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 <boost/optional.hpp>
  29 #include <string>
  30 #include <list>
  31
  32 namespace sub {
  33
  34 class Subtitle
  35 {
  36 public:
  37         Subtitle ()
  38                 : colour (1, 1, 1)
  39                 , bold (false)
  40                 , italic (false)
  41                 , underline (false)
  42                 , line (0)
  43         {}
  44
  45         std::string text;
  46         std::string font;
  47
  48         /** font size */
  49         struct {
  50                 /** as a proportion of screen height */
  51                 boost::optional<float> proportional;
  52                 /** in points */
  53                 boost::optional<int> points;
  54         } font_size;
  55
  56         /** vertical position of the baseline of the text */
  57         struct {
  58                 /** as a proportion of screen height offset from some reference point */
  59                 boost::optional<float> proportional;
  60                 /** reference position for proportional */
  61                 boost::optional<VerticalReference> reference;
  62         } vertical_position;
  63
  64         boost::optional<Effect> effect;
  65         boost::optional<Colour> effect_colour;
  66
  67         Colour colour;
  68         bool bold;      ///< true to use a bold version of font
  69         bool italic;    ///< true to use an italic version of font
  70         bool underline; ///< true to underline
  71         int line;
  72
  73         /** from time */
  74         struct {
  75                 boost::optional<FrameTime> frame;
  76                 boost::optional<MetricTime> metric;
  77         } from;
  78
  79         /** to time */
  80         struct {
  81                 boost::optional<FrameTime> frame;
  82                 boost::optional<MetricTime> metric;
  83         } to;
  84
  85         boost::optional<MetricTime> fade_up;
  86         boost::optional<MetricTime> fade_down;
  87 };
  88
  89 bool operator< (Subtitle const & a, Subtitle const & b);
  90
  91 void convert_font_sizes (std::list<Subtitle> &, int screen_height_in_points);
  92 void convert_times (std::list<Subtitle> &, float frames_per_second);
  93
  94 }
  95
  96 #endif