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
|
/*
Copyright (C) 2012-2015 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/smpte_subtitle_asset.h
* @brief SMPTESubtitleAsset class.
*/
#include "subtitle_asset.h"
#include "local_time.h"
#include "mxf.h"
#include <boost/filesystem.hpp>
namespace dcp {
class SMPTELoadFontNode;
/** @class SMPTESubtitleAsset
* @brief A set of subtitles to be read and/or written in the SMPTE format.
*/
class SMPTESubtitleAsset : public SubtitleAsset, public MXF
{
public:
/** @param file File name
* @param mxf true if `file' is a MXF, or false if it is an XML file.
*/
SMPTESubtitleAsset (boost::filesystem::path file, bool mxf = true);
bool equals (
boost::shared_ptr<const Asset>,
EqualityOptions,
NoteHandler note
) const;
std::list<boost::shared_ptr<LoadFontNode> > load_font_nodes () const;
Glib::ustring xml_as_string () const;
void write (boost::filesystem::path path) const;
/** @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:
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;
};
}
|
