src/mxf.h

   1 /*
   2     Copyright (C) 2012-2014 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 #ifndef LIBDCP_MXF_H
  35 #define LIBDCP_MXF_H
  36
  37 #include "asset.h"
  38 #include "key.h"
  39 #include "metadata.h"
  40
  41 #include <boost/signals2.hpp>
  42
  43 namespace ASDCP {
  44         class AESDecContext;
  45         struct WriterInfo;
  46 }
  47
  48 /* Undefine some stuff that the OS X 10.5 SDK defines */
  49 #undef Key
  50 #undef set_key
  51
  52 namespace dcp
  53 {
  54
  55 class MXFMetadata;
  56 class PictureAssetWriter;
  57
  58 /** @class MXF
  59  *  @brief Parent for classes which represent MXF files.
  60  */
  61 class MXF
  62 {
  63 public:
  64         virtual ~MXF () {}
  65
  66         /** @return true if the data is encrypted */
  67         bool encrypted () const {
  68                 return static_cast<bool>(_key_id);
  69         }
  70
  71         /** Set the ID of the key that is used for encryption/decryption.
  72          *  @param i key ID.
  73          */
  74         void set_key_id (std::string i) {
  75                 _key_id = i;
  76         }
  77
  78         /** @return the ID of the key used for encryption/decryption, if there is one */
  79         boost::optional<std::string> key_id () const {
  80                 return _key_id;
  81         }
  82
  83         virtual void set_key (Key);
  84
  85         /** @return encryption/decryption key, if one has been set */
  86         boost::optional<Key> key () const {
  87                 return _key;
  88         }
  89
  90         /** Set the metadata that is written to the MXF file.
  91          *  @param m Metadata.
  92          */
  93         void set_metadata (MXFMetadata m) {
  94                 _metadata = m;
  95         }
  96
  97         /** @return metadata from the MXF file */
  98         MXFMetadata metadata () const {
  99                 return _metadata;
 100         }
 101
 102 protected:
 103         template <class P, class Q>
 104         friend void start (PictureAssetWriter* writer, boost::shared_ptr<P> state, Standard standard, Q* mxf, uint8_t* data, int size);
 105
 106         std::string read_writer_info (ASDCP::WriterInfo const &);
 107         /** Fill in a ADSCP::WriteInfo struct.
 108          *  @param w struct to fill in.
 109          *  @param standard INTEROP or SMPTE.
 110          */
 111         void fill_writer_info (ASDCP::WriterInfo* w, std::string id, Standard standard) const;
 112
 113         /** ID of the key used for encryption/decryption, if there is one */
 114         boost::optional<std::string> _key_id;
 115         /** Key used for encryption/decryption, if there is one */
 116         boost::optional<Key> _key;
 117         MXFMetadata _metadata;
 118 };
 119
 120 }
 121
 122 #endif