/*
- Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2012-2021 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
+ * @brief DCP class
+ */
+
+
#ifndef LIBDCP_DCP_H
#define LIBDCP_DCP_H
-#include <string>
-#include <list>
-#include <boost/shared_ptr.hpp>
-#include <sigc++/sigc++.h>
+
+#include "asset_map.h"
+#include "certificate.h"
+#include "compose.hpp"
+#include "metadata.h"
+#include "name_format.h"
#include "types.h"
+#include "util.h"
+#include "verify.h"
+#include "version.h"
+#include <boost/signals2.hpp>
+#include <memory>
+#include <string>
+#include <vector>
+
+
+namespace xmlpp {
+ class Document;
+ class Element;
+}
+
/** @brief Namespace for everything in libdcp */
-namespace libdcp
+namespace dcp
{
-class Asset;
-
-/** @class DCP dcp.h libdcp/dcp.h
- * @brief A class to create a DCP.
- *
- * Typical use might be:
- * @code
- * #include <libdcp/dcp.h>
- * using namespace std;
- *
- * libdcp::DCP dcp ("My Film DCP", "My Film", libdcp::DCP::FEATURE, 24, 50000);
- *
- * vector<string> j2k_files;
- * j2k_files.push_back ("1.j2c");
- * ...
- * j2k_files.push_back ("50000.j2c");
- *
- * // These images are 1998x1080 pixels (DCI Flat)
- * dcp.add_picture_asset (j2k_files, 1998, 1080);
- *
- * vector<string> wav_files;
- * wav_files.push_back ("L.wav");
- * wav_files.push_back ("R.wav");
- * wav_files.push_back ("C.wav");
- * wav_files.push_back ("Lfe.wav");
- * wav_files.push_back ("Ls.wav");
- * wav_files.push_back ("Rs.wav");
- * dcp.add_sound_asset (wav_files);
- *
- * dcp.write_xml ();
- *
- * @endcode
- *
- * This will create a DCP at 24 frames per second with 50000 frames, writing
- * data to a directory "My Film DCP", naming the DCP "My Film" and marking
- * as a Feature. We then add the picture and sound files (which creates
- * MXF files inside the DCP directory) and then write the required XML files.
- *
- * If you want to report progress for long jobs (add_picture_asset() can
- * take a long time, in particular, as it must do a lot of disk I/O for
- * large DCPs), connect to the libdcp::DCP::Progress signal and report its parameter
- * to the user (it will range between 0 for 0% and 1 for 100%).
+
+class PKL;
+class Content;
+class Reel;
+class CPL;
+class CertificateChain;
+class DecryptedKDM;
+class Asset;
+class ReadError;
+
+
+/** @class DCP
+ * @brief A class to create or read a DCP
*/
-
class DCP
{
public:
- enum ContentType
- {
- FEATURE,
- SHORT,
- TRAILER,
- TEST,
- TRANSITIONAL,
- RATING,
- TEASER,
- POLICY,
- PUBLIC_SERVICE_ANNOUNCEMENT,
- ADVERTISEMENT
- };
-
- /** Construct a DCP.
- * @param directory Directory to write files to.
- * @param name Name.
- * @param content_type Content type.
- * @param fps Frames per second.
- * @param length Length in frames.
+ /** Construct a DCP. You can pass an existing DCP's directory
+ * 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 (std::string directory, std::string name, ContentType content_type, int fps, int length);
-
- /** Add a sound asset.
- * @param files Pathnames of WAV files to use in the order Left, Right,
- * Centre, Lfe (sub), Left surround, Right surround; not all files need
- * to be present.
+ explicit DCP (boost::filesystem::path directory);
+
+ DCP (DCP const&) = delete;
+ DCP& operator= (DCP const&) = delete;
+
+ DCP (DCP &&);
+ DCP& operator= (DCP &&);
+
+ /** Read a DCP. This method does not do any deep checking of the DCP's validity, but
+ * if it comes across any bad things it will do one of two things.
+ *
+ * Errors that are so serious that they prevent the method from working will result
+ * in an exception being thrown. For example, a missing ASSETMAP means that the DCP
+ * can't be read without a lot of guesswork, so this will throw.
+ *
+ * Errors that are not fatal will be added to notes, if it's non-null. For example,
+ * if the DCP contains a mixture of Interop and SMPTE elements this will result
+ * in a note being added to the vector.
+ *
+ * For more thorough checking of a DCP's contents, see dcp::verify().
+ *
+ * @param notes List of notes that will be added to if non-0.
+ * @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 add_sound_asset (std::vector<std::string> const & files);
+ void read (std::vector<VerificationNote>* notes = nullptr, bool ignore_incorrect_picture_mxf_type = false);
- /** Add a sound asset.
- * @param get_path Functor to get the path to the WAV for a given channel.
- * @param channels Number of channels.
+ /** Compare this DCP with another, according to various options.
+ * @param other DCP to compare this one to.
+ * @param options Options to define what "equality" means.
+ * @param note Functor to handle notes made by the equality operation.
+ * @return true if the DCPs are equal according to EqualityOptions, otherwise false.
*/
- void add_sound_asset (sigc::slot<std::string, Channel> get_path, int channels);
+ bool equals(DCP const & other, EqualityOptions const& options, NoteHandler note) const;
- /** Add a picture asset.
- * @param files Pathnames of JPEG2000 files, in frame order.
- * @param width Width of images in pixels.
- * @param height Height of images in pixels.
- */
- void add_picture_asset (std::vector<std::string> const & files, int width, int height);
+ void add (std::shared_ptr<CPL> cpl);
- /** Add a picture asset.
- * @param get_path Functor to get path to the JPEG2000 for a given frame.
- * @param width Width of images in pixels.
- * @param height Height of images in pixels.
- */
- void add_picture_asset (sigc::slot<std::string, int> get_path, int width, int height);
+ std::vector<std::shared_ptr<CPL>> cpls () const;
- /** Write the required XML files to the directory that was
- * passed into the constructor.
+ /** @param ignore_unresolved true to silently ignore unresolved assets, otherwise
+ * an exception is thrown if they are found.
+ * @return All assets (including CPLs).
*/
- void write_xml () const;
+ std::vector<std::shared_ptr<Asset>> assets (bool ignore_unresolved = false) const;
+
+ bool any_encrypted () const;
+ bool all_encrypted () const;
- /** Emitted with a parameter between 0 and 1 to indicate progress
- * for long jobs.
+ /** Add a KDM to decrypt this DCP. This method must be called after DCP::read()
+ * or the KDM you specify will be ignored.
+ * @param kdm KDM to use.
*/
- sigc::signal1<void, float> Progress;
+ void add (DecryptedKDM const &);
-private:
+ void set_issuer(std::string issuer);
+ void set_creator(std::string creator);
+ void set_issue_date(std::string issue_date);
+ void set_annotation_text(std::string annotation_text);
- /** Write the CPL file.
- * @param cpl_uuid UUID to use.
- * @return CPL pathname.
+ /** Write all the XML files for this DCP.
+ * @param signer Signer to use
+ * @param include_mca_subdescriptors true to write MCA subdescriptors to CPLs.
+ * @param name_format Name format to use for the CPL and PKL filenames
*/
- std::string write_cpl (std::string cpl_uuid) const;
+ void write_xml(
+ std::shared_ptr<const CertificateChain> signer = std::shared_ptr<const CertificateChain>(),
+ bool include_mca_subdescriptors = true,
+ NameFormat name_format = NameFormat("%t")
+ );
- /** Write the PKL file.
- * @param pkl_uuid UUID to use.
- * @param cpl_uuid UUID of the CPL file.
- * @param cpl_digest SHA digest of the CPL file.
- * @param cpl_length Length of the CPL file in bytes.
- */
- std::string write_pkl (std::string pkl_uuid, std::string cpl_uuid, std::string cpl_digest, int cpl_length) const;
-
- /** Write the VOLINDEX file */
- void write_volindex () const;
-
- /** Write the ASSETMAP file.
- * @param cpl_uuid UUID of our CPL.
- * @param cpl_length Length of our CPL in bytes.
- * @param pkl_uuid UUID of our PKL.
- * @param pkl_length Length of our PKL in bytes.
- */
- void write_assetmap (std::string cpl_uuid, int cpl_length, std::string pkl_uuid, int pkl_length) const;
+ void resolve_refs (std::vector<std::shared_ptr<Asset>> assets);
- /** @param type A content type.
- * @return A string representation suitable for use in a CPL.
+ /** @return Standard of a DCP that was read in */
+ boost::optional<Standard> standard () const {
+ if (!_asset_map) {
+ return {};
+ }
+
+ return _asset_map->standard();
+ }
+
+ boost::filesystem::path directory () const {
+ return _directory;
+ }
+
+ /** @return PKLs 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 an empty vector.
*/
- static std::string content_type_string (ContentType type);
-
- /** the directory that we are writing to */
- std::string _directory;
- /** the name of the DCP */
- std::string _name;
- /** the content type of the DCP */
- ContentType _content_type;
- /** frames per second */
- int _fps;
- /** length in frames */
- int _length;
- /** assets */
- std::list<boost::shared_ptr<Asset> > _assets;
+ std::vector<std::shared_ptr<PKL>> pkls () const {
+ return _pkls;
+ }
+
+ boost::optional<boost::filesystem::path> asset_map_file() const {
+ if (!_asset_map) {
+ return {};
+ }
+
+ return _asset_map->file();
+ }
+
+ boost::optional<AssetMap> asset_map() const {
+ return _asset_map;
+ }
+
+ static std::vector<boost::filesystem::path> directories_from_files (std::vector<boost::filesystem::path> files);
+
+private:
+
+ void write_volindex (Standard standard) const;
+
+ /** The directory that we are writing to */
+ boost::filesystem::path _directory;
+ /** The CPLs that make up this DCP */
+ std::vector<std::shared_ptr<CPL>> _cpls;
+ /** The PKLs that make up this DCP */
+ std::vector<std::shared_ptr<PKL>> _pkls;
+ boost::optional<AssetMap> _asset_map;
+
+ /* Metadata to use for newly created PKLs and AssetMaps */
+ boost::optional<std::string> _new_issuer;
+ boost::optional<std::string> _new_creator;
+ boost::optional<std::string> _new_issue_date;
+ boost::optional<std::string> _new_annotation_text;
};
+
}
+
#endif
projects / libdcp.git / blobdiff