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 #include "metadata.h"
  27
  28 namespace ASDCP {
  29         class AESEncContext;
  30         class AESDecContext;
  31 }
  32
  33 namespace libdcp
  34 {
  35
  36 class MXFMetadata;
  37
  38 /** @brief Parent class for assets which have MXF files */
  39 class MXFAsset : public Asset
  40 {
  41 public:
  42         /** Construct an MXFAsset.
  43          *  This class will not write anything to disk in this constructor, but subclasses may.
  44          *
  45          *  @param directory Directory where MXF file is.
  46          *  @param file_name Name of MXF file.
  47          */
  48         MXFAsset (boost::filesystem::path directory, std::string file_name);
  49
  50         ~MXFAsset ();
  51
  52         virtual bool equals (boost::shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, std::string)> note) const;
  53         virtual void write_to_cpl (xmlpp::Element *, bool interop) const;
  54         virtual std::string key_type () const = 0;
  55
  56         /** Fill in a ADSCP::WriteInfo struct.
  57          *  @param w struct to fill in.
  58          *  @param uuid uuid to use.
  59          *  @param true to label as interop, false for SMPTE.
  60          */
  61         void fill_writer_info (ASDCP::WriterInfo* w, std::string uuid, bool interop, MXFMetadata const & metadata);
  62
  63         void set_progress (boost::signals2::signal<void (float)>* progress) {
  64                 _progress = progress;
  65         }
  66
  67         bool encrypted () const {
  68                 return !_key_id.empty ();
  69         }
  70
  71         void set_key_id (std::string i) {
  72                 _key_id = i;
  73         }
  74
  75         std::string key_id () const {
  76                 return _key_id;
  77         }
  78
  79         void set_key (Key);
  80
  81         boost::optional<Key> key () const {
  82                 return _key;
  83         }
  84
  85         ASDCP::AESEncContext* encryption_context () const {
  86                 return _encryption_context;
  87         }
  88
  89         void set_metadata (MXFMetadata m) {
  90                 _metadata = m;
  91         }
  92
  93         MXFMetadata metadata () const {
  94                 return _metadata;
  95         }
  96
  97         void set_interop (bool i) {
  98                 _interop = i;
  99         }
 100
 101         bool interop () const {
 102                 return _interop;
 103         }
 104
 105 protected:
 106         virtual std::string cpl_node_name () const = 0;
 107         virtual std::pair<std::string, std::string> cpl_node_attribute (bool) const {
 108                 return std::make_pair ("", "");
 109         }
 110
 111         /** Signal to emit to report progress, or 0 */
 112         boost::signals2::signal<void (float)>* _progress;
 113         ASDCP::AESEncContext* _encryption_context;
 114         ASDCP::AESDecContext* _decryption_context;
 115         std::string _key_id;
 116         boost::optional<Key> _key;
 117         MXFMetadata _metadata;
 118         bool _interop;
 119 };
 120
 121 }
 122
 123 #endif