src/subtitle_image.cc

   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.cc
  36  *  @brief SubtitleImage class
  37  */
  38
  39
  40 #include "equality_options.h"
  41 #include "subtitle_image.h"
  42 #include "util.h"
  43
  44
  45 using std::dynamic_pointer_cast;
  46 using std::ostream;
  47 using std::shared_ptr;
  48 using std::string;
  49 using namespace dcp;
  50
  51
  52 SubtitleImage::SubtitleImage (
  53         ArrayData png_image,
  54         Time in,
  55         Time out,
  56         float h_position,
  57         HAlign h_align,
  58         float v_position,
  59         VAlign v_align,
  60         float z_position,
  61         Time fade_up_time,
  62         Time fade_down_time
  63         )
  64         : Subtitle(in, out, h_position, h_align, v_position, v_align, z_position, fade_up_time, fade_down_time)
  65         , _png_image (png_image)
  66         , _id (make_uuid ())
  67 {
  68
  69 }
  70
  71
  72 SubtitleImage::SubtitleImage (
  73         ArrayData png_image,
  74         string id,
  75         Time in,
  76         Time out,
  77         float h_position,
  78         HAlign h_align,
  79         float v_position,
  80         VAlign v_align,
  81         float z_position,
  82         Time fade_up_time,
  83         Time fade_down_time
  84         )
  85         : Subtitle(in, out, h_position, h_align, v_position, v_align, z_position, fade_up_time, fade_down_time)
  86         , _png_image (png_image)
  87         , _id (id)
  88 {
  89
  90 }
  91
  92
  93 void
  94 SubtitleImage::read_png_file (boost::filesystem::path file)
  95 {
  96         _file = file;
  97         _png_image = ArrayData (file);
  98 }
  99
 100
 101 void
 102 SubtitleImage::write_png_file (boost::filesystem::path file) const
 103 {
 104         _file = file;
 105         png_image().write (file);
 106 }
 107
 108
 109 bool
 110 dcp::operator== (SubtitleImage const & a, SubtitleImage const & b)
 111 {
 112         return (
 113                 a.png_image() == b.png_image() &&
 114                 a.id() == b.id() &&
 115                 a.in() == b.in() &&
 116                 a.out() == b.out() &&
 117                 a.h_position() == b.h_position() &&
 118                 a.h_align() == b.h_align() &&
 119                 a.v_position() == b.v_position() &&
 120                 a.v_align() == b.v_align() &&
 121                 a.z_position() == b.z_position() &&
 122                 a.fade_up_time() == b.fade_up_time() &&
 123                 a.fade_down_time() == b.fade_down_time()
 124                 );
 125 }
 126
 127
 128 bool
 129 dcp::operator!= (SubtitleImage const & a, SubtitleImage const & b)
 130 {
 131         return !(a == b);
 132 }
 133
 134
 135 bool
 136 SubtitleImage::equals(shared_ptr<const Subtitle> other_sub, EqualityOptions const& options, NoteHandler note) const
 137 {
 138         if (!Subtitle::equals(other_sub, options, note)) {
 139                 return false;
 140         }
 141
 142         auto other = dynamic_pointer_cast<const SubtitleImage>(other_sub);
 143         if (!other) {
 144                 note(NoteType::ERROR, "Subtitle types differ: string vs image");
 145                 return false;
 146         }
 147
 148         if (png_image() != other->png_image()) {
 149                 note (NoteType::ERROR, "subtitle image PNG data differs");
 150                 if (options.export_differing_subtitles) {
 151                         string const base = "dcpdiff_subtitle_";
 152                         if (boost::filesystem::exists(base + "A.png")) {
 153                                 note (NoteType::ERROR, "could not export subtitle as " + base + "A.png already exists");
 154                         } else {
 155                                 png_image().write(base + "A.png");
 156                         }
 157                         if (boost::filesystem::exists(base + "B.png")) {
 158                                 note (NoteType::ERROR, "could not export subtitle as " + base + "B.png already exists");
 159                         } else {
 160                                 other->png_image().write(base + "B.png");
 161                         }
 162                 }
 163                 return false;
 164         }
 165
 166         return true;
 167 }
 168
 169
 170 ostream&
 171 dcp::operator<< (ostream& s, SubtitleImage const & sub)
 172 {
 173         s << "\n[IMAGE] from " << sub.in() << " to " << sub.out() << ";\n"
 174           << "fade up " << sub.fade_up_time() << ", fade down " << sub.fade_down_time() << ";\n"
 175           << "v pos " << sub.v_position() << ", valign " << ((int) sub.v_align())
 176           << ", hpos " << sub.h_position() << ", halign " << ((int) sub.h_align())
 177           << ", zpos " << sub.z_position() << "\n";
 178
 179         return s;
 180 }
 181