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