2 Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 * @brief A class to create a DCP.
29 #include <boost/shared_ptr.hpp>
30 #include <boost/signals2.hpp>
32 #include "certificates.h"
38 /** @brief Namespace for everything in libdcp */
52 CPL (std::string directory, std::string name, ContentKind content_kind, int length, int frames_per_second);
53 CPL (std::string directory, std::string file, boost::shared_ptr<const AssetMap> asset_map, bool require_mxfs = true);
55 void add_reel (boost::shared_ptr<const Reel> reel);
57 /** @return the length in frames */
62 /** @return the type of the content, used by media servers
63 * to categorise things (e.g. feature, trailer, etc.)
65 ContentKind content_kind () const {
69 std::list<boost::shared_ptr<const Reel> > reels () const {
73 /** @return the CPL's name, as will be presented on projector
74 * media servers and theatre management systems.
76 std::string name () const {
80 /** @return the number of frames per second */
81 int frames_per_second () const {
85 std::list<boost::shared_ptr<const Asset> > assets () const;
87 bool equals (CPL const & other, EqualityOptions options, std::list<std::string>& notes) const;
89 void write_xml (bool, CertificateChain const &) const;
90 void write_to_assetmap (std::ostream& s) const;
91 void write_to_pkl (std::ostream& s) const;
94 std::string _directory;
95 /** the name of the DCP */
97 /** the content kind of the CPL */
98 ContentKind _content_kind;
99 /** length in frames */
101 /** frames per second */
104 std::list<boost::shared_ptr<const Reel> > _reels;
107 mutable std::string _digest;
110 /** @class DCP dcp.h libdcp/dcp.h
111 * @brief A class to create or read a DCP.
117 /** Construct a DCP. You can pass an existing DCP's directory
118 * as the parameter, or a non-existant folder to create a new
121 * @param directory Directory containing the DCP's files.
123 DCP (std::string directory);
125 /** Read an existing DCP's data.
127 * The DCP's XML metadata will be examined, and you can then look at the contents
130 * @param require_mxfs true to throw an exception if MXF files are missing; setting to false
131 * can be useful for testing, but normally it should be set to true.
133 void read (bool require_mxfs = true);
135 /** Write the required XML files to the directory that was
136 * passed into the constructor.
138 void write_xml () const;
140 /** Compare this DCP with another, according to various options.
141 * @param other DCP to compare this one to.
142 * @param options Options to define just what "equality" means.
143 * @param notes Filled in with notes about differences.
144 * @return true if the DCPs are equal according to EqualityOptions, otherwise false.
146 bool equals (DCP const & other, EqualityOptions options, std::list<std::string>& notes) const;
148 void add_cpl (boost::shared_ptr<CPL> cpl);
150 std::list<boost::shared_ptr<const CPL> > cpls () const {
154 /** Emitted with a parameter between 0 and 1 to indicate progress
157 boost::signals2::signal<void (float)> Progress;
161 /** Write the PKL file.
162 * @param pkl_uuid UUID to use.
164 std::string write_pkl (std::string pkl_uuid) const;
166 /** Write the VOLINDEX file */
167 void write_volindex () const;
169 /** Write the ASSETMAP file.
170 * @param pkl_uuid UUID of our PKL.
171 * @param pkl_length Length of our PKL in bytes.
173 void write_assetmap (std::string pkl_uuid, int pkl_length) const;
175 std::list<boost::shared_ptr<const Asset> > assets () const;
178 std::list<std::string> cpls;
180 std::string asset_map;
183 /** the directory that we are writing to */
184 std::string _directory;
185 std::list<boost::shared_ptr<const CPL> > _cpls;
188 CertificateChain _certificates;