diff options
| author | Carl Hetherington <cth@carlh.net> | 2012-07-17 17:47:28 +0100 |
|---|---|---|
| committer | Carl Hetherington <cth@carlh.net> | 2012-07-17 17:47:28 +0100 |
| commit | b6718fb437f242fd5127194d4c94e39d71c5e1ad (patch) | |
| tree | e6c0fb61d5252bb72969cdeaa752875bb06e14e3 /src/dcp.cc | |
| parent | 1c22ef308a1d62b4c6935ede8233b1fea082b0ca (diff) | |
Some comments; fix up a UUID I think.
Diffstat (limited to 'src/dcp.cc')
| -rw-r--r-- | src/dcp.cc | 21 |
1 files changed, 20 insertions, 1 deletions
@@ -35,6 +35,10 @@ using namespace libdcp; /** Construct a DCP. * @param d Directory to write files to. + * @param n Name. + * @param c Content type. + * @param fps Frames per second. + * @param length Length in frames. */ DCP::DCP (string d, string n, ContentType c, int fps, int length) : _directory (d) @@ -45,6 +49,9 @@ DCP::DCP (string d, string n, ContentType c, int fps, int length) { } +/** Add a sound asset. + * @param files Pathnames of WAV files to use in the order Left, Right, Centre, Lfe (sub), Left surround, Right surround. + */ void DCP::add_sound_asset (list<string> const & files) { @@ -54,6 +61,9 @@ DCP::add_sound_asset (list<string> const & files) _assets.push_back (shared_ptr<SoundAsset> (new SoundAsset (files, p.string(), _fps, _length))); } +/** Add a picture asset. + * @param files Pathnames of JPEG2000 files, in frame order. + */ void DCP::add_picture_asset (list<string> const & files, int w, int h) { @@ -168,6 +178,7 @@ DCP::write_pkl (string pkl_uuid, string cpl_uuid, string cpl_digest, int cpl_len return p.string (); } +/** Write the VOLINDEX file */ void DCP::write_volindex () const { @@ -182,6 +193,12 @@ DCP::write_volindex () const << "</VolumeIndex>\n"; } +/** Write the ASSETMAP file. + * @param cpl_uuid UUID of our CPL. + * @param cpl_length Length of our CPL in bytes. + * @param pkl_uuid UUID of our PKL. + * @param pkl_length Length of our PKL in bytes. + */ void DCP::write_assetmap (string cpl_uuid, int cpl_length, string pkl_uuid, int pkl_length) const { @@ -232,7 +249,9 @@ DCP::write_assetmap (string cpl_uuid, int cpl_length, string pkl_uuid, int pkl_l << "</AssetMap>\n"; } - +/** @param t A content type. + * @return A string representation suitable for use in a CPL. + */ string DCP::content_type_string (ContentType t) { |