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
|
/*
Copyright (C) 2014-2021 Carl Hetherington <cth@carlh.net>
This file is part of libdcp.
libdcp 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.
libdcp 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 libdcp. If not, see <http://www.gnu.org/licenses/>.
In addition, as a special exception, the copyright holders give
permission to link the code of portions of this program with the
OpenSSL library under certain conditions as described in each
individual source file, and distribute linked combinations
including the two.
You must obey the GNU General Public License in all respects
for all of the code used other than OpenSSL. If you modify
file(s) with this exception, you may extend this exception to your
version of the file(s), but you are not obligated to do so. If you
do not wish to do so, delete this exception statement from your
version. If you delete this exception statement from all source
files in the program, then also delete it here.
*/
/** @file src/asset.h
* @brief Asset class
*/
#ifndef LIBDCP_ASSET_H
#define LIBDCP_ASSET_H
#include "object.h"
#include "types.h"
#include "pkl.h"
#include <boost/filesystem.hpp>
#include <boost/function.hpp>
#include <boost/optional.hpp>
namespace xmlpp {
class Node;
}
struct asset_test;
namespace dcp {
/** @class Asset
* @brief Parent class for DCP assets, i.e. picture, sound, subtitles, closed captions, CPLs, fonts
*
* Note that this class is not used for ReelAssets; those are just for the metadata
* that gets put into <Reel>s.
*/
class Asset : public Object
{
public:
/** Create an Asset with a randomly-generated ID */
Asset ();
/** Create an Asset from a given file with a randomly-generated ID
* @param file File name
*/
explicit Asset (boost::filesystem::path file);
/** Create an Asset from a given file with a given ID
* @param id ID
* @param file File name
*/
Asset (std::string id, boost::filesystem::path file);
virtual bool equals (
std::shared_ptr<const Asset> other,
EqualityOptions opt,
NoteHandler note
) const;
virtual void write_to_assetmap (xmlpp::Node* node, boost::filesystem::path root) const;
virtual void add_to_pkl (std::shared_ptr<PKL> pkl, boost::filesystem::path root) const;
/** @return the most recent disk file used to read or write this asset, if there is one */
boost::optional<boost::filesystem::path> file () const {
return _file;
}
/** Set the file that holds this asset on disk. Calling this function
* clears this object's store of its hash, so you should call ::hash
* after this.
*
* @param file New file's path.
*/
void set_file (boost::filesystem::path file) const;
/** Calculate the hash of this asset's file, if it has not already been calculated,
* then return it
* @param progress Function that will be called with a parameter between 0 and 1 to indicate
* progress in the calculation
* @return the hash
*/
std::string hash (boost::function<void (float)> progress = {}) const;
void set_hash (std::string hash);
protected:
/** The most recent disk file used to read or write this asset */
mutable boost::optional<boost::filesystem::path> _file;
static void write_file_to_assetmap (xmlpp::Node* node, boost::filesystem::path root, boost::filesystem::path file, std::string id);
private:
friend struct ::asset_test;
/** @return type string for PKLs for this asset */
virtual std::string pkl_type (Standard standard) const = 0;
/** Hash of _file if it has been computed */
mutable boost::optional<std::string> _hash;
};
}
#endif
|
