src/lib/j2k_encoder.cc

   1 /*
   2     Copyright (C) 2012-2019 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   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.
  10
  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.
  15
  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/>.
  18
  19 */
  20
  21 /** @file src/j2k_encoder.cc
  22  *  @brief J2K encoder class.
  23  */
  24
  25 #include "j2k_encoder.h"
  26 #include "util.h"
  27 #include "film.h"
  28 #include "log.h"
  29 #include "dcpomatic_log.h"
  30 #include "config.h"
  31 #include "dcp_video.h"
  32 #include "cross.h"
  33 #include "writer.h"
  34 #include "encode_server_finder.h"
  35 #include "player.h"
  36 #include "player_video.h"
  37 #include "encode_server_description.h"
  38 #include "compose.hpp"
  39 #include <libcxml/cxml.h>
  40 #include <iostream>
  41
  42 #include "i18n.h"
  43
  44 using std::list;
  45 using std::cout;
  46 using std::exception;
  47 using std::shared_ptr;
  48 using std::weak_ptr;
  49 using std::make_shared;
  50 using boost::optional;
  51 using dcp::Data;
  52 using namespace dcpomatic;
  53
  54 /** @param film Film that we are encoding.
  55  *  @param writer Writer that we are using.
  56  */
  57 J2KEncoder::J2KEncoder (shared_ptr<const Film> film, shared_ptr<Writer> writer)
  58         : _film (film)
  59         , _history (200)
  60         , _writer (writer)
  61 {
  62         servers_list_changed ();
  63 }
  64
  65 J2KEncoder::~J2KEncoder ()
  66 {
  67         boost::mutex::scoped_lock lm (_threads_mutex);
  68         terminate_threads ();
  69 }
  70
  71 void
  72 J2KEncoder::begin ()
  73 {
  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)
  77                 );
  78 }
  79
  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
  82    to achieve that.
  83 */
  84 void
  85 J2KEncoder::call_servers_list_changed (weak_ptr<J2KEncoder> encoder)
  86 {
  87         auto e = encoder.lock ();
  88         if (e) {
  89                 e->servers_list_changed ();
  90         }
  91 }
  92
  93 void
  94 J2KEncoder::end ()
  95 {
  96         boost::mutex::scoped_lock lock (_queue_mutex);
  97
  98         LOG_GENERAL (N_("Clearing queue of %1"), _queue.size ());
  99
 100         /* Keep waking workers until the queue is empty */
 101         while (!_queue.empty ()) {
 102                 rethrow ();
 103                 _empty_condition.notify_all ();
 104                 _full_condition.wait (lock);
 105         }
 106
 107         lock.unlock ();
 108
 109         LOG_GENERAL_NC (N_("Terminating encoder threads"));
 110
 111         {
 112                 boost::mutex::scoped_lock lm (_threads_mutex);
 113                 terminate_threads ();
 114         }
 115
 116         /* Something might have been thrown during terminate_threads */
 117         rethrow ();
 118
 119         LOG_GENERAL (N_("Mopping up %1"), _queue.size());
 120
 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
 126
 127              So just mop up anything left in the queue here.
 128         */
 129
 130         for (auto i: _queue) {
 131                 LOG_GENERAL(N_("Encode left-over frame %1"), i->index());
 132                 try {
 133                         _writer->write (
 134                                 make_shared<dcp::ArrayData>(i->encode_locally()),
 135                                 i->index(),
 136                                 i->eyes()
 137                                 );
 138                         frame_done ();
 139                 } catch (std::exception& e) {
 140                         LOG_ERROR (N_("Local encode failed (%1)"), e.what ());
 141                 }
 142         }
 143 }
 144
 145 /** @return an estimate of the current number of frames we are encoding per second,
 146  *  if known.
 147  */
 148 optional<float>
 149 J2KEncoder::current_encoding_rate () const
 150 {
 151         return _history.rate ();
 152 }
 153
 154 /** @return Number of video frames that have been queued for encoding */
 155 int
 156 J2KEncoder::video_frames_enqueued () const
 157 {
 158         if (!_last_player_video_time) {
 159                 return 0;
 160         }
 161
 162         return _last_player_video_time->frames_floor (_film->video_frame_rate ());
 163 }
 164
 165 /** Should be called when a frame has been encoded successfully */
 166 void
 167 J2KEncoder::frame_done ()
 168 {
 169         _history.event ();
 170 }
 171
 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.
 176  *
 177  *  @param pv PlayerVideo to encode.
 178  *  @param time Time of \p pv within the DCP.
 179  */
 180 void
 181 J2KEncoder::encode (shared_ptr<PlayerVideo> pv, DCPTime time)
 182 {
 183         _waker.nudge ();
 184
 185         size_t threads = 0;
 186         {
 187                 boost::mutex::scoped_lock lm (_threads_mutex);
 188                 threads = _threads->size();
 189         }
 190
 191         boost::mutex::scoped_lock queue_lock (_queue_mutex);
 192
 193         /* Wait until the queue has gone down a bit.  Allow one thing in the queue even
 194            when there are no threads.
 195         */
 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);
 200         }
 201
 202         _writer->rethrow ();
 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.
 206         */
 207         rethrow ();
 208
 209         auto const position = time.frames_floor(_film->video_frame_rate());
 210
 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 ());
 215                 frame_done ();
 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 ());
 220                 frame_done ();
 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 ());
 224         } else {
 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 (make_shared<DCPVideo>(
 229                                 pv,
 230                                 position,
 231                                 _film->video_frame_rate(),
 232                                 _film->j2k_bandwidth(),
 233                                 _film->resolution()
 234                                 ));
 235
 236                 /* The queue might not be empty any more, so notify anything which is
 237                    waiting on that.
 238                 */
 239                 _empty_condition.notify_all ();
 240         }
 241
 242         _last_player_video[pv->eyes()] = pv;
 243         _last_player_video_time = time;
 244 }
 245
 246
 247 /** Caller must hold a lock on _threads_mutex */
 248 void
 249 J2KEncoder::terminate_threads ()
 250 {
 251         boost::this_thread::disable_interruption dis;
 252
 253         if (!_threads) {
 254                 return;
 255         }
 256
 257         _threads->interrupt_all ();
 258         try {
 259                 _threads->join_all ();
 260         } catch (exception& e) {
 261                 LOG_ERROR ("join() threw an exception: %1", e.what());
 262         } catch (...) {
 263                 LOG_ERROR_NC ("join() threw an exception");
 264         }
 265
 266         _threads.reset ();
 267 }
 268
 269 void
 270 J2KEncoder::encoder_thread (optional<EncodeServerDescription> server)
 271 try
 272 {
 273         if (server) {
 274                 LOG_TIMING ("start-encoder-thread thread=%1 server=%2", thread_id (), server->host_name ());
 275         } else {
 276                 LOG_TIMING ("start-encoder-thread thread=%1 server=localhost", thread_id ());
 277         }
 278
 279         /* Number of seconds that we currently wait between attempts
 280            to connect to the server; not relevant for localhost
 281            encodings.
 282         */
 283         int remote_backoff = 0;
 284
 285         while (true) {
 286
 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);
 291                 }
 292
 293                 LOG_TIMING ("encoder-wake thread=%1 queue=%2", thread_id(), _queue.size());
 294                 auto vf = _queue.front ();
 295
 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.
 299                 */
 300                 {
 301                         boost::this_thread::disable_interruption dis;
 302
 303                         LOG_TIMING ("encoder-pop thread=%1 frame=%2 eyes=%3", thread_id(), vf->index(), (int) vf->eyes ());
 304                         _queue.pop_front ();
 305
 306                         lock.unlock ();
 307
 308                         shared_ptr<Data> encoded;
 309
 310                         /* We need to encode this input */
 311                         if (server) {
 312                                 try {
 313                                         encoded = make_shared<dcp::ArrayData>(vf->encode_remotely(server.get()));
 314
 315                                         if (remote_backoff > 0) {
 316                                                 LOG_GENERAL ("%1 was lost, but now she is found; removing backoff", server->host_name ());
 317                                         }
 318
 319                                         /* This job succeeded, so remove any backoff */
 320                                         remote_backoff = 0;
 321
 322                                 } catch (std::exception& e) {
 323                                         if (remote_backoff < 60) {
 324                                                 /* back off more */
 325                                                 remote_backoff += 10;
 326                                         }
 327                                         LOG_ERROR (
 328                                                 N_("Remote encode of %1 on %2 failed (%3); thread sleeping for %4s"),
 329                                                 vf->index(), server->host_name(), e.what(), remote_backoff
 330                                                 );
 331                                 }
 332
 333                         } else {
 334                                 try {
 335                                         LOG_TIMING ("start-local-encode thread=%1 frame=%2", thread_id(), vf->index());
 336                                         encoded = make_shared<dcp::ArrayData>(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 ());
 341                                         throw;
 342                                 }
 343                         }
 344
 345                         if (encoded) {
 346                                 _writer->write (encoded, vf->index(), vf->eyes());
 347                                 frame_done ();
 348                         } else {
 349                                 lock.lock ();
 350                                 LOG_GENERAL (N_("[%1] J2KEncoder thread pushes frame %2 back onto queue after failure"), thread_id(), vf->index());
 351                                 _queue.push_front (vf);
 352                                 lock.unlock ();
 353                         }
 354                 }
 355
 356                 if (remote_backoff > 0) {
 357                         boost::this_thread::sleep (boost::posix_time::seconds (remote_backoff));
 358                 }
 359
 360                 /* The queue might not be full any more, so notify anything that is waiting on that */
 361                 lock.lock ();
 362                 _full_condition.notify_all ();
 363         }
 364 }
 365 catch (boost::thread_interrupted& e) {
 366         /* Ignore these and just stop the thread */
 367         _full_condition.notify_all ();
 368 }
 369 catch (...)
 370 {
 371         store_current ();
 372         /* Wake anything waiting on _full_condition so it can see the exception */
 373         _full_condition.notify_all ();
 374 }
 375
 376 void
 377 J2KEncoder::servers_list_changed ()
 378 {
 379         boost::mutex::scoped_lock lm (_threads_mutex);
 380
 381         terminate_threads ();
 382         _threads = make_shared<boost::thread_group>();
 383
 384         /* XXX: could re-use threads */
 385
 386         if (!Config::instance()->only_servers_encode ()) {
 387                 for (int i = 0; i < Config::instance()->master_encoding_threads (); ++i) {
 388 #ifdef DCPOMATIC_LINUX
 389                         auto t = _threads->create_thread(boost::bind(&J2KEncoder::encoder_thread, this, optional<EncodeServerDescription>()));
 390                         pthread_setname_np (t->native_handle(), "encode-worker");
 391 #else
 392                         _threads->create_thread(boost::bind(&J2KEncoder::encoder_thread, this, optional<EncodeServerDescription>()));
 393 #endif
 394                 }
 395         }
 396
 397         for (auto i: EncodeServerFinder::instance()->servers()) {
 398                 if (!i.current_link_version()) {
 399                         continue;
 400                 }
 401
 402                 LOG_GENERAL (N_("Adding %1 worker threads for remote %2"), i.threads(), i.host_name ());
 403                 for (int j = 0; j < i.threads(); ++j) {
 404                         _threads->create_thread(boost::bind(&J2KEncoder::encoder_thread, this, i));
 405                 }
 406         }
 407
 408         _writer->set_encoder_threads (_threads->size());
 409 }