Tidying up; comments; fps in assets -> edit rate.

1 files changed, 49 insertions, 5 deletions

diff --git a/src/picture_asset.h b/src/picture_asset.h
index dd69e352..ea558e7d 100644
--- a/src/picture_asset.h
+++ b/src/picture_asset.h
@@ -36,7 +36,24 @@ class StereoPictureFrame;
 class PictureAsset : public MXFAsset
 {
 public:
+	/** Construct a PictureAsset.
+	 *  This class will not write anything to disk in this constructor, but subclasses may.
+	 *  
+	 *  @param directory Directory where MXF file is.
+	 *  @param mxf_name Name of MXF file.
+	 */
 	PictureAsset (std::string directory, std::string mxf_name);
+
+	/** Construct a PictureAsset.
+	 *  This class will not write anything to disk in this constructor, but subclasses may.
+	 *
+	 *  @param directory Directory where MXF file is.
+	 *  @param mxf_name Name of MXF file.
+	 *  @param progress Signal to use to inform of progres, or 0.
+	 *  @param fps Video Frames per second.
+	 *  @param intrinsic_duration Duration of all the frames in the asset.
+	 *  @param size Size of video frame images in pixels.
+	 */
 	PictureAsset (std::string directory, std::string mxf_name, boost::signals2::signal<void (float)>* progress, int fps, int intrinsic_duration, Size size);
 	
 	/** Write details of this asset to a CPL stream.
@@ -63,6 +80,16 @@ protected:
 
 class MonoPictureAsset;
 
+/** A helper class for writing to MonoPictureAssets progressively (i.e. writing frame-by-frame,
+ *  rather than giving libdcp all the frames in one go).
+ *
+ *  Objects of this class can only be created with MonoPictureAsset::start_write().
+ *
+ *  Frames can be written to the MonoPictureAsset by calling write() with a JPEG2000 image
+ *  (a verbatim .j2 file).  finalize() must be called after the last frame has been written.
+ *  The action of finalize() can't be done in MonoPictureAssetWriter's destructor as it may
+ *  throw an exception.
+ */
 class MonoPictureAssetWriter
 {
 public:
@@ -82,7 +109,9 @@ private:
 	ASDCP::WriterInfo _writer_info;
 	ASDCP::JP2K::PictureDescriptor _picture_descriptor;
 	MonoPictureAsset* _asset;
+	/** Number of picture frames written to the asset so far */
 	int _frames_written;
+	/** true if finalize() has been called */
 	bool _finalized;
 };
 
@@ -90,13 +119,14 @@ private:
 class MonoPictureAsset : public PictureAsset
 {
 public:
-	/** Construct a PictureAsset, generating the MXF from the JPEG2000 files.
+	/** Construct a MonoPictureAsset, generating the MXF from the JPEG2000 files.
 	 *  This may take some time; progress is indicated by emission of the Progress signal.
+	 *
 	 *  @param files Pathnames of JPEG2000 files, in frame order.
 	 *  @param directory Directory in which to create MXF file.
 	 *  @param mxf_name Name of MXF file to create.
 	 *  @param progress Signal to inform of progress.
-	 *  @param fps Frames per second.
+	 *  @param fps Video frames per second.
 	 *  @param intrinsic_duration Length of the whole asset in frames.
 	 *  @param size Size of images in pixels.
 	 */
@@ -110,13 +140,14 @@ public:
 		Size size
 		);
 
-	/** Construct a PictureAsset, generating the MXF from the JPEG2000 files.
+	/** Construct a MonoPictureAsset, generating the MXF from the JPEG2000 files.
 	 *  This may take some time; progress is indicated by emission of the Progress signal.
+	 *
 	 *  @param get_path Functor which returns a JPEG2000 file path for a given frame (frames counted from 0).
 	 *  @param directory Directory in which to create MXF file.
 	 *  @param mxf_name Name of MXF file to create.
 	 *  @param progress Signal to inform of progress.
-	 *  @param fps Frames per second.
+	 *  @param fps Video frames per second.
 	 *  @param intrinsic_duration Length of the whole asset in frames.
 	 *  @param size Size of images in pixels.
 	 */
@@ -130,10 +161,23 @@ public:
 		Size size
 		);
 
+	/** Construct a MonoPictureAsset, reading the MXF from disk.
+	 *  @param directory Directory that the MXF is in.
+	 *  @param mxf_name The filename of the MXF within `directory'.
+	 */
 	MonoPictureAsset (std::string directory, std::string mxf_name);
-	
+
+	/** Construct a MonoPictureAsset for progressive writing using
+	 *  start_write() and a MonoPictureAssetWriter.
+	 *
+	 *  @param directory Directory to put the MXF in.
+	 *  @param mxf_name Filename of the MXF within this directory.
+	 *  @param fps Video frames per second.
+	 *  @param size Size in pixels that the picture frames will be.
+	 */
 	MonoPictureAsset (std::string directory, std::string mxf_name, int fps, Size size);
 
+	/** Start a progressive write to a MonoPictureAsset */
 	boost::shared_ptr<MonoPictureAssetWriter> start_write ();
 
 	boost::shared_ptr<const MonoPictureFrame> get_frame (int n) const;