src/mxf_asset.h

   1 /*
   2     Copyright (C) 2012 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 #ifndef LIBDCP_MXF_ASSET_H
  21 #define LIBDCP_MXF_ASSET_H
  22
  23 #include <boost/signals2.hpp>
  24 #include "asset.h"
  25
  26 namespace ASDCP {
  27         class AESEncContext;
  28         class AESDecContext;
  29 }
  30
  31 namespace libdcp
  32 {
  33
  34 class MXFMetadata;
  35 class KDMCipher;
  36
  37 /** @brief Parent class for assets which have MXF files */
  38 class MXFAsset : public Asset
  39 {
  40 public:
  41         /** Construct an MXFAsset.
  42          *  This class will not write anything to disk in this constructor, but subclasses may.
  43          *
  44          *  @param directory Directory where MXF file is.
  45          *  @param file_name Name of MXF file.
  46          */
  47         MXFAsset (std::string directory, std::string file_name);
  48
  49         /** Construct an MXFAsset.
  50          *  This class will not write anything to disk in this constructor, but subclasses may.
  51          *
  52          *  @param directory Directory where MXF file is.
  53          *  @param file_name Name of MXF file.
  54          *  @param progress Signal to use to inform of progress, or 0.
  55          *  @param edit_rate Edit rate in frames per second (usually equal to the video frame rate).
  56          *  @param intrinsic_duration Duration of the whole asset in frames.
  57          */
  58         MXFAsset (std::string directory, std::string file_name, boost::signals2::signal<void (float)>* progress, int edit_rate, int intrinsic_duration, bool encrypted);
  59
  60         ~MXFAsset ();
  61
  62         virtual bool equals (boost::shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, std::string)> note) const;
  63
  64         virtual void write_to_cpl (xmlpp::Element *, bool interop) const;
  65
  66         /** Fill in a ADSCP::WriteInfo struct.
  67          *  @param w struct to fill in.
  68          *  @param uuid uuid to use.
  69          *  @param true to label as interop, false for SMPTE.
  70          */
  71         void fill_writer_info (ASDCP::WriterInfo* w, std::string uuid, bool interop, MXFMetadata const & metadata);
  72
  73         void add_typed_key_id (xmlpp::Element *) const;
  74
  75         std::string key_id () const {
  76                 return _key_id;
  77         }
  78
  79         void set_key_id (std::string k) {
  80                 _key_id = k;
  81         }
  82
  83         bool encrypted () const {
  84                 return !_key_id.empty ();
  85         }
  86
  87         void set_kdm_cipher (KDMCipher);
  88
  89 protected:
  90         virtual std::string key_type () const = 0;
  91         virtual std::string cpl_node_name () const = 0;
  92         virtual std::pair<std::string, std::string> cpl_node_attribute (bool) const {
  93                 return std::make_pair ("", "");
  94         }
  95
  96         /** Signal to emit to report progress, or 0 */
  97         boost::signals2::signal<void (float)>* _progress;
  98         bool _encrypted;
  99         ASDCP::AESEncContext* _encryption_context;
 100         std::string _key_value;
 101         std::string _key_id;
 102         ASDCP::AESDecContext* _decryption_context;
 103 };
 104
 105 }
 106
 107 #endif