Merge master.

[dcpomatic.git] / src / lib / writer.h

diff --git a/src/lib/writer.h b/src/lib/writer.h
index 1aaea4d9d0e26f31d07fea6acd6089b0c2cf979b..e817b1ca205beadc9d7ebbfe256ba2d04183a963 100644 (file)
--- a/src/lib/writer.h
+++ b/src/lib/writer.h
@@ -17,50 +17,132 @@
 
 */
 
+/** @file  src/lib/writer.h
+ *  @brief Writer class.
+ */
+
 #include <list>
 #include <boost/shared_ptr.hpp>
 #include <boost/thread.hpp>
 #include <boost/thread/condition.hpp>
+#include "exceptions.h"
+#include "types.h"
 
 class Film;
 class EncodedData;
 class AudioBuffers;
+class Job;
 
-namespace libdcp {
-       class MonoPictureAsset;
-       class MonoPictureAssetWriter;
-       class SoundAsset;
-       class SoundAssetWriter;
+namespace dcp {
+       class MonoPictureMXF;
+       class MonoPictureMXFWriter;
+       class StereoPictureMXF;
+       class StereoPictureMXFWriter;
+       class PictureMXF;
+       class PictureMXFWriter;
+       class SoundMXF;
+       class SoundMXFWriter;
 }
 
-class Writer
+struct QueueItem
+{
+public:
+       enum Type {
+               /** a normal frame with some JPEG200 data */
+               FULL,
+               /** a frame whose data already exists in the MXF,
+                   and we fake-write it; i.e. we update the writer's
+                   state but we use the data that is already on disk.
+               */
+               FAKE,
+       } type;
+
+       /** encoded data for FULL */
+       boost::shared_ptr<const EncodedData> encoded;
+       /** size of data for FAKE */
+       int size;
+       /** frame index */
+       int frame;
+       Eyes eyes;
+};
+
+bool operator< (QueueItem const & a, QueueItem const & b);
+bool operator== (QueueItem const & a, QueueItem const & b);
+
+/** @class Writer
+ *  @brief Class to manage writing JPEG2000 and audio data to MXFs on disk.
+ *
+ *  This class creates sound and picture MXFs, then takes EncodedData
+ *  or AudioBuffers objects (containing image or sound data respectively)
+ *  and writes them to the MXFs.
+ *
+ *  ::write() for EncodedData can be called out of order, and the Writer
+ *  will sort it out.  write() for AudioBuffers must be called in order.
+ */
+
+class Writer : public ExceptionStore, public boost::noncopyable
 {
 public:
-       Writer (boost::shared_ptr<Film>);
+       Writer (boost::shared_ptr<const Film>, boost::weak_ptr<Job>);
+       ~Writer ();
+
+       bool can_fake_write (int) const;
        
-       void write (boost::shared_ptr<const EncodedData>, int);
+       void write (boost::shared_ptr<const EncodedData>, int, Eyes);
+       void fake_write (int, Eyes);
        void write (boost::shared_ptr<const AudioBuffers>);
-       void repeat (int f);
+       void repeat (int f, Eyes);
        void finish ();
 
 private:
 
        void thread ();
+       void terminate_thread (bool);
+       void check_existing_picture_mxf ();
+       bool check_existing_picture_mxf_frame (FILE *, int, Eyes);
+       bool have_sequenced_image_at_queue_head ();
 
-       boost::shared_ptr<Film> _film;
+       /** our Film */
+       boost::shared_ptr<const Film> _film;
+       boost::weak_ptr<Job> _job;
+       /** the first frame index that does not already exist in our MXF */
+       int _first_nonexistant_frame;
 
+       /** our thread, or 0 */
        boost::thread* _thread;
+       /** true if our thread should finish */
        bool _finish;
-       std::list<std::pair<boost::shared_ptr<const EncodedData>, int> > _queue;
+       /** queue of things to write to disk */
+       std::list<QueueItem> _queue;
+       /** number of FULL frames whose JPEG200 data is currently held in RAM */
+       int _queued_full_in_memory;
+       /** mutex for thread state */
        mutable boost::mutex _mutex;
-       boost::condition _condition;
-       boost::shared_ptr<const EncodedData> _last_written;
-       std::list<int> _pending;
+       /** condition to manage thread wakeups when we have nothing to do  */
+       boost::condition _empty_condition;
+       /** condition to manage thread wakeups when we have too much to do */
+       boost::condition _full_condition;
+       /** the data of the last written frame, or 0 if there isn't one */
+       boost::shared_ptr<const EncodedData> _last_written[EYES_COUNT];
+       /** the index of the last written frame */
        int _last_written_frame;
-       static const unsigned int _maximum_frames_in_memory;
+       Eyes _last_written_eyes;
+       /** maximum number of frames to hold in memory, for when we are managing
+           ordering
+       */
+       static const int _maximum_frames_in_memory;
 
-       boost::shared_ptr<libdcp::MonoPictureAsset> _picture_asset;
-       boost::shared_ptr<libdcp::MonoPictureAssetWriter> _picture_asset_writer;
-       boost::shared_ptr<libdcp::SoundAsset> _sound_asset;
-       boost::shared_ptr<libdcp::SoundAssetWriter> _sound_asset_writer;
+       /** number of FULL written frames */
+       int _full_written;
+       /** number of FAKE written frames */
+       int _fake_written;
+       /** number of frames pushed to disk and then recovered
+           due to the limit of frames to be held in memory.
+       */
+       int _pushed_to_disk;
+       
+       boost::shared_ptr<dcp::PictureMXF> _picture_mxf;
+       boost::shared_ptr<dcp::PictureMXFWriter> _picture_mxf_writer;
+       boost::shared_ptr<dcp::SoundMXF> _sound_mxf;
+       boost::shared_ptr<dcp::SoundMXFWriter> _sound_mxf_writer;
 };