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_WRITER_H
23 #define DCPOMATIC_WRITER_H
26 /** @file src/lib/writer.h
27 * @brief Writer class.
31 #include "atmos_metadata.h"
32 #include "dcp_text_track.h"
33 #include "dcpomatic_time.h"
34 #include "exception_store.h"
35 #include "font_id_map.h"
36 #include "player_text.h"
37 #include "text_type.h"
38 #include "weak_film.h"
39 #include <dcp/atmos_frame.h>
40 #include <dcp/frame_info.h>
41 #include <dcp/mono_mpeg2_picture_frame.h>
42 #include <boost/thread.hpp>
43 #include <boost/thread/condition.hpp>
55 class ReferencedReelAsset;
56 struct writer_disambiguate_font_ids1;
57 struct writer_disambiguate_font_ids2;
58 struct writer_disambiguate_font_ids3;
67 /** a normal frame with some JPEG200 data */
69 /** a frame whose data already exists in the MXF,
70 and we fake-write it; i.e. we update the writer's
71 state but we use the data that is already on disk.
77 /** encoded data for FULL */
78 std::shared_ptr<const dcp::Data> encoded;
80 dcp::J2KFrameInfo info;
83 /** frame index within the reel */
85 /** eyes for FULL, FAKE and REPEAT */
86 Eyes eyes = Eyes::BOTH;
90 bool operator< (QueueItem const & a, QueueItem const & b);
91 bool operator== (QueueItem const & a, QueueItem const & b);
95 * @brief Class to manage writing JPEG2000 and audio data to assets on disk.
97 * This class creates sound and picture assets, then takes Data
98 * or AudioBuffers objects (containing image or sound data respectively)
99 * and writes them to the assets.
101 * write() for Data (picture) can be called out of order, and the Writer
102 * will sort it out. write() for AudioBuffers must be called in order.
105 class Writer : public ExceptionStore, public WeakConstFilm
108 Writer (std::weak_ptr<const Film>, std::weak_ptr<Job>, bool text_only = false);
111 Writer (Writer const &) = delete;
112 Writer& operator= (Writer const &) = delete;
116 bool can_fake_write (Frame) const;
118 void write (std::shared_ptr<const dcp::Data>, Frame, Eyes);
119 void fake_write (Frame, Eyes);
120 bool can_repeat (Frame) const;
121 void repeat (Frame, Eyes);
122 void write (std::shared_ptr<const AudioBuffers>, dcpomatic::DCPTime time);
123 void write (PlayerText text, TextType type, boost::optional<DCPTextTrack>, dcpomatic::DCPTimePeriod period);
124 void write (std::vector<std::shared_ptr<dcpomatic::Font>> fonts);
125 void write (ReferencedReelAsset asset);
126 void write (std::shared_ptr<const dcp::AtmosFrame> atmos, dcpomatic::DCPTime time, AtmosMetadata metadata);
127 void write (std::shared_ptr<dcp::MonoMPEG2PictureFrame> image, Frame frame);
128 void finish (boost::filesystem::path output_dcp);
130 void set_encoder_threads (int threads);
133 friend struct ::writer_disambiguate_font_ids1;
134 friend struct ::writer_disambiguate_font_ids2;
135 friend struct ::writer_disambiguate_font_ids3;
138 void terminate_thread (bool);
139 bool have_sequenced_image_at_queue_head ();
140 size_t video_reel (int frame) const;
141 void set_digest_progress(Job* job, int id, int64_t done, int64_t size);
142 void write_cover_sheet (boost::filesystem::path output_dcp);
143 void calculate_referenced_digests(std::function<void (int64_t, int64_t)> set_progress);
144 void write_hanging_text (ReelWriter& reel);
145 void calculate_digests ();
147 std::weak_ptr<Job> _job;
148 std::vector<ReelWriter> _reels;
149 std::vector<ReelWriter>::iterator _audio_reel;
150 std::vector<ReelWriter>::iterator _subtitle_reel;
151 std::map<DCPTextTrack, std::vector<ReelWriter>::iterator> _caption_reels;
152 std::vector<ReelWriter>::iterator _atmos_reel;
155 boost::thread _thread;
156 /** true if our thread should finish */
157 bool _finish = false;
158 /** queue of things to write to disk */
159 std::list<QueueItem> _queue;
160 /** number of FULL frames whose JPEG200 data is currently held in RAM */
161 int _queued_full_in_memory = 0;
162 /** mutex for thread state */
163 mutable boost::mutex _state_mutex;
164 /** condition to manage thread wakeups when we have nothing to do */
165 boost::condition _empty_condition;
166 /** condition to manage thread wakeups when we have too much to do */
167 boost::condition _full_condition;
168 /** maximum number of frames to hold in memory, for when we are managing
171 int _maximum_frames_in_memory;
172 unsigned int _maximum_queue_size;
182 /** @return true if qi is the next item after this one */
183 bool next (QueueItem qi) const;
184 void update (QueueItem qi);
195 /** The last frame written to each reel */
196 std::vector<LastWritten> _last_written;
198 /** number of FULL written frames */
199 int _full_written = 0;
200 /** number of FAKE written frames */
201 int _fake_written = 0;
202 int _repeat_written = 0;
203 /** number of frames pushed to disk and then recovered
204 due to the limit of frames to be held in memory.
206 int _pushed_to_disk = 0;
210 boost::mutex _digest_progresses_mutex;
211 std::map<int, std::pair<int64_t, int64_t>> _digest_progresses;
213 std::list<ReferencedReelAsset> _reel_assets;
216 /** If we are given many fonts, but we're making an Interop DCP, we'll choose a single
217 * one that we'll use everywher. This is that chosen font.
219 std::shared_ptr<dcpomatic::Font> _chosen_interop_font;
221 /** true if any reel has any subtitles */
222 bool _have_subtitles = false;
223 /** all closed caption tracks that we have on any reel */
224 std::set<DCPTextTrack> _have_closed_captions;
229 boost::optional<DCPTextTrack> track;
230 dcpomatic::DCPTimePeriod period;
233 std::vector<HangingText> _hanging_texts;