2 Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 /** @file src/smpte_subtitle_asset.h
21 * @brief SMPTESubtitleAsset class.
24 #include "subtitle_asset.h"
25 #include "local_time.h"
27 #include <boost/filesystem.hpp>
31 class SMPTELoadFontNode;
33 /** @class SMPTESubtitleAsset
34 * @brief A set of subtitles to be read and/or written in the SMPTE format.
36 class SMPTESubtitleAsset : public SubtitleAsset, public MXF
39 SMPTESubtitleAsset ();
41 /** @param file File name
43 SMPTESubtitleAsset (boost::filesystem::path file);
46 boost::shared_ptr<const Asset>,
51 std::list<boost::shared_ptr<LoadFontNode> > load_font_nodes () const;
53 Glib::ustring xml_as_string () const;
54 void write (boost::filesystem::path path) const;
55 void add_font (std::string id, boost::filesystem::path file);
57 void set_content_title_text (std::string t) {
58 _content_title_text = t;
61 void set_language (std::string l) {
65 void set_edit_rate (Fraction e) {
69 void set_time_code_rate (int t) {
73 /** @return title of the film that these subtitles are for,
74 * to be presented to the user.
76 std::string content_title_text () const {
77 return _content_title_text;
80 /** @return language as a xs:language, if one was specified */
81 boost::optional<std::string> language () const {
85 /** @return annotation text, to be presented to the user */
86 boost::optional<std::string> annotation_text () const {
87 return _annotation_text;
90 /** @return file creation time and date */
91 LocalTime issue_date () const {
95 boost::optional<int> reel_number () const {
99 Fraction edit_rate () const {
103 /** @return subdivision of 1 second that is used for subtitle times;
104 * e.g. a time_code_rate of 250 means that a subtitle time of 0:0:0:001
107 int time_code_rate () const {
108 return _time_code_rate;
111 boost::optional<Time> start_time () const {
115 static bool valid_mxf (boost::filesystem::path);
119 std::string pkl_type (Standard) const {
120 return "application/mxf";
124 std::string _content_title_text;
125 boost::optional<std::string> _language;
126 boost::optional<std::string> _annotation_text;
127 LocalTime _issue_date;
128 boost::optional<int> _reel_number;
131 boost::optional<Time> _start_time;
133 std::list<boost::shared_ptr<SMPTELoadFontNode> > _load_font_nodes;