summaryrefslogtreecommitdiff
path: root/src/picture_asset.h
diff options
context:
space:
mode:
authorCarl Hetherington <cth@carlh.net>2012-07-17 21:09:39 +0100
committerCarl Hetherington <cth@carlh.net>2012-07-17 21:09:39 +0100
commit82d22d7ff5328fae4f2e3048e63a2b11f3ce36b4 (patch)
tree82bdbe0285f159bcfd8204d53efe938bd5999095 /src/picture_asset.h
parent4709b2fe88040f3678560997726f3a209eacc660 (diff)
Doc fixes.
Diffstat (limited to 'src/picture_asset.h')
-rw-r--r--src/picture_asset.h31
1 files changed, 28 insertions, 3 deletions
diff --git a/src/picture_asset.h b/src/picture_asset.h
index 3027a789..2f3c7cdf 100644
--- a/src/picture_asset.h
+++ b/src/picture_asset.h
@@ -17,18 +17,43 @@
*/
+/** @file src/picture_asset.h
+ * @brief An asset made up of JPEG2000 files
+ */
+
#include "asset.h"
namespace libdcp
{
-/** An asset made up of JPEG2000 files */
+/** @brief An asset made up of JPEG2000 files */
class PictureAsset : public Asset
{
public:
- PictureAsset (std::list<std::string> const &, std::string, sigc::signal1<void, float>*, int, int, int, int);
+ /** Construct a PictureAsset, 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 mxf_path Pathname of MXF file to create.
+ * @param progress Signal to inform of progress.
+ * @param fps Frames per second.
+ * @param length Length in frames.
+ * @param width Width of images in pixels.
+ * @param height Height of images in pixels.
+ */
+ PictureAsset (
+ std::list<std::string> const & files,
+ std::string mxf_path,
+ sigc::signal1<void, float>* progress,
+ int fps,
+ int length,
+ int width,
+ int height
+ );
- void write_to_cpl (std::ostream &) const;
+ /** Write details of this asset to a CPL stream.
+ * @param s Stream.
+ */
+ void write_to_cpl (std::ostream& s) const;
private:
/** picture width in pixels */