path: root/tools/dcpdiff.cc

/*
    Copyright (C) 2012-2014 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.
*/


#include "common.h"
#include "dcp.h"
#include "equality_options.h"
#include "exceptions.h"
#include "filesystem.h"
#include "mxf.h"
#include <getopt.h>
#include <boost/bind/bind.hpp>
#include <boost/filesystem.hpp>
#include <boost/optional.hpp>
#include <iostream>
#include <list>
#include <memory>


using std::list;
using std::cerr;
using std::cout;
using std::string;
using std::shared_ptr;
using std::vector;
using boost::optional;
using std::dynamic_pointer_cast;
#if BOOST_VERSION >= 106100
using namespace boost::placeholders;
#endif
using namespace dcp;

static bool verbose = false;

static void
help (string n)
{
	cerr << "Syntax: " << n << " [OPTION] <DCP> <DCP>\n"
	     << "  -V, --version                     show libdcp version\n"
	     << "  -h, --help                        show this help\n"
	     << "  -v, --verbose                     be verbose\n"
	     << "      --cpl-annotation-texts        allow differing CPL annotation texts\n"
	     << "      --reel-annotation-texts       allow differing reel annotation texts\n"
	     << "  -a, --annotation-texts            allow different CPL and reel annotation texts\n"
	     << "  -d, --issue-dates                 allow different issue dates\n"
	     << "  -m, --mean-pixel                  maximum allowed mean pixel error (default 5)\n"
	     << "  -s, --std-dev-pixel               maximum allowed standard deviation of pixel error (default 5)\n"
	     << "      --key                         hexadecimal key to use to decrypt MXFs\n"
	     << "      --ignore-missing-assets       ignore missing asset files\n"
	     << "      --export-differing-subtitles  export the first pair of differing image subtitles to the current working directory\n"
	     << "\n"
	     << "The <DCP>s are the DCP directories to compare.\n"
	     << "Comparison is of metadata and content, ignoring timestamps\n"
	     << "and differing UUIDs.\n";
}

void
note (NoteType t, string n)
{
	if (t == NoteType::ERROR || verbose) {
		cout << " " << n << "\n";
		cout.flush ();
	}
}

static
DCP *
load_dcp (boost::filesystem::path path, bool ignore_missing_assets, optional<string> key)
{
	DCP* dcp = 0;
	try {
		dcp = new DCP (path);
		vector<dcp::VerificationNote> notes;
		dcp->read (&notes);
		for (auto i: dcp::filter_notes(notes, ignore_missing_assets, false)) {
			cerr << dcp::note_to_string(i) << "\n";
		}

		if (key) {
			auto assets = dcp->assets ();
			for (auto i: assets) {
				auto mxf = dynamic_pointer_cast<MXF>(i);
				if (mxf) {
					mxf->set_key (Key (key.get ()));
				}
			}
		}

	} catch (FileError& e) {
		cerr << "Could not read DCP " << path.string() << "; " << e.what() << " " << e.filename() << "\n";
		exit (EXIT_FAILURE);
	}

	return dcp;
}

int
main (int argc, char* argv[])
{
	dcp::init ();

	EqualityOptions options;
	options.max_mean_pixel_error = 5;
	options.max_std_dev_pixel_error = 5;
	options.reel_hashes_can_differ = true;
	options.reel_annotation_texts_can_differ = false;
	bool ignore_missing_assets = false;
	optional<string> key;

	int option_index = 0;
	while (1) {
		static struct option long_options[] = {
			{ "version", no_argument, 0, 'V'},
			{ "help", no_argument, 0, 'h'},
			{ "verbose", no_argument, 0, 'v'},
			{ "mean-pixel", required_argument, 0, 'm'},
			{ "std-dev-pixel", required_argument, 0, 's'},
			{ "annotation-texts", no_argument, 0, 'a'},
			{ "issue-dates", no_argument, 0, 'd'},
			/* From here we're using random capital letters for the short option */
			{ "ignore-missing-assets", no_argument, 0, 'A'},
			{ "cpl-annotation-texts", no_argument, 0, 'C'},
			{ "key", required_argument, 0, 'D'},
			{ "reel-annotation-texts", no_argument, 0, 'E'},
			{ "export-differing-subtitles", no_argument, 0, 'F' },
			{ 0, 0, 0, 0 }
		};

		int c = getopt_long (argc, argv, "Vhvm:s:adACD:EF", long_options, &option_index);

		if (c == -1) {
			break;
		}

		switch (c) {
		case 'V':
			cout << "dcpdiff version " << dcp::version << "\n";
			exit (EXIT_SUCCESS);
		case 'h':
			help (argv[0]);
			exit (EXIT_SUCCESS);
		case 'v':
			verbose = true;
			break;
		case 'm':
			options.max_mean_pixel_error = atof (optarg);
			break;
		case 's':
			options.max_std_dev_pixel_error = atof (optarg);
			break;
		case 'a':
			options.cpl_annotation_texts_can_differ = options.reel_annotation_texts_can_differ = true;
			break;
		case 'd':
			options.issue_dates_can_differ = true;
			break;
		case 'A':
			ignore_missing_assets = true;
			break;
		case 'B':
		case 'C':
			options.cpl_annotation_texts_can_differ = true;
			break;
		case 'D':
			key = string (optarg);
			break;
		case 'E':
			options.reel_annotation_texts_can_differ = true;
			break;
		case 'F':
			options.export_differing_texts = true;
			break;
		}
	}

	if (argc <= (optind + 1) || argc > (optind + 2)) {
		help (argv[0]);
		exit (EXIT_FAILURE);
	}

	if (!filesystem::exists(argv[optind])) {
		cerr << argv[0] << ": DCP " << argv[optind] << " not found.\n";
		exit (EXIT_FAILURE);
	}

	if (!filesystem::exists(argv[optind + 1])) {
		cerr << argv[0] << ": DCP " << argv[optind + 1] << " not found.\n";
		exit (EXIT_FAILURE);
	}

	DCP* a = load_dcp (argv[optind], ignore_missing_assets, key);
	DCP* b = load_dcp (argv[optind + 1], ignore_missing_assets, key);

	/* I think this is just below the LSB at 16-bits (ie the 8th most significant bit at 24-bit) */
	options.max_audio_sample_error = 255;

	bool const equals = a->equals (*b, options, boost::bind (note, _1, _2));

	exit (equals ? EXIT_SUCCESS : EXIT_FAILURE);
}