2 Copyright (C) 2012-2014 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 #ifndef LIBDCP_SUBTITLE_CONTENT_H
21 #define LIBDCP_SUBTITLE_CONTENT_H
25 #include "subtitle_string.h"
26 #include <libcxml/cxml.h>
37 /** @class SubtitleContent
38 * @brief A representation of an XML or MXF file containing subtitles.
40 * XXX: perhaps this should inhert from MXF, or there should be different
41 * classes for XML and MXF subs.
43 class SubtitleContent : public Content
46 /** Construct a SubtitleContent.
47 * @param file Filename.
48 * @param mxf true if the file is an MXF file, false for XML.
50 SubtitleContent (boost::filesystem::path file, bool mxf);
51 SubtitleContent (std::string movie_title, std::string language);
54 boost::shared_ptr<const Asset>,
56 boost::function<void (NoteType, std::string)> note
59 note (DCP_ERROR, "subtitle content not compared yet");
63 std::string language () const {
67 std::list<SubtitleString> subtitles_at (Time t) const;
68 std::list<SubtitleString> const & subtitles () const {
72 void add (SubtitleString);
74 void write_xml (boost::filesystem::path) const;
75 Glib::ustring xml_as_string () const;
77 Time latest_subtitle_out () const;
80 std::string pkl_type (Standard) const {
84 std::string asdcp_kind () const {
89 std::string font_id_to_name (std::string id) const;
92 std::list<boost::shared_ptr<Font> > font_nodes;
93 std::list<boost::shared_ptr<Text> > text_nodes;
94 std::list<boost::shared_ptr<Subtitle> > subtitle_nodes;
97 void maybe_add_subtitle (std::string text, ParseState const & parse_state);
99 void examine_font_nodes (
100 boost::shared_ptr<const cxml::Node> xml,
101 std::list<boost::shared_ptr<Font> > const & font_nodes,
102 ParseState& parse_state
105 void examine_text_nodes (
106 boost::shared_ptr<const cxml::Node> xml,
107 std::list<boost::shared_ptr<Text> > const & text_nodes,
108 ParseState& parse_state
111 boost::optional<std::string> _movie_title;
112 /* strangely, this is sometimes a string */
113 std::string _reel_number;
114 std::string _language;
115 std::list<boost::shared_ptr<LoadFont> > _load_font_nodes;
117 std::list<SubtitleString> _subtitles;