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