src/mxf.h

   1 /*
   2     Copyright (C) 2012-2014 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_H
  21 #define LIBDCP_MXF_H
  22
  23 #include "content.h"
  24 #include "key.h"
  25 #include "metadata.h"
  26 #include <boost/signals2.hpp>
  27
  28 namespace ASDCP {
  29         class AESEncContext;
  30         class AESDecContext;
  31 }
  32
  33 namespace dcp
  34 {
  35
  36 class MXFMetadata;
  37
  38 /** @class MXF
  39  *  @brief Parent class for classes which represent MXF files.
  40  */
  41 class MXF : public Content
  42 {
  43 public:
  44         MXF (Fraction edit_rate);
  45         MXF (boost::filesystem::path file);
  46         ~MXF ();
  47
  48         /** @return the 4-character key type for this MXF (MDIK, MDAK, etc.) */
  49         virtual std::string key_type () const = 0;
  50
  51         bool equals (
  52                 boost::shared_ptr<const Content> other,
  53                 EqualityOptions opt,
  54                 boost::function<void (NoteType, std::string)> note
  55                 ) const;
  56
  57         /** Fill in a ADSCP::WriteInfo struct.
  58          *  @param w struct to fill in.
  59          *  @param standard INTEROP or SMPTE.
  60          */
  61         void fill_writer_info (ASDCP::WriterInfo* w, Standard standard);
  62
  63         /** @return true if the data is encrypted */
  64         bool encrypted () const {
  65                 return !_key_id.empty ();
  66         }
  67
  68         /** Set the ID of the key that is used for encryption/decryption.
  69          *  @param i key ID.
  70          */
  71         void set_key_id (std::string i) {
  72                 _key_id = i;
  73         }
  74
  75         /** @return the ID of the key used for encryption/decryption, or an empty string */
  76         std::string key_id () const {
  77                 return _key_id;
  78         }
  79
  80         void set_key (Key);
  81
  82         /** @return encryption/decryption key, if one has been set */
  83         boost::optional<Key> key () const {
  84                 return _key;
  85         }
  86
  87         /** @return encryption context, set up with any key that has been passed to set_key() */
  88         ASDCP::AESEncContext* encryption_context () const {
  89                 return _encryption_context;
  90         }
  91
  92         /** Set the metadata that is written to the MXF file.
  93          *  @param m Metadata.
  94          */
  95         void set_metadata (MXFMetadata m) {
  96                 _metadata = m;
  97         }
  98
  99         /** @return metadata from the MXF file */
 100         MXFMetadata metadata () const {
 101                 return _metadata;
 102         }
 103
 104 protected:
 105         std::string pkl_type (Standard standard) const;
 106         void read_writer_info (ASDCP::WriterInfo const &);
 107
 108         ASDCP::AESEncContext* _encryption_context;
 109         ASDCP::AESDecContext* _decryption_context;
 110         /** ID of the key used for encryption/decryption, or an empty string */
 111         std::string _key_id;
 112         /** Key used for encryption/decryption, if there is one */
 113         boost::optional<Key> _key;
 114         MXFMetadata _metadata;
 115 };
 116
 117 }
 118
 119 #endif