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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
/*
Copyright (C) 2012-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/interop_text_asset.h
* @brief InteropTextAsset class
*/
#ifndef LIBDCP_INTEROP_TEXT_ASSET_H
#define LIBDCP_INTEROP_TEXT_ASSET_H
#include "text_asset.h"
#include "subtitle_standard.h"
#include <boost/filesystem.hpp>
namespace dcp {
class InteropLoadFontNode;
/** @class InteropTextAsset
* @brief A set of subtitles to be read and/or written in the Inter-Op format
*
* Inter-Op subtitles are sometimes known as CineCanvas.
*/
class InteropTextAsset : public TextAsset
{
public:
InteropTextAsset();
explicit InteropTextAsset(boost::filesystem::path file);
bool equals (
std::shared_ptr<const Asset>,
EqualityOptions const&,
NoteHandler note
) const override;
void add_to_assetmap (AssetMap& asset_map, boost::filesystem::path root) const override;
void add_to_pkl (std::shared_ptr<PKL> pkl, boost::filesystem::path root) const override;
std::vector<std::shared_ptr<LoadFontNode>> load_font_nodes () const override;
void add_font (std::string load_id, dcp::ArrayData data) override;
std::string xml_as_string () const override;
/** Write this content to an XML file with its fonts alongside */
void write (boost::filesystem::path path) const override;
void resolve_fonts (std::vector<std::shared_ptr<Asset>> assets);
void set_font_file (std::string load_id, boost::filesystem::path file);
std::vector<std::shared_ptr<Asset>> font_assets();
std::vector<std::shared_ptr<const Asset>> font_assets() const;
/** @return the <LoadFont> IDs of fonts for which we have not (yet) found a font asset.
* This could be because resolve_fonts() has not yet been called, or because there is
* a missing font file.
*/
std::vector<std::string> unresolved_fonts() const;
/** Set the reel number or sub-element identifier
* of these subtitles.
* @param n New reel number.
*/
void set_reel_number (std::string n) {
_reel_number = n;
}
/** Set the language tag of these subtitles.
* @param l New language.
*/
void set_language (std::string l) {
_language = l;
}
/** @return title of the movie that the subtitles are for */
void set_movie_title (std::string m) {
_movie_title = m;
}
/** @return reel number or sub-element of a programme that
* these subtitles refer to.
*/
std::string reel_number () const {
return _reel_number;
}
/** @return language used in the subtitles */
std::string language () const {
return _language;
}
/** @return movie title that these subtitles are for */
std::string movie_title () const {
return _movie_title;
}
int time_code_rate () const override {
/* Interop can use either; just pick one */
return 1000;
}
SubtitleStandard subtitle_standard() const override {
return SubtitleStandard::INTEROP;
}
static std::string static_pkl_type (Standard) {
return "text/xml;asdcpKind=Subtitle";
}
protected:
std::string pkl_type (Standard s) const override {
return static_pkl_type (s);
}
private:
std::string _reel_number;
std::string _language;
std::string _movie_title;
std::vector<std::shared_ptr<InteropLoadFontNode>> _load_font_nodes;
};
}
#endif
|
