src/reel_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_asset.cc
  36  *  @brief ReelAsset class
  37  */
  38
  39
  40 #include "raw_convert.h"
  41 #include "reel_asset.h"
  42 #include "asset.h"
  43 #include "compose.hpp"
  44 #include "dcp_assert.h"
  45 #include <libcxml/cxml.h>
  46 #include <libxml++/libxml++.h>
  47
  48
  49 using std::pair;
  50 using std::string;
  51 using std::make_pair;
  52 using std::shared_ptr;
  53 using boost::optional;
  54 using namespace dcp;
  55
  56
  57 ReelAsset::ReelAsset (string id, Fraction edit_rate, int64_t intrinsic_duration, int64_t entry_point)
  58         : Object (id)
  59         , _intrinsic_duration (intrinsic_duration)
  60         , _duration (intrinsic_duration - entry_point)
  61         , _edit_rate (edit_rate)
  62         , _entry_point (entry_point)
  63 {
  64         DCP_ASSERT (_entry_point <= _intrinsic_duration);
  65 }
  66
  67
  68 ReelAsset::ReelAsset (shared_ptr<const cxml::Node> node)
  69         : Object (remove_urn_uuid (node->string_child ("Id")))
  70         , _intrinsic_duration (node->number_child<int64_t> ("IntrinsicDuration"))
  71         , _duration (node->optional_number_child<int64_t>("Duration"))
  72         , _annotation_text (node->optional_string_child ("AnnotationText").get_value_or (""))
  73         , _edit_rate (Fraction (node->string_child ("EditRate")))
  74         , _entry_point (node->optional_number_child<int64_t>("EntryPoint"))
  75 {
  76
  77 }
  78
  79
  80 xmlpp::Node*
  81 ReelAsset::write_to_cpl_asset (xmlpp::Node* node, Standard standard, optional<string> hash) const
  82 {
  83         auto a = node->add_child (cpl_node_name (standard));
  84         auto const attr = cpl_node_attribute (standard);
  85         if (!attr.first.empty ()) {
  86                 a->set_attribute (attr.first, attr.second);
  87         }
  88         auto const ns = cpl_node_namespace (standard);
  89         if (!ns.first.empty ()) {
  90                 a->set_namespace_declaration (ns.first, ns.second);
  91         }
  92         a->add_child("Id")->add_child_text ("urn:uuid:" + _id);
  93         a->add_child("AnnotationText")->add_child_text (_annotation_text);
  94         a->add_child("EditRate")->add_child_text (_edit_rate.as_string());
  95         a->add_child("IntrinsicDuration")->add_child_text (raw_convert<string> (_intrinsic_duration));
  96         if (_entry_point) {
  97                 a->add_child("EntryPoint")->add_child_text(raw_convert<string>(*_entry_point));
  98         }
  99         if (_duration) {
 100                 a->add_child("Duration")->add_child_text(raw_convert<string>(*_duration));
 101         }
 102         if (hash) {
 103                 a->add_child("Hash")->add_child_text (hash.get());
 104         }
 105         return a;
 106 }
 107
 108
 109 pair<string, string>
 110 ReelAsset::cpl_node_attribute (Standard) const
 111 {
 112         return make_pair ("", "");
 113 }
 114
 115
 116 pair<string, string>
 117 ReelAsset::cpl_node_namespace (Standard) const
 118 {
 119         return make_pair ("", "");
 120 }
 121
 122
 123 bool
 124 ReelAsset::asset_equals (shared_ptr<const ReelAsset> other, EqualityOptions opt, NoteHandler note) const
 125 {
 126         if (_annotation_text != other->_annotation_text) {
 127                 string const s = "Reel: annotation texts differ (" + _annotation_text + " vs " + other->_annotation_text + ")\n";
 128                 if (!opt.reel_annotation_texts_can_differ) {
 129                         note (NoteType::ERROR, s);
 130                         return false;
 131                 } else {
 132                         note (NoteType::NOTE, s);
 133                 }
 134         }
 135
 136         if (_edit_rate != other->_edit_rate) {
 137                 note (NoteType::ERROR, "Reel: edit rates differ");
 138                 return false;
 139         }
 140
 141         if (_intrinsic_duration != other->_intrinsic_duration) {
 142                 note (NoteType::ERROR, String::compose ("Reel: intrinsic durations differ (%1 vs %2)", _intrinsic_duration, other->_intrinsic_duration));
 143                 return false;
 144         }
 145
 146         if (_entry_point != other->_entry_point) {
 147                 note (NoteType::ERROR, "Reel: entry points differ");
 148                 return false;
 149         }
 150
 151         if (_duration != other->_duration) {
 152                 note (NoteType::ERROR, "Reel: durations differ");
 153                 return false;
 154         }
 155
 156         return true;
 157 }
 158
 159
 160 int64_t
 161 ReelAsset::actual_duration () const
 162 {
 163         if (_duration) {
 164                 return *_duration;
 165         }
 166
 167         return _intrinsic_duration - _entry_point.get_value_or(0);
 168 }