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-2016 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/package.h
* @brief Package class.
*/
#ifndef LIBDCP_PACKAGE_H
#define LIBDCP_PACKAGE_H
#include "types.h"
#include "certificate.h"
#include "metadata.h"
#include "dcp_assert.h"
#include <boost/shared_ptr.hpp>
#include <boost/signals2.hpp>
#include <boost/foreach.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 CertificateChain;
class DecryptedKDM;
class Asset;
class PackageReadError;
/** @class Package
* @brief A class to create or read a package.
*/
class Package : public boost::noncopyable
{
public:
/** Construct a package. You can pass an existing package's directory
* as the parameter; alternatively, directory will be created
* if it does not exist. Note that if you pass an existing package
* into this constructor it will not be read until you call ::read().
*
* @param directory Directory containing the package's files.
*/
Package (boost::filesystem::path directory);
typedef std::list<boost::shared_ptr<PackageReadError> > ReadErrors;
/** Read the package's structure into this object.
* @param keep_going true to try to keep going in the face of (some) errors.
* @param errors List of errors that will be added to if keep_going is true.
*/
void read (bool keep_going = false, ReadErrors* errors = 0);
/** Compare this package with another, according to various options.
* @param other package 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 packages are equal according to EqualityOptions, otherwise false.
*/
bool equals (Package const & other, EqualityOptions options, NoteHandler note) const;
void add (boost::shared_ptr<CPL> cpl);
bool encrypted () const;
void add (DecryptedKDM const &);
void resolve_refs (std::list<boost::shared_ptr<Asset> > assets);
virtual std::list<boost::shared_ptr<Asset> > assets () const = 0;
protected:
/** 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 CertificateChain> 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;
template <class T>
std::list<boost::shared_ptr<T> >
cpls_of_type () const
{
std::list<boost::shared_ptr<T> > cpls;
BOOST_FOREACH (boost::shared_ptr<CPL> i, _cpls) {
boost::shared_ptr<T> t = boost::dynamic_pointer_cast<T> (i);
DCP_ASSERT (t);
cpls.push_back (t);
}
return cpls;
}
/** the directory that we are writing to */
boost::filesystem::path _directory;
/** the CPLs that make up this package */
std::list<boost::shared_ptr<CPL> > _cpls;
private:
virtual boost::shared_ptr<CPL> read_cpl (boost::filesystem::path file) const = 0;
};
}
#endif
|
