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
24 #include "vertical_reference.h"
26 #include "font_size.h"
27 #include "vertical_position.h"
28 #include "horizontal_position.h"
29 #include "raw_subtitle.h"
30 #include <boost/optional.hpp>
37 * @brief A block of text within a subtitle's line
39 * This represents a block of text which has a particular style (font, size, effect, colour etc.)
51 /** Construct a Block taking any relevant information from a RawSubtitle */
52 Block (RawSubtitle s);
54 /** Subtitle text in UTF-8 */
56 boost::optional<std::string> font;
61 boost::optional<Effect> effect;
62 boost::optional<Colour> effect_colour;
65 bool bold; ///< true to use a bold version of font
66 bool italic; ///< true to use an italic version of font
67 bool underline; ///< true to underline
70 extern bool operator== (Block const & a, Block const & b);
73 * @brief A line of text within a subtitle.
75 * This represents a line of text which has a particular vertical position.
82 horizontal_position.reference = HORIZONTAL_CENTRE_OF_SCREEN;
85 /** Construct a Line taking any relevant information from a RawSubtitle */
88 HorizontalPosition horizontal_position;
90 /** vertical position of the baseline of the text */
91 VerticalPosition vertical_position;
93 std::vector<Block> blocks;
95 bool same_metadata (RawSubtitle) const;
98 extern bool operator== (Line const & a, Line const & b);
101 * @brief A subtitle which has been collected into lines and blocks.
103 * This represents a chunk of text which appears and disappears at some particular
112 /** Construct a Line taking any relevant information from a RawSubtitle */
113 Subtitle (RawSubtitle s);
120 boost::optional<Time> fade_up;
121 boost::optional<Time> fade_down;
123 std::vector<Line> lines;
125 bool same_metadata (RawSubtitle) const;
128 extern bool operator== (Subtitle const & a, Subtitle const & b);