X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fdcp.h;h=effadfa3ebeb2b8f3538122359028b5415d572dc;hb=391860586976a6b6309caa56cc1191e1ca9efd06;hp=0ee4a8fc8bd23856461f6b3c80f5c296e984abac;hpb=bb6c2aef9befb77bf14775abfedf8a2c9b7f8d53;p=libdcp.git diff --git a/src/dcp.h b/src/dcp.h index 0ee4a8fc..effadfa3 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,189 +18,117 @@ */ /** @file src/dcp.h - * @brief A class to create a DCP. + * @brief DCP class. */ #ifndef LIBDCP_DCP_H #define LIBDCP_DCP_H -#include -#include -#include -#include #include "types.h" #include "certificates.h" +#include "metadata.h" +#include +#include +#include +#include namespace xmlpp { + 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 AssetMap; - -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 (bool, CertificateChain const &, std::string const &) const; - void write_to_assetmap (std::ostream& s) const; - void write_to_pkl (xmlpp::Element* p) 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; - - std::string _uuid; - mutable std::string _digest; -}; +class CPL; +class XMLMetadata; +class Signer; +class DecryptedKDM; +class Asset; +class DCPReadError; + +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. You can pass an existing DCP's directory - * as the parameter, or a non-existant folder to create a new - * DCP in. + * as the parameter; alternatively, directory will be created + * if it does not exist. Note that if you pass an existing DCP + * into this constructor it will not be read until you call ::read(). * * @param directory Directory containing the DCP's files. */ - 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 read (bool require_mxfs = true); + DCP (boost::filesystem::path directory); - /** Write the required XML files to the directory that was - * passed into the constructor. + typedef std::list > ReadErrors; + + /** Read the DCP's structure into this object. + * @param keep_going true to try to keep going in the face of (some) errors. + * @param errors List of errors that will be added to if keep_going is true. */ - void write_xml () const; + void read (bool keep_going = false, ReadErrors* errors = 0); /** 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. + * @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. */ - bool equals (DCP const & other, EqualityOptions options, std::list& notes) const; + bool equals (DCP const & other, EqualityOptions options, NoteHandler note) const; - void add_cpl (boost::shared_ptr cpl); + void add (boost::shared_ptr asset); - std::list > cpls () const { - return _cpls; - } + std::list > cpls () const; - void set_encrypted (bool e) { - _encrypted = e; + /** @return All this DCP's assets (note that CPLs are assets) */ + std::list > assets () const { + return _assets; } - void set_certificates (CertificateChain const & c) { - _certificates = c; - } + bool encrypted () const; - void set_signer_key (std::string const & s) { - _signer_key = s; - } + void add (DecryptedKDM const &); - /** Emitted with a parameter between 0 and 1 to indicate progress - * for long jobs. - */ - boost::signals2::signal Progress; - - static void sign (xmlpp::Element* parent, CertificateChain const & certificates, std::string const & signer_key); + void write_xml ( + Standard standard, + XMLMetadata metadata = XMLMetadata (), + boost::shared_ptr signer = boost::shared_ptr () + ); private: /** Write the PKL file. * @param pkl_uuid UUID to use. */ - std::string write_pkl (std::string pkl_uuid) 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 pkl_uuid UUID of our PKL. * @param pkl_length Length of our PKL in bytes. */ - void write_assetmap (std::string pkl_uuid, int pkl_length) const; - - std::list > assets () const; - - struct Files { - std::list cpls; - std::string pkl; - std::string asset_map; - }; + 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; - std::list > _cpls; - - bool _encrypted; - CertificateChain _certificates; - std::string _signer_key; + boost::filesystem::path _directory; + /** the assets that make up this DCP */ + std::list > _assets; }; }