src/reel_asset.cc

   1 /*
   2     Copyright (C) 2014-2015 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 /** @file  src/reel_asset.cc
  35  *  @brief ReelAsset class.
  36  */
  37
  38 #include "raw_convert.h"
  39 #include "reel_asset.h"
  40 #include "asset.h"
  41 #include "compose.hpp"
  42 #include <libcxml/cxml.h>
  43 #include <libxml++/libxml++.h>
  44
  45 using std::pair;
  46 using std::string;
  47 using std::make_pair;
  48 using boost::shared_ptr;
  49 using boost::optional;
  50 using namespace dcp;
  51
  52 /** Construct a ReelAsset.
  53  *  @param id ID of this ReelAsset (which is that of the MXF, if there is one)
  54  *  @param edit_rate Edit rate for the asset.
  55  *  @param intrinsic_duration Intrinsic duration of this asset.
  56  *  @param entry_point Entry point to use in that asset.
  57  */
  58 ReelAsset::ReelAsset (string id, Fraction edit_rate, int64_t intrinsic_duration, int64_t entry_point)
  59         : Object (id)
  60         , _intrinsic_duration (intrinsic_duration)
  61         , _duration (intrinsic_duration - entry_point)
  62         , _edit_rate (edit_rate)
  63         , _entry_point (entry_point)
  64 {
  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 xmlpp::Node*
  80 ReelAsset::write_to_cpl_asset (xmlpp::Node* node, Standard standard, optional<string> hash) const
  81 {
  82         xmlpp::Element* a = node->add_child (cpl_node_name (standard));
  83         pair<string, string> const attr = cpl_node_attribute (standard);
  84         if (!attr.first.empty ()) {
  85                 a->set_attribute (attr.first, attr.second);
  86         }
  87         pair<string, string> const ns = cpl_node_namespace (standard);
  88         if (!ns.first.empty ()) {
  89                 a->set_namespace_declaration (ns.first, ns.second);
  90         }
  91         a->add_child("Id")->add_child_text ("urn:uuid:" + _id);
  92         a->add_child("AnnotationText")->add_child_text (_annotation_text);
  93         a->add_child("EditRate")->add_child_text (_edit_rate.as_string());
  94         a->add_child("IntrinsicDuration")->add_child_text (raw_convert<string> (_intrinsic_duration));
  95         if (_entry_point) {
  96                 a->add_child("EntryPoint")->add_child_text(raw_convert<string>(*_entry_point));
  97         }
  98         if (_duration) {
  99                 a->add_child("Duration")->add_child_text(raw_convert<string>(*_duration));
 100         }
 101         if (hash) {
 102                 a->add_child("Hash")->add_child_text (hash.get());
 103         }
 104         return a;
 105 }
 106
 107 pair<string, string>
 108 ReelAsset::cpl_node_attribute (Standard) const
 109 {
 110         return make_pair ("", "");
 111 }
 112
 113 pair<string, string>
 114 ReelAsset::cpl_node_namespace (Standard) const
 115 {
 116         return make_pair ("", "");
 117 }
 118
 119 bool
 120 ReelAsset::asset_equals (shared_ptr<const ReelAsset> other, EqualityOptions opt, NoteHandler note) const
 121 {
 122         if (_annotation_text != other->_annotation_text) {
 123                 string const s = "Reel: annotation texts differ (" + _annotation_text + " vs " + other->_annotation_text + ")\n";
 124                 if (!opt.reel_annotation_texts_can_differ) {
 125                         note (DCP_ERROR, s);
 126                         return false;
 127                 } else {
 128                         note (DCP_NOTE, s);
 129                 }
 130         }
 131
 132         if (_edit_rate != other->_edit_rate) {
 133                 note (DCP_ERROR, "Reel: edit rates differ");
 134                 return false;
 135         }
 136
 137         if (_intrinsic_duration != other->_intrinsic_duration) {
 138                 note (DCP_ERROR, String::compose ("Reel: intrinsic durations differ (%1 vs %2)", _intrinsic_duration, other->_intrinsic_duration));
 139                 return false;
 140         }
 141
 142         if (_entry_point != other->_entry_point) {
 143                 note (DCP_ERROR, "Reel: entry points differ");
 144                 return false;
 145         }
 146
 147         if (_duration != other->_duration) {
 148                 note (DCP_ERROR, "Reel: durations differ");
 149                 return false;
 150         }
 151
 152         return true;
 153 }
 154
 155 /** @return <Duration>, or <IntrinsicDuration> - <EntryPoint> if <Duration> is not present */
 156 int64_t
 157 ReelAsset::actual_duration () const
 158 {
 159         if (_duration) {
 160                 return *_duration;
 161         }
 162
 163         return _intrinsic_duration - _entry_point.get_value_or(0);
 164 }