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