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, boost::filesystem::path 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 *) 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          */
  60         void fill_writer_info (ASDCP::WriterInfo* w, std::string uuid, MXFMetadata const & metadata);
  61
  62         void set_progress (boost::signals2::signal<void (float)>* progress) {
  63                 _progress = progress;
  64         }
  65
  66         bool encrypted () const {
  67                 return !_key_id.empty ();
  68         }
  69
  70         void set_key_id (std::string i) {
  71                 _key_id = i;
  72         }
  73
  74         std::string key_id () const {
  75                 return _key_id;
  76         }
  77
  78         void set_key (Key);
  79
  80         boost::optional<Key> key () const {
  81                 return _key;
  82         }
  83
  84         ASDCP::AESEncContext* encryption_context () const {
  85                 return _encryption_context;
  86         }
  87
  88         void set_metadata (MXFMetadata m) {
  89                 _metadata = m;
  90         }
  91
  92         MXFMetadata metadata () const {
  93                 return _metadata;
  94         }
  95
  96         /** Set whether or not the asset should be written in Interop mode.
  97          *  @param i true to use interop.
  98          */
  99         void set_interop (bool i) {
 100                 _interop = i;
 101         }
 102
 103         bool interop () const {
 104                 return _interop;
 105         }
 106
 107 protected:
 108         virtual std::string cpl_node_name () const = 0;
 109         virtual std::pair<std::string, std::string> cpl_node_attribute () const {
 110                 return std::make_pair ("", "");
 111         }
 112
 113         /** Signal to emit to report progress, or 0 */
 114         boost::signals2::signal<void (float)>* _progress;
 115         ASDCP::AESEncContext* _encryption_context;
 116         ASDCP::AESDecContext* _decryption_context;
 117         std::string _key_id;
 118         boost::optional<Key> _key;
 119         MXFMetadata _metadata;
 120         bool _interop;
 121 };
 122
 123 }
 124
 125 #endif