libdcp
subtitle.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
3 
4  This file is part of libdcp.
5 
6  libdcp is free software; you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation; either version 2 of the License, or
9  (at your option) any later version.
10 
11  libdcp is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU General Public License for more details.
15 
16  You should have received a copy of the GNU General Public License
17  along with libdcp. If not, see <http://www.gnu.org/licenses/>.
18 
19  In addition, as a special exception, the copyright holders give
20  permission to link the code of portions of this program with the
21  OpenSSL library under certain conditions as described in each
22  individual source file, and distribute linked combinations
23  including the two.
24 
25  You must obey the GNU General Public License in all respects
26  for all of the code used other than OpenSSL. If you modify
27  file(s) with this exception, you may extend this exception to your
28  version of the file(s), but you are not obligated to do so. If you
29  do not wish to do so, delete this exception statement from your
30  version. If you delete this exception statement from all source
31  files in the program, then also delete it here.
32 */
33 
34 
40 #ifndef LIBDCP_SUBTITLE_H
41 #define LIBDCP_SUBTITLE_H
42 
43 
44 #include "dcp_time.h"
45 
46 
47 namespace dcp {
48 
49 
50 class Subtitle
51 {
52 public:
53  virtual ~Subtitle () {}
54 
56  Time in () const {
57  return _in;
58  }
59 
61  Time out () const {
62  return _out;
63  }
64 
65  float h_position () const {
66  return _h_position;
67  }
68 
69  HAlign h_align () const {
70  return _h_align;
71  }
72 
77  float v_position () const {
78  return _v_position;
79  }
80 
81  VAlign v_align () const {
82  return _v_align;
83  }
84 
85  Time fade_up_time () const {
86  return _fade_up_time;
87  }
88 
89  Time fade_down_time () const {
90  return _fade_down_time;
91  }
92 
93  void set_in (Time i) {
94  _in = i;
95  }
96 
97  void set_out (Time o) {
98  _out = o;
99  }
100 
101  void set_h_position (float p) {
102  _h_position = p;
103  }
104 
108  void set_v_position (float p) {
109  _v_position = p;
110  }
111 
112  void set_fade_up_time (Time t) {
113  _fade_up_time = t;
114  }
115 
116  void set_fade_down_time (Time t) {
117  _fade_down_time = t;
118  }
119 
120 
121 protected:
122 
123  Subtitle (
124  Time in,
125  Time out,
126  float h_position,
127  HAlign h_align,
128  float v_position,
129  VAlign v_align,
130  Time fade_up_time,
131  Time fade_down_time
132  );
133 
134  Time _in;
135  Time _out;
139  float _h_position = 0;
140  HAlign _h_align = HAlign::CENTER;
144  float _v_position = 0;
145  VAlign _v_align = VAlign::CENTER;
146  Time _fade_up_time;
147  Time _fade_down_time;
148 };
149 
150 
151 }
152 
153 
154 #endif
Subtitle(Time in, Time out, float h_position, HAlign h_align, float v_position, VAlign v_align, Time fade_up_time, Time fade_down_time)
Definition: subtitle.cc:48
float v_position() const
Definition: subtitle.h:77
float _v_position
Definition: subtitle.h:144
void set_v_position(float p)
Definition: subtitle.h:108
Time in() const
Definition: subtitle.h:56
Time out() const
Definition: subtitle.h:61
float _h_position
Definition: subtitle.h:139
A representation of time within a DCP.
Definition: dcp_time.h:73
Time class.
Namespace for everything in libdcp.
Definition: array_data.h:50
HAlign
Definition: types.h:166
@ CENTER
horizontal position is distance from centre of screen to centre of subtitle
VAlign
Definition: types.h:178
@ CENTER
vertical position is distance from centre of screen to centre of subtitle