libdcp
mxf.h
Go to the documentation of this file.
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 
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 
49 
50 namespace ASDCP {
51  class AESDecContext;
52  struct WriterInfo;
53 }
54 
55 
56 /* Undefine some stuff that the OS X 10.5 SDK defines */
57 #undef Key
58 #undef set_key
59 
60 
61 namespace dcp
62 {
63 
64 
65 class MXFMetadata;
66 class J2KPictureAssetWriter;
67 class MPEG2PictureAssetWriter;
68 
69 
73 class MXF
74 {
75 public:
76  MXF (Standard standard);
77  virtual ~MXF () {}
78 
80  bool encrypted () const {
81  return static_cast<bool>(_key_id);
82  }
83 
87  void set_key_id (std::string i) {
88  _key_id = i;
89  }
90 
92  boost::optional<std::string> key_id () const {
93  return _key_id;
94  }
95 
101  virtual void set_key (Key);
102 
104  boost::optional<Key> key () const {
105  return _key;
106  }
107 
111  void set_context_id (std::string id) {
112  _context_id = id;
113  }
114 
116  std::string context_id () const {
117  return _context_id;
118  }
119 
124  _metadata = m;
125  }
126 
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 (J2KPictureAssetWriter* writer, std::shared_ptr<P> state, Q* mxf, uint8_t const * data, int size);
140  template <class P, class Q>
141  friend void start (MPEG2PictureAssetWriter* writer, std::shared_ptr<P> state, Q* mxf, uint8_t const * data, int size);
142 
143  MXF ();
144 
149  std::string read_writer_info (ASDCP::WriterInfo const &);
150 
154  void fill_writer_info (ASDCP::WriterInfo* w, std::string id) const;
155 
157  boost::optional<std::string> _key_id;
159  boost::optional<Key> _key;
160  std::string _context_id;
161  MXFMetadata _metadata;
162  boost::optional<Standard> _standard;
163 };
164 
165 
166 }
167 
168 
169 #endif
Asset class.
A key for decrypting/encrypting assets.
Definition: key.h:59
Metadata that is written to a MXF file's header.
Definition: metadata.h:63
Parent for classes which represent MXF files.
Definition: mxf.h:74
MXFMetadata metadata() const
Definition: mxf.h:128
virtual void set_key(Key)
Definition: mxf.cc:112
void set_key_id(std::string i)
Definition: mxf.h:87
bool encrypted() const
Definition: mxf.h:80
void set_context_id(std::string id)
Definition: mxf.h:111
boost::optional< Key > _key
Definition: mxf.h:159
std::string context_id() const
Definition: mxf.h:116
std::string read_writer_info(ASDCP::WriterInfo const &)
Definition: mxf.cc:124
void fill_writer_info(ASDCP::WriterInfo *w, std::string id) const
Definition: mxf.cc:82
boost::optional< std::string > _key_id
Definition: mxf.h:157
boost::optional< Key > key() const
Definition: mxf.h:104
boost::optional< std::string > key_id() const
Definition: mxf.h:92
void set_metadata(MXFMetadata m)
Definition: mxf.h:123
DCP_ASSERT macro.
Key class.
MXFMetadata class.
Namespace for everything in libdcp.
Definition: array_data.h:50