2 Copyright (C) 2012-2014 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"
27 #include <boost/shared_ptr.hpp>
28 #include <boost/weak_ptr.hpp>
29 #include <boost/thread.hpp>
30 #include <boost/thread/condition.hpp>
41 class MonoPictureMXFWriter;
42 class StereoPictureMXF;
43 class StereoPictureMXFWriter;
45 class PictureMXFWriter;
48 class InteropSubtitleContent;
55 /** a normal frame with some JPEG200 data */
57 /** a frame whose data already exists in the MXF,
58 and we fake-write it; i.e. we update the writer's
59 state but we use the data that is already on disk.
64 /** encoded data for FULL */
65 boost::shared_ptr<const EncodedData> encoded;
66 /** size of data for FAKE */
73 bool operator< (QueueItem const & a, QueueItem const & b);
74 bool operator== (QueueItem const & a, QueueItem const & b);
77 * @brief Class to manage writing JPEG2000 and audio data to MXFs on disk.
79 * This class creates sound and picture MXFs, then takes EncodedData
80 * or AudioBuffers objects (containing image or sound data respectively)
81 * and writes them to the MXFs.
83 * ::write() for EncodedData can be called out of order, and the Writer
84 * will sort it out. write() for AudioBuffers must be called in order.
87 class Writer : public ExceptionStore, public boost::noncopyable
90 Writer (boost::shared_ptr<const Film>, boost::weak_ptr<Job>);
93 bool can_fake_write (int) const;
95 void write (boost::shared_ptr<const EncodedData>, int, Eyes);
96 void fake_write (int, Eyes);
97 void write (boost::shared_ptr<const AudioBuffers>);
98 void write (PlayerSubtitles subs);
99 void write (std::list<boost::shared_ptr<Font> > fonts);
100 void repeat (int f, Eyes);
103 void set_encoder_threads (int threads);
108 void terminate_thread (bool);
109 void check_existing_picture_mxf ();
110 bool check_existing_picture_mxf_frame (FILE *, int, Eyes);
111 bool have_sequenced_image_at_queue_head ();
114 boost::shared_ptr<const Film> _film;
115 boost::weak_ptr<Job> _job;
116 /** the first frame index that does not already exist in our MXF */
117 int _first_nonexistant_frame;
119 /** our thread, or 0 */
120 boost::thread* _thread;
121 /** true if our thread should finish */
123 /** queue of things to write to disk */
124 std::list<QueueItem> _queue;
125 /** number of FULL frames whose JPEG200 data is currently held in RAM */
126 int _queued_full_in_memory;
127 /** mutex for thread state */
128 mutable boost::mutex _mutex;
129 /** condition to manage thread wakeups when we have nothing to do */
130 boost::condition _empty_condition;
131 /** condition to manage thread wakeups when we have too much to do */
132 boost::condition _full_condition;
133 /** the data of the last written frame, or 0 if there isn't one */
134 boost::shared_ptr<const EncodedData> _last_written[EYES_COUNT];
135 /** the index of the last written frame */
136 int _last_written_frame;
137 Eyes _last_written_eyes;
138 /** maximum number of frames to hold in memory, for when we are managing
141 int _maximum_frames_in_memory;
143 /** number of FULL written frames */
145 /** number of FAKE written frames */
147 /** number of frames pushed to disk and then recovered
148 due to the limit of frames to be held in memory.
152 boost::shared_ptr<dcp::PictureMXF> _picture_mxf;
153 boost::shared_ptr<dcp::PictureMXFWriter> _picture_mxf_writer;
154 boost::shared_ptr<dcp::SoundMXF> _sound_mxf;
155 boost::shared_ptr<dcp::SoundMXFWriter> _sound_mxf_writer;
156 boost::shared_ptr<dcp::InteropSubtitleContent> _subtitle_content;
158 std::list<boost::shared_ptr<Font> > _fonts;