verify.h

Go to the documentation of this file.

/*
    Copyright (C) 2018-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_VERIFY_H
#define LIBDCP_VERIFY_H
 
 
#include "decrypted_kdm.h"
#include <boost/any.hpp>
#include <boost/filesystem.hpp>
#include <boost/function.hpp>
#include <boost/optional.hpp>
#include <map>
#include <string>
#include <vector>
 
 
/* windows.h defines this but we want to use it */
#undef ERROR
 
 
namespace dcp {
 
 
class DCP;
class TextAsset;
 
 
class VerificationNote
{
public:
        enum class Type {
                OK,
                ERROR,
                BV21_ERROR, 
                WARNING
        };
 
        // If you change the next line, also look in doc/manual/verifier.py in DCP-o-matic
        // as it looks for it when compiling the manual.  Also, in this enum:
        //   [...]  will be taken as a reference to a section of Bv2.1
        //   _foo_  means foo should be written as a piece of code
        enum class Code {
                FAILED_READ,
                MATCHING_CPL_HASHES,
                MISMATCHED_CPL_HASHES,
                INVALID_PICTURE_FRAME_RATE,
                CORRECT_PICTURE_HASH,
                INCORRECT_PICTURE_HASH,
                MISMATCHED_PICTURE_HASHES,
                INCORRECT_SOUND_HASH,
                MISMATCHED_SOUND_HASHES,
                EMPTY_ASSET_PATH,
                MISSING_ASSET,
                MISMATCHED_STANDARD,
                INVALID_XML,
                MISSING_ASSETMAP,
                INVALID_INTRINSIC_DURATION,
                INVALID_DURATION,
                VALID_PICTURE_FRAME_SIZES_IN_BYTES,
                INVALID_PICTURE_FRAME_SIZE_IN_BYTES,
                NEARLY_INVALID_PICTURE_FRAME_SIZE_IN_BYTES,
                EXTERNAL_ASSET,
                THREED_ASSET_MARKED_AS_TWOD,
                INVALID_STANDARD,
                INVALID_LANGUAGE,
                VALID_RELEASE_TERRITORY,
                INVALID_PICTURE_SIZE_IN_PIXELS,
                INVALID_PICTURE_FRAME_RATE_FOR_2K,
                INVALID_PICTURE_FRAME_RATE_FOR_4K,
                INVALID_PICTURE_ASSET_RESOLUTION_FOR_3D,
                INVALID_CLOSED_CAPTION_XML_SIZE_IN_BYTES,
                INVALID_TIMED_TEXT_SIZE_IN_BYTES,
                INVALID_TIMED_TEXT_FONT_SIZE_IN_BYTES,
                MISSING_SUBTITLE_LANGUAGE,
                MISMATCHED_SUBTITLE_LANGUAGES,
                MISSING_SUBTITLE_START_TIME,
                INVALID_SUBTITLE_START_TIME,
                INVALID_SUBTITLE_FIRST_TEXT_TIME,
                INVALID_SUBTITLE_DURATION,
                INVALID_SUBTITLE_SPACING,
                SUBTITLE_OVERLAPS_REEL_BOUNDARY,
                INVALID_SUBTITLE_LINE_COUNT,
                NEARLY_INVALID_SUBTITLE_LINE_LENGTH,
                INVALID_SUBTITLE_LINE_LENGTH,
                INVALID_CLOSED_CAPTION_LINE_COUNT,
                INVALID_CLOSED_CAPTION_LINE_LENGTH,
                INVALID_SOUND_FRAME_RATE,
                INVALID_SOUND_BIT_DEPTH,
                MISSING_CPL_ANNOTATION_TEXT,
                MISMATCHED_CPL_ANNOTATION_TEXT,
                VALID_CPL_ANNOTATION_TEXT,
                MISMATCHED_ASSET_DURATION,
                MISSING_MAIN_SUBTITLE_FROM_SOME_REELS,
                MISMATCHED_CLOSED_CAPTION_ASSET_COUNTS,
                MISSING_SUBTITLE_ENTRY_POINT,
                INCORRECT_SUBTITLE_ENTRY_POINT,
                MISSING_CLOSED_CAPTION_ENTRY_POINT,
                INCORRECT_CLOSED_CAPTION_ENTRY_POINT,
                MISSING_HASH,
                MISSING_FFEC_IN_FEATURE,
                MISSING_FFMC_IN_FEATURE,
                MISSING_FFOC,
                MISSING_LFOC,
                INCORRECT_FFOC,
                INCORRECT_LFOC,
                MISSING_CPL_METADATA,
                MISSING_CPL_METADATA_VERSION_NUMBER,
                MISSING_EXTENSION_METADATA,
                INVALID_EXTENSION_METADATA,
                UNSIGNED_CPL_WITH_ENCRYPTED_CONTENT,
                UNSIGNED_PKL_WITH_ENCRYPTED_CONTENT,
                MISMATCHED_PKL_ANNOTATION_TEXT_WITH_CPL,
                MATCHING_PKL_ANNOTATION_TEXT_WITH_CPL,
                ALL_ENCRYPTED,
                NONE_ENCRYPTED,
                PARTIALLY_ENCRYPTED,
                INVALID_JPEG2000_CODESTREAM,
                INVALID_JPEG2000_GUARD_BITS_FOR_2K,
                INVALID_JPEG2000_GUARD_BITS_FOR_4K,
                INVALID_JPEG2000_TILE_SIZE,
                INVALID_JPEG2000_CODE_BLOCK_WIDTH,
                INVALID_JPEG2000_CODE_BLOCK_HEIGHT,
                INCORRECT_JPEG2000_POC_MARKER_COUNT_FOR_2K,
                INCORRECT_JPEG2000_POC_MARKER_COUNT_FOR_4K,
                INCORRECT_JPEG2000_POC_MARKER,
                INVALID_JPEG2000_POC_MARKER_LOCATION,
                INVALID_JPEG2000_TILE_PARTS_FOR_2K,
                INVALID_JPEG2000_TILE_PARTS_FOR_4K,
                MISSING_JPEG200_TLM_MARKER,
                MISMATCHED_TIMED_TEXT_RESOURCE_ID,
                INCORRECT_TIMED_TEXT_ASSET_ID,
                MISMATCHED_TIMED_TEXT_DURATION,
                MISSED_CHECK_OF_ENCRYPTED,
                EMPTY_TEXT,
                MISMATCHED_CLOSED_CAPTION_VALIGN,
                INCORRECT_CLOSED_CAPTION_ORDERING,
                UNEXPECTED_ENTRY_POINT,
                UNEXPECTED_DURATION,
                INVALID_CONTENT_KIND,
                VALID_CONTENT_KIND,
                INVALID_MAIN_PICTURE_ACTIVE_AREA,
                VALID_MAIN_PICTURE_ACTIVE_AREA,
                DUPLICATE_ASSET_ID_IN_PKL,
                DUPLICATE_ASSET_ID_IN_ASSETMAP,
                MISSING_SUBTITLE,
                INVALID_SUBTITLE_ISSUE_DATE,
                MISMATCHED_SOUND_CHANNEL_COUNTS,
                INVALID_MAIN_SOUND_CONFIGURATION,
                MISSING_FONT,
                INVALID_JPEG2000_TILE_PART_SIZE,
                INCORRECT_SUBTITLE_NAMESPACE_COUNT,
                MISSING_LOAD_FONT_FOR_FONT,
                MISSING_LOAD_FONT,
                MISMATCHED_ASSET_MAP_ID,
                EMPTY_CONTENT_VERSION_LABEL_TEXT,
                VALID_CONTENT_VERSION_LABEL_TEXT,
                INVALID_CPL_NAMESPACE,
                MISSING_CPL_CONTENT_VERSION,
                INVALID_PKL_NAMESPACE
        };
 
