/*
Copyright (C) 2012-2014 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.
*/
/** @file src/dcp.h
#define LIBDCP_DCP_H
#include "types.h"
-#include "certificates.h"
+#include "util.h"
+#include "certificate.h"
#include "metadata.h"
+#include "name_format.h"
#include <boost/shared_ptr.hpp>
#include <boost/signals2.hpp>
#include <string>
namespace dcp
{
-class Content;
+class PKL;
+class Content;
class Reel;
class CPL;
class XMLMetadata;
-class Signer;
-class KDM;
+class CertificateChain;
+class DecryptedKDM;
class Asset;
-
-namespace parse {
- class AssetMap;
-}
+class DCPReadError;
/** @class DCP
* @brief A class to create or read a DCP.
*/
-
+
class DCP : public boost::noncopyable
{
public:
/** Construct a DCP. You can pass an existing DCP's directory
- * as the parameter, or a non-existant folder to create a new
- * DCP in.
+ * as the parameter; alternatively, directory will be created
+ * if it does not exist. Note that if you pass an existing DCP
+ * into this constructor it will not be read until you call ::read().
*
* @param directory Directory containing the DCP's files.
*/
- DCP (boost::filesystem::path directory);
+ explicit DCP (boost::filesystem::path directory);
- void read ();
+ typedef std::list<boost::shared_ptr<DCPReadError> > ReadErrors;
+
+ /** Read the DCP's structure into this object.
+ * @param keep_going true to try to keep going in the face of (some) errors.
+ * @param errors List of errors that will be added to if keep_going is true.
+ * @param ignore_incorrect_picture_mxf_type true to try loading MXF files marked as monoscopic
+ * as stereoscopic if the monoscopic load fails; fixes problems some 3D DCPs that (I think)
+ * have an incorrect descriptor in their MXF.
+ */
+ void read (bool keep_going = false, ReadErrors* errors = 0, bool ignore_incorrect_picture_mxf_type = false);
/** Compare this DCP with another, according to various options.
* @param other DCP to compare this one to.
* @param note Functor to handle notes made by the equality operation.
* @return true if the DCPs are equal according to EqualityOptions, otherwise false.
*/
- bool equals (DCP const & other, EqualityOptions options, boost::function<void (NoteType, std::string)> note) const;
+ bool equals (DCP const & other, EqualityOptions options, NoteHandler note) const;
- void add (boost::shared_ptr<Asset> asset);
+ void add (boost::shared_ptr<CPL> cpl);
std::list<boost::shared_ptr<CPL> > cpls () const;
-
- /** @return All this DCP's assets (note that CPLs are assets) */
- std::list<boost::shared_ptr<Asset> > assets () const {
- return _assets;
- }
+ std::list<boost::shared_ptr<Asset> > assets (bool ignore_unresolved = false) const;
bool encrypted () const;
- void add (KDM const &);
+ void add (DecryptedKDM const &);
void write_xml (
Standard standard,
XMLMetadata metadata = XMLMetadata (),
- boost::shared_ptr<const Signer> signer = boost::shared_ptr<const Signer> ()
+ boost::shared_ptr<const CertificateChain> signer = boost::shared_ptr<const CertificateChain> (),
+ NameFormat name_format = NameFormat("%t")
);
-private:
+ void resolve_refs (std::list<boost::shared_ptr<Asset> > assets);
- /** Write the PKL file.
- * @param pkl_uuid UUID to use.
+ /** @return Standard of a DCP that was read in */
+ boost::optional<Standard> standard () const {
+ return _standard;
+ }
+
+ boost::filesystem::path directory () const {
+ return _directory;
+ }
+
+ /** @return PKL if this DCP was read from an existing one, or if write_xml() has been called on it.
+ * If neither is true, this method returns 0.
*/
- boost::filesystem::path write_pkl (
- Standard standard,
- std::string pkl_uuid,
- XMLMetadata metadata,
- boost::shared_ptr<const Signer> signer
- ) const;
-
+ boost::shared_ptr<PKL> pkl () const {
+ return _pkl;
+ }
+
+ static std::vector<boost::filesystem::path> directories_from_files (std::vector<boost::filesystem::path> files);
+
+private:
+
void write_volindex (Standard standard) const;
/** Write the ASSETMAP file.
* @param pkl_uuid UUID of our PKL.
- * @param pkl_length Length of our PKL in bytes.
+ * @param pkl_path Pathname of our PKL file.
*/
- void write_assetmap (Standard standard, std::string pkl_uuid, int pkl_length, XMLMetadata metadata) const;
+ void write_assetmap (Standard standard, std::string pkl_uuid, boost::filesystem::path pkl_path, XMLMetadata metadata) const;
/** the directory that we are writing to */
boost::filesystem::path _directory;
- /** the assets that make up this DCP */
- std::list<boost::shared_ptr<Asset> > _assets;
+ /** the CPLs that make up this DCP */
+ std::list<boost::shared_ptr<CPL> > _cpls;
+ boost::shared_ptr<PKL> _pkl;
+
+ /** Standard of DCP that was read in */
+ boost::optional<Standard> _standard;
};
}
projects / libdcp.git / blobdiff