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"
39 #include "weak_film.h"
40 #include <dcp/atmos_frame.h>
41 #include <boost/thread.hpp>
42 #include <boost/thread/condition.hpp>
54 class ReferencedReelAsset;
55 struct writer_disambiguate_font_ids1;
56 struct writer_disambiguate_font_ids2;
57 struct writer_disambiguate_font_ids3;
66 /** a normal frame with some JPEG200 data */
68 /** a frame whose data already exists in the MXF,
69 and we fake-write it; i.e. we update the writer's
70 state but we use the data that is already on disk.
76 /** encoded data for FULL */
77 std::shared_ptr<const dcp::Data> encoded;
78 /** size of data for FAKE */
82 /** frame index within the reel */
84 /** eyes for FULL, FAKE and REPEAT */
85 Eyes eyes = Eyes::BOTH;
89 bool operator< (QueueItem const & a, QueueItem const & b);
90 bool operator== (QueueItem const & a, QueueItem const & b);
94 * @brief Class to manage writing JPEG2000 and audio data to assets on disk.
96 * This class creates sound and picture assets, then takes Data
97 * or AudioBuffers objects (containing image or sound data respectively)
98 * and writes them to the assets.
100 * write() for Data (picture) can be called out of order, and the Writer
101 * will sort it out. write() for AudioBuffers must be called in order.
104 class Writer : public ExceptionStore, public WeakConstFilm
107 Writer (std::weak_ptr<const Film>, std::weak_ptr<Job>, bool text_only = false);
110 Writer (Writer const &) = delete;
111 Writer& operator= (Writer const &) = delete;
115 bool can_fake_write (Frame) const;
117 void write (std::shared_ptr<const dcp::Data>, Frame, Eyes);
118 void fake_write (Frame, Eyes);
119 bool can_repeat (Frame) const;
120 void repeat (Frame, Eyes);
121 void write (std::shared_ptr<const AudioBuffers>, dcpomatic::DCPTime time);
122 void write (PlayerText text, TextType type, boost::optional<DCPTextTrack>, dcpomatic::DCPTimePeriod period);
123 void write (std::vector<std::shared_ptr<dcpomatic::Font>> fonts);
124 void write (ReferencedReelAsset asset);
125 void write (std::shared_ptr<const dcp::AtmosFrame> atmos, dcpomatic::DCPTime time, AtmosMetadata metadata);
126 void finish (boost::filesystem::path output_dcp);
128 void set_encoder_threads (int threads);
131 friend struct ::writer_disambiguate_font_ids1;
132 friend struct ::writer_disambiguate_font_ids2;
133 friend struct ::writer_disambiguate_font_ids3;
136 void terminate_thread (bool);
137 bool have_sequenced_image_at_queue_head ();
138 size_t video_reel (int frame) const;
139 void set_digest_progress(Job* job, int id, int64_t done, int64_t size);
140 void write_cover_sheet (boost::filesystem::path output_dcp);
141 void calculate_referenced_digests(std::function<void (int64_t, int64_t)> set_progress);
142 void write_hanging_text (ReelWriter& reel);
143 void calculate_digests ();
145 std::weak_ptr<Job> _job;
146 std::vector<ReelWriter> _reels;
147 std::vector<ReelWriter>::iterator _audio_reel;
148 std::vector<ReelWriter>::iterator _subtitle_reel;
149 std::map<DCPTextTrack, std::vector<ReelWriter>::iterator> _caption_reels;
150 std::vector<ReelWriter>::iterator _atmos_reel;
153 boost::thread _thread;
154 /** true if our thread should finish */
155 bool _finish = false;
156 /** queue of things to write to disk */
157 std::list<QueueItem> _queue;
158 /** number of FULL frames whose JPEG200 data is currently held in RAM */
159 int _queued_full_in_memory = 0;
160 /** mutex for thread state */
161 mutable boost::mutex _state_mutex;
162 /** condition to manage thread wakeups when we have nothing to do */
163 boost::condition _empty_condition;
164 /** condition to manage thread wakeups when we have too much to do */
165 boost::condition _full_condition;
166 /** maximum number of frames to hold in memory, for when we are managing
169 int _maximum_frames_in_memory;
170 unsigned int _maximum_queue_size;
180 /** @return true if qi is the next item after this one */
181 bool next (QueueItem qi) const;
182 void update (QueueItem qi);
193 /** The last frame written to each reel */
194 std::vector<LastWritten> _last_written;
196 /** number of FULL written frames */
197 int _full_written = 0;
198 /** number of FAKE written frames */
199 int _fake_written = 0;
200 int _repeat_written = 0;
201 /** number of frames pushed to disk and then recovered
202 due to the limit of frames to be held in memory.
204 int _pushed_to_disk = 0;
208 boost::mutex _digest_progresses_mutex;
209 std::map<int, std::pair<int64_t, int64_t>> _digest_progresses;
211 std::list<ReferencedReelAsset> _reel_assets;
214 /** If we are given many fonts, but we're making an Interop DCP, we'll choose a single
215 * one that we'll use everywher. This is that chosen font.
217 std::shared_ptr<dcpomatic::Font> _chosen_interop_font;
219 /** true if any reel has any subtitles */
220 bool _have_subtitles = false;
221 /** all closed caption tracks that we have on any reel */
222 std::set<DCPTextTrack> _have_closed_captions;
227 boost::optional<DCPTextTrack> track;
228 dcpomatic::DCPTimePeriod period;
231 std::vector<HangingText> _hanging_texts;