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 #include <iostream>
  45
  46 using std::pair;
  47 using std::cout;
  48 using std::string;
  49 using std::stringstream;
  50 using std::make_pair;
  51 using boost::shared_ptr;
  52 using namespace dcp;
  53
  54 ReelAsset::ReelAsset ()
  55         : _asset_ref (_id)
  56         , _edit_rate (Fraction (24, 1))
  57         , _intrinsic_duration (0)
  58         , _entry_point (0)
  59         , _duration (0)
  60 {
  61
  62 }
  63
  64 /** Construct a ReelAsset.
  65  *  @param asset Asset that this ReelAsset refers to.
  66  *  @param edit_rate Edit rate for the asset.
  67  *  @param intrinsic_duration Intrinsic duration of this asset.
  68  *  @param entry_point Entry point to use in that asset.
  69  */
  70 ReelAsset::ReelAsset (shared_ptr<Asset> asset, Fraction edit_rate, int64_t intrinsic_duration, int64_t entry_point)
  71         : Object (asset->id ())
  72         , _asset_ref (asset)
  73         , _edit_rate (edit_rate)
  74         , _intrinsic_duration (intrinsic_duration)
  75         , _entry_point (entry_point)
  76         , _duration (intrinsic_duration - entry_point)
  77         , _hash (asset->hash ())
  78 {
  79         /* default _annotation_text to the leaf name of our file */
  80         _annotation_text = asset->file().leaf().string ();
  81 }
  82
  83 ReelAsset::ReelAsset (shared_ptr<const cxml::Node> node)
  84         : Object (remove_urn_uuid (node->string_child ("Id")))
  85         , _asset_ref (_id)
  86         , _annotation_text (node->optional_string_child ("AnnotationText").get_value_or (""))
  87         , _edit_rate (Fraction (node->string_child ("EditRate")))
  88         , _intrinsic_duration (node->number_child<int64_t> ("IntrinsicDuration"))
  89         , _entry_point (node->number_child<int64_t> ("EntryPoint"))
  90         , _duration (node->number_child<int64_t> ("Duration"))
  91         , _hash (node->optional_string_child ("Hash"))
  92 {
  93
  94 }
  95
  96 void
  97 ReelAsset::write_to_cpl (xmlpp::Node* node, Standard standard) const
  98 {
  99         pair<string, string> const attr = cpl_node_attribute (standard);
 100         xmlpp::Element* a = node->add_child (cpl_node_name ());
 101         if (!attr.first.empty ()) {
 102                 a->set_attribute (attr.first, attr.second);
 103         }
 104         a->add_child("Id")->add_child_text ("urn:uuid:" + _id);
 105         a->add_child("AnnotationText")->add_child_text (_annotation_text);
 106         a->add_child("EditRate")->add_child_text (String::compose ("%1 %2", _edit_rate.numerator, _edit_rate.denominator));
 107         a->add_child("IntrinsicDuration")->add_child_text (raw_convert<string> (_intrinsic_duration));
 108         a->add_child("EntryPoint")->add_child_text (raw_convert<string> (_entry_point));
 109         a->add_child("Duration")->add_child_text (raw_convert<string> (_duration));
 110         if (_hash) {
 111                 a->add_child("Hash")->add_child_text (_hash.get());
 112         }
 113 }
 114
 115 pair<string, string>
 116 ReelAsset::cpl_node_attribute (Standard) const
 117 {
 118         return make_pair ("", "");
 119 }
 120
 121 bool
 122 ReelAsset::equals (shared_ptr<const ReelAsset> other, EqualityOptions opt, NoteHandler note) const
 123 {
 124         if (_annotation_text != other->_annotation_text) {
 125                 stringstream s;
 126                 s << "Reel: annotation texts differ (" << _annotation_text << " vs " << other->_annotation_text << ")\n";
 127                 if (!opt.reel_annotation_texts_can_differ) {
 128                         note (DCP_ERROR, s.str ());
 129                         return false;
 130                 } else {
 131                         note (DCP_NOTE, s.str ());
 132                 }
 133         }
 134
 135         if (_edit_rate != other->_edit_rate) {
 136                 note (DCP_ERROR, "Reel: edit rates differ");
 137                 return false;
 138         }
 139
 140         if (_intrinsic_duration != other->_intrinsic_duration) {
 141                 note (DCP_ERROR, String::compose ("Reel: intrinsic durations differ (%1 vs %2)", _intrinsic_duration, other->_intrinsic_duration));
 142                 return false;
 143         }
 144
 145         if (_entry_point != other->_entry_point) {
 146                 note (DCP_ERROR, "Reel: entry points differ");
 147                 return false;
 148         }
 149
 150         if (_duration != other->_duration) {
 151                 note (DCP_ERROR, "Reel: durations differ");
 152                 return false;
 153         }
 154
 155         if (_hash != other->_hash) {
 156                 if (!opt.reel_hashes_can_differ) {
 157                         note (DCP_ERROR, "Reel: hashes differ");
 158                         return false;
 159                 } else {
 160                         note (DCP_NOTE, "Reel: hashes differ");
 161                 }
 162         }
 163
 164         if (_asset_ref.resolved () && other->_asset_ref.resolved ()) {
 165                 return _asset_ref->equals (other->_asset_ref.asset(), opt, note);
 166         }
 167
 168         return true;
 169 }