summaryrefslogtreecommitdiff
path: root/src/cpl.h
blob: 35a8bb624d429b654f5c09ed8ab776d52a54556f (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
/*
    Copyright (C) 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_CPL_H
#define LIBDCP_CPL_H

#include "types.h"
#include "certificates.h"
#include "key.h"
#include "asset.h"
#include <libxml++/libxml++.h>
#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 <list>

namespace dcp {
	
class Content;
class Reel;
class XMLMetadata;
class MXFMetadata;
class Signer;
class KDM;
	
/** @class CPL
 *  @brief A Composition Playlist.
 */
class CPL : public Asset
{
public:
	CPL (std::string annotation_text, ContentKind content_kind);
	CPL (boost::filesystem::path file);

	std::string pkl_type () const {
		return "text/xml";
	}

	bool equals (
		CPL const & other,
		EqualityOptions options,
		boost::function<void (NoteType, std::string)> note
		) const;

	void add (boost::shared_ptr<Reel> reel);
	void add (KDM const &);
	
	std::string annotation_text () const {
		return _annotation_text;
	}
	
	std::string content_title_text () const {
		return _content_title_text;
	}
	
	/** @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;
	}

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

	bool encrypted () const;

	void set_mxf_keys (Key);

	void write_xml (
		boost::filesystem::path file,
		Standard standard,
		XMLMetadata,
		boost::shared_ptr<const Signer>
		) const;
	
private:
	std::string _annotation_text;               ///< <AnnotationText>
	std::string _issue_date;                    ///< <IssueDate>
	std::string _creator;                       ///< <Creator>
	std::string _content_title_text;            ///< <ContentTitleText>
	ContentKind _content_kind;                  ///< <ContentKind>
	std::string _content_version_id;            ///< <Id> in <ContentVersion>
	std::string _content_version_label_text;    ///< <LabelText> in <ContentVersion>
	std::list<boost::shared_ptr<Reel> > _reels;
};

}

#endif