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/j2k_encoder.cc
22 * @brief J2K encoder class.
25 #include "j2k_encoder.h"
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);
48 #define LOG_DEBUG_ENCODE(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_DEBUG_ENCODE);
52 using boost::shared_ptr;
53 using boost::weak_ptr;
54 using boost::optional;
57 /** @param film Film that we are encoding.
58 * @param writer Writer that we are using.
60 J2KEncoder::J2KEncoder (shared_ptr<const Film> film, shared_ptr<Writer> writer)
65 servers_list_changed ();
68 J2KEncoder::~J2KEncoder ()
73 /* Destructors must not throw exceptions; anything bad
74 happening now is too late to worry about anyway,
83 weak_ptr<J2KEncoder> wp = shared_from_this ();
84 _server_found_connection = EncodeServerFinder::instance()->ServersListChanged.connect (
85 boost::bind (&J2KEncoder::call_servers_list_changed, wp)
89 /* We don't want the servers-list-changed callback trying to do things
90 during destruction of J2KEncoder, and I think this is the neatest way
94 J2KEncoder::call_servers_list_changed (weak_ptr<J2KEncoder> encoder)
96 shared_ptr<J2KEncoder> 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 J2KEncoder::current_encoding_rate () const
154 return _history.rate ();
157 /** @return Number of video frames that have been queued for encoding */
159 J2KEncoder::video_frames_enqueued () const
161 if (!_last_player_video_time) {
165 return _last_player_video_time->frames_floor (_film->video_frame_rate ());
168 /** Should be called when a frame has been encoded successfully */
170 J2KEncoder::frame_done ()
175 /** Called to request encoding of the next video frame in the DCP. This is called in order,
176 * so each time the supplied frame is the one after the previous one.
177 * pv represents one video frame, and could be empty if there is nothing to encode
178 * for this DCP frame.
180 * @param pv PlayerVideo to encode.
181 * @param time Time of \p pv within the DCP.
184 J2KEncoder::encode (shared_ptr<PlayerVideo> pv, DCPTime time)
190 boost::mutex::scoped_lock threads_lock (_threads_mutex);
191 threads = _threads.size ();
194 boost::mutex::scoped_lock queue_lock (_queue_mutex);
196 /* Wait until the queue has gone down a bit. Allow one thing in the queue even
197 when there are no threads.
199 while (_queue.size() >= (threads * 2) + 1) {
200 LOG_TIMING ("decoder-sleep queue=%1 threads=%2", _queue.size(), threads);
201 _full_condition.wait (queue_lock);
202 LOG_TIMING ("decoder-wake queue=%1 threads=%2", _queue.size(), threads);
206 /* Re-throw any exception raised by one of our threads. If more
207 than one has thrown an exception, only one will be rethrown, I think;
208 but then, if that happens something has gone badly wrong.
212 Frame const position = time.frames_floor(_film->video_frame_rate());
214 if (_writer->can_fake_write (position)) {
215 /* We can fake-write this frame */
216 LOG_DEBUG_ENCODE("Frame @ %1 FAKE", to_string(time));
217 _writer->fake_write (position, pv->eyes ());
219 } else if (pv->has_j2k ()) {
220 LOG_DEBUG_ENCODE("Frame @ %1 J2K", to_string(time));
221 /* This frame already has J2K data, so just write it */
222 _writer->write (pv->j2k(), position, pv->eyes ());
223 } else if (_last_player_video[pv->eyes()] && _writer->can_repeat(position) && pv->same (_last_player_video[pv->eyes()])) {
224 LOG_DEBUG_ENCODE("Frame @ %1 REPEAT", to_string(time));
225 _writer->repeat (position, pv->eyes ());
227 LOG_DEBUG_ENCODE("Frame @ %1 ENCODE", to_string(time));
228 /* Queue this new frame for encoding */
229 LOG_TIMING ("add-frame-to-queue queue=%1", _queue.size ());
230 _queue.push_back (shared_ptr<DCPVideo> (
234 _film->video_frame_rate(),
235 _film->j2k_bandwidth(),
241 /* The queue might not be empty any more, so notify anything which is
244 _empty_condition.notify_all ();
247 _last_player_video[pv->eyes()] = pv;
248 _last_player_video_time = time;
252 J2KEncoder::terminate_threads ()
254 boost::mutex::scoped_lock threads_lock (_threads_mutex);
257 for (list<boost::thread *>::iterator i = _threads.begin(); i != _threads.end(); ++i) {
258 LOG_GENERAL ("Terminating thread %1 of %2", n + 1, _threads.size ());
260 DCPOMATIC_ASSERT ((*i)->joinable ());
263 } catch (boost::thread_interrupted& e) {
264 /* This is to be expected */
267 LOG_GENERAL_NC ("Thread terminated");
275 J2KEncoder::encoder_thread (optional<EncodeServerDescription> server)
279 LOG_TIMING ("start-encoder-thread thread=%1 server=%2", thread_id (), server->host_name ());
281 LOG_TIMING ("start-encoder-thread thread=%1 server=localhost", thread_id ());
284 /* Number of seconds that we currently wait between attempts
285 to connect to the server; not relevant for localhost
288 int remote_backoff = 0;
292 LOG_TIMING ("encoder-sleep thread=%1", thread_id ());
293 boost::mutex::scoped_lock lock (_queue_mutex);
294 while (_queue.empty ()) {
295 _empty_condition.wait (lock);
298 LOG_TIMING ("encoder-wake thread=%1 queue=%2", thread_id(), _queue.size());
299 shared_ptr<DCPVideo> vf = _queue.front ();
301 /* We're about to commit to either encoding this frame or putting it back onto the queue,
302 so we must not be interrupted until one or other of these things have happened. This
303 block has thread interruption disabled.
306 boost::this_thread::disable_interruption dis;
308 LOG_TIMING ("encoder-pop thread=%1 frame=%2 eyes=%3", thread_id(), vf->index(), (int) vf->eyes ());
313 optional<Data> encoded;
315 /* We need to encode this input */
318 encoded = vf->encode_remotely (server.get ());
320 if (remote_backoff > 0) {
321 LOG_GENERAL ("%1 was lost, but now she is found; removing backoff", server->host_name ());
324 /* This job succeeded, so remove any backoff */
327 } catch (std::exception& e) {
328 if (remote_backoff < 60) {
330 remote_backoff += 10;
333 N_("Remote encode of %1 on %2 failed (%3); thread sleeping for %4s"),
334 vf->index(), server->host_name(), e.what(), remote_backoff
340 LOG_TIMING ("start-local-encode thread=%1 frame=%2", thread_id(), vf->index());
341 encoded = vf->encode_locally (boost::bind (&Log::dcp_log, _film->log().get(), _1, _2));
342 LOG_TIMING ("finish-local-encode thread=%1 frame=%2", thread_id(), vf->index());
343 } catch (std::exception& e) {
344 /* This is very bad, so don't cope with it, just pass it on */
345 LOG_ERROR (N_("Local encode failed (%1)"), e.what ());
351 _writer->write (encoded.get(), vf->index (), vf->eyes ());
355 LOG_GENERAL (N_("[%1] J2KEncoder thread pushes frame %2 back onto queue after failure"), thread_id(), vf->index());
356 _queue.push_front (vf);
361 if (remote_backoff > 0) {
362 boost::this_thread::sleep (boost::posix_time::seconds (remote_backoff));
365 /* The queue might not be full any more, so notify anything that is waiting on that */
367 _full_condition.notify_all ();
370 catch (boost::thread_interrupted& e) {
371 /* Ignore these and just stop the thread */
372 _full_condition.notify_all ();
377 /* Wake anything waiting on _full_condition so it can see the exception */
378 _full_condition.notify_all ();
382 J2KEncoder::servers_list_changed ()
384 terminate_threads ();
386 /* XXX: could re-use threads */
388 boost::mutex::scoped_lock lm (_threads_mutex);
390 #ifdef BOOST_THREAD_PLATFORM_WIN32
392 info.dwOSVersionInfoSize = sizeof (OSVERSIONINFO);
393 GetVersionEx (&info);
394 bool const windows_xp = (info.dwMajorVersion == 5 && info.dwMinorVersion == 1);
396 LOG_GENERAL_NC (N_("Setting thread affinity for Windows XP"));
400 if (!Config::instance()->only_servers_encode ()) {
401 for (int i = 0; i < Config::instance()->master_encoding_threads (); ++i) {
402 boost::thread* t = new boost::thread (boost::bind (&J2KEncoder::encoder_thread, this, optional<EncodeServerDescription> ()));
403 _threads.push_back (t);
404 #ifdef BOOST_THREAD_PLATFORM_WIN32
406 SetThreadAffinityMask (t->native_handle(), 1 << i);
412 BOOST_FOREACH (EncodeServerDescription i, EncodeServerFinder::instance()->servers ()) {
413 LOG_GENERAL (N_("Adding %1 worker threads for remote %2"), i.threads(), i.host_name ());
414 for (int j = 0; j < i.threads(); ++j) {
415 _threads.push_back (new boost::thread (boost::bind (&J2KEncoder::encoder_thread, this, i)));
419 _writer->set_encoder_threads (_threads.size ());