test/test.cc

   1 /*
   2     Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic 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     DCP-o-matic 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 DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21
  22
  23 /** @file  test/test.cc
  24  *  @brief Overall test stuff and useful methods for tests.
  25  */
  26
  27
  28 #include "lib/compose.hpp"
  29 #include "lib/config.h"
  30 #include "lib/cross.h"
  31 #include "lib/dcp_content_type.h"
  32 #include "lib/dcpomatic_log.h"
  33 #include "lib/encode_server_finder.h"
  34 #include "lib/ffmpeg_image_proxy.h"
  35 #include "lib/file_log.h"
  36 #include "lib/film.h"
  37 #include "lib/image.h"
  38 #include "lib/job.h"
  39 #include "lib/job_manager.h"
  40 #include "lib/log_entry.h"
  41 #include "lib/make_dcp.h"
  42 #include "lib/ratio.h"
  43 #include "lib/signal_manager.h"
  44 #include "lib/util.h"
  45 #include "test.h"
  46 #include <dcp/cpl.h>
  47 #include <dcp/dcp.h>
  48 #include <dcp/equality_options.h>
  49 #include <dcp/mono_picture_asset.h>
  50 #include <dcp/mono_picture_frame.h>
  51 #include <dcp/openjpeg_image.h>
  52 #include <dcp/reel.h>
  53 #include <dcp/reel_picture_asset.h>
  54 #include <dcp/warnings.h>
  55 #include <asdcp/AS_DCP.h>
  56 #include <png.h>
  57 #include <sndfile.h>
  58 #include <libxml++/libxml++.h>
  59 extern "C" {
  60 #include <libavformat/avformat.h>
  61 }
  62 #define BOOST_TEST_DYN_LINK
  63 #define BOOST_TEST_MODULE dcpomatic_test
  64 #include <boost/algorithm/string.hpp>
  65 LIBDCP_DISABLE_WARNINGS
  66 #include <boost/random.hpp>
  67 LIBDCP_ENABLE_WARNINGS
  68 #include <boost/test/unit_test.hpp>
  69 #include <iostream>
  70 #include <list>
  71 #include <vector>
  72
  73
  74 using std::abs;
  75 using std::cerr;
  76 using std::cout;
  77 using std::list;
  78 using std::make_shared;
  79 using std::min;
  80 using std::shared_ptr;
  81 using std::string;
  82 using std::vector;
  83 using boost::scoped_array;
  84 using std::dynamic_pointer_cast;
  85 #if BOOST_VERSION >= 106100
  86 using namespace boost::placeholders;
  87 #endif
  88
  89
  90 boost::filesystem::path
  91 TestPaths::TestPaths::private_data ()
  92 {
  93         char* env = getenv("DCPOMATIC_TEST_PRIVATE");
  94         if (env) {
  95                 return boost::filesystem::path(env);
  96         }
  97
  98         auto relative = boost::filesystem::path ("..") / boost::filesystem::path ("dcpomatic-test-private");
  99         if (!boost::filesystem::exists(relative)) {
 100                 std::cerr << "No private test data found! Tests may fail.\n";
 101                 return relative;
 102         }
 103
 104         return boost::filesystem::canonical(relative);
 105 }
 106
 107
 108 boost::filesystem::path TestPaths::xsd ()
 109 {
 110         return boost::filesystem::canonical(boost::filesystem::path("..") / boost::filesystem::path("libdcp") / boost::filesystem::path("xsd"));
 111 }
 112
 113
 114 static void
 115 setup_test_config ()
 116 {
 117         Config::instance()->set_master_encoding_threads (boost::thread::hardware_concurrency() / 2);
 118         Config::instance()->set_server_encoding_threads (1);
 119         Config::instance()->set_server_port_base (61921);
 120         Config::instance()->set_default_dcp_content_type (static_cast<DCPContentType*> (0));
 121         Config::instance()->set_default_audio_delay (0);
 122         Config::instance()->set_default_j2k_bandwidth (100000000);
 123         Config::instance()->set_default_interop (false);
 124         Config::instance()->set_default_still_length (10);
 125         Config::instance()->set_log_types (
 126                 LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING |
 127                 LogEntry::TYPE_ERROR | LogEntry::TYPE_DISK
 128                 );
 129         Config::instance()->set_automatic_audio_analysis (false);
 130         auto signer = make_shared<dcp::CertificateChain>(dcp::file_to_string("test/data/signer_chain"));
 131         signer->set_key(dcp::file_to_string("test/data/signer_key"));
 132         Config::instance()->set_signer_chain (signer);
 133         auto decryption = make_shared<dcp::CertificateChain>(dcp::file_to_string("test/data/decryption_chain"));
 134         decryption->set_key(dcp::file_to_string("test/data/decryption_key"));
 135         Config::instance()->set_decryption_chain (decryption);
 136         Config::instance()->set_dcp_asset_filename_format(dcp::NameFormat("%t"));
 137 }
 138
 139
 140 class TestSignalManager : public SignalManager
 141 {
 142 public:
 143         /* No wakes in tests: we call ui_idle ourselves */
 144         void wake_ui () override
 145         {
 146
 147         }
 148 };
 149
 150 struct TestConfig
 151 {
 152         TestConfig ()
 153         {
 154                 State::override_path = "build/test/state";
 155                 boost::filesystem::remove_all (*State::override_path);
 156
 157                 dcpomatic_setup ();
 158                 setup_test_config ();
 159
 160                 EncodeServerFinder::instance()->stop ();
 161
 162                 signal_manager = new TestSignalManager ();
 163
 164                 dcpomatic_log.reset (new FileLog("build/test/log"));
 165         }
 166
 167         ~TestConfig ()
 168         {
 169                 JobManager::drop ();
 170         }
 171 };
 172
 173
 174 BOOST_GLOBAL_FIXTURE (TestConfig);
 175
 176
 177 boost::filesystem::path
 178 test_film_dir (string name)
 179 {
 180         boost::filesystem::path p;
 181         p /= "build";
 182         p /= "test";
 183         p /= name;
 184         return p;
 185 }
 186
 187
 188 shared_ptr<Film>
 189 new_test_film (string name)
 190 {
 191         auto p = test_film_dir (name);
 192         if (boost::filesystem::exists (p)) {
 193                 boost::filesystem::remove_all (p);
 194         }
 195
 196         auto film = make_shared<Film>(p);
 197         film->write_metadata ();
 198         return film;
 199 }
 200
 201
 202 shared_ptr<Film>
 203 new_test_film2 (string name, vector<shared_ptr<Content>> content, Cleanup* cleanup)
 204 {
 205         auto p = test_film_dir (name);
 206         if (boost::filesystem::exists (p)) {
 207                 boost::filesystem::remove_all (p);
 208         }
 209         if (cleanup) {
 210                 cleanup->add (p);
 211         }
 212
 213         auto film = make_shared<Film>(p);
 214         film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TST"));
 215         film->set_container (Ratio::from_id ("185"));
 216         film->write_metadata ();
 217
 218         for (auto i: content) {
 219                 film->examine_and_add_content (i);
 220                 BOOST_REQUIRE (!wait_for_jobs());
 221         }
 222
 223         return film;
 224 }
 225
 226
 227 void
 228 check_wav_file (boost::filesystem::path ref, boost::filesystem::path check)
 229 {
 230         SF_INFO ref_info;
 231         ref_info.format = 0;
 232         auto ref_file = sf_open (ref.string().c_str(), SFM_READ, &ref_info);
 233         BOOST_CHECK (ref_file);
 234
 235         SF_INFO check_info;
 236         check_info.format = 0;
 237         auto check_file = sf_open (check.string().c_str(), SFM_READ, &check_info);
 238         BOOST_CHECK (check_file);
 239
 240         BOOST_CHECK_EQUAL (ref_info.frames, check_info.frames);
 241         BOOST_CHECK_EQUAL (ref_info.samplerate, check_info.samplerate);
 242         BOOST_CHECK_EQUAL (ref_info.channels, check_info.channels);
 243         BOOST_CHECK_EQUAL (ref_info.format, check_info.format);
 244
 245         /* buffer_size is in frames */
 246         sf_count_t const buffer_size = 65536 * ref_info.channels;
 247         scoped_array<int32_t> ref_buffer (new int32_t[buffer_size]);
 248         scoped_array<int32_t> check_buffer (new int32_t[buffer_size]);
 249
 250         sf_count_t N = ref_info.frames;
 251         while (N) {
 252                 sf_count_t this_time = min (buffer_size, N);
 253                 sf_count_t r = sf_readf_int (ref_file, ref_buffer.get(), this_time);
 254                 BOOST_CHECK_EQUAL (r, this_time);
 255                 r = sf_readf_int (check_file, check_buffer.get(), this_time);
 256                 BOOST_CHECK_EQUAL (r, this_time);
 257
 258                 for (sf_count_t i = 0; i < this_time; ++i) {
 259                         BOOST_REQUIRE_MESSAGE (
 260                                 abs (ref_buffer[i] - check_buffer[i]) <= 65536,
 261                                 ref << " differs from " << check << " at " << (ref_info.frames - N + i) << " of " << ref_info.frames
 262                                 << "(" << ref_buffer[i] << " vs " << check_buffer[i] << ")"
 263                                 );
 264                 }
 265
 266                 N -= this_time;
 267         }
 268 }
 269
 270
 271 void
 272 check_mxf_audio_file (boost::filesystem::path ref, boost::filesystem::path check)
 273 {
 274         ASDCP::PCM::MXFReader ref_reader;
 275         BOOST_REQUIRE (!ASDCP_FAILURE (ref_reader.OpenRead (ref.string().c_str())));
 276
 277         ASDCP::PCM::AudioDescriptor ref_desc;
 278         BOOST_REQUIRE (!ASDCP_FAILURE (ref_reader.FillAudioDescriptor (ref_desc)));
 279
 280         ASDCP::PCM::MXFReader check_reader;
 281         BOOST_REQUIRE (!ASDCP_FAILURE (check_reader.OpenRead (check.string().c_str())));
 282
 283         ASDCP::PCM::AudioDescriptor check_desc;
 284         BOOST_REQUIRE (!ASDCP_FAILURE (check_reader.FillAudioDescriptor (check_desc)));
 285
 286         BOOST_REQUIRE_EQUAL (ref_desc.ContainerDuration, check_desc.ContainerDuration);
 287
 288         ASDCP::PCM::FrameBuffer ref_buffer (Kumu::Megabyte);
 289         ASDCP::PCM::FrameBuffer check_buffer (Kumu::Megabyte);
 290         for (size_t i = 0; i < ref_desc.ContainerDuration; ++i) {
 291                 ref_reader.ReadFrame (i, ref_buffer, 0);
 292                 check_reader.ReadFrame (i, check_buffer, 0);
 293                 BOOST_REQUIRE_MESSAGE(memcmp(ref_buffer.RoData(), check_buffer.RoData(), ref_buffer.Size()) == 0, "Audio MXF differs in frame " << i);
 294         }
 295 }
 296
 297
 298 /** @return true if the files are the same, otherwise false */
 299 bool
 300 mxf_atmos_files_same (boost::filesystem::path ref, boost::filesystem::path check, bool verbose)
 301 {
 302         ASDCP::ATMOS::MXFReader ref_reader;
 303         BOOST_REQUIRE (!ASDCP_FAILURE(ref_reader.OpenRead(ref.string().c_str())));
 304
 305         ASDCP::ATMOS::AtmosDescriptor ref_desc;
 306         BOOST_REQUIRE (!ASDCP_FAILURE(ref_reader.FillAtmosDescriptor(ref_desc)));
 307
 308         ASDCP::ATMOS::MXFReader check_reader;
 309         BOOST_REQUIRE (!ASDCP_FAILURE(check_reader.OpenRead(check.string().c_str())));
 310
 311         ASDCP::ATMOS::AtmosDescriptor check_desc;
 312         BOOST_REQUIRE (!ASDCP_FAILURE(check_reader.FillAtmosDescriptor(check_desc)));
 313
 314         if (ref_desc.EditRate.Numerator != check_desc.EditRate.Numerator) {
 315                 if (verbose) {
 316                         std::cout << "EditRate.Numerator differs.\n";
 317                 }
 318                 return false;
 319         }
 320         if (ref_desc.EditRate.Denominator != check_desc.EditRate.Denominator) {
 321                 if (verbose) {
 322                         std::cout << "EditRate.Denominator differs.\n";
 323                 }
 324                 return false;
 325         }
 326         if (ref_desc.ContainerDuration != check_desc.ContainerDuration) {
 327                 if (verbose) {
 328                         std::cout << "EditRate.ContainerDuration differs.\n";
 329                 }
 330                 return false;
 331         }
 332         if (ref_desc.FirstFrame != check_desc.FirstFrame) {
 333                 if (verbose) {
 334                         std::cout << "EditRate.FirstFrame differs.\n";
 335                 }
 336                 return false;
 337         }
 338         if (ref_desc.MaxChannelCount != check_desc.MaxChannelCount) {
 339                 if (verbose) {
 340                         std::cout << "EditRate.MaxChannelCount differs.\n";
 341                 }
 342                 return false;
 343         }
 344         if (ref_desc.MaxObjectCount != check_desc.MaxObjectCount) {
 345                 if (verbose) {
 346                         std::cout << "EditRate.MaxObjectCount differs.\n";
 347                 }
 348                 return false;
 349         }
 350         if (ref_desc.AtmosVersion != check_desc.AtmosVersion) {
 351                 if (verbose) {
 352                         std::cout << "EditRate.AtmosVersion differs.\n";
 353                 }
 354                 return false;
 355         }
 356
 357         ASDCP::DCData::FrameBuffer ref_buffer (Kumu::Megabyte);
 358         ASDCP::DCData::FrameBuffer check_buffer (Kumu::Megabyte);
 359         for (size_t i = 0; i < ref_desc.ContainerDuration; ++i) {
 360                 ref_reader.ReadFrame (i, ref_buffer, 0);
 361                 check_reader.ReadFrame (i, check_buffer, 0);
 362                 if (memcmp(ref_buffer.RoData(), check_buffer.RoData(), ref_buffer.Size())) {
 363                         if (verbose) {
 364                                 std::cout << "data differs.\n";
 365                         }
 366                         return false;
 367                 }
 368         }
 369
 370         return true;
 371 }
 372
 373
 374 static
 375 double
 376 rms_error (boost::filesystem::path ref, boost::filesystem::path check)
 377 {
 378         FFmpegImageProxy ref_proxy (ref);
 379         auto ref_image = ref_proxy.image(Image::Alignment::COMPACT).image;
 380         FFmpegImageProxy check_proxy (check);
 381         auto check_image = check_proxy.image(Image::Alignment::COMPACT).image;
 382
 383         BOOST_REQUIRE_EQUAL (ref_image->planes(), check_image->planes());
 384
 385         BOOST_REQUIRE_EQUAL (ref_image->pixel_format(), check_image->pixel_format());
 386         auto const format = ref_image->pixel_format();
 387
 388         BOOST_REQUIRE (ref_image->size() == check_image->size());
 389         int const width = ref_image->size().width;
 390         int const height = ref_image->size().height;
 391
 392         double sum_square = 0;
 393         switch (format) {
 394                 case AV_PIX_FMT_RGBA:
 395                 {
 396                         for (int y = 0; y < height; ++y) {
 397                                 uint8_t* p = ref_image->data()[0] + y * ref_image->stride()[0];
 398                                 uint8_t* q = check_image->data()[0] + y * check_image->stride()[0];
 399                                 for (int x = 0; x < width; ++x) {
 400                                         for (int c = 0; c < 4; ++c) {
 401                                                 sum_square += pow((*p++ - *q++), 2);
 402                                         }
 403                                 }
 404                         }
 405                         break;
 406                 }
 407                 case AV_PIX_FMT_RGB24:
 408                 {
 409                         for (int y = 0; y < height; ++y) {
 410                                 uint8_t* p = ref_image->data()[0] + y * ref_image->stride()[0];
 411                                 uint8_t* q = check_image->data()[0] + y * check_image->stride()[0];
 412                                 for (int x = 0; x < width; ++x) {
 413                                         for (int c = 0; c < 3; ++c) {
 414                                                 sum_square += pow((*p++ - *q++), 2);
 415                                         }
 416                                 }
 417                         }
 418                         break;
 419                 }
 420                 case AV_PIX_FMT_RGB48BE:
 421                 {
 422                         for (int y = 0; y < height; ++y) {
 423                                 uint16_t* p = reinterpret_cast<uint16_t*>(ref_image->data()[0] + y * ref_image->stride()[0]);
 424                                 uint16_t* q = reinterpret_cast<uint16_t*>(check_image->data()[0] + y * check_image->stride()[0]);
 425                                 for (int x = 0; x < width; ++x) {
 426                                         for (int c = 0; c < 3; ++c) {
 427                                                 sum_square += pow((*p++ - *q++), 2);
 428                                         }
 429                                 }
 430                         }
 431                         break;
 432                 }
 433                 case AV_PIX_FMT_YUVJ420P:
 434                 {
 435                         for (int c = 0; c < ref_image->planes(); ++c) {
 436                                 for (int y = 0; y < height / ref_image->vertical_factor(c); ++y) {
 437                                         auto p = ref_image->data()[c] + y * ref_image->stride()[c];
 438                                         auto q = check_image->data()[c] + y * check_image->stride()[c];
 439                                         for (int x = 0; x < ref_image->line_size()[c]; ++x) {
 440                                                 sum_square += pow((*p++ - *q++), 2);
 441                                         }
 442                                 }
 443                         }
 444                         break;
 445                 }
 446                 default:
 447                         BOOST_REQUIRE_MESSAGE (false, "unrecognised pixel format " << format);
 448         }
 449
 450         return sqrt(sum_square / (height * width));
 451 }
 452
 453
 454 BOOST_AUTO_TEST_CASE (rms_error_test)
 455 {
 456         BOOST_CHECK_CLOSE (rms_error("test/data/check_image0.png", "test/data/check_image0.png"), 0, 0.001);
 457         BOOST_CHECK_CLOSE (rms_error("test/data/check_image0.png", "test/data/check_image1.png"), 2.2778, 0.001);
 458         BOOST_CHECK_CLOSE (rms_error("test/data/check_image0.png", "test/data/check_image2.png"), 59.8896, 0.001);
 459         BOOST_CHECK_CLOSE (rms_error("test/data/check_image0.png", "test/data/check_image3.png"), 0.89164, 0.001);
 460 }
 461
 462
 463 void
 464 check_image (boost::filesystem::path ref, boost::filesystem::path check, double threshold)
 465 {
 466         double const e = rms_error (ref, check);
 467         BOOST_CHECK_MESSAGE (e < threshold, ref << " differs from " << check << " " << e);
 468 }
 469
 470
 471 void
 472 check_file (boost::filesystem::path ref, boost::filesystem::path check)
 473 {
 474         auto N = boost::filesystem::file_size (ref);
 475         BOOST_CHECK_EQUAL (N, boost::filesystem::file_size (check));
 476         dcp::File ref_file(ref, "rb");
 477         BOOST_CHECK (ref_file);
 478         dcp::File check_file(check, "rb");
 479         BOOST_CHECK (check_file);
 480
 481         int const buffer_size = 65536;
 482         std::vector<uint8_t> ref_buffer(buffer_size);
 483         std::vector<uint8_t> check_buffer(buffer_size);
 484
 485         string error = "File " + check.string() + " differs from reference " + ref.string();
 486
 487         while (N) {
 488                 uintmax_t this_time = min (uintmax_t (buffer_size), N);
 489                 size_t r = ref_file.read (ref_buffer.data(), 1, this_time);
 490                 BOOST_CHECK_EQUAL (r, this_time);
 491                 r = check_file.read(check_buffer.data(), 1, this_time);
 492                 BOOST_CHECK_EQUAL (r, this_time);
 493
 494                 BOOST_CHECK_MESSAGE (memcmp (ref_buffer.data(), check_buffer.data(), this_time) == 0, error);
 495                 if (memcmp (ref_buffer.data(), check_buffer.data(), this_time)) {
 496                         break;
 497                 }
 498
 499                 N -= this_time;
 500         }
 501 }
 502
 503
 504 void
 505 check_text_file (boost::filesystem::path ref, boost::filesystem::path check)
 506 {
 507         dcp::File ref_file(ref, "r");
 508         BOOST_CHECK (ref_file);
 509         dcp::File check_file(check, "r");
 510         BOOST_CHECK (check_file);
 511
 512         int const buffer_size = std::max(
 513                 boost::filesystem::file_size(ref),
 514                 boost::filesystem::file_size(check)
 515                 );
 516
 517         DCPOMATIC_ASSERT (buffer_size < 1024 * 1024);
 518
 519         std::vector<uint8_t> ref_buffer(buffer_size);
 520         auto ref_read = ref_file.read(ref_buffer.data(), 1, buffer_size);
 521         std::vector<uint8_t> check_buffer(buffer_size);
 522         auto check_read = check_file.read(check_buffer.data(), 1, buffer_size);
 523         BOOST_CHECK_EQUAL (ref_read, check_read);
 524
 525         string const error = "File " + check.string() + " differs from reference " + ref.string();
 526         BOOST_CHECK_MESSAGE(memcmp(ref_buffer.data(), check_buffer.data(), ref_read) == 0, error);
 527 }
 528
 529
 530 static void
 531 note (dcp::NoteType t, string n)
 532 {
 533         if (t == dcp::NoteType::ERROR) {
 534                 cerr << n << "\n";
 535         }
 536 }
 537
 538
 539 void
 540 check_dcp (boost::filesystem::path ref, shared_ptr<const Film> film)
 541 {
 542         check_dcp (ref, film->dir(film->dcp_name()));
 543 }
 544
 545
 546 void
 547 check_dcp(boost::filesystem::path ref, boost::filesystem::path check, bool sound_can_differ)
 548 {
 549         dcp::DCP ref_dcp (ref);
 550         ref_dcp.read ();
 551         dcp::DCP check_dcp (check);
 552         check_dcp.read ();
 553
 554         dcp::EqualityOptions options;
 555         options.max_mean_pixel_error = 5;
 556         options.max_std_dev_pixel_error = 5;
 557         options.max_audio_sample_error = 255;
 558         options.cpl_annotation_texts_can_differ = true;
 559         options.reel_annotation_texts_can_differ = true;
 560         options.reel_hashes_can_differ = true;
 561         options.asset_hashes_can_differ = true;
 562         options.issue_dates_can_differ = true;
 563         options.max_subtitle_vertical_position_error = 0.001;
 564         options.sound_assets_can_differ = sound_can_differ;
 565
 566         BOOST_CHECK (ref_dcp.equals (check_dcp, options, boost::bind (note, _1, _2)));
 567 }
 568
 569 void
 570 check_xml (xmlpp::Element* ref, xmlpp::Element* test, list<string> ignore)
 571 {
 572         BOOST_CHECK_EQUAL (ref->get_name (), test->get_name ());
 573         BOOST_CHECK_EQUAL (ref->get_namespace_prefix (), test->get_namespace_prefix ());
 574
 575         if (find (ignore.begin(), ignore.end(), ref->get_name()) != ignore.end ()) {
 576                 return;
 577         }
 578
 579         auto ref_children = ref->get_children ();
 580         auto test_children = test->get_children ();
 581         BOOST_REQUIRE_MESSAGE (
 582                 ref_children.size() == test_children.size(),
 583                 ref->get_name() << " has " << ref_children.size() << " or " << test_children.size() << " children"
 584                 );
 585
 586         auto k = ref_children.begin ();
 587         auto l = test_children.begin ();
 588         while (k != ref_children.end ()) {
 589
 590                 /* XXX: should be doing xmlpp::EntityReference, xmlpp::XIncludeEnd, xmlpp::XIncludeStart */
 591
 592                 auto ref_el = dynamic_cast<xmlpp::Element*>(*k);
 593                 auto test_el = dynamic_cast<xmlpp::Element*>(*l);
 594                 BOOST_CHECK ((ref_el && test_el) || (!ref_el && !test_el));
 595                 if (ref_el && test_el) {
 596                         check_xml (ref_el, test_el, ignore);
 597                 }
 598
 599                 auto ref_cn = dynamic_cast<xmlpp::ContentNode*>(*k);
 600                 auto test_cn = dynamic_cast<xmlpp::ContentNode*>(*l);
 601                 BOOST_CHECK ((ref_cn && test_cn) || (!ref_cn && !test_cn));
 602                 if (ref_cn && test_cn) {
 603                         BOOST_CHECK_EQUAL (ref_cn->get_content(), test_cn->get_content ());
 604                 }
 605
 606                 ++k;
 607                 ++l;
 608         }
 609
 610         auto ref_attributes = ref->get_attributes ();
 611         auto test_attributes = test->get_attributes ();
 612         BOOST_CHECK_EQUAL (ref_attributes.size(), test_attributes.size ());
 613
 614         auto m = ref_attributes.begin();
 615         auto n = test_attributes.begin();
 616         while (m != ref_attributes.end ()) {
 617                 BOOST_CHECK_EQUAL ((*m)->get_name(), (*n)->get_name());
 618                 BOOST_CHECK_EQUAL ((*m)->get_value(), (*n)->get_value());
 619
 620                 ++m;
 621                 ++n;
 622         }
 623 }
 624
 625 void
 626 check_xml (boost::filesystem::path ref, boost::filesystem::path test, list<string> ignore)
 627 {
 628         auto ref_parser = new xmlpp::DomParser(ref.string());
 629         auto ref_root = ref_parser->get_document()->get_root_node();
 630         auto test_parser = new xmlpp::DomParser(test.string());
 631         auto test_root = test_parser->get_document()->get_root_node();
 632
 633         check_xml (ref_root, test_root, ignore);
 634 }
 635
 636 bool
 637 wait_for_jobs ()
 638 {
 639         auto jm = JobManager::instance ();
 640         while (jm->work_to_do()) {
 641                 while (signal_manager->ui_idle()) {}
 642                 dcpomatic_sleep_seconds (1);
 643         }
 644
 645         if (jm->errors ()) {
 646                 int N = 0;
 647                 for (auto i: jm->_jobs) {
 648                         if (i->finished_in_error()) {
 649                                 ++N;
 650                         }
 651                 }
 652                 cerr << N << " errors.\n";
 653
 654                 for (auto i: jm->_jobs) {
 655                         if (i->finished_in_error()) {
 656                                 cerr << i->name() << ":\n"
 657                                      << "\tsummary: " << i->error_summary() << "\n"
 658                                      << "\tdetails: " << i->error_details() << "\n";
 659                         }
 660                 }
 661         }
 662
 663         while (signal_manager->ui_idle ()) {}
 664
 665         if (jm->errors ()) {
 666                 JobManager::drop ();
 667                 return true;
 668         }
 669
 670         return false;
 671 }
 672
 673
 674 class Memory
 675 {
 676 public:
 677         Memory () {}
 678
 679         ~Memory ()
 680         {
 681                 free (data);
 682         }
 683
 684         Memory (Memory const&) = delete;
 685         Memory& operator= (Memory const&) = delete;
 686
 687         uint8_t* data = nullptr;
 688         size_t size = 0;
 689 };
 690
 691
 692 static void
 693 png_write_data (png_structp png_ptr, png_bytep data, png_size_t length)
 694 {
 695         auto mem = reinterpret_cast<Memory*>(png_get_io_ptr(png_ptr));
 696         size_t size = mem->size + length;
 697
 698         if (mem->data) {
 699                 mem->data = reinterpret_cast<uint8_t*>(realloc(mem->data, size));
 700         } else {
 701                 mem->data = reinterpret_cast<uint8_t*>(malloc(size));
 702         }
 703
 704         BOOST_REQUIRE (mem->data);
 705
 706         memcpy (mem->data + mem->size, data, length);
 707         mem->size += length;
 708 }
 709
 710
 711 static void
 712 png_flush (png_structp)
 713 {
 714
 715 }
 716
 717
 718 static void
 719 png_error_fn (png_structp, char const * message)
 720 {
 721         throw EncodeError (String::compose("Error during PNG write: %1", message));
 722 }
 723
 724
 725 void
 726 write_image (shared_ptr<const Image> image, boost::filesystem::path file)
 727 {
 728         int png_color_type = PNG_COLOR_TYPE_RGB;
 729         int bits_per_pixel = 0;
 730         switch (image->pixel_format()) {
 731         case AV_PIX_FMT_RGB24:
 732                 bits_per_pixel = 8;
 733                 break;
 734         case AV_PIX_FMT_XYZ12LE:
 735                 bits_per_pixel = 16;
 736                 break;
 737         default:
 738                 BOOST_REQUIRE_MESSAGE (false, "unexpected pixel format " << image->pixel_format());
 739         }
 740
 741         /* error handling? */
 742         png_structp png_ptr = png_create_write_struct(PNG_LIBPNG_VER_STRING, reinterpret_cast<void*>(const_cast<Image*>(image.get())), png_error_fn, 0);
 743         BOOST_REQUIRE (png_ptr);
 744
 745         Memory state;
 746
 747         png_set_write_fn (png_ptr, &state, png_write_data, png_flush);
 748
 749         png_infop info_ptr = png_create_info_struct(png_ptr);
 750         BOOST_REQUIRE (info_ptr);
 751
 752         png_set_IHDR (png_ptr, info_ptr, image->size().width, image->size().height, bits_per_pixel, png_color_type, PNG_INTERLACE_NONE, PNG_COMPRESSION_TYPE_DEFAULT, PNG_FILTER_TYPE_DEFAULT);
 753
 754         auto const width = image->size().width;
 755         auto const height = image->size().height;
 756         auto const stride = image->stride()[0];
 757
 758         vector<vector<uint8_t>> data_to_write(height);
 759         for (int y = 0; y < height; ++y) {
 760                 data_to_write[y].resize(stride);
 761         }
 762
 763         switch (image->pixel_format()) {
 764         case AV_PIX_FMT_RGB24:
 765                 for (int y = 0; y < height; ++y) {
 766                         memcpy(data_to_write[y].data(), image->data()[0] + y * stride, stride);
 767                 }
 768                 break;
 769         case AV_PIX_FMT_XYZ12LE:
 770                 /* 16-bit pixel values must be written MSB first */
 771                 for (int y = 0; y < height; ++y) {
 772                         data_to_write[y].resize(stride);
 773                         uint8_t* original = image->data()[0] + y * stride;
 774                         for (int x = 0; x < width * 3; ++x) {
 775                                 data_to_write[y][x * 2] = original[1];
 776                                 data_to_write[y][x * 2 + 1] = original[0];
 777                                 original += 2;
 778                         }
 779                 }
 780                 break;
 781         default:
 782                 break;
 783         }
 784
 785         png_byte ** row_pointers = reinterpret_cast<png_byte**>(png_malloc(png_ptr, image->size().height * sizeof(png_byte *)));
 786         for (int y = 0; y < height; ++y) {
 787                 row_pointers[y] = reinterpret_cast<png_byte*>(data_to_write[y].data());
 788         }
 789
 790         png_write_info (png_ptr, info_ptr);
 791         png_write_image (png_ptr, row_pointers);
 792         png_write_end (png_ptr, info_ptr);
 793
 794         png_destroy_write_struct (&png_ptr, &info_ptr);
 795         png_free (png_ptr, row_pointers);
 796
 797         dcp::ArrayData(state.data, state.size).write(file);
 798 }
 799
 800
 801 void
 802 check_ffmpeg (boost::filesystem::path ref, boost::filesystem::path check, int audio_tolerance)
 803 {
 804         int const r = system (String::compose("ffcmp -t %1 %2 %3", audio_tolerance, ref.string(), check.string()).c_str());
 805         BOOST_REQUIRE_EQUAL (WEXITSTATUS(r), 0);
 806 }
 807
 808 void
 809 check_one_frame (boost::filesystem::path dcp_dir, int64_t index, boost::filesystem::path ref)
 810 {
 811         dcp::DCP dcp (dcp_dir);
 812         dcp.read ();
 813         auto asset = dynamic_pointer_cast<dcp::MonoPictureAsset> (dcp.cpls().front()->reels().front()->main_picture()->asset());
 814         BOOST_REQUIRE (asset);
 815         auto frame = asset->start_read()->get_frame(index);
 816         auto ref_frame (new dcp::MonoPictureFrame (ref));
 817
 818         auto image = frame->xyz_image ();
 819         auto ref_image = ref_frame->xyz_image ();
 820
 821         BOOST_REQUIRE (image->size() == ref_image->size());
 822
 823         int off = 0;
 824         for (int y = 0; y < ref_image->size().height; ++y) {
 825                 for (int x = 0; x < ref_image->size().width; ++x) {
 826                         BOOST_REQUIRE_EQUAL (ref_image->data(0)[off], image->data(0)[off]);
 827                         BOOST_REQUIRE_EQUAL (ref_image->data(1)[off], image->data(1)[off]);
 828                         BOOST_REQUIRE_EQUAL (ref_image->data(2)[off], image->data(2)[off]);
 829                         ++off;
 830                 }
 831         }
 832 }
 833
 834 boost::filesystem::path
 835 dcp_file (shared_ptr<const Film> film, string prefix)
 836 {
 837         using namespace boost::filesystem;
 838
 839         vector<directory_entry> matches;
 840         std::copy_if(recursive_directory_iterator(film->dir(film->dcp_name())), recursive_directory_iterator(), std::back_inserter(matches), [&prefix](directory_entry const& entry) {
 841                 return boost::algorithm::starts_with(entry.path().leaf().string(), prefix);
 842         });
 843
 844         BOOST_REQUIRE_MESSAGE(matches.size() == 1, "Found " << matches.size() << " files with prefix " << prefix);
 845         return matches[0].path();
 846 }
 847
 848 boost::filesystem::path
 849 subtitle_file (shared_ptr<Film> film)
 850 {
 851         for (auto i: boost::filesystem::recursive_directory_iterator(film->directory().get() / film->dcp_name(false))) {
 852                 if (boost::algorithm::starts_with(i.path().leaf().string(), "sub_")) {
 853                         return i.path();
 854                 }
 855         }
 856
 857         BOOST_REQUIRE (false);
 858         /* Remove warning */
 859         return boost::filesystem::path("/");
 860 }
 861
 862
 863 void
 864 make_random_file (boost::filesystem::path path, size_t size)
 865 {
 866         dcp::File random_file(path, "wb");
 867         BOOST_REQUIRE (random_file);
 868
 869         boost::random::mt19937 rng(1);
 870         boost::random::uniform_int_distribution<uint64_t> dist(0);
 871
 872         while (size > 0) {
 873                 auto this_time = std::min(size, size_t(8));
 874                 uint64_t random = dist(rng);
 875                 random_file.write(&random, this_time, 1);
 876                 size -= this_time;
 877         }
 878 }
 879
 880
 881 LogSwitcher::LogSwitcher (shared_ptr<Log> log)
 882         : _old (dcpomatic_log)
 883 {
 884         dcpomatic_log = log;
 885 }
 886
 887
 888 LogSwitcher::~LogSwitcher ()
 889 {
 890         dcpomatic_log = _old;
 891 }
 892
 893 std::ostream&
 894 dcp::operator<< (std::ostream& s, dcp::Size i)
 895 {
 896         s << i.width << "x" << i.height;
 897         return s;
 898 }
 899
 900 std::ostream&
 901 dcp::operator<< (std::ostream& s, dcp::Standard t)
 902 {
 903         switch (t) {
 904         case Standard::INTEROP:
 905                 s << "interop";
 906                 break;
 907         case Standard::SMPTE:
 908                 s << "smpte";
 909                 break;
 910         }
 911         return s;
 912 }
 913
 914 std::ostream&
 915 operator<< (std::ostream&s, VideoFrameType f)
 916 {
 917         s << video_frame_type_to_string(f);
 918         return s;
 919 }
 920
 921
 922 void
 923 Cleanup::add (boost::filesystem::path path)
 924 {
 925         _paths.push_back (path);
 926 }
 927
 928
 929 void
 930 Cleanup::run ()
 931 {
 932         boost::system::error_code ec;
 933         for (auto i: _paths) {
 934                 boost::filesystem::remove_all (i, ec);
 935         }
 936 }
 937
 938
 939 void stage (string, boost::optional<boost::filesystem::path>) {}
 940 void progress (float) {}
 941
 942
 943 void
 944 verify_dcp(boost::filesystem::path dir, vector<dcp::VerificationNote::Code> ignore)
 945 {
 946         auto notes = dcp::verify({dir}, &stage, &progress, {}, TestPaths::xsd());
 947         bool ok = true;
 948         for (auto i: notes) {
 949                 if (find(ignore.begin(), ignore.end(), i.code()) == ignore.end()) {
 950                         std::cout << "\t" << dcp::note_to_string(i) << "\n";
 951                         ok = false;
 952                 }
 953         }
 954         BOOST_CHECK(ok);
 955 }
 956
 957
 958 void
 959 make_and_verify_dcp (shared_ptr<Film> film, vector<dcp::VerificationNote::Code> ignore)
 960 {
 961         film->write_metadata ();
 962         make_dcp (film, TranscodeJob::ChangedBehaviour::IGNORE);
 963         BOOST_REQUIRE (!wait_for_jobs());
 964         verify_dcp({film->dir(film->dcp_name())}, ignore);
 965 }
 966
 967
 968 void
 969 check_int_close (int a, int b, int d)
 970 {
 971         BOOST_CHECK_MESSAGE (std::abs(a - b) < d, a << " differs from " << b << " by more than " << d);
 972 }
 973
 974
 975 void
 976 check_int_close (std::pair<int, int> a, std::pair<int, int> b, int d)
 977 {
 978         check_int_close (a.first, b.first, d);
 979         check_int_close (a.second, b.second, d);
 980 }
 981
 982
 983 ConfigRestorer::~ConfigRestorer()
 984 {
 985         setup_test_config();
 986 }
 987
 988
 989 boost::filesystem::path
 990 find_file (boost::filesystem::path dir, string filename_part)
 991 {
 992         boost::optional<boost::filesystem::path> found;
 993         for (auto i: boost::filesystem::directory_iterator(dir)) {
 994                 if (i.path().filename().string().find(filename_part) != string::npos) {
 995                         BOOST_REQUIRE_MESSAGE(!found, "File " << filename_part << " found more than once in " << dir);
 996                         found = i;
 997                 }
 998         }
 999         BOOST_REQUIRE_MESSAGE(found, "Could not find " << filename_part << " in " << dir);
1000         return *found;
1001 }
1002
1003
1004 Editor::Editor(boost::filesystem::path path)
1005         : _path(path)
1006         , _content(dcp::file_to_string(path))
1007 {
1008
1009 }
1010
1011 Editor::~Editor()
1012 {
1013         auto f = fopen(_path.string().c_str(), "w");
1014         BOOST_REQUIRE(f);
1015         fwrite(_content.c_str(), _content.length(), 1, f);
1016         fclose(f);
1017 }
1018
1019 void
1020 Editor::replace(string a, string b)
1021 {
1022         auto old_content = _content;
1023         boost::algorithm::replace_all(_content, a, b);
1024         BOOST_REQUIRE(_content != old_content);
1025 }