2 Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of libdcp.
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.
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.
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/>.
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
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.
35 /** @file src/subtitle.h
36 * @brief Subtitle class
40 #ifndef LIBDCP_SUBTITLE_H
41 #define LIBDCP_SUBTITLE_H
52 class EqualityOptions;
58 virtual ~Subtitle () {}
60 /** @return subtitle start time (relative to the start of the reel) */
65 /** @return subtitle finish time (relative to the start of the reel) */
70 float h_position () const {
74 HAlign h_align () const {
78 /** @return vertical position as a proportion of the screen height from the
79 * vertical alignment point.
82 float v_position () const {
86 VAlign v_align () const {
90 float z_position() const {
94 Time fade_up_time () const {
98 Time fade_down_time () const {
99 return _fade_down_time;
102 void set_in (Time i) {
106 void set_out (Time o) {
110 void set_h_position (float p) {
114 /** @param p New vertical position as a proportion of the screen height
115 * from the top (between 0 and 1)
117 void set_v_position (float p) {
121 void set_z_position(float z) {
125 void set_fade_up_time (Time t) {
129 void set_fade_down_time (Time t) {
133 virtual bool equals(std::shared_ptr<const dcp::Subtitle> other, EqualityOptions const& options, NoteHandler note) const;
151 /** Horizontal position as a proportion of the screen width from the _h_align
154 float _h_position = 0;
155 HAlign _h_align = HAlign::CENTER;
156 /** Vertical position as a proportion of the screen height from the _v_align
159 float _v_position = 0;
160 VAlign _v_align = VAlign::CENTER;
161 float _z_position = 0;
163 Time _fade_down_time;