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
|
/*
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 "frame_time.h"
#include "metric_time.h"
#include "colour.h"
#include "vertical_reference.h"
#include "effect.h"
#include "time_pair.h"
#include <boost/optional.hpp>
#include <string>
#include <list>
namespace sub {
/** A piece of text with a single font, style, size etc. */
class Block
{
public:
Block ()
: colour (1, 1, 1)
, bold (false)
, italic (false)
, underline (false)
{}
/** Subtitle text in UTF-8 */
std::string text;
std::string font;
/** font size */
class FontSize {
public:
void set_proportional (float p) {
_proportional = p;
}
void set_points (int p) {
_points = p;
}
boost::optional<float> proportional () const {
return _proportional;
}
boost::optional<int> points () const {
return _points;
}
float proportional (int screen_height_in_points) const;
int points (int screen_height_in_points) const;
private:
/** as a proportion of screen height */
boost::optional<float> _proportional;
/** in points */
boost::optional<int> _points;
} 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
};
/** A line of text which starts and stops at specific times */
class Subtitle
{
public:
Subtitle ()
{}
/** vertical position of the baseline of the text */
struct VerticalPosition {
/** as a proportion of screen height offset from some reference point */
boost::optional<float> proportional;
/** reference position for proportional */
boost::optional<VerticalReference> reference;
/** line number from the top of the screen */
boost::optional<int> line;
bool operator== (VerticalPosition const & other) const;
} vertical_position;
/** from time */
TimePair from;
/** to time */
TimePair to;
boost::optional<MetricTime> fade_up;
boost::optional<MetricTime> fade_down;
std::list<Block> blocks;
bool same_metadata (Subtitle const &) const;
};
bool operator< (Subtitle const & a, Subtitle const & b);
}
#endif
|