diff options
| author | Carl Hetherington <cth@carlh.net> | 2013-07-23 15:05:12 +0100 |
|---|---|---|
| committer | Carl Hetherington <cth@carlh.net> | 2013-07-23 15:05:12 +0100 |
| commit | 04156a67a01fbb81c6e8b59ecff6a22dee712c30 (patch) | |
| tree | d133d5b8aa73224aa8d3c7241c1f0f2dedfd27a9 | |
| parent | fe95c6dfbeda97ec88ffa5e2fded883ffb609b81 (diff) | |
A few comment fixes.
| -rw-r--r-- | src/picture_asset.h | 29 |
1 files changed, 21 insertions, 8 deletions
diff --git a/src/picture_asset.h b/src/picture_asset.h index f1b14bd6..df8415d3 100644 --- a/src/picture_asset.h +++ b/src/picture_asset.h @@ -21,7 +21,7 @@ #define LIBDCP_PICTURE_ASSET_H /** @file src/picture_asset.h - * @brief An asset made up of JPEG2000 files + * @brief An asset made up of JPEG2000 data */ #include <openjpeg.h> @@ -36,7 +36,7 @@ class MonoPictureFrame; class StereoPictureFrame; class PictureAssetWriter; -/** @brief An asset made up of JPEG2000 files */ +/** @brief An asset made up of JPEG2000 data */ class PictureAsset : public MXFAsset { public: @@ -54,13 +54,26 @@ public: * @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 fps Video frames per second. + * @param intrinsic_duration Total number of 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, bool encrypted, Size); + PictureAsset ( + std::string directory, + std::string mxf_name, + boost::signals2::signal<void (float)>* progress, + int fps, + int intrinsic_duration, + bool encrypted, + Size + ); - virtual boost::shared_ptr<PictureAssetWriter> start_write (bool, MXFMetadata const & metadata = MXFMetadata ()) = 0; + /** Start a progressive write to this asset. + * @param overwrite true to overwrite an existing MXF file; in this mode, writing can be resumed to a partially-written MXF; false if the + * MXF file does not exist. + * @param metadata MXF metadata to use. + */ + virtual boost::shared_ptr<PictureAssetWriter> start_write (bool overwrite, MXFMetadata const & metadata = MXFMetadata ()) = 0; bool equals (boost::shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, std::string)> note) const; @@ -98,7 +111,7 @@ public: * @param mxf_name Name of MXF file to create. * @param progress Signal to inform of progress. * @param fps Video frames per second. - * @param intrinsic_duration Length of the whole asset in frames. + * @param intrinsic_duration Total number of frames in the asset. * @param size Size of images in pixels. * @param encrypted true if asset should be encrypted. */ @@ -122,7 +135,7 @@ public: * @param mxf_name Name of MXF file to create. * @param progress Signal to inform of progress. * @param fps Video frames per second. - * @param intrinsic_duration Length of the whole asset in frames. + * @param intrinsic_duration Total number of frames in the asset. * @param size Size of images in pixels. * @param encrypted true if asset should be encrypted. */ |
