summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCarl Hetherington <cth@carlh.net>2016-01-04 14:45:39 +0000
committerCarl Hetherington <cth@carlh.net>2016-01-04 14:45:39 +0000
commit5c92b6dbf3bc7d905938ad9972aec5f0ee106935 (patch)
treec81c003711b95c0cbdf8db93812ba733a30b1692
parente18e48ce04852c5418099a9f1e4c6928eb03cbd7 (diff)
Add missing.
-rw-r--r--src/dcp_cpl.cc267
-rw-r--r--src/dcp_cpl.h139
2 files changed, 406 insertions, 0 deletions
diff --git a/src/dcp_cpl.cc b/src/dcp_cpl.cc
new file mode 100644
index 00000000..0320052d
--- /dev/null
+++ b/src/dcp_cpl.cc
@@ -0,0 +1,267 @@
+/*
+ Copyright (C) 2012-2015 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.
+
+*/
+
+#include "dcp_cpl.h"
+#include "util.h"
+#include "reel.h"
+#include "metadata.h"
+#include "certificate_chain.h"
+#include "xml.h"
+#include "reel_picture_asset.h"
+#include "reel_sound_asset.h"
+#include "reel_subtitle_asset.h"
+#include "local_time.h"
+#include "dcp_assert.h"
+#include "compose.hpp"
+#include <libxml/parser.h>
+#include <boost/foreach.hpp>
+
+using std::string;
+using std::stringstream;
+using std::ostream;
+using std::list;
+using std::pair;
+using std::make_pair;
+using std::cout;
+using boost::shared_ptr;
+using boost::optional;
+using boost::dynamic_pointer_cast;
+using namespace dcp;
+
+DCPCPL::DCPCPL (string annotation_text, ContentKind content_kind)
+ : _annotation_text (annotation_text)
+ /* default _content_title_text to _annotation_text */
+ , _content_title_text (annotation_text)
+ , _content_kind (content_kind)
+ , _content_version_id ("urn:uuid:" + make_uuid ())
+{
+ /* default _content_version_id to a random ID and _content_version_label to
+ a random ID and the current time.
+ */
+ _content_version_id = "urn:uuid:" + make_uuid();
+ _content_version_label_text = _content_version_id + LocalTime().as_string ();
+}
+
+/** Construct a DCPCPL object from a XML file */
+DCPCPL::DCPCPL (boost::filesystem::path file)
+ : CPL (file)
+ , _content_kind (FEATURE)
+{
+ cxml::Document f ("CompositionPlaylist");
+ f.read_file (file);
+
+ _id = f.string_child ("Id");
+ if (_id.length() > 9) {
+ _id = _id.substr (9);
+ }
+ _annotation_text = f.optional_string_child ("AnnotationText").get_value_or ("");
+ _metadata.issuer = f.optional_string_child ("Issuer").get_value_or ("");
+ _metadata.creator = f.optional_string_child ("Creator").get_value_or ("");
+ _metadata.issue_date = f.string_child ("IssueDate");
+ _content_title_text = f.string_child ("ContentTitleText");
+ _content_kind = content_kind_from_string (f.string_child ("ContentKind"));
+ shared_ptr<cxml::Node> content_version = f.optional_node_child ("ContentVersion");
+ if (content_version) {
+ _content_version_id = content_version->optional_string_child ("Id").get_value_or ("");
+ _content_version_label_text = content_version->string_child ("LabelText");
+ content_version->done ();
+ }
+ f.ignore_child ("RatingList");
+ _reels = type_grand_children<Reel> (f, "ReelList", "Reel");
+
+ f.ignore_child ("Issuer");
+ f.ignore_child ("Signer");
+ f.ignore_child ("Signature");
+
+ f.done ();
+}
+
+/** Add a reel to this CPL.
+ * @param reel Reel to add.
+ */
+void
+DCPCPL::add (boost::shared_ptr<Reel> reel)
+{
+ _reels.push_back (reel);
+}
+
+/** Write an CompositonPlaylist XML file.
+ * @param file Filename to write.
+ * @param standard INTEROP or SMPTE.
+ * @param signer Signer to sign the CPL, or 0 to add no signature.
+ */
+void
+DCPCPL::write_xml (boost::filesystem::path file, Standard standard, shared_ptr<const CertificateChain> signer) const
+{
+ xmlpp::Document doc;
+ xmlpp::Element* root;
+ if (standard == INTEROP) {
+ root = doc.create_root_node ("CompositionPlaylist", "http://www.digicine.com/PROTO-ASDCP-CPL-20040511#");
+ } else {
+ root = doc.create_root_node ("CompositionPlaylist", "http://www.smpte-ra.org/schemas/429-7/2006/CPL");
+ }
+
+ if (signer) {
+ root->set_namespace_declaration ("http://www.w3.org/2000/09/xmldsig#", "dsig");
+ }
+
+ root->add_child("Id")->add_child_text ("urn:uuid:" + _id);
+ root->add_child("AnnotationText")->add_child_text (_annotation_text);
+ root->add_child("IssueDate")->add_child_text (_metadata.issue_date);
+ root->add_child("Issuer")->add_child_text (_metadata.issuer);
+ root->add_child("Creator")->add_child_text (_metadata.creator);
+ root->add_child("ContentTitleText")->add_child_text (_content_title_text);
+ root->add_child("ContentKind")->add_child_text (content_kind_to_string (_content_kind));
+ {
+ xmlpp::Node* cv = root->add_child ("ContentVersion");
+ cv->add_child ("Id")->add_child_text (_content_version_id);
+ cv->add_child ("LabelText")->add_child_text (_content_version_label_text);
+ }
+ root->add_child("RatingList");
+
+ xmlpp::Element* reel_list = root->add_child ("ReelList");
+
+ BOOST_FOREACH (shared_ptr<Reel> i, _reels) {
+ i->write_to_cpl (reel_list, standard);
+ }
+
+ if (signer) {
+ signer->sign (root, standard);
+ }
+
+ /* This must not be the _formatted version otherwise signature digests will be wrong */
+ doc.write_to_file (file.string (), "UTF-8");
+
+ set_file (file);
+}
+
+list<shared_ptr<const ReelAsset> >
+DCPCPL::reel_assets () const
+{
+ list<shared_ptr<const ReelAsset> > c;
+
+ BOOST_FOREACH (shared_ptr<Reel> i, _reels) {
+ if (i->main_picture ()) {
+ c.push_back (i->main_picture());
+ }
+ if (i->main_sound ()) {
+ c.push_back (i->main_sound());
+ }
+ if (i->main_subtitle ()) {
+ c.push_back (i->main_subtitle());
+ }
+ }
+
+ return c;
+}
+
+bool
+DCPCPL::equals (shared_ptr<const Asset> other, EqualityOptions opt, NoteHandler note) const
+{
+ shared_ptr<const DCPCPL> other_cpl = dynamic_pointer_cast<const DCPCPL> (other);
+ if (!other_cpl) {
+ return false;
+ }
+
+ if (_annotation_text != other_cpl->_annotation_text && !opt.cpl_annotation_texts_can_differ) {
+ stringstream s;
+ s << "CPL: annotation texts differ: " << _annotation_text << " vs " << other_cpl->_annotation_text << "\n";
+ note (DCP_ERROR, s.str ());
+ return false;
+ }
+
+ if (_content_kind != other_cpl->_content_kind) {
+ note (DCP_ERROR, "CPL: content kinds differ");
+ return false;
+ }
+
+ if (_reels.size() != other_cpl->_reels.size()) {
+ note (DCP_ERROR, String::compose ("CPL: reel counts differ (%1 vs %2)", _reels.size(), other_cpl->_reels.size()));
+ return false;
+ }
+
+ list<shared_ptr<Reel> >::const_iterator a = _reels.begin ();
+ list<shared_ptr<Reel> >::const_iterator b = other_cpl->_reels.begin ();
+
+ while (a != _reels.end ()) {
+ if (!(*a)->equals (*b, opt, note)) {
+ return false;
+ }
+ ++a;
+ ++b;
+ }
+
+ return true;
+}
+
+/** @return true if we have any encrypted content */
+bool
+DCPCPL::encrypted () const
+{
+ BOOST_FOREACH (shared_ptr<Reel> i, _reels) {
+ if (i->encrypted ()) {
+ return true;
+ }
+ }
+
+ return false;
+}
+
+/** Add a KDM to this CPL. If the KDM is for any of this CPLs assets it will be used
+ * to decrypt those assets.
+ * @param kdm KDM.
+ */
+void
+DCPCPL::add (DecryptedKDM const & kdm)
+{
+ BOOST_FOREACH (shared_ptr<Reel> i, _reels) {
+ i->add (kdm);
+ }
+}
+
+void
+DCPCPL::resolve_refs (list<shared_ptr<Asset> > assets)
+{
+ BOOST_FOREACH (shared_ptr<Reel> i, _reels) {
+ i->resolve_refs (assets);
+ }
+}
+
+string
+DCPCPL::pkl_type (Standard standard) const
+{
+ switch (standard) {
+ case INTEROP:
+ return "text/xml;asdcpKind=CPL";
+ case SMPTE:
+ return "text/xml";
+ default:
+ DCP_ASSERT (false);
+ }
+}
+
+int64_t
+DCPCPL::duration () const
+{
+ int64_t d = 0;
+ BOOST_FOREACH (shared_ptr<Reel> i, _reels) {
+ d += i->duration ();
+ }
+ return d;
+}
diff --git a/src/dcp_cpl.h b/src/dcp_cpl.h
new file mode 100644
index 00000000..3f0e43e3
--- /dev/null
+++ b/src/dcp_cpl.h
@@ -0,0 +1,139 @@
+/*
+ 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.
+
+*/
+
+/** @file src/dcp_cpl.h
+ * @brief DCPCPL class.
+ */
+
+#ifndef LIBDCP_DCP_CPL_H
+#define LIBDCP_DCP_CPL_H
+
+#include "types.h"
+#include "certificate.h"
+#include "key.h"
+#include "asset.h"
+#include "cpl.h"
+#include "metadata.h"
+#include <libxml++/libxml++.h>
+#include <boost/shared_ptr.hpp>
+#include <boost/function.hpp>
+#include <boost/optional.hpp>
+#include <boost/filesystem.hpp>
+#include <list>
+
+namespace dcp {
+
+class ReelAsset;
+class Reel;
+class XMLMetadata;
+class MXFMetadata;
+class CertificateChain;
+class DecryptedKDM;
+
+/** @class DCPL
+ * @brief A DCP's Composition Playlist.
+ */
+class DCPCPL : public CPL
+{
+public:
+ DCPCPL (std::string annotation_text, ContentKind content_kind);
+ DCPCPL (boost::filesystem::path file);
+
+ bool equals (
+ boost::shared_ptr<const Asset> other,
+ EqualityOptions options,
+ NoteHandler note
+ ) const;
+
+ void resolve_refs (std::list<boost::shared_ptr<Asset> >);
+ int64_t duration () const;
+ bool encrypted () const;
+ void add (DecryptedKDM const &);
+ std::string pkl_annotation () const {
+ return annotation_text ();
+ }
+
+ void add (boost::shared_ptr<Reel> reel);
+
+ /** @return contents of the &lt;AnnotationText&gt; node */
+ std::string annotation_text () const {
+ return _annotation_text;
+ }
+
+ /** @return contents of the &lt;ContentTitleText&gt; node */
+ std::string content_title_text () const {
+ return _content_title_text;
+ }
+
+ /** @return contents of the &lt;Id&gt; node within &lt;ContentVersion&gt; */
+ void set_content_version_id (std::string id) {
+ _content_version_id = id;
+ }
+
+ /** @return contents of the &lt;LabelText&gt; node within &lt;ContentVersion&gt; */
+ void set_content_version_label_text (std::string text) {
+ _content_version_label_text = 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;
+ }
+
+ /** @return the reels in this CPL */
+ std::list<boost::shared_ptr<Reel> > reels () const {
+ return _reels;
+ }
+
+ /** @return the ReelAssets in this CPL in all reels.
+ */
+ std::list<boost::shared_ptr<const ReelAsset> > reel_assets () const;
+
+ void set_metadata (XMLMetadata m) {
+ _metadata = m;
+ }
+
+ void write_xml (
+ boost::filesystem::path file,
+ Standard standard,
+ boost::shared_ptr<const CertificateChain>
+ ) const;
+
+protected:
+ /** @return type string for PKLs for this asset */
+ std::string pkl_type (Standard standard) const;
+
+private:
+ std::string _annotation_text; ///< &lt;AnnotationText&gt;
+ /** &lt;Issuer&gt;, &lt;Creator&gt; and &lt;IssueDate&gt;. These are grouped
+ * because they occur together in a few places.
+ */
+ XMLMetadata _metadata;
+ std::string _content_title_text; ///< &lt;ContentTitleText&gt;
+ ContentKind _content_kind; ///< &lt;ContentKind&gt;
+ std::string _content_version_id; ///< &lt;Id&gt; in &lt;ContentVersion&gt;
+ std::string _content_version_label_text; ///< &lt;LabelText&gt; in &lt;ContentVersion&gt;
+ std::list<boost::shared_ptr<Reel> > _reels;
+};
+
+}
+
+#endif