Various fixes to make audio analysis sort-of work.
[dcpomatic.git] / src / lib / writer.h
index 1aaea4d9d0e26f31d07fea6acd6089b0c2cf979b..e56e12e75a2255ac95bab0b1563733f3a5521e94 100644 (file)
 #include <boost/shared_ptr.hpp>
 #include <boost/thread.hpp>
 #include <boost/thread/condition.hpp>
+#include "exceptions.h"
 
 class Film;
 class EncodedData;
 class AudioBuffers;
+class Job;
 
 namespace libdcp {
        class MonoPictureAsset;
@@ -33,12 +35,41 @@ namespace libdcp {
        class SoundAssetWriter;
 }
 
-class Writer
+struct QueueItem
 {
 public:
-       Writer (boost::shared_ptr<Film>);
+       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,
+               /** this is a repeat of the last frame to be written */
+               REPEAT
+       } type;
+
+       /** encoded data for FULL */
+       boost::shared_ptr<const EncodedData> encoded;
+       /** size of data for FAKE */
+       int size;
+       /** frame index */
+       int frame;
+};
+
+bool operator< (QueueItem const & a, QueueItem const & b);
+bool operator== (QueueItem const & a, QueueItem const & b);
+
+class Writer : public ExceptionStore
+{
+public:
+       Writer (boost::shared_ptr<const Film>, boost::shared_ptr<Job>);
+
+       bool can_fake_write (int) const;
        
        void write (boost::shared_ptr<const EncodedData>, int);
+       void fake_write (int);
        void write (boost::shared_ptr<const AudioBuffers>);
        void repeat (int f);
        void finish ();
@@ -46,19 +77,46 @@ public:
 private:
 
        void thread ();
+       void check_existing_picture_mxf ();
 
-       boost::shared_ptr<Film> _film;
+       /** our Film */
+       boost::shared_ptr<const Film> _film;
+       boost::shared_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;
+       /** condition to manage thread wakeups */
        boost::condition _condition;
+       /** the data of the last written frame, or 0 if there isn't one */
        boost::shared_ptr<const EncodedData> _last_written;
-       std::list<int> _pending;
+       /** the index of the last written frame */
        int _last_written_frame;
-       static const unsigned int _maximum_frames_in_memory;
+       /** 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::MonoPictureAsset> _picture_asset;
        boost::shared_ptr<libdcp::MonoPictureAssetWriter> _picture_asset_writer;
        boost::shared_ptr<libdcp::SoundAsset> _sound_asset;