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);
53 using boost::shared_ptr;
54 using boost::weak_ptr;
55 using boost::optional;
56 using boost::scoped_array;
58 int const Encoder::_history_size = 25;
60 /** @param f Film that we are encoding */
61 Encoder::Encoder (shared_ptr<const Film> f, weak_ptr<Job> j, shared_ptr<Writer> writer)
64 , _video_frames_out (0)
76 /** Add a worker thread for a each thread on a remote server. Caller must hold
77 * a lock on _mutex, or know that one is not currently required to
78 * safely modify _threads.
81 Encoder::add_worker_threads (ServerDescription d)
83 LOG_GENERAL (N_("Adding %1 worker threads for remote %2"), d.host_name ());
84 for (int i = 0; i < d.threads(); ++i) {
85 _threads.push_back (new boost::thread (boost::bind (&Encoder::encoder_thread, this, d)));
92 for (int i = 0; i < Config::instance()->num_local_encoding_threads (); ++i) {
93 _threads.push_back (new boost::thread (boost::bind (&Encoder::encoder_thread, this, optional<ServerDescription> ())));
96 ServerFinder::instance()->connect (boost::bind (&Encoder::server_found, this, _1));
102 boost::mutex::scoped_lock lock (_mutex);
104 LOG_GENERAL (N_("Clearing queue of %1"), _queue.size ());
106 /* Keep waking workers until the queue is empty */
107 while (!_queue.empty ()) {
108 _empty_condition.notify_all ();
109 _full_condition.wait (lock);
114 terminate_threads ();
116 LOG_GENERAL (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<DCPVideo> >::iterator i = _queue.begin(); i != _queue.end(); ++i) {
128 LOG_GENERAL (N_("Encode left-over frame %1"), (*i)->index ());
130 _writer->write ((*i)->encode_locally(), (*i)->index (), (*i)->eyes ());
132 } catch (std::exception& e) {
133 LOG_ERROR (N_("Local encode failed (%1)"), e.what ());
138 /** @return an estimate of the current number of frames we are encoding per second,
142 Encoder::current_encoding_rate () const
144 boost::mutex::scoped_lock lock (_state_mutex);
145 if (int (_time_history.size()) < _history_size) {
150 gettimeofday (&now, 0);
152 return _history_size / (seconds (now) - seconds (_time_history.back ()));
155 /** @return Number of video frames that have been sent out */
157 Encoder::video_frames_out () const
159 boost::mutex::scoped_lock (_state_mutex);
160 return _video_frames_out;
163 /** Should be called when a frame has been encoded successfully.
164 * @param n Source frame index.
167 Encoder::frame_done ()
169 boost::mutex::scoped_lock lock (_state_mutex);
172 gettimeofday (&tv, 0);
173 _time_history.push_front (tv);
174 if (int (_time_history.size()) > _history_size) {
175 _time_history.pop_back ();
180 Encoder::enqueue (shared_ptr<PlayerVideo> pvf)
184 boost::mutex::scoped_lock lock (_mutex);
186 /* XXX: discard 3D here if required */
188 /* Wait until the queue has gone down a bit */
189 while (_queue.size() >= _threads.size() * 2 && !_terminate) {
190 LOG_TIMING ("decoder sleeps with queue of %1", _queue.size());
191 _full_condition.wait (lock);
192 LOG_TIMING ("decoder wakes with queue of %1", _queue.size());
200 /* Re-throw any exception raised by one of our threads. If more
201 than one has thrown an exception, only one will be rethrown, I think;
202 but then, if that happens something has gone badly wrong.
206 if (_writer->can_fake_write (_video_frames_out)) {
207 _writer->fake_write (_video_frames_out, pvf->eyes ());
209 } else if (pvf->has_j2k ()) {
210 _writer->write (pvf->j2k(), _video_frames_out, pvf->eyes ());
212 /* Queue this new frame for encoding */
213 LOG_TIMING ("adding to queue of %1", _queue.size ());
214 _queue.push_back (shared_ptr<DCPVideo> (
218 _film->video_frame_rate(),
219 _film->j2k_bandwidth(),
221 _film->burn_subtitles(),
226 /* The queue might not be empty any more, so notify anything which is
229 _empty_condition.notify_all ();
232 if (pvf->eyes() != EYES_LEFT) {
238 Encoder::terminate_threads ()
241 boost::mutex::scoped_lock lock (_mutex);
243 _full_condition.notify_all ();
244 _empty_condition.notify_all ();
247 for (list<boost::thread *>::iterator i = _threads.begin(); i != _threads.end(); ++i) {
248 if ((*i)->joinable ()) {
258 Encoder::encoder_thread (optional<ServerDescription> server)
261 /* Number of seconds that we currently wait between attempts
262 to connect to the server; not relevant for localhost
265 int remote_backoff = 0;
269 LOG_TIMING ("[%1] encoder thread sleeps", boost::this_thread::get_id());
270 boost::mutex::scoped_lock lock (_mutex);
271 while (_queue.empty () && !_terminate) {
272 _empty_condition.wait (lock);
279 LOG_TIMING ("[%1] encoder thread wakes with queue of %2", boost::this_thread::get_id(), _queue.size());
280 shared_ptr<DCPVideo> vf = _queue.front ();
281 LOG_TIMING ("[%1] encoder thread pops frame %2 (%3) from queue", boost::this_thread::get_id(), vf->index(), vf->eyes ());
286 shared_ptr<EncodedData> encoded;
290 encoded = vf->encode_remotely (server.get ());
292 if (remote_backoff > 0) {
293 LOG_GENERAL ("%1 was lost, but now she is found; removing backoff", server->host_name ());
296 /* This job succeeded, so remove any backoff */
299 } catch (std::exception& e) {
300 if (remote_backoff < 60) {
302 remote_backoff += 10;
305 N_("Remote encode of %1 on %2 failed (%3); thread sleeping for %4s"),
306 vf->index(), server->host_name(), e.what(), remote_backoff
312 LOG_TIMING ("[%1] encoder thread begins local encode of %2", boost::this_thread::get_id(), vf->index());
313 encoded = vf->encode_locally ();
314 LOG_TIMING ("[%1] encoder thread finishes local encode of %2", boost::this_thread::get_id(), vf->index());
315 } catch (std::exception& e) {
316 LOG_ERROR (N_("Local encode failed (%1)"), e.what ());
321 _writer->write (encoded, vf->index (), vf->eyes ());
325 LOG_GENERAL (N_("[%1] Encoder thread pushes frame %2 back onto queue after failure"), boost::this_thread::get_id(), vf->index());
326 _queue.push_front (vf);
330 if (remote_backoff > 0) {
331 dcpomatic_sleep (remote_backoff);
334 /* The queue might not be full any more, so notify anything that is waiting on that */
336 _full_condition.notify_all ();
345 Encoder::server_found (ServerDescription s)
347 add_worker_threads (s);