2 Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
21 /** @file src/encoder.h
22 * @brief Parent class for classes which can encode video and audio frames.
30 #include "dcp_video.h"
33 #include "encode_server_finder.h"
35 #include "player_video.h"
36 #include "encode_server_description.h"
37 #include "compose.hpp"
38 #include <libcxml/cxml.h>
39 #include <boost/foreach.hpp>
44 #define LOG_GENERAL(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
45 #define LOG_GENERAL_NC(...) _film->log()->log (__VA_ARGS__, LogEntry::TYPE_GENERAL);
46 #define LOG_ERROR(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_ERROR);
47 #define LOG_TIMING(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_TIMING);
51 using boost::shared_ptr;
52 using boost::weak_ptr;
53 using boost::optional;
56 int const Encoder::_history_size = 25;
58 /** @param f Film that we are encoding */
59 Encoder::Encoder (shared_ptr<const Film> film, shared_ptr<Writer> writer)
63 servers_list_changed ();
71 /* Destructors must not throw exceptions; anything bad
72 happening now is too late to worry about anyway,
81 if (!EncodeServerFinder::instance()->disabled ()) {
82 weak_ptr<Encoder> wp = shared_from_this ();
83 _server_found_connection = EncodeServerFinder::instance()->ServersListChanged.connect (
84 boost::bind (&Encoder::call_servers_list_changed, wp)
89 /* We don't want the servers-list-changed callback trying to do things
90 during destruction of Encoder, and I think this is the neatest way
94 Encoder::call_servers_list_changed (weak_ptr<Encoder> encoder)
96 shared_ptr<Encoder> e = encoder.lock ();
98 e->servers_list_changed ();
105 boost::mutex::scoped_lock lock (_queue_mutex);
107 LOG_GENERAL (N_("Clearing queue of %1"), _queue.size ());
109 /* Keep waking workers until the queue is empty */
110 while (!_queue.empty ()) {
112 _empty_condition.notify_all ();
113 _full_condition.wait (lock);
118 LOG_GENERAL_NC (N_("Terminating encoder threads"));
120 terminate_threads ();
122 LOG_GENERAL (N_("Mopping up %1"), _queue.size());
124 /* The following sequence of events can occur in the above code:
125 1. a remote worker takes the last image off the queue
126 2. the loop above terminates
127 3. the remote worker fails to encode the image and puts it back on the queue
128 4. the remote worker is then terminated by terminate_threads
130 So just mop up anything left in the queue here.
133 for (list<shared_ptr<DCPVideo> >::iterator i = _queue.begin(); i != _queue.end(); ++i) {
134 LOG_GENERAL (N_("Encode left-over frame %1"), (*i)->index ());
137 (*i)->encode_locally (boost::bind (&Log::dcp_log, _film->log().get(), _1, _2)),
142 } catch (std::exception& e) {
143 LOG_ERROR (N_("Local encode failed (%1)"), e.what ());
148 /** @return an estimate of the current number of frames we are encoding per second,
152 Encoder::current_encoding_rate () const
154 boost::mutex::scoped_lock lock (_state_mutex);
155 if (int (_time_history.size()) < _history_size) {
160 gettimeofday (&now, 0);
162 return _history_size / (seconds (now) - seconds (_time_history.back ()));
165 /** @return Number of video frames that have been queued for encoding */
167 Encoder::video_frames_enqueued () const
169 return _last_player_video->time().frames_floor (_film->video_frame_rate ());
172 /** Should be called when a frame has been encoded successfully.
173 * @param n Source frame index.
176 Encoder::frame_done ()
178 boost::mutex::scoped_lock lock (_state_mutex);
181 gettimeofday (&tv, 0);
182 _time_history.push_front (tv);
183 if (int (_time_history.size()) > _history_size) {
184 _time_history.pop_back ();
188 /** Called to start encoding of the next video frame in the DCP. This is called in order,
189 * so each time the supplied frame is the one after the previous one.
190 * pv represents one video frame, and could be empty if there is nothing to encode
191 * for this DCP frame.
194 Encoder::encode (shared_ptr<PlayerVideo> pv)
200 boost::mutex::scoped_lock threads_lock (_threads_mutex);
201 threads = _threads.size ();
204 boost::mutex::scoped_lock queue_lock (_queue_mutex);
206 /* Wait until the queue has gone down a bit */
207 while (_queue.size() >= threads * 2) {
208 LOG_TIMING ("decoder-sleep queue=%1", _queue.size());
209 _full_condition.wait (queue_lock);
210 LOG_TIMING ("decoder-wake queue=%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 Frame const position = pv->time().frames_floor(_film->video_frame_rate());
222 if (_writer->can_fake_write (position)) {
223 /* We can fake-write this frame */
224 _writer->fake_write (position, pv->eyes ());
226 } else if (pv->has_j2k ()) {
227 /* This frame already has JPEG2000 data, so just write it */
228 _writer->write (pv->j2k(), position, pv->eyes ());
229 } else if (_last_player_video && _writer->can_repeat(position) && pv->same (_last_player_video)) {
230 _writer->repeat (position, pv->eyes ());
232 /* Queue this new frame for encoding */
233 LOG_TIMING ("add-frame-to-queue queue=%1", _queue.size ());
234 _queue.push_back (shared_ptr<DCPVideo> (
238 _film->video_frame_rate(),
239 _film->j2k_bandwidth(),
245 /* The queue might not be empty any more, so notify anything which is
248 _empty_condition.notify_all ();
251 _last_player_video = pv;
255 Encoder::terminate_threads ()
257 boost::mutex::scoped_lock threads_lock (_threads_mutex);
260 for (list<boost::thread *>::iterator i = _threads.begin(); i != _threads.end(); ++i) {
261 LOG_GENERAL ("Terminating thread %1 of %2", n + 1, _threads.size ());
263 DCPOMATIC_ASSERT ((*i)->joinable ());
266 } catch (boost::thread_interrupted& e) {
267 /* This is to be expected */
270 LOG_GENERAL_NC ("Thread terminated");
278 Encoder::encoder_thread (optional<EncodeServerDescription> server)
282 LOG_TIMING ("start-encoder-thread thread=%1 server=%2", boost::this_thread::get_id (), server->host_name ());
284 LOG_TIMING ("start-encoder-thread thread=%1 server=localhost", boost::this_thread::get_id ());
287 /* Number of seconds that we currently wait between attempts
288 to connect to the server; not relevant for localhost
291 int remote_backoff = 0;
295 LOG_TIMING ("encoder-sleep thread=%1", boost::this_thread::get_id());
296 boost::mutex::scoped_lock lock (_queue_mutex);
297 while (_queue.empty ()) {
298 _empty_condition.wait (lock);
301 LOG_TIMING ("encoder-wake thread=%1 queue=%2", boost::this_thread::get_id(), _queue.size());
302 shared_ptr<DCPVideo> vf = _queue.front ();
303 LOG_TIMING ("encoder-pop thread=%1 frame=%2 eyes=%3", boost::this_thread::get_id(), vf->index(), vf->eyes ());
308 optional<Data> encoded;
310 /* We need to encode this input */
313 encoded = vf->encode_remotely (server.get ());
315 if (remote_backoff > 0) {
316 LOG_GENERAL ("%1 was lost, but now she is found; removing backoff", server->host_name ());
319 /* This job succeeded, so remove any backoff */
322 } catch (std::exception& e) {
323 if (remote_backoff < 60) {
325 remote_backoff += 10;
328 N_("Remote encode of %1 on %2 failed (%3); thread sleeping for %4s"),
329 vf->index(), server->host_name(), e.what(), remote_backoff
335 LOG_TIMING ("start-local-encode thread=%1 frame=%2", boost::this_thread::get_id(), vf->index());
336 encoded = vf->encode_locally (boost::bind (&Log::dcp_log, _film->log().get(), _1, _2));
337 LOG_TIMING ("finish-local-encode thread=%1 frame=%2", boost::this_thread::get_id(), vf->index());
338 } catch (std::exception& e) {
339 LOG_ERROR (N_("Local encode failed (%1)"), e.what ());
345 _writer->write (encoded.get(), vf->index (), vf->eyes ());
349 LOG_GENERAL (N_("[%1] Encoder thread pushes frame %2 back onto queue after failure"), boost::this_thread::get_id(), vf->index());
350 _queue.push_front (vf);
354 if (remote_backoff > 0) {
355 boost::this_thread::sleep (boost::posix_time::seconds (remote_backoff));
358 /* The queue might not be full any more, so notify anything that is waiting on that */
360 _full_condition.notify_all ();
366 /* Wake anything waiting on _full_condition so it can see the exception */
367 _full_condition.notify_all ();
371 Encoder::servers_list_changed ()
373 terminate_threads ();
375 /* XXX: could re-use threads */
377 boost::mutex::scoped_lock lm (_threads_mutex);
379 #ifdef BOOST_THREAD_PLATFORM_WIN32
381 info.dwOSVersionInfoSize = sizeof (OSVERSIONINFO);
382 GetVersionEx (&info);
383 bool const windows_xp = (info.dwMajorVersion == 5 && info.dwMinorVersion == 1);
385 LOG_GENERAL_NC (N_("Setting thread affinity for Windows XP"));
389 if (!Config::instance()->only_servers_encode ()) {
390 for (int i = 0; i < Config::instance()->num_local_encoding_threads (); ++i) {
391 boost::thread* t = new boost::thread (boost::bind (&Encoder::encoder_thread, this, optional<EncodeServerDescription> ()));
392 _threads.push_back (t);
393 #ifdef BOOST_THREAD_PLATFORM_WIN32
395 SetThreadAffinityMask (t->native_handle(), 1 << i);
401 BOOST_FOREACH (EncodeServerDescription i, EncodeServerFinder::instance()->servers ()) {
402 LOG_GENERAL (N_("Adding %1 worker threads for remote %2"), i.threads(), i.host_name ());
403 for (int j = 0; j < i.threads(); ++j) {
404 _threads.push_back (new boost::thread (boost::bind (&Encoder::encoder_thread, this, i)));
408 _writer->set_encoder_threads (_threads.size ());