X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Fj2k_encoder.cc;h=de229113b3a93234f9af47d91c17c1133ae8575f;hb=1fc8c0c6d045404732497ba70bd2eccfbe4cc6f6;hp=94728d6a9e6acccbe5839e4acc0c73d3d1b09530;hpb=ad1ef39eda58b3a919ea3b7084401a0439409ec6;p=dcpomatic.git diff --git a/src/lib/j2k_encoder.cc b/src/lib/j2k_encoder.cc index 94728d6a9..de229113b 100644 --- a/src/lib/j2k_encoder.cc +++ b/src/lib/j2k_encoder.cc @@ -1,5 +1,5 @@ /* - Copyright (C) 2012-2015 Carl Hetherington + Copyright (C) 2012-2021 Carl Hetherington This file is part of DCP-o-matic. @@ -18,84 +18,169 @@ */ + /** @file src/j2k_encoder.cc * @brief J2K encoder class. */ -#include "j2k_encoder.h" -#include "util.h" -#include "film.h" -#include "log.h" -#include "dcpomatic_log.h" + +#include "compose.hpp" #include "config.h" -#include "dcp_video.h" #include "cross.h" -#include "writer.h" +#include "dcp_video.h" +#include "dcpomatic_log.h" +#include "encode_server_description.h" #include "encode_server_finder.h" -#include "player.h" +#include "film.h" +#include "cpu_j2k_encoder_thread.h" +#ifdef DCPOMATIC_GROK +#include "grok/context.h" +#include "grok_j2k_encoder_thread.h" +#endif +#include "remote_j2k_encoder_thread.h" +#include "j2k_encoder.h" +#include "log.h" #include "player_video.h" -#include "encode_server_description.h" -#include "compose.hpp" +#include "util.h" +#include "writer.h" #include -#include #include #include "i18n.h" -using std::list; + using std::cout; -using boost::shared_ptr; -using boost::weak_ptr; +using std::dynamic_pointer_cast; +using std::exception; +using std::list; +using std::make_shared; +using std::shared_ptr; +using std::weak_ptr; using boost::optional; using dcp::Data; +using namespace dcpomatic; + +#ifdef DCPOMATIC_GROK + +namespace grk_plugin { + +IMessengerLogger* sLogger = nullptr; + +#if defined(__GNUC__) || defined(__clang__) +#pragma GCC diagnostic push +#pragma GCC diagnostic ignored "-Wunused-function" +#endif +void setMessengerLogger(grk_plugin::IMessengerLogger* logger) +{ + delete sLogger; + sLogger = logger; +} +#if defined(__GNUC__) || defined(__clang__) +#pragma GCC diagnostic pop +#endif +grk_plugin::IMessengerLogger* getMessengerLogger(void) +{ + return sLogger; +} + +} + +#endif + /** @param film Film that we are encoding. * @param writer Writer that we are using. */ -J2KEncoder::J2KEncoder (shared_ptr film, shared_ptr writer) +J2KEncoder::J2KEncoder(shared_ptr film, Writer& writer) : _film (film) , _history (200) , _writer (writer) { - servers_list_changed (); +#ifdef DCPOMATIC_GROK + auto grok = Config::instance()->grok().get_value_or({}); + _dcpomatic_context = new grk_plugin::DcpomaticContext(film, writer, _history, grok.binary_location); + if (grok.enable) { + _context = new grk_plugin::GrokContext(_dcpomatic_context); + } +#endif } + J2KEncoder::~J2KEncoder () { - try { - terminate_threads (); - } catch (...) { - /* Destructors must not throw exceptions; anything bad - happening now is too late to worry about anyway, - I think. - */ - } + _server_found_connection.disconnect(); + + terminate_threads(); + +#ifdef DCPOMATIC_GROK + delete _context; + delete _dcpomatic_context; +#endif } + +void +J2KEncoder::servers_list_changed() +{ + auto config = Config::instance(); +#ifdef DCPOMATIC_GROK + auto const grok_enable = config->grok().get_value_or({}).enable; +#else + auto const grok_enable = false; +#endif + + auto const cpu = (grok_enable || config->only_servers_encode()) ? 0 : config->master_encoding_threads(); + auto const gpu = grok_enable ? config->master_encoding_threads() : 0; + + remake_threads(cpu, gpu, EncodeServerFinder::instance()->servers()); +} + + void J2KEncoder::begin () { - weak_ptr wp = shared_from_this (); - _server_found_connection = EncodeServerFinder::instance()->ServersListChanged.connect ( - boost::bind (&J2KEncoder::call_servers_list_changed, wp) + _server_found_connection = EncodeServerFinder::instance()->ServersListChanged.connect( + boost::bind(&J2KEncoder::servers_list_changed, this) ); + servers_list_changed (); } -/* We don't want the servers-list-changed callback trying to do things - during destruction of J2KEncoder, and I think this is the neatest way - to achieve that. -*/ + void -J2KEncoder::call_servers_list_changed (weak_ptr encoder) +J2KEncoder::pause() +{ +#ifdef DCPOMATIC_GROK + if (!Config::instance()->grok().get_value_or({}).enable) { + return; + } + return; + + terminate_threads (); + + /* Something might have been thrown during terminate_threads */ + rethrow (); + + delete _context; + _context = nullptr; +#endif +} + + +void J2KEncoder::resume() { - shared_ptr e = encoder.lock (); - if (e) { - e->servers_list_changed (); +#ifdef DCPOMATIC_GROK + if (!Config::instance()->grok().get_value_or({}).enable) { + return; } + + _context = new grk_plugin::GrokContext(_dcpomatic_context); + servers_list_changed(); +#endif } + void -J2KEncoder::end () +J2KEncoder::end() { boost::mutex::scoped_lock lock (_queue_mutex); @@ -104,16 +189,17 @@ J2KEncoder::end () /* 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 (); + /* Something might have been thrown during terminate_threads */ + rethrow (); + LOG_GENERAL (N_("Mopping up %1"), _queue.size()); /* The following sequence of events can occur in the above code: @@ -124,31 +210,48 @@ J2KEncoder::end () 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 ()); + for (auto & i: _queue) { +#ifdef DCPOMATIC_GROK + if (Config::instance()->grok().get_value_or({}).enable) { + if (!_context->scheduleCompress(i)){ + LOG_GENERAL (N_("[%1] J2KEncoder thread pushes frame %2 back onto queue after failure"), thread_id(), i.index()); + // handle error + } + } else { +#else + { +#endif + LOG_GENERAL(N_("Encode left-over frame %1"), i.index()); + try { + _writer.write( + make_shared(i.encode_locally()), + i.index(), + i.eyes() + ); + frame_done (); + } catch (std::exception& e) { + LOG_ERROR (N_("Local encode failed (%1)"), e.what ()); + } } } + +#ifdef DCPOMATIC_GROK + delete _context; + _context = nullptr; +#endif } + /** @return an estimate of the current number of frames we are encoding per second, - * or 0 if not known. + * if known. */ -float +optional J2KEncoder::current_encoding_rate () const { return _history.rate (); } + /** @return Number of video frames that have been queued for encoding */ int J2KEncoder::video_frames_enqueued () const @@ -160,6 +263,7 @@ J2KEncoder::video_frames_enqueued () const return _last_player_video_time->frames_floor (_film->video_frame_rate ()); } + /** Should be called when a frame has been encoded successfully */ void J2KEncoder::frame_done () @@ -167,6 +271,7 @@ J2KEncoder::frame_done () _history.event (); } + /** 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 @@ -182,8 +287,8 @@ J2KEncoder::encode (shared_ptr pv, DCPTime time) size_t threads = 0; { - boost::mutex::scoped_lock threads_lock (_threads_mutex); - threads = _threads.size (); + boost::mutex::scoped_lock lm (_threads_mutex); + threads = _threads.size(); } boost::mutex::scoped_lock queue_lock (_queue_mutex); @@ -197,40 +302,40 @@ J2KEncoder::encode (shared_ptr pv, DCPTime time) LOG_TIMING ("decoder-wake queue=%1 threads=%2", _queue.size(), threads); } - _writer->rethrow (); + _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 = time.frames_floor(_film->video_frame_rate()); + auto const position = time.frames_floor(_film->video_frame_rate()); - if (_writer->can_fake_write (position)) { + if (_writer.can_fake_write(position)) { /* We can fake-write this frame */ LOG_DEBUG_ENCODE("Frame @ %1 FAKE", to_string(time)); - _writer->fake_write (position, pv->eyes ()); + _writer.fake_write(position, pv->eyes ()); frame_done (); } else if (pv->has_j2k() && !_film->reencode_j2k()) { LOG_DEBUG_ENCODE("Frame @ %1 J2K", to_string(time)); /* This frame already has J2K data, so just write it */ - _writer->write (pv->j2k(), position, pv->eyes ()); - } else if (_last_player_video[pv->eyes()] && _writer->can_repeat(position) && pv->same (_last_player_video[pv->eyes()])) { + _writer.write(pv->j2k(), position, pv->eyes ()); + frame_done (); + } else if (_last_player_video[pv->eyes()] && _writer.can_repeat(position) && pv->same(_last_player_video[pv->eyes()])) { LOG_DEBUG_ENCODE("Frame @ %1 REPEAT", to_string(time)); - _writer->repeat (position, pv->eyes ()); + _writer.repeat(position, pv->eyes()); } else { LOG_DEBUG_ENCODE("Frame @ %1 ENCODE", to_string(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() - ) - )); + auto dcpv = DCPVideo( + pv, + position, + _film->video_frame_rate(), + _film->j2k_bandwidth(), + _film->resolution() + ); + _queue.push_back (dcpv); /* The queue might not be empty any more, so notify anything which is waiting on that. @@ -242,180 +347,142 @@ J2KEncoder::encode (shared_ptr pv, DCPTime time) _last_player_video_time = time; } + void J2KEncoder::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; + boost::mutex::scoped_lock lm(_threads_mutex); + boost::this_thread::disable_interruption dis; + + for (auto& thread: _threads) { + thread->stop(); } - _threads.clear (); + _threads.clear(); + _ending = true; } + void -J2KEncoder::encoder_thread (optional server) -try +J2KEncoder::remake_threads(int cpu, int gpu, list servers) { - 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 ()); - } + LOG_GENERAL("Making threads: CPU=%1, GPU=%2, Remote=%3", cpu, gpu, servers.size()); - /* 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) { + boost::mutex::scoped_lock lm (_threads_mutex); + if (_ending) { + return; + } - LOG_TIMING ("encoder-sleep thread=%1", thread_id ()); - boost::mutex::scoped_lock lock (_queue_mutex); - while (_queue.empty ()) { - _empty_condition.wait (lock); + auto remove_threads = [this](int wanted, int current, std::function)> predicate) { + for (auto i = wanted; i < current; ++i) { + auto iter = std::find_if(_threads.begin(), _threads.end(), predicate); + if (iter != _threads.end()) { + (*iter)->stop(); + _threads.erase(iter); + } } + }; - 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 (); - 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; - } - } + /* CPU */ - if (encoded) { - _writer->write (encoded.get(), vf->index (), vf->eyes ()); - frame_done (); - } else { - lock.lock (); - LOG_GENERAL (N_("[%1] J2KEncoder thread pushes frame %2 back onto queue after failure"), thread_id(), vf->index()); - _queue.push_front (vf); - lock.unlock (); - } - } + auto const is_cpu_thread = [](shared_ptr thread) { + return static_cast(dynamic_pointer_cast(thread)); + }; - if (remote_backoff > 0) { - boost::this_thread::sleep (boost::posix_time::seconds (remote_backoff)); - } + auto const current_cpu_threads = std::count_if(_threads.begin(), _threads.end(), is_cpu_thread); - /* The queue might not be full any more, so notify anything that is waiting on that */ - lock.lock (); - _full_condition.notify_all (); + for (auto i = current_cpu_threads; i < cpu; ++i) { + auto thread = make_shared(*this); + thread->start(); + _threads.push_back(thread); } -} -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 -J2KEncoder::servers_list_changed () -{ - terminate_threads (); + remove_threads(cpu, current_cpu_threads, is_cpu_thread); - /* XXX: could re-use threads */ +#ifdef DCPOMATIC_GROK + /* GPU */ - boost::mutex::scoped_lock lm (_threads_mutex); + auto const is_grok_thread = [](shared_ptr thread) { + return static_cast(dynamic_pointer_cast(thread)); + }; + + auto const current_gpu_threads = std::count_if(_threads.begin(), _threads.end(), is_grok_thread); -#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")); + for (auto i = current_gpu_threads; i < gpu; ++i) { + auto thread = make_shared(*this, _context); + thread->start(); + _threads.push_back(thread); } -#endif - if (!Config::instance()->only_servers_encode ()) { - for (int i = 0; i < Config::instance()->master_encoding_threads (); ++i) { - boost::thread* t = new boost::thread (boost::bind (&J2KEncoder::encoder_thread, this, optional ())); -#ifdef DCPOMATIC_LINUX - pthread_setname_np (t->native_handle(), "encode-worker"); -#endif - _threads.push_back (t); -#ifdef BOOST_THREAD_PLATFORM_WIN32 - if (windows_xp) { - SetThreadAffinityMask (t->native_handle(), 1 << i); - } + remove_threads(gpu, current_gpu_threads, is_grok_thread); #endif - } - } - BOOST_FOREACH (EncodeServerDescription i, EncodeServerFinder::instance()->servers()) { - if (!i.current_link_version()) { + /* Remote */ + + for (auto const& server: servers) { + if (!server.current_link_version()) { continue; } - 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 (&J2KEncoder::encoder_thread, this, i))); + auto is_remote_thread = [server](shared_ptr thread) { + auto remote = dynamic_pointer_cast(thread); + return remote && remote->server().host_name() == server.host_name(); + }; + + auto const current_threads = std::count_if(_threads.begin(), _threads.end(), is_remote_thread); + + auto const wanted_threads = server.threads(); + + if (wanted_threads > current_threads) { + LOG_GENERAL(N_("Adding %1 worker threads for remote %2"), wanted_threads - current_threads, server.host_name()); + } else if (wanted_threads < current_threads) { + LOG_GENERAL(N_("Removing %1 worker threads for remote %2"), current_threads - wanted_threads, server.host_name()); + } + + for (auto i = current_threads; i < wanted_threads; ++i) { + auto thread = make_shared(*this, server); + thread->start(); + _threads.push_back(thread); } + + remove_threads(wanted_threads, current_threads, is_remote_thread); } - _writer->set_encoder_threads (_threads.size ()); + _writer.set_encoder_threads(_threads.size()); +} + + +DCPVideo +J2KEncoder::pop() +{ + 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()); + + auto vf = _queue.front(); + _queue.pop_front(); + + _full_condition.notify_all(); + return vf; +} + + +void +J2KEncoder::retry(DCPVideo video) +{ + boost::mutex::scoped_lock lock(_queue_mutex); + _queue.push_front(video); + _empty_condition.notify_all(); +} + + +void +J2KEncoder::write(shared_ptr data, int index, Eyes eyes) +{ + _writer.write(data, index, eyes); + frame_done(); }