tools/dcpdiff.cc

   1 /*
   2     Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of libdcp.
   5
   6     libdcp is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     libdcp is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
  18
  19     In addition, as a special exception, the copyright holders give
  20     permission to link the code of portions of this program with the
  21     OpenSSL library under certain conditions as described in each
  22     individual source file, and distribute linked combinations
  23     including the two.
  24
  25     You must obey the GNU General Public License in all respects
  26     for all of the code used other than OpenSSL.  If you modify
  27     file(s) with this exception, you may extend this exception to your
  28     version of the file(s), but you are not obligated to do so.  If you
  29     do not wish to do so, delete this exception statement from your
  30     version.  If you delete this exception statement from all source
  31     files in the program, then also delete it here.
  32 */
  33
  34 #include "dcp.h"
  35 #include "exceptions.h"
  36 #include "common.h"
  37 #include "mxf.h"
  38 #include <getopt.h>
  39 #include <boost/optional.hpp>
  40 #include <memory>
  41 #include <boost/filesystem.hpp>
  42 #include <boost/foreach.hpp>
  43 #include <iostream>
  44 #include <list>
  45
  46 using std::list;
  47 using std::cerr;
  48 using std::cout;
  49 using std::string;
  50 using std::shared_ptr;
  51 using std::vector;
  52 using boost::optional;
  53 using std::dynamic_pointer_cast;
  54 #if BOOST_VERSION >= 106100
  55 using namespace boost::placeholders;
  56 #endif
  57 using namespace dcp;
  58
  59 static bool verbose = false;
  60
  61 static void
  62 help (string n)
  63 {
  64         cerr << "Syntax: " << n << " [OPTION] <DCP> <DCP>\n"
  65              << "  -V, --version                     show libdcp version\n"
  66              << "  -h, --help                        show this help\n"
  67              << "  -v, --verbose                     be verbose\n"
  68              << "      --cpl-annotation-texts        allow differing CPL annotation texts\n"
  69              << "      --reel-annotation-texts       allow differing reel annotation texts\n"
  70              << "  -a, --annotation-texts            allow different CPL and reel annotation texts\n"
  71              << "  -d, --issue-dates                 allow different issue dates\n"
  72              << "  -m, --mean-pixel                  maximum allowed mean pixel error (default 5)\n"
  73              << "  -s, --std-dev-pixel               maximum allowed standard deviation of pixel error (default 5)\n"
  74              << "      --key                         hexadecimal key to use to decrypt MXFs\n"
  75              << "      --ignore-missing-assets       ignore missing asset files\n"
  76              << "      --export-differing-subtitles  export the first pair of differing image subtitles to the current working directory\n"
  77              << "\n"
  78              << "The <DCP>s are the DCP directories to compare.\n"
  79              << "Comparison is of metadata and content, ignoring timestamps\n"
  80              << "and differing UUIDs.\n";
  81 }
  82
  83 void
  84 note (NoteType t, string n)
  85 {
  86         if (t == NoteType::ERROR || verbose) {
  87                 cout << " " << n << "\n";
  88                 cout.flush ();
  89         }
  90 }
  91
  92 static
  93 DCP *
  94 load_dcp (boost::filesystem::path path, bool ignore_missing_assets, optional<string> key)
  95 {
  96         DCP* dcp = 0;
  97         try {
  98                 dcp = new DCP (path);
  99                 vector<dcp::VerificationNote> notes;
 100                 dcp->read (&notes);
 101                 filter_notes (notes, ignore_missing_assets);
 102                 for (auto i: notes) {
 103                         cerr << dcp::note_to_string(i) << "\n";
 104                 }
 105
 106                 if (key) {
 107                         auto assets = dcp->assets ();
 108                         for (auto i: assets) {
 109                                 auto mxf = dynamic_pointer_cast<MXF>(i);
 110                                 if (mxf) {
 111                                         mxf->set_key (Key (key.get ()));
 112                                 }
 113                         }
 114                 }
 115
 116         } catch (FileError& e) {
 117                 cerr << "Could not read DCP " << path.string() << "; " << e.what() << " " << e.filename() << "\n";
 118                 exit (EXIT_FAILURE);
 119         }
 120
 121         return dcp;
 122 }
 123
 124 int
 125 main (int argc, char* argv[])
 126 {
 127         dcp::init ();
 128
 129         EqualityOptions options;
 130         options.max_mean_pixel_error = 5;
 131         options.max_std_dev_pixel_error = 5;
 132         options.reel_hashes_can_differ = true;
 133         options.reel_annotation_texts_can_differ = false;
 134         bool ignore_missing_assets = false;
 135         optional<string> key;
 136
 137         int option_index = 0;
 138         while (1) {
 139                 static struct option long_options[] = {
 140                         { "version", no_argument, 0, 'V'},
 141                         { "help", no_argument, 0, 'h'},
 142                         { "verbose", no_argument, 0, 'v'},
 143                         { "mean-pixel", required_argument, 0, 'm'},
 144                         { "std-dev-pixel", required_argument, 0, 's'},
 145                         { "annotation-texts", no_argument, 0, 'a'},
 146                         { "issue-dates", no_argument, 0, 'd'},
 147                         /* From here we're using random capital letters for the short option */
 148                         { "ignore-missing-assets", no_argument, 0, 'A'},
 149                         { "cpl-annotation-texts", no_argument, 0, 'C'},
 150                         { "key", required_argument, 0, 'D'},
 151                         { "reel-annotation-texts", no_argument, 0, 'E'},
 152                         { "export-differing-subtitles", no_argument, 0, 'F' },
 153                         { 0, 0, 0, 0 }
 154                 };
 155
 156                 int c = getopt_long (argc, argv, "Vhvm:s:adACD:EF", long_options, &option_index);
 157
 158                 if (c == -1) {
 159                         break;
 160                 }
 161
 162                 switch (c) {
 163                 case 'V':
 164                         cout << "dcpdiff version " << LIBDCP_VERSION << "\n";
 165                         exit (EXIT_SUCCESS);
 166                 case 'h':
 167                         help (argv[0]);
 168                         exit (EXIT_SUCCESS);
 169                 case 'v':
 170                         verbose = true;
 171                         break;
 172                 case 'm':
 173                         options.max_mean_pixel_error = atof (optarg);
 174                         break;
 175                 case 's':
 176                         options.max_std_dev_pixel_error = atof (optarg);
 177                         break;
 178                 case 'a':
 179                         options.cpl_annotation_texts_can_differ = options.reel_annotation_texts_can_differ = true;
 180                         break;
 181                 case 'd':
 182                         options.issue_dates_can_differ = true;
 183                         break;
 184                 case 'A':
 185                         ignore_missing_assets = true;
 186                         break;
 187                 case 'B':
 188                 case 'C':
 189                         options.cpl_annotation_texts_can_differ = true;
 190                         break;
 191                 case 'D':
 192                         key = string (optarg);
 193                         break;
 194                 case 'E':
 195                         options.reel_annotation_texts_can_differ = true;
 196                         break;
 197                 case 'F':
 198                         options.export_differing_subtitles = true;
 199                         break;
 200                 }
 201         }
 202
 203         if (argc <= (optind + 1) || argc > (optind + 2)) {
 204                 help (argv[0]);
 205                 exit (EXIT_FAILURE);
 206         }
 207
 208         if (!boost::filesystem::exists (argv[optind])) {
 209                 cerr << argv[0] << ": DCP " << argv[optind] << " not found.\n";
 210                 exit (EXIT_FAILURE);
 211         }
 212
 213         if (!boost::filesystem::exists (argv[optind + 1])) {
 214                 cerr << argv[0] << ": DCP " << argv[optind + 1] << " not found.\n";
 215                 exit (EXIT_FAILURE);
 216         }
 217
 218         DCP* a = load_dcp (argv[optind], ignore_missing_assets, key);
 219         DCP* b = load_dcp (argv[optind + 1], ignore_missing_assets, key);
 220
 221         /* I think this is just below the LSB at 16-bits (ie the 8th most significant bit at 24-bit) */
 222         options.max_audio_sample_error = 255;
 223
 224         bool const equals = a->equals (*b, options, boost::bind (note, _1, _2));
 225
 226         exit (equals ? EXIT_SUCCESS : EXIT_FAILURE);
 227 }