2 Copyright (C) 2014-2016 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 #include "text_subtitle_content.h"
22 #include "text_subtitle.h"
25 #include "raw_convert.h"
26 #include <libxml++/libxml++.h>
33 using boost::shared_ptr;
34 using boost::lexical_cast;
36 std::string const TextSubtitleContent::font_id = "font";
38 int const TextSubtitleContentProperty::TEXT_SUBTITLE_COLOUR = 300;
39 int const TextSubtitleContentProperty::TEXT_SUBTITLE_OUTLINE = 301;
40 int const TextSubtitleContentProperty::TEXT_SUBTITLE_OUTLINE_COLOUR = 302;
42 TextSubtitleContent::TextSubtitleContent (shared_ptr<const Film> film, boost::filesystem::path path)
43 : Content (film, path)
44 , SubtitleContent (film, path)
45 , _colour (255, 255, 255)
47 , _outline_colour (0, 0, 0)
52 TextSubtitleContent::TextSubtitleContent (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version)
53 : Content (film, node)
54 , SubtitleContent (film, node, version)
55 , _length (node->number_child<ContentTime::Type> ("Length"))
56 , _frame_rate (node->optional_number_child<double>("SubtitleFrameRate"))
58 node->optional_number_child<int>("Red").get_value_or(255),
59 node->optional_number_child<int>("Green").get_value_or(255),
60 node->optional_number_child<int>("Blue").get_value_or(255)
62 , _outline (node->optional_bool_child("Outline").get_value_or(false))
64 node->optional_number_child<int>("OutlineRed").get_value_or(255),
65 node->optional_number_child<int>("OutlineGreen").get_value_or(255),
66 node->optional_number_child<int>("OutlineBlue").get_value_or(255)
73 TextSubtitleContent::examine (boost::shared_ptr<Job> job)
75 Content::examine (job);
76 TextSubtitle s (shared_from_this ());
78 /* Default to turning these subtitles on */
79 set_use_subtitles (true);
81 boost::mutex::scoped_lock lm (_mutex);
82 _length = s.length ();
83 add_font (shared_ptr<Font> (new Font (font_id)));
87 TextSubtitleContent::summary () const
89 return path_summary() + " " + _("[subtitles]");
93 TextSubtitleContent::technical_summary () const
95 return Content::technical_summary() + " - " + _("Text subtitles");
99 TextSubtitleContent::as_xml (xmlpp::Node* node) const
101 node->add_child("Type")->add_child_text ("TextSubtitle");
102 Content::as_xml (node);
103 SubtitleContent::as_xml (node);
104 node->add_child("Length")->add_child_text (raw_convert<string> (_length.get ()));
105 node->add_child("Red")->add_child_text (raw_convert<string> (_colour.r));
106 node->add_child("Green")->add_child_text (raw_convert<string> (_colour.g));
107 node->add_child("Blue")->add_child_text (raw_convert<string> (_colour.b));
108 node->add_child("Outline")->add_child_text (raw_convert<string> (_outline));
109 node->add_child("OutlineRed")->add_child_text (raw_convert<string> (_outline_colour.r));
110 node->add_child("OutlineGreen")->add_child_text (raw_convert<string> (_outline_colour.g));
111 node->add_child("OutlineBlue")->add_child_text (raw_convert<string> (_outline_colour.b));
115 TextSubtitleContent::full_length () const
117 FrameRateChange const frc (subtitle_video_frame_rate(), film()->video_frame_rate ());
118 return DCPTime (_length, frc);
122 TextSubtitleContent::set_subtitle_video_frame_rate (int r)
125 boost::mutex::scoped_lock lm (_mutex);
129 signal_changed (SubtitleContentProperty::SUBTITLE_VIDEO_FRAME_RATE);
133 TextSubtitleContent::subtitle_video_frame_rate () const
136 boost::mutex::scoped_lock lm (_mutex);
138 return _frame_rate.get ();
142 /* No frame rate specified, so assume this content has been
143 prepared for any concurrent video content.
145 return film()->active_frame_rate_change(position()).source;
149 TextSubtitleContent::set_colour (dcp::Colour colour)
152 boost::mutex::scoped_lock lm (_mutex);
153 if (_colour == colour) {
160 signal_changed (TextSubtitleContentProperty::TEXT_SUBTITLE_COLOUR);
164 TextSubtitleContent::set_outline (bool o)
167 boost::mutex::scoped_lock lm (_mutex);
175 signal_changed (TextSubtitleContentProperty::TEXT_SUBTITLE_OUTLINE);
179 TextSubtitleContent::set_outline_colour (dcp::Colour colour)
182 boost::mutex::scoped_lock lm (_mutex);
183 if (_outline_colour == colour) {
187 _outline_colour = colour;
190 signal_changed (TextSubtitleContentProperty::TEXT_SUBTITLE_OUTLINE_COLOUR);