src/subtitle.h

   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
  35 /** @file  src/subtitle.h
  36  *  @brief Subtitle class
  37  */
  38
  39
  40 #ifndef LIBDCP_SUBTITLE_H
  41 #define LIBDCP_SUBTITLE_H
  42
  43
  44 #include "dcp_time.h"
  45 #include "h_align.h"
  46 #include "v_align.h"
  47
  48
  49 namespace dcp {
  50
  51
  52 class EqualityOptions;
  53
  54
  55 class Subtitle
  56 {
  57 public:
  58         virtual ~Subtitle () {}
  59
  60         /** @return subtitle start time (relative to the start of the reel) */
  61         Time in () const {
  62                 return _in;
  63         }
  64
  65         /** @return subtitle finish time (relative to the start of the reel) */
  66         Time out () const {
  67                 return _out;
  68         }
  69
  70         float h_position () const {
  71                 return _h_position;
  72         }
  73
  74         HAlign h_align () const {
  75                 return _h_align;
  76         }
  77
  78         /** @return vertical position as a proportion of the screen height from the
  79          *  vertical alignment point.
  80          *  (between 0 and 1)
  81          */
  82         float v_position () const {
  83                 return _v_position;
  84         }
  85
  86         VAlign v_align () const {
  87                 return _v_align;
  88         }
  89
  90         float z_position() const {
  91                 return _z_position;
  92         }
  93
  94         Time fade_up_time () const {
  95                 return _fade_up_time;
  96         }
  97
  98         Time fade_down_time () const {
  99                 return _fade_down_time;
 100         }
 101
 102         void set_in (Time i) {
 103                 _in = i;
 104         }
 105
 106         void set_out (Time o) {
 107                 _out = o;
 108         }
 109
 110         void set_h_position (float p) {
 111                 _h_position = p;
 112         }
 113
 114         /** @param p New vertical position as a proportion of the screen height
 115          *  from the top (between 0 and 1)
 116          */
 117         void set_v_position (float p) {
 118                 _v_position = p;
 119         }
 120
 121         void set_z_position(float z) {
 122                 _z_position = z;
 123         }
 124
 125         void set_fade_up_time (Time t) {
 126                 _fade_up_time = t;
 127         }
 128
 129         void set_fade_down_time (Time t) {
 130                 _fade_down_time = t;
 131         }
 132
 133         virtual bool equals(std::shared_ptr<const dcp::Subtitle> other, EqualityOptions const& options, NoteHandler note) const;
 134
 135 protected:
 136
 137         Subtitle (
 138                 Time in,
 139                 Time out,
 140                 float h_position,
 141                 HAlign h_align,
 142                 float v_position,
 143                 VAlign v_align,
 144                 float z_position,
 145                 Time fade_up_time,
 146                 Time fade_down_time
 147                 );
 148
 149         Time _in;
 150         Time _out;
 151         /** Horizontal position as a proportion of the screen width from the _h_align
 152          *  (between 0 and 1)
 153          */
 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
 157          *  (between 0 and 1)
 158          */
 159         float _v_position = 0;
 160         VAlign _v_align = VAlign::CENTER;
 161         float _z_position = 0;
 162         Time _fade_up_time;
 163         Time _fade_down_time;
 164 };
 165
 166
 167 }
 168
 169
 170 #endif