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 asset Asset that this ReelAsset refers to.
  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 (shared_ptr<Asset> asset, Fraction edit_rate, int64_t intrinsic_duration, int64_t entry_point)
  59         : Object (asset->id ())
  60         , _edit_rate (edit_rate)
  61         , _intrinsic_duration (intrinsic_duration)
  62         , _entry_point (entry_point)
  63         , _duration (intrinsic_duration - entry_point)
  64 {
  65         /* default _annotation_text to the leaf name of our file */
  66         if (asset->file ()) {
  67                 _annotation_text = asset->file()->leaf().string ();
  68         }
  69 }
  70
  71 ReelAsset::ReelAsset (shared_ptr<const cxml::Node> node)
  72         : Object (remove_urn_uuid (node->string_child ("Id")))
  73         , _annotation_text (node->optional_string_child ("AnnotationText").get_value_or (""))
  74         , _edit_rate (Fraction (node->string_child ("EditRate")))
  75         , _intrinsic_duration (node->number_child<int64_t> ("IntrinsicDuration"))
  76         , _entry_point (node->number_child<int64_t> ("EntryPoint"))
  77         , _duration (node->number_child<int64_t> ("Duration"))
  78 {
  79
  80 }
  81
  82 xmlpp::Node*
  83 ReelAsset::write_to_cpl_base (xmlpp::Node* node, Standard standard, optional<string> hash) const
  84 {
  85         xmlpp::Element* a = node->add_child (cpl_node_name (standard));
  86         pair<string, string> const attr = cpl_node_attribute (standard);
  87         if (!attr.first.empty ()) {
  88                 a->set_attribute (attr.first, attr.second);
  89         }
  90         pair<string, string> const ns = cpl_node_namespace (standard);
  91         if (!ns.first.empty ()) {
  92                 a->set_namespace_declaration (ns.first, ns.second);
  93         }
  94         a->add_child("Id")->add_child_text ("urn:uuid:" + _id);
  95         a->add_child("AnnotationText")->add_child_text (_annotation_text);
  96         a->add_child("EditRate")->add_child_text (String::compose ("%1 %2", _edit_rate.numerator, _edit_rate.denominator));
  97         a->add_child("IntrinsicDuration")->add_child_text (raw_convert<string> (_intrinsic_duration));
  98         a->add_child("EntryPoint")->add_child_text (raw_convert<string> (_entry_point));
  99         a->add_child("Duration")->add_child_text (raw_convert<string> (_duration));
 100         if (hash) {
 101                 a->add_child("Hash")->add_child_text (hash.get());
 102         }
 103         return a;
 104 }
 105
 106 pair<string, string>
 107 ReelAsset::cpl_node_attribute (Standard) const
 108 {
 109         return make_pair ("", "");
 110 }
 111
 112 pair<string, string>
 113 ReelAsset::cpl_node_namespace (Standard) const
 114 {
 115         return make_pair ("", "");
 116 }
 117
 118 bool
 119 ReelAsset::asset_equals (shared_ptr<const ReelAsset> other, EqualityOptions opt, NoteHandler note) const
 120 {
 121         if (_annotation_text != other->_annotation_text) {
 122                 string const s = "Reel: annotation texts differ (" + _annotation_text + " vs " + other->_annotation_text + ")\n";
 123                 if (!opt.reel_annotation_texts_can_differ) {
 124                         note (DCP_ERROR, s);
 125                         return false;
 126                 } else {
 127                         note (DCP_NOTE, s);
 128                 }
 129         }
 130
 131         if (_edit_rate != other->_edit_rate) {
 132                 note (DCP_ERROR, "Reel: edit rates differ");
 133                 return false;
 134         }
 135
 136         if (_intrinsic_duration != other->_intrinsic_duration) {
 137                 note (DCP_ERROR, String::compose ("Reel: intrinsic durations differ (%1 vs %2)", _intrinsic_duration, other->_intrinsic_duration));
 138                 return false;
 139         }
 140
 141         if (_entry_point != other->_entry_point) {
 142                 note (DCP_ERROR, "Reel: entry points differ");
 143                 return false;
 144         }
 145
 146         if (_duration != other->_duration) {
 147                 note (DCP_ERROR, "Reel: durations differ");
 148                 return false;
 149         }
 150
 151         return true;
 152 }