src/lib/subtitle.h

   1 /*
   2     Copyright (C) 2012 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 /** @file  src/subtitle.h
  21  *  @brief Representations of subtitles.
  22  */
  23
  24 #include <list>
  25 #include <boost/shared_ptr.hpp>
  26 #include "util.h"
  27
  28 struct AVSubtitle;
  29 class Image;
  30
  31 /** A subtitle, consisting of an image and a position */
  32 class Subtitle
  33 {
  34 public:
  35         Subtitle (Position p, boost::shared_ptr<Image> i);
  36
  37         void set_position (Position p) {
  38                 _position = p;
  39         }
  40
  41         Position position () const {
  42                 return _position;
  43         }
  44
  45         boost::shared_ptr<Image> image () const {
  46                 return _image;
  47         }
  48
  49         dvdomatic::Rect area () const;
  50
  51 private:
  52         Position _position;
  53         boost::shared_ptr<Image> _image;
  54 };
  55
  56 dvdomatic::Rect
  57 subtitle_transformed_area (
  58         float target_x_scale, float target_y_scale,
  59         dvdomatic::Rect sub_area, int subtitle_offset, float subtitle_scale
  60         );
  61
  62 /** A Subtitle class with details of the time over which it should be shown */
  63 class TimedSubtitle
  64 {
  65 public:
  66         TimedSubtitle (AVSubtitle const &);
  67
  68         bool displayed_at (double t) const;
  69
  70         boost::shared_ptr<Subtitle> subtitle () const {
  71                 return _subtitle;
  72         }
  73
  74 private:
  75         /** the subtitle */
  76         boost::shared_ptr<Subtitle> _subtitle;
  77         /** display from time in seconds from the start of the film */
  78         double _from;
  79         /** display to time in seconds from the start of the film */
  80         double _to;
  81 };