summaryrefslogtreecommitdiff
path: root/src/mxf.h
blob: f7b94bd2555cdb8faee3081a41de8c25b5fa43b8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
/*
    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>

    This program 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,
    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.

*/

#ifndef LIBDCP_MXF_H
#define LIBDCP_MXF_H

#include "content.h"
#include "key.h"
#include "metadata.h"
#include <boost/signals2.hpp>

namespace ASDCP {
	class AESEncContext;
	class AESDecContext;
}

/* Undefine some stuff that the OS X 10.5 SDK defines */
#undef Key
#undef set_key

namespace dcp
{

class MXFMetadata;	

/** @class MXF
 *  @brief Parent class for classes which represent MXF files.
 */
class MXF : public Content
{
public:
	MXF (Fraction edit_rate);
	MXF (boost::filesystem::path file);
	~MXF ();

	bool equals (
		boost::shared_ptr<const Asset> other,
		EqualityOptions opt,
		boost::function<void (NoteType, std::string)> note
		) const;

	/** Fill in a ADSCP::WriteInfo struct.
	 *  @param w struct to fill in.
	 *  @param standard INTEROP or SMPTE.
	 */
	void fill_writer_info (ASDCP::WriterInfo* w, Standard standard);

	/** @return true if the data is encrypted */
	bool encrypted () const {
		return !_key_id.empty ();
	}

	/** 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;
	}

	/** @return the ID of the key used for encryption/decryption, or an empty string */
	std::string key_id () const {
		return _key_id;
	}

	void set_key (Key);

	/** @return encryption/decryption key, if one has been set */
	boost::optional<Key> 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 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;
	}

	Fraction edit_rate () const {
		return _edit_rate;
	}

	/** @return The total length of this content in video frames.
	 *  The amount of content presented may be less than this.
	 */
	int64_t intrinsic_duration () const {
		return _intrinsic_duration;
	}
	
protected:
	friend class MXFWriter;

	std::string pkl_type (Standard standard) const;
	void read_writer_info (ASDCP::WriterInfo const &);
	
	Fraction _edit_rate;
	/** The total length of this content in video frames.  The amount of
	 *  content presented may be less than this.
	 */
	int64_t _intrinsic_duration;
	
	ASDCP::AESEncContext* _encryption_context;
	ASDCP::AESDecContext* _decryption_context;
	/** ID of the key used for encryption/decryption, or an empty string */
	std::string _key_id;
	/** Key used for encryption/decryption, if there is one */
	boost::optional<Key> _key;
	MXFMetadata _metadata;
};

}

#endif