2 Copyright (C) 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 LIBSUB_SUBTITLE_H
21 #define LIBSUB_SUBTITLE_H
23 #include "frame_time.h"
24 #include "metric_time.h"
26 #include "vertical_reference.h"
28 #include <boost/optional.hpp>
50 /** as a proportion of screen height */
51 boost::optional<float> proportional;
53 boost::optional<int> points;
56 float font_size_proportional (int screen_height_in_points) const;
57 int font_size_points (int screen_height_in_points) const;
59 /** vertical position of the baseline of the text */
61 /** as a proportion of screen height offset from some reference point */
62 boost::optional<float> proportional;
63 /** reference position for proportional */
64 boost::optional<VerticalReference> reference;
67 boost::optional<Effect> effect;
68 boost::optional<Colour> effect_colour;
71 bool bold; ///< true to use a bold version of font
72 bool italic; ///< true to use an italic version of font
73 bool underline; ///< true to underline
78 boost::optional<FrameTime> frame;
79 boost::optional<MetricTime> metric;
82 FrameTime from_frame (float frames_per_second) const;
83 MetricTime from_metric (float frames_per_second) const;
87 boost::optional<FrameTime> frame;
88 boost::optional<MetricTime> metric;
91 FrameTime to_frame (float frames_per_second) const;
92 MetricTime to_metric (float frames_per_second) const;
94 boost::optional<MetricTime> fade_up;
95 boost::optional<MetricTime> fade_down;
98 bool operator< (Subtitle const & a, Subtitle const & b);