2 Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 /** @file src/lib/writer.h
21 * @brief Writer class.
25 #include "player_subtitles.h"
27 #include "exception_store.h"
28 #include <dcp/picture_asset_writer.h>
29 #include <boost/shared_ptr.hpp>
30 #include <boost/weak_ptr.hpp>
31 #include <boost/thread.hpp>
32 #include <boost/thread/condition.hpp>
40 class ReferencedReelAsset;
43 class MonoPictureAsset;
44 class MonoPictureAssetWriter;
45 class StereoPictureAsset;
46 class StereoPictureAssetWriter;
48 class PictureAssetWriter;
50 class SoundAssetWriter;
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::optional<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
102 Writer (boost::shared_ptr<const Film>, boost::weak_ptr<Job>);
107 bool can_fake_write (Frame) const;
109 void write (Data, Frame, Eyes);
110 void fake_write (Frame, Eyes);
111 void repeat (Frame, Eyes);
112 void write (boost::shared_ptr<const AudioBuffers>);
113 void write (PlayerSubtitles subs);
114 void write (std::list<boost::shared_ptr<Font> > fonts);
115 void write (ReferencedReelAsset asset);
118 void set_encoder_threads (int threads);
125 : first_nonexistant_frame (0)
126 , last_written_video_frame (-1)
127 , last_written_eyes (EYES_RIGHT)
128 , total_written_audio_frames (0)
131 DCPTimePeriod period;
132 /** the first frame index that does not already exist in our MXF */
133 int first_nonexistant_frame;
134 /** the data of the last written frame, if there is one */
135 boost::optional<Data> last_written[EYES_COUNT];
136 /** the index of the last written video frame within the reel */
137 int last_written_video_frame;
138 Eyes last_written_eyes;
139 /** the number of audio frames that have been written to the reel */
140 int total_written_audio_frames;
142 boost::shared_ptr<dcp::PictureAsset> picture_asset;
143 boost::shared_ptr<dcp::PictureAssetWriter> picture_asset_writer;
144 boost::shared_ptr<dcp::SoundAsset> sound_asset;
145 boost::shared_ptr<dcp::SoundAssetWriter> sound_asset_writer;
146 boost::shared_ptr<dcp::SubtitleAsset> subtitle_asset;
150 void terminate_thread (bool);
151 void check_existing_picture_asset (Reel& reel);
152 bool have_sequenced_image_at_queue_head ();
153 void write_frame_info (Reel const & reel, int frame, Eyes eyes, dcp::FrameInfo info) const;
154 long frame_info_position (int frame, Eyes eyes) const;
155 dcp::FrameInfo read_frame_info (FILE* file, int frame, Eyes eyes) const;
156 size_t video_reel (int frame) const;
159 boost::shared_ptr<const Film> _film;
160 boost::weak_ptr<Job> _job;
161 std::vector<Reel> _reels;
162 std::vector<Reel>::iterator _audio_reel;
163 std::vector<Reel>::iterator _subtitle_reel;
165 /** our thread, or 0 */
166 boost::thread* _thread;
167 /** true if our thread should finish */
169 /** queue of things to write to disk */
170 std::list<QueueItem> _queue;
171 /** number of FULL frames whose JPEG200 data is currently held in RAM */
172 int _queued_full_in_memory;
173 /** mutex for thread state */
174 mutable boost::mutex _state_mutex;
175 /** condition to manage thread wakeups when we have nothing to do */
176 boost::condition _empty_condition;
177 /** condition to manage thread wakeups when we have too much to do */
178 boost::condition _full_condition;
179 /** maximum number of frames to hold in memory, for when we are managing
182 int _maximum_frames_in_memory;
184 /** number of FULL written frames */
186 /** number of FAKE written frames */
189 /** number of frames pushed to disk and then recovered
190 due to the limit of frames to be held in memory.
194 std::list<ReferencedReelAsset> _reel_assets;
196 std::list<boost::shared_ptr<Font> > _fonts;
198 static int const _info_size;