*/
+/** @file src/dcp.h
+ * @brief A class to create a DCP.
+ */
+
+#ifndef LIBDCP_DCP_H
+#define LIBDCP_DCP_H
+
#include <string>
-#include <list>
+#include <vector>
#include <boost/shared_ptr.hpp>
+#include <boost/signals2.hpp>
+#include "types.h"
+#include "certificates.h"
+
+namespace xmlpp {
+ class Document;
+ class Element;
+}
+/** @brief Namespace for everything in libdcp */
namespace libdcp
{
class Asset;
-
-class DCP
+class PictureAsset;
+class SoundAsset;
+class SubtitleAsset;
+class Reel;
+class CPL;
+class XMLMetadata;
+class Encryption;
+class KDM;
+
+/** @class DCP
+ * @brief A class to create or read a DCP.
+ */
+
+class DCP : public boost::noncopyable
{
public:
- enum ContentType
- {
- FEATURE,
- SHORT,
- TRAILER,
- TEST,
- TRANSITIONAL,
- RATING,
- TEASER,
- POLICY,
- PUBLIC_SERVICE_ANNOUNCEMENT,
- ADVERTISEMENT
- };
-
- DCP (std::string, std::string, ContentType, int, int);
-
- void add_sound_asset (std::list<std::string> const &);
- void add_picture_asset (std::list<std::string> const &, int, int);
-
- void write_xml () const;
+ /** 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.
+ *
+ * @param directory Directory containing the DCP's files.
+ */
+ DCP (std::string 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 (bool interop, XMLMetadata const &, boost::shared_ptr<Encryption> crypt = boost::shared_ptr<Encryption> ()) const;
+
+ /** 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.
+ * @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);
+
+ /** @return The list of CPLs in this DCP */
+ std::list<boost::shared_ptr<CPL> > cpls () const {
+ return _cpls;
+ }
+
+ bool encrypted () const;
+
+ void add_kdm (KDM const &);
+
+ /** Emitted with a parameter between 0 and 1 to indicate progress
+ * for long jobs.
+ */
+ boost::signals2::signal<void (float)> Progress;
private:
- std::string write_cpl (std::string) const;
- std::string write_pkl (std::string, std::string, std::string, int) const;
+ /** Write the PKL file.
+ * @param pkl_uuid UUID to use.
+ */
+ std::string write_pkl (std::string pkl_uuid, bool, XMLMetadata const &, boost::shared_ptr<Encryption>) const;
+
+ /** Write the VOLINDEX file */
void write_volindex () const;
- void write_assetmap (std::string, int, std::string, int) const;
- static std::string content_type_string (ContentType);
+ /** 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, bool, XMLMetadata const &) const;
- std::string _directory;
- std::string _name;
- ContentType _content_type;
- int _fps;
- int _length;
- std::list<boost::shared_ptr<Asset> > _assets;
+ /** @return Assets in all this CPLs in this DCP */
+ std::list<boost::shared_ptr<const Asset> > assets () const;
- std::string _date;
+ struct Files {
+ std::list<std::string> cpls;
+ std::string pkl;
+ std::string asset_map;
+ };
+
+ /** the directory that we are writing to */
+ std::string _directory;
+ /** our CPLs */
+ std::list<boost::shared_ptr<CPL> > _cpls;
};
}
+
+#endif
projects / libdcp.git / blobdiff