2 Copyright (C) 2012-2015 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 #ifndef DCPOMATIC_ENCODER_H
21 #define DCPOMATIC_ENCODER_H
23 /** @file src/encoder.h
24 * @brief Encoder class.
29 #include "exception_store.h"
30 #include <boost/shared_ptr.hpp>
31 #include <boost/thread/mutex.hpp>
32 #include <boost/thread/condition.hpp>
33 #include <boost/thread.hpp>
34 #include <boost/optional.hpp>
35 #include <boost/signals2.hpp>
40 class ServerDescription;
47 * @brief Class to manage encoding to JPEG2000.
49 * This class keeps a queue of frames to be encoded and distributes
50 * the work around threads and encoding servers.
53 class Encoder : public boost::noncopyable, public ExceptionStore
56 Encoder (boost::shared_ptr<const Film>, boost::weak_ptr<Job>, boost::shared_ptr<Writer>);
59 /** Called to indicate that a processing run is about to begin */
62 /** Called to pass in zero or more bits of video to be encoded
63 * as the next DCP frame.
65 void encode (std::list<boost::shared_ptr<PlayerVideo> > f);
67 /** Called when a processing run has finished */
70 float current_encoding_rate () const;
71 int video_frames_out () const;
75 void enqueue (boost::shared_ptr<PlayerVideo> f);
78 void encoder_thread (boost::optional<ServerDescription>);
79 void terminate_threads ();
80 void servers_list_changed ();
82 /** Film that we are encoding */
83 boost::shared_ptr<const Film> _film;
84 boost::weak_ptr<Job> _job;
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;