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 #include "key.h"
  26
  27 namespace ASDCP {
  28         class AESEncContext;
  29         class AESDecContext;
  30 }
  31
  32 namespace libdcp
  33 {
  34
  35 class MXFMetadata;
  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 (
  59                 std::string directory,
  60                 std::string file_name,
  61                 boost::signals2::signal<void (float)>* progress,
  62                 int edit_rate,
  63                 int intrinsic_duration
  64                 );
  65
  66         ~MXFAsset ();
  67
  68         virtual bool equals (boost::shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, std::string)> note) const;
  69
  70         virtual void write_to_cpl (xmlpp::Element *, bool interop) const;
  71
  72         /** Fill in a ADSCP::WriteInfo struct.
  73          *  @param w struct to fill in.
  74          *  @param uuid uuid to use.
  75          *  @param true to label as interop, false for SMPTE.
  76          */
  77         void fill_writer_info (ASDCP::WriterInfo* w, std::string uuid, bool interop, MXFMetadata const & metadata);
  78
  79         void add_typed_key_id (xmlpp::Element *) const;
  80
  81         bool encrypted () const {
  82                 return !_key_id.empty ();
  83         }
  84
  85         void set_key_id (std::string i) {
  86                 _key_id = i;
  87         }
  88
  89         std::string key_id () const {
  90                 return _key_id;
  91         }
  92
  93         void set_key (Key);
  94
  95         boost::optional<Key> key () const {
  96                 return _key;
  97         }
  98
  99         ASDCP::AESEncContext* encryption_context () const {
 100                 return _encryption_context;
 101         }
 102
 103 protected:
 104         virtual std::string key_type () const = 0;
 105         virtual std::string cpl_node_name () const = 0;
 106         virtual std::pair<std::string, std::string> cpl_node_attribute (bool) const {
 107                 return std::make_pair ("", "");
 108         }
 109
 110         /** Signal to emit to report progress, or 0 */
 111         boost::signals2::signal<void (float)>* _progress;
 112         ASDCP::AESEncContext* _encryption_context;
 113         ASDCP::AESDecContext* _decryption_context;
 114         std::string _key_id;
 115         boost::optional<Key> _key;
 116 };
 117
 118 }
 119
 120 #endif