src/subtitle_string.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_string.h
  36  *  @brief SubtitleString class
  37  */
  38
  39
  40 #ifndef LIBDCP_SUBTITLE_STRING_H
  41 #define LIBDCP_SUBTITLE_STRING_H
  42
  43
  44 #include "dcp_time.h"
  45 #include "subtitle.h"
  46 #include <boost/optional.hpp>
  47 #include <string>
  48
  49
  50 namespace dcp {
  51
  52
  53 /** @class SubtitleString
  54  *  @brief A single line of subtitle text with all the associated attributes.
  55  */
  56 class SubtitleString : public Subtitle
  57 {
  58 public:
  59         /** @param font Font ID, or empty to use the default
  60          *  @param italic true for italic text
  61          *  @param bold true for bold text
  62          *  @param underline true for underlined text
  63          *  @param colour Colour of the text
  64          *  @param size Size in points as if the screen height is 11 inches, so a 72pt font would be 1/11th of the screen height
  65          *  @param aspect_adjust greater than 1 to stretch text to be wider, less than 1 to shrink text to be narrower (must be between 0.25 and 4)
  66          *  @param in start time
  67          *  @param out finish time
  68          *  @param h_position Horizontal position as a fraction of the screen width (between 0 and 1) from h_align
  69          *  @param h_align Horizontal alignment point
  70          *  @param v_position Vertical position as a fraction of the screen height (between 0 and 1) from v_align
  71          *  @param v_align Vertical alignment point
  72          *  @param z_position Z position as a proportion of the primary picture width between -1 and +1;
  73          *  +ve moves the image away from the viewer, -ve moves it toward the viewer, 0 is in the plane of the screen.
  74          *  @param direction Direction of text
  75          *  @param text The text to display
  76          *  @param effect Effect to use
  77          *  @param effect_colour Colour of the effect
  78          *  @param fade_up_time Time to fade the text in
  79          *  @param fade_down_time Time to fade the text out
  80          *  @param space_before Space to add before this string, in ems (could be negative to remove space).
  81          */
  82         SubtitleString (
  83                 boost::optional<std::string> font,
  84                 bool italic,
  85                 bool bold,
  86                 bool underline,
  87                 Colour colour,
  88                 int size,
  89                 float aspect_adjust,
  90                 Time in,
  91                 Time out,
  92                 float h_position,
  93                 HAlign h_align,
  94                 float v_position,
  95                 VAlign v_align,
  96                 float z_position,
  97                 Direction direction,
  98                 std::string text,
  99                 Effect effect,
 100                 Colour effect_colour,
 101                 Time fade_up_time,
 102                 Time fade_down_time,
 103                 float space_before
 104                 );
 105
 106         /** @return font ID */
 107         boost::optional<std::string> font () const {
 108                 return _font;
 109         }
 110
 111         bool italic () const {
 112                 return _italic;
 113         }
 114
 115         bool bold () const {
 116                 return _bold;
 117         }
 118
 119         bool underline () const {
 120                 return _underline;
 121         }
 122
 123         Colour colour () const {
 124                 return _colour;
 125         }
 126
 127         std::string text () const {
 128                 return _text;
 129         }
 130
 131         Direction direction () const {
 132                 return _direction;
 133         }
 134
 135         Effect effect () const {
 136                 return _effect;
 137         }
 138
 139         Colour effect_colour () const {
 140                 return _effect_colour;
 141         }
 142
 143         int size () const {
 144                 return _size;
 145         }
 146
 147         float size_in_pixels (int screen_height) const;
 148
 149         float space_before () const {
 150                 return _space_before;
 151         }
 152
 153         /** @return Aspect ratio `adjustment' of the font size.
 154          *  Values greater than 1 widen each character, values less than 1 narrow each character,
 155          *  and the value must be between 0.25 and 4.
 156          */
 157         float aspect_adjust () const {
 158                 return _aspect_adjust;
 159         }
 160
 161         void set_font (std::string id) {
 162                 _font = id;
 163         }
 164
 165         void unset_font () {
 166                 _font = boost::optional<std::string>();
 167         }
 168
 169         void set_size (int s) {
 170                 _size = s;
 171         }
 172
 173         void set_aspect_adjust (float a) {
 174                 _aspect_adjust = a;
 175         }
 176
 177         void set_text (std::string t) {
 178                 _text = t;
 179         }
 180
 181         void set_colour (Colour c) {
 182                 _colour = c;
 183         }
 184
 185         void set_effect (Effect e) {
 186                 _effect = e;
 187         }
 188
 189         void set_effect_colour (Colour c) {
 190                 _effect_colour = c;
 191         }
 192
 193         bool equals(std::shared_ptr<const dcp::Subtitle> other_sub, EqualityOptions const& options, NoteHandler node) const override;
 194
 195 private:
 196         /** font ID */
 197         boost::optional<std::string> _font;
 198         /** true if the text is italic */
 199         bool _italic;
 200         /** true if the weight is bold, false for normal */
 201         bool _bold;
 202         /** true to enable underlining, false otherwise */
 203         bool _underline;
 204         /** text colour */
 205         Colour _colour;
 206         /** Size in points as if the screen height is 11 inches, so a 72pt font
 207          *  would be 1/11th of the screen height.
 208          */
 209         int _size;
 210         float _aspect_adjust;
 211         Direction _direction;
 212         std::string _text;
 213         Effect _effect;
 214         Colour _effect_colour;
 215         float _space_before;
 216 };
 217
 218 bool operator== (SubtitleString const & a, SubtitleString const & b);
 219 bool operator!= (SubtitleString const & a, SubtitleString const & b);
 220 std::ostream& operator<< (std::ostream& s, SubtitleString const & sub);
 221
 222
 223 }
 224
 225
 226 #endif