/*
- 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 "types.h"
+#include "certificates.h"
+#include "metadata.h"
+#include <boost/shared_ptr.hpp>
+#include <boost/signals2.hpp>
#include <string>
#include <vector>
-#include <boost/shared_ptr.hpp>
-#include <sigc++/sigc++.h>
-#include "types.h"
namespace xmlpp {
- class Node;
+ 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 DCP dcp.h libdcp/dcp.h
+class CPL;
+class XMLMetadata;
+class Signer;
+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.
+ /** 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().
*
- * This is for making a new DCP that you are going to add assets to.
- *
- * @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);
-
- /** Construct a DCP object for an existing DCP.
- *
- * The DCP's XML metadata will be examined, and you can then look at the contents
- * of the DCP.
- *
- * @param directory Existing DCP's directory.
+ * @param directory Directory containing the DCP's files.
*/
- DCP (std::string directory);
-
- void add_reel (boost::shared_ptr<const Reel> reel);
+ DCP (boost::filesystem::path directory);
- /** Write the required XML files to the directory that was
- * passed into the constructor.
- */
- void write_xml () const;
+ typedef std::list<boost::shared_ptr<DCPReadError> > ReadErrors;
- /** @return the DCP's name, as will be presented on projector
- * media servers and theatre management systems.
+ /** 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.
*/
- std::string name () const {
- return _name;
- }
+ void read (bool keep_going = false, ReadErrors* errors = 0);
- /** @return the type of the content, used by media servers
- * to categorise things (e.g. feature, trailer, etc.)
+ /** 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.
*/
- ContentKind content_kind () const {
- return _content_kind;
- }
+ bool equals (DCP const & other, EqualityOptions options, NoteHandler note) const;
- /** @return the number of frames per second */
- int frames_per_second () const {
- return _fps;
- }
+ void add (boost::shared_ptr<CPL> cpl);
- /** @return the length in frames */
- int length () const {
- return _length;
- }
+ std::list<boost::shared_ptr<CPL> > cpls () const;
+ std::list<boost::shared_ptr<Asset> > assets () const;
- std::list<boost::shared_ptr<const Reel> > reels () const {
- return _reels;
- }
+ bool encrypted () const;
- /** 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.
- * @return An empty list if the DCPs are equal; otherwise a list of messages
- * which explain the ways in which they differ.
- */
- std::list<std::string> equals (DCP const & other, EqualityOptions options) const;
+ void add (DecryptedKDM const &);
- /** Emitted with a parameter between 0 and 1 to indicate progress
- * for long jobs.
- */
- sigc::signal1<void, float> Progress;
+ void write_xml (
+ Standard standard,
+ XMLMetadata metadata = XMLMetadata (),
+ boost::shared_ptr<const Signer> signer = boost::shared_ptr<const Signer> ()
+ );
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;
-
- /** Write the VOLINDEX file */
- void write_volindex () const;
+ boost::filesystem::path write_pkl (
+ Standard standard,
+ std::string pkl_uuid,
+ XMLMetadata metadata,
+ boost::shared_ptr<const Signer> signer
+ ) 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;
-
- struct Files {
- std::string cpl;
- std::string pkl;
- std::string asset_map;
- std::list<std::string> subtitles;
- };
-
- void scan (Files& files, std::string directory) 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;
- /** reels */
- std::list<boost::shared_ptr<const Reel> > _reels;
+ boost::filesystem::path _directory;
+ /** the CPLs that make up this DCP */
+ std::list<boost::shared_ptr<CPL> > _cpls;
};
}
projects / libdcp.git / blobdiff