2 Copyright (C) 2012-2021 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/>.
22 #ifndef DCPOMATIC_J2K_ENCODER_H
23 #define DCPOMATIC_J2K_ENCODER_H
26 /** @file src/j2k_encoder.h
27 * @brief J2KEncoder class.
33 #include "event_history.h"
34 #include "exception_store.h"
35 #include <boost/thread/mutex.hpp>
36 #include <boost/thread/condition.hpp>
37 #include <boost/thread.hpp>
38 #include <boost/optional.hpp>
39 #include <boost/signals2.hpp>
45 class EncodeServerDescription;
53 * @brief Class to manage encoding to J2K.
55 * This class keeps a queue of frames to be encoded and distributes
56 * the work around threads and encoding servers.
58 class J2KEncoder : public ExceptionStore, public std::enable_shared_from_this<J2KEncoder>
61 J2KEncoder (std::shared_ptr<const Film> film, std::shared_ptr<Writer> writer);
64 J2KEncoder (J2KEncoder const&) = delete;
65 J2KEncoder& operator= (J2KEncoder const&) = delete;
67 /** Called to indicate that a processing run is about to begin */
70 /** Called to pass a bit of video to be encoded as the next DCP frame */
71 void encode (std::shared_ptr<PlayerVideo> pv, dcpomatic::DCPTime time);
73 /** Called when a processing run has finished */
76 boost::optional<float> current_encoding_rate () const;
77 int video_frames_enqueued () const;
79 void servers_list_changed ();
83 static void call_servers_list_changed (std::weak_ptr<J2KEncoder> encoder);
87 void encoder_thread (boost::optional<EncodeServerDescription>);
88 void terminate_threads ();
90 /** Film that we are encoding */
91 std::shared_ptr<const Film> _film;
93 EventHistory _history;
95 boost::mutex _threads_mutex;
96 std::shared_ptr<boost::thread_group> _threads;
98 mutable boost::mutex _queue_mutex;
99 std::list<std::shared_ptr<DCPVideo>> _queue;
100 /** condition to manage thread wakeups when we have nothing to do */
101 boost::condition _empty_condition;
102 /** condition to manage thread wakeups when we have too much to do */
103 boost::condition _full_condition;
105 std::shared_ptr<Writer> _writer;
108 std::shared_ptr<PlayerVideo> _last_player_video[static_cast<int>(Eyes::COUNT)];
109 boost::optional<dcpomatic::DCPTime> _last_player_video_time;
111 boost::signals2::scoped_connection _server_found_connection;