src/subtitle_image.h

   1 /*
   2     Copyright (C) 2018 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of libdcp.
   5
   6     libdcp is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     libdcp is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
  18
  19     In addition, as a special exception, the copyright holders give
  20     permission to link the code of portions of this program with the
  21     OpenSSL library under certain conditions as described in each
  22     individual source file, and distribute linked combinations
  23     including the two.
  24
  25     You must obey the GNU General Public License in all respects
  26     for all of the code used other than OpenSSL.  If you modify
  27     file(s) with this exception, you may extend this exception to your
  28     version of the file(s), but you are not obligated to do so.  If you
  29     do not wish to do so, delete this exception statement from your
  30     version.  If you delete this exception statement from all source
  31     files in the program, then also delete it here.
  32 */
  33
  34 /** @file  src/subtitle_image.h
  35  *  @brief SubtitleImage class.
  36  */
  37
  38 #ifndef LIBDCP_SUBTITLE_IMAGE_H
  39 #define LIBDCP_SUBTITLE_IMAGE_H
  40
  41 #include "types.h"
  42 #include "subtitle.h"
  43 #include "data.h"
  44 #include "dcp_time.h"
  45 #include <boost/optional.hpp>
  46 #include <string>
  47
  48 namespace dcp {
  49
  50 /** @class SubtitleImage
  51  *  @brief A bitmap subtitle with all the associated attributes.
  52  */
  53 class SubtitleImage : public Subtitle
  54 {
  55 public:
  56         SubtitleImage (
  57                 Data png_image,
  58                 Time in,
  59                 Time out,
  60                 float h_position,
  61                 HAlign h_align,
  62                 float v_position,
  63                 VAlign v_align,
  64                 Time fade_up_time,
  65                 Time fade_down_time
  66                 );
  67
  68         SubtitleImage (
  69                 Data png_image,
  70                 std::string id,
  71                 Time in,
  72                 Time out,
  73                 float h_position,
  74                 HAlign h_align,
  75                 float v_position,
  76                 VAlign v_align,
  77                 Time fade_up_time,
  78                 Time fade_down_time
  79                 );
  80
  81         Data png_image () const {
  82                 return _png_image;
  83         }
  84
  85         void set_png_image (Data d) {
  86                 _png_image = d;
  87         }
  88
  89         std::string id () const {
  90                 return _id;
  91         }
  92
  93 private:
  94         Data _png_image;
  95         std::string _id;
  96 };
  97
  98 bool operator== (SubtitleImage const & a, SubtitleImage const & b);
  99 bool operator!= (SubtitleImage const & a, SubtitleImage const & b);
 100 std::ostream& operator<< (std::ostream& s, SubtitleImage const & sub);
 101
 102 }
 103
 104 #endif