2 Copyright (C) 2013 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;
35 /** @class SubtitleContent
36 * @brief Parent for content which has the potential to include subtitles.
38 * Although inheriting from this class indicates that the content could
39 * have subtitles, it may not. ::has_subtitles() will tell you.
41 class SubtitleContent : public virtual Content
44 SubtitleContent (boost::shared_ptr<const Film>);
45 SubtitleContent (boost::shared_ptr<const Film>, boost::filesystem::path);
46 SubtitleContent (boost::shared_ptr<const Film>, cxml::ConstNodePtr, int version);
47 SubtitleContent (boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
49 void as_xml (xmlpp::Node *) const;
50 std::string identifier () const;
52 virtual bool has_subtitles () const = 0;
54 void set_use_subtitles (bool);
55 void set_subtitle_x_offset (double);
56 void set_subtitle_y_offset (double);
57 void set_subtitle_x_scale (double);
58 void set_subtitle_y_scale (double);
60 bool use_subtitles () const {
61 boost::mutex::scoped_lock lm (_mutex);
62 return _use_subtitles;
65 double subtitle_x_offset () const {
66 boost::mutex::scoped_lock lm (_mutex);
67 return _subtitle_x_offset;
70 double subtitle_y_offset () const {
71 boost::mutex::scoped_lock lm (_mutex);
72 return _subtitle_y_offset;
75 double subtitle_x_scale () const {
76 boost::mutex::scoped_lock lm (_mutex);
77 return _subtitle_x_scale;
80 double subtitle_y_scale () const {
81 boost::mutex::scoped_lock lm (_mutex);
82 return _subtitle_y_scale;
86 friend struct ffmpeg_pts_offset_test;
89 /** x offset for placing subtitles, as a proportion of the container width;
90 * +ve is further right, -ve is further left.
92 double _subtitle_x_offset;
93 /** y offset for placing subtitles, as a proportion of the container height;
94 * +ve is further down the frame, -ve is further up.
96 double _subtitle_y_offset;
97 /** x scale factor to apply to subtitles */
98 double _subtitle_x_scale;
99 /** y scale factor to apply to subtitles */
100 double _subtitle_y_scale;