src/mxf.h

   1 /*
   2     Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of libdcp.
   5
   6     libdcp is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     libdcp is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
  18
  19     In addition, as a special exception, the copyright holders give
  20     permission to link the code of portions of this program with the
  21     OpenSSL library under certain conditions as described in each
  22     individual source file, and distribute linked combinations
  23     including the two.
  24
  25     You must obey the GNU General Public License in all respects
  26     for all of the code used other than OpenSSL.  If you modify
  27     file(s) with this exception, you may extend this exception to your
  28     version of the file(s), but you are not obligated to do so.  If you
  29     do not wish to do so, delete this exception statement from your
  30     version.  If you delete this exception statement from all source
  31     files in the program, then also delete it here.
  32 */
  33
  34
  35 /** @file  src/mxf.h
  36  *  @brief MXF class
  37  */
  38
  39
  40 #ifndef LIBDCP_MXF_H
  41 #define LIBDCP_MXF_H
  42
  43
  44 #include "asset.h"
  45 #include "key.h"
  46 #include "metadata.h"
  47 #include "dcp_assert.h"
  48 #include <boost/signals2.hpp>
  49
  50
  51 namespace ASDCP {
  52         class AESDecContext;
  53         struct WriterInfo;
  54 }
  55
  56
  57 /* Undefine some stuff that the OS X 10.5 SDK defines */
  58 #undef Key
  59 #undef set_key
  60
  61
  62 namespace dcp
  63 {
  64
  65
  66 class MXFMetadata;
  67 class PictureAssetWriter;
  68
  69
  70 /** @class MXF
  71  *  @brief Parent for classes which represent MXF files
  72  */
  73 class MXF
  74 {
  75 public:
  76         MXF (Standard standard);
  77         virtual ~MXF () {}
  78
  79         /** @return true if the data is encrypted */
  80         bool encrypted () const {
  81                 return static_cast<bool>(_key_id);
  82         }
  83
  84         /** Set the ID of the key that is used for encryption/decryption.
  85          *  @param i key ID.
  86          */
  87         void set_key_id (std::string i) {
  88                 _key_id = i;
  89         }
  90
  91         /** @return the ID of the key used for encryption/decryption, if there is one */
  92         boost::optional<std::string> key_id () const {
  93                 return _key_id;
  94         }
  95
  96         /** Set the (private) key that will be used to encrypt or decrypt this MXF's content
  97          *  This is the top-secret key that is distributed (itself encrypted) to cinemas
  98          *  via Key Delivery Messages (KDMs)
  99          *  @param key Key to use
 100          */
 101         virtual void set_key (Key);
 102
 103         /** @return encryption/decryption key, if one has been set */
 104         boost::optional<Key> key () const {
 105                 return _key;
 106         }
 107
 108         /** Set the context ID to be used when encrypting.
 109          *  @param id New ID.
 110          */
 111         void set_context_id (std::string id) {
 112                 _context_id = id;
 113         }
 114
 115         /** @return context ID used when encrypting; this starts off as a random value */
 116         std::string context_id () const {
 117                 return _context_id;
 118         }
 119
 120         /** Set the metadata that is written to the MXF file.
 121          *  @param m Metadata.
 122          */
 123         void set_metadata (MXFMetadata m) {
 124                 _metadata = m;
 125         }
 126
 127         /** @return metadata from the MXF file */
 128         MXFMetadata metadata () const {
 129                 return _metadata;
 130         }
 131
 132         Standard standard () const {
 133                 DCP_ASSERT (_standard);
 134                 return *_standard;
 135         }
 136
 137 protected:
 138         template <class P, class Q>
 139         friend void start (PictureAssetWriter* writer, std::shared_ptr<P> state, Q* mxf, uint8_t const * data, int size);
 140
 141         MXF ();
 142
 143         std::string read_writer_info (ASDCP::WriterInfo const &);
 144         /** Fill in a ADSCP::WriteInfo struct.
 145          *  @param w struct to fill in.
 146          */
 147         void fill_writer_info (ASDCP::WriterInfo* w, std::string id) const;
 148
 149         /** ID of the key used for encryption/decryption, if there is one */
 150         boost::optional<std::string> _key_id;
 151         /** Key used for encryption/decryption, if there is one */
 152         boost::optional<Key> _key;
 153         std::string _context_id;
 154         MXFMetadata _metadata;
 155         boost::optional<Standard> _standard;
 156 };
 157
 158
 159 }
 160
 161
 162 #endif