/*
- Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
- 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 <http://www.gnu.org/licenses/>.
+
+ 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 "compose.hpp"
+#include "types.h"
+#include "util.h"
+#include "certificate.h"
+#include "metadata.h"
+#include "name_format.h"
+#include "verify.h"
+#include "version.h"
+#include <memory>
+#include <boost/signals2.hpp>
#include <string>
#include <vector>
-#include <boost/shared_ptr.hpp>
-#include <boost/signals2.hpp>
-#include "types.h"
-#include "certificates.h"
namespace xmlpp {
class Document;
}
/** @brief Namespace for everything in libdcp */
-namespace libdcp
+namespace dcp
{
-class Asset;
-class PictureAsset;
-class SoundAsset;
-class SubtitleAsset;
+class PKL;
+class Content;
class Reel;
class CPL;
-class XMLMetadata;
-class Signer;
-class KDM;
-
-namespace parse {
- class AssetMap;
-}
+class CertificateChain;
+class DecryptedKDM;
+class Asset;
+class ReadError;
/** @class DCP
* @brief A class to create or read a 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 (boost::filesystem::path directory);
+ explicit DCP (boost::filesystem::path directory);
- void read (bool require_mxfs = true);
-
- /** 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 read_assets ();
-
- void read_cpls (bool require_mxfs = true);
-
- /** Write the required XML files to the directory that was
- * passed into the constructor.
+ /** Read the DCP's structure into this object.
+ * @param notes List of notes that will be added to if non-0.
+ * @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 (bool interop, XMLMetadata const &, boost::shared_ptr<const Signer> signer = boost::shared_ptr<const Signer> ()) const;
+ void read (std::list<VerificationNote>* notes = 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<void (NoteType, std::string)> note) const;
-
- /** Add a CPL to this DCP.
- * @param cpl CPL to add.
- */
- void add_cpl (boost::shared_ptr<CPL> cpl);
+ bool equals (DCP const & other, EqualityOptions options, NoteHandler note) const;
- /** @return The list of CPLs in this DCP */
- std::list<boost::shared_ptr<CPL> > cpls () const {
- return _cpls;
- }
+ void add (std::shared_ptr<CPL> cpl);
- /** 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 &);
+ std::list<std::shared_ptr<CPL> > cpls () const;
+ std::list<std::shared_ptr<Asset> > assets (bool ignore_unresolved = false) const;
bool encrypted () const;
- void add_kdm (KDM const &);
+ void add (DecryptedKDM const &);
+
+ void write_xml (
+ Standard standard,
+ std::string issuer = String::compose("libdcp %1", dcp::version),
+ std::string creator = String::compose("libdcp %1", dcp::version),
+ std::string issue_date = LocalTime().as_string(),
+ std::string annotation_text = String::compose("Created by libdcp %1", dcp::version),
+ std::shared_ptr<const CertificateChain> signer = std::shared_ptr<const CertificateChain> (),
+ NameFormat name_format = NameFormat("%t")
+ );
- /** Emitted with a parameter between 0 and 1 to indicate progress
- * for long jobs.
+ void resolve_refs (std::list<std::shared_ptr<Asset> > assets);
+
+ /** @return Standard of a DCP that was read in */
+ boost::optional<Standard> standard () const {
+ return _standard;
+ }
+
+ boost::filesystem::path directory () const {
+ return _directory;
+ }
+
+ /** @return PKLs if this DCP was read from an existing one, or if write_xml() has been called on it.
+ * If neither is true, this method returns an empty list.
*/
- boost::signals2::signal<void (float)> Progress;
+ std::list<std::shared_ptr<PKL> > pkls () const {
+ return _pkls;
+ }
+
+ boost::optional<boost::filesystem::path> asset_map_path () {
+ return _asset_map;
+ }
+
+ static std::vector<boost::filesystem::path> directories_from_files (std::vector<boost::filesystem::path> files);
private:
- /** Write the PKL file.
- * @param pkl_uuid UUID to use.
- */
- std::string write_pkl (std::string pkl_uuid, bool, XMLMetadata const &, boost::shared_ptr<const 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.
+ * @param pkl_path Pathname of our PKL file.
*/
- void write_assetmap (std::string pkl_uuid, int pkl_length, bool, XMLMetadata const &) const;
+ void write_assetmap (
+ Standard standard, std::string pkl_uuid, boost::filesystem::path pkl_path,
+ std::string issuer, std::string creator, std::string issue_date, std::string annotation_text
+ ) const;
- /** @return Assets in all the CPLs in this DCP */
- std::list<boost::shared_ptr<const Asset> > assets () const;
-
- struct Files {
- std::list<std::string> cpls;
- std::string pkl;
- std::string asset_map;
- };
-
- Files _files;
-
- /** the directory that we are writing to */
+ /** The directory that we are writing to */
boost::filesystem::path _directory;
- /** our CPLs */
- std::list<boost::shared_ptr<CPL> > _cpls;
-
- std::list<PathAssetMap> _asset_maps;
+ /** The CPLs that make up this DCP */
+ std::list<std::shared_ptr<CPL> > _cpls;
+ /** The PKLs that make up this DCP */
+ std::list<std::shared_ptr<PKL> > _pkls;
+ /** File that the ASSETMAP was read from or last written to */
+ mutable boost::optional<boost::filesystem::path> _asset_map;
+
+ /** Standard of DCP that was read in */
+ boost::optional<Standard> _standard;
};
}
projects / libdcp.git / blobdiff