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 "frame_time.h"
  24 #include "metric_time.h"
  25 #include "colour.h"
  26 #include "vertical_reference.h"
  27 #include "effect.h"
  28 #include "time_pair.h"
  29 #include "font_size.h"
  30 #include "vertical_position.h"
  31 #include "raw_subtitle.h"
  32 #include <boost/optional.hpp>
  33 #include <string>
  34 #include <list>
  35
  36 namespace sub {
  37
  38 /** A piece of text with a single font, style, size etc. */
  39 class Block
  40 {
  41 public:
  42         Block ()
  43                 : colour (1, 1, 1)
  44                 , bold (false)
  45                 , italic (false)
  46                 , underline (false)
  47         {}
  48
  49         /** Construct a Block taking any relevant information from a RawSubtitle */
  50         Block (RawSubtitle s);
  51
  52         /** Subtitle text in UTF-8 */
  53         std::string text;
  54         std::string font;
  55
  56         /** font size */
  57         FontSize font_size;
  58
  59         boost::optional<Effect> effect;
  60         boost::optional<Colour> effect_colour;
  61
  62         Colour colour;
  63         bool bold;      ///< true to use a bold version of font
  64         bool italic;    ///< true to use an italic version of font
  65         bool underline; ///< true to underline
  66 };
  67
  68 /** A line of text */
  69 class Line
  70 {
  71 public:
  72         Line () {}
  73
  74         /** Construct a Line taking any relevant information from a RawSubtitle */
  75         Line (RawSubtitle s);
  76
  77         /** vertical position of the baseline of the text */
  78         VerticalPosition vertical_position;
  79
  80         std::list<Block> blocks;
  81
  82         bool same_metadata (RawSubtitle) const;
  83 };
  84
  85 class Subtitle
  86 {
  87 public:
  88         Subtitle ()
  89         {}
  90
  91         /** Construct a Line taking any relevant information from a RawSubtitle */
  92         Subtitle (RawSubtitle s);
  93
  94         /** from time */
  95         TimePair from;
  96         /** to time */
  97         TimePair to;
  98
  99         boost::optional<MetricTime> fade_up;
 100         boost::optional<MetricTime> fade_down;
 101
 102         std::list<Line> lines;
 103
 104         bool same_metadata (RawSubtitle) const;
 105 };
 106
 107 }
 108
 109 #endif