/*
- Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
- 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 <http://www.gnu.org/licenses/>.
+
+ 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.
*/
-#ifndef LIBDCP_MXF_ASSET_H
-#define LIBDCP_MXF_ASSET_H
-#include <boost/signals2.hpp>
-#include "content_asset.h"
+/** @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 <boost/signals2.hpp>
+
namespace ASDCP {
- class AESEncContext;
class AESDecContext;
+ struct WriterInfo;
}
+
+/* Undefine some stuff that the OS X 10.5 SDK defines */
+#undef Key
+#undef set_key
+
+
namespace dcp
{
-class MXFMetadata;
+
+class MXFMetadata;
+class PictureAssetWriter;
+
/** @class MXF
- * @brief Parent class for classes which represent MXF files.
+ * @brief Parent for classes which represent MXF files
*/
-class MXF : public ContentAsset
+class MXF
{
public:
- /** Construct an MXF.
- * This class will not write anything to disk in this constructor, but subclasses may.
- *
- * @param directory Directory where MXF file is.
- * @param file_name Name of MXF file.
- */
- MXF (boost::filesystem::path directory, boost::filesystem::path file_name);
-
- ~MXF ();
-
- virtual bool equals (boost::shared_ptr<const ContentAsset> other, EqualityOptions opt, boost::function<void (NoteType, std::string)> note) const;
- virtual void write_to_cpl (xmlpp::Element *) const;
- virtual std::string key_type () const = 0;
-
- /** Fill in a ADSCP::WriteInfo struct.
- * @param w struct to fill in.
- */
- void fill_writer_info (ASDCP::WriterInfo* w);
-
- void set_progress (boost::signals2::signal<void (float)>* progress) {
- _progress = progress;
- }
+ MXF (Standard standard);
+ virtual ~MXF () {}
+ /** @return true if the data is encrypted */
bool encrypted () const {
- return !_key_id.empty ();
+ return static_cast<bool>(_key_id);
}
+ /** Set the ID of the key that is used for encryption/decryption.
+ * @param i key ID.
+ */
void set_key_id (std::string i) {
_key_id = i;
}
- std::string key_id () const {
+ /** @return the ID of the key used for encryption/decryption, if there is one */
+ boost::optional<std::string> 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> key () const {
return _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.
+ * @param m Metadata.
+ */
void set_metadata (MXFMetadata m) {
_metadata = m;
}
+ /** @return metadata from the MXF file */
MXFMetadata metadata () const {
return _metadata;
}
- /** Set whether or not the asset should be written in Interop mode.
- * @param i true to use interop.
- */
- void set_interop (bool i) {
- _interop = i;
- }
-
- bool interop () const {
- return _interop;
+ Standard standard () const {
+ DCP_ASSERT (_standard);
+ return *_standard;
}
protected:
- virtual std::string cpl_node_name () const = 0;
- virtual std::pair<std::string, std::string> cpl_node_attribute () const {
- return std::make_pair ("", "");
- }
-
- /** Signal to emit to report progress, or 0 */
- boost::signals2::signal<void (float)>* _progress;
- ASDCP::AESEncContext* _encryption_context;
- ASDCP::AESDecContext* _decryption_context;
- std::string _key_id;
+ template <class P, class Q>
+ friend void start (PictureAssetWriter* writer, std::shared_ptr<P> state, Q* mxf, uint8_t const * data, int size);
+
+ MXF ();
+
+ std::string read_writer_info (ASDCP::WriterInfo const &);
+ /** Fill in a ADSCP::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<std::string> _key_id;
+ /** Key used for encryption/decryption, if there is one */
boost::optional<Key> _key;
+ std::string _context_id;
MXFMetadata _metadata;
- bool _interop;
+ boost::optional<Standard> _standard;
};
+
}
+
#endif
projects / libdcp.git / blobdiff