X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fdcp.h;h=effadfa3ebeb2b8f3538122359028b5415d572dc;hb=edf35a7acb05289dc024733efd6e13205def5174;hp=900a5665a52554ab659f7ec15c0d49da03153543;hpb=b3ae1623ed44ade680236b4af283543083bceea3;p=libdcp.git diff --git a/src/dcp.h b/src/dcp.h index 900a5665..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,137 +18,116 @@ */ /** @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 Content; +class Reel; +class CPL; +class XMLMetadata; +class Signer; +class DecryptedKDM; +class Asset; +class DCPReadError; + +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. - */ - DCP (std::string directory, std::string name, ContentKind content_kind, int fps, int length); - - DCP (std::string directory); - - /** 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. - */ - void add_sound_asset (std::vector const & files); - - /** Add a sound asset. - * @param get_path Functor to get the path to the WAV for a given channel. - * @param channels Number of channels. + /** Construct a DCP. You can pass an existing DCP's directory + * 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. */ - void add_sound_asset (sigc::slot get_path, int channels); + DCP (boost::filesystem::path directory); - /** 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. + 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 add_picture_asset (std::vector const & files, int width, int height); + void read (bool keep_going = false, ReadErrors* errors = 0); - /** 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. + * @param note Functor to handle notes made by the equality operation. + * @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, NoteHandler note) const; - /** Write the required XML files to the directory that was - * passed into the constructor. - */ - void write_xml () const; + void add (boost::shared_ptr asset); - std::string name () const { - return _name; - } + std::list > cpls () const; - ContentKind content_kind () const { - return _content_kind; + /** @return All this DCP's assets (note that CPLs are assets) */ + std::list > assets () const { + return _assets; } - int frames_per_second () const { - return _fps; - } + bool encrypted () const; - int length () const { - return _length; - } + void add (DecryptedKDM 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; + 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; - /** assets */ + boost::filesystem::path _directory; + /** the assets that make up this DCP */ std::list > _assets; };