X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Fencoder.cc;h=1d688c31868d49450140e7381994f3431fe6bb5d;hp=f468f91e113a2235ab3c69d17e35a2d6a92bf064;hb=ac34066d5e448d1984d11a180be74e31b6e13b5c;hpb=38e8f2f4611fa95d9fe110cda549d5c25f296077 diff --git a/src/lib/encoder.cc b/src/lib/encoder.cc index f468f91e1..1d688c318 100644 --- a/src/lib/encoder.cc +++ b/src/lib/encoder.cc @@ -1,5 +1,5 @@ /* - Copyright (C) 2012-2015 Carl Hetherington + Copyright (C) 2012-2017 Carl Hetherington This file is part of DCP-o-matic. @@ -18,415 +18,30 @@ */ -/** @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 "encoder.h" -#include "util.h" -#include "film.h" -#include "log.h" -#include "config.h" -#include "dcp_video.h" -#include "cross.h" -#include "writer.h" -#include "encode_server_finder.h" #include "player.h" -#include "player_video.h" -#include "encode_server_description.h" -#include "compose.hpp" -#include -#include -#include #include "i18n.h" -#define LOG_GENERAL(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL); -#define LOG_GENERAL_NC(...) _film->log()->log (__VA_ARGS__, LogEntry::TYPE_GENERAL); -#define LOG_ERROR(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_ERROR); -#define LOG_TIMING(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_TIMING); -#define LOG_DEBUG_ENCODE(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_DEBUG_ENCODE); - -using std::list; -using std::cout; -using boost::shared_ptr; -using boost::weak_ptr; -using boost::optional; -using dcp::Data; - -int const Encoder::_history_size = 200; - -/** @param f Film that we are encoding */ -Encoder::Encoder (shared_ptr film, shared_ptr writer) - : _film (film) - , _writer (writer) -{ - servers_list_changed (); -} - -Encoder::~Encoder () -{ - try { - terminate_threads (); - } catch (...) { - /* Destructors must not throw exceptions; anything bad - happening now is too late to worry about anyway, - I think. - */ - } -} - -void -Encoder::begin () -{ - weak_ptr wp = shared_from_this (); - _server_found_connection = EncodeServerFinder::instance()->ServersListChanged.connect ( - boost::bind (&Encoder::call_servers_list_changed, wp) - ); -} - -/* We don't want the servers-list-changed callback trying to do things - during destruction of Encoder, and I think this is the neatest way - to achieve that. -*/ -void -Encoder::call_servers_list_changed (weak_ptr encoder) -{ - shared_ptr e = encoder.lock (); - if (e) { - e->servers_list_changed (); - } -} - -void -Encoder::end () -{ - boost::mutex::scoped_lock lock (_queue_mutex); - - LOG_GENERAL (N_("Clearing queue of %1"), _queue.size ()); - - /* Keep waking workers until the queue is empty */ - while (!_queue.empty ()) { - rethrow (); - _empty_condition.notify_all (); - _full_condition.wait (lock); - } - - lock.unlock (); - - LOG_GENERAL_NC (N_("Terminating encoder threads")); - - 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 (boost::bind (&Log::dcp_log, _film->log().get(), _1, _2)), - (*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 queued for encoding */ -int -Encoder::video_frames_enqueued () const -{ - if (!_last_player_video) { - return 0; - } - - return _last_player_video->time().frames_floor (_film->video_frame_rate ()); -} - -/** 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 (); - } -} -/** Called to request encoding of the next video frame in the DCP. This is called in order, - * so each time the supplied frame is the one after the previous one. - * pv represents one video frame, and could be empty if there is nothing to encode - * for this DCP frame. +/** Construct an encoder. + * @param film Film that we are encoding. + * @param job Job that this encoder is being used in. */ -void -Encoder::encode (shared_ptr pv) -{ - _waker.nudge (); - - size_t threads = 0; - { - boost::mutex::scoped_lock threads_lock (_threads_mutex); - threads = _threads.size (); - } - - boost::mutex::scoped_lock queue_lock (_queue_mutex); - - /* Wait until the queue has gone down a bit. Allow one thing in the queue even - when there are no threads. - */ - while (_queue.size() >= (threads * 2) + 1) { - LOG_TIMING ("decoder-sleep queue=%1 threads=%2", _queue.size(), threads); - _full_condition.wait (queue_lock); - LOG_TIMING ("decoder-wake queue=%1 threads=%2", _queue.size(), threads); - } - - _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 (); - - Frame const position = pv->time().frames_floor(_film->video_frame_rate()); - - if (_writer->can_fake_write (position)) { - /* We can fake-write this frame */ - LOG_DEBUG_ENCODE("Frame @ %1 FAKE", to_string(pv->time())); - _writer->fake_write (position, pv->eyes ()); - frame_done (); - } else if (pv->has_j2k ()) { - LOG_DEBUG_ENCODE("Frame @ %1 J2K", to_string(pv->time())); - /* This frame already has JPEG2000 data, so just write it */ - _writer->write (pv->j2k(), position, pv->eyes ()); - } else if (_last_player_video && _writer->can_repeat(position) && pv->same (_last_player_video)) { - LOG_DEBUG_ENCODE("Frame @ %1 REPEAT", to_string(pv->time())); - _writer->repeat (position, pv->eyes ()); - } else { - LOG_DEBUG_ENCODE("Frame @ %1 ENCODE", to_string(pv->time())); - /* Queue this new frame for encoding */ - LOG_TIMING ("add-frame-to-queue queue=%1", _queue.size ()); - _queue.push_back (shared_ptr ( - new DCPVideo ( - pv, - position, - _film->video_frame_rate(), - _film->j2k_bandwidth(), - _film->resolution(), - _film->log() - ) - )); - - /* The queue might not be empty any more, so notify anything which is - waiting on that. - */ - _empty_condition.notify_all (); - } - - _last_player_video = pv; -} - -void -Encoder::terminate_threads () -{ - boost::mutex::scoped_lock threads_lock (_threads_mutex); - - int n = 0; - for (list::iterator i = _threads.begin(); i != _threads.end(); ++i) { - LOG_GENERAL ("Terminating thread %1 of %2", n + 1, _threads.size ()); - (*i)->interrupt (); - DCPOMATIC_ASSERT ((*i)->joinable ()); - try { - (*i)->join (); - } catch (boost::thread_interrupted& e) { - /* This is to be expected */ - } - delete *i; - LOG_GENERAL_NC ("Thread terminated"); - ++n; - } - - _threads.clear (); -} - -void -Encoder::encoder_thread (optional server) -try -{ - if (server) { - LOG_TIMING ("start-encoder-thread thread=%1 server=%2", thread_id (), server->host_name ()); - } else { - LOG_TIMING ("start-encoder-thread thread=%1 server=localhost", thread_id ()); - } - - /* 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 ("encoder-sleep thread=%1", thread_id ()); - boost::mutex::scoped_lock lock (_queue_mutex); - while (_queue.empty ()) { - _empty_condition.wait (lock); - } - - LOG_TIMING ("encoder-wake thread=%1 queue=%2", thread_id(), _queue.size()); - shared_ptr vf = _queue.front (); - - /* We're about to commit to either encoding this frame or putting it back onto the queue, - so we must not be interrupted until one or other of these things have happened. This - block has thread interruption disabled. - */ - { - boost::this_thread::disable_interruption dis; - - LOG_TIMING ("encoder-pop thread=%1 frame=%2 eyes=%3", thread_id(), vf->index(), (int) vf->eyes ()); - _queue.pop_front (); - - lock.unlock (); - - optional encoded; - - /* We need to encode this input */ - 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 ("start-local-encode thread=%1 frame=%2", thread_id(), vf->index()); - encoded = vf->encode_locally (boost::bind (&Log::dcp_log, _film->log().get(), _1, _2)); - LOG_TIMING ("finish-local-encode thread=%1 frame=%2", thread_id(), vf->index()); - } catch (std::exception& e) { - /* This is very bad, so don't cope with it, just pass it on */ - LOG_ERROR (N_("Local encode failed (%1)"), e.what ()); - throw; - } - } - - if (encoded) { - _writer->write (encoded.get(), vf->index (), vf->eyes ()); - frame_done (); - } else { - lock.lock (); - LOG_GENERAL (N_("[%1] Encoder thread pushes frame %2 back onto queue after failure"), thread_id(), vf->index()); - _queue.push_front (vf); - lock.unlock (); - } - } - - if (remote_backoff > 0) { - boost::this_thread::sleep (boost::posix_time::seconds (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 (boost::thread_interrupted& e) { - /* Ignore these and just stop the thread */ - _full_condition.notify_all (); -} -catch (...) -{ - store_current (); - /* Wake anything waiting on _full_condition so it can see the exception */ - _full_condition.notify_all (); -} - -void -Encoder::servers_list_changed () +Encoder::Encoder (std::shared_ptr film, std::weak_ptr job) + : _film (film) + , _job (job) + , _player (new Player(film, Image::Alignment::PADDED)) { - terminate_threads (); - - /* XXX: could re-use threads */ - - boost::mutex::scoped_lock lm (_threads_mutex); - -#ifdef BOOST_THREAD_PLATFORM_WIN32 - OSVERSIONINFO info; - info.dwOSVersionInfoSize = sizeof (OSVERSIONINFO); - GetVersionEx (&info); - bool const windows_xp = (info.dwMajorVersion == 5 && info.dwMinorVersion == 1); - if (windows_xp) { - LOG_GENERAL_NC (N_("Setting thread affinity for Windows XP")); - } -#endif - - if (!Config::instance()->only_servers_encode ()) { - for (int i = 0; i < Config::instance()->num_local_encoding_threads (); ++i) { - boost::thread* t = new boost::thread (boost::bind (&Encoder::encoder_thread, this, optional ())); - _threads.push_back (t); -#ifdef BOOST_THREAD_PLATFORM_WIN32 - if (windows_xp) { - SetThreadAffinityMask (t->native_handle(), 1 << i); - } -#endif - } - } - - BOOST_FOREACH (EncodeServerDescription i, EncodeServerFinder::instance()->servers ()) { - LOG_GENERAL (N_("Adding %1 worker threads for remote %2"), i.threads(), i.host_name ()); - for (int j = 0; j < i.threads(); ++j) { - _threads.push_back (new boost::thread (boost::bind (&Encoder::encoder_thread, this, i))); - } - } - _writer->set_encoder_threads (_threads.size ()); }