Fix crashes on x-thread signal emission.
[dcpomatic.git] / src / lib / writer.h
index c0699ad4407158294a3c6d48eccdc8739efdca36..41d4d4474bae3dde1e97e35f9d6392aeb165315b 100644 (file)
 
 */
 
-#include <list>
+/** @file  src/lib/writer.h
+ *  @brief Writer class.
+ */
+
+#include "exceptions.h"
+#include "types.h"
+#include "player_subtitles.h"
 #include <boost/shared_ptr.hpp>
+#include <boost/weak_ptr.hpp>
 #include <boost/thread.hpp>
 #include <boost/thread/condition.hpp>
-#include "exceptions.h"
-#include "types.h"
+#include <list>
 
 class Film;
 class EncodedData;
 class AudioBuffers;
 class Job;
-
-namespace libdcp {
-       class MonoPictureAsset;
-       class MonoPictureAssetWriter;
-       class StereoPictureAsset;
-       class StereoPictureAssetWriter;
-       class PictureAsset;
-       class PictureAssetWriter;
-       class SoundAsset;
-       class SoundAssetWriter;
+class Font;
+
+namespace dcp {
+       class MonoPictureMXF;
+       class MonoPictureMXFWriter;
+       class StereoPictureMXF;
+       class StereoPictureMXFWriter;
+       class PictureMXF;
+       class PictureMXFWriter;
+       class SoundMXF;
+       class SoundMXFWriter;
+       class InteropSubtitleContent;
 }
 
 struct QueueItem
@@ -51,8 +59,6 @@ public:
                    state but we use the data that is already on disk.
                */
                FAKE,
-               /** this is a repeat of the last frame to be written */
-               REPEAT
        } type;
 
        /** encoded data for FULL */
@@ -67,6 +73,17 @@ public:
 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:
@@ -78,6 +95,8 @@ public:
        void write (boost::shared_ptr<const EncodedData>, int, Eyes);
        void fake_write (int, Eyes);
        void write (boost::shared_ptr<const AudioBuffers>);
+       void write (PlayerSubtitles subs);
+       void write (std::list<boost::shared_ptr<Font> > fonts);
        void repeat (int f, Eyes);
        void finish ();
 
@@ -88,6 +107,10 @@ private:
        void check_existing_picture_mxf ();
        bool check_existing_picture_mxf_frame (FILE *, int, Eyes);
        bool have_sequenced_image_at_queue_head ();
+       /** maximum number of frames to hold in memory, for when we are managing
+        *  ordering
+        */
+       int maximum_frames_in_memory () const;
 
        /** our Film */
        boost::shared_ptr<const Film> _film;
@@ -114,24 +137,21 @@ private:
        /** the index of the last written frame */
        int _last_written_frame;
        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;
 
        /** number of FULL written frames */
        int _full_written;
        /** number of FAKE written frames */
        int _fake_written;
-       /** number of REPEAT written frames */
-       int _repeat_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<libdcp::PictureAsset> _picture_asset;
-       boost::shared_ptr<libdcp::PictureAssetWriter> _picture_asset_writer;
-       boost::shared_ptr<libdcp::SoundAsset> _sound_asset;
-       boost::shared_ptr<libdcp::SoundAssetWriter> _sound_asset_writer;
+       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;
+       boost::shared_ptr<dcp::InteropSubtitleContent> _subtitle_content;
+
+       std::list<boost::shared_ptr<Font> > _fonts;
 };