dcp.h

Go to the documentation of this file.

/*
    Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
 
    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.
 
    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 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.
*/
 
 
#ifndef LIBDCP_DCP_H
#define LIBDCP_DCP_H
 
 
#include "compose.hpp"
#include "types.h"
#include "util.h"
#include "certificate.h"
#include "metadata.h"
#include "name_format.h"
#include "verify.h"
#include "version.h"
#include <boost/signals2.hpp>
#include <memory>
#include <string>
#include <vector>
 
 
namespace xmlpp {
        class Document;
        class Element;
}
 
 
namespace dcp
{
 
 
class PKL;
class Content;
class Reel;
class CPL;
class CertificateChain;
class DecryptedKDM;
class Asset;
class ReadError;
 
 
class DCP
{
public:
        explicit DCP (boost::filesystem::path directory);
 
        DCP (DCP const&) = delete;
        DCP& operator= (DCP const&) = delete;
 
        void read (std::vector<VerificationNote>* notes = nullptr, bool ignore_incorrect_picture_mxf_type = false);
 
        bool equals (DCP const & other, EqualityOptions options, NoteHandler note) const;
 
        void add (std::shared_ptr<CPL> cpl);
 
        std::vector<std::shared_ptr<CPL>> cpls () const;
 
        std::vector<std::shared_ptr<Asset>> assets (bool ignore_unresolved = false) const;
 
        bool any_encrypted () const;
        bool all_encrypted () const;
 
        void add (DecryptedKDM const &);
 
        void write_xml (
                std::string issuer = String::compose("libdcp %1", dcp::version),
                std::string creator = String::compose("libdcp %1", dcp::version),
                std::string issue_date = LocalTime().as_string(),
                std::string annotation_text = String::compose("Created by libdcp %1", dcp::version),
                std::shared_ptr<const CertificateChain> signer = std::shared_ptr<const CertificateChain>(),
                NameFormat name_format = NameFormat("%t")
        );
 
        void resolve_refs (std::vector<std::shared_ptr<Asset>> assets);
 
        boost::optional<Standard> standard () const {
                return _standard;
        }
 
        boost::filesystem::path directory () const {
                return _directory;
        }
 
        std::vector<std::shared_ptr<PKL>> pkls () const {
                return _pkls;
        }
 
        boost::optional<boost::filesystem::path> asset_map_path () {
                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;
 
        void write_assetmap (
                Standard standard, std::string pkl_uuid, boost::filesystem::path pkl_path,
                std::string issuer, std::string creator, std::string issue_date, std::string annotation_text
                ) const;
 
        boost::filesystem::path _directory;
        std::vector<std::shared_ptr<CPL>> _cpls;
        std::vector<std::shared_ptr<PKL>> _pkls;
        mutable boost::optional<boost::filesystem::path> _asset_map;
 
        boost::optional<Standard> _standard;
};
 
 
}
 
 
#endif