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"
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>
47 using boost::shared_ptr;
48 using boost::weak_ptr;
49 using boost::optional;
51 using namespace dcpomatic;
53 /** @param film Film that we are encoding.
54 * @param writer Writer that we are using.
56 J2KEncoder::J2KEncoder (shared_ptr<const Film> film, shared_ptr<Writer> writer)
61 servers_list_changed ();
64 J2KEncoder::~J2KEncoder ()
69 /* Destructors must not throw exceptions; anything bad
70 happening now is too late to worry about anyway,
79 weak_ptr<J2KEncoder> wp = shared_from_this ();
80 _server_found_connection = EncodeServerFinder::instance()->ServersListChanged.connect (
81 boost::bind (&J2KEncoder::call_servers_list_changed, wp)
85 /* We don't want the servers-list-changed callback trying to do things
86 during destruction of J2KEncoder, and I think this is the neatest way
90 J2KEncoder::call_servers_list_changed (weak_ptr<J2KEncoder> encoder)
92 shared_ptr<J2KEncoder> e = encoder.lock ();
94 e->servers_list_changed ();
101 boost::mutex::scoped_lock lock (_queue_mutex);
103 LOG_GENERAL (N_("Clearing queue of %1"), _queue.size ());
105 /* Keep waking workers until the queue is empty */
106 while (!_queue.empty ()) {
108 _empty_condition.notify_all ();
109 _full_condition.wait (lock);
114 LOG_GENERAL_NC (N_("Terminating encoder threads"));
116 terminate_threads ();
118 LOG_GENERAL (N_("Mopping up %1"), _queue.size());
120 /* The following sequence of events can occur in the above code:
121 1. a remote worker takes the last image off the queue
122 2. the loop above terminates
123 3. the remote worker fails to encode the image and puts it back on the queue
124 4. the remote worker is then terminated by terminate_threads
126 So just mop up anything left in the queue here.
129 for (list<shared_ptr<DCPVideo> >::iterator i = _queue.begin(); i != _queue.end(); ++i) {
130 LOG_GENERAL (N_("Encode left-over frame %1"), (*i)->index ());
133 (*i)->encode_locally(),
138 } catch (std::exception& e) {
139 LOG_ERROR (N_("Local encode failed (%1)"), e.what ());
144 /** @return an estimate of the current number of frames we are encoding per second,
148 J2KEncoder::current_encoding_rate () const
150 return _history.rate ();
153 /** @return Number of video frames that have been queued for encoding */
155 J2KEncoder::video_frames_enqueued () const
157 if (!_last_player_video_time) {
161 return _last_player_video_time->frames_floor (_film->video_frame_rate ());
164 /** Should be called when a frame has been encoded successfully */
166 J2KEncoder::frame_done ()
171 /** Called to request encoding of the next video frame in the DCP. This is called in order,
172 * so each time the supplied frame is the one after the previous one.
173 * pv represents one video frame, and could be empty if there is nothing to encode
174 * for this DCP frame.
176 * @param pv PlayerVideo to encode.
177 * @param time Time of \p pv within the DCP.
180 J2KEncoder::encode (shared_ptr<PlayerVideo> pv, DCPTime time)
186 boost::mutex::scoped_lock threads_lock (_threads_mutex);
187 threads = _threads.size ();
190 boost::mutex::scoped_lock queue_lock (_queue_mutex);
192 /* Wait until the queue has gone down a bit. Allow one thing in the queue even
193 when there are no threads.
195 while (_queue.size() >= (threads * 2) + 1) {
196 LOG_TIMING ("decoder-sleep queue=%1 threads=%2", _queue.size(), threads);
197 _full_condition.wait (queue_lock);
198 LOG_TIMING ("decoder-wake queue=%1 threads=%2", _queue.size(), threads);
202 /* Re-throw any exception raised by one of our threads. If more
203 than one has thrown an exception, only one will be rethrown, I think;
204 but then, if that happens something has gone badly wrong.
208 Frame const position = time.frames_floor(_film->video_frame_rate());
210 if (_writer->can_fake_write (position)) {
211 /* We can fake-write this frame */
212 LOG_DEBUG_ENCODE("Frame @ %1 FAKE", to_string(time));
213 _writer->fake_write (position, pv->eyes ());
215 } else if (pv->has_j2k() && !_film->reencode_j2k()) {
216 LOG_DEBUG_ENCODE("Frame @ %1 J2K", to_string(time));
217 /* This frame already has J2K data, so just write it */
218 _writer->write (pv->j2k(), position, pv->eyes ());
219 } else if (_last_player_video[pv->eyes()] && _writer->can_repeat(position) && pv->same (_last_player_video[pv->eyes()])) {
220 LOG_DEBUG_ENCODE("Frame @ %1 REPEAT", to_string(time));
221 _writer->repeat (position, pv->eyes ());
223 LOG_DEBUG_ENCODE("Frame @ %1 ENCODE", to_string(time));
224 /* Queue this new frame for encoding */
225 LOG_TIMING ("add-frame-to-queue queue=%1", _queue.size ());
226 _queue.push_back (shared_ptr<DCPVideo> (
230 _film->video_frame_rate(),
231 _film->j2k_bandwidth(),
236 /* The queue might not be empty any more, so notify anything which is
239 _empty_condition.notify_all ();
242 _last_player_video[pv->eyes()] = pv;
243 _last_player_video_time = time;
247 J2KEncoder::terminate_threads ()
249 boost::mutex::scoped_lock threads_lock (_threads_mutex);
252 for (list<boost::thread *>::iterator i = _threads.begin(); i != _threads.end(); ++i) {
253 LOG_GENERAL ("Terminating thread %1 of %2", n + 1, _threads.size ());
255 DCPOMATIC_ASSERT ((*i)->joinable ());
258 } catch (boost::thread_interrupted& e) {
259 /* This is to be expected */
262 LOG_GENERAL_NC ("Thread terminated");
270 J2KEncoder::encoder_thread (optional<EncodeServerDescription> server)
274 LOG_TIMING ("start-encoder-thread thread=%1 server=%2", thread_id (), server->host_name ());
276 LOG_TIMING ("start-encoder-thread thread=%1 server=localhost", thread_id ());
279 /* Number of seconds that we currently wait between attempts
280 to connect to the server; not relevant for localhost
283 int remote_backoff = 0;
287 LOG_TIMING ("encoder-sleep thread=%1", thread_id ());
288 boost::mutex::scoped_lock lock (_queue_mutex);
289 while (_queue.empty ()) {
290 _empty_condition.wait (lock);
293 LOG_TIMING ("encoder-wake thread=%1 queue=%2", thread_id(), _queue.size());
294 shared_ptr<DCPVideo> vf = _queue.front ();
296 /* We're about to commit to either encoding this frame or putting it back onto the queue,
297 so we must not be interrupted until one or other of these things have happened. This
298 block has thread interruption disabled.
301 boost::this_thread::disable_interruption dis;
303 LOG_TIMING ("encoder-pop thread=%1 frame=%2 eyes=%3", thread_id(), vf->index(), (int) 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", thread_id(), vf->index());
336 encoded = vf->encode_locally ();
337 LOG_TIMING ("finish-local-encode thread=%1 frame=%2", thread_id(), vf->index());
338 } catch (std::exception& e) {
339 /* This is very bad, so don't cope with it, just pass it on */
340 LOG_ERROR (N_("Local encode failed (%1)"), e.what ());
346 _writer->write (encoded.get(), vf->index (), vf->eyes ());
350 LOG_GENERAL (N_("[%1] J2KEncoder thread pushes frame %2 back onto queue after failure"), thread_id(), vf->index());
351 _queue.push_front (vf);
356 if (remote_backoff > 0) {
357 boost::this_thread::sleep (boost::posix_time::seconds (remote_backoff));
360 /* The queue might not be full any more, so notify anything that is waiting on that */
362 _full_condition.notify_all ();
365 catch (boost::thread_interrupted& e) {
366 /* Ignore these and just stop the thread */
367 _full_condition.notify_all ();
372 /* Wake anything waiting on _full_condition so it can see the exception */
373 _full_condition.notify_all ();
377 J2KEncoder::servers_list_changed ()
379 terminate_threads ();
381 /* XXX: could re-use threads */
383 boost::mutex::scoped_lock lm (_threads_mutex);
385 #ifdef BOOST_THREAD_PLATFORM_WIN32
387 info.dwOSVersionInfoSize = sizeof (OSVERSIONINFO);
388 GetVersionEx (&info);
389 bool const windows_xp = (info.dwMajorVersion == 5 && info.dwMinorVersion == 1);
391 LOG_GENERAL_NC (N_("Setting thread affinity for Windows XP"));
395 if (!Config::instance()->only_servers_encode ()) {
396 for (int i = 0; i < Config::instance()->master_encoding_threads (); ++i) {
397 boost::thread* t = new boost::thread (boost::bind (&J2KEncoder::encoder_thread, this, optional<EncodeServerDescription> ()));
398 #ifdef DCPOMATIC_LINUX
399 pthread_setname_np (t->native_handle(), "encode-worker");
401 _threads.push_back (t);
402 #ifdef BOOST_THREAD_PLATFORM_WIN32
404 SetThreadAffinityMask (t->native_handle(), 1 << i);
410 BOOST_FOREACH (EncodeServerDescription i, EncodeServerFinder::instance()->servers()) {
411 if (!i.current_link_version()) {
415 LOG_GENERAL (N_("Adding %1 worker threads for remote %2"), i.threads(), i.host_name ());
416 for (int j = 0; j < i.threads(); ++j) {
417 _threads.push_back (new boost::thread (boost::bind (&J2KEncoder::encoder_thread, this, i)));
421 _writer->set_encoder_threads (_threads.size ());