summaryrefslogtreecommitdiff
path: root/src/cpl.h
blob: 62362c6fdce9418c0bc9dc78dffd9ddb204a51f4 (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
/*
    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"

namespace libdcp {

namespace parse {
	class AssetMap;
	class AssetMapAsset;
}
	
class Asset;
class Reel;
class XMLMetadata;
class MXFMetadata;
class Encryption;
class KDM;
	
/** @brief A composition playlist (CPL) */
class CPL
{
public:
	CPL (std::string annotation_text, std::string content_title_text, ContentKind content_kind);
	CPL (boost::filesystem::path file);

	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 (boost::filesystem::path, bool, XMLMetadata const &, boost::shared_ptr<Encryption>) const;
	void write_to_assetmap (xmlpp::Node *) const;
	void write_to_pkl (xmlpp::Node *) const;

	boost::shared_ptr<xmlpp::Document> make_kdm (
		CertificateChain const &,
		std::string const &,
		boost::shared_ptr<const Certificate>,
		boost::posix_time::ptime from,
		boost::posix_time::ptime until,
		bool,
		MXFMetadata const &,
		XMLMetadata const &
		) const;

	void add_kdm (KDM const &);

	/* Properties */
	
	std::string annotation_text;
	std::string issue_date;
	std::string creator;
	std::string content_title_text;
	/** The type of the content, used by media servers to categorise things (e.g. feature, trailer, etc.) */
	ContentKind content_kind;
	std::list<boost::shared_ptr<Reel> > reels;
	
private:
	/** our UUID */
	std::string _id;

	/* XXX: nasty */
        /** the SHA1 digest of our XML the last time it was written to disk */
	mutable std::string _digest;
	/** file size of our XML the last time it was written to disk */
	mutable int _length;
};

}

#endif