src/subtitle.h

   1 /*
   2     Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef LIBSUB_SUBTITLE_H
  21 #define LIBSUB_SUBTITLE_H
  22
  23 #include "colour.h"
  24 #include "vertical_reference.h"
  25 #include "effect.h"
  26 #include "font_size.h"
  27 #include "vertical_position.h"
  28 #include "horizontal_position.h"
  29 #include "raw_subtitle.h"
  30 #include <boost/optional.hpp>
  31 #include <string>
  32 #include <list>
  33
  34 namespace sub {
  35
  36 /** @class Block
  37  *  @brief A block of text within a subtitle's line
  38  *
  39  *  This represents a block of text which has a particular style (font, size, effect, colour etc.)
  40  */
  41 class Block
  42 {
  43 public:
  44         Block ()
  45                 : colour (1, 1, 1)
  46                 , bold (false)
  47                 , italic (false)
  48                 , underline (false)
  49         {}
  50
  51         /** Construct a Block taking any relevant information from a RawSubtitle */
  52         Block (RawSubtitle s);
  53
  54         /** Subtitle text in UTF-8 */
  55         std::string text;
  56         boost::optional<std::string> font;
  57
  58         /** font size */
  59         FontSize font_size;
  60
  61         boost::optional<Effect> effect;
  62         boost::optional<Colour> effect_colour;
  63
  64         Colour colour;
  65         bool bold;      ///< true to use a bold version of font
  66         bool italic;    ///< true to use an italic version of font
  67         bool underline; ///< true to underline
  68 };
  69
  70 extern bool operator== (Block const & a, Block const & b);
  71
  72 /** @class Line
  73  *  @brief A line of text within a subtitle.
  74  *
  75  *  This represents a line of text which has a particular vertical position.
  76  */
  77 class Line
  78 {
  79 public:
  80         Line ()
  81                 : horizontal_position (CENTRE)
  82         {}
  83
  84         /** Construct a Line taking any relevant information from a RawSubtitle */
  85         Line (RawSubtitle s);
  86
  87         HorizontalPosition horizontal_position;
  88
  89         /** vertical position of the baseline of the text */
  90         VerticalPosition vertical_position;
  91
  92         std::list<Block> blocks;
  93
  94         bool same_metadata (RawSubtitle) const;
  95 };
  96
  97 extern bool operator== (Line const & a, Line const & b);
  98
  99 /** @class Subtitle
 100  *  @brief A subtitle which has been collected into lines and blocks.
 101  *
 102  *  This represents a chunk of text which appears and disappears at some particular
 103  *  times.
 104  */
 105 class Subtitle
 106 {
 107 public:
 108         Subtitle ()
 109         {}
 110
 111         /** Construct a Line taking any relevant information from a RawSubtitle */
 112         Subtitle (RawSubtitle s);
 113
 114         /** from time */
 115         Time from;
 116         /** to time */
 117         Time to;
 118
 119         boost::optional<Time> fade_up;
 120         boost::optional<Time> fade_down;
 121
 122         std::list<Line> lines;
 123
 124         bool same_metadata (RawSubtitle) const;
 125 };
 126
 127 extern bool operator== (Subtitle const & a, Subtitle const & b);
 128
 129 }
 130
 131 #endif