1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
/*
Copyright (C) 2012 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
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
/** @file src/dcp.h
* @brief A class to create a DCP.
*/
#ifndef LIBDCP_DCP_H
#define LIBDCP_DCP_H
#include <string>
#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 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:
/** 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 (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:
/** Write the PKL file.
* @param pkl_uuid UUID to use.
*/
std::string write_pkl (std::string pkl_uuid, XMLMetadata const &, boost::shared_ptr<Encryption>) const;
/** Write the VOLINDEX file */
void write_volindex () const;
/** 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, XMLMetadata const &) 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;
/** our CPLs */
std::list<boost::shared_ptr<CPL> > _cpls;
};
}
#endif
|
