2 Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
21 #ifndef DCPOMATIC_ENCODER_H
22 #define DCPOMATIC_ENCODER_H
24 /** @file src/encoder.h
25 * @brief Encoder class.
30 #include "exception_store.h"
31 #include <boost/shared_ptr.hpp>
32 #include <boost/thread/mutex.hpp>
33 #include <boost/thread/condition.hpp>
34 #include <boost/thread.hpp>
35 #include <boost/optional.hpp>
36 #include <boost/signals2.hpp>
41 class EncodeServerDescription;
48 * @brief Class to manage encoding to JPEG2000.
50 * This class keeps a queue of frames to be encoded and distributes
51 * the work around threads and encoding servers.
54 class Encoder : public boost::noncopyable, public ExceptionStore
57 Encoder (boost::shared_ptr<const Film>, boost::shared_ptr<Writer>);
60 /** Called to indicate that a processing run is about to begin */
63 /** Called to pass in zero or more bits of video to be encoded
64 * as the next DCP frame.
66 void encode (std::list<boost::shared_ptr<PlayerVideo> > f);
68 /** Called when a processing run has finished */
71 float current_encoding_rate () const;
72 int video_frames_out () const;
76 void enqueue (boost::shared_ptr<PlayerVideo> f);
79 void encoder_thread (boost::optional<EncodeServerDescription>);
80 void terminate_threads ();
81 void servers_list_changed ();
83 /** Film that we are encoding */
84 boost::shared_ptr<const Film> _film;
86 /** Mutex for _time_history and _video_frames_enqueued */
87 mutable boost::mutex _state_mutex;
88 /** List of the times of completion of the last _history_size frames;
89 first is the most recently completed.
91 std::list<struct timeval> _time_history;
92 /** Number of frames that we should keep history for */
93 static int const _history_size;
94 /** Current DCP frame index */
97 /* XXX: probably should be atomic */
98 bool _terminate_enqueue;
99 bool _terminate_encoding;
100 /** Mutex for _threads */
101 mutable boost::mutex _threads_mutex;
102 std::list<boost::thread *> _threads;
103 mutable boost::mutex _queue_mutex;
104 std::list<boost::shared_ptr<DCPVideo> > _queue;
105 /** condition to manage thread wakeups when we have nothing to do */
106 boost::condition _empty_condition;
107 /** condition to manage thread wakeups when we have too much to do */
108 boost::condition _full_condition;
110 boost::shared_ptr<Writer> _writer;
113 boost::shared_ptr<PlayerVideo> _last_player_video;
115 boost::signals2::scoped_connection _server_found_connection;