d588620e70bf15da29cc242e4ae8d86977e8f36a from master; fix hang if you cancel a paused...

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

diff --git a/src/lib/writer.h b/src/lib/writer.h
index ca0bdeb92a2189983cd3b6ff3758c9387eb887ed..e63591a8a338d50351b8ed4f0f45ad48e794c148 100644 (file)
--- a/src/lib/writer.h
+++ b/src/lib/writer.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -17,17 +17,24 @@
 
 */
 
-#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;
+class Font;
 
 namespace dcp {
        class MonoPictureMXF;
@@ -38,6 +45,7 @@ namespace dcp {
        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,9 +95,13 @@ 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 ();
 
+       void set_encoder_threads (int threads);
+
 private:
 
        void thread ();
@@ -115,16 +136,14 @@ private:
        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;
-
+        *  ordering
+        */
+       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.
        */
@@ -134,4 +153,7 @@ private:
        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;
 };