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>
32 #include "exceptions.h"
35 #include "dcp_video_frame.h"
41 #include "audio_mapping.h"
42 #include "container.h"
48 using std::stringstream;
53 using boost::shared_ptr;
54 using boost::optional;
56 int const Encoder::_history_size = 25;
58 /** @param f Film that we are encoding */
59 Encoder::Encoder (shared_ptr<Film> f, shared_ptr<Job> j)
62 , _video_frames_out (0)
63 , _have_a_real_frame (false)
78 Encoder::process_begin ()
80 for (int i = 0; i < Config::instance()->num_local_encoding_threads (); ++i) {
81 _threads.push_back (new boost::thread (boost::bind (&Encoder::encoder_thread, this, (ServerDescription *) 0)));
84 vector<ServerDescription*> servers = Config::instance()->servers ();
86 for (vector<ServerDescription*>::iterator i = servers.begin(); i != servers.end(); ++i) {
87 for (int j = 0; j < (*i)->threads (); ++j) {
88 _threads.push_back (new boost::thread (boost::bind (&Encoder::encoder_thread, this, *i)));
92 _writer.reset (new Writer (_film, _job));
97 Encoder::process_end ()
99 boost::mutex::scoped_lock lock (_mutex);
101 _film->log()->log (String::compose (N_("Clearing queue of %1"), _queue.size ()));
103 /* Keep waking workers until the queue is empty */
104 while (!_queue.empty ()) {
105 _film->log()->log (String::compose (N_("Waking with %1"), _queue.size ()), Log::VERBOSE);
106 _condition.notify_all ();
107 _condition.wait (lock);
112 terminate_threads ();
114 _film->log()->log (String::compose (N_("Mopping up %1"), _queue.size()));
116 /* The following sequence of events can occur in the above code:
117 1. a remote worker takes the last image off the queue
118 2. the loop above terminates
119 3. the remote worker fails to encode the image and puts it back on the queue
120 4. the remote worker is then terminated by terminate_threads
122 So just mop up anything left in the queue here.
125 for (list<shared_ptr<DCPVideoFrame> >::iterator i = _queue.begin(); i != _queue.end(); ++i) {
126 _film->log()->log (String::compose (N_("Encode left-over frame %1"), (*i)->frame ()));
128 _writer->write ((*i)->encode_locally(), (*i)->frame ());
130 } catch (std::exception& e) {
131 _film->log()->log (String::compose (N_("Local encode failed (%1)"), e.what ()));
139 /** @return an estimate of the current number of frames we are encoding per second,
143 Encoder::current_encoding_rate () const
145 boost::mutex::scoped_lock lock (_history_mutex);
146 if (int (_time_history.size()) < _history_size) {
151 gettimeofday (&now, 0);
153 return _history_size / (seconds (now) - seconds (_time_history.back ()));
156 /** @return Number of video frames that have been sent out */
158 Encoder::video_frames_out () const
160 boost::mutex::scoped_lock (_history_mutex);
161 return _video_frames_out;
164 /** Should be called when a frame has been encoded successfully.
165 * @param n Source frame index.
168 Encoder::frame_done ()
170 boost::mutex::scoped_lock lock (_history_mutex);
173 gettimeofday (&tv, 0);
174 _time_history.push_front (tv);
175 if (int (_time_history.size()) > _history_size) {
176 _time_history.pop_back ();
181 Encoder::process_video (shared_ptr<const Image> image, bool same, shared_ptr<Subtitle> sub, Time)
183 boost::mutex::scoped_lock lock (_mutex);
185 /* Wait until the queue has gone down a bit */
186 while (_queue.size() >= _threads.size() * 2 && !_terminate) {
187 TIMING ("decoder sleeps with queue of %1", _queue.size());
188 _condition.wait (lock);
189 TIMING ("decoder wakes with queue of %1", _queue.size());
196 if (_writer->thrown ()) {
200 if (_writer->can_fake_write (_video_frames_out)) {
201 _writer->fake_write (_video_frames_out);
202 _have_a_real_frame = false;
204 } else if (same && _have_a_real_frame) {
205 /* Use the last frame that we encoded. */
206 _writer->repeat (_video_frames_out);
209 /* Queue this new frame for encoding */
210 pair<string, string> const s = Filter::ffmpeg_strings (_film->filters());
211 TIMING ("adding to queue of %1", _queue.size ());
213 _queue.push_back (shared_ptr<DCPVideoFrame> (
215 image, sub, _film->container()->dcp_size(), 0,
216 _film->subtitle_offset(), _film->subtitle_scale(),
217 _film->scaler(), _video_frames_out, _film->dcp_video_frame_rate(), s.second,
218 _film->colour_lut(), _film->j2k_bandwidth(),
223 _condition.notify_all ();
224 _have_a_real_frame = true;
231 Encoder::process_audio (shared_ptr<const AudioBuffers> data, Time)
233 _writer->write (data);
237 Encoder::terminate_threads ()
239 boost::mutex::scoped_lock lock (_mutex);
241 _condition.notify_all ();
244 for (list<boost::thread *>::iterator i = _threads.begin(); i != _threads.end(); ++i) {
245 if ((*i)->joinable ()) {
253 Encoder::encoder_thread (ServerDescription* server)
255 /* Number of seconds that we currently wait between attempts
256 to connect to the server; not relevant for localhost
259 int remote_backoff = 0;
263 TIMING ("encoder thread %1 sleeps", boost::this_thread::get_id());
264 boost::mutex::scoped_lock lock (_mutex);
265 while (_queue.empty () && !_terminate) {
266 _condition.wait (lock);
273 TIMING ("encoder thread %1 wakes with queue of %2", boost::this_thread::get_id(), _queue.size());
274 shared_ptr<DCPVideoFrame> vf = _queue.front ();
275 _film->log()->log (String::compose (N_("Encoder thread %1 pops frame %2 from queue"), boost::this_thread::get_id(), vf->frame()), Log::VERBOSE);
280 shared_ptr<EncodedData> encoded;
284 encoded = vf->encode_remotely (server);
286 if (remote_backoff > 0) {
287 _film->log()->log (String::compose (N_("%1 was lost, but now she is found; removing backoff"), server->host_name ()));
290 /* This job succeeded, so remove any backoff */
293 } catch (std::exception& e) {
294 if (remote_backoff < 60) {
296 remote_backoff += 10;
300 N_("Remote encode of %1 on %2 failed (%3); thread sleeping for %4s"),
301 vf->frame(), server->host_name(), e.what(), remote_backoff)
307 TIMING ("encoder thread %1 begins local encode of %2", boost::this_thread::get_id(), vf->frame());
308 encoded = vf->encode_locally ();
309 TIMING ("encoder thread %1 finishes local encode of %2", boost::this_thread::get_id(), vf->frame());
310 } catch (std::exception& e) {
311 _film->log()->log (String::compose (N_("Local encode failed (%1)"), e.what ()));
316 _writer->write (encoded, vf->frame ());
321 String::compose (N_("Encoder thread %1 pushes frame %2 back onto queue after failure"), boost::this_thread::get_id(), vf->frame())
323 _queue.push_front (vf);
327 if (remote_backoff > 0) {
328 dcpomatic_sleep (remote_backoff);
332 _condition.notify_all ();