X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;ds=inline;f=src%2Fdcp.h;h=c5734542a97e17cff311f199da3f1c2200c0b154;hb=2489080f9a5d2891da0fc313b2c0ac1450a630ad;hp=828a6e751a2cb3f2b777fcdec1086cd1ff0356ab;hpb=e841d657980849483d0651cccb889e7b4cf1d711;p=libdcp.git diff --git a/src/dcp.h b/src/dcp.h index 828a6e75..c5734542 100644 --- a/src/dcp.h +++ b/src/dcp.h @@ -27,126 +27,170 @@ #include #include #include -#include +#include #include "types.h" +namespace xmlpp { + class Node; +} + /** @brief Namespace for everything in libdcp */ namespace libdcp { class Asset; +class PictureAsset; +class SoundAsset; +class SubtitleAsset; +class Reel; +class AssetMap; + +/** @brief A CPL within a DCP */ +class CPL +{ +public: + CPL (std::string directory, std::string name, ContentKind content_kind, int length, int frames_per_second); + CPL (std::string directory, std::string file, boost::shared_ptr asset_map, bool require_mxfs = true); + + void add_reel (boost::shared_ptr reel); + + /** @return the length in frames */ + int length () const { + return _length; + } + + /** @return the type of the content, used by media servers + * to categorise things (e.g. feature, trailer, etc.) + */ + ContentKind content_kind () const { + return _content_kind; + } + + std::list > reels () const { + return _reels; + } + + /** @return the CPL's name, as will be presented on projector + * media servers and theatre management systems. + */ + std::string name () const { + return _name; + } + + /** @return the number of frames per second */ + int frames_per_second () const { + return _fps; + } + + std::list > assets () const; + + bool equals (CPL const & other, EqualityOptions options, std::list& notes) const; + + void write_xml () const; + void write_to_assetmap (std::ostream& s) const; + void write_to_pkl (std::ostream& s) const; + +private: + std::string _directory; + /** the name of the DCP */ + std::string _name; + /** the content kind of the CPL */ + ContentKind _content_kind; + /** length in frames */ + mutable int _length; + /** frames per second */ + int _fps; + /** reels */ + std::list > _reels; + + /** our UUID */ + std::string _uuid; + /** a SHA1 digest of our XML */ + mutable std::string _digest; +}; /** @class DCP dcp.h libdcp/dcp.h - * @brief A class to create a DCP. + * @brief A class to create or read a DCP. */ class DCP { public: - enum ContentType - { - FEATURE, - SHORT, - TRAILER, - TEST, - TRANSITIONAL, - RATING, - TEASER, - POLICY, - PUBLIC_SERVICE_ANNOUNCEMENT, - ADVERTISEMENT - }; - - /** Construct a DCP. - * @param directory Directory to write files to. - * @param name Name. - * @param content_type Content type. - * @param fps Frames per second. - * @param length Length in frames. + /** Construct a DCP. You can pass an existing DCP's directory + * as the parameter, or a non-existant folder to create a new + * DCP in. + * + * @param directory Directory containing the DCP's files. */ - DCP (std::string directory, std::string name, ContentType content_type, 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; not all files need - * to be present. + DCP (std::string directory); + + /** Read an existing DCP's data. + * + * The DCP's XML metadata will be examined, and you can then look at the contents + * of the DCP. + * + * @param require_mxfs true to throw an exception if MXF files are missing; setting to false + * can be useful for testing, but normally it should be set to true. */ - void add_sound_asset (std::vector const & files); + void read (bool require_mxfs = true); - /** Add a sound asset. - * @param get_path Functor to get the path to the WAV for a given channel. - * @param channels Number of channels. + /** Write the required XML files to the directory that was + * passed into the constructor. */ - void add_sound_asset (sigc::slot get_path, int channels); + void write_xml () const; - /** Add a picture asset. - * @param files Pathnames of JPEG2000 files, in frame order. - * @param width Width of images in pixels. - * @param height Height of images in pixels. + /** Compare this DCP with another, according to various options. + * @param other DCP to compare this one to. + * @param options Options to define just what "equality" means. + * @param notes Filled in with notes about differences. + * @return true if the DCPs are equal according to EqualityOptions, otherwise false. */ - void add_picture_asset (std::vector const & files, int width, int height); + bool equals (DCP const & other, EqualityOptions options, std::list& notes) const; - /** Add a picture asset. - * @param get_path Functor to get path to the JPEG2000 for a given frame. - * @param width Width of images in pixels. - * @param height Height of images in pixels. + /** Add a CPL to this DCP. + * @param cpl CPL to add. */ - void add_picture_asset (sigc::slot get_path, int width, int height); + void add_cpl (boost::shared_ptr cpl); - /** Write the required XML files to the directory that was - * passed into the constructor. - */ - void write_xml () const; + /** @return The list of CPLs in this DCP */ + std::list > cpls () const { + return _cpls; + } /** Emitted with a parameter between 0 and 1 to indicate progress * for long jobs. */ - sigc::signal1 Progress; + boost::signals2::signal Progress; private: - /** Write the CPL file. - * @param cpl_uuid UUID to use. - * @return CPL pathname. - */ - std::string write_cpl (std::string cpl_uuid) const; - /** Write the PKL file. * @param pkl_uuid UUID to use. - * @param cpl_uuid UUID of the CPL file. - * @param cpl_digest SHA digest of the CPL file. - * @param cpl_length Length of the CPL file in bytes. */ - std::string write_pkl (std::string pkl_uuid, std::string cpl_uuid, std::string cpl_digest, int cpl_length) const; + std::string write_pkl (std::string pkl_uuid) const; /** Write the VOLINDEX file */ void write_volindex () const; /** 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 write_assetmap (std::string cpl_uuid, int cpl_length, std::string pkl_uuid, int pkl_length) const; + void write_assetmap (std::string pkl_uuid, int pkl_length) const; - /** @param type A content type. - * @return A string representation suitable for use in a CPL. - */ - static std::string content_type_string (ContentType type); + /** @return Assets in all this CPLs in this DCP */ + std::list > assets () const; + + struct Files { + std::list cpls; + std::string pkl; + std::string asset_map; + }; /** the directory that we are writing to */ std::string _directory; - /** the name of the DCP */ - std::string _name; - /** the content type of the DCP */ - ContentType _content_type; - /** frames per second */ - int _fps; - /** length in frames */ - int _length; - /** assets */ - std::list > _assets; + /** our CPLs */ + std::list > _cpls; }; }