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 std::shared_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 ()
67 boost::mutex::scoped_lock lm (_threads_mutex);
74 weak_ptr<J2KEncoder> wp = shared_from_this ();
75 _server_found_connection = EncodeServerFinder::instance()->ServersListChanged.connect (
76 boost::bind (&J2KEncoder::call_servers_list_changed, wp)
80 /* We don't want the servers-list-changed callback trying to do things
81 during destruction of J2KEncoder, and I think this is the neatest way
85 J2KEncoder::call_servers_list_changed (weak_ptr<J2KEncoder> encoder)
87 shared_ptr<J2KEncoder> e = encoder.lock ();
89 e->servers_list_changed ();
96 boost::mutex::scoped_lock lock (_queue_mutex);
98 LOG_GENERAL (N_("Clearing queue of %1"), _queue.size ());
100 /* Keep waking workers until the queue is empty */
101 while (!_queue.empty ()) {
103 _empty_condition.notify_all ();
104 _full_condition.wait (lock);
109 LOG_GENERAL_NC (N_("Terminating encoder threads"));
112 boost::mutex::scoped_lock lm (_threads_mutex);
113 terminate_threads ();
116 /* Something might have been thrown during terminate_threads */
119 LOG_GENERAL (N_("Mopping up %1"), _queue.size());
121 /* The following sequence of events can occur in the above code:
122 1. a remote worker takes the last image off the queue
123 2. the loop above terminates
124 3. the remote worker fails to encode the image and puts it back on the queue
125 4. the remote worker is then terminated by terminate_threads
127 So just mop up anything left in the queue here.
130 for (list<shared_ptr<DCPVideo> >::iterator i = _queue.begin(); i != _queue.end(); ++i) {
131 LOG_GENERAL (N_("Encode left-over frame %1"), (*i)->index ());
134 shared_ptr<dcp::Data>(new dcp::ArrayData((*i)->encode_locally())),
139 } catch (std::exception& e) {
140 LOG_ERROR (N_("Local encode failed (%1)"), e.what ());
145 /** @return an estimate of the current number of frames we are encoding per second,
149 J2KEncoder::current_encoding_rate () const
151 return _history.rate ();
154 /** @return Number of video frames that have been queued for encoding */
156 J2KEncoder::video_frames_enqueued () const
158 if (!_last_player_video_time) {
162 return _last_player_video_time->frames_floor (_film->video_frame_rate ());
165 /** Should be called when a frame has been encoded successfully */
167 J2KEncoder::frame_done ()
172 /** Called to request encoding of the next video frame in the DCP. This is called in order,
173 * so each time the supplied frame is the one after the previous one.
174 * pv represents one video frame, and could be empty if there is nothing to encode
175 * for this DCP frame.
177 * @param pv PlayerVideo to encode.
178 * @param time Time of \p pv within the DCP.
181 J2KEncoder::encode (shared_ptr<PlayerVideo> pv, DCPTime time)
187 boost::mutex::scoped_lock lm (_threads_mutex);
188 threads = _threads->size();
191 boost::mutex::scoped_lock queue_lock (_queue_mutex);
193 /* Wait until the queue has gone down a bit. Allow one thing in the queue even
194 when there are no threads.
196 while (_queue.size() >= (threads * 2) + 1) {
197 LOG_TIMING ("decoder-sleep queue=%1 threads=%2", _queue.size(), threads);
198 _full_condition.wait (queue_lock);
199 LOG_TIMING ("decoder-wake queue=%1 threads=%2", _queue.size(), threads);
203 /* Re-throw any exception raised by one of our threads. If more
204 than one has thrown an exception, only one will be rethrown, I think;
205 but then, if that happens something has gone badly wrong.
209 Frame const position = time.frames_floor(_film->video_frame_rate());
211 if (_writer->can_fake_write (position)) {
212 /* We can fake-write this frame */
213 LOG_DEBUG_ENCODE("Frame @ %1 FAKE", to_string(time));
214 _writer->fake_write (position, pv->eyes ());
216 } else if (pv->has_j2k() && !_film->reencode_j2k()) {
217 LOG_DEBUG_ENCODE("Frame @ %1 J2K", to_string(time));
218 /* This frame already has J2K data, so just write it */
219 _writer->write (pv->j2k(), position, pv->eyes ());
221 } else if (_last_player_video[pv->eyes()] && _writer->can_repeat(position) && pv->same (_last_player_video[pv->eyes()])) {
222 LOG_DEBUG_ENCODE("Frame @ %1 REPEAT", to_string(time));
223 _writer->repeat (position, pv->eyes ());
225 LOG_DEBUG_ENCODE("Frame @ %1 ENCODE", to_string(time));
226 /* Queue this new frame for encoding */
227 LOG_TIMING ("add-frame-to-queue queue=%1", _queue.size ());
228 _queue.push_back (shared_ptr<DCPVideo> (
232 _film->video_frame_rate(),
233 _film->j2k_bandwidth(),
238 /* The queue might not be empty any more, so notify anything which is
241 _empty_condition.notify_all ();
244 _last_player_video[pv->eyes()] = pv;
245 _last_player_video_time = time;
249 /** Caller must hold a lock on _threads_mutex */
251 J2KEncoder::terminate_threads ()
253 boost::this_thread::disable_interruption dis;
259 _threads->interrupt_all ();
261 _threads->join_all ();
262 } catch (exception& e) {
263 LOG_ERROR ("join() threw an exception: %1", e.what());
265 LOG_ERROR_NC ("join() threw an exception");
272 J2KEncoder::encoder_thread (optional<EncodeServerDescription> server)
276 LOG_TIMING ("start-encoder-thread thread=%1 server=%2", thread_id (), server->host_name ());
278 LOG_TIMING ("start-encoder-thread thread=%1 server=localhost", thread_id ());
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 ("encoder-sleep thread=%1", thread_id ());
290 boost::mutex::scoped_lock lock (_queue_mutex);
291 while (_queue.empty ()) {
292 _empty_condition.wait (lock);
295 LOG_TIMING ("encoder-wake thread=%1 queue=%2", thread_id(), _queue.size());
296 shared_ptr<DCPVideo> vf = _queue.front ();
298 /* We're about to commit to either encoding this frame or putting it back onto the queue,
299 so we must not be interrupted until one or other of these things have happened. This
300 block has thread interruption disabled.
303 boost::this_thread::disable_interruption dis;
305 LOG_TIMING ("encoder-pop thread=%1 frame=%2 eyes=%3", thread_id(), vf->index(), (int) vf->eyes ());
310 shared_ptr<Data> encoded;
312 /* We need to encode this input */
315 encoded.reset(new dcp::ArrayData(vf->encode_remotely(server.get())));
317 if (remote_backoff > 0) {
318 LOG_GENERAL ("%1 was lost, but now she is found; removing backoff", server->host_name ());
321 /* This job succeeded, so remove any backoff */
324 } catch (std::exception& e) {
325 if (remote_backoff < 60) {
327 remote_backoff += 10;
330 N_("Remote encode of %1 on %2 failed (%3); thread sleeping for %4s"),
331 vf->index(), server->host_name(), e.what(), remote_backoff
337 LOG_TIMING ("start-local-encode thread=%1 frame=%2", thread_id(), vf->index());
338 encoded.reset(new dcp::ArrayData(vf->encode_locally()));
339 LOG_TIMING ("finish-local-encode thread=%1 frame=%2", thread_id(), vf->index());
340 } catch (std::exception& e) {
341 /* This is very bad, so don't cope with it, just pass it on */
342 LOG_ERROR (N_("Local encode failed (%1)"), e.what ());
348 _writer->write (encoded, vf->index(), vf->eyes());
352 LOG_GENERAL (N_("[%1] J2KEncoder thread pushes frame %2 back onto queue after failure"), thread_id(), vf->index());
353 _queue.push_front (vf);
358 if (remote_backoff > 0) {
359 boost::this_thread::sleep (boost::posix_time::seconds (remote_backoff));
362 /* The queue might not be full any more, so notify anything that is waiting on that */
364 _full_condition.notify_all ();
367 catch (boost::thread_interrupted& e) {
368 /* Ignore these and just stop the thread */
369 _full_condition.notify_all ();
374 /* Wake anything waiting on _full_condition so it can see the exception */
375 _full_condition.notify_all ();
379 J2KEncoder::servers_list_changed ()
381 boost::mutex::scoped_lock lm (_threads_mutex);
383 terminate_threads ();
384 _threads.reset (new boost::thread_group());
386 /* XXX: could re-use threads */
388 if (!Config::instance()->only_servers_encode ()) {
389 for (int i = 0; i < Config::instance()->master_encoding_threads (); ++i) {
390 #ifdef DCPOMATIC_LINUX
391 boost::thread* t = _threads->create_thread(boost::bind(&J2KEncoder::encoder_thread, this, optional<EncodeServerDescription>()));
392 pthread_setname_np (t->native_handle(), "encode-worker");
394 _threads->create_thread(boost::bind(&J2KEncoder::encoder_thread, this, optional<EncodeServerDescription>()));
399 BOOST_FOREACH (EncodeServerDescription i, EncodeServerFinder::instance()->servers()) {
400 if (!i.current_link_version()) {
404 LOG_GENERAL (N_("Adding %1 worker threads for remote %2"), i.threads(), i.host_name ());
405 for (int j = 0; j < i.threads(); ++j) {
406 _threads->create_thread(boost::bind(&J2KEncoder::encoder_thread, this, i));
410 _writer->set_encoder_threads (_threads->size());