/*
- 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 "certificate.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 Content;
+class Reel;
+class CPL;
+class XMLMetadata;
+class Signer;
+class DecryptedKDM;
+class Asset;
+class DCPReadError;
-/** @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.
- * @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.
+ /** 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.
*/
- DCP (std::string directory, std::string name, ContentKind content_kind, int fps, int length);
+ DCP (boost::filesystem::path directory);
- DCP (std::string directory);
+ typedef std::list<boost::shared_ptr<DCPReadError> > ReadErrors;
- /** 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.
+ /** 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_sound_asset (std::vector<std::string> const & files);
+ void read (bool keep_going = false, ReadErrors* errors = 0);
- /** Add a sound asset.
- * @param get_path Functor to get the path to the WAV for a given channel.
- * @param channels Number of channels.
+ /** 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_sound_asset (sigc::slot<std::string, Channel> get_path, int channels);
+ bool equals (DCP const & other, EqualityOptions options, NoteHandler note) const;
- /** 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.
- */
- void add_picture_asset (std::vector<std::string> const & files, int width, int height);
-
- /** 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.
- */
- void add_picture_asset (sigc::slot<std::string, int> get_path, int width, int height);
+ void add (boost::shared_ptr<CPL> cpl);
- /** Write the required XML files to the directory that was
- * passed into the constructor.
- */
- void write_xml () const;
+ std::list<boost::shared_ptr<CPL> > cpls () const;
+ std::list<boost::shared_ptr<Asset> > assets () const;
- std::string name () const {
- return _name;
- }
+ bool encrypted () const;
- ContentKind content_kind () const {
- return _content_kind;
- }
+ void add (DecryptedKDM const &);
- int frames_per_second () const {
- return _fps;
- }
-
- int length () const {
- return _length;
- }
-
- boost::shared_ptr<const PictureAsset> picture_asset () const;
-
- std::list<std::string> equals (DCP const & other, EqualityOptions options) 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;
+ 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 */
- std::list<boost::shared_ptr<Asset> > _assets;
+ boost::filesystem::path _directory;
+ /** the CPLs that make up this DCP */
+ std::list<boost::shared_ptr<CPL> > _cpls;
};
}
projects / libdcp.git / blobdiff