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.h"
36 #include "server_finder.h"
38 #include "player_video.h"
42 #define LOG_GENERAL(...) _film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
43 #define LOG_ERROR(...) _film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_ERROR);
44 #define LOG_TIMING(...) _film->log()->microsecond_log (String::compose (__VA_ARGS__), Log::TYPE_TIMING);
48 using std::stringstream;
54 using boost::shared_ptr;
55 using boost::weak_ptr;
56 using boost::optional;
57 using boost::scoped_array;
59 int const Encoder::_history_size = 25;
61 /** @param f Film that we are encoding */
62 Encoder::Encoder (shared_ptr<const Film> f, weak_ptr<Job> j, shared_ptr<Writer> writer)
65 , _video_frames_out (0)
77 /** Add a worker thread for a each thread on a remote server. Caller must hold
78 * a lock on _mutex, or know that one is not currently required to
79 * safely modify _threads.
82 Encoder::add_worker_threads (ServerDescription d)
84 LOG_GENERAL (N_("Adding %1 worker threads for remote %2"), d.host_name ());
85 for (int i = 0; i < d.threads(); ++i) {
86 _threads.push_back (new boost::thread (boost::bind (&Encoder::encoder_thread, this, d)));
93 for (int i = 0; i < Config::instance()->num_local_encoding_threads (); ++i) {
94 _threads.push_back (new boost::thread (boost::bind (&Encoder::encoder_thread, this, optional<ServerDescription> ())));
97 ServerFinder::instance()->connect (boost::bind (&Encoder::server_found, this, _1));
103 boost::mutex::scoped_lock lock (_mutex);
105 LOG_GENERAL (N_("Clearing queue of %1"), _queue.size ());
107 /* Keep waking workers until the queue is empty */
108 while (!_queue.empty ()) {
109 _empty_condition.notify_all ();
110 _full_condition.wait (lock);
115 terminate_threads ();
117 LOG_GENERAL (N_("Mopping up %1"), _queue.size());
119 /* The following sequence of events can occur in the above code:
120 1. a remote worker takes the last image off the queue
121 2. the loop above terminates
122 3. the remote worker fails to encode the image and puts it back on the queue
123 4. the remote worker is then terminated by terminate_threads
125 So just mop up anything left in the queue here.
128 for (list<shared_ptr<DCPVideo> >::iterator i = _queue.begin(); i != _queue.end(); ++i) {
129 LOG_GENERAL (N_("Encode left-over frame %1"), (*i)->index ());
131 _writer->write ((*i)->encode_locally(), (*i)->index (), (*i)->eyes ());
133 } catch (std::exception& e) {
134 LOG_ERROR (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 (_state_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 (_state_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 (_state_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::enqueue (shared_ptr<PlayerVideo> pvf)
185 boost::mutex::scoped_lock lock (_mutex);
187 /* XXX: discard 3D here if required */
189 /* Wait until the queue has gone down a bit */
190 while (_queue.size() >= _threads.size() * 2 && !_terminate) {
191 LOG_TIMING ("decoder sleeps with queue of %1", _queue.size());
192 _full_condition.wait (lock);
193 LOG_TIMING ("decoder wakes with queue of %1", _queue.size());
201 /* Re-throw any exception raised by one of our threads. If more
202 than one has thrown an exception, only one will be rethrown, I think;
203 but then, if that happens something has gone badly wrong.
207 if (_writer->can_fake_write (_video_frames_out)) {
208 _writer->fake_write (_video_frames_out, pvf->eyes ());
211 /* Queue this new frame for encoding */
212 LOG_TIMING ("adding to queue of %1", _queue.size ());
213 _queue.push_back (shared_ptr<DCPVideo> (
217 _film->video_frame_rate(),
218 _film->j2k_bandwidth(),
220 _film->burn_subtitles(),
225 /* The queue might not be empty any more, so notify anything which is
228 _empty_condition.notify_all ();
231 if (pvf->eyes() != EYES_LEFT) {
237 Encoder::terminate_threads ()
240 boost::mutex::scoped_lock lock (_mutex);
242 _full_condition.notify_all ();
243 _empty_condition.notify_all ();
246 for (list<boost::thread *>::iterator i = _threads.begin(); i != _threads.end(); ++i) {
247 if ((*i)->joinable ()) {
257 Encoder::encoder_thread (optional<ServerDescription> server)
260 /* Number of seconds that we currently wait between attempts
261 to connect to the server; not relevant for localhost
264 int remote_backoff = 0;
268 LOG_TIMING ("[%1] encoder thread sleeps", boost::this_thread::get_id());
269 boost::mutex::scoped_lock lock (_mutex);
270 while (_queue.empty () && !_terminate) {
271 _empty_condition.wait (lock);
278 LOG_TIMING ("[%1] encoder thread wakes with queue of %2", boost::this_thread::get_id(), _queue.size());
279 shared_ptr<DCPVideo> vf = _queue.front ();
280 LOG_TIMING ("[%1] encoder thread pops frame %2 (%3) from queue", boost::this_thread::get_id(), vf->index(), vf->eyes ());
285 shared_ptr<EncodedData> encoded;
289 encoded = vf->encode_remotely (server.get ());
291 if (remote_backoff > 0) {
292 LOG_GENERAL ("%1 was lost, but now she is found; removing backoff", server->host_name ());
295 /* This job succeeded, so remove any backoff */
298 } catch (std::exception& e) {
299 if (remote_backoff < 60) {
301 remote_backoff += 10;
304 N_("Remote encode of %1 on %2 failed (%3); thread sleeping for %4s"),
305 vf->index(), server->host_name(), e.what(), remote_backoff
311 LOG_TIMING ("[%1] encoder thread begins local encode of %2", boost::this_thread::get_id(), vf->index());
312 encoded = vf->encode_locally ();
313 LOG_TIMING ("[%1] encoder thread finishes local encode of %2", boost::this_thread::get_id(), vf->index());
314 } catch (std::exception& e) {
315 LOG_ERROR (N_("Local encode failed (%1)"), e.what ());
320 _writer->write (encoded, vf->index (), vf->eyes ());
324 LOG_GENERAL (N_("[%1] Encoder thread pushes frame %2 back onto queue after failure"), boost::this_thread::get_id(), vf->index());
325 _queue.push_front (vf);
329 if (remote_backoff > 0) {
330 dcpomatic_sleep (remote_backoff);
333 /* The queue might not be full any more, so notify anything that is waiting on that */
335 _full_condition.notify_all ();
344 Encoder::server_found (ServerDescription s)
346 add_worker_threads (s);