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 /** @file src/lib/writer.h
23 * @brief Writer class.
27 #include "atmos_metadata.h"
29 #include "player_text.h"
30 #include "exception_store.h"
31 #include "dcp_text_track.h"
32 #include "weak_film.h"
33 #include <dcp/atmos_frame.h>
34 #include <boost/thread.hpp>
35 #include <boost/thread/condition.hpp>
50 class ReferencedReelAsset;
60 /** a normal frame with some JPEG200 data */
62 /** a frame whose data already exists in the MXF,
63 and we fake-write it; i.e. we update the writer's
64 state but we use the data that is already on disk.
70 /** encoded data for FULL */
71 std::shared_ptr<const dcp::Data> encoded;
72 /** size of data for FAKE */
76 /** frame index within the reel */
78 /** eyes for FULL, FAKE and REPEAT */
79 Eyes eyes = Eyes::BOTH;
83 bool operator< (QueueItem const & a, QueueItem const & b);
84 bool operator== (QueueItem const & a, QueueItem const & b);
88 * @brief Class to manage writing JPEG2000 and audio data to assets on disk.
90 * This class creates sound and picture assets, then takes Data
91 * or AudioBuffers objects (containing image or sound data respectively)
92 * and writes them to the assets.
94 * write() for Data (picture) can be called out of order, and the Writer
95 * will sort it out. write() for AudioBuffers must be called in order.
98 class Writer : public ExceptionStore, public WeakConstFilm
101 Writer (std::weak_ptr<const Film>, std::weak_ptr<Job>, bool text_only = false);
104 Writer (Writer const &) = delete;
105 Writer& operator= (Writer const &) = delete;
109 bool can_fake_write (Frame) const;
111 void write (std::shared_ptr<const dcp::Data>, Frame, Eyes);
112 void fake_write (Frame, Eyes);
113 bool can_repeat (Frame) const;
114 void repeat (Frame, Eyes);
115 void write (std::shared_ptr<const AudioBuffers>, dcpomatic::DCPTime time);
116 void write (PlayerText text, TextType type, boost::optional<DCPTextTrack>, dcpomatic::DCPTimePeriod period);
117 void write (std::vector<dcpomatic::FontData> fonts);
118 void write (ReferencedReelAsset asset);
119 void write (std::shared_ptr<const dcp::AtmosFrame> atmos, dcpomatic::DCPTime time, AtmosMetadata metadata);
120 void finish (boost::filesystem::path output_dcp);
122 void set_encoder_threads (int threads);
126 void terminate_thread (bool);
127 bool have_sequenced_image_at_queue_head ();
128 size_t video_reel (int frame) const;
129 void set_digest_progress (Job* job, float progress);
130 void write_cover_sheet (boost::filesystem::path output_dcp);
131 void calculate_referenced_digests (std::function<void (float)> set_progress);
132 void write_hanging_text (ReelWriter& reel);
133 void calculate_digests ();
135 std::weak_ptr<Job> _job;
136 std::vector<ReelWriter> _reels;
137 std::vector<ReelWriter>::iterator _audio_reel;
138 std::vector<ReelWriter>::iterator _subtitle_reel;
139 std::map<DCPTextTrack, std::vector<ReelWriter>::iterator> _caption_reels;
140 std::vector<ReelWriter>::iterator _atmos_reel;
143 boost::thread _thread;
144 /** true if our thread should finish */
145 bool _finish = false;
146 /** queue of things to write to disk */
147 std::list<QueueItem> _queue;
148 /** number of FULL frames whose JPEG200 data is currently held in RAM */
149 int _queued_full_in_memory = 0;
150 /** mutex for thread state */
151 mutable boost::mutex _state_mutex;
152 /** condition to manage thread wakeups when we have nothing to do */
153 boost::condition _empty_condition;
154 /** condition to manage thread wakeups when we have too much to do */
155 boost::condition _full_condition;
156 /** maximum number of frames to hold in memory, for when we are managing
159 int _maximum_frames_in_memory;
160 unsigned int _maximum_queue_size;
170 /** @return true if qi is the next item after this one */
171 bool next (QueueItem qi) const;
172 void update (QueueItem qi);
183 /** The last frame written to each reel */
184 std::vector<LastWritten> _last_written;
186 /** number of FULL written frames */
187 int _full_written = 0;
188 /** number of FAKE written frames */
189 int _fake_written = 0;
190 int _repeat_written = 0;
191 /** number of frames pushed to disk and then recovered
192 due to the limit of frames to be held in memory.
194 int _pushed_to_disk = 0;
198 boost::mutex _digest_progresses_mutex;
199 std::map<boost::thread::id, float> _digest_progresses;
201 std::list<ReferencedReelAsset> _reel_assets;
203 std::vector<dcpomatic::FontData> _fonts;
205 /** true if any reel has any subtitles */
206 bool _have_subtitles = false;
207 /** all closed caption tracks that we have on any reel */
208 std::set<DCPTextTrack> _have_closed_captions;
213 boost::optional<DCPTextTrack> track;
214 dcpomatic::DCPTimePeriod period;
217 std::vector<HangingText> _hanging_texts;