        VerificationNote (Type type, Code code)
                : _type (type)
                , _code (code)
        {}
 
        VerificationNote (Type type, Code code, std::string note)
                : _type (type)
                , _code (code)
        {
                _data[Data::NOTE] = note;
        }
 
        VerificationNote (Type type, Code code, boost::filesystem::path file)
                : _type (type)
                , _code (code)
        {
                _data[Data::FILE] = file;
        }
 
        VerificationNote (Type type, Code code, std::string note, boost::filesystem::path file)
                : _type (type)
                , _code (code)
        {
                _data[Data::NOTE] = note;
                _data[Data::FILE] = file;
        }
 
        VerificationNote (Type type, Code code, std::string note, boost::filesystem::path file, uint64_t line)
                : _type (type)
                , _code (code)
        {
                _data[Data::NOTE] = note;
                _data[Data::FILE] = file;
                _data[Data::LINE] = line;
        }
 
        Type type () const {
                return _type;
        }
 
        Code code () const {
                return _code;
        }
 
private:
        enum class Data {
                NOTE,  
                FILE,  
                LINE,  
                FRAME,
                COMPONENT,
                SIZE,
                ID,
                OTHER_ID,
                FRAME_RATE,
                CPL_ID,
                CALCULATED_HASH,
                REFERENCE_HASH
        };
 
