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>
37 /** @brief Namespace for everything in libdcp */
51 * @brief A class to create or read a DCP.
57 /** Construct a DCP. You can pass an existing DCP's directory
58 * as the parameter, or a non-existant folder to create a new
61 * @param directory Directory containing the DCP's files.
63 DCP (std::string directory);
65 /** Read an existing DCP's data.
67 * The DCP's XML metadata will be examined, and you can then look at the contents
70 * @param require_mxfs true to throw an exception if MXF files are missing; setting to false
71 * can be useful for testing, but normally it should be set to true.
73 void read (bool require_mxfs = true);
75 /** Write the required XML files to the directory that was
76 * passed into the constructor.
78 void write_xml (XMLMetadata const &) const;
80 /** Compare this DCP with another, according to various options.
81 * @param other DCP to compare this one to.
82 * @param options Options to define what "equality" means.
83 * @return true if the DCPs are equal according to EqualityOptions, otherwise false.
85 bool equals (DCP const & other, EqualityOptions options, boost::function<void (NoteType, std::string)> note) const;
87 /** Add a CPL to this DCP.
88 * @param cpl CPL to add.
90 void add_cpl (boost::shared_ptr<CPL> cpl);
92 /** @return The list of CPLs in this DCP */
93 std::list<boost::shared_ptr<const CPL> > cpls () const {
97 /** Emitted with a parameter between 0 and 1 to indicate progress
100 boost::signals2::signal<void (float)> Progress;
104 /** Write the PKL file.
105 * @param pkl_uuid UUID to use.
107 std::string write_pkl (std::string pkl_uuid, XMLMetadata const &) const;
109 /** Write the VOLINDEX file */
110 void write_volindex () const;
112 /** Write the ASSETMAP file.
113 * @param pkl_uuid UUID of our PKL.
114 * @param pkl_length Length of our PKL in bytes.
116 void write_assetmap (std::string pkl_uuid, int pkl_length, XMLMetadata const &) const;
118 /** @return Assets in all this CPLs in this DCP */
119 std::list<boost::shared_ptr<const Asset> > assets () const;
122 std::list<std::string> cpls;
124 std::string asset_map;
127 /** the directory that we are writing to */
128 std::string _directory;
130 std::list<boost::shared_ptr<const CPL> > _cpls;