X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Fwriter.h;h=beb16c7b9107da1972bcbd5f92a2dc07d3b1b701;hb=a991c734ebfedb5456cec827d5eaf2583fdbb9a1;hp=57609825d06bde2d1b8f85ea23d0a416ca1a3415;hpb=32fc1ddb0ee004d18c36155ddcf4d9b3998a7061;p=dcpomatic.git

diff --git a/src/lib/writer.h b/src/lib/writer.h
index 57609825d..beb16c7b9 100644
--- a/src/lib/writer.h
+++ b/src/lib/writer.h
@@ -21,6 +21,7 @@
 #include <boost/shared_ptr.hpp>
 #include <boost/thread.hpp>
 #include <boost/thread/condition.hpp>
+#include "exceptions.h"
 
 class Film;
 class EncodedData;
@@ -37,8 +38,14 @@ 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,
+		/** this is a repeat of the last frame to be written */
 		REPEAT
 	} type;
 
@@ -53,7 +60,7 @@ public:
 bool operator< (QueueItem const & a, QueueItem const & b);
 bool operator== (QueueItem const & a, QueueItem const & b);
 
-class Writer
+class Writer : public ExceptionStore
 {
 public:
 	Writer (boost::shared_ptr<Film>);
@@ -71,19 +78,43 @@ private:
 	void thread ();
 	void check_existing_picture_mxf ();
 
+	/** our Film */
 	boost::shared_ptr<Film> _film;
+	/** 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;
+	/** 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<QueueItem> _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;