2 Copyright (C) 2012-2020 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/>.
21 /** @file src/lib/writer.h
22 * @brief Writer class.
25 #include "atmos_metadata.h"
27 #include "player_text.h"
28 #include "exception_store.h"
29 #include "dcp_text_track.h"
30 #include "weak_film.h"
31 #include <dcp/atmos_frame.h>
32 #include <boost/shared_ptr.hpp>
33 #include <boost/weak_ptr.hpp>
34 #include <boost/thread.hpp>
35 #include <boost/thread/condition.hpp>
49 class ReferencedReelAsset;
63 /** a normal frame with some JPEG200 data */
65 /** a frame whose data already exists in the MXF,
66 and we fake-write it; i.e. we update the writer's
67 state but we use the data that is already on disk.
73 /** encoded data for FULL */
74 boost::shared_ptr<const dcp::Data> encoded;
75 /** size of data for FAKE */
79 /** frame index within the reel */
81 /** eyes for FULL, FAKE and REPEAT */
85 bool operator< (QueueItem const & a, QueueItem const & b);
86 bool operator== (QueueItem const & a, QueueItem const & b);
89 * @brief Class to manage writing JPEG2000 and audio data to assets on disk.
91 * This class creates sound and picture assets, then takes Data
92 * or AudioBuffers objects (containing image or sound data respectively)
93 * and writes them to the assets.
95 * write() for Data (picture) can be called out of order, and the Writer
96 * will sort it out. write() for AudioBuffers must be called in order.
99 class Writer : public ExceptionStore, public boost::noncopyable, public WeakConstFilm
102 Writer (boost::weak_ptr<const Film>, boost::weak_ptr<Job>, bool text_only = false);
107 bool can_fake_write (Frame) const;
109 void write (boost::shared_ptr<const dcp::Data>, Frame, Eyes);
110 void fake_write (Frame, Eyes);
111 bool can_repeat (Frame) const;
112 void repeat (Frame, Eyes);
113 void write (boost::shared_ptr<const AudioBuffers>, dcpomatic::DCPTime time);
114 void write (PlayerText text, TextType type, boost::optional<DCPTextTrack>, dcpomatic::DCPTimePeriod period);
115 void write (std::vector<dcpomatic::FontData> fonts);
116 void write (ReferencedReelAsset asset);
117 void write (boost::shared_ptr<const dcp::AtmosFrame> atmos, dcpomatic::DCPTime time, AtmosMetadata metadata);
118 void finish (boost::filesystem::path output_dcp);
120 void set_encoder_threads (int threads);
124 void terminate_thread (bool);
125 bool have_sequenced_image_at_queue_head ();
126 size_t video_reel (int frame) const;
127 void set_digest_progress (Job* job, float progress);
128 void write_cover_sheet (boost::filesystem::path output_dcp);
129 void calculate_referenced_digests (boost::function<void (float)> set_progress);
131 boost::weak_ptr<Job> _job;
132 std::vector<ReelWriter> _reels;
133 std::vector<ReelWriter>::iterator _audio_reel;
134 std::vector<ReelWriter>::iterator _subtitle_reel;
135 std::map<DCPTextTrack, std::vector<ReelWriter>::iterator> _caption_reels;
136 std::vector<ReelWriter>::iterator _atmos_reel;
139 boost::thread _thread;
140 /** true if our thread should finish */
142 /** queue of things to write to disk */
143 std::list<QueueItem> _queue;
144 /** number of FULL frames whose JPEG200 data is currently held in RAM */
145 int _queued_full_in_memory;
146 /** mutex for thread state */
147 mutable boost::mutex _state_mutex;
148 /** condition to manage thread wakeups when we have nothing to do */
149 boost::condition _empty_condition;
150 /** condition to manage thread wakeups when we have too much to do */
151 boost::condition _full_condition;
152 /** maximum number of frames to hold in memory, for when we are managing
155 int _maximum_frames_in_memory;
156 unsigned int _maximum_queue_size;
166 /** @return true if qi is the next item after this one */
167 bool next (QueueItem qi) const;
168 void update (QueueItem qi);
179 /** The last frame written to each reel */
180 std::vector<LastWritten> _last_written;
182 /** number of FULL written frames */
184 /** number of FAKE written frames */
187 /** number of frames pushed to disk and then recovered
188 due to the limit of frames to be held in memory.
194 boost::mutex _digest_progresses_mutex;
195 std::map<boost::thread::id, float> _digest_progresses;
197 std::list<ReferencedReelAsset> _reel_assets;
199 std::vector<dcpomatic::FontData> _fonts;
201 /** true if any reel has any subtitles */
202 bool _have_subtitles;
203 /** all closed caption tracks that we have on any reel */
204 std::set<DCPTextTrack> _have_closed_captions;