X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Fwriter.h;h=2ddf70380181534d8f49b1326479dc5270b61f7a;hb=e6c67f4aac2ca9afc275b6f13058e1e46f2cecc3;hp=ca0bdeb92a2189983cd3b6ff3758c9387eb887ed;hpb=85c65bd422742813992686c17a5e1b718cc3c449;p=dcpomatic.git

diff --git a/src/lib/writer.h b/src/lib/writer.h
index ca0bdeb92..2ddf70380 100644
--- 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,6 +17,10 @@
 
 */
 
+/** @file  src/lib/writer.h
+ *  @brief Writer class.
+ */
+
 #include <list>
 #include <boost/shared_ptr.hpp>
 #include <boost/thread.hpp>
@@ -51,8 +55,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 +69,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:
@@ -123,8 +136,6 @@ private:
 	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.
 	*/