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.
29 #include "dcp_video.h"
33 #include "server_finder.h"
35 #include "player_video.h"
36 #include <libcxml/cxml.h>
37 #include <boost/lambda/lambda.hpp>
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.threads(), 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 if (!ServerFinder::instance()->disabled ()) {
97 _server_found_connection = ServerFinder::instance()->connect (boost::bind (&Encoder::server_found, this, _1));
104 boost::mutex::scoped_lock lock (_mutex);
106 LOG_GENERAL (N_("Clearing queue of %1"), _queue.size ());
108 /* Keep waking workers until the queue is empty */
109 while (!_queue.empty ()) {
110 _empty_condition.notify_all ();
111 _full_condition.wait (lock);
116 terminate_threads ();
118 LOG_GENERAL (N_("Mopping up %1"), _queue.size());
120 /* The following sequence of events can occur in the above code:
121 1. a remote worker takes the last image off the queue
122 2. the loop above terminates
123 3. the remote worker fails to encode the image and puts it back on the queue
124 4. the remote worker is then terminated by terminate_threads
126 So just mop up anything left in the queue here.
129 for (list<shared_ptr<DCPVideo> >::iterator i = _queue.begin(); i != _queue.end(); ++i) {
130 LOG_GENERAL (N_("Encode left-over frame %1"), (*i)->index ());
133 (*i)->encode_locally (boost::bind (&Log::dcp_log, _film->log().get(), _1, _2)),
138 } catch (std::exception& e) {
139 LOG_ERROR (N_("Local encode failed (%1)"), e.what ());
144 /** @return an estimate of the current number of frames we are encoding per second,
148 Encoder::current_encoding_rate () const
150 boost::mutex::scoped_lock lock (_state_mutex);
151 if (int (_time_history.size()) < _history_size) {
156 gettimeofday (&now, 0);
158 return _history_size / (seconds (now) - seconds (_time_history.back ()));
161 /** @return Number of video frames that have been sent out */
163 Encoder::video_frames_out () const
165 boost::mutex::scoped_lock (_state_mutex);
166 return _video_frames_out;
169 /** Should be called when a frame has been encoded successfully.
170 * @param n Source frame index.
173 Encoder::frame_done ()
175 boost::mutex::scoped_lock lock (_state_mutex);
178 gettimeofday (&tv, 0);
179 _time_history.push_front (tv);
180 if (int (_time_history.size()) > _history_size) {
181 _time_history.pop_back ();
185 /** Called in order, so each time this is called the supplied frame is the one
186 * after the previous one.
189 Encoder::enqueue (shared_ptr<PlayerVideo> pv)
193 boost::mutex::scoped_lock lock (_mutex);
195 /* XXX: discard 3D here if required */
197 /* Wait until the queue has gone down a bit */
198 while (_queue.size() >= _threads.size() * 2 && !_terminate) {
199 LOG_TIMING ("decoder sleeps with queue of %1", _queue.size());
200 _full_condition.wait (lock);
201 LOG_TIMING ("decoder wakes with queue of %1", _queue.size());
209 /* Re-throw any exception raised by one of our threads. If more
210 than one has thrown an exception, only one will be rethrown, I think;
211 but then, if that happens something has gone badly wrong.
215 if (_writer->can_fake_write (_video_frames_out)) {
216 /* We can fake-write this frame */
217 _writer->fake_write (_video_frames_out, pv->eyes ());
219 } else if (pv->has_j2k ()) {
220 /* This frame already has JPEG2000 data, so just write it */
221 _writer->write (pv->j2k(), _video_frames_out, pv->eyes ());
223 /* Queue this new frame for encoding */
224 LOG_TIMING ("adding to queue of %1", _queue.size ());
225 _queue.push_back (shared_ptr<DCPVideo> (
229 _film->video_frame_rate(),
230 _film->j2k_bandwidth(),
232 _film->burn_subtitles(),
237 /* The queue might not be empty any more, so notify anything which is
240 _empty_condition.notify_all ();
243 if (pv->eyes() != EYES_LEFT) {
249 Encoder::terminate_threads ()
252 boost::mutex::scoped_lock lock (_mutex);
254 _full_condition.notify_all ();
255 _empty_condition.notify_all ();
258 for (list<boost::thread *>::iterator i = _threads.begin(); i != _threads.end(); ++i) {
259 if ((*i)->joinable ()) {
269 Encoder::encoder_thread (optional<ServerDescription> server)
272 /* Number of seconds that we currently wait between attempts
273 to connect to the server; not relevant for localhost
276 int remote_backoff = 0;
277 shared_ptr<DCPVideo> last_dcp_video;
278 shared_ptr<EncodedData> last_encoded;
282 LOG_TIMING ("[%1] encoder thread sleeps", boost::this_thread::get_id());
283 boost::mutex::scoped_lock lock (_mutex);
284 while (_queue.empty () && !_terminate) {
285 _empty_condition.wait (lock);
292 LOG_TIMING ("[%1] encoder thread wakes with queue of %2", boost::this_thread::get_id(), _queue.size());
293 shared_ptr<DCPVideo> vf = _queue.front ();
294 LOG_TIMING ("[%1] encoder thread pops frame %2 (%3) from queue", boost::this_thread::get_id(), vf->index(), vf->eyes ());
299 shared_ptr<EncodedData> encoded;
301 if (last_dcp_video && vf->same (last_dcp_video)) {
302 /* We already have encoded data for the same input as this one, so take a short-cut */
303 encoded = last_encoded;
305 /* We need to encode this input */
308 encoded = vf->encode_remotely (server.get ());
310 if (remote_backoff > 0) {
311 LOG_GENERAL ("%1 was lost, but now she is found; removing backoff", server->host_name ());
314 /* This job succeeded, so remove any backoff */
317 } catch (std::exception& e) {
318 if (remote_backoff < 60) {
320 remote_backoff += 10;
323 N_("Remote encode of %1 on %2 failed (%3); thread sleeping for %4s"),
324 vf->index(), server->host_name(), e.what(), remote_backoff
330 LOG_TIMING ("[%1] encoder thread begins local encode of %2", boost::this_thread::get_id(), vf->index());
331 encoded = vf->encode_locally (boost::bind (&Log::dcp_log, _film->log().get(), _1, _2));
332 LOG_TIMING ("[%1] encoder thread finishes local encode of %2", boost::this_thread::get_id(), vf->index());
333 } catch (std::exception& e) {
334 LOG_ERROR (N_("Local encode failed (%1)"), e.what ());
340 last_encoded = encoded;
343 _writer->write (encoded, vf->index (), vf->eyes ());
347 LOG_GENERAL (N_("[%1] Encoder thread pushes frame %2 back onto queue after failure"), boost::this_thread::get_id(), vf->index());
348 _queue.push_front (vf);
352 if (remote_backoff > 0) {
353 dcpomatic_sleep (remote_backoff);
356 /* The queue might not be full any more, so notify anything that is waiting on that */
358 _full_condition.notify_all ();
367 Encoder::server_found (ServerDescription s)
369 add_worker_threads (s);