X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fdcp.h;h=f2a261cd875c1dbb8c78fa00a9a1d2824007cd83;hb=f8005516a681b805ccc2d929f63312ac711fdc24;hp=6ab57bcb9152322248271b263373c5c0c5ef5e44;hpb=4678bf06d71c8a18c489912dabf8aca312ab8b6b;p=libdcp.git diff --git a/src/dcp.h b/src/dcp.h index 6ab57bcb..f2a261cd 100644 --- a/src/dcp.h +++ b/src/dcp.h @@ -27,11 +27,13 @@ #include #include #include -#include +#include #include "types.h" +#include "certificates.h" namespace xmlpp { - class Node; + class Document; + class Element; } /** @brief Namespace for everything in libdcp */ @@ -39,119 +41,119 @@ namespace libdcp { class Asset; +class PictureAsset; +class SoundAsset; +class SubtitleAsset; +class Reel; +class CPL; +class XMLMetadata; +class Signer; +class KDM; + +namespace parse { + class AssetMap; +} -/** @class DCP dcp.h libdcp/dcp.h - * @brief A class to create a DCP. +/** @class DCP + * @brief A class to create or read a DCP. */ -class DCP +class DCP : public boost::noncopyable { public: - /** Construct a DCP. - * @param directory Directory to write files to. - * @param name Name. - * @param content_kind Content kind. - * @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, ContentKind content_kind, int fps, int length); + DCP (boost::filesystem::path directory); - DCP (std::string directory); + void read (bool require_mxfs = true); - /** 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. + /** Read an existing DCP's assets. + * + * The DCP's XML metadata will be examined, and you can then look at the contents + * of the DCP. */ - void add_sound_asset (std::vector const & files); + void read_assets (); - /** Add a sound asset. - * @param get_path Functor to get the path to the WAV for a given channel. - * @param channels Number of channels. - */ - void add_sound_asset (sigc::slot get_path, int channels); + void read_cpls (bool require_mxfs = true); - /** 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. + /** Write the required XML files to the directory that was + * passed into the constructor. */ - void add_picture_asset (std::vector const & files, int width, int height); + void write_xml (bool interop, XMLMetadata const &, boost::shared_ptr signer = boost::shared_ptr ()) 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. + /** Compare this DCP with another, according to various options. + * @param other DCP to compare this one to. + * @param options Options to define what "equality" means. + * @return true if the DCPs are equal according to EqualityOptions, otherwise false. */ - void add_picture_asset (sigc::slot get_path, int width, int height); + bool equals (DCP const & other, EqualityOptions options, boost::function note) const; - /** Write the required XML files to the directory that was - * passed into the constructor. + /** Add a CPL to this DCP. + * @param cpl CPL to add. */ - void write_xml () const; - - std::string name () const { - return _name; - } + void add_cpl (boost::shared_ptr cpl); - ContentKind content_kind () const { - return _content_kind; + /** @return The list of CPLs in this DCP */ + std::list > cpls () const { + return _cpls; } - int frames_per_second () const { - return _fps; - } + /** Add another DCP as a source of assets for this DCP. This should be called before + * ::read() on the DCP that needs the extra assets. For example + * + * DCP original_version ("my_dcp_OV"); + * DCP supplemental ("my_dcp_VF"); + * supplemental.add_assets_from (original_version); + * supplemental.read (); + */ + void add_assets_from (libdcp::DCP const &); - int length () const { - return _length; - } + bool encrypted () const; - std::list equals (DCP const & other, EqualityType type) const; + void add_kdm (KDM const &); /** 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, bool, XMLMetadata const &, boost::shared_ptr) 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, bool, XMLMetadata const &) const; + + /** @return Assets in all the CPLs in this DCP */ + std::list > assets () const; + + struct Files { + std::list cpls; + std::string pkl; + std::string asset_map; + }; + + Files _files; /** the directory that we are writing to */ - std::string _directory; - /** the name of the DCP */ - std::string _name; - /** the content kind of the DCP */ - ContentKind _content_kind; - /** frames per second */ - int _fps; - /** length in frames */ - int _length; - /** assets */ - std::list > _assets; + boost::filesystem::path _directory; + /** our CPLs */ + std::list > _cpls; + + std::list _asset_maps; }; }