/*
- Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
- This program is free software; you can redistribute it and/or modify
+ This file is part of libdcp.
+
+ libdcp 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,
+ libdcp 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.
-
+ along with libdcp. If not, see <http://www.gnu.org/licenses/>.
+
+ In addition, as a special exception, the copyright holders give
+ permission to link the code of portions of this program with the
+ OpenSSL library under certain conditions as described in each
+ individual source file, and distribute linked combinations
+ including the two.
+
+ You must obey the GNU General Public License in all respects
+ for all of the code used other than OpenSSL. If you modify
+ file(s) with this exception, you may extend this exception to your
+ version of the file(s), but you are not obligated to do so. If you
+ do not wish to do so, delete this exception statement from your
+ version. If you delete this exception statement from all source
+ files in the program, then also delete it here.
*/
-#include <fstream>
#include "cpl.h"
-#include "cpl_file.h"
#include "util.h"
-#include "picture_asset.h"
-#include "sound_asset.h"
-#include "subtitle_asset.h"
-#include "asset_map.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 "reel_closed_caption_asset.h"
+#include "reel_atmos_asset.h"
+#include "local_time.h"
+#include "dcp_assert.h"
+#include "compose.hpp"
+#include <libxml/parser.h>
+#include <libxml++/libxml++.h>
+#include <boost/foreach.hpp>
using std::string;
-using std::stringstream;
-using std::ofstream;
-using std::ostream;
using std::list;
+using std::pair;
+using std::make_pair;
+using std::cout;
using boost::shared_ptr;
-using namespace libdcp;
+using boost::optional;
+using boost::dynamic_pointer_cast;
+using namespace dcp;
-CPL::CPL (string directory, string name, ContentKind content_kind, int length, int frames_per_second)
- : _directory (directory)
- , _name (name)
+static string const cpl_interop_ns = "http://www.digicine.com/PROTO-ASDCP-CPL-20040511#";
+static string const cpl_smpte_ns = "http://www.smpte-ra.org/schemas/429-7/2006/CPL";
+
+CPL::CPL (string annotation_text, ContentKind content_kind)
+ /* default _content_title_text to annotation_text */
+ : _content_title_text (annotation_text)
, _content_kind (content_kind)
- , _length (length)
- , _fps (frames_per_second)
+ , _content_version_id ("urn:uuid:" + make_uuid ())
{
- _uuid = make_uuid ();
+ _metadata.annotation_text = annotation_text;
+ /* 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 CPL object from a XML file.
- * @param directory The directory containing this CPL's DCP.
- * @param file The CPL XML filename.
- * @param asset_map The corresponding asset map.
- * @param require_mxfs true to throw an exception if a required MXF file does not exist.
- */
-CPL::CPL (string directory, string file, shared_ptr<const AssetMap> asset_map, bool require_mxfs)
- : _directory (directory)
+/** Construct a CPL object from a XML file */
+CPL::CPL (boost::filesystem::path file)
+ : Asset (file)
, _content_kind (FEATURE)
- , _length (0)
- , _fps (0)
{
- /* Read the XML */
- shared_ptr<CPLFile> cpl;
- try {
- cpl.reset (new CPLFile (file));
- } catch (FileError& e) {
- boost::throw_exception (FileError ("could not load CPL file", file));
+ cxml::Document f ("CompositionPlaylist");
+ f.read_file (file);
+
+ if (f.namespace_uri() == cpl_interop_ns) {
+ _standard = INTEROP;
+ } else if (f.namespace_uri() == cpl_smpte_ns) {
+ _standard = SMPTE;
+ } else {
+ boost::throw_exception (XMLError ("Unrecognised CPL namespace " + f.namespace_uri()));
}
-
- /* Now cherry-pick the required bits into our own data structure */
-
- _name = cpl->annotation_text;
- _content_kind = cpl->content_kind;
- for (list<shared_ptr<CPLReel> >::iterator i = cpl->reels.begin(); i != cpl->reels.end(); ++i) {
+ _id = remove_urn_uuid (f.string_child ("Id"));
+ _metadata.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");
- shared_ptr<Picture> p;
+ f.ignore_child ("Issuer");
+ f.ignore_child ("Signer");
+ f.ignore_child ("Signature");
- if ((*i)->asset_list->main_picture) {
- p = (*i)->asset_list->main_picture;
- } else {
- p = (*i)->asset_list->main_stereoscopic_picture;
- }
-
- _fps = p->edit_rate.numerator;
- _length += p->duration;
-
- shared_ptr<PictureAsset> picture;
- shared_ptr<SoundAsset> sound;
- shared_ptr<SubtitleAsset> subtitle;
-
- /* Some rather twisted logic to decide if we are 3D or not;
- some DCPs give a MainStereoscopicPicture to indicate 3D, others
- just have a FrameRate twice the EditRate and apparently
- expect you to divine the fact that they are hence 3D.
- */
-
- if (!(*i)->asset_list->main_stereoscopic_picture && p->edit_rate == p->frame_rate) {
-
- try {
- picture.reset (new MonoPictureAsset (
- _directory,
- asset_map->asset_from_id (p->id)->chunks.front()->path
- )
- );
-
- picture->set_entry_point ((*i)->asset_list->main_picture->entry_point);
- } catch (MXFFileError) {
- if (require_mxfs) {
- throw;
- }
- }
-
- } else {
-
- try {
- picture.reset (new StereoPictureAsset (
- _directory,
- asset_map->asset_from_id (p->id)->chunks.front()->path,
- _fps,
- p->duration
- )
- );
-
- picture->set_entry_point (p->entry_point);
-
- } catch (MXFFileError) {
- if (require_mxfs) {
- throw;
- }
- }
-
- }
-
- if ((*i)->asset_list->main_sound) {
-
- try {
- sound.reset (new SoundAsset (
- _directory,
- asset_map->asset_from_id ((*i)->asset_list->main_sound->id)->chunks.front()->path
- )
- );
-
- sound->set_entry_point ((*i)->asset_list->main_sound->entry_point);
- } catch (MXFFileError) {
- if (require_mxfs) {
- throw;
- }
- }
- }
-
- if ((*i)->asset_list->main_subtitle) {
-
- subtitle.reset (new SubtitleAsset (
- _directory,
- asset_map->asset_from_id ((*i)->asset_list->main_subtitle->id)->chunks.front()->path
- )
- );
- }
-
- _reels.push_back (shared_ptr<Reel> (new Reel (picture, sound, subtitle)));
- }
+ f.done ();
}
+/** Add a reel to this CPL.
+ * @param reel Reel to add.
+ */
void
-CPL::add_reel (shared_ptr<const Reel> reel)
+CPL::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
-CPL::write_xml (XMLMetadata const & metadata) const
+CPL::write_xml (boost::filesystem::path file, Standard standard, shared_ptr<const CertificateChain> signer) const
{
- boost::filesystem::path p;
- p /= _directory;
- stringstream s;
- s << _uuid << "_cpl.xml";
- p /= s.str();
- ofstream os (p.string().c_str());
-
- os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
- << "<CompositionPlaylist xmlns=\"http://www.smpte-ra.org/schemas/429-7/2006/CPL\">\n"
- << " <Id>urn:uuid:" << _uuid << "</Id>\n"
- << " <AnnotationText>" << _name << "</AnnotationText>\n"
- << " <IssueDate>" << metadata.issue_date << "</IssueDate>\n"
- << " <Creator>" << metadata.creator << "</Creator>\n"
- << " <ContentTitleText>" << _name << "</ContentTitleText>\n"
- << " <ContentKind>" << content_kind_to_string (_content_kind) << "</ContentKind>\n"
- << " <ContentVersion>\n"
- << " <Id>urn:uri:" << _uuid << "_" << metadata.issue_date << "</Id>\n"
- << " <LabelText>" << _uuid << "_" << metadata.issue_date << "</LabelText>\n"
- << " </ContentVersion>\n"
- << " <RatingList/>\n"
- << " <ReelList>\n";
-
- for (list<shared_ptr<const Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
- (*i)->write_to_cpl (os);
+ xmlpp::Document doc;
+ xmlpp::Element* root;
+ if (standard == INTEROP) {
+ root = doc.create_root_node ("CompositionPlaylist", cpl_interop_ns);
+ } else {
+ root = doc.create_root_node ("CompositionPlaylist", cpl_smpte_ns);
}
- os << " </ReelList>\n"
- << "</CompositionPlaylist>\n";
+ root->add_child("Id")->add_child_text ("urn:uuid:" + _id);
+ root->add_child("AnnotationText")->add_child_text (_metadata.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");
- os.close ();
+ xmlpp::Element* reel_list = root->add_child ("ReelList");
- _digest = make_digest (p.string ());
- _length = boost::filesystem::file_size (p.string ());
-}
+ BOOST_FOREACH (shared_ptr<Reel> i, _reels) {
+ i->write_to_cpl (reel_list, standard);
+ }
-void
-CPL::write_to_pkl (ostream& s) const
-{
- s << " <Asset>\n"
- << " <Id>urn:uuid:" << _uuid << "</Id>\n"
- << " <Hash>" << _digest << "</Hash>\n"
- << " <Size>" << _length << "</Size>\n"
- << " <Type>text/xml</Type>\n"
- << " </Asset>\n";
+ 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 Asset> >
-CPL::assets () const
+list<shared_ptr<const ReelAsset> >
+CPL::reel_assets () const
{
- list<shared_ptr<const Asset> > a;
- for (list<shared_ptr<const Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
- if ((*i)->main_picture ()) {
- a.push_back ((*i)->main_picture ());
+ 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_sound ()) {
- a.push_back ((*i)->main_sound ());
+ if (i->main_subtitle ()) {
+ c.push_back (i->main_subtitle());
}
- if ((*i)->main_subtitle ()) {
- a.push_back ((*i)->main_subtitle ());
+ BOOST_FOREACH (shared_ptr<ReelClosedCaptionAsset> j, i->closed_captions()) {
+ c.push_back (j);
+ }
+ if (i->atmos ()) {
+ c.push_back (i->atmos());
}
}
- return a;
+ return c;
}
-void
-CPL::write_to_assetmap (ostream& s) const
-{
- s << " <Asset>\n"
- << " <Id>urn:uuid:" << _uuid << "</Id>\n"
- << " <ChunkList>\n"
- << " <Chunk>\n"
- << " <Path>" << _uuid << "_cpl.xml</Path>\n"
- << " <VolumeIndex>1</VolumeIndex>\n"
- << " <Offset>0</Offset>\n"
- << " <Length>" << _length << "</Length>\n"
- << " </Chunk>\n"
- << " </ChunkList>\n"
- << " </Asset>\n";
-}
-
-
-
bool
-CPL::equals (CPL const & other, EqualityOptions opt, boost::function<void (NoteType, string)> note) const
+CPL::equals (shared_ptr<const Asset> other, EqualityOptions opt, NoteHandler note) const
{
- if (_name != other._name) {
- note (ERROR, "names differ");
+ shared_ptr<const CPL> other_cpl = dynamic_pointer_cast<const CPL> (other);
+ if (!other_cpl) {
return false;
}
- if (_content_kind != other._content_kind) {
- note (ERROR, "content kinds differ");
+ if (_metadata.annotation_text != other_cpl->_metadata.annotation_text && !opt.cpl_annotation_texts_can_differ) {
+ string const s = "CPL: annotation texts differ: " + _metadata.annotation_text + " vs " + other_cpl->_metadata.annotation_text + "\n";
+ note (DCP_ERROR, s);
return false;
}
- if (_fps != other._fps) {
- note (ERROR, "frames per second differ");
+ if (_content_kind != other_cpl->_content_kind) {
+ note (DCP_ERROR, "CPL: content kinds differ");
return false;
}
- if (_length != other._length) {
- note (ERROR, "lengths differ");
+ 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;
}
- if (_reels.size() != other._reels.size()) {
- note (ERROR, "reel counts differ");
- return false;
- }
-
- list<shared_ptr<const Reel> >::const_iterator a = _reels.begin ();
- list<shared_ptr<const Reel> >::const_iterator b = other._reels.begin ();
-
+ 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;
return true;
}
+
+/** @return true if we have any encrypted content */
+bool
+CPL::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
+CPL::add (DecryptedKDM const & kdm)
+{
+ BOOST_FOREACH (shared_ptr<Reel> i, _reels) {
+ i->add (kdm);
+ }
+}
+
+void
+CPL::resolve_refs (list<shared_ptr<Asset> > assets)
+{
+ BOOST_FOREACH (shared_ptr<Reel> i, _reels) {
+ i->resolve_refs (assets);
+ }
+}
+
+string
+CPL::pkl_type (Standard standard) const
+{
+ return static_pkl_type (standard);
+}
+
+string
+CPL::static_pkl_type (Standard standard)
+{
+ switch (standard) {
+ case INTEROP:
+ return "text/xml;asdcpKind=CPL";
+ case SMPTE:
+ return "text/xml";
+ default:
+ DCP_ASSERT (false);
+ }
+}
+
+int64_t
+CPL::duration () const
+{
+ int64_t d = 0;
+ BOOST_FOREACH (shared_ptr<Reel> i, _reels) {
+ d += i->duration ();
+ }
+ return d;
+}
projects / libdcp.git / blobdiff