test/test.cc

   1 /*
   2     Copyright (C) 2012-2018 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/j2k_image_proxy.h"
  38 #include "lib/compose.hpp"
  39 #include "test.h"
  40 #include <dcp/dcp.h>
  41 #include <dcp/cpl.h>
  42 #include <dcp/reel.h>
  43 #include <dcp/reel_picture_asset.h>
  44 #include <dcp/mono_picture_frame.h>
  45 #include <dcp/mono_picture_asset.h>
  46 #include <dcp/openjpeg_image.h>
  47 #include <asdcp/AS_DCP.h>
  48 #include <sndfile.h>
  49 #include <libxml++/libxml++.h>
  50 #include <Magick++.h>
  51 extern "C" {
  52 #include <libavformat/avformat.h>
  53 }
  54 #define BOOST_TEST_DYN_LINK
  55 #define BOOST_TEST_MODULE dcpomatic_test
  56 #include <boost/test/unit_test.hpp>
  57 #include <boost/algorithm/string.hpp>
  58 #include <list>
  59 #include <vector>
  60 #include <iostream>
  61
  62 using std::string;
  63 using std::vector;
  64 using std::min;
  65 using std::cout;
  66 using std::cerr;
  67 using std::list;
  68 using std::abs;
  69 using boost::shared_ptr;
  70 using boost::scoped_array;
  71 using boost::dynamic_pointer_cast;
  72 using boost::optional;
  73
  74 boost::filesystem::path private_data = 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
 120         ~TestConfig ()
 121         {
 122                 JobManager::drop ();
 123         }
 124 };
 125
 126 BOOST_GLOBAL_FIXTURE (TestConfig);
 127
 128 boost::filesystem::path
 129 test_film_dir (string name)
 130 {
 131         boost::filesystem::path p;
 132         p /= "build";
 133         p /= "test";
 134         p /= name;
 135         return p;
 136 }
 137
 138 shared_ptr<Film>
 139 new_test_film (string name)
 140 {
 141         boost::filesystem::path p = test_film_dir (name);
 142         if (boost::filesystem::exists (p)) {
 143                 boost::filesystem::remove_all (p);
 144         }
 145
 146         shared_ptr<Film> film = shared_ptr<Film> (new Film (p));
 147         film->write_metadata ();
 148         return film;
 149 }
 150
 151 shared_ptr<Film>
 152 new_test_film2 (string name)
 153 {
 154         boost::filesystem::path p = test_film_dir (name);
 155         if (boost::filesystem::exists (p)) {
 156                 boost::filesystem::remove_all (p);
 157         }
 158
 159         shared_ptr<Film> film = shared_ptr<Film> (new Film (p));
 160         film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TST"));
 161         film->set_container (Ratio::from_id ("185"));
 162         film->write_metadata ();
 163         return film;
 164 }
 165
 166 void
 167 check_wav_file (boost::filesystem::path ref, boost::filesystem::path check)
 168 {
 169         SF_INFO ref_info;
 170         ref_info.format = 0;
 171         SNDFILE* ref_file = sf_open (ref.string().c_str(), SFM_READ, &ref_info);
 172         BOOST_CHECK (ref_file);
 173
 174         SF_INFO check_info;
 175         check_info.format = 0;
 176         SNDFILE* check_file = sf_open (check.string().c_str(), SFM_READ, &check_info);
 177         BOOST_CHECK (check_file);
 178
 179         BOOST_CHECK_EQUAL (ref_info.frames, check_info.frames);
 180         BOOST_CHECK_EQUAL (ref_info.samplerate, check_info.samplerate);
 181         BOOST_CHECK_EQUAL (ref_info.channels, check_info.channels);
 182         BOOST_CHECK_EQUAL (ref_info.format, check_info.format);
 183
 184         /* buffer_size is in frames */
 185         sf_count_t const buffer_size = 65536 * ref_info.channels;
 186         scoped_array<int32_t> ref_buffer (new int32_t[buffer_size]);
 187         scoped_array<int32_t> check_buffer (new int32_t[buffer_size]);
 188
 189         sf_count_t N = ref_info.frames;
 190         while (N) {
 191                 sf_count_t this_time = min (buffer_size, N);
 192                 sf_count_t r = sf_readf_int (ref_file, ref_buffer.get(), this_time);
 193                 BOOST_CHECK_EQUAL (r, this_time);
 194                 r = sf_readf_int (check_file, check_buffer.get(), this_time);
 195                 BOOST_CHECK_EQUAL (r, this_time);
 196
 197                 for (sf_count_t i = 0; i < this_time; ++i) {
 198                         BOOST_REQUIRE_MESSAGE (
 199                                 abs (ref_buffer[i] - check_buffer[i]) <= 65536,
 200                                 ref << " differs from " << check << " at " << (ref_info.frames - N + i) << " of " << ref_info.frames
 201                                 << "(" << ref_buffer[i] << " vs " << check_buffer[i] << ")"
 202                                 );
 203                 }
 204
 205                 N -= this_time;
 206         }
 207 }
 208
 209 void
 210 check_mxf_audio_file (boost::filesystem::path ref, boost::filesystem::path check)
 211 {
 212         ASDCP::PCM::MXFReader ref_reader;
 213         BOOST_REQUIRE (!ASDCP_FAILURE (ref_reader.OpenRead (ref.string().c_str())));
 214
 215         ASDCP::PCM::AudioDescriptor ref_desc;
 216         BOOST_REQUIRE (!ASDCP_FAILURE (ref_reader.FillAudioDescriptor (ref_desc)));
 217
 218         ASDCP::PCM::MXFReader check_reader;
 219         BOOST_REQUIRE (!ASDCP_FAILURE (check_reader.OpenRead (check.string().c_str())));
 220
 221         ASDCP::PCM::AudioDescriptor check_desc;
 222         BOOST_REQUIRE (!ASDCP_FAILURE (check_reader.FillAudioDescriptor (check_desc)));
 223
 224         BOOST_REQUIRE_EQUAL (ref_desc.ContainerDuration, check_desc.ContainerDuration);
 225
 226         ASDCP::PCM::FrameBuffer ref_buffer (Kumu::Megabyte);
 227         ASDCP::PCM::FrameBuffer check_buffer (Kumu::Megabyte);
 228         for (size_t i = 0; i < ref_desc.ContainerDuration; ++i) {
 229                 ref_reader.ReadFrame (i, ref_buffer, 0);
 230                 check_reader.ReadFrame (i, check_buffer, 0);
 231                 BOOST_REQUIRE (memcmp(ref_buffer.RoData(), check_buffer.RoData(), ref_buffer.Size()) == 0);
 232         }
 233 }
 234
 235 void
 236 check_image (boost::filesystem::path ref, boost::filesystem::path check, double dist_tolerance)
 237 {
 238 #ifdef DCPOMATIC_IMAGE_MAGICK
 239         using namespace MagickCore;
 240 #else
 241         using namespace MagickLib;
 242 #endif
 243
 244         Magick::Image ref_image;
 245         ref_image.read (ref.string ());
 246         Magick::Image check_image;
 247         check_image.read (check.string ());
 248         /* XXX: this is a hack; we really want the ImageMagick call but GraphicsMagick doesn't have it;
 249            this may cause random test failures on platforms that use GraphicsMagick.
 250         */
 251 #ifdef DCPOMATIC_ADVANCED_MAGICK_COMPARE
 252         double const dist = ref_image.compare(check_image, Magick::RootMeanSquaredErrorMetric);
 253         BOOST_CHECK_MESSAGE (dist < dist_tolerance, ref << " differs from " << check << " " << dist);
 254 #else
 255         BOOST_CHECK_MESSAGE (!ref_image.compare(check_image), ref << " differs from " << check);
 256 #endif
 257 }
 258
 259 void
 260 check_file (boost::filesystem::path ref, boost::filesystem::path check)
 261 {
 262         uintmax_t N = boost::filesystem::file_size (ref);
 263         BOOST_CHECK_EQUAL (N, boost::filesystem::file_size (check));
 264         FILE* ref_file = fopen_boost (ref, "rb");
 265         BOOST_CHECK (ref_file);
 266         FILE* check_file = fopen_boost (check, "rb");
 267         BOOST_CHECK (check_file);
 268
 269         int const buffer_size = 65536;
 270         uint8_t* ref_buffer = new uint8_t[buffer_size];
 271         uint8_t* check_buffer = new uint8_t[buffer_size];
 272
 273         string error = "File " + check.string() + " differs from reference " + ref.string();
 274
 275         while (N) {
 276                 uintmax_t this_time = min (uintmax_t (buffer_size), N);
 277                 size_t r = fread (ref_buffer, 1, this_time, ref_file);
 278                 BOOST_CHECK_EQUAL (r, this_time);
 279                 r = fread (check_buffer, 1, this_time, check_file);
 280                 BOOST_CHECK_EQUAL (r, this_time);
 281
 282                 BOOST_CHECK_MESSAGE (memcmp (ref_buffer, check_buffer, this_time) == 0, error);
 283                 if (memcmp (ref_buffer, check_buffer, this_time)) {
 284                         break;
 285                 }
 286
 287                 N -= this_time;
 288         }
 289
 290         delete[] ref_buffer;
 291         delete[] check_buffer;
 292
 293         fclose (ref_file);
 294         fclose (check_file);
 295 }
 296
 297 static void
 298 note (dcp::NoteType t, string n)
 299 {
 300         if (t == dcp::DCP_ERROR) {
 301                 cerr << n << "\n";
 302         }
 303 }
 304
 305 void
 306 check_dcp (boost::filesystem::path ref, boost::filesystem::path check)
 307 {
 308         dcp::DCP ref_dcp (ref);
 309         ref_dcp.read ();
 310         dcp::DCP check_dcp (check);
 311         check_dcp.read ();
 312
 313         dcp::EqualityOptions options;
 314         options.max_mean_pixel_error = 5;
 315         options.max_std_dev_pixel_error = 5;
 316         options.max_audio_sample_error = 255;
 317         options.cpl_annotation_texts_can_differ = true;
 318         options.reel_annotation_texts_can_differ = true;
 319         options.reel_hashes_can_differ = true;
 320         options.issue_dates_can_differ = true;
 321
 322         BOOST_CHECK (ref_dcp.equals (check_dcp, options, boost::bind (note, _1, _2)));
 323 }
 324
 325 void
 326 check_xml (xmlpp::Element* ref, xmlpp::Element* test, list<string> ignore)
 327 {
 328         BOOST_CHECK_EQUAL (ref->get_name (), test->get_name ());
 329         BOOST_CHECK_EQUAL (ref->get_namespace_prefix (), test->get_namespace_prefix ());
 330
 331         if (find (ignore.begin(), ignore.end(), ref->get_name()) != ignore.end ()) {
 332                 return;
 333         }
 334
 335         xmlpp::Element::NodeList ref_children = ref->get_children ();
 336         xmlpp::Element::NodeList test_children = test->get_children ();
 337         BOOST_REQUIRE_MESSAGE (
 338                 ref_children.size() == test_children.size(),
 339                 ref->get_name() << " has " << ref_children.size() << " or " << test_children.size() << " children"
 340                 );
 341
 342         xmlpp::Element::NodeList::iterator k = ref_children.begin ();
 343         xmlpp::Element::NodeList::iterator l = test_children.begin ();
 344         while (k != ref_children.end ()) {
 345
 346                 /* XXX: should be doing xmlpp::EntityReference, xmlpp::XIncludeEnd, xmlpp::XIncludeStart */
 347
 348                 xmlpp::Element* ref_el = dynamic_cast<xmlpp::Element*> (*k);
 349                 xmlpp::Element* test_el = dynamic_cast<xmlpp::Element*> (*l);
 350                 BOOST_CHECK ((ref_el && test_el) || (!ref_el && !test_el));
 351                 if (ref_el && test_el) {
 352                         check_xml (ref_el, test_el, ignore);
 353                 }
 354
 355                 xmlpp::ContentNode* ref_cn = dynamic_cast<xmlpp::ContentNode*> (*k);
 356                 xmlpp::ContentNode* test_cn = dynamic_cast<xmlpp::ContentNode*> (*l);
 357                 BOOST_CHECK ((ref_cn && test_cn) || (!ref_cn && !test_cn));
 358                 if (ref_cn && test_cn) {
 359                         BOOST_CHECK_EQUAL (ref_cn->get_content(), test_cn->get_content ());
 360                 }
 361
 362                 ++k;
 363                 ++l;
 364         }
 365
 366         xmlpp::Element::AttributeList ref_attributes = ref->get_attributes ();
 367         xmlpp::Element::AttributeList test_attributes = test->get_attributes ();
 368         BOOST_CHECK_EQUAL (ref_attributes.size(), test_attributes.size ());
 369
 370         xmlpp::Element::AttributeList::const_iterator m = ref_attributes.begin();
 371         xmlpp::Element::AttributeList::const_iterator n = test_attributes.begin();
 372         while (m != ref_attributes.end ()) {
 373                 BOOST_CHECK_EQUAL ((*m)->get_name(), (*n)->get_name());
 374                 BOOST_CHECK_EQUAL ((*m)->get_value(), (*n)->get_value());
 375
 376                 ++m;
 377                 ++n;
 378         }
 379 }
 380
 381 void
 382 check_xml (boost::filesystem::path ref, boost::filesystem::path test, list<string> ignore)
 383 {
 384         xmlpp::DomParser* ref_parser = new xmlpp::DomParser (ref.string ());
 385         xmlpp::Element* ref_root = ref_parser->get_document()->get_root_node ();
 386         xmlpp::DomParser* test_parser = new xmlpp::DomParser (test.string ());
 387         xmlpp::Element* test_root = test_parser->get_document()->get_root_node ();
 388
 389         check_xml (ref_root, test_root, ignore);
 390 }
 391
 392 bool
 393 wait_for_jobs ()
 394 {
 395         JobManager* jm = JobManager::instance ();
 396         while (jm->work_to_do ()) {
 397                 while (signal_manager->ui_idle ()) {}
 398                 dcpomatic_sleep (1);
 399         }
 400
 401         if (jm->errors ()) {
 402                 int N = 0;
 403                 for (list<shared_ptr<Job> >::iterator i = jm->_jobs.begin(); i != jm->_jobs.end(); ++i) {
 404                         if ((*i)->finished_in_error ()) {
 405                                 ++N;
 406                         }
 407                 }
 408                 cerr << N << " errors.\n";
 409
 410                 for (list<shared_ptr<Job> >::iterator i = jm->_jobs.begin(); i != jm->_jobs.end(); ++i) {
 411                         if ((*i)->finished_in_error ()) {
 412                                 cerr << (*i)->name() << ":\n"
 413                                      << "\tsummary: " << (*i)->error_summary () << "\n"
 414                                      << "\tdetails: " << (*i)->error_details () << "\n";
 415                         }
 416                 }
 417         }
 418
 419         while (signal_manager->ui_idle ()) {}
 420
 421         if (jm->errors ()) {
 422                 JobManager::drop ();
 423                 return true;
 424         }
 425
 426         return false;
 427 }
 428
 429 void
 430 write_image (shared_ptr<const Image> image, boost::filesystem::path file, string format)
 431 {
 432 #ifdef DCPOMATIC_IMAGE_MAGICK
 433                 using namespace MagickCore;
 434 #else
 435                 using namespace MagickLib;
 436 #endif
 437
 438         Magick::Image m (image->size().width, image->size().height, format.c_str(), CharPixel, (void *) image->data()[0]);
 439         m.write (file.string ());
 440 }
 441
 442 void
 443 check_ffmpeg (boost::filesystem::path ref, boost::filesystem::path check, int audio_tolerance)
 444 {
 445         int const r = system (String::compose("ffcmp -t %1 %2 %3", audio_tolerance, ref.string(), check.string()).c_str());
 446         BOOST_REQUIRE_EQUAL (WEXITSTATUS(r), 0);
 447 }
 448
 449 void
 450 check_one_frame (boost::filesystem::path dcp_dir, int64_t index, dcp::Size dcp_size, boost::filesystem::path ref, dcp::Size ref_size, double dist_tolerance)
 451 {
 452         dcp::DCP dcp (dcp_dir);
 453         dcp.read ();
 454         shared_ptr<dcp::MonoPictureAsset> asset = dynamic_pointer_cast<dcp::MonoPictureAsset> (dcp.cpls().front()->reels().front()->main_picture()->asset());
 455         BOOST_REQUIRE (asset);
 456         shared_ptr<const dcp::MonoPictureFrame> frame = asset->start_read()->get_frame(index);
 457
 458         J2KImageProxy dcp_proxy (frame, dcp_size, AV_PIX_FMT_RGB48, optional<int>());
 459         J2KImageProxy ref_proxy (ref, ref_size, AV_PIX_FMT_RGB48);
 460
 461         shared_ptr<Image> dcp_image = dcp_proxy.image().first->convert_pixel_format (dcp::YUV_TO_RGB_REC709, AV_PIX_FMT_RGB24, true, false);
 462         shared_ptr<Image> ref_image = ref_proxy.image().first->convert_pixel_format (dcp::YUV_TO_RGB_REC709, AV_PIX_FMT_RGB24, true, false);
 463
 464 #ifdef DCPOMATIC_IMAGE_MAGICK
 465                 using namespace MagickCore;
 466 #else
 467                 using namespace MagickLib;
 468 #endif
 469
 470         Magick::Image dcp_magick (dcp_image->size().width, dcp_image->size().height, "RGB", CharPixel, (void *) dcp_image->data()[0]);
 471         Magick::Image ref_magick (ref_image->size().width, ref_image->size().height, "RGB", CharPixel, (void *) ref_image->data()[0]);
 472
 473         /* XXX: this is a hack; we really want the ImageMagick call but GraphicsMagick doesn't have it;
 474            this may cause random test failures on platforms that use GraphicsMagick.
 475         */
 476 #ifdef DCPOMATIC_ADVANCED_MAGICK_COMPARE
 477         double const dist = ref_magick.compare(dcp_magick, Magick::RootMeanSquaredErrorMetric);
 478         BOOST_CHECK_MESSAGE (dist < dist_tolerance, ref << " differs from " << dcp_dir << ":" << index << " " << dist);
 479 #else
 480         BOOST_CHECK_MESSAGE (!ref_magick.compare(dcp_magick), ref << " differs from " << dcp_dir << ":" << index);
 481 #endif
 482 }
 483
 484 boost::filesystem::path
 485 dcp_file (shared_ptr<const Film> film, string prefix)
 486 {
 487         boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (film->dir(film->dcp_name()));
 488         while (i != boost::filesystem::directory_iterator() && !boost::algorithm::starts_with (i->path().leaf().string(), prefix)) {
 489                 ++i;
 490         }
 491
 492         BOOST_REQUIRE (i != boost::filesystem::directory_iterator());
 493         return i->path();
 494 }