X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fdcp.h;h=7c318622ae2a30478284334618f7b15de951561a;hb=d927e9b913606f4fc982885c7582ecaf0e3c5a1a;hp=d7919e612f845367f1c4a7bdc2db906793e412aa;hpb=932b942a51bef4e2dd2de9f83aa5b68ad07f60f9;p=libdcp.git diff --git a/src/dcp.h b/src/dcp.h index d7919e61..7c318622 100644 --- a/src/dcp.h +++ b/src/dcp.h @@ -1,35 +1,50 @@ /* - Copyright (C) 2012 Carl Hetherington + Copyright (C) 2012-2014 Carl Hetherington - This program is free software; you can redistribute it and/or modify + This file is part of libdcp. + + libdcp is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. - This program is distributed in the hope that it will be useful, + libdcp is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - + along with libdcp. If not, see . + + In addition, as a special exception, the copyright holders give + permission to link the code of portions of this program with the + OpenSSL library under certain conditions as described in each + individual source file, and distribute linked combinations + including the two. + + You must obey the GNU General Public License in all respects + for all of the code used other than OpenSSL. If you modify + file(s) with this exception, you may extend this exception to your + version of the file(s), but you are not obligated to do so. If you + do not wish to do so, delete this exception statement from your + version. If you delete this exception statement from all source + files in the program, then also delete it here. */ /** @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 "types.h" +#include "certificate.h" +#include "metadata.h" #include #include -#include "types.h" -#include "certificates.h" +#include +#include namespace xmlpp { class Document; @@ -37,104 +52,102 @@ namespace xmlpp { } /** @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 Encryption; -class KDM; +class CertificateChain; +class DecryptedKDM; +class Asset; +class DCPReadError; /** @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); + explicit DCP (boost::filesystem::path 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); + typedef std::list > ReadErrors; - /** Write the required XML files to the directory that was - * passed into the constructor. + /** 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. + * @param ignore_incorrect_picture_mxf_type true to try loading MXF files marked as monoscopic + * as stereoscopic if the monoscopic load fails; fixes problems some 3D DCPs that (I think) + * have an incorrect descriptor in their MXF. */ - void write_xml (XMLMetadata const &, boost::shared_ptr crypt = boost::shared_ptr ()) const; + void read (bool keep_going = false, ReadErrors* errors = 0, bool ignore_incorrect_picture_mxf_type = false); /** 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. */ - bool equals (DCP const & other, EqualityOptions options, boost::function note) const; + bool equals (DCP const & other, EqualityOptions options, NoteHandler note) const; - /** Add a CPL to this DCP. - * @param cpl CPL to add. - */ - void add_cpl (boost::shared_ptr cpl); + void add (boost::shared_ptr cpl); - /** @return The list of CPLs in this DCP */ - std::list > cpls () const { - return _cpls; - } + std::list > cpls () const; + std::list > assets () const; bool encrypted () const; - void add_kdm (KDM const &); + void add (DecryptedKDM const &); - /** Emitted with a parameter between 0 and 1 to indicate progress - * for long jobs. - */ - boost::signals2::signal Progress; + void write_xml ( + Standard standard, + XMLMetadata metadata = XMLMetadata (), + boost::shared_ptr signer = boost::shared_ptr () + ); + + void resolve_refs (std::list > assets); + + /** @return Standard of a DCP that was read in */ + boost::optional standard () const { + return _standard; + } private: /** Write the PKL file. * @param pkl_uuid UUID to use. */ - std::string write_pkl (std::string pkl_uuid, XMLMetadata const &, boost::shared_ptr) const; - - /** Write the VOLINDEX file */ - void write_volindex () const; + boost::filesystem::path write_pkl ( + Standard standard, + std::string pkl_uuid, + XMLMetadata metadata, + boost::shared_ptr signer + ) 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, XMLMetadata const &) const; - - /** @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; - }; + 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; - /** our CPLs */ + boost::filesystem::path _directory; + /** the CPLs that make up this DCP */ std::list > _cpls; + + /** Standard of DCP that was read in */ + boost::optional _standard; }; }