1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
/*
Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#ifndef LIBSUB_SUBTITLE_H
#define LIBSUB_SUBTITLE_H
#include "colour.h"
#include "sub_time.h"
#include "vertical_reference.h"
#include "effect.h"
#include "font_size.h"
#include "vertical_position.h"
#include "raw_subtitle.h"
#include <boost/optional.hpp>
#include <string>
#include <list>
namespace sub {
/** @class Block
* @brief A block of text within a subtitle's line
*
* This represents a block of text which has a particular style (font, size, effect, colour etc.)
*/
class Block
{
public:
Block ()
: colour (1, 1, 1)
, bold (false)
, italic (false)
, underline (false)
{}
/** Construct a Block taking any relevant information from a RawSubtitle */
Block (RawSubtitle s);
/** Subtitle text in UTF-8 */
std::string text;
boost::optional<std::string> font;
/** font size */
FontSize font_size;
boost::optional<Effect> effect;
boost::optional<Colour> effect_colour;
Colour colour;
bool bold; ///< true to use a bold version of font
bool italic; ///< true to use an italic version of font
bool underline; ///< true to underline
};
bool operator== (Block const & a, Block const & b);
/** @class Line
* @brief A line of text within a subtitle.
*
* This represents a line of text which has a particular vertical position.
*/
class Line
{
public:
Line () {}
/** Construct a Line taking any relevant information from a RawSubtitle */
Line (RawSubtitle s);
/** vertical position of the baseline of the text */
VerticalPosition vertical_position;
std::list<Block> blocks;
bool same_metadata (RawSubtitle) const;
};
bool operator== (Line const & a, Line const & b);
/** @class Subtitle
* @brief A subtitle which has been collected into lines and blocks.
*
* This represents a chunk of text which appears and disappears at some particular
* times.
*/
class Subtitle
{
public:
Subtitle ()
{}
/** Construct a Line taking any relevant information from a RawSubtitle */
Subtitle (RawSubtitle s);
/** from time */
Time from;
/** to time */
Time to;
boost::optional<Time> fade_up;
boost::optional<Time> fade_down;
std::list<Line> lines;
bool same_metadata (RawSubtitle) const;
};
bool operator== (Subtitle const & a, Subtitle const & b);
std::ostream & operator<< (std::ostream &, Subtitle const & sub);
}
#endif
|
