2 Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
21 #ifndef DCPOMATIC_SUBTITLE_CONTENT_H
22 #define DCPOMATIC_SUBTITLE_CONTENT_H
24 #include "content_part.h"
25 #include <libcxml/cxml.h>
26 #include <dcp/types.h>
27 #include <boost/signals2.hpp>
31 class SubtitleContentProperty
34 static int const X_OFFSET;
35 static int const Y_OFFSET;
36 static int const X_SCALE;
37 static int const Y_SCALE;
39 static int const BURN;
40 static int const LANGUAGE;
41 static int const FONTS;
42 static int const COLOUR;
43 static int const OUTLINE;
44 static int const OUTLINE_COLOUR;
47 class SubtitleContent : public ContentPart
50 SubtitleContent (Content* parent);
51 SubtitleContent (Content* parent, std::vector<boost::shared_ptr<Content> >);
53 void as_xml (xmlpp::Node *) const;
54 std::string identifier () const;
56 bool has_image_subtitles () const {
61 void add_font (boost::shared_ptr<Font> font);
65 void set_x_offset (double);
66 void set_y_offset (double);
67 void set_x_scale (double);
68 void set_y_scale (double);
69 void set_language (std::string language);
72 boost::mutex::scoped_lock lm (_mutex);
77 boost::mutex::scoped_lock lm (_mutex);
81 double x_offset () const {
82 boost::mutex::scoped_lock lm (_mutex);
86 double y_offset () const {
87 boost::mutex::scoped_lock lm (_mutex);
91 double x_scale () const {
92 boost::mutex::scoped_lock lm (_mutex);
96 double y_scale () const {
97 boost::mutex::scoped_lock lm (_mutex);
101 std::list<boost::shared_ptr<Font> > fonts () const {
102 boost::mutex::scoped_lock lm (_mutex);
106 std::string language () const {
107 boost::mutex::scoped_lock lm (_mutex);
111 void set_colour (dcp::Colour);
113 dcp::Colour colour () const {
114 boost::mutex::scoped_lock lm (_mutex);
118 void set_outline (bool);
120 bool outline () const {
121 boost::mutex::scoped_lock lm (_mutex);
125 void set_outline_colour (dcp::Colour);
127 dcp::Colour outline_colour () const {
128 boost::mutex::scoped_lock lm (_mutex);
129 return _outline_colour;
132 static boost::shared_ptr<SubtitleContent> from_xml (Content* parent, cxml::ConstNodePtr, int version);
135 /** subtitle language (e.g. "German") or empty if it is not known */
136 std::string _language;
139 friend struct ffmpeg_pts_offset_test;
141 SubtitleContent (Content* parent, cxml::ConstNodePtr, int version);
142 void font_changed ();
143 void connect_to_fonts ();
147 /** x offset for placing subtitles, as a proportion of the container width;
148 * +ve is further right, -ve is further left.
151 /** y offset for placing subtitles, as a proportion of the container height;
152 * +ve is further down the frame, -ve is further up.
155 /** x scale factor to apply to subtitles */
157 /** y scale factor to apply to subtitles */
159 std::list<boost::shared_ptr<Font> > _fonts;
162 dcp::Colour _outline_colour;
163 std::list<boost::signals2::connection> _font_connections;