diff options
Diffstat (limited to 'src')
| -rw-r--r-- | src/picture_asset.cc | 14 | ||||
| -rw-r--r-- | src/picture_asset.h | 3 | ||||
| -rw-r--r-- | src/sound_asset.cc | 12 | ||||
| -rw-r--r-- | src/sound_asset.h | 1 | ||||
| -rw-r--r-- | src/tags.cc | 2 | ||||
| -rw-r--r-- | src/tags.h | 7 |
6 files changed, 37 insertions, 2 deletions
diff --git a/src/picture_asset.cc b/src/picture_asset.cc index bdf8ce41..1f131234 100644 --- a/src/picture_asset.cc +++ b/src/picture_asset.cc @@ -30,6 +30,16 @@ using namespace std; using namespace boost; using namespace libdcp; +/** 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 p Pathname of MXF file to create. + * @param fps Frames per second. + * @param len Length in frames. + * @param w Width of images in pixels. + * @param h Height of images in pixels. + */ + PictureAsset::PictureAsset (list<string> const & files, string p, int fps, int len, int w, int h) : Asset (p, fps, len) , _width (w) @@ -43,7 +53,6 @@ PictureAsset::PictureAsset (list<string> const & files, string p, int fps, int l ASDCP::JP2K::PictureDescriptor picture_desc; j2k_parser.FillPictureDescriptor (picture_desc); - /* XXX: we round for DCP: not sure if this is right */ picture_desc.EditRate = ASDCP::Rational (_fps, 1); ASDCP::WriterInfo writer_info; @@ -76,6 +85,9 @@ PictureAsset::PictureAsset (list<string> const & files, string p, int fps, int l _digest = make_digest (_mxf_path); } +/** Write details of this asset to a CPL stream. + * @param s Stream. + */ void PictureAsset::write_to_cpl (ostream& s) const { diff --git a/src/picture_asset.h b/src/picture_asset.h index cef5367b..8883e538 100644 --- a/src/picture_asset.h +++ b/src/picture_asset.h @@ -22,6 +22,7 @@ namespace libdcp { +/** An asset made up of JPEG2000 files */ class PictureAsset : public Asset { public: @@ -30,7 +31,9 @@ public: void write_to_cpl (std::ostream &) const; private: + /** picture width in pixels */ int _width; + /** picture height in pixels */ int _height; }; diff --git a/src/sound_asset.cc b/src/sound_asset.cc index 0b22b4f5..9dba4ed6 100644 --- a/src/sound_asset.cc +++ b/src/sound_asset.cc @@ -28,6 +28,14 @@ using namespace std; using namespace boost; using namespace libdcp; +/** Construct a SoundAsset, generating the MXF from the WAV files. + * This may take some time; progress is indicated by emission of the Progress signal. + * @param files Pathnames of sound files, in the order Left, Right, Centre, Lfe (sub), Left surround, Right surround. + * @param p Pathname of MXF file to create. + * @param fps Frames per second. + * @param len Length in frames. + */ + SoundAsset::SoundAsset (list<string> const & files, string p, int fps, int len) : Asset (p, fps, len) { @@ -116,6 +124,10 @@ SoundAsset::SoundAsset (list<string> const & files, string p, int fps, int len) _digest = make_digest (_mxf_path); } +/** Write details of this asset to a CPL stream. + * @param s Stream. + */ + void SoundAsset::write_to_cpl (ostream& s) const { diff --git a/src/sound_asset.h b/src/sound_asset.h index 8c63b530..0327adf4 100644 --- a/src/sound_asset.h +++ b/src/sound_asset.h @@ -22,6 +22,7 @@ namespace libdcp { +/** An asset made up of WAV files */ class SoundAsset : public Asset { public: diff --git a/src/tags.cc b/src/tags.cc index 584d3623..0adc63c8 100644 --- a/src/tags.cc +++ b/src/tags.cc @@ -24,6 +24,7 @@ using namespace libdcp; Tags* Tags::_instance = 0; +/** Construct a Tags object with some default values */ Tags::Tags () : company_name ("libdcp") , product_name ("libdcp") @@ -39,6 +40,7 @@ Tags::Tags () issue_date = string (buffer); } +/** @return Singleton Tags instance */ Tags * Tags::instance () { @@ -22,6 +22,10 @@ namespace libdcp { +/** A class to hold various metadata that will be written + * to the DCP. The values are initialised, and can be modified + * if desired. + */ class Tags { public: @@ -36,7 +40,8 @@ public: private: Tags (); - + + /** Singleton instance of Tags */ static Tags* _instance; }; |