2 Copyright (C) 2012-2019 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"
29 #include "dcpomatic_log.h"
31 #include "dcp_video.h"
34 #include "encode_server_finder.h"
36 #include "player_video.h"
37 #include "encode_server_description.h"
38 #include "compose.hpp"
39 #include <libcxml/cxml.h>
40 #include <boost/foreach.hpp>
48 using boost::shared_ptr;
49 using boost::weak_ptr;
50 using boost::optional;
52 using namespace dcpomatic;
54 /** @param film Film that we are encoding.
55 * @param writer Writer that we are using.
57 J2KEncoder::J2KEncoder (shared_ptr<const Film> film, shared_ptr<Writer> writer)
62 servers_list_changed ();
65 J2KEncoder::~J2KEncoder ()
70 /* Destructors must not throw exceptions; anything bad
71 happening now is too late to worry about anyway,
80 weak_ptr<J2KEncoder> wp = shared_from_this ();
81 _server_found_connection = EncodeServerFinder::instance()->ServersListChanged.connect (
82 boost::bind (&J2KEncoder::call_servers_list_changed, wp)
86 /* We don't want the servers-list-changed callback trying to do things
87 during destruction of J2KEncoder, and I think this is the neatest way
91 J2KEncoder::call_servers_list_changed (weak_ptr<J2KEncoder> encoder)
93 shared_ptr<J2KEncoder> e = encoder.lock ();
95 e->servers_list_changed ();
102 boost::mutex::scoped_lock lock (_queue_mutex);
104 LOG_GENERAL (N_("Clearing queue of %1"), _queue.size ());
106 /* Keep waking workers until the queue is empty */
107 while (!_queue.empty ()) {
109 _empty_condition.notify_all ();
110 _full_condition.wait (lock);
115 LOG_GENERAL_NC (N_("Terminating encoder threads"));
117 terminate_threads ();
119 /* Something might have been thrown during 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(),
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() && !_film->reencode_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(),
240 /* The queue might not be empty any more, so notify anything which is
243 _empty_condition.notify_all ();
246 _last_player_video[pv->eyes()] = pv;
247 _last_player_video_time = time;
251 J2KEncoder::terminate_threads ()
253 boost::mutex::scoped_lock threads_lock (_threads_mutex);
256 BOOST_FOREACH (boost::thread* i, _threads) {
257 /* Be careful not to throw in here otherwise _threads will not be clear()ed */
258 LOG_GENERAL ("Terminating thread %1 of %2", n + 1, _threads.size ());
262 } catch (exception& e) {
263 LOG_ERROR ("join() threw an exception: %1", e.what());
265 LOG_ERROR_NC ("join() threw an exception");
267 LOG_GENERAL_NC ("Thread terminated");
276 J2KEncoder::encoder_thread (optional<EncodeServerDescription> server)
280 LOG_TIMING ("start-encoder-thread thread=%1 server=%2", thread_id (), server->host_name ());
282 LOG_TIMING ("start-encoder-thread thread=%1 server=localhost", thread_id ());
285 /* Number of seconds that we currently wait between attempts
286 to connect to the server; not relevant for localhost
289 int remote_backoff = 0;
293 LOG_TIMING ("encoder-sleep thread=%1", thread_id ());
294 boost::mutex::scoped_lock lock (_queue_mutex);
295 while (_queue.empty ()) {
296 _empty_condition.wait (lock);
299 LOG_TIMING ("encoder-wake thread=%1 queue=%2", thread_id(), _queue.size());
300 shared_ptr<DCPVideo> vf = _queue.front ();
302 /* We're about to commit to either encoding this frame or putting it back onto the queue,
303 so we must not be interrupted until one or other of these things have happened. This
304 block has thread interruption disabled.
307 boost::this_thread::disable_interruption dis;
309 LOG_TIMING ("encoder-pop thread=%1 frame=%2 eyes=%3", thread_id(), vf->index(), (int) vf->eyes ());
314 optional<Data> encoded;
316 /* We need to encode this input */
319 encoded = vf->encode_remotely (server.get ());
321 if (remote_backoff > 0) {
322 LOG_GENERAL ("%1 was lost, but now she is found; removing backoff", server->host_name ());
325 /* This job succeeded, so remove any backoff */
328 } catch (std::exception& e) {
329 if (remote_backoff < 60) {
331 remote_backoff += 10;
334 N_("Remote encode of %1 on %2 failed (%3); thread sleeping for %4s"),
335 vf->index(), server->host_name(), e.what(), remote_backoff
341 LOG_TIMING ("start-local-encode thread=%1 frame=%2", thread_id(), vf->index());
342 encoded = vf->encode_locally ();
343 LOG_TIMING ("finish-local-encode thread=%1 frame=%2", thread_id(), vf->index());
344 } catch (std::exception& e) {
345 /* This is very bad, so don't cope with it, just pass it on */
346 LOG_ERROR (N_("Local encode failed (%1)"), e.what ());
352 _writer->write (encoded.get(), vf->index (), vf->eyes ());
356 LOG_GENERAL (N_("[%1] J2KEncoder thread pushes frame %2 back onto queue after failure"), thread_id(), vf->index());
357 _queue.push_front (vf);
362 if (remote_backoff > 0) {
363 boost::this_thread::sleep (boost::posix_time::seconds (remote_backoff));
366 /* The queue might not be full any more, so notify anything that is waiting on that */
368 _full_condition.notify_all ();
371 catch (boost::thread_interrupted& e) {
372 /* Ignore these and just stop the thread */
373 _full_condition.notify_all ();
378 /* Wake anything waiting on _full_condition so it can see the exception */
379 _full_condition.notify_all ();
383 J2KEncoder::servers_list_changed ()
385 terminate_threads ();
387 /* XXX: could re-use threads */
389 boost::mutex::scoped_lock lm (_threads_mutex);
391 #ifdef BOOST_THREAD_PLATFORM_WIN32
393 info.dwOSVersionInfoSize = sizeof (OSVERSIONINFO);
394 GetVersionEx (&info);
395 bool const windows_xp = (info.dwMajorVersion == 5 && info.dwMinorVersion == 1);
397 LOG_GENERAL_NC (N_("Setting thread affinity for Windows XP"));
401 if (!Config::instance()->only_servers_encode ()) {
402 for (int i = 0; i < Config::instance()->master_encoding_threads (); ++i) {
403 boost::thread* t = new boost::thread (boost::bind(&J2KEncoder::encoder_thread, this, optional<EncodeServerDescription>()));
404 #ifdef DCPOMATIC_LINUX
405 pthread_setname_np (t->native_handle(), "encode-worker");
407 _threads.push_back (t);
408 #ifdef BOOST_THREAD_PLATFORM_WIN32
410 SetThreadAffinityMask (t->native_handle(), 1 << i);
416 BOOST_FOREACH (EncodeServerDescription i, EncodeServerFinder::instance()->servers()) {
417 if (!i.current_link_version()) {
421 LOG_GENERAL (N_("Adding %1 worker threads for remote %2"), i.threads(), i.host_name ());
422 for (int j = 0; j < i.threads(); ++j) {
423 _threads.push_back (new boost::thread(boost::bind(&J2KEncoder::encoder_thread, this, i)));
427 _writer->set_encoder_threads (_threads.size ());