Fix crash with insufficient parameters to libdcp.
[libdcp.git] / 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 <boost/shared_ptr.hpp>
41 #include <boost/filesystem.hpp>
42 #include <iostream>
43 #include <list>
44
45 using std::list;
46 using std::cerr;
47 using std::cout;
48 using std::string;
49 using boost::shared_ptr;
50 using boost::optional;
51 using boost::dynamic_pointer_cast;
52 using namespace dcp;
53
54 static bool verbose = false;
55
56 static void
57 help (string n)
58 {
59         cerr << "Syntax: " << n << " [OPTION] <DCP> <DCP>\n"
60              << "  -V, --version                show libdcp version\n"
61              << "  -h, --help                   show this help\n"
62              << "  -v, --verbose                be verbose\n"
63              << "      --cpl-annotation-texts   allow differing CPL annotation texts\n"
64              << "      --reel-annotation-texts  allow differing reel annotation texts\n"
65              << "  -a, --annotation-texts       allow different CPL and reel annotation texts\n"
66              << "  -d, --issue-dates            allow different issue dates\n"
67              << "  -m, --mean-pixel             maximum allowed mean pixel error (default 5)\n"
68              << "  -s, --std-dev-pixel          maximum allowed standard deviation of pixel error (default 5)\n"
69              << "      --key                    hexadecimal key to use to decrypt MXFs\n"
70              << "  -k, --keep-going             carry on in the event of errors, if possible\n"
71              << "      --ignore-missing-assets  ignore missing asset files\n"
72              << "\n"
73              << "The <DCP>s are the DCP directories to compare.\n"
74              << "Comparison is of metadata and content, ignoring timestamps\n"
75              << "and differing UUIDs.\n";
76 }
77
78 void
79 note (NoteType t, string n)
80 {
81         if (t == DCP_ERROR || verbose) {
82                 cout << " " << n << "\n";
83                 cout.flush ();
84         }
85 }
86
87 DCP *
88 load_dcp (boost::filesystem::path path, bool keep_going, bool ignore_missing_assets, optional<string> key)
89 {
90         DCP* dcp = 0;
91         try {
92                 dcp = new DCP (path);
93                 DCP::ReadErrors errors;
94                 dcp->read (keep_going, &errors);
95                 filter_errors (errors, ignore_missing_assets);
96                 for (DCP::ReadErrors::const_iterator i = errors.begin(); i != errors.end(); ++i) {
97                         cerr << (*i)->what() << "\n";
98                 }
99
100                 if (key) {
101                         list<shared_ptr<Asset> > assets = dcp->assets ();
102                         for (list<shared_ptr<Asset> >::const_iterator i = assets.begin(); i != assets.end(); ++i) {
103                                 shared_ptr<MXF> mxf = dynamic_pointer_cast<MXF> (*i);
104                                 if (mxf) {
105                                         mxf->set_key (Key (key.get ()));
106                                 }
107                         }
108                 }
109
110         } catch (FileError& e) {
111                 cerr << "Could not read DCP " << path.string() << "; " << e.what() << " " << e.filename() << "\n";
112                 exit (EXIT_FAILURE);
113         }
114
115         return dcp;
116 }
117
118 int
119 main (int argc, char* argv[])
120 {
121         EqualityOptions options;
122         options.max_mean_pixel_error = 5;
123         options.max_std_dev_pixel_error = 5;
124         options.reel_hashes_can_differ = true;
125         options.reel_annotation_texts_can_differ = false;
126         options.keep_going = false;
127         bool ignore_missing_assets = false;
128         optional<string> key;
129
130         int option_index = 0;
131         while (1) {
132                 static struct option long_options[] = {
133                         { "version", no_argument, 0, 'V'},
134                         { "help", no_argument, 0, 'h'},
135                         { "verbose", no_argument, 0, 'v'},
136                         { "mean-pixel", required_argument, 0, 'm'},
137                         { "std-dev-pixel", required_argument, 0, 's'},
138                         { "keep-going", no_argument, 0, 'k'},
139                         { "annotation-texts", no_argument, 0, 'a'},
140                         { "issue-dates", no_argument, 0, 'd'},
141                         /* From here we're using random capital letters for the short option */
142                         { "ignore-missing-assets", no_argument, 0, 'A'},
143                         { "cpl-annotation-texts", no_argument, 0, 'C'},
144                         { "key", required_argument, 0, 'D'},
145                         { "reel-annotation-texts", no_argument, 0, 'E'},
146                         { 0, 0, 0, 0 }
147                 };
148
149                 int c = getopt_long (argc, argv, "Vhvm:s:kadACD:E", long_options, &option_index);
150
151                 if (c == -1) {
152                         break;
153                 }
154
155                 switch (c) {
156                 case 'V':
157                         cout << "dcpdiff version " << LIBDCP_VERSION << "\n";
158                         exit (EXIT_SUCCESS);
159                 case 'h':
160                         help (argv[0]);
161                         exit (EXIT_SUCCESS);
162                 case 'v':
163                         verbose = true;
164                         break;
165                 case 'm':
166                         options.max_mean_pixel_error = atof (optarg);
167                         break;
168                 case 's':
169                         options.max_std_dev_pixel_error = atof (optarg);
170                         break;
171                 case 'k':
172                         options.keep_going = true;
173                         break;
174                 case 'a':
175                         options.cpl_annotation_texts_can_differ = options.reel_annotation_texts_can_differ = true;
176                         break;
177                 case 'd':
178                         options.issue_dates_can_differ = true;
179                         break;
180                 case 'A':
181                         ignore_missing_assets = true;
182                         break;
183                 case 'B':
184                 case 'C':
185                         options.cpl_annotation_texts_can_differ = true;
186                         break;
187                 case 'D':
188                         key = string (optarg);
189                         break;
190                 case 'E':
191                         options.reel_annotation_texts_can_differ = true;
192                         break;
193                 }
194         }
195
196         if (argc <= (optind + 1) || argc > (optind + 2)) {
197                 help (argv[0]);
198                 exit (EXIT_FAILURE);
199         }
200
201         if (!boost::filesystem::exists (argv[optind])) {
202                 cerr << argv[0] << ": DCP " << argv[optind] << " not found.\n";
203                 exit (EXIT_FAILURE);
204         }
205
206         if (!boost::filesystem::exists (argv[optind + 1])) {
207                 cerr << argv[0] << ": DCP " << argv[optind + 1] << " not found.\n";
208                 exit (EXIT_FAILURE);
209         }
210
211         DCP* a = load_dcp (argv[optind], options.keep_going, ignore_missing_assets, key);
212         DCP* b = load_dcp (argv[optind + 1], options.keep_going, ignore_missing_assets, key);
213
214         /* I think this is just below the LSB at 16-bits (ie the 8th most significant bit at 24-bit) */
215         options.max_audio_sample_error = 255;
216
217         bool const equals = a->equals (*b, options, boost::bind (note, _1, _2));
218
219         exit (equals ? EXIT_SUCCESS : EXIT_FAILURE);
220 }