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.
24 #include "exceptions.h"
26 #include "player_subtitles.h"
28 #include <boost/shared_ptr.hpp>
29 #include <boost/weak_ptr.hpp>
30 #include <boost/thread.hpp>
31 #include <boost/thread/condition.hpp>
41 class MonoPictureAsset;
42 class MonoPictureAssetWriter;
43 class StereoPictureAsset;
44 class StereoPictureAssetWriter;
46 class PictureAssetWriter;
48 class SoundAssetWriter;
56 /** a normal frame with some JPEG200 data */
58 /** a frame whose data already exists in the MXF,
59 and we fake-write it; i.e. we update the writer's
60 state but we use the data that is already on disk.
65 /** encoded data for FULL */
66 boost::optional<Data> encoded;
67 /** size of data for FAKE */
74 bool operator< (QueueItem const & a, QueueItem const & b);
75 bool operator== (QueueItem const & a, QueueItem const & b);
78 * @brief Class to manage writing JPEG2000 and audio data to assets on disk.
80 * This class creates sound and picture assets, then takes Data
81 * or AudioBuffers objects (containing image or sound data respectively)
82 * and writes them to the assets.
84 * ::write() for Data can be called out of order, and the Writer
85 * will sort it out. write() for AudioBuffers must be called in order.
88 class Writer : public ExceptionStore, public boost::noncopyable
91 Writer (boost::shared_ptr<const Film>, boost::weak_ptr<Job>);
94 bool can_fake_write (int) const;
96 void write (Data, int, Eyes);
97 void fake_write (int, Eyes);
98 void write (boost::shared_ptr<const AudioBuffers>);
99 void write (PlayerSubtitles subs);
100 void write (std::list<boost::shared_ptr<Font> > fonts);
101 void repeat (int f, Eyes);
104 void set_encoder_threads (int threads);
109 void terminate_thread (bool);
110 void check_existing_picture_asset ();
111 bool check_existing_picture_asset_frame (FILE *, int, Eyes);
112 bool have_sequenced_image_at_queue_head ();
115 boost::shared_ptr<const Film> _film;
116 boost::weak_ptr<Job> _job;
117 /** the first frame index that does not already exist in our MXF */
118 int _first_nonexistant_frame;
120 /** our thread, or 0 */
121 boost::thread* _thread;
122 /** true if our thread should finish */
124 /** queue of things to write to disk */
125 std::list<QueueItem> _queue;
126 /** number of FULL frames whose JPEG200 data is currently held in RAM */
127 int _queued_full_in_memory;
128 /** mutex for thread state */
129 mutable boost::mutex _mutex;
130 /** condition to manage thread wakeups when we have nothing to do */
131 boost::condition _empty_condition;
132 /** condition to manage thread wakeups when we have too much to do */
133 boost::condition _full_condition;
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 frame */
137 int _last_written_frame;
138 Eyes _last_written_eyes;
139 /** maximum number of frames to hold in memory, for when we are managing
142 int _maximum_frames_in_memory;
144 /** number of FULL written frames */
146 /** number of FAKE written frames */
148 /** number of frames pushed to disk and then recovered
149 due to the limit of frames to be held in memory.
153 boost::shared_ptr<dcp::PictureAsset> _picture_asset;
154 boost::shared_ptr<dcp::PictureAssetWriter> _picture_asset_writer;
155 boost::shared_ptr<dcp::SoundAsset> _sound_asset;
156 boost::shared_ptr<dcp::SoundAssetWriter> _sound_asset_writer;
157 boost::shared_ptr<dcp::SubtitleAsset> _subtitle_asset;
159 std::list<boost::shared_ptr<Font> > _fonts;