X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fmxf.h;h=19d4a9567b62485ae7585f913f439b645b6c5a5f;hb=refs%2Fheads%2Ftidy-eq-options;hp=9c5b095aece26bfc2f09a3f653d4ca76bcffd079;hpb=3fd8e16705b3eb4dc08cf9f33a489418b069b90a;p=libdcp.git diff --git a/src/mxf.h b/src/mxf.h index 9c5b095a..19d4a956 100644 --- a/src/mxf.h +++ b/src/mxf.h @@ -1,66 +1,84 @@ /* - Copyright (C) 2012-2014 Carl Hetherington + Copyright (C) 2012-2021 Carl Hetherington - This program is free software; you can redistribute it and/or modify + This file is part of libdcp. + + libdcp is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. - This program is distributed in the hope that it will be useful, + libdcp is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - + along with libdcp. If not, see . + + In addition, as a special exception, the copyright holders give + permission to link the code of portions of this program with the + OpenSSL library under certain conditions as described in each + individual source file, and distribute linked combinations + including the two. + + You must obey the GNU General Public License in all respects + for all of the code used other than OpenSSL. If you modify + file(s) with this exception, you may extend this exception to your + version of the file(s), but you are not obligated to do so. If you + do not wish to do so, delete this exception statement from your + version. If you delete this exception statement from all source + files in the program, then also delete it here. */ + +/** @file src/mxf.h + * @brief MXF class + */ + + #ifndef LIBDCP_MXF_H #define LIBDCP_MXF_H + #include "asset.h" #include "key.h" #include "metadata.h" - +#include "dcp_assert.h" #include + namespace ASDCP { - class AESEncContext; class AESDecContext; - class WriterInfo; + struct WriterInfo; } + /* Undefine some stuff that the OS X 10.5 SDK defines */ #undef Key #undef set_key + namespace dcp { + class MXFMetadata; -class PictureMXFWriter; +class PictureAssetWriter; + /** @class MXF - * @brief Parent class for classes which represent MXF files. + * @brief Parent for classes which represent MXF files */ -class MXF : public Asset +class MXF { public: - MXF (); - MXF (boost::filesystem::path file); - ~MXF (); - - bool equals ( - boost::shared_ptr other, - EqualityOptions opt, - NoteHandler note - ) const; + MXF (Standard standard); + virtual ~MXF () {} /** @return true if the data is encrypted */ bool encrypted () const { - return !_key_id.empty (); + return static_cast(_key_id); } /** Set the ID of the key that is used for encryption/decryption. @@ -70,21 +88,33 @@ public: _key_id = i; } - /** @return the ID of the key used for encryption/decryption, or an empty string */ - std::string key_id () const { + /** @return the ID of the key used for encryption/decryption, if there is one */ + boost::optional key_id () const { return _key_id; } - void set_key (Key); + /** Set the (private) key that will be used to encrypt or decrypt this MXF's content + * This is the top-secret key that is distributed (itself encrypted) to cinemas + * via Key Delivery Messages (KDMs) + * @param key Key to use + */ + virtual void set_key (Key); /** @return encryption/decryption key, if one has been set */ boost::optional key () const { return _key; } - /** @return encryption context, set up with any key that has been passed to set_key() */ - ASDCP::AESEncContext* encryption_context () const { - return _encryption_context; + /** Set the context ID to be used when encrypting. + * @param id New ID. + */ + void set_context_id (std::string id) { + _context_id = id; + } + + /** @return context ID used when encrypting; this starts off as a random value */ + std::string context_id () const { + return _context_id; } /** Set the metadata that is written to the MXF file. @@ -98,27 +128,40 @@ public: MXFMetadata metadata () const { return _metadata; } - + + Standard standard () const { + DCP_ASSERT (_standard); + return *_standard; + } + protected: template - friend void start (PictureMXFWriter* writer, boost::shared_ptr

state, Standard standard, Q* mxf, uint8_t* data, int size); + friend void start (PictureAssetWriter* writer, std::shared_ptr

state, Q* mxf, uint8_t const * data, int size); + + MXF (); - void read_writer_info (ASDCP::WriterInfo const &); - /** Fill in a ADSCP::WriteInfo struct. - * @param w struct to fill in. - * @param standard INTEROP or SMPTE. + /** Read an ASDCP::WriterInfo struct, extracting things for our + * member variables. + * @return AssetUUID of the MXF */ - void fill_writer_info (ASDCP::WriterInfo* w, Standard standard); + std::string read_writer_info (ASDCP::WriterInfo const &); - ASDCP::AESEncContext* _encryption_context; - ASDCP::AESDecContext* _decryption_context; - /** ID of the key used for encryption/decryption, or an empty string */ - std::string _key_id; + /** Fill in a ASDCP::WriteInfo struct. + * @param w struct to fill in + */ + void fill_writer_info (ASDCP::WriterInfo* w, std::string id) const; + + /** ID of the key used for encryption/decryption, if there is one */ + boost::optional _key_id; /** Key used for encryption/decryption, if there is one */ boost::optional _key; + std::string _context_id; MXFMetadata _metadata; + boost::optional _standard; }; + } + #endif