src/lib/encoder.cc

   1 /*
   2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file src/encoder.h
  21  *  @brief Parent class for classes which can encode video and audio frames.
  22  */
  23
  24 #include <iostream>
  25 #include "encoder.h"
  26 #include "util.h"
  27 #include "film.h"
  28 #include "log.h"
  29 #include "config.h"
  30 #include "dcp_video_frame.h"
  31 #include "server.h"
  32 #include "cross.h"
  33 #include "writer.h"
  34
  35 #include "i18n.h"
  36
  37 using std::pair;
  38 using std::string;
  39 using std::stringstream;
  40 using std::vector;
  41 using std::list;
  42 using std::cout;
  43 using std::make_pair;
  44 using boost::shared_ptr;
  45 using boost::optional;
  46
  47 int const Encoder::_history_size = 25;
  48
  49 /** @param f Film that we are encoding */
  50 Encoder::Encoder (shared_ptr<const Film> f, shared_ptr<Job> j)
  51         : _film (f)
  52         , _job (j)
  53         , _video_frames_out (0)
  54         , _have_a_real_frame (false)
  55         , _terminate (false)
  56 {
  57
  58 }
  59
  60 Encoder::~Encoder ()
  61 {
  62         terminate_threads ();
  63         if (_writer) {
  64                 _writer->finish ();
  65         }
  66 }
  67
  68 void
  69 Encoder::process_begin ()
  70 {
  71         for (int i = 0; i < Config::instance()->num_local_encoding_threads (); ++i) {
  72                 _threads.push_back (new boost::thread (boost::bind (&Encoder::encoder_thread, this, (ServerDescription *) 0)));
  73         }
  74
  75         vector<ServerDescription*> servers = Config::instance()->servers ();
  76
  77         for (vector<ServerDescription*>::iterator i = servers.begin(); i != servers.end(); ++i) {
  78                 for (int j = 0; j < (*i)->threads (); ++j) {
  79                         _threads.push_back (new boost::thread (boost::bind (&Encoder::encoder_thread, this, *i)));
  80                 }
  81         }
  82
  83         _writer.reset (new Writer (_film, _job));
  84 }
  85
  86
  87 void
  88 Encoder::process_end ()
  89 {
  90         boost::mutex::scoped_lock lock (_mutex);
  91
  92         _film->log()->log (String::compose (N_("Clearing queue of %1"), _queue.size ()));
  93
  94         /* Keep waking workers until the queue is empty */
  95         while (!_queue.empty ()) {
  96                 _film->log()->log (String::compose (N_("Waking with %1"), _queue.size ()), Log::VERBOSE);
  97                 _condition.notify_all ();
  98                 _condition.wait (lock);
  99         }
 100
 101         lock.unlock ();
 102
 103         terminate_threads ();
 104
 105         _film->log()->log (String::compose (N_("Mopping up %1"), _queue.size()));
 106
 107         /* The following sequence of events can occur in the above code:
 108              1. a remote worker takes the last image off the queue
 109              2. the loop above terminates
 110              3. the remote worker fails to encode the image and puts it back on the queue
 111              4. the remote worker is then terminated by terminate_threads
 112
 113              So just mop up anything left in the queue here.
 114         */
 115
 116         for (list<shared_ptr<DCPVideoFrame> >::iterator i = _queue.begin(); i != _queue.end(); ++i) {
 117                 _film->log()->log (String::compose (N_("Encode left-over frame %1"), (*i)->frame ()));
 118                 try {
 119                         _writer->write ((*i)->encode_locally(), (*i)->frame ());
 120                         frame_done ();
 121                 } catch (std::exception& e) {
 122                         _film->log()->log (String::compose (N_("Local encode failed (%1)"), e.what ()));
 123                 }
 124         }
 125
 126         _writer->finish ();
 127         _writer.reset ();
 128 }
 129
 130 /** @return an estimate of the current number of frames we are encoding per second,
 131  *  or 0 if not known.
 132  */
 133 float
 134 Encoder::current_encoding_rate () const
 135 {
 136         boost::mutex::scoped_lock lock (_history_mutex);
 137         if (int (_time_history.size()) < _history_size) {
 138                 return 0;
 139         }
 140
 141         struct timeval now;
 142         gettimeofday (&now, 0);
 143
 144         return _history_size / (seconds (now) - seconds (_time_history.back ()));
 145 }
 146
 147 /** @return Number of video frames that have been sent out */
 148 int
 149 Encoder::video_frames_out () const
 150 {
 151         boost::mutex::scoped_lock (_history_mutex);
 152         return _video_frames_out;
 153 }
 154
 155 /** Should be called when a frame has been encoded successfully.
 156  *  @param n Source frame index.
 157  */
 158 void
 159 Encoder::frame_done ()
 160 {
 161         boost::mutex::scoped_lock lock (_history_mutex);
 162
 163         struct timeval tv;
 164         gettimeofday (&tv, 0);
 165         _time_history.push_front (tv);
 166         if (int (_time_history.size()) > _history_size) {
 167                 _time_history.pop_back ();
 168         }
 169 }
 170
 171 void
 172 Encoder::process_video (shared_ptr<const Image> image, bool same, Time)
 173 {
 174         boost::mutex::scoped_lock lock (_mutex);
 175
 176         /* Wait until the queue has gone down a bit */
 177         while (_queue.size() >= _threads.size() * 2 && !_terminate) {
 178                 TIMING ("decoder sleeps with queue of %1", _queue.size());
 179                 _condition.wait (lock);
 180                 TIMING ("decoder wakes with queue of %1", _queue.size());
 181         }
 182
 183         if (_terminate) {
 184                 return;
 185         }
 186
 187         if (_writer->thrown ()) {
 188                 _writer->rethrow ();
 189         }
 190
 191         if (_writer->can_fake_write (_video_frames_out)) {
 192                 _writer->fake_write (_video_frames_out);
 193                 _have_a_real_frame = false;
 194                 frame_done ();
 195         } else if (same && _have_a_real_frame) {
 196                 /* Use the last frame that we encoded. */
 197                 _writer->repeat (_video_frames_out);
 198                 frame_done ();
 199         } else {
 200                 /* Queue this new frame for encoding */
 201                 TIMING ("adding to queue of %1", _queue.size ());
 202                 /* XXX: padding */
 203                 _queue.push_back (shared_ptr<DCPVideoFrame> (
 204                                           new DCPVideoFrame (
 205                                                   image, _video_frames_out, _film->dcp_video_frame_rate(),
 206                                                   _film->colour_lut(), _film->j2k_bandwidth(), _film->log()
 207                                                   )
 208                                           ));
 209
 210                 _condition.notify_all ();
 211                 _have_a_real_frame = true;
 212         }
 213
 214         ++_video_frames_out;
 215 }
 216
 217 void
 218 Encoder::process_audio (shared_ptr<const AudioBuffers> data, Time)
 219 {
 220         _writer->write (data);
 221 }
 222
 223 void
 224 Encoder::terminate_threads ()
 225 {
 226         boost::mutex::scoped_lock lock (_mutex);
 227         _terminate = true;
 228         _condition.notify_all ();
 229         lock.unlock ();
 230
 231         for (list<boost::thread *>::iterator i = _threads.begin(); i != _threads.end(); ++i) {
 232                 if ((*i)->joinable ()) {
 233                         (*i)->join ();
 234                 }
 235                 delete *i;
 236         }
 237
 238         _threads.clear ();
 239 }
 240
 241 void
 242 Encoder::encoder_thread (ServerDescription* server)
 243 {
 244         /* Number of seconds that we currently wait between attempts
 245            to connect to the server; not relevant for localhost
 246            encodings.
 247         */
 248         int remote_backoff = 0;
 249
 250         while (1) {
 251
 252                 TIMING ("encoder thread %1 sleeps", boost::this_thread::get_id());
 253                 boost::mutex::scoped_lock lock (_mutex);
 254                 while (_queue.empty () && !_terminate) {
 255                         _condition.wait (lock);
 256                 }
 257
 258                 if (_terminate) {
 259                         return;
 260                 }
 261
 262                 TIMING ("encoder thread %1 wakes with queue of %2", boost::this_thread::get_id(), _queue.size());
 263                 shared_ptr<DCPVideoFrame> vf = _queue.front ();
 264                 _film->log()->log (String::compose (N_("Encoder thread %1 pops frame %2 from queue"), boost::this_thread::get_id(), vf->frame()), Log::VERBOSE);
 265                 _queue.pop_front ();
 266
 267                 lock.unlock ();
 268
 269                 shared_ptr<EncodedData> encoded;
 270
 271                 if (server) {
 272                         try {
 273                                 encoded = vf->encode_remotely (server);
 274
 275                                 if (remote_backoff > 0) {
 276                                         _film->log()->log (String::compose (N_("%1 was lost, but now she is found; removing backoff"), server->host_name ()));
 277                                 }
 278
 279                                 /* This job succeeded, so remove any backoff */
 280                                 remote_backoff = 0;
 281
 282                         } catch (std::exception& e) {
 283                                 if (remote_backoff < 60) {
 284                                         /* back off more */
 285                                         remote_backoff += 10;
 286                                 }
 287                                 _film->log()->log (
 288                                         String::compose (
 289                                                 N_("Remote encode of %1 on %2 failed (%3); thread sleeping for %4s"),
 290                                                 vf->frame(), server->host_name(), e.what(), remote_backoff)
 291                                         );
 292                         }
 293
 294                 } else {
 295                         try {
 296                                 TIMING ("encoder thread %1 begins local encode of %2", boost::this_thread::get_id(), vf->frame());
 297                                 encoded = vf->encode_locally ();
 298                                 TIMING ("encoder thread %1 finishes local encode of %2", boost::this_thread::get_id(), vf->frame());
 299                         } catch (std::exception& e) {
 300                                 _film->log()->log (String::compose (N_("Local encode failed (%1)"), e.what ()));
 301                         }
 302                 }
 303
 304                 if (encoded) {
 305                         _writer->write (encoded, vf->frame ());
 306                         frame_done ();
 307                 } else {
 308                         lock.lock ();
 309                         _film->log()->log (
 310                                 String::compose (N_("Encoder thread %1 pushes frame %2 back onto queue after failure"), boost::this_thread::get_id(), vf->frame())
 311                                 );
 312                         _queue.push_front (vf);
 313                         lock.unlock ();
 314                 }
 315
 316                 if (remote_backoff > 0) {
 317                         dcpomatic_sleep (remote_backoff);
 318                 }
 319
 320                 lock.lock ();
 321                 _condition.notify_all ();
 322         }
 323 }