X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Fencoder.cc;h=0c41d8d806a8ec9bf627a54b2ac579315edab074;hp=8caa0190c38726121d182b1f81e27ebf99b85295;hb=422be0eece2bf6ee80db1d3c21553cd82efff789;hpb=cb1dfa9ec09af2abf6d10e4bf2764476db83841b diff --git a/src/lib/encoder.cc b/src/lib/encoder.cc index 8caa0190c..0c41d8d80 100644 --- a/src/lib/encoder.cc +++ b/src/lib/encoder.cc @@ -1,19 +1,20 @@ /* - Copyright (C) 2012-2014 Carl Hetherington + Copyright (C) 2012-2015 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 . */ @@ -21,96 +22,99 @@ * @brief Parent class for classes which can encode video and audio frames. */ -#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 "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__), 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); +#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); -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; +using dcp::Data; -int const Encoder::_history_size = 25; +int const Encoder::_history_size = 200; /** @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) +Encoder::Encoder (shared_ptr film, shared_ptr writer) + : _film (film) , _writer (writer) { - + servers_list_changed (); } Encoder::~Encoder () { - terminate_threads (); + try { + terminate_threads (); + } catch (...) { + /* Destructors must not throw exceptions; anything bad + happening now is too late to worry about anyway, + I think. + */ + } } -/** 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. - */ void -Encoder::add_worker_threads (ServerDescription d) +Encoder::begin () { - 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))); - } + 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::begin () +Encoder::call_servers_list_changed (weak_ptr encoder) { - 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 ()))); + shared_ptr e = encoder.lock (); + if (e) { + e->servers_list_changed (); } - - ServerFinder::instance()->connect (boost::bind (&Encoder::server_found, this, _1)); } void Encoder::end () { - boost::mutex::scoped_lock lock (_mutex); + 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()); @@ -127,13 +131,17 @@ Encoder::end () 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 ()); + _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. @@ -152,12 +160,15 @@ Encoder::current_encoding_rate () const return _history_size / (seconds (now) - seconds (_time_history.back ())); } -/** @return Number of video frames that have been sent out */ +/** @return Number of video frames that have been queued for encoding */ int -Encoder::video_frames_out () const +Encoder::video_frames_enqueued () const { - boost::mutex::scoped_lock (_state_mutex); - return _video_frames_out; + 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. @@ -167,7 +178,7 @@ void Encoder::frame_done () { boost::mutex::scoped_lock lock (_state_mutex); - + struct timeval tv; gettimeofday (&tv, 0); _time_history.push_front (tv); @@ -176,24 +187,31 @@ Encoder::frame_done () } } +/** Called to start 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. + */ void -Encoder::enqueue (shared_ptr pvf) +Encoder::encode (shared_ptr pv) { _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()); + size_t threads = 0; + { + boost::mutex::scoped_lock threads_lock (_threads_mutex); + threads = _threads.size (); } - if (_terminate) { - return; + 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 (); @@ -203,22 +221,27 @@ Encoder::enqueue (shared_ptr pvf) */ rethrow (); - if (_writer->can_fake_write (_video_frames_out)) { - _writer->fake_write (_video_frames_out, pvf->eyes ()); + Frame const position = pv->time().frames_floor(_film->video_frame_rate()); + + if (_writer->can_fake_write (position)) { + /* We can fake-write this frame */ + _writer->fake_write (position, pv->eyes ()); frame_done (); - } else if (pvf->has_j2k ()) { - _writer->write (pvf->j2k(), _video_frames_out, pvf->eyes ()); + } else if (pv->has_j2k ()) { + /* 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)) { + _writer->repeat (position, pv->eyes ()); } else { /* Queue this new frame for encoding */ - LOG_TIMING ("adding to queue of %1", _queue.size ()); + LOG_TIMING ("add-frame-to-queue queue=%1", _queue.size ()); _queue.push_back (shared_ptr ( new DCPVideo ( - pvf, - _video_frames_out, + pv, + position, _film->video_frame_rate(), _film->j2k_bandwidth(), _film->resolution(), - _film->burn_subtitles(), _film->log() ) )); @@ -229,62 +252,66 @@ Encoder::enqueue (shared_ptr pvf) _empty_condition.notify_all (); } - if (pvf->eyes() != EYES_LEFT) { - ++_video_frames_out; - } + _last_player_video = pv; } void Encoder::terminate_threads () { - { - boost::mutex::scoped_lock lock (_mutex); - _terminate = true; - _full_condition.notify_all (); - _empty_condition.notify_all (); - } + boost::mutex::scoped_lock threads_lock (_threads_mutex); + int n = 0; for (list::iterator i = _threads.begin(); i != _threads.end(); ++i) { - if ((*i)->joinable ()) { + 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) +Encoder::encoder_thread (optional server) try { + if (server) { + LOG_TIMING ("start-encoder-thread thread=%1 server=%2", boost::this_thread::get_id (), server->host_name ()); + } else { + LOG_TIMING ("start-encoder-thread thread=%1 server=localhost", boost::this_thread::get_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 ("[%1] encoder thread sleeps", boost::this_thread::get_id()); - boost::mutex::scoped_lock lock (_mutex); - while (_queue.empty () && !_terminate) { + LOG_TIMING ("encoder-sleep thread=%1", boost::this_thread::get_id()); + boost::mutex::scoped_lock lock (_queue_mutex); + while (_queue.empty ()) { _empty_condition.wait (lock); } - if (_terminate) { - return; - } - - LOG_TIMING ("[%1] encoder thread wakes with queue of %2", boost::this_thread::get_id(), _queue.size()); + LOG_TIMING ("encoder-wake thread=%1 queue=%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 ()); + LOG_TIMING ("encoder-pop thread=%1 frame=%2 eyes=%3", boost::this_thread::get_id(), vf->index(), vf->eyes ()); _queue.pop_front (); - + lock.unlock (); - shared_ptr encoded; + optional encoded; + /* We need to encode this input */ if (server) { try { encoded = vf->encode_remotely (server.get ()); @@ -292,10 +319,10 @@ try 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 */ @@ -306,19 +333,20 @@ try 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()); + LOG_TIMING ("start-local-encode thread=%1 frame=%2", boost::this_thread::get_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", boost::this_thread::get_id(), vf->index()); } catch (std::exception& e) { LOG_ERROR (N_("Local encode failed (%1)"), e.what ()); + throw; } } if (encoded) { - _writer->write (encoded, vf->index (), vf->eyes ()); + _writer->write (encoded.get(), vf->index (), vf->eyes ()); frame_done (); } else { lock.lock (); @@ -328,7 +356,7 @@ try } if (remote_backoff > 0) { - dcpomatic_sleep (remote_backoff); + 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 */ @@ -336,13 +364,54 @@ try _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::server_found (ServerDescription s) +Encoder::servers_list_changed () { - add_worker_threads (s); + 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 ()); }