2 Copyright (C) 2012-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 /** @file src/subtitle_string.h
21 * @brief SubtitleString class.
24 #ifndef LIBDCP_SUBTITLE_STRING_H
25 #define LIBDCP_SUBTITLE_STRING_H
29 #include <boost/optional.hpp>
34 /** @class SubtitleString
35 * @brief A single line of subtitle text with all the associated attributes.
41 boost::optional<std::string> font,
61 /** @return font ID */
62 boost::optional<std::string> font () const {
66 bool italic () const {
74 Colour colour () const {
86 std::string text () const {
90 float h_position () const {
94 HAlign h_align () const {
98 /** @return vertical position as a proportion of the screen height from the
99 * vertical alignment point.
102 float v_position () const {
106 VAlign v_align () const {
110 Direction direction () const {
114 Effect effect () const {
118 Colour effect_colour () const {
119 return _effect_colour;
122 Time fade_up_time () const {
123 return _fade_up_time;
126 Time fade_down_time () const {
127 return _fade_down_time;
134 int size_in_pixels (int screen_height) const;
136 /** @return Aspect ratio `adjustment' of the font size.
137 * Values greater than 1 widen each character, values less than 1 narrow each character,
138 * and the value must be between 0.25 and 4.
140 float aspect_adjust () const {
141 return _aspect_adjust;
144 void set_in (Time i) {
148 void set_out (Time o) {
152 void set_h_position (float p) {
156 /** @param p New vertical position as a proportion of the screen height
157 * from the top (between 0 and 1)
159 void set_v_position (float p) {
163 void set_size (int s) {
167 void set_aspect_adjust (float a) {
173 boost::optional<std::string> _font;
174 /** true if the text is italic */
176 /** true if the weight is bold, false for normal */
180 /** Size in points as if the screen height is 11 inches, so a 72pt font
181 * would be 1/11th of the screen height.
184 float _aspect_adjust;
187 /** Horizontal position as a proportion of the screen width from the _h_align
192 /** Vertical position as a proportion of the screen height from the _v_align
197 Direction _direction;
200 Colour _effect_colour;
202 Time _fade_down_time;
205 bool operator== (SubtitleString const & a, SubtitleString const & b);
206 std::ostream& operator<< (std::ostream& s, SubtitleString const & sub);