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
|
/*
Copyright (C) 2012-2014 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 DCP class.
*/
#ifndef LIBDCP_DCP_H
#define LIBDCP_DCP_H
#include "types.h"
#include "certificates.h"
#include "metadata.h"
#include <boost/shared_ptr.hpp>
#include <boost/signals2.hpp>
#include <string>
#include <vector>
namespace xmlpp {
class Document;
class Element;
}
/** @brief Namespace for everything in libdcp */
namespace dcp
{
class Content;
class Reel;
class CPL;
class XMLMetadata;
class Signer;
class KDM;
class Asset;
namespace parse {
class AssetMap;
}
/** @class DCP
* @brief A class to create or read a DCP.
*/
class DCP : public boost::noncopyable
{
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 (boost::filesystem::path directory);
void read ();
/** 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.
* @param note Functor to handle notes made by the equality operation.
* @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;
void add (boost::shared_ptr<Asset> asset);
std::list<boost::shared_ptr<CPL> > cpls () const;
bool encrypted () const;
void add (KDM const &);
void write_xml (
Standard standard,
XMLMetadata metadata = XMLMetadata (),
boost::shared_ptr<const Signer> signer = boost::shared_ptr<const Signer> ()
);
/** 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.
*/
boost::filesystem::path write_pkl (Standard standard, std::string pkl_uuid, XMLMetadata metadata, boost::shared_ptr<const Signer> signer) const;
void write_volindex (Standard standard) const;
/** Write the ASSETMAP file.
* @param pkl_uuid UUID of our PKL.
* @param pkl_length Length of our PKL in bytes.
*/
void write_assetmap (Standard standard, std::string pkl_uuid, int pkl_length, XMLMetadata metadata) const;
/** the directory that we are writing to */
boost::filesystem::path _directory;
/** the assets that make up this DCP */
std::list<boost::shared_ptr<Asset> > _assets;
};
}
#endif
|
