src/reel_picture_asset.cc

   1 /*
   2     Copyright (C) 2014-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/reel_picture_asset.cc
  36  *  @brief ReelPictureAsset class
  37  */
  38
  39
  40 #include "reel_picture_asset.h"
  41 #include "picture_asset.h"
  42 #include "dcp_assert.h"
  43 #include "raw_convert.h"
  44 #include "compose.hpp"
  45 #include <libcxml/cxml.h>
  46 #include <libxml++/libxml++.h>
  47 #include <iomanip>
  48 #include <cmath>
  49
  50
  51 using std::bad_cast;
  52 using std::string;
  53 using std::shared_ptr;
  54 using std::dynamic_pointer_cast;
  55 using boost::optional;
  56 using namespace dcp;
  57
  58
  59 ReelPictureAsset::ReelPictureAsset (shared_ptr<PictureAsset> asset, int64_t entry_point)
  60         : ReelFileAsset (asset, asset->key_id(), asset->id(), asset->edit_rate(), asset->intrinsic_duration(), entry_point)
  61         , _frame_rate (asset->frame_rate ())
  62         , _screen_aspect_ratio (asset->screen_aspect_ratio ())
  63 {
  64
  65 }
  66
  67
  68 ReelPictureAsset::ReelPictureAsset (shared_ptr<const cxml::Node> node)
  69         : ReelFileAsset (node)
  70 {
  71         _frame_rate = Fraction (node->string_child ("FrameRate"));
  72         try {
  73                 _screen_aspect_ratio = Fraction (node->string_child ("ScreenAspectRatio"));
  74         } catch (XMLError& e) {
  75                 /* It's not a fraction */
  76                 try {
  77                         float f = node->number_child<float> ("ScreenAspectRatio");
  78                         _screen_aspect_ratio = Fraction (f * 1000, 1000);
  79                 } catch (bad_cast& e) {
  80
  81                 }
  82         }
  83 }
  84
  85
  86 xmlpp::Node*
  87 ReelPictureAsset::write_to_cpl (xmlpp::Node* node, Standard standard) const
  88 {
  89         auto asset = ReelFileAsset::write_to_cpl (node, standard);
  90
  91         asset->add_child("FrameRate")->add_child_text(String::compose("%1 %2", _frame_rate.numerator, _frame_rate.denominator));
  92
  93         if (standard == Standard::INTEROP) {
  94
  95                 /* Allowed values for this tag from the standard */
  96                 float allowed[] = { 1.33, 1.66, 1.77, 1.85, 2.00, 2.39 };
  97                 int const num_allowed = sizeof(allowed) / sizeof(float);
  98
  99                 /* Actual ratio */
 100                 float ratio = float (_screen_aspect_ratio.numerator) / _screen_aspect_ratio.denominator;
 101
 102                 /* Pick the closest and use that */
 103                 optional<float> closest;
 104                 optional<float> error;
 105                 for (int i = 0; i < num_allowed; ++i) {
 106                         float const e = fabsf (allowed[i] - ratio);
 107                         if (!closest || e < error.get()) {
 108                                 closest = allowed[i];
 109                                 error = e;
 110                         }
 111                 }
 112
 113                 asset->add_child("ScreenAspectRatio")->add_child_text(raw_convert<string>(closest.get(), 2, true));
 114         } else {
 115                 asset->add_child("ScreenAspectRatio")->add_child_text(
 116                         String::compose ("%1 %2", _screen_aspect_ratio.numerator, _screen_aspect_ratio.denominator)
 117                         );
 118         }
 119
 120         return asset;
 121 }
 122
 123
 124 bool
 125 ReelPictureAsset::equals (shared_ptr<const ReelPictureAsset> other, EqualityOptions opt, NoteHandler note) const
 126 {
 127         if (!asset_equals (other, opt, note)) {
 128                 return false;
 129         }
 130         if (!file_asset_equals (other, opt, note)) {
 131                 return false;
 132         }
 133
 134         auto rpa = dynamic_pointer_cast<const ReelPictureAsset>(other);
 135         if (!rpa) {
 136                 return false;
 137         }
 138
 139         if (_frame_rate != rpa->_frame_rate) {
 140                 note (NoteType::ERROR, "frame rates differ in reel");
 141                 return false;
 142         }
 143
 144         if (_screen_aspect_ratio != rpa->_screen_aspect_ratio) {
 145                 note (NoteType::ERROR, "screen aspect ratios differ in reel");
 146                 return false;
 147         }
 148
 149         return true;
 150 }