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