        template <class T>
        boost::optional<T> data(Data key) const
        {
                auto iter = _data.find(key);
                if (iter == _data.end()) {
                        return {};
                }
                return boost::any_cast<T>(iter->second);
        }
 
public:
        boost::optional<std::string> note () const {
                return data<std::string>(Data::NOTE);
        }
 
        boost::optional<boost::filesystem::path> file () const {
                return data<boost::filesystem::path>(Data::FILE);
        }
 
        boost::optional<uint64_t> line () const {
                return data<uint64_t>(Data::LINE);
        }
 
        VerificationNote& set_frame(int frame) {
                _data[Data::FRAME] = frame;
                return *this;
        }
 
        boost::optional<int> frame() const {
                return data<int>(Data::FRAME);
        }
 
        VerificationNote& set_component(int component) {
                _data[Data::COMPONENT] = component;
                return *this;
        }
 
        boost::optional<int> component() const {
                return data<int>(Data::COMPONENT);
        }
 
        VerificationNote& set_size(int size) {
                _data[Data::SIZE] = size;
                return *this;
        }
 
        boost::optional<int> size() const {
                return data<int>(Data::SIZE);
        }
 
        VerificationNote& set_id(std::string id) {
                _data[Data::ID] = id;
                return *this;
        }
 
        boost::optional<std::string> id() const {
                return data<std::string>(Data::ID);
        }
 
        VerificationNote& set_other_id(std::string other_id) {
                _data[Data::OTHER_ID] = other_id;
                return *this;
        }
 
        boost::optional<std::string> other_id() const {
                return data<std::string>(Data::OTHER_ID);
        }
 
        VerificationNote& set_frame_rate(int frame_rate) {
                _data[Data::FRAME_RATE] = frame_rate;
                return *this;
        }
 
        boost::optional<int> frame_rate() const {
                return data<int>(Data::FRAME_RATE);
        }
 
        VerificationNote& set_calculated_hash(std::string hash) {
                _data[Data::CALCULATED_HASH] = hash;
                return *this;
        }
 
        boost::optional<std::string> calculated_hash() const {
                return data<std::string>(Data::CALCULATED_HASH);
        }
 
        VerificationNote& set_reference_hash(std::string hash) {
                _data[Data::REFERENCE_HASH] = hash;
                return *this;
        }
 
        boost::optional<std::string> reference_hash() const {
                return data<std::string>(Data::REFERENCE_HASH);
        }
 
        VerificationNote& set_cpl_id(std::string id) {
                _data[Data::CPL_ID] = id;
                return *this;
        }
 
        boost::optional<std::string> cpl_id() const {
                return data<std::string>(Data::CPL_ID);
        }
 
private:
        Type _type;
        Code _code;
        std::map<Data, boost::any> _data;
};
 
 
struct VerificationOptions
{
        boost::optional<boost::uintmax_t> maximum_asset_size_for_hash_check;
        bool check_asset_hashes = true;
};
 
 
struct VerificationResult
{
        std::vector<VerificationNote> notes;
        std::vector<std::shared_ptr<dcp::DCP>> dcps;
};
 
 
VerificationResult verify(
        std::vector<boost::filesystem::path> directories,
        std::vector<dcp::DecryptedKDM> kdms,
        std::function<void (std::string, boost::optional<boost::filesystem::path>)> stage,
        std::function<void (float)> progress,
        VerificationOptions options = {},
        boost::optional<boost::filesystem::path> xsd_dtd_directory = boost::optional<boost::filesystem::path>()
        );
 
std::string note_to_string(
        dcp::VerificationNote note,
        std::function<std::string (std::string)> process_string = [](std::string s) { return s; },
        std::function<std::string (std::string)> process_filename = [](std::string s) { return s; }
        );
 
bool operator== (dcp::VerificationNote const& a, dcp::VerificationNote const& b);
bool operator!=(dcp::VerificationNote const& a, dcp::VerificationNote const& b);
bool operator< (dcp::VerificationNote const& a, dcp::VerificationNote const& b);
 
std::ostream& operator<<(std::ostream& s, dcp::VerificationNote const& note);
 
}
 
#endif