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         /** Subtitle text in UTF-8 */
  46         std::string text;
  47         std::string font;
  48
  49         /** font size */
  50         struct {
  51                 /** as a proportion of screen height */
  52                 boost::optional<float> proportional;
  53                 /** in points */
  54                 boost::optional<int> points;
  55         } font_size;
  56
  57         float font_size_proportional (int screen_height_in_points) const;
  58         int font_size_points (int screen_height_in_points) const;
  59
  60         /** vertical position of the baseline of the text */
  61         struct {
  62                 /** as a proportion of screen height offset from some reference point */
  63                 boost::optional<float> proportional;
  64                 /** reference position for proportional */
  65                 boost::optional<VerticalReference> reference;
  66         } vertical_position;
  67
  68         boost::optional<Effect> effect;
  69         boost::optional<Colour> effect_colour;
  70
  71         Colour colour;
  72         bool bold;      ///< true to use a bold version of font
  73         bool italic;    ///< true to use an italic version of font
  74         bool underline; ///< true to underline
  75         int line;       ///< line number, starting from 0
  76
  77         /** from time */
  78         struct {
  79                 boost::optional<FrameTime> frame;
  80                 boost::optional<MetricTime> metric;
  81         } from;
  82
  83         FrameTime  from_frame  (float frames_per_second) const;
  84         MetricTime from_metric (float frames_per_second) const;
  85
  86         /** to time */
  87         struct {
  88                 boost::optional<FrameTime> frame;
  89                 boost::optional<MetricTime> metric;
  90         } to;
  91
  92         FrameTime  to_frame  (float frames_per_second) const;
  93         MetricTime to_metric (float frames_per_second) const;
  94
  95         boost::optional<MetricTime> fade_up;
  96         boost::optional<MetricTime> fade_down;
  97 };
  98
  99 bool operator< (Subtitle const & a, Subtitle const & b);
 100
 101 }
 102
 103 #endif