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 /** @param file File name
40 * @param mxf true if `file' is a MXF, or false if it is an XML file.
42 SMPTESubtitleAsset (boost::filesystem::path file, bool mxf = true);
45 boost::shared_ptr<const Asset>,
50 std::list<boost::shared_ptr<LoadFontNode> > load_font_nodes () const;
52 Glib::ustring xml_as_string () const;
53 void write (boost::filesystem::path path) const;
55 /** @return title of the film that these subtitles are for,
56 * to be presented to the user.
58 std::string content_title_text () const {
59 return _content_title_text;
62 /** @return language as a xs:language, if one was specified */
63 boost::optional<std::string> language () const {
67 /** @return annotation text, to be presented to the user */
68 boost::optional<std::string> annotation_text () const {
69 return _annotation_text;
72 /** @return file creation time and date */
73 LocalTime issue_date () const {
77 Fraction edit_rate () const {
81 /** @return subdivision of 1 second that is used for subtitle times;
82 * e.g. a time_code_rate of 250 means that a subtitle time of 0:0:0:001
85 int time_code_rate () const {
86 return _time_code_rate;
89 boost::optional<Time> start_time () const {
93 static bool valid_mxf (boost::filesystem::path);
97 std::string pkl_type (Standard) const {
98 return "application/mxf";
102 std::string _content_title_text;
103 boost::optional<std::string> _language;
104 boost::optional<std::string> _annotation_text;
105 LocalTime _issue_date;
106 boost::optional<int> _reel_number;
109 boost::optional<Time> _start_time;
111 std::list<boost::shared_ptr<SMPTELoadFontNode> > _load_font_nodes;