/*
- Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
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
*/
/** @file src/dcp.h
- * @brief A class to create a DCP.
+ * @brief DCP class.
*/
#ifndef LIBDCP_DCP_H
#define LIBDCP_DCP_H
-#include <string>
-#include <vector>
-#include <boost/shared_ptr.hpp>
-#include <boost/signals2.hpp>
-#include <boost/date_time/posix_time/posix_time.hpp>
#include "types.h"
#include "certificates.h"
+#include "metadata.h"
+#include <boost/shared_ptr.hpp>
+#include <boost/signals2.hpp>
+#include <string>
+#include <vector>
namespace xmlpp {
class Document;
}
/** @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 Encryption
-{
-public:
- Encryption (CertificateChain c, std::string const & k)
- : certificates (c)
- , signer_key (k)
- {}
-
- CertificateChain certificates;
- std::string signer_key;
-};
-
-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<const AssetMap> asset_map, bool require_mxfs = true);
-
- void add_reel (boost::shared_ptr<const Reel> 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<boost::shared_ptr<const Reel> > 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<boost::shared_ptr<const Asset> > assets () const;
-
- bool equals (CPL const & other, EqualityOptions options, std::list<std::string>& notes) const;
-
- void write_xml (boost::shared_ptr<Encryption>) const;
- void write_to_assetmap (std::ostream& s) const;
- void write_to_pkl (xmlpp::Element* p) const;
-
- boost::shared_ptr<xmlpp::Document> make_kdm (
- CertificateChain const &,
- std::string const &,
- boost::shared_ptr<const Certificate>,
- boost::posix_time::ptime from,
- boost::posix_time::ptime until
- ) 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<boost::shared_ptr<const Reel> > _reels;
-
- std::string _uuid;
- mutable std::string _digest;
-};
+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. You can pass an existing DCP's directory
*
* @param directory Directory containing the DCP's files.
*/
- DCP (std::string directory);
+ 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);
-
- /** Write the required XML files to the directory that was
- * passed into the constructor.
- */
- void write_xml (boost::shared_ptr<Encryption> crypt = boost::shared_ptr<Encryption> ()) const;
+ void read ();
/** 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<std::string>& notes) const;
+ bool equals (DCP const & other, EqualityOptions options, boost::function<void (NoteType, std::string)> note) const;
+
+ void add (boost::shared_ptr<Asset> asset);
- void add_cpl (boost::shared_ptr<CPL> cpl);
+ std::list<boost::shared_ptr<CPL> > cpls () const;
- std::list<boost::shared_ptr<const CPL> > cpls () const {
- return _cpls;
+ /** @return All this DCP's assets (note that CPLs are assets) */
+ std::list<boost::shared_ptr<Asset> > assets () const {
+ return _assets;
}
+ bool encrypted () const;
+
+ void add (KDM const &);
+
+ void write_xml (
+ Standard standard,
+ XMLMetadata metadata = XMLMetadata (),
+ boost::shared_ptr<const Signer> signer = boost::shared_ptr<const Signer> ()
+ );
+
/** Emitted with a parameter between 0 and 1 to indicate progress
* for long jobs.
*/
/** Write the PKL file.
* @param pkl_uuid UUID to use.
*/
- std::string write_pkl (std::string pkl_uuid, boost::shared_ptr<Encryption>) const;
+ boost::filesystem::path write_pkl (
+ Standard standard,
+ std::string pkl_uuid,
+ XMLMetadata metadata,
+ boost::shared_ptr<const Signer> 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<boost::shared_ptr<const Asset> > assets () const;
-
- struct Files {
- std::list<std::string> 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<boost::shared_ptr<const CPL> > _cpls;
+ boost::filesystem::path _directory;
+ /** the assets that make up this DCP */
+ std::list<boost::shared_ptr<Asset> > _assets;
};
}
projects / libdcp.git / blobdiff