src/reel_mxf.h

   1 /*
   2     Copyright (C) 2012-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
  20 /** @file  src/reel_mxf.h
  21  *  @brief ReelMXF
  22  */
  23
  24 #ifndef LIBDCP_REEL_ENCRYPTABLE_ASSET_H
  25 #define LIBDCP_REEL_ENCRYPTABLE_ASSET_H
  26
  27 #include <boost/optional.hpp>
  28 #include <boost/shared_ptr.hpp>
  29 #include <string>
  30
  31 namespace cxml {
  32         class Node;
  33 }
  34
  35 namespace dcp {
  36
  37 /** @class ReelMXF
  38  *  @brief Part of a Reel's description which refers to an asset which can be encrypted.
  39  */
  40 class ReelMXF
  41 {
  42 public:
  43         ReelMXF () {}
  44         explicit ReelMXF (boost::optional<std::string> key_id);
  45         explicit ReelMXF (boost::shared_ptr<const cxml::Node>);
  46         virtual ~ReelMXF () {}
  47
  48         /** @return the 4-character key type for this MXF (MDIK, MDAK, etc.) */
  49         virtual std::string key_type () const = 0;
  50
  51         /** @return true if a KeyId is specified for this asset, implying
  52          *  that its content is encrypted.
  53          */
  54         bool encrypted () const {
  55                 return static_cast<bool>(_key_id);
  56         }
  57
  58         /** @return Key ID to describe the key that encrypts this asset's
  59          *  content, if there is one.
  60          */
  61         boost::optional<std::string> key_id () const {
  62                 return _key_id;
  63         }
  64
  65 private:
  66         boost::optional<std::string> _key_id; ///< The &lt;KeyId&gt; from the reel's entry for this asset, if there is one
  67 };
  68
  69 }
  70
  71 #endif