src/subtitle.h

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