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.
32 #include "enum_indexed_vector.h"
33 #include "event_history.h"
34 #include "exception_store.h"
35 #include "j2k_encoder_thread.h"
37 #include <boost/optional.hpp>
38 #include <boost/signals2.hpp>
39 #include <boost/thread.hpp>
40 #include <boost/thread/condition.hpp>
41 #include <boost/thread/mutex.hpp>
47 class EncodeServerDescription;
52 namespace grk_plugin {
53 struct DcpomaticContext;
57 struct local_threads_created_and_destroyed;
58 struct remote_threads_created_and_destroyed;
59 struct frames_not_lost_when_threads_disappear;
63 * @brief Class to manage encoding to J2K.
65 * This class keeps a queue of frames to be encoded and distributes
66 * the work around threads and encoding servers.
68 class J2KEncoder : public ExceptionStore
71 J2KEncoder(std::shared_ptr<const Film> film, Writer& writer);
74 J2KEncoder (J2KEncoder const&) = delete;
75 J2KEncoder& operator= (J2KEncoder const&) = delete;
77 /** Called to indicate that a processing run is about to begin */
80 /** Called to pass a bit of video to be encoded as the next DCP frame */
81 void encode (std::shared_ptr<PlayerVideo> pv, dcpomatic::DCPTime time);
86 /** Called when a processing run has finished */
89 boost::optional<float> current_encoding_rate () const;
90 int video_frames_enqueued () const;
93 void retry(DCPVideo frame);
94 void write(std::shared_ptr<const dcp::Data> data, int index, Eyes eyes);
97 friend struct ::local_threads_created_and_destroyed;
98 friend struct ::remote_threads_created_and_destroyed;
99 friend struct ::frames_not_lost_when_threads_disappear;
102 void servers_list_changed ();
103 void remake_threads(int cpu, int gpu, std::list<EncodeServerDescription> servers);
104 void terminate_threads ();
106 /** Film that we are encoding */
107 std::shared_ptr<const Film> _film;
109 EventHistory _history;
111 boost::mutex _threads_mutex;
112 std::vector<std::shared_ptr<J2KEncoderThread>> _threads;
114 mutable boost::mutex _queue_mutex;
115 std::list<DCPVideo> _queue;
116 /** condition to manage thread wakeups when we have nothing to do */
117 boost::condition _empty_condition;
118 /** condition to manage thread wakeups when we have too much to do */
119 boost::condition _full_condition;
124 EnumIndexedVector<std::shared_ptr<PlayerVideo>, Eyes> _last_player_video;
125 boost::optional<dcpomatic::DCPTime> _last_player_video_time;
127 boost::signals2::scoped_connection _server_found_connection;
129 #ifdef DCPOMATIC_GROK
130 grk_plugin::DcpomaticContext* _dcpomatic_context = nullptr;
131 grk_plugin::GrokContext *_context = nullptr;
134 bool _ending = false;