2 Copyright (C) 2012-2021 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/>.
22 /** @file src/j2k_encoder.cc
23 * @brief J2K encoder class.
27 #include "compose.hpp"
30 #include "dcp_video.h"
31 #include "dcpomatic_log.h"
32 #include "encode_server_description.h"
33 #include "encode_server_finder.h"
35 #include "j2k_encoder.h"
37 #include "player_video.h"
40 #include <libcxml/cxml.h>
49 using std::make_shared;
50 using std::shared_ptr;
52 using boost::optional;
54 using namespace dcpomatic;
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 ();
69 J2KEncoder::~J2KEncoder ()
71 boost::mutex::scoped_lock lm (_threads_mutex);
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)
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 auto e = encoder.lock ();
95 e->servers_list_changed ();
103 boost::mutex::scoped_lock lock (_queue_mutex);
105 LOG_GENERAL (N_("Clearing queue of %1"), _queue.size ());
107 /* Keep waking workers until the queue is empty */
108 while (!_queue.empty ()) {
110 _empty_condition.notify_all ();
111 _full_condition.wait (lock);
116 LOG_GENERAL_NC (N_("Terminating encoder threads"));
119 boost::mutex::scoped_lock lm (_threads_mutex);
120 terminate_threads ();
123 /* Something might have been thrown during terminate_threads */
126 LOG_GENERAL (N_("Mopping up %1"), _queue.size());
128 /* The following sequence of events can occur in the above code:
129 1. a remote worker takes the last image off the queue
130 2. the loop above terminates
131 3. the remote worker fails to encode the image and puts it back on the queue
132 4. the remote worker is then terminated by terminate_threads
134 So just mop up anything left in the queue here.
137 for (auto const& i: _queue) {
138 LOG_GENERAL(N_("Encode left-over frame %1"), i.index());
141 make_shared<dcp::ArrayData>(i.encode_locally()),
146 } catch (std::exception& e) {
147 LOG_ERROR (N_("Local encode failed (%1)"), e.what ());
153 /** @return an estimate of the current number of frames we are encoding per second,
157 J2KEncoder::current_encoding_rate () const
159 return _history.rate ();
163 /** @return Number of video frames that have been queued for encoding */
165 J2KEncoder::video_frames_enqueued () const
167 if (!_last_player_video_time) {
171 return _last_player_video_time->frames_floor (_film->video_frame_rate ());
175 /** Should be called when a frame has been encoded successfully */
177 J2KEncoder::frame_done ()
183 /** Called to request encoding of the next video frame in the DCP. This is called in order,
184 * so each time the supplied frame is the one after the previous one.
185 * pv represents one video frame, and could be empty if there is nothing to encode
186 * for this DCP frame.
188 * @param pv PlayerVideo to encode.
189 * @param time Time of \p pv within the DCP.
192 J2KEncoder::encode (shared_ptr<PlayerVideo> pv, DCPTime time)
198 boost::mutex::scoped_lock lm (_threads_mutex);
199 threads = _threads->size();
202 boost::mutex::scoped_lock queue_lock (_queue_mutex);
204 /* Wait until the queue has gone down a bit. Allow one thing in the queue even
205 when there are no threads.
207 while (_queue.size() >= (threads * 2) + 1) {
208 LOG_TIMING ("decoder-sleep queue=%1 threads=%2", _queue.size(), threads);
209 _full_condition.wait (queue_lock);
210 LOG_TIMING ("decoder-wake queue=%1 threads=%2", _queue.size(), threads);
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 auto const position = time.frames_floor(_film->video_frame_rate());
222 if (_writer->can_fake_write (position)) {
223 /* We can fake-write this frame */
224 LOG_DEBUG_ENCODE("Frame @ %1 FAKE", to_string(time));
225 _writer->fake_write (position, pv->eyes ());
227 } else if (pv->has_j2k() && !_film->reencode_j2k()) {
228 LOG_DEBUG_ENCODE("Frame @ %1 J2K", to_string(time));
229 /* This frame already has J2K data, so just write it */
230 _writer->write (pv->j2k(), position, pv->eyes ());
232 } else if (_last_player_video[static_cast<int>(pv->eyes())] && _writer->can_repeat(position) && pv->same (_last_player_video[static_cast<int>(pv->eyes())])) {
233 LOG_DEBUG_ENCODE("Frame @ %1 REPEAT", to_string(time));
234 _writer->repeat (position, pv->eyes ());
236 LOG_DEBUG_ENCODE("Frame @ %1 ENCODE", to_string(time));
237 /* Queue this new frame for encoding */
238 LOG_TIMING ("add-frame-to-queue queue=%1", _queue.size ());
239 _queue.push_back (DCPVideo(
242 _film->video_frame_rate(),
243 _film->j2k_bandwidth(),
247 /* The queue might not be empty any more, so notify anything which is
250 _empty_condition.notify_all ();
253 _last_player_video[static_cast<int>(pv->eyes())] = pv;
254 _last_player_video_time = time;
258 /** Caller must hold a lock on _threads_mutex */
260 J2KEncoder::terminate_threads ()
262 boost::this_thread::disable_interruption dis;
268 _threads->interrupt_all ();
270 _threads->join_all ();
271 } catch (exception& e) {
272 LOG_ERROR ("join() threw an exception: %1", e.what());
274 LOG_ERROR_NC ("join() threw an exception");
282 J2KEncoder::encoder_thread (optional<EncodeServerDescription> server)
285 start_of_thread ("J2KEncoder");
288 LOG_TIMING ("start-encoder-thread thread=%1 server=%2", thread_id (), server->host_name ());
290 LOG_TIMING ("start-encoder-thread thread=%1 server=localhost", thread_id ());
293 /* Number of seconds that we currently wait between attempts
294 to connect to the server; not relevant for localhost
297 int remote_backoff = 0;
301 LOG_TIMING ("encoder-sleep thread=%1", thread_id ());
302 boost::mutex::scoped_lock lock (_queue_mutex);
303 while (_queue.empty ()) {
304 _empty_condition.wait (lock);
307 LOG_TIMING ("encoder-wake thread=%1 queue=%2", thread_id(), _queue.size());
308 auto vf = _queue.front ();
310 /* We're about to commit to either encoding this frame or putting it back onto the queue,
311 so we must not be interrupted until one or other of these things have happened. This
312 block has thread interruption disabled.
315 boost::this_thread::disable_interruption dis;
317 LOG_TIMING ("encoder-pop thread=%1 frame=%2 eyes=%3", thread_id(), vf.index(), static_cast<int>(vf.eyes()));
322 shared_ptr<Data> encoded;
324 /* We need to encode this input */
327 encoded = make_shared<dcp::ArrayData>(vf.encode_remotely(server.get()));
329 if (remote_backoff > 0) {
330 LOG_GENERAL ("%1 was lost, but now she is found; removing backoff", server->host_name ());
333 /* This job succeeded, so remove any backoff */
336 } catch (std::exception& e) {
337 if (remote_backoff < 60) {
339 remote_backoff += 10;
342 N_("Remote encode of %1 on %2 failed (%3); thread sleeping for %4s"),
343 vf.index(), server->host_name(), e.what(), remote_backoff
349 LOG_TIMING ("start-local-encode thread=%1 frame=%2", thread_id(), vf.index());
350 encoded = make_shared<dcp::ArrayData>(vf.encode_locally());
351 LOG_TIMING ("finish-local-encode thread=%1 frame=%2", thread_id(), vf.index());
352 } catch (std::exception& e) {
353 /* This is very bad, so don't cope with it, just pass it on */
354 LOG_ERROR (N_("Local encode failed (%1)"), e.what ());
360 _writer->write (encoded, vf.index(), vf.eyes());
364 LOG_GENERAL (N_("[%1] J2KEncoder thread pushes frame %2 back onto queue after failure"), thread_id(), vf.index());
365 _queue.push_front (vf);
370 if (remote_backoff > 0) {
371 boost::this_thread::sleep (boost::posix_time::seconds (remote_backoff));
374 /* The queue might not be full any more, so notify anything that is waiting on that */
376 _full_condition.notify_all ();
379 catch (boost::thread_interrupted& e) {
380 /* Ignore these and just stop the thread */
381 _full_condition.notify_all ();
386 /* Wake anything waiting on _full_condition so it can see the exception */
387 _full_condition.notify_all ();
392 J2KEncoder::servers_list_changed ()
394 boost::mutex::scoped_lock lm (_threads_mutex);
396 terminate_threads ();
397 _threads = make_shared<boost::thread_group>();
399 /* XXX: could re-use threads */
401 if (!Config::instance()->only_servers_encode ()) {
402 for (int i = 0; i < Config::instance()->master_encoding_threads (); ++i) {
403 #ifdef DCPOMATIC_LINUX
404 auto t = _threads->create_thread(boost::bind(&J2KEncoder::encoder_thread, this, optional<EncodeServerDescription>()));
405 pthread_setname_np (t->native_handle(), "encode-worker");
407 _threads->create_thread(boost::bind(&J2KEncoder::encoder_thread, this, optional<EncodeServerDescription>()));
412 for (auto i: EncodeServerFinder::instance()->servers()) {
413 if (!i.current_link_version()) {
417 LOG_GENERAL (N_("Adding %1 worker threads for remote %2"), i.threads(), i.host_name ());
418 for (int j = 0; j < i.threads(); ++j) {
419 _threads->create_thread(boost::bind(&J2KEncoder::encoder_thread, this, i));
423 _writer->set_encoder_threads (_threads->size());