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