2 Copyright (C) 2012-2014 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/lambda/lambda.hpp>
26 #include <libcxml/cxml.h>
32 #include "dcp_video_frame.h"
36 #include "server_finder.h"
38 #include "player_video_frame.h"
44 using std::stringstream;
50 using boost::shared_ptr;
51 using boost::weak_ptr;
52 using boost::optional;
53 using boost::scoped_array;
55 int const Encoder::_history_size = 25;
57 /** @param f Film that we are encoding */
58 Encoder::Encoder (shared_ptr<const Film> f, weak_ptr<Job> j)
61 , _video_frames_out (0)
64 _have_a_real_frame[EYES_BOTH] = false;
65 _have_a_real_frame[EYES_LEFT] = false;
66 _have_a_real_frame[EYES_RIGHT] = false;
74 /** Add a worker thread for a each thread on a remote server. Caller must hold
75 * a lock on _mutex, or know that one is not currently required to
76 * safely modify _threads.
79 Encoder::add_worker_threads (ServerDescription d)
81 _film->log()->log (String::compose (N_("Adding %1 worker threads for remote %2"), d.host_name ()));
82 for (int i = 0; i < d.threads(); ++i) {
83 _threads.push_back (new boost::thread (boost::bind (&Encoder::encoder_thread, this, d)));
88 Encoder::process_begin ()
90 for (int i = 0; i < Config::instance()->num_local_encoding_threads (); ++i) {
91 _threads.push_back (new boost::thread (boost::bind (&Encoder::encoder_thread, this, optional<ServerDescription> ())));
94 _writer.reset (new Writer (_film, _job));
95 ServerFinder::instance()->connect (boost::bind (&Encoder::server_found, this, _1));
99 Encoder::process_end ()
101 boost::mutex::scoped_lock lock (_mutex);
103 _film->log()->log (String::compose (N_("Clearing queue of %1"), _queue.size ()));
105 /* Keep waking workers until the queue is empty */
106 while (!_queue.empty ()) {
107 _film->log()->log (String::compose (N_("Waking with %1"), _queue.size ()), Log::VERBOSE);
108 _condition.notify_all ();
109 _condition.wait (lock);
114 terminate_threads ();
116 _film->log()->log (String::compose (N_("Mopping up %1"), _queue.size()));
118 /* The following sequence of events can occur in the above code:
119 1. a remote worker takes the last image off the queue
120 2. the loop above terminates
121 3. the remote worker fails to encode the image and puts it back on the queue
122 4. the remote worker is then terminated by terminate_threads
124 So just mop up anything left in the queue here.
127 for (list<shared_ptr<DCPVideoFrame> >::iterator i = _queue.begin(); i != _queue.end(); ++i) {
128 _film->log()->log (String::compose (N_("Encode left-over frame %1"), (*i)->index ()));
130 _writer->write ((*i)->encode_locally(), (*i)->index (), (*i)->eyes ());
132 } catch (std::exception& e) {
133 _film->log()->log (String::compose (N_("Local encode failed (%1)"), e.what ()));
141 /** @return an estimate of the current number of frames we are encoding per second,
145 Encoder::current_encoding_rate () const
147 boost::mutex::scoped_lock lock (_state_mutex);
148 if (int (_time_history.size()) < _history_size) {
153 gettimeofday (&now, 0);
155 return _history_size / (seconds (now) - seconds (_time_history.back ()));
158 /** @return Number of video frames that have been sent out */
160 Encoder::video_frames_out () const
162 boost::mutex::scoped_lock (_state_mutex);
163 return _video_frames_out;
166 /** Should be called when a frame has been encoded successfully.
167 * @param n Source frame index.
170 Encoder::frame_done ()
172 boost::mutex::scoped_lock lock (_state_mutex);
175 gettimeofday (&tv, 0);
176 _time_history.push_front (tv);
177 if (int (_time_history.size()) > _history_size) {
178 _time_history.pop_back ();
183 Encoder::process_video (shared_ptr<PlayerVideoFrame> pvf, bool same)
187 boost::mutex::scoped_lock lock (_mutex);
189 /* XXX: discard 3D here if required */
191 /* Wait until the queue has gone down a bit */
192 while (_queue.size() >= _threads.size() * 2 && !_terminate) {
193 TIMING ("decoder sleeps with queue of %1", _queue.size());
194 _condition.wait (lock);
195 TIMING ("decoder wakes with queue of %1", _queue.size());
203 /* Re-throw any exception raised by one of our threads. If more
204 than one has thrown an exception, only one will be rethrown, I think;
205 but then, if that happens something has gone badly wrong.
209 if (_writer->can_fake_write (_video_frames_out)) {
210 _writer->fake_write (_video_frames_out, pvf->eyes ());
211 _have_a_real_frame[pvf->eyes()] = false;
213 } else if (same && _have_a_real_frame[pvf->eyes()]) {
214 /* Use the last frame that we encoded. */
215 _writer->repeat (_video_frames_out, pvf->eyes());
218 /* Queue this new frame for encoding */
219 TIMING ("adding to queue of %1", _queue.size ());
220 _queue.push_back (shared_ptr<DCPVideoFrame> (
222 pvf, _video_frames_out, _film->video_frame_rate(),
223 _film->j2k_bandwidth(), _film->resolution(), _film->log()
227 _condition.notify_all ();
228 _have_a_real_frame[pvf->eyes()] = true;
231 if (pvf->eyes() != EYES_LEFT) {
237 Encoder::process_audio (shared_ptr<const AudioBuffers> data)
239 _writer->write (data);
243 Encoder::terminate_threads ()
246 boost::mutex::scoped_lock lock (_mutex);
248 _condition.notify_all ();
251 for (list<boost::thread *>::iterator i = _threads.begin(); i != _threads.end(); ++i) {
252 if ((*i)->joinable ()) {
262 Encoder::encoder_thread (optional<ServerDescription> server)
265 /* Number of seconds that we currently wait between attempts
266 to connect to the server; not relevant for localhost
269 int remote_backoff = 0;
273 TIMING ("encoder thread %1 sleeps", boost::this_thread::get_id());
274 boost::mutex::scoped_lock lock (_mutex);
275 while (_queue.empty () && !_terminate) {
276 _condition.wait (lock);
283 TIMING ("encoder thread %1 wakes with queue of %2", boost::this_thread::get_id(), _queue.size());
284 shared_ptr<DCPVideoFrame> vf = _queue.front ();
285 TIMING ("encoder thread %1 pops frame %2 (%3) from queue", boost::this_thread::get_id(), vf->index(), vf->eyes ());
290 shared_ptr<EncodedData> encoded;
294 encoded = vf->encode_remotely (server.get ());
296 if (remote_backoff > 0) {
297 _film->log()->log (String::compose (N_("%1 was lost, but now she is found; removing backoff"), server->host_name ()));
300 /* This job succeeded, so remove any backoff */
303 } catch (std::exception& e) {
304 if (remote_backoff < 60) {
306 remote_backoff += 10;
310 N_("Remote encode of %1 on %2 failed (%3); thread sleeping for %4s"),
311 vf->index(), server->host_name(), e.what(), remote_backoff)
317 TIMING ("encoder thread %1 begins local encode of %2", boost::this_thread::get_id(), vf->index());
318 encoded = vf->encode_locally ();
319 TIMING ("encoder thread %1 finishes local encode of %2", boost::this_thread::get_id(), vf->index());
320 } catch (std::exception& e) {
321 _film->log()->log (String::compose (N_("Local encode failed (%1)"), e.what ()));
326 _writer->write (encoded, vf->index (), vf->eyes ());
331 String::compose (N_("Encoder thread %1 pushes frame %2 back onto queue after failure"), boost::this_thread::get_id(), vf->index())
333 _queue.push_front (vf);
337 if (remote_backoff > 0) {
338 dcpomatic_sleep (remote_backoff);
342 _condition.notify_all ();
351 Encoder::server_found (ServerDescription s)
353 add_worker_threads (s);