src/reel_asset.cc

   1 /*
   2     Copyright (C) 2014-2022 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_asset.cc
  36  *  @brief ReelAsset class
  37  */
  38
  39
  40 #include "asset.h"
  41 #include "compose.hpp"
  42 #include "dcp_assert.h"
  43 #include "raw_convert.h"
  44 #include "reel_asset.h"
  45 #include "warnings.h"
  46 #include <libcxml/cxml.h>
  47 LIBDCP_DISABLE_WARNINGS
  48 #include <libxml++/libxml++.h>
  49 LIBDCP_ENABLE_WARNINGS
  50
  51
  52 using std::make_pair;
  53 using std::pair;
  54 using std::shared_ptr;
  55 using std::string;
  56 using boost::optional;
  57 using namespace dcp;
  58
  59
  60 ReelAsset::ReelAsset (string id, Fraction edit_rate, int64_t intrinsic_duration, optional<int64_t> entry_point)
  61         : Object (id)
  62         , _intrinsic_duration (intrinsic_duration)
  63         , _edit_rate (edit_rate)
  64         , _entry_point (entry_point)
  65 {
  66         if (_entry_point) {
  67                 _duration = intrinsic_duration - *_entry_point;
  68         }
  69
  70         DCP_ASSERT (!_entry_point || *_entry_point <= _intrinsic_duration);
  71 }
  72
  73
  74 ReelAsset::ReelAsset (shared_ptr<const cxml::Node> node)
  75         : Object (remove_urn_uuid (node->string_child ("Id")))
  76         , _intrinsic_duration (node->number_child<int64_t> ("IntrinsicDuration"))
  77         , _duration (node->optional_number_child<int64_t>("Duration"))
  78         , _annotation_text (node->optional_string_child("AnnotationText"))
  79         , _edit_rate (Fraction (node->string_child ("EditRate")))
  80         , _entry_point (node->optional_number_child<int64_t>("EntryPoint"))
  81 {
  82
  83 }
  84
  85
  86 xmlpp::Node*
  87 ReelAsset::write_to_cpl (xmlpp::Node* node, Standard standard) const
  88 {
  89         auto a = node->add_child (cpl_node_name (standard));
  90         auto const attr = cpl_node_attribute (standard);
  91         if (!attr.first.empty ()) {
  92                 a->set_attribute (attr.first, attr.second);
  93         }
  94         auto const ns = cpl_node_namespace ();
  95         if (!ns.first.empty()) {
  96                 a->set_namespace_declaration (ns.first, ns.second);
  97         }
  98         a->add_child("Id")->add_child_text ("urn:uuid:" + _id);
  99         /* Empty <AnnotationText> tags cause refusal to play on some Sony SRX320 / LMT3000 systems (DoM bug #2124) */
 100         if (_annotation_text && !_annotation_text->empty()) {
 101                 a->add_child("AnnotationText")->add_child_text(*_annotation_text);
 102         }
 103         a->add_child("EditRate")->add_child_text (_edit_rate.as_string());
 104         a->add_child("IntrinsicDuration")->add_child_text (raw_convert<string> (_intrinsic_duration));
 105         if (_entry_point) {
 106                 a->add_child("EntryPoint")->add_child_text(raw_convert<string>(*_entry_point));
 107         }
 108         if (_duration) {
 109                 a->add_child("Duration")->add_child_text(raw_convert<string>(*_duration));
 110         }
 111         return a;
 112 }
 113
 114
 115 pair<string, string>
 116 ReelAsset::cpl_node_attribute (Standard) const
 117 {
 118         return make_pair ("", "");
 119 }
 120
 121
 122 pair<string, string>
 123 ReelAsset::cpl_node_namespace () const
 124 {
 125         return make_pair ("", "");
 126 }
 127
 128
 129 template <class T>
 130 string
 131 optional_to_string (optional<T> o)
 132 {
 133         return o ? raw_convert<string>(*o) : "[none]";
 134 }
 135
 136
 137 bool
 138 ReelAsset::asset_equals (shared_ptr<const ReelAsset> other, EqualityOptions opt, NoteHandler note) const
 139 {
 140         auto const node = cpl_node_name(Standard::SMPTE);
 141
 142         if (_annotation_text != other->_annotation_text) {
 143                 string const s = String::compose("Reel %1: annotation texts differ (%2 vs %3)", node, optional_to_string(_annotation_text), optional_to_string(other->_annotation_text));
 144                 if (!opt.reel_annotation_texts_can_differ) {
 145                         note (NoteType::ERROR, s);
 146                         return false;
 147                 } else {
 148                         note (NoteType::NOTE, s);
 149                 }
 150         }
 151
 152         if (_edit_rate != other->_edit_rate) {
 153                 note (
 154                         NoteType::ERROR,
 155                         String::compose("Reel %1: edit rates differ (%2 vs %3)", node, _edit_rate.as_string(), other->_edit_rate.as_string())
 156                      );
 157                 return false;
 158         }
 159
 160         if (_intrinsic_duration != other->_intrinsic_duration) {
 161                 note (
 162                         NoteType::ERROR,
 163                         String::compose("Reel %1: intrinsic durations differ (%2 vs %3)", node, _intrinsic_duration, other->_intrinsic_duration)
 164                      );
 165                 return false;
 166         }
 167
 168         if (_entry_point != other->_entry_point) {
 169                 note (
 170                         NoteType::ERROR,
 171                         String::compose("Reel %1: entry points differ (%2 vs %3)", node, optional_to_string(_entry_point), optional_to_string(other->_entry_point))
 172                      );
 173                 return false;
 174         }
 175
 176         if (_duration != other->_duration) {
 177                 note (
 178                         NoteType::ERROR,
 179                         String::compose("Reel %1: durations differ (%2 vs %3)", node, optional_to_string(_duration), optional_to_string(other->_duration))
 180                      );
 181                 return false;
 182         }
 183
 184         return true;
 185 }
 186
 187
 188 int64_t
 189 ReelAsset::actual_duration () const
 190 {
 191         if (_duration) {
 192                 return *_duration;
 193         }
 194
 195         return _intrinsic_duration - _entry_point.get_value_or(0);
 196 }