src/reel_mxf.h

   1 /*
   2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  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         ReelMXF (boost::optional<std::string> key_id);
  45         ReelMXF (boost::shared_ptr<const cxml::Node>);
  46
  47         /** @return the 4-character key type for this MXF (MDIK, MDAK, etc.) */
  48         virtual std::string key_type () const = 0;
  49
  50         /** @return true if a KeyId is specified for this asset, implying
  51          *  that its content is encrypted.
  52          */
  53         bool encrypted () const {
  54                 return _key_id;
  55         }
  56
  57         /** @return Key ID to describe the key that encrypts this asset's
  58          *  content, if there is one.
  59          */
  60         boost::optional<std::string> key_id () const {
  61                 return _key_id;
  62         }
  63
  64 private:
  65         boost::optional<std::string> _key_id; ///< The &lt;KeyId&gt; from the reel's entry for this asset, if there is one
  66 };
  67
  68 }
  69
  70 #endif