2 Copyright (C) 2013-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 DCPOMATIC_SUBTITLE_CONTENT_H
21 #define DCPOMATIC_SUBTITLE_CONTENT_H
25 class SubtitleContentProperty
28 static int const SUBTITLE_X_OFFSET;
29 static int const SUBTITLE_Y_OFFSET;
30 static int const SUBTITLE_X_SCALE;
31 static int const SUBTITLE_Y_SCALE;
32 static int const USE_SUBTITLES;
33 static int const SUBTITLE_LANGUAGE;
36 /** @class SubtitleContent
37 * @brief Parent for content which has the potential to include subtitles.
39 * Although inheriting from this class indicates that the content could
40 * have subtitles, it may not. ::has_subtitles() will tell you.
42 class SubtitleContent : public virtual Content
45 SubtitleContent (boost::shared_ptr<const Film>);
46 SubtitleContent (boost::shared_ptr<const Film>, boost::filesystem::path);
47 SubtitleContent (boost::shared_ptr<const Film>, cxml::ConstNodePtr, int version);
48 SubtitleContent (boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
50 void as_xml (xmlpp::Node *) const;
51 std::string identifier () const;
53 virtual bool has_subtitles () const = 0;
55 void set_use_subtitles (bool);
56 void set_subtitle_x_offset (double);
57 void set_subtitle_y_offset (double);
58 void set_subtitle_x_scale (double);
59 void set_subtitle_y_scale (double);
60 void set_subtitle_language (std::string language);
62 bool use_subtitles () const {
63 boost::mutex::scoped_lock lm (_mutex);
64 return _use_subtitles;
67 double subtitle_x_offset () const {
68 boost::mutex::scoped_lock lm (_mutex);
69 return _subtitle_x_offset;
72 double subtitle_y_offset () const {
73 boost::mutex::scoped_lock lm (_mutex);
74 return _subtitle_y_offset;
77 double subtitle_x_scale () const {
78 boost::mutex::scoped_lock lm (_mutex);
79 return _subtitle_x_scale;
82 double subtitle_y_scale () const {
83 boost::mutex::scoped_lock lm (_mutex);
84 return _subtitle_y_scale;
87 boost::optional<std::string> subtitle_language () const {
88 return _subtitle_language;
92 friend struct ffmpeg_pts_offset_test;
95 /** x offset for placing subtitles, as a proportion of the container width;
96 * +ve is further right, -ve is further left.
98 double _subtitle_x_offset;
99 /** y offset for placing subtitles, as a proportion of the container height;
100 * +ve is further down the frame, -ve is further up.
102 double _subtitle_y_offset;
103 /** x scale factor to apply to subtitles */
104 double _subtitle_x_scale;
105 /** y scale factor to apply to subtitles */
106 double _subtitle_y_scale;
108 boost::optional<std::string> _subtitle_language;