test/test.cc

   1 /*
   2     Copyright (C) 2012-2019 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 /** @file  test/test.cc
  22  *  @brief Overall test stuff and useful methods for tests.
  23  */
  24
  25 #include "lib/config.h"
  26 #include "lib/util.h"
  27 #include "lib/signal_manager.h"
  28 #include "lib/film.h"
  29 #include "lib/job_manager.h"
  30 #include "lib/job.h"
  31 #include "lib/cross.h"
  32 #include "lib/encode_server_finder.h"
  33 #include "lib/image.h"
  34 #include "lib/ratio.h"
  35 #include "lib/dcp_content_type.h"
  36 #include "lib/log_entry.h"
  37 #include "lib/compose.hpp"
  38 #include "lib/file_log.h"
  39 #include "lib/dcpomatic_log.h"
  40 #include "test.h"
  41 #include <dcp/dcp.h>
  42 #include <dcp/cpl.h>
  43 #include <dcp/reel.h>
  44 #include <dcp/reel_picture_asset.h>
  45 #include <dcp/mono_picture_frame.h>
  46 #include <dcp/mono_picture_asset.h>
  47 #include <dcp/openjpeg_image.h>
  48 #include <asdcp/AS_DCP.h>
  49 #include <sndfile.h>
  50 #include <libxml++/libxml++.h>
  51 #include <Magick++.h>
  52 extern "C" {
  53 #include <libavformat/avformat.h>
  54 }
  55 #define BOOST_TEST_DYN_LINK
  56 #define BOOST_TEST_MODULE dcpomatic_test
  57 #include <boost/test/unit_test.hpp>
  58 #include <boost/algorithm/string.hpp>
  59 #include <list>
  60 #include <vector>
  61 #include <iostream>
  62
  63 using std::string;
  64 using std::vector;
  65 using std::min;
  66 using std::cout;
  67 using std::cerr;
  68 using std::list;
  69 using std::abs;
  70 using boost::shared_ptr;
  71 using boost::scoped_array;
  72 using boost::dynamic_pointer_cast;
  73
  74 boost::filesystem::path TestPaths::TestPaths::private_data = boost::filesystem::canonical(boost::filesystem::path ("..") / boost::filesystem::path ("dcpomatic-test-private"));
  75 boost::filesystem::path TestPaths::xsd = boost::filesystem::canonical(boost::filesystem::path("..") / boost::filesystem::path("libdcp") / boost::filesystem::path("xsd"));
  76
  77 void
  78 setup_test_config ()
  79 {
  80         Config::instance()->set_master_encoding_threads (boost::thread::hardware_concurrency());
  81         Config::instance()->set_server_encoding_threads (1);
  82         Config::instance()->set_server_port_base (61921);
  83         Config::instance()->set_default_isdcf_metadata (ISDCFMetadata ());
  84         Config::instance()->set_default_container (Ratio::from_id ("185"));
  85         Config::instance()->set_default_dcp_content_type (static_cast<DCPContentType*> (0));
  86         Config::instance()->set_default_audio_delay (0);
  87         Config::instance()->set_default_j2k_bandwidth (100000000);
  88         Config::instance()->set_default_interop (false);
  89         Config::instance()->set_default_still_length (10);
  90         Config::instance()->set_log_types (
  91                 LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR | LogEntry::TYPE_DEBUG_THREED | LogEntry::TYPE_DEBUG_ENCODE | LogEntry::TYPE_DEBUG_PLAYER
  92                 );
  93         Config::instance()->set_automatic_audio_analysis (false);
  94 }
  95
  96 class TestSignalManager : public SignalManager
  97 {
  98 public:
  99         /* No wakes in tests: we call ui_idle ourselves */
 100         void wake_ui ()
 101         {
 102
 103         }
 104 };
 105
 106 struct TestConfig
 107 {
 108         TestConfig ()
 109         {
 110                 dcpomatic_setup ();
 111                 setup_test_config ();
 112
 113                 EncodeServerFinder::instance()->stop ();
 114
 115                 signal_manager = new TestSignalManager ();
 116
 117                 char* env_private = getenv("DCPOMATIC_TEST_PRIVATE");
 118                 if (env_private) {
 119                         TestPaths::TestPaths::private_data = env_private;
 120                 }
 121
 122                 dcpomatic_log.reset (new FileLog("build/test/log"));
 123         }
 124
 125         ~TestConfig ()
 126         {
 127                 JobManager::drop ();
 128         }
 129 };
 130
 131 BOOST_GLOBAL_FIXTURE (TestConfig);
 132
 133 boost::filesystem::path
 134 test_film_dir (string name)
 135 {
 136         boost::filesystem::path p;
 137         p /= "build";
 138         p /= "test";
 139         p /= name;
 140         return p;
 141 }
 142
 143 shared_ptr<Film>
 144 new_test_film (string name)
 145 {
 146         boost::filesystem::path p = test_film_dir (name);
 147         if (boost::filesystem::exists (p)) {
 148                 boost::filesystem::remove_all (p);
 149         }
 150
 151         shared_ptr<Film> film = shared_ptr<Film> (new Film (p));
 152         film->write_metadata ();
 153         return film;
 154 }
 155
 156 shared_ptr<Film>
 157 new_test_film2 (string name)
 158 {
 159         boost::filesystem::path p = test_film_dir (name);
 160         if (boost::filesystem::exists (p)) {
 161                 boost::filesystem::remove_all (p);
 162         }
 163
 164         shared_ptr<Film> film = shared_ptr<Film> (new Film (p));
 165         film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TST"));
 166         film->set_container (Ratio::from_id ("185"));
 167         film->write_metadata ();
 168         return film;
 169 }
 170
 171 void
 172 check_wav_file (boost::filesystem::path ref, boost::filesystem::path check)
 173 {
 174         SF_INFO ref_info;
 175         ref_info.format = 0;
 176         SNDFILE* ref_file = sf_open (ref.string().c_str(), SFM_READ, &ref_info);
 177         BOOST_CHECK (ref_file);
 178
 179         SF_INFO check_info;
 180         check_info.format = 0;
 181         SNDFILE* check_file = sf_open (check.string().c_str(), SFM_READ, &check_info);
 182         BOOST_CHECK (check_file);
 183
 184         BOOST_CHECK_EQUAL (ref_info.frames, check_info.frames);
 185         BOOST_CHECK_EQUAL (ref_info.samplerate, check_info.samplerate);
 186         BOOST_CHECK_EQUAL (ref_info.channels, check_info.channels);
 187         BOOST_CHECK_EQUAL (ref_info.format, check_info.format);
 188
 189         /* buffer_size is in frames */
 190         sf_count_t const buffer_size = 65536 * ref_info.channels;
 191         scoped_array<int32_t> ref_buffer (new int32_t[buffer_size]);
 192         scoped_array<int32_t> check_buffer (new int32_t[buffer_size]);
 193
 194         sf_count_t N = ref_info.frames;
 195         while (N) {
 196                 sf_count_t this_time = min (buffer_size, N);
 197                 sf_count_t r = sf_readf_int (ref_file, ref_buffer.get(), this_time);
 198                 BOOST_CHECK_EQUAL (r, this_time);
 199                 r = sf_readf_int (check_file, check_buffer.get(), this_time);
 200                 BOOST_CHECK_EQUAL (r, this_time);
 201
 202                 for (sf_count_t i = 0; i < this_time; ++i) {
 203                         BOOST_REQUIRE_MESSAGE (
 204                                 abs (ref_buffer[i] - check_buffer[i]) <= 65536,
 205                                 ref << " differs from " << check << " at " << (ref_info.frames - N + i) << " of " << ref_info.frames
 206                                 << "(" << ref_buffer[i] << " vs " << check_buffer[i] << ")"
 207                                 );
 208                 }
 209
 210                 N -= this_time;
 211         }
 212 }
 213
 214 void
 215 check_mxf_audio_file (boost::filesystem::path ref, boost::filesystem::path check)
 216 {
 217         ASDCP::PCM::MXFReader ref_reader;
 218         BOOST_REQUIRE (!ASDCP_FAILURE (ref_reader.OpenRead (ref.string().c_str())));
 219
 220         ASDCP::PCM::AudioDescriptor ref_desc;
 221         BOOST_REQUIRE (!ASDCP_FAILURE (ref_reader.FillAudioDescriptor (ref_desc)));
 222
 223         ASDCP::PCM::MXFReader check_reader;
 224         BOOST_REQUIRE (!ASDCP_FAILURE (check_reader.OpenRead (check.string().c_str())));
 225
 226         ASDCP::PCM::AudioDescriptor check_desc;
 227         BOOST_REQUIRE (!ASDCP_FAILURE (check_reader.FillAudioDescriptor (check_desc)));
 228
 229         BOOST_REQUIRE_EQUAL (ref_desc.ContainerDuration, check_desc.ContainerDuration);
 230
 231         ASDCP::PCM::FrameBuffer ref_buffer (Kumu::Megabyte);
 232         ASDCP::PCM::FrameBuffer check_buffer (Kumu::Megabyte);
 233         for (size_t i = 0; i < ref_desc.ContainerDuration; ++i) {
 234                 ref_reader.ReadFrame (i, ref_buffer, 0);
 235                 check_reader.ReadFrame (i, check_buffer, 0);
 236                 BOOST_REQUIRE (memcmp(ref_buffer.RoData(), check_buffer.RoData(), ref_buffer.Size()) == 0);
 237         }
 238 }
 239
 240 void
 241 check_image (boost::filesystem::path ref, boost::filesystem::path check, double threshold)
 242 {
 243         using namespace MagickCore;
 244
 245         Magick::Image ref_image;
 246         ref_image.read (ref.string ());
 247         Magick::Image check_image;
 248         check_image.read (check.string ());
 249         /* XXX: this is a hack; we really want the ImageMagick call but GraphicsMagick doesn't have it;
 250            this may cause random test failures on platforms that use GraphicsMagick.
 251         */
 252         double const dist = ref_image.compare(check_image, Magick::RootMeanSquaredErrorMetric);
 253         BOOST_CHECK_MESSAGE (dist < threshold, ref << " differs from " << check << " " << dist);
 254 }
 255
 256 void
 257 check_file (boost::filesystem::path ref, boost::filesystem::path check)
 258 {
 259         uintmax_t N = boost::filesystem::file_size (ref);
 260         BOOST_CHECK_EQUAL (N, boost::filesystem::file_size (check));
 261         FILE* ref_file = fopen_boost (ref, "rb");
 262         BOOST_CHECK (ref_file);
 263         FILE* check_file = fopen_boost (check, "rb");
 264         BOOST_CHECK (check_file);
 265
 266         int const buffer_size = 65536;
 267         uint8_t* ref_buffer = new uint8_t[buffer_size];
 268         uint8_t* check_buffer = new uint8_t[buffer_size];
 269
 270         string error = "File " + check.string() + " differs from reference " + ref.string();
 271
 272         while (N) {
 273                 uintmax_t this_time = min (uintmax_t (buffer_size), N);
 274                 size_t r = fread (ref_buffer, 1, this_time, ref_file);
 275                 BOOST_CHECK_EQUAL (r, this_time);
 276                 r = fread (check_buffer, 1, this_time, check_file);
 277                 BOOST_CHECK_EQUAL (r, this_time);
 278
 279                 BOOST_CHECK_MESSAGE (memcmp (ref_buffer, check_buffer, this_time) == 0, error);
 280                 if (memcmp (ref_buffer, check_buffer, this_time)) {
 281                         break;
 282                 }
 283
 284                 N -= this_time;
 285         }
 286
 287         delete[] ref_buffer;
 288         delete[] check_buffer;
 289
 290         fclose (ref_file);
 291         fclose (check_file);
 292 }
 293
 294 static void
 295 note (dcp::NoteType t, string n)
 296 {
 297         if (t == dcp::DCP_ERROR) {
 298                 cerr << n << "\n";
 299         }
 300 }
 301
 302
 303 void
 304 check_dcp (boost::filesystem::path ref, shared_ptr<const Film> film)
 305 {
 306         check_dcp (ref, film->dir(film->dcp_name()));
 307 }
 308
 309
 310 void
 311 check_dcp (boost::filesystem::path ref, boost::filesystem::path check)
 312 {
 313         dcp::DCP ref_dcp (ref);
 314         ref_dcp.read ();
 315         dcp::DCP check_dcp (check);
 316         check_dcp.read ();
 317
 318         dcp::EqualityOptions options;
 319         options.max_mean_pixel_error = 5;
 320         options.max_std_dev_pixel_error = 5;
 321         options.max_audio_sample_error = 255;
 322         options.cpl_annotation_texts_can_differ = true;
 323         options.reel_annotation_texts_can_differ = true;
 324         options.reel_hashes_can_differ = true;
 325         options.issue_dates_can_differ = true;
 326
 327         BOOST_CHECK (ref_dcp.equals (check_dcp, options, boost::bind (note, _1, _2)));
 328 }
 329
 330 void
 331 check_xml (xmlpp::Element* ref, xmlpp::Element* test, list<string> ignore)
 332 {
 333         BOOST_CHECK_EQUAL (ref->get_name (), test->get_name ());
 334         BOOST_CHECK_EQUAL (ref->get_namespace_prefix (), test->get_namespace_prefix ());
 335
 336         if (find (ignore.begin(), ignore.end(), ref->get_name()) != ignore.end ()) {
 337                 return;
 338         }
 339
 340         xmlpp::Element::NodeList ref_children = ref->get_children ();
 341         xmlpp::Element::NodeList test_children = test->get_children ();
 342         BOOST_REQUIRE_MESSAGE (
 343                 ref_children.size() == test_children.size(),
 344                 ref->get_name() << " has " << ref_children.size() << " or " << test_children.size() << " children"
 345                 );
 346
 347         xmlpp::Element::NodeList::iterator k = ref_children.begin ();
 348         xmlpp::Element::NodeList::iterator l = test_children.begin ();
 349         while (k != ref_children.end ()) {
 350
 351                 /* XXX: should be doing xmlpp::EntityReference, xmlpp::XIncludeEnd, xmlpp::XIncludeStart */
 352
 353                 xmlpp::Element* ref_el = dynamic_cast<xmlpp::Element*> (*k);
 354                 xmlpp::Element* test_el = dynamic_cast<xmlpp::Element*> (*l);
 355                 BOOST_CHECK ((ref_el && test_el) || (!ref_el && !test_el));
 356                 if (ref_el && test_el) {
 357                         check_xml (ref_el, test_el, ignore);
 358                 }
 359
 360                 xmlpp::ContentNode* ref_cn = dynamic_cast<xmlpp::ContentNode*> (*k);
 361                 xmlpp::ContentNode* test_cn = dynamic_cast<xmlpp::ContentNode*> (*l);
 362                 BOOST_CHECK ((ref_cn && test_cn) || (!ref_cn && !test_cn));
 363                 if (ref_cn && test_cn) {
 364                         BOOST_CHECK_EQUAL (ref_cn->get_content(), test_cn->get_content ());
 365                 }
 366
 367                 ++k;
 368                 ++l;
 369         }
 370
 371         xmlpp::Element::AttributeList ref_attributes = ref->get_attributes ();
 372         xmlpp::Element::AttributeList test_attributes = test->get_attributes ();
 373         BOOST_CHECK_EQUAL (ref_attributes.size(), test_attributes.size ());
 374
 375         xmlpp::Element::AttributeList::const_iterator m = ref_attributes.begin();
 376         xmlpp::Element::AttributeList::const_iterator n = test_attributes.begin();
 377         while (m != ref_attributes.end ()) {
 378                 BOOST_CHECK_EQUAL ((*m)->get_name(), (*n)->get_name());
 379                 BOOST_CHECK_EQUAL ((*m)->get_value(), (*n)->get_value());
 380
 381                 ++m;
 382                 ++n;
 383         }
 384 }
 385
 386 void
 387 check_xml (boost::filesystem::path ref, boost::filesystem::path test, list<string> ignore)
 388 {
 389         xmlpp::DomParser* ref_parser = new xmlpp::DomParser (ref.string ());
 390         xmlpp::Element* ref_root = ref_parser->get_document()->get_root_node ();
 391         xmlpp::DomParser* test_parser = new xmlpp::DomParser (test.string ());
 392         xmlpp::Element* test_root = test_parser->get_document()->get_root_node ();
 393
 394         check_xml (ref_root, test_root, ignore);
 395 }
 396
 397 bool
 398 wait_for_jobs ()
 399 {
 400         JobManager* jm = JobManager::instance ();
 401         while (jm->work_to_do ()) {
 402                 while (signal_manager->ui_idle ()) {}
 403                 dcpomatic_sleep_seconds (1);
 404         }
 405
 406         if (jm->errors ()) {
 407                 int N = 0;
 408                 for (list<shared_ptr<Job> >::iterator i = jm->_jobs.begin(); i != jm->_jobs.end(); ++i) {
 409                         if ((*i)->finished_in_error ()) {
 410                                 ++N;
 411                         }
 412                 }
 413                 cerr << N << " errors.\n";
 414
 415                 for (list<shared_ptr<Job> >::iterator i = jm->_jobs.begin(); i != jm->_jobs.end(); ++i) {
 416                         if ((*i)->finished_in_error ()) {
 417                                 cerr << (*i)->name() << ":\n"
 418                                      << "\tsummary: " << (*i)->error_summary () << "\n"
 419                                      << "\tdetails: " << (*i)->error_details () << "\n";
 420                         }
 421                 }
 422         }
 423
 424         while (signal_manager->ui_idle ()) {}
 425
 426         if (jm->errors ()) {
 427                 JobManager::drop ();
 428                 return true;
 429         }
 430
 431         return false;
 432 }
 433
 434 void
 435 write_image (shared_ptr<const Image> image, boost::filesystem::path file, string format, MagickCore::StorageType pixel_type)
 436 {
 437         using namespace MagickCore;
 438
 439         Magick::Image m (image->size().width, image->size().height, format.c_str(), pixel_type, (void *) image->data()[0]);
 440         m.write (file.string ());
 441 }
 442
 443 void
 444 check_ffmpeg (boost::filesystem::path ref, boost::filesystem::path check, int audio_tolerance)
 445 {
 446         int const r = system (String::compose("ffcmp -t %1 %2 %3", audio_tolerance, ref.string(), check.string()).c_str());
 447         BOOST_REQUIRE_EQUAL (WEXITSTATUS(r), 0);
 448 }
 449
 450 void
 451 check_one_frame (boost::filesystem::path dcp_dir, int64_t index, boost::filesystem::path ref)
 452 {
 453         dcp::DCP dcp (dcp_dir);
 454         dcp.read ();
 455         shared_ptr<dcp::MonoPictureAsset> asset = dynamic_pointer_cast<dcp::MonoPictureAsset> (dcp.cpls().front()->reels().front()->main_picture()->asset());
 456         BOOST_REQUIRE (asset);
 457         shared_ptr<const dcp::MonoPictureFrame> frame = asset->start_read()->get_frame(index);
 458         shared_ptr<const dcp::MonoPictureFrame> ref_frame (new dcp::MonoPictureFrame (ref));
 459
 460         shared_ptr<dcp::OpenJPEGImage> image = frame->xyz_image ();
 461         shared_ptr<dcp::OpenJPEGImage> ref_image = ref_frame->xyz_image ();
 462
 463         BOOST_REQUIRE (image->size() == ref_image->size());
 464
 465         int off = 0;
 466         for (int y = 0; y < ref_image->size().height; ++y) {
 467                 for (int x = 0; x < ref_image->size().width; ++x) {
 468                         BOOST_REQUIRE_EQUAL (ref_image->data(0)[off], image->data(0)[off]);
 469                         BOOST_REQUIRE_EQUAL (ref_image->data(1)[off], image->data(1)[off]);
 470                         BOOST_REQUIRE_EQUAL (ref_image->data(2)[off], image->data(2)[off]);
 471                         ++off;
 472                 }
 473         }
 474 }
 475
 476 boost::filesystem::path
 477 dcp_file (shared_ptr<const Film> film, string prefix)
 478 {
 479         boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (film->dir(film->dcp_name()));
 480         while (i != boost::filesystem::directory_iterator() && !boost::algorithm::starts_with (i->path().leaf().string(), prefix)) {
 481                 ++i;
 482         }
 483
 484         BOOST_REQUIRE (i != boost::filesystem::directory_iterator());
 485         return i->path();
 486 }
 487
 488 boost::filesystem::path
 489 subtitle_file (shared_ptr<Film> film)
 490 {
 491         for (
 492                 boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (film->directory().get() / film->dcp_name (false));
 493                 i != boost::filesystem::directory_iterator ();
 494                 ++i) {
 495
 496                 if (boost::filesystem::is_directory (i->path ())) {
 497                         for (
 498                                 boost::filesystem::directory_iterator j = boost::filesystem::directory_iterator (i->path ());
 499                                 j != boost::filesystem::directory_iterator ();
 500                                 ++j) {
 501
 502                                 if (boost::algorithm::starts_with (j->path().leaf().string(), "sub_")) {
 503                                         return j->path();
 504                                 }
 505                         }
 506                 }
 507         }
 508
 509         BOOST_REQUIRE (false);
 510         /* Remove warning */
 511         return boost::filesystem::path("/");
 512 }
 513
 514 void
 515 make_random_file (boost::filesystem::path path, size_t size)
 516 {
 517         size_t const chunk = 128 * 1024;
 518         uint8_t* buffer = static_cast<uint8_t*> (malloc(chunk));
 519         BOOST_REQUIRE (buffer);
 520         FILE* r = fopen("/dev/urandom", "rb");
 521         BOOST_REQUIRE (r);
 522         FILE* t = fopen_boost(path, "wb");
 523         BOOST_REQUIRE (t);
 524         while (size) {
 525                 size_t this_time = min (size, chunk);
 526                 size_t N = fread (buffer, 1, this_time, r);
 527                 BOOST_REQUIRE (N == this_time);
 528                 N = fwrite (buffer, 1, this_time, t);
 529                 BOOST_REQUIRE (N == this_time);
 530                 size -= this_time;
 531         }
 532         fclose (t);
 533         fclose (r);
 534         free (buffer);
 535 }
 536
 537
 538 LogSwitcher::LogSwitcher (shared_ptr<Log> log)
 539         : _old (dcpomatic_log)
 540 {
 541         dcpomatic_log = log;
 542 }
 543
 544
 545 LogSwitcher::~LogSwitcher ()
 546 {
 547         dcpomatic_log = _old;
 548 }
 549