2 Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 /** @file src/encoder.h
21 * @brief Parent class for classes which can encode video and audio frames.
29 #include "dcp_video.h"
33 #include "server_finder.h"
35 #include "player_video.h"
37 #include <libcxml/cxml.h>
38 #include <boost/lambda/lambda.hpp>
43 #define LOG_GENERAL(...) _film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
44 #define LOG_ERROR(...) _film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_ERROR);
45 #define LOG_TIMING(...) _film->log()->microsecond_log (String::compose (__VA_ARGS__), Log::TYPE_TIMING);
54 using boost::shared_ptr;
55 using boost::weak_ptr;
56 using boost::optional;
57 using boost::scoped_array;
59 int const Encoder::_history_size = 25;
61 /** @param f Film that we are encoding */
62 Encoder::Encoder (shared_ptr<const Film> f, weak_ptr<Job> j, shared_ptr<Writer> writer)
65 , _video_frames_enqueued (0)
77 /** Add a worker thread for a each thread on a remote server. Caller must hold
78 * a lock on _mutex, or know that one is not currently required to
79 * safely modify _threads.
82 Encoder::add_worker_threads (ServerDescription d)
84 LOG_GENERAL (N_("Adding %1 worker threads for remote %2"), d.threads(), d.host_name ());
85 for (int i = 0; i < d.threads(); ++i) {
86 _threads.push_back (new boost::thread (boost::bind (&Encoder::encoder_thread, this, d)));
89 _writer->set_encoder_threads (_threads.size ());
95 for (int i = 0; i < Config::instance()->num_local_encoding_threads (); ++i) {
96 _threads.push_back (new boost::thread (boost::bind (&Encoder::encoder_thread, this, optional<ServerDescription> ())));
99 _writer->set_encoder_threads (_threads.size ());
101 if (!ServerFinder::instance()->disabled ()) {
102 _server_found_connection = ServerFinder::instance()->connect (boost::bind (&Encoder::server_found, this, _1));
109 boost::mutex::scoped_lock lock (_mutex);
111 LOG_GENERAL (N_("Clearing queue of %1"), _queue.size ());
113 /* Keep waking workers until the queue is empty */
114 while (!_queue.empty ()) {
115 _empty_condition.notify_all ();
116 _full_condition.wait (lock);
121 terminate_threads ();
123 LOG_GENERAL (N_("Mopping up %1"), _queue.size());
125 /* The following sequence of events can occur in the above code:
126 1. a remote worker takes the last image off the queue
127 2. the loop above terminates
128 3. the remote worker fails to encode the image and puts it back on the queue
129 4. the remote worker is then terminated by terminate_threads
131 So just mop up anything left in the queue here.
134 for (list<shared_ptr<DCPVideo> >::iterator i = _queue.begin(); i != _queue.end(); ++i) {
135 LOG_GENERAL (N_("Encode left-over frame %1"), (*i)->index ());
138 (*i)->encode_locally (boost::bind (&Log::dcp_log, _film->log().get(), _1, _2)),
143 } catch (std::exception& e) {
144 LOG_ERROR (N_("Local encode failed (%1)"), e.what ());
149 /** @return an estimate of the current number of frames we are encoding per second,
153 Encoder::current_encoding_rate () const
155 boost::mutex::scoped_lock lock (_state_mutex);
156 if (int (_time_history.size()) < _history_size) {
161 gettimeofday (&now, 0);
163 return _history_size / (seconds (now) - seconds (_time_history.back ()));
166 /** @return Number of video frames that have been sent out */
168 Encoder::video_frames_out () const
170 boost::mutex::scoped_lock (_state_mutex);
171 return _video_frames_enqueued;
174 /** Should be called when a frame has been encoded successfully.
175 * @param n Source frame index.
178 Encoder::frame_done ()
180 boost::mutex::scoped_lock lock (_state_mutex);
183 gettimeofday (&tv, 0);
184 _time_history.push_front (tv);
185 if (int (_time_history.size()) > _history_size) {
186 _time_history.pop_back ();
190 /** Called in order, so each time this is called the supplied frame is the one
191 * after the previous one.
194 Encoder::enqueue (shared_ptr<PlayerVideo> pv)
198 boost::mutex::scoped_lock lock (_mutex);
200 /* XXX: discard 3D here if required */
202 /* Wait until the queue has gone down a bit */
203 while (_queue.size() >= _threads.size() * 2 && !_terminate) {
204 LOG_TIMING ("decoder sleeps with queue of %1", _queue.size());
205 _full_condition.wait (lock);
206 LOG_TIMING ("decoder wakes with queue of %1", _queue.size());
214 /* Re-throw any exception raised by one of our threads. If more
215 than one has thrown an exception, only one will be rethrown, I think;
216 but then, if that happens something has gone badly wrong.
220 if (_writer->can_fake_write (_video_frames_enqueued)) {
221 /* We can fake-write this frame */
222 _writer->fake_write (_video_frames_enqueued, pv->eyes ());
224 } else if (_last_player_video && pv->same (_last_player_video)) {
225 _writer->repeat (_video_frames_enqueued, pv->eyes ());
226 } else if (pv->has_j2k ()) {
227 /* This frame already has JPEG2000 data, so just write it */
228 _writer->write (pv->j2k(), _video_frames_enqueued, pv->eyes ());
230 /* Queue this new frame for encoding */
231 LOG_TIMING ("adding to queue of %1", _queue.size ());
232 _queue.push_back (shared_ptr<DCPVideo> (
235 _video_frames_enqueued,
236 _film->video_frame_rate(),
237 _film->j2k_bandwidth(),
239 _film->burn_subtitles(),
244 /* The queue might not be empty any more, so notify anything which is
247 _empty_condition.notify_all ();
250 if (pv->eyes() != EYES_LEFT) {
251 ++_video_frames_enqueued;
254 _last_player_video = pv;
258 Encoder::terminate_threads ()
261 boost::mutex::scoped_lock lock (_mutex);
263 _full_condition.notify_all ();
264 _empty_condition.notify_all ();
267 for (list<boost::thread *>::iterator i = _threads.begin(); i != _threads.end(); ++i) {
268 if ((*i)->joinable ()) {
278 Encoder::encoder_thread (optional<ServerDescription> server)
281 /* Number of seconds that we currently wait between attempts
282 to connect to the server; not relevant for localhost
285 int remote_backoff = 0;
289 LOG_TIMING ("[%1] encoder thread sleeps", boost::this_thread::get_id());
290 boost::mutex::scoped_lock lock (_mutex);
291 while (_queue.empty () && !_terminate) {
292 _empty_condition.wait (lock);
299 LOG_TIMING ("[%1] encoder thread wakes with queue of %2", boost::this_thread::get_id(), _queue.size());
300 shared_ptr<DCPVideo> vf = _queue.front ();
301 LOG_TIMING ("[%1] encoder thread pops frame %2 (%3) from queue", boost::this_thread::get_id(), vf->index(), vf->eyes ());
306 optional<Data> encoded;
308 /* We need to encode this input */
311 encoded = vf->encode_remotely (server.get ());
313 if (remote_backoff > 0) {
314 LOG_GENERAL ("%1 was lost, but now she is found; removing backoff", server->host_name ());
317 /* This job succeeded, so remove any backoff */
320 } catch (std::exception& e) {
321 if (remote_backoff < 60) {
323 remote_backoff += 10;
326 N_("Remote encode of %1 on %2 failed (%3); thread sleeping for %4s"),
327 vf->index(), server->host_name(), e.what(), remote_backoff
333 LOG_TIMING ("[%1] encoder thread begins local encode of %2", boost::this_thread::get_id(), vf->index());
334 encoded = vf->encode_locally (boost::bind (&Log::dcp_log, _film->log().get(), _1, _2));
335 LOG_TIMING ("[%1] encoder thread finishes local encode of %2", boost::this_thread::get_id(), vf->index());
336 } catch (std::exception& e) {
337 LOG_ERROR (N_("Local encode failed (%1)"), e.what ());
342 _writer->write (encoded.get(), vf->index (), vf->eyes ());
346 LOG_GENERAL (N_("[%1] Encoder thread pushes frame %2 back onto queue after failure"), boost::this_thread::get_id(), vf->index());
347 _queue.push_front (vf);
351 if (remote_backoff > 0) {
352 dcpomatic_sleep (remote_backoff);
355 /* The queue might not be full any more, so notify anything that is waiting on that */
357 _full_condition.notify_all ();
366 Encoder::server_found (ServerDescription s)
368 add_worker_threads (s);