summaryrefslogtreecommitdiff
path: root/src/cpl.h
blob: da30fdbb8e2c009aa4d4e8f4ea6c3d0ed63933ad (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
140
141
142
143
144
/*
    Copyright (C) 2012 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_CPL_H
#define LIBDCP_CPL_H

#include <list>
#include <boost/shared_ptr.hpp>
#include <boost/function.hpp>
#include <boost/date_time/posix_time/posix_time.hpp>
#include <boost/optional.hpp>
#include <boost/filesystem.hpp>
#include <libxml++/libxml++.h>
#include "types.h"
#include "certificates.h"
#include "key.h"

namespace libdcp {

namespace parse {
	class AssetMap;
	class AssetMapAsset;
}
	
class Asset;
class Reel;
class XMLMetadata;
class MXFMetadata;
class Signer;
class KDM;
	
/** @brief A CPL within a DCP */
class CPL
{
public:
	CPL (boost::filesystem::path directory, std::string name, ContentKind content_kind, int length, int frames_per_second);
	CPL (boost::filesystem::path, std::string file, std::list<PathAssetMap> asset_maps, bool require_mxfs = true);

	void add_reel (boost::shared_ptr<Reel> reel);
	
	/** @return the length in frames */
	int length () const {
		return _length;
	}

	/** @return the type of the content, used by media servers
	 *  to categorise things (e.g. feature, trailer, etc.)
	 */
	ContentKind content_kind () const {
		return _content_kind;
	}

	std::list<boost::shared_ptr<Reel> > reels () const {
		return _reels;
	}

	/** @return the CPL's name, as will be presented on projector
	 *  media servers and theatre management systems.
	 */
	std::string name () const {
		return _name;
	}

	/** @return the number of frames per second */
	int frames_per_second () const {
		return _fps;
	}

	std::list<boost::shared_ptr<const Asset> > assets () const;

	bool encrypted () const;

	std::string id () const {
		return _id;
	}
	
	bool equals (CPL const & other, EqualityOptions options, boost::function<void (NoteType, std::string)> note) const;
	
	void write_xml (bool, XMLMetadata const &, boost::shared_ptr<const Signer>) const;
	void write_to_assetmap (xmlpp::Node *) const;
	void write_to_pkl (xmlpp::Node *) const;

	/** Make a KDM for this CPL.
	 *  @param signer Details of the certificates and private key to sign the KDM with.
	 *  @param recipient_cert The certificate of the projector that this KDM is targeted at.  This will contain the
	 *  projector's public key which is used to encrypt the content keys.
	 *  @param key Private key used to encrypt the MXFs referenced by this CPL.
	 *  @param from Time that the KDM should be valid from.
	 *  @param until Time that the KDM should be valid until.
	 *  @param interop true to generate an interop KDM, false for SMPTE.
	 */
	boost::shared_ptr<xmlpp::Document> make_kdm (
		boost::shared_ptr<const Signer> signer,
		boost::shared_ptr<const Certificate> recipient_cert,
		Key key,
		boost::posix_time::ptime from,
		boost::posix_time::ptime until,
		bool interop,
		MXFMetadata const &,
		XMLMetadata const &
		) const;

	void add_kdm (KDM const &);
	
private:
	std::pair<std::string, boost::shared_ptr<const parse::AssetMapAsset> > asset_from_id (std::list<PathAssetMap>, std::string id) const;
	
	boost::filesystem::path _directory;
	/** the name of the DCP */
	std::string _name;
	/** the content kind of the CPL */
	ContentKind _content_kind;
	/** length in frames */
	mutable int _length;
	/** frames per second */
	int _fps;
	/** reels */
	std::list<boost::shared_ptr<Reel> > _reels;

	/** our UUID */
	std::string _id;
	/** a SHA1 digest of our XML */
	mutable std::string _digest;
};

}

#endif