src/reel_mxf.h

   1 /*
   2     Copyright (C) 2012-2019 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_mxf.h
  35  *  @brief ReelMXF
  36  */
  37
  38 #ifndef LIBDCP_REEL_MXF_H
  39 #define LIBDCP_REEL_MXF_H
  40
  41 #include "ref.h"
  42 #include <boost/optional.hpp>
  43 #include <memory>
  44 #include <string>
  45
  46 namespace cxml {
  47         class Node;
  48 }
  49
  50 namespace dcp {
  51
  52 /** @class ReelMXF
  53  *  @brief Part of a Reel's description which refers to an asset which can be encrypted.
  54  */
  55 class ReelMXF
  56 {
  57 public:
  58         explicit ReelMXF (std::shared_ptr<Asset> asset, boost::optional<std::string> key_id);
  59         explicit ReelMXF (std::shared_ptr<const cxml::Node>);
  60         virtual ~ReelMXF () {}
  61
  62         /** @return the 4-character key type for this MXF (MDIK, MDAK, etc.) */
  63         virtual std::string key_type () const = 0;
  64
  65         /** @return a Ref to our actual asset */
  66         Ref const & asset_ref () const {
  67                 return _asset_ref;
  68         }
  69
  70         /** @return a Ref to our actual asset */
  71         Ref & asset_ref () {
  72                 return _asset_ref;
  73         }
  74
  75         /** @return the asset's hash, if this ReelMXF has been created from one,
  76          *  otherwise the hash written to the CPL for this asset (if present).
  77          */
  78         boost::optional<std::string> hash () const {
  79                 return _hash;
  80         }
  81
  82         void set_hash (std::string h) {
  83                 _hash = h;
  84         }
  85
  86         /** @return true if a KeyId is specified for this asset, implying
  87          *  that its content is encrypted.
  88          */
  89         bool encrypted () const {
  90                 return static_cast<bool>(_key_id);
  91         }
  92
  93         /** @return Key ID to describe the key that encrypts this asset's
  94          *  content, if there is one.
  95          */
  96         boost::optional<std::string> key_id () const {
  97                 return _key_id;
  98         }
  99
 100         bool mxf_equals (std::shared_ptr<const ReelMXF> other, EqualityOptions opt, NoteHandler note) const;
 101
 102 protected:
 103
 104         template <class T>
 105         std::shared_ptr<T> asset_of_type () const {
 106                 return std::dynamic_pointer_cast<T> (_asset_ref.asset ());
 107         }
 108
 109         template <class T>
 110         std::shared_ptr<T> asset_of_type () {
 111                 return std::dynamic_pointer_cast<T> (_asset_ref.asset ());
 112         }
 113
 114         void write_to_cpl_mxf (xmlpp::Node* node) const;
 115
 116         /** Reference to the asset (MXF or XML file) that this reel entry
 117          *  applies to.
 118          */
 119         Ref _asset_ref;
 120
 121 private:
 122         boost::optional<std::string> _key_id; ///< The &lt;KeyId&gt; from the reel's entry for this asset, if there is one
 123         /** Either our asset's computed hash or the hash read in from the CPL, if it's present */
 124         boost::optional<std::string> _hash;
 125 };
 126
 127 }
 128
 129 #endif