#include <string>
#include <vector>
#include <boost/shared_ptr.hpp>
-#include <sigc++/sigc++.h>
+#include <boost/signals2.hpp>
#include "types.h"
namespace xmlpp {
{
class Asset;
+class PictureAsset;
+class SoundAsset;
+class SubtitleAsset;
+class Reel;
+class AssetMap;
+
+/** @brief A CPL within a DCP */
+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, boost::function<void (NoteType, std::string)> note) const;
+
+ void write_xml () const;
+ void write_to_assetmap (std::ostream& s) const;
+ void write_to_pkl (std::ostream& s) 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;
+
+ /** our UUID */
+ std::string _uuid;
+ /** a SHA1 digest of our XML */
+ mutable std::string _digest;
+};
/** @class DCP dcp.h libdcp/dcp.h
* @brief A class to create or read a DCP.
class DCP
{
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, or a non-existant folder to create a new
+ * DCP in.
+ *
+ * @param directory Directory containing the DCP's files.
*/
- DCP (std::string directory, std::string name, ContentKind content_kind, int fps, int length);
-
DCP (std::string directory);
- /** 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.
- */
- void add_sound_asset (std::vector<std::string> const & files);
-
- /** Add a sound asset.
- * @param get_path Functor to get the path to the WAV for a given channel.
- * @param channels Number of channels.
- */
- void add_sound_asset (sigc::slot<std::string, Channel> get_path, int channels);
-
- /** 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.
+ /** 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 add_picture_asset (sigc::slot<std::string, int> get_path, int width, int height);
+ void read (bool require_mxfs = true);
/** Write the required XML files to the directory that was
* passed into the constructor.
*/
void write_xml () const;
- std::string name () const {
- return _name;
- }
-
- ContentKind content_kind () const {
- return _content_kind;
- }
+ /** 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;
- int frames_per_second () const {
- return _fps;
- }
+ /** Add a CPL to this DCP.
+ * @param cpl CPL to add.
+ */
+ void add_cpl (boost::shared_ptr<CPL> cpl);
- int length () const {
- return _length;
+ /** @return The list of CPLs in this DCP */
+ std::list<boost::shared_ptr<const CPL> > cpls () const {
+ return _cpls;
}
- 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;
+ boost::signals2::signal<void (float)> Progress;
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;
+ std::string write_pkl (std::string pkl_uuid) const;
/** Write the VOLINDEX file */
void write_volindex () 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 (std::string pkl_uuid, int pkl_length) const;
+
+ /** @return Assets in all this 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;
+ };
/** 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;
+ /** our CPLs */
+ std::list<boost::shared_ptr<const CPL> > _cpls;
};
}
projects / libdcp.git / blobdiff