2 Copyright (C) 2012 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 <boost/shared_ptr.hpp>
26 #include <boost/thread.hpp>
27 #include <boost/thread/condition.hpp>
28 #include "exceptions.h"
38 class MonoPictureMXFWriter;
39 class StereoPictureMXF;
40 class StereoPictureMXFWriter;
42 class PictureMXFWriter;
51 /** a normal frame with some JPEG200 data */
53 /** a frame whose data already exists in the MXF,
54 and we fake-write it; i.e. we update the writer's
55 state but we use the data that is already on disk.
58 /** this is a repeat of the last frame to be written */
62 /** encoded data for FULL */
63 boost::shared_ptr<const EncodedData> encoded;
64 /** size of data for FAKE */
71 bool operator< (QueueItem const & a, QueueItem const & b);
72 bool operator== (QueueItem const & a, QueueItem const & b);
75 * @brief Class to manage writing JPEG2000 and audio data to MXFs on disk.
77 * This class creates sound and picture MXFs, then takes EncodedData
78 * or AudioBuffers objects (containing image or sound data respectively)
79 * and writes them to the MXFs.
81 * ::write() for EncodedData can be called out of order, and the Writer
82 * will sort it out. write() for AudioBuffers must be called in order.
85 class Writer : public ExceptionStore, public boost::noncopyable
88 Writer (boost::shared_ptr<const Film>, boost::weak_ptr<Job>);
91 bool can_fake_write (int) const;
93 void write (boost::shared_ptr<const EncodedData>, int, Eyes);
94 void fake_write (int, Eyes);
95 void write (boost::shared_ptr<const AudioBuffers>);
96 void repeat (int f, Eyes);
102 void terminate_thread (bool);
103 void check_existing_picture_mxf ();
104 bool check_existing_picture_mxf_frame (FILE *, int, Eyes);
105 bool have_sequenced_image_at_queue_head ();
108 boost::shared_ptr<const Film> _film;
109 boost::weak_ptr<Job> _job;
110 /** the first frame index that does not already exist in our MXF */
111 int _first_nonexistant_frame;
113 /** our thread, or 0 */
114 boost::thread* _thread;
115 /** true if our thread should finish */
117 /** queue of things to write to disk */
118 std::list<QueueItem> _queue;
119 /** number of FULL frames whose JPEG200 data is currently held in RAM */
120 int _queued_full_in_memory;
121 /** mutex for thread state */
122 mutable boost::mutex _mutex;
123 /** condition to manage thread wakeups when we have nothing to do */
124 boost::condition _empty_condition;
125 /** condition to manage thread wakeups when we have too much to do */
126 boost::condition _full_condition;
127 /** the data of the last written frame, or 0 if there isn't one */
128 boost::shared_ptr<const EncodedData> _last_written[EYES_COUNT];
129 /** the index of the last written frame */
130 int _last_written_frame;
131 Eyes _last_written_eyes;
132 /** maximum number of frames to hold in memory, for when we are managing
135 static const int _maximum_frames_in_memory;
137 /** number of FULL written frames */
139 /** number of FAKE written frames */
141 /** number of REPEAT written frames */
143 /** number of frames pushed to disk and then recovered
144 due to the limit of frames to be held in memory.
148 boost::shared_ptr<dcp::PictureMXF> _picture_mxf;
149 boost::shared_ptr<dcp::PictureMXFWriter> _picture_mxf_writer;
150 boost::shared_ptr<dcp::SoundMXF> _sound_mxf;
151 boost::shared_ptr<dcp::SoundMXFWriter> _sound_mxf_writer;