Use VerificationNote for non-fatal errors in DCP::read.
[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 <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 boost::shared_ptr;
51 using boost::optional;
52 using boost::dynamic_pointer_cast;
53 using namespace dcp;
54
55 static bool verbose = false;
56
57 static void
58 help (string n)
59 {
60         cerr << "Syntax: " << n << " [OPTION] <DCP> <DCP>\n"
61              << "  -V, --version                show libdcp version\n"
62              << "  -h, --help                   show this help\n"
63              << "  -v, --verbose                be verbose\n"
64              << "      --cpl-annotation-texts   allow differing CPL annotation texts\n"
65              << "      --reel-annotation-texts  allow differing reel annotation texts\n"
66              << "  -a, --annotation-texts       allow different CPL and reel annotation texts\n"
67              << "  -d, --issue-dates            allow different issue dates\n"
68              << "  -m, --mean-pixel             maximum allowed mean pixel error (default 5)\n"
69              << "  -s, --std-dev-pixel          maximum allowed standard deviation of pixel error (default 5)\n"
70              << "      --key                    hexadecimal key to use to decrypt MXFs\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 static
88 DCP *
89 load_dcp (boost::filesystem::path path, bool ignore_missing_assets, optional<string> key)
90 {
91         DCP* dcp = 0;
92         try {
93                 dcp = new DCP (path);
94                 list<dcp::VerificationNote> notes;
95                 dcp->read (&notes);
96                 filter_notes (notes, ignore_missing_assets);
97                 BOOST_FOREACH (dcp::VerificationNote i, notes) {
98                         cerr << dcp::note_to_string(i) << "\n";
99                 }
100
101                 if (key) {
102                         list<shared_ptr<Asset> > assets = dcp->assets ();
103                         for (list<shared_ptr<Asset> >::const_iterator i = assets.begin(); i != assets.end(); ++i) {
104                                 shared_ptr<MXF> mxf = dynamic_pointer_cast<MXF> (*i);
105                                 if (mxf) {
106                                         mxf->set_key (Key (key.get ()));
107                                 }
108                         }
109                 }
110
111         } catch (FileError& e) {
112                 cerr << "Could not read DCP " << path.string() << "; " << e.what() << " " << e.filename() << "\n";
113                 exit (EXIT_FAILURE);
114         }
115
116         return dcp;
117 }
118
119 int
120 main (int argc, char* argv[])
121 {
122         EqualityOptions options;
123         options.max_mean_pixel_error = 5;
124         options.max_std_dev_pixel_error = 5;
125         options.reel_hashes_can_differ = true;
126         options.reel_annotation_texts_can_differ = 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                         { "annotation-texts", no_argument, 0, 'a'},
139                         { "issue-dates", no_argument, 0, 'd'},
140                         /* From here we're using random capital letters for the short option */
141                         { "ignore-missing-assets", no_argument, 0, 'A'},
142                         { "cpl-annotation-texts", no_argument, 0, 'C'},
143                         { "key", required_argument, 0, 'D'},
144                         { "reel-annotation-texts", no_argument, 0, 'E'},
145                         { 0, 0, 0, 0 }
146                 };
147
148                 int c = getopt_long (argc, argv, "Vhvm:s:adACD:E", long_options, &option_index);
149
150                 if (c == -1) {
151                         break;
152                 }
153
154                 switch (c) {
155                 case 'V':
156                         cout << "dcpdiff version " << LIBDCP_VERSION << "\n";
157                         exit (EXIT_SUCCESS);
158                 case 'h':
159                         help (argv[0]);
160                         exit (EXIT_SUCCESS);
161                 case 'v':
162                         verbose = true;
163                         break;
164                 case 'm':
165                         options.max_mean_pixel_error = atof (optarg);
166                         break;
167                 case 's':
168                         options.max_std_dev_pixel_error = atof (optarg);
169                         break;
170                 case 'a':
171                         options.cpl_annotation_texts_can_differ = options.reel_annotation_texts_can_differ = true;
172                         break;
173                 case 'd':
174                         options.issue_dates_can_differ = true;
175                         break;
176                 case 'A':
177                         ignore_missing_assets = true;
178                         break;
179                 case 'B':
180                 case 'C':
181                         options.cpl_annotation_texts_can_differ = true;
182                         break;
183                 case 'D':
184                         key = string (optarg);
185                         break;
186                 case 'E':
187                         options.reel_annotation_texts_can_differ = true;
188                         break;
189                 }
190         }
191
192         if (argc <= (optind + 1) || argc > (optind + 2)) {
193                 help (argv[0]);
194                 exit (EXIT_FAILURE);
195         }
196
197         if (!boost::filesystem::exists (argv[optind])) {
198                 cerr << argv[0] << ": DCP " << argv[optind] << " not found.\n";
199                 exit (EXIT_FAILURE);
200         }
201
202         if (!boost::filesystem::exists (argv[optind + 1])) {
203                 cerr << argv[0] << ": DCP " << argv[optind + 1] << " not found.\n";
204                 exit (EXIT_FAILURE);
205         }
206
207         DCP* a = load_dcp (argv[optind], ignore_missing_assets, key);
208         DCP* b = load_dcp (argv[optind + 1], ignore_missing_assets, key);
209
210         /* I think this is just below the LSB at 16-bits (ie the 8th most significant bit at 24-bit) */
211         options.max_audio_sample_error = 255;
212
213         bool const equals = a->equals (*b, options, boost::bind (note, _1, _2));
214
215         exit (equals ? EXIT_SUCCESS : EXIT_FAILURE);
216 }