2 Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 /** @file src/encoder.h
21 * @brief Parent class for classes which can encode video and audio frames.
25 #include <boost/filesystem.hpp>
26 #include <boost/lexical_cast.hpp>
27 #include <libdcp/picture_asset.h>
33 #include "exceptions.h"
36 #include "dcp_video_frame.h"
46 using std::stringstream;
51 using namespace boost;
53 int const Encoder::_history_size = 25;
55 /** @param f Film that we are encoding */
56 Encoder::Encoder (shared_ptr<Film> f)
58 , _video_frames_in (0)
59 , _video_frames_out (0)
60 #ifdef HAVE_SWRESAMPLE
63 , _have_a_real_frame (false)
78 Encoder::process_begin ()
80 if (_film->audio_stream() && _film->audio_stream()->sample_rate() != _film->target_audio_sample_rate()) {
81 #ifdef HAVE_SWRESAMPLE
84 s << String::compose (N_("Will resample audio from %1 to %2"), _film->audio_stream()->sample_rate(), _film->target_audio_sample_rate());
85 _film->log()->log (s.str ());
87 /* We will be using planar float data when we call the resampler */
88 _swr_context = swr_alloc_set_opts (
90 _film->audio_stream()->channel_layout(),
92 _film->target_audio_sample_rate(),
93 _film->audio_stream()->channel_layout(),
95 _film->audio_stream()->sample_rate(),
99 swr_init (_swr_context);
101 throw EncodeError (_("Cannot resample audio as libswresample is not present"));
104 #ifdef HAVE_SWRESAMPLE
109 for (int i = 0; i < Config::instance()->num_local_encoding_threads (); ++i) {
110 _threads.push_back (new boost::thread (boost::bind (&Encoder::encoder_thread, this, (ServerDescription *) 0)));
113 vector<ServerDescription*> servers = Config::instance()->servers ();
115 for (vector<ServerDescription*>::iterator i = servers.begin(); i != servers.end(); ++i) {
116 for (int j = 0; j < (*i)->threads (); ++j) {
117 _threads.push_back (new boost::thread (boost::bind (&Encoder::encoder_thread, this, *i)));
121 _writer.reset (new Writer (_film));
126 Encoder::process_end ()
129 if (_film->audio_stream() && _film->audio_stream()->channels() && _swr_context) {
131 shared_ptr<AudioBuffers> out (new AudioBuffers (_film->audio_stream()->channels(), 256));
134 int const frames = swr_convert (_swr_context, (uint8_t **) out->data(), 256, 0, 0);
137 throw EncodeError (_("could not run sample-rate converter"));
144 out->set_frames (frames);
148 swr_free (&_swr_context);
152 boost::mutex::scoped_lock lock (_mutex);
154 _film->log()->log (String::compose (N_("Clearing queue of %1"), _queue.size ()));
156 /* Keep waking workers until the queue is empty */
157 while (!_queue.empty ()) {
158 _film->log()->log (String::compose (N_("Waking with %1"), _queue.size ()), Log::VERBOSE);
159 _condition.notify_all ();
160 _condition.wait (lock);
165 terminate_threads ();
167 _film->log()->log (String::compose (N_("Mopping up %1"), _queue.size()));
169 /* The following sequence of events can occur in the above code:
170 1. a remote worker takes the last image off the queue
171 2. the loop above terminates
172 3. the remote worker fails to encode the image and puts it back on the queue
173 4. the remote worker is then terminated by terminate_threads
175 So just mop up anything left in the queue here.
178 for (list<shared_ptr<DCPVideoFrame> >::iterator i = _queue.begin(); i != _queue.end(); ++i) {
179 _film->log()->log (String::compose (N_("Encode left-over frame %1"), (*i)->frame ()));
181 _writer->write ((*i)->encode_locally(), (*i)->frame ());
183 } catch (std::exception& e) {
184 _film->log()->log (String::compose (N_("Local encode failed (%1)"), e.what ()));
192 /** @return an estimate of the current number of frames we are encoding per second,
196 Encoder::current_frames_per_second () const
198 boost::mutex::scoped_lock lock (_history_mutex);
199 if (int (_time_history.size()) < _history_size) {
204 gettimeofday (&now, 0);
206 return _history_size / (seconds (now) - seconds (_time_history.back ()));
209 /** @return Number of video frames that have been sent out */
211 Encoder::video_frames_out () const
213 boost::mutex::scoped_lock (_history_mutex);
214 return _video_frames_out;
217 /** Should be called when a frame has been encoded successfully.
218 * @param n Source frame index.
221 Encoder::frame_done ()
223 boost::mutex::scoped_lock lock (_history_mutex);
226 gettimeofday (&tv, 0);
227 _time_history.push_front (tv);
228 if (int (_time_history.size()) > _history_size) {
229 _time_history.pop_back ();
234 Encoder::process_video (shared_ptr<const Image> image, bool same, boost::shared_ptr<Subtitle> sub)
236 FrameRateConversion frc (_film->source_frame_rate(), _film->dcp_frame_rate());
238 if (frc.skip && (_video_frames_in % 2)) {
243 boost::mutex::scoped_lock lock (_mutex);
245 /* Wait until the queue has gone down a bit */
246 while (_queue.size() >= _threads.size() * 2 && !_terminate) {
247 TIMING ("decoder sleeps with queue of %1", _queue.size());
248 _condition.wait (lock);
249 TIMING ("decoder wakes with queue of %1", _queue.size());
256 if (_writer->thrown ()) {
260 if (_writer->can_fake_write (_video_frames_out)) {
261 _writer->fake_write (_video_frames_out);
262 _have_a_real_frame = false;
264 } else if (same && _have_a_real_frame) {
265 /* Use the last frame that we encoded. */
266 _writer->repeat (_video_frames_out);
269 /* Queue this new frame for encoding */
270 pair<string, string> const s = Filter::ffmpeg_strings (_film->filters());
271 TIMING ("adding to queue of %1", _queue.size ());
272 _queue.push_back (boost::shared_ptr<DCPVideoFrame> (
274 image, sub, _film->format()->dcp_size(), _film->format()->dcp_padding (_film),
275 _film->subtitle_offset(), _film->subtitle_scale(),
276 _film->scaler(), _video_frames_out, _film->dcp_frame_rate(), s.second,
277 _film->colour_lut(), _film->j2k_bandwidth(),
282 _condition.notify_all ();
283 _have_a_real_frame = true;
290 _writer->repeat (_video_frames_out);
297 Encoder::process_audio (shared_ptr<const AudioBuffers> data)
300 /* Maybe sample-rate convert */
303 /* Compute the resampled frames count and add 32 for luck */
304 int const max_resampled_frames = ceil ((int64_t) data->frames() * _film->target_audio_sample_rate() / _film->audio_stream()->sample_rate()) + 32;
306 shared_ptr<AudioBuffers> resampled (new AudioBuffers (_film->audio_stream()->channels(), max_resampled_frames));
309 int const resampled_frames = swr_convert (
310 _swr_context, (uint8_t **) resampled->data(), max_resampled_frames, (uint8_t const **) data->data(), data->frames()
313 if (resampled_frames < 0) {
314 throw EncodeError (_("could not run sample-rate converter"));
317 resampled->set_frames (resampled_frames);
319 /* And point our variables at the resampled audio */
328 Encoder::terminate_threads ()
330 boost::mutex::scoped_lock lock (_mutex);
332 _condition.notify_all ();
335 for (list<boost::thread *>::iterator i = _threads.begin(); i != _threads.end(); ++i) {
336 if ((*i)->joinable ()) {
344 Encoder::encoder_thread (ServerDescription* server)
346 /* Number of seconds that we currently wait between attempts
347 to connect to the server; not relevant for localhost
350 int remote_backoff = 0;
354 TIMING ("encoder thread %1 sleeps", boost::this_thread::get_id());
355 boost::mutex::scoped_lock lock (_mutex);
356 while (_queue.empty () && !_terminate) {
357 _condition.wait (lock);
364 TIMING ("encoder thread %1 wakes with queue of %2", boost::this_thread::get_id(), _queue.size());
365 boost::shared_ptr<DCPVideoFrame> vf = _queue.front ();
366 _film->log()->log (String::compose (N_("Encoder thread %1 pops frame %2 from queue"), boost::this_thread::get_id(), vf->frame()), Log::VERBOSE);
371 shared_ptr<EncodedData> encoded;
375 encoded = vf->encode_remotely (server);
377 if (remote_backoff > 0) {
378 _film->log()->log (String::compose (N_("%1 was lost, but now she is found; removing backoff"), server->host_name ()));
381 /* This job succeeded, so remove any backoff */
384 } catch (std::exception& e) {
385 if (remote_backoff < 60) {
387 remote_backoff += 10;
391 N_("Remote encode of %1 on %2 failed (%3); thread sleeping for %4s"),
392 vf->frame(), server->host_name(), e.what(), remote_backoff)
398 TIMING ("encoder thread %1 begins local encode of %2", boost::this_thread::get_id(), vf->frame());
399 encoded = vf->encode_locally ();
400 TIMING ("encoder thread %1 finishes local encode of %2", boost::this_thread::get_id(), vf->frame());
401 } catch (std::exception& e) {
402 _film->log()->log (String::compose (N_("Local encode failed (%1)"), e.what ()));
407 _writer->write (encoded, vf->frame ());
412 String::compose (N_("Encoder thread %1 pushes frame %2 back onto queue after failure"), boost::this_thread::get_id(), vf->frame())
414 _queue.push_front (vf);
418 if (remote_backoff > 0) {
419 dvdomatic_sleep (remote_backoff);
423 _condition.notify_all ();
428 Encoder::write_audio (shared_ptr<const AudioBuffers> data)
430 AudioMapping m (_film->audio_channels ());
431 if (m.dcp_channels() != _film->audio_channels()) {
433 /* Remap (currently just for mono -> 5.1) */
435 shared_ptr<AudioBuffers> b (new AudioBuffers (m.dcp_channels(), data->frames ()));
436 for (int i = 0; i < m.dcp_channels(); ++i) {
437 optional<int> s = m.dcp_to_source (static_cast<libdcp::Channel> (i));
441 memcpy (b->data()[i], data->data()[s.get()], data->frames() * sizeof(float));
448 _writer->write (data);