* @brief Parent class for classes which can encode video and audio frames.
*/
+#include <iostream>
+#include <boost/filesystem.hpp>
+#include <boost/lexical_cast.hpp>
+#include <libdcp/picture_asset.h>
#include "encoder.h"
#include "util.h"
-#include "options.h"
+#include "film.h"
+#include "log.h"
+#include "exceptions.h"
+#include "filter.h"
+#include "config.h"
+#include "dcp_video_frame.h"
+#include "server.h"
+#include "format.h"
+#include "cross.h"
+#include "writer.h"
+#include "player.h"
+#include "audio_mapping.h"
+
+#include "i18n.h"
using std::pair;
-using namespace boost;
+using std::string;
+using std::stringstream;
+using std::vector;
+using std::list;
+using std::cout;
+using std::make_pair;
+using boost::shared_ptr;
+using boost::optional;
int const Encoder::_history_size = 25;
-/** @param f Film that we are encoding.
- * @param o Options.
- */
-Encoder::Encoder (shared_ptr<const Film> f, shared_ptr<const EncodeOptions> o)
+/** @param f Film that we are encoding */
+Encoder::Encoder (shared_ptr<Film> f, shared_ptr<Job> j)
: _film (f)
- , _opt (o)
- , _just_skipped (false)
- , _video_frame (0)
- , _audio_frame (0)
+ , _job (j)
+ , _video_frames_out (0)
+ , _have_a_real_frame (false)
+ , _terminate (false)
+{
+
+}
+
+Encoder::~Encoder ()
+{
+ terminate_threads ();
+ if (_writer) {
+ _writer->finish ();
+ }
+}
+
+void
+Encoder::process_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, (ServerDescription *) 0)));
+ }
+ vector<ServerDescription*> servers = Config::instance()->servers ();
+
+ for (vector<ServerDescription*>::iterator i = servers.begin(); i != servers.end(); ++i) {
+ for (int j = 0; j < (*i)->threads (); ++j) {
+ _threads.push_back (new boost::thread (boost::bind (&Encoder::encoder_thread, this, *i)));
+ }
+ }
+
+ _writer.reset (new Writer (_film, _job));
}
+void
+Encoder::process_end ()
+{
+ boost::mutex::scoped_lock lock (_mutex);
+
+ _film->log()->log (String::compose (N_("Clearing queue of %1"), _queue.size ()));
+
+ /* Keep waking workers until the queue is empty */
+ while (!_queue.empty ()) {
+ _film->log()->log (String::compose (N_("Waking with %1"), _queue.size ()), Log::VERBOSE);
+ _condition.notify_all ();
+ _condition.wait (lock);
+ }
+
+ lock.unlock ();
+
+ terminate_threads ();
+
+ _film->log()->log (String::compose (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<shared_ptr<DCPVideoFrame> >::iterator i = _queue.begin(); i != _queue.end(); ++i) {
+ _film->log()->log (String::compose (N_("Encode left-over frame %1"), (*i)->frame ()));
+ try {
+ _writer->write ((*i)->encode_locally(), (*i)->frame ());
+ frame_done ();
+ } catch (std::exception& e) {
+ _film->log()->log (String::compose (N_("Local encode failed (%1)"), e.what ()));
+ }
+ }
+
+ _writer->finish ();
+ _writer.reset ();
+}
+
/** @return an estimate of the current number of frames we are encoding per second,
* or 0 if not known.
*/
float
-Encoder::current_frames_per_second () const
+Encoder::current_encoding_rate () const
{
boost::mutex::scoped_lock lock (_history_mutex);
if (int (_time_history.size()) < _history_size) {
return _history_size / (seconds (now) - seconds (_time_history.back ()));
}
-/** @return true if the last frame to be processed was skipped as it already existed */
-bool
-Encoder::skipping () const
-{
- boost::mutex::scoped_lock (_history_mutex);
- return _just_skipped;
-}
-
-/** @return Number of video frames that have been received */
-SourceFrame
-Encoder::video_frame () const
+/** @return Number of video frames that have been sent out */
+int
+Encoder::video_frames_out () const
{
boost::mutex::scoped_lock (_history_mutex);
- return _video_frame;
+ return _video_frames_out;
}
/** Should be called when a frame has been encoded successfully.
Encoder::frame_done ()
{
boost::mutex::scoped_lock lock (_history_mutex);
- _just_skipped = false;
struct timeval tv;
gettimeofday (&tv, 0);
}
}
-/** Called by a subclass when it has just skipped the processing
- of a frame because it has already been done.
-*/
void
-Encoder::frame_skipped ()
+Encoder::process_video (shared_ptr<const Image> image, bool same, shared_ptr<Subtitle> sub, Time)
{
- boost::mutex::scoped_lock lock (_history_mutex);
- _just_skipped = true;
+ boost::mutex::scoped_lock lock (_mutex);
+
+ /* Wait until the queue has gone down a bit */
+ while (_queue.size() >= _threads.size() * 2 && !_terminate) {
+ TIMING ("decoder sleeps with queue of %1", _queue.size());
+ _condition.wait (lock);
+ TIMING ("decoder wakes with queue of %1", _queue.size());
+ }
+
+ if (_terminate) {
+ return;
+ }
+
+ if (_writer->thrown ()) {
+ _writer->rethrow ();
+ }
+
+ if (_writer->can_fake_write (_video_frames_out)) {
+ _writer->fake_write (_video_frames_out);
+ _have_a_real_frame = false;
+ frame_done ();
+ } else if (same && _have_a_real_frame) {
+ /* Use the last frame that we encoded. */
+ _writer->repeat (_video_frames_out);
+ frame_done ();
+ } else {
+ /* Queue this new frame for encoding */
+ pair<string, string> const s = Filter::ffmpeg_strings (_film->filters());
+ TIMING ("adding to queue of %1", _queue.size ());
+ _queue.push_back (shared_ptr<DCPVideoFrame> (
+ new DCPVideoFrame (
+ image, sub, _film->format()->dcp_size(), _film->format()->dcp_padding (_film),
+ _film->subtitle_offset(), _film->subtitle_scale(),
+ _film->scaler(), _video_frames_out, _film->dcp_video_frame_rate(), s.second,
+ _film->colour_lut(), _film->j2k_bandwidth(),
+ _film->log()
+ )
+ ));
+
+ _condition.notify_all ();
+ _have_a_real_frame = true;
+ }
+
+ ++_video_frames_out;
}
void
-Encoder::process_video (shared_ptr<Image> i, boost::shared_ptr<Subtitle> s)
+Encoder::process_audio (shared_ptr<const AudioBuffers> data, Time)
{
- if (_opt->video_skip != 0 && (_video_frame % _opt->video_skip) != 0) {
- ++_video_frame;
- return;
- }
+ _writer->write (data);
+}
- if (_opt->video_range) {
- pair<SourceFrame, SourceFrame> const r = _opt->video_range.get();
- if (_video_frame < r.first || _video_frame >= r.second) {
- ++_video_frame;
- return;
+void
+Encoder::terminate_threads ()
+{
+ boost::mutex::scoped_lock lock (_mutex);
+ _terminate = true;
+ _condition.notify_all ();
+ lock.unlock ();
+
+ for (list<boost::thread *>::iterator i = _threads.begin(); i != _threads.end(); ++i) {
+ if ((*i)->joinable ()) {
+ (*i)->join ();
}
+ delete *i;
}
-
- do_process_video (i, s);
- ++_video_frame;
}
void
-Encoder::process_audio (shared_ptr<AudioBuffers> data)
+Encoder::encoder_thread (ServerDescription* server)
{
- if (_opt->audio_range) {
+ /* Number of seconds that we currently wait between attempts
+ to connect to the server; not relevant for localhost
+ encodings.
+ */
+ int remote_backoff = 0;
+
+ while (1) {
- shared_ptr<AudioBuffers> trimmed (new AudioBuffers (*data.get ()));
-
- /* Range that we are encoding */
- pair<int64_t, int64_t> required_range = _opt->audio_range.get();
- /* Range of this block of data */
- pair<int64_t, int64_t> this_range (_audio_frame, _audio_frame + trimmed->frames());
+ TIMING ("encoder thread %1 sleeps", boost::this_thread::get_id());
+ boost::mutex::scoped_lock lock (_mutex);
+ while (_queue.empty () && !_terminate) {
+ _condition.wait (lock);
+ }
- if (this_range.second < required_range.first || required_range.second < this_range.first) {
- /* No part of this audio is within the required range */
+ if (_terminate) {
return;
- } else if (required_range.first >= this_range.first && required_range.first < this_range.second) {
- /* Trim start */
- int64_t const shift = required_range.first - this_range.first;
- trimmed->move (shift, 0, trimmed->frames() - shift);
- trimmed->set_frames (trimmed->frames() - shift);
- } else if (required_range.second >= this_range.first && required_range.second < this_range.second) {
- /* Trim end */
- trimmed->set_frames (required_range.second - this_range.first);
}
- data = trimmed;
- }
+ TIMING ("encoder thread %1 wakes with queue of %2", boost::this_thread::get_id(), _queue.size());
+ shared_ptr<DCPVideoFrame> vf = _queue.front ();
+ _film->log()->log (String::compose (N_("Encoder thread %1 pops frame %2 from queue"), boost::this_thread::get_id(), vf->frame()), Log::VERBOSE);
+ _queue.pop_front ();
+
+ lock.unlock ();
- do_process_audio (data);
+ shared_ptr<EncodedData> encoded;
- _audio_frame += data->frames ();
+ if (server) {
+ try {
+ encoded = vf->encode_remotely (server);
+
+ if (remote_backoff > 0) {
+ _film->log()->log (String::compose (N_("%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;
+ }
+ _film->log()->log (
+ String::compose (
+ N_("Remote encode of %1 on %2 failed (%3); thread sleeping for %4s"),
+ vf->frame(), server->host_name(), e.what(), remote_backoff)
+ );
+ }
+
+ } else {
+ try {
+ TIMING ("encoder thread %1 begins local encode of %2", boost::this_thread::get_id(), vf->frame());
+ encoded = vf->encode_locally ();
+ TIMING ("encoder thread %1 finishes local encode of %2", boost::this_thread::get_id(), vf->frame());
+ } catch (std::exception& e) {
+ _film->log()->log (String::compose (N_("Local encode failed (%1)"), e.what ()));
+ }
+ }
+
+ if (encoded) {
+ _writer->write (encoded, vf->frame ());
+ frame_done ();
+ } else {
+ lock.lock ();
+ _film->log()->log (
+ String::compose (N_("Encoder thread %1 pushes frame %2 back onto queue after failure"), boost::this_thread::get_id(), vf->frame())
+ );
+ _queue.push_front (vf);
+ lock.unlock ();
+ }
+
+ if (remote_backoff > 0) {
+ dcpomatic_sleep (remote_backoff);
+ }
+
+ lock.lock ();
+ _condition.notify_all ();
+ }
}