2 Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
4 This file is part of libdcp.
6 libdcp is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 libdcp is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with libdcp. If not, see <http://www.gnu.org/licenses/>.
19 In addition, as a special exception, the copyright holders give
20 permission to link the code of portions of this program with the
21 OpenSSL library under certain conditions as described in each
22 individual source file, and distribute linked combinations
25 You must obey the GNU General Public License in all respects
26 for all of the code used other than OpenSSL. If you modify
27 file(s) with this exception, you may extend this exception to your
28 version of the file(s), but you are not obligated to do so. If you
29 do not wish to do so, delete this exception statement from your
30 version. If you delete this exception statement from all source
31 files in the program, then also delete it here.
34 /** @file src/smpte_subtitle_asset.h
35 * @brief SMPTESubtitleAsset class.
38 #include "subtitle_asset.h"
39 #include "local_time.h"
41 #include "crypto_context.h"
42 #include <boost/filesystem.hpp>
52 class SMPTELoadFontNode;
54 /** @class SMPTESubtitleAsset
55 * @brief A set of subtitles to be read and/or written in the SMPTE format.
57 class SMPTESubtitleAsset : public SubtitleAsset, public MXF
60 SMPTESubtitleAsset ();
62 /** @param file File name
64 explicit SMPTESubtitleAsset (boost::filesystem::path file);
67 boost::shared_ptr<const Asset>,
72 std::list<boost::shared_ptr<LoadFontNode> > load_font_nodes () const;
74 std::string xml_as_string () const;
75 void write (boost::filesystem::path path) const;
76 void add (SubtitleString);
77 void add_font (std::string id, boost::filesystem::path file);
78 void set_key (Key key);
80 void set_content_title_text (std::string t) {
81 _content_title_text = t;
84 void set_language (std::string l) {
88 void set_issue_date (LocalTime t) {
92 void set_reel_number (int r) {
96 void set_edit_rate (Fraction e) {
100 void set_time_code_rate (int t) {
104 void set_start_time (Time t) {
108 void set_intrinsic_duration (int64_t d) {
109 _intrinsic_duration = d;
112 /** @return title of the film that these subtitles are for,
113 * to be presented to the user.
115 std::string content_title_text () const {
116 return _content_title_text;
119 /** @return language as a xs:language, if one was specified */
120 boost::optional<std::string> language () const {
124 /** @return annotation text, to be presented to the user */
125 boost::optional<std::string> annotation_text () const {
126 return _annotation_text;
129 /** @return file creation time and date */
130 LocalTime issue_date () const {
134 boost::optional<int> reel_number () const {
138 Fraction edit_rate () const {
142 /** @return subdivision of 1 second that is used for subtitle times;
143 * e.g. a time_code_rate of 250 means that a subtitle time of 0:0:0:001
146 int time_code_rate () const {
147 return _time_code_rate;
150 boost::optional<Time> start_time () const {
154 std::string xml_id () const {
158 static bool valid_mxf (boost::filesystem::path);
162 std::string pkl_type (Standard) const {
163 return "application/mxf";
167 friend struct ::write_smpte_subtitle_test;
168 friend struct ::write_smpte_subtitle_test2;
170 void read_fonts (boost::shared_ptr<ASDCP::TimedText::MXFReader>);
171 void parse_xml (boost::shared_ptr<cxml::Document> xml);
172 void read_mxf_descriptor (boost::shared_ptr<ASDCP::TimedText::MXFReader> reader, boost::shared_ptr<DecryptionContext> dec);
174 /** The total length of this content in video frames. The amount of
175 * content presented may be less than this.
177 int64_t _intrinsic_duration;
178 /** <ContentTitleText> from the asset */
179 std::string _content_title_text;
180 boost::optional<std::string> _language;
181 boost::optional<std::string> _annotation_text;
182 LocalTime _issue_date;
183 boost::optional<int> _reel_number;
186 boost::optional<Time> _start_time;
188 std::list<boost::shared_ptr<SMPTELoadFontNode> > _load_font_nodes;
189 /** UUID for the XML inside the MXF, which should be different to the ID of the MXF according to
190 * Doremi's 2.8.18 release notes.