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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
/*
Copyright (C) 2012-2015 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/smpte_subtitle_asset.h
* @brief SMPTESubtitleAsset class.
*/
#include "subtitle_asset.h"
#include "local_time.h"
#include "mxf.h"
#include <boost/filesystem.hpp>
namespace ASDCP {
namespace TimedText {
class MXFReader;
}
}
namespace dcp {
class SMPTELoadFontNode;
class DecryptionContext;
/** @class SMPTESubtitleAsset
* @brief A set of subtitles to be read and/or written in the SMPTE format.
*/
class SMPTESubtitleAsset : public SubtitleAsset, public MXF
{
public:
SMPTESubtitleAsset ();
/** @param file File name
*/
explicit SMPTESubtitleAsset (boost::filesystem::path file);
bool equals (
boost::shared_ptr<const Asset>,
EqualityOptions,
NoteHandler note
) const;
std::list<boost::shared_ptr<LoadFontNode> > load_font_nodes () const;
std::string xml_as_string () const;
void write (boost::filesystem::path path) const;
void add (SubtitleString);
void add_font (std::string id, boost::filesystem::path file);
void set_key (Key key);
void set_content_title_text (std::string t) {
_content_title_text = t;
}
void set_language (std::string l) {
_language = l;
}
void set_issue_date (LocalTime t) {
_issue_date = t;
}
void set_reel_number (int r) {
_reel_number = r;
}
void set_edit_rate (Fraction e) {
_edit_rate = e;
}
void set_time_code_rate (int t) {
_time_code_rate = t;
}
void set_start_time (Time t) {
_start_time = t;
}
void set_intrinsic_duration (int64_t d) {
_intrinsic_duration = d;
}
/** @return title of the film that these subtitles are for,
* to be presented to the user.
*/
std::string content_title_text () const {
return _content_title_text;
}
/** @return language as a xs:language, if one was specified */
boost::optional<std::string> language () const {
return _language;
}
/** @return annotation text, to be presented to the user */
boost::optional<std::string> annotation_text () const {
return _annotation_text;
}
/** @return file creation time and date */
LocalTime issue_date () const {
return _issue_date;
}
boost::optional<int> reel_number () const {
return _reel_number;
}
Fraction edit_rate () const {
return _edit_rate;
}
/** @return subdivision of 1 second that is used for subtitle times;
* e.g. a time_code_rate of 250 means that a subtitle time of 0:0:0:001
* represents 4ms.
*/
int time_code_rate () const {
return _time_code_rate;
}
boost::optional<Time> start_time () const {
return _start_time;
}
static bool valid_mxf (boost::filesystem::path);
protected:
std::string pkl_type (Standard) const {
return "application/mxf";
}
private:
void read_fonts (boost::shared_ptr<ASDCP::TimedText::MXFReader>);
void parse_xml (boost::shared_ptr<cxml::Document> xml);
void read_mxf_descriptor (boost::shared_ptr<ASDCP::TimedText::MXFReader> reader, boost::shared_ptr<DecryptionContext> dec);
/** The total length of this content in video frames. The amount of
* content presented may be less than this.
*/
int64_t _intrinsic_duration;
/** <ContentTitleText> from the asset */
std::string _content_title_text;
boost::optional<std::string> _language;
boost::optional<std::string> _annotation_text;
LocalTime _issue_date;
boost::optional<int> _reel_number;
Fraction _edit_rate;
int _time_code_rate;
boost::optional<Time> _start_time;
std::list<boost::shared_ptr<SMPTELoadFontNode> > _load_font_nodes;
};
}
|