src/subtitle_image.h

   1 /*
   2     Copyright (C) 2018-2021 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
  35 /** @file  src/subtitle_image.h
  36  *  @brief SubtitleImage class
  37  */
  38
  39
  40 #ifndef LIBDCP_SUBTITLE_IMAGE_H
  41 #define LIBDCP_SUBTITLE_IMAGE_H
  42
  43
  44 #include "array_data.h"
  45 #include "types.h"
  46 #include "subtitle.h"
  47 #include "dcp_time.h"
  48 #include <boost/optional.hpp>
  49 #include <string>
  50
  51
  52 namespace dcp {
  53
  54
  55 /** @class SubtitleImage
  56  *  @brief A bitmap subtitle with all the associated attributes
  57  */
  58 class SubtitleImage : public Subtitle
  59 {
  60 public:
  61         SubtitleImage (
  62                 ArrayData png_image,
  63                 Time in,
  64                 Time out,
  65                 float h_position,
  66                 HAlign h_align,
  67                 float v_position,
  68                 VAlign v_align,
  69                 Time fade_up_time,
  70                 Time fade_down_time
  71                 );
  72
  73         SubtitleImage (
  74                 ArrayData png_image,
  75                 std::string id,
  76                 Time in,
  77                 Time out,
  78                 float h_position,
  79                 HAlign h_align,
  80                 float v_position,
  81                 VAlign v_align,
  82                 Time fade_up_time,
  83                 Time fade_down_time
  84                 );
  85
  86         ArrayData png_image () const {
  87                 return _png_image;
  88         }
  89
  90         void set_png_image (ArrayData png) {
  91                 _png_image = png;
  92         }
  93
  94         void read_png_file (boost::filesystem::path file);
  95         void write_png_file (boost::filesystem::path file) const;
  96
  97         std::string id () const {
  98                 return _id;
  99         }
 100
 101         /** @return the most recent disk file used to read or write this asset, if there is one */
 102         boost::optional<boost::filesystem::path> file () const {
 103                 return _file;
 104         }
 105
 106         bool equals (std::shared_ptr<dcp::SubtitleImage> other, EqualityOptions options, NoteHandler note);
 107
 108 private:
 109         ArrayData _png_image;
 110         std::string _id;
 111         mutable boost::optional<boost::filesystem::path> _file;
 112 };
 113
 114
 115 bool operator== (SubtitleImage const & a, SubtitleImage const & b);
 116 bool operator!= (SubtitleImage const & a, SubtitleImage const & b);
 117 std::ostream& operator<< (std::ostream& s, SubtitleImage const & sub);
 118
 119
 120 }
 121
 122
 123 #endif