X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fdcp.h;h=d6275037c1582ce4719639b98ae4b4237c87c72f;hb=ac265d3d008328b9bdaf00c39ebcd86f263605c7;hp=2f7a31aa0cb1d657e001aad73cf668b7540ba097;hpb=4d91615b49a3246654baaf7a08f10f303b79b85a;p=libdcp.git diff --git a/src/dcp.h b/src/dcp.h index 2f7a31aa..d6275037 100644 --- a/src/dcp.h +++ b/src/dcp.h @@ -1,5 +1,5 @@ /* - Copyright (C) 2012 Carl Hetherington + Copyright (C) 2012-2014 Carl Hetherington This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -18,156 +18,109 @@ */ /** @file src/dcp.h - * @brief A class to create a DCP. + * @brief DCP class. */ #ifndef LIBDCP_DCP_H #define LIBDCP_DCP_H +#include "types.h" +#include "certificates.h" +#include "metadata.h" +#include +#include #include #include -#include -#include -#include "types.h" namespace xmlpp { - class Node; + class Document; + class Element; } /** @brief Namespace for everything in libdcp */ -namespace libdcp +namespace dcp { -class Asset; -class PictureAsset; -class SoundAsset; -class SubtitleAsset; +class Content; class Reel; +class CPL; +class XMLMetadata; +class Signer; +class KDM; +class Asset; + +namespace parse { + class AssetMap; +} -/** @class DCP dcp.h libdcp/dcp.h +/** @class DCP * @brief A class to create or read a DCP. */ -class DCP +class DCP : public boost::noncopyable { public: - /** Construct a DCP. - * - * This is for making a new DCP that you are going to add assets to. - * - * @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. - */ - DCP (std::string directory, std::string name, ContentKind content_kind, int fps, int length); - - /** Construct a DCP object for an existing DCP. + /** 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. * - * The DCP's XML metadata will be examined, and you can then look at the contents - * of the DCP. - * - * @param directory Existing DCP's directory. + * @param directory Directory containing the DCP's files. */ - DCP (std::string directory); + DCP (boost::filesystem::path directory); - void add_reel (boost::shared_ptr reel); + void read (); - /** Write the required XML files to the directory that was - * passed into the constructor. + /** 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. + * @param note Functor to handle notes made by the equality operation. + * @return true if the DCPs are equal according to EqualityOptions, otherwise false. */ - void write_xml () const; + bool equals (DCP const & other, EqualityOptions options, boost::function note) const; - /** @return the DCP's name, as will be presented on projector - * media servers and theatre management systems. - */ - std::string name () const { - return _name; - } + void add (boost::shared_ptr asset); - /** @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 > cpls () const; - /** @return the number of frames per second */ - int frames_per_second () const { - return _fps; + /** @return All this DCP's assets (note that CPLs are assets) */ + std::list > assets () const { + return _assets; } - /** @return the length in frames */ - int length () const { - return _length; - } + bool encrypted () const; - std::list > reels () const { - return _reels; - } + void add (KDM const &); - /** 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. - * @return An empty list if the DCPs are equal; otherwise a list of messages - * which explain the ways in which they differ. - */ - std::list equals (DCP const & other, EqualityOptions options) const; - - /** Emitted with a parameter between 0 and 1 to indicate progress - * for long jobs. - */ - sigc::signal1 Progress; + void write_xml ( + Standard standard, + XMLMetadata metadata = XMLMetadata (), + boost::shared_ptr signer = boost::shared_ptr () + ); 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; + boost::filesystem::path write_pkl ( + Standard standard, + std::string pkl_uuid, + XMLMetadata metadata, + boost::shared_ptr signer + ) const; - /** Write the VOLINDEX file */ - void write_volindex () const; + void write_volindex (Standard standard) 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; - - struct Files { - std::string cpl; - std::string pkl; - std::string asset_map; - std::list subtitles; - }; - - void scan (Files& files, std::string directory) const; + void write_assetmap (Standard standard, std::string pkl_uuid, int pkl_length, XMLMetadata metadata) const; /** 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; - /** reels */ - std::list > _reels; + boost::filesystem::path _directory; + /** the assets that make up this DCP */ + std::list > _assets; }; }