X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Fencoder.cc;h=1d688c31868d49450140e7381994f3431fe6bb5d;hp=8caa0190c38726121d182b1f81e27ebf99b85295;hb=ac34066d5e448d1984d11a180be74e31b6e13b5c;hpb=f4030653da8f5a0b3daebe640f485b3daf9ef091 diff --git a/src/lib/encoder.cc b/src/lib/encoder.cc index 8caa0190c..1d688c318 100644 --- a/src/lib/encoder.cc +++ b/src/lib/encoder.cc @@ -1,348 +1,47 @@ /* - Copyright (C) 2012-2014 Carl Hetherington + Copyright (C) 2012-2017 Carl Hetherington - This program is free software; you can redistribute it and/or modify + This file is part of DCP-o-matic. + + DCP-o-matic is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. - This program is distributed in the hope that it will be useful, + DCP-o-matic is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + along with DCP-o-matic. If not, see . */ -/** @file src/encoder.h - * @brief Parent class for classes which can encode video and audio frames. + +/** @file src/encoder.cc + * @brief A class which takes a Film and some Options, then uses those to encode the film + * into some output format. + * + * A decoder is selected according to the content type, and the encoder can be specified + * as a parameter to the constructor. */ -#include -#include -#include + #include "encoder.h" -#include "util.h" -#include "film.h" -#include "log.h" -#include "config.h" -#include "dcp_video.h" -#include "server.h" -#include "cross.h" -#include "writer.h" -#include "server_finder.h" #include "player.h" -#include "player_video.h" #include "i18n.h" -#define LOG_GENERAL(...) _film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL); -#define LOG_ERROR(...) _film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_ERROR); -#define LOG_TIMING(...) _film->log()->microsecond_log (String::compose (__VA_ARGS__), Log::TYPE_TIMING); - -using std::pair; -using std::string; -using std::vector; -using std::list; -using std::cout; -using std::min; -using std::make_pair; -using boost::shared_ptr; -using boost::weak_ptr; -using boost::optional; -using boost::scoped_array; - -int const Encoder::_history_size = 25; - -/** @param f Film that we are encoding */ -Encoder::Encoder (shared_ptr f, weak_ptr j, shared_ptr writer) - : _film (f) - , _job (j) - , _video_frames_out (0) - , _terminate (false) - , _writer (writer) -{ - -} - -Encoder::~Encoder () -{ - terminate_threads (); -} -/** Add a worker thread for a each thread on a remote server. Caller must hold - * a lock on _mutex, or know that one is not currently required to - * safely modify _threads. +/** Construct an encoder. + * @param film Film that we are encoding. + * @param job Job that this encoder is being used in. */ -void -Encoder::add_worker_threads (ServerDescription d) +Encoder::Encoder (std::shared_ptr film, std::weak_ptr job) + : _film (film) + , _job (job) + , _player (new Player(film, Image::Alignment::PADDED)) { - LOG_GENERAL (N_("Adding %1 worker threads for remote %2"), d.host_name ()); - for (int i = 0; i < d.threads(); ++i) { - _threads.push_back (new boost::thread (boost::bind (&Encoder::encoder_thread, this, d))); - } -} - -void -Encoder::begin () -{ - for (int i = 0; i < Config::instance()->num_local_encoding_threads (); ++i) { - _threads.push_back (new boost::thread (boost::bind (&Encoder::encoder_thread, this, optional ()))); - } - - ServerFinder::instance()->connect (boost::bind (&Encoder::server_found, this, _1)); -} - -void -Encoder::end () -{ - boost::mutex::scoped_lock lock (_mutex); - - LOG_GENERAL (N_("Clearing queue of %1"), _queue.size ()); - - /* Keep waking workers until the queue is empty */ - while (!_queue.empty ()) { - _empty_condition.notify_all (); - _full_condition.wait (lock); - } - - lock.unlock (); - - terminate_threads (); - - LOG_GENERAL (N_("Mopping up %1"), _queue.size()); - - /* The following sequence of events can occur in the above code: - 1. a remote worker takes the last image off the queue - 2. the loop above terminates - 3. the remote worker fails to encode the image and puts it back on the queue - 4. the remote worker is then terminated by terminate_threads - - So just mop up anything left in the queue here. - */ - - for (list >::iterator i = _queue.begin(); i != _queue.end(); ++i) { - LOG_GENERAL (N_("Encode left-over frame %1"), (*i)->index ()); - try { - _writer->write ((*i)->encode_locally(), (*i)->index (), (*i)->eyes ()); - frame_done (); - } catch (std::exception& e) { - LOG_ERROR (N_("Local encode failed (%1)"), e.what ()); - } - } -} - -/** @return an estimate of the current number of frames we are encoding per second, - * or 0 if not known. - */ -float -Encoder::current_encoding_rate () const -{ - boost::mutex::scoped_lock lock (_state_mutex); - if (int (_time_history.size()) < _history_size) { - return 0; - } - - struct timeval now; - gettimeofday (&now, 0); - - return _history_size / (seconds (now) - seconds (_time_history.back ())); -} - -/** @return Number of video frames that have been sent out */ -int -Encoder::video_frames_out () const -{ - boost::mutex::scoped_lock (_state_mutex); - return _video_frames_out; -} -/** Should be called when a frame has been encoded successfully. - * @param n Source frame index. - */ -void -Encoder::frame_done () -{ - boost::mutex::scoped_lock lock (_state_mutex); - - struct timeval tv; - gettimeofday (&tv, 0); - _time_history.push_front (tv); - if (int (_time_history.size()) > _history_size) { - _time_history.pop_back (); - } -} - -void -Encoder::enqueue (shared_ptr pvf) -{ - _waker.nudge (); - - boost::mutex::scoped_lock lock (_mutex); - - /* XXX: discard 3D here if required */ - - /* Wait until the queue has gone down a bit */ - while (_queue.size() >= _threads.size() * 2 && !_terminate) { - LOG_TIMING ("decoder sleeps with queue of %1", _queue.size()); - _full_condition.wait (lock); - LOG_TIMING ("decoder wakes with queue of %1", _queue.size()); - } - - if (_terminate) { - return; - } - - _writer->rethrow (); - /* Re-throw any exception raised by one of our threads. If more - than one has thrown an exception, only one will be rethrown, I think; - but then, if that happens something has gone badly wrong. - */ - rethrow (); - - if (_writer->can_fake_write (_video_frames_out)) { - _writer->fake_write (_video_frames_out, pvf->eyes ()); - frame_done (); - } else if (pvf->has_j2k ()) { - _writer->write (pvf->j2k(), _video_frames_out, pvf->eyes ()); - } else { - /* Queue this new frame for encoding */ - LOG_TIMING ("adding to queue of %1", _queue.size ()); - _queue.push_back (shared_ptr ( - new DCPVideo ( - pvf, - _video_frames_out, - _film->video_frame_rate(), - _film->j2k_bandwidth(), - _film->resolution(), - _film->burn_subtitles(), - _film->log() - ) - )); - - /* The queue might not be empty any more, so notify anything which is - waiting on that. - */ - _empty_condition.notify_all (); - } - - if (pvf->eyes() != EYES_LEFT) { - ++_video_frames_out; - } -} - -void -Encoder::terminate_threads () -{ - { - boost::mutex::scoped_lock lock (_mutex); - _terminate = true; - _full_condition.notify_all (); - _empty_condition.notify_all (); - } - - for (list::iterator i = _threads.begin(); i != _threads.end(); ++i) { - if ((*i)->joinable ()) { - (*i)->join (); - } - delete *i; - } - - _threads.clear (); -} - -void -Encoder::encoder_thread (optional server) -try -{ - /* Number of seconds that we currently wait between attempts - to connect to the server; not relevant for localhost - encodings. - */ - int remote_backoff = 0; - - while (true) { - - LOG_TIMING ("[%1] encoder thread sleeps", boost::this_thread::get_id()); - boost::mutex::scoped_lock lock (_mutex); - while (_queue.empty () && !_terminate) { - _empty_condition.wait (lock); - } - - if (_terminate) { - return; - } - - LOG_TIMING ("[%1] encoder thread wakes with queue of %2", boost::this_thread::get_id(), _queue.size()); - shared_ptr vf = _queue.front (); - LOG_TIMING ("[%1] encoder thread pops frame %2 (%3) from queue", boost::this_thread::get_id(), vf->index(), vf->eyes ()); - _queue.pop_front (); - - lock.unlock (); - - shared_ptr encoded; - - if (server) { - try { - encoded = vf->encode_remotely (server.get ()); - - if (remote_backoff > 0) { - LOG_GENERAL ("%1 was lost, but now she is found; removing backoff", server->host_name ()); - } - - /* This job succeeded, so remove any backoff */ - remote_backoff = 0; - - } catch (std::exception& e) { - if (remote_backoff < 60) { - /* back off more */ - remote_backoff += 10; - } - LOG_ERROR ( - N_("Remote encode of %1 on %2 failed (%3); thread sleeping for %4s"), - vf->index(), server->host_name(), e.what(), remote_backoff - ); - } - - } else { - try { - LOG_TIMING ("[%1] encoder thread begins local encode of %2", boost::this_thread::get_id(), vf->index()); - encoded = vf->encode_locally (); - LOG_TIMING ("[%1] encoder thread finishes local encode of %2", boost::this_thread::get_id(), vf->index()); - } catch (std::exception& e) { - LOG_ERROR (N_("Local encode failed (%1)"), e.what ()); - } - } - - if (encoded) { - _writer->write (encoded, vf->index (), vf->eyes ()); - frame_done (); - } else { - lock.lock (); - LOG_GENERAL (N_("[%1] Encoder thread pushes frame %2 back onto queue after failure"), boost::this_thread::get_id(), vf->index()); - _queue.push_front (vf); - lock.unlock (); - } - - if (remote_backoff > 0) { - dcpomatic_sleep (remote_backoff); - } - - /* The queue might not be full any more, so notify anything that is waiting on that */ - lock.lock (); - _full_condition.notify_all (); - } -} -catch (...) -{ - store_current (); -} - -void -Encoder::server_found (ServerDescription s) -{ - add_worker_threads (s); }