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