2 Copyright (C) 2013-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 #ifndef DCPOMATIC_SUBTITLE_CONTENT_H
21 #define DCPOMATIC_SUBTITLE_CONTENT_H
23 #include "content_part.h"
24 #include <libcxml/cxml.h>
25 #include <dcp/types.h>
26 #include <boost/signals2.hpp>
30 class SubtitleContentProperty
33 static int const X_OFFSET;
34 static int const Y_OFFSET;
35 static int const X_SCALE;
36 static int const Y_SCALE;
38 static int const BURN;
39 static int const LANGUAGE;
40 static int const FONTS;
41 static int const COLOUR;
42 static int const OUTLINE;
43 static int const OUTLINE_COLOUR;
46 class SubtitleContent : public ContentPart
49 SubtitleContent (Content* parent);
50 SubtitleContent (Content* parent, std::vector<boost::shared_ptr<Content> >);
52 void as_xml (xmlpp::Node *) const;
53 std::string identifier () const;
55 bool has_image_subtitles () const {
60 void add_font (boost::shared_ptr<Font> font);
64 void set_x_offset (double);
65 void set_y_offset (double);
66 void set_x_scale (double);
67 void set_y_scale (double);
68 void set_language (std::string language);
71 boost::mutex::scoped_lock lm (_mutex);
76 boost::mutex::scoped_lock lm (_mutex);
80 double x_offset () const {
81 boost::mutex::scoped_lock lm (_mutex);
85 double y_offset () const {
86 boost::mutex::scoped_lock lm (_mutex);
90 double x_scale () const {
91 boost::mutex::scoped_lock lm (_mutex);
95 double y_scale () const {
96 boost::mutex::scoped_lock lm (_mutex);
100 std::list<boost::shared_ptr<Font> > fonts () const {
101 boost::mutex::scoped_lock lm (_mutex);
105 std::string language () const {
106 boost::mutex::scoped_lock lm (_mutex);
110 void set_colour (dcp::Colour);
112 dcp::Colour colour () const {
113 boost::mutex::scoped_lock lm (_mutex);
117 void set_outline (bool);
119 bool outline () const {
120 boost::mutex::scoped_lock lm (_mutex);
124 void set_outline_colour (dcp::Colour);
126 dcp::Colour outline_colour () const {
127 boost::mutex::scoped_lock lm (_mutex);
128 return _outline_colour;
131 static boost::shared_ptr<SubtitleContent> from_xml (Content* parent, cxml::ConstNodePtr, int version);
134 /** subtitle language (e.g. "German") or empty if it is not known */
135 std::string _language;
138 friend struct ffmpeg_pts_offset_test;
140 SubtitleContent (Content* parent, cxml::ConstNodePtr, int version);
141 void font_changed ();
142 void connect_to_fonts ();
146 /** x offset for placing subtitles, as a proportion of the container width;
147 * +ve is further right, -ve is further left.
150 /** y offset for placing subtitles, as a proportion of the container height;
151 * +ve is further down the frame, -ve is further up.
154 /** x scale factor to apply to subtitles */
156 /** y scale factor to apply to subtitles */
158 std::list<boost::shared_ptr<Font> > _fonts;
161 dcp::Colour _outline_colour;
162 std::list<boost::signals2::connection> _font_connections;