2 Copyright (C) 2012-2019 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
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.
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.
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/>.
21 /** @file test/test.cc
22 * @brief Overall test stuff and useful methods for tests.
25 #include "lib/config.h"
27 #include "lib/signal_manager.h"
29 #include "lib/job_manager.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"
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>
50 #include <libxml++/libxml++.h>
53 #include <libavformat/avformat.h>
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>
70 using boost::shared_ptr;
71 using boost::scoped_array;
72 using boost::dynamic_pointer_cast;
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"));
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
93 Config::instance()->set_automatic_audio_analysis (false);
96 class TestSignalManager : public SignalManager
99 /* No wakes in tests: we call ui_idle ourselves */
110 State::override_path = "build/test/state";
111 boost::filesystem::remove_all (*State::override_path);
114 setup_test_config ();
116 EncodeServerFinder::instance()->stop ();
118 signal_manager = new TestSignalManager ();
120 char* env_private = getenv("DCPOMATIC_TEST_PRIVATE");
122 TestPaths::TestPaths::private_data = env_private;
125 dcpomatic_log.reset (new FileLog("build/test/log"));
134 BOOST_GLOBAL_FIXTURE (TestConfig);
136 boost::filesystem::path
137 test_film_dir (string name)
139 boost::filesystem::path p;
147 new_test_film (string name)
149 boost::filesystem::path p = test_film_dir (name);
150 if (boost::filesystem::exists (p)) {
151 boost::filesystem::remove_all (p);
154 shared_ptr<Film> film = shared_ptr<Film> (new Film (p));
155 film->write_metadata ();
160 new_test_film2 (string name)
162 boost::filesystem::path p = test_film_dir (name);
163 if (boost::filesystem::exists (p)) {
164 boost::filesystem::remove_all (p);
167 shared_ptr<Film> film = shared_ptr<Film> (new Film (p));
168 film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TST"));
169 film->set_container (Ratio::from_id ("185"));
170 film->write_metadata ();
175 check_wav_file (boost::filesystem::path ref, boost::filesystem::path check)
179 SNDFILE* ref_file = sf_open (ref.string().c_str(), SFM_READ, &ref_info);
180 BOOST_CHECK (ref_file);
183 check_info.format = 0;
184 SNDFILE* check_file = sf_open (check.string().c_str(), SFM_READ, &check_info);
185 BOOST_CHECK (check_file);
187 BOOST_CHECK_EQUAL (ref_info.frames, check_info.frames);
188 BOOST_CHECK_EQUAL (ref_info.samplerate, check_info.samplerate);
189 BOOST_CHECK_EQUAL (ref_info.channels, check_info.channels);
190 BOOST_CHECK_EQUAL (ref_info.format, check_info.format);
192 /* buffer_size is in frames */
193 sf_count_t const buffer_size = 65536 * ref_info.channels;
194 scoped_array<int32_t> ref_buffer (new int32_t[buffer_size]);
195 scoped_array<int32_t> check_buffer (new int32_t[buffer_size]);
197 sf_count_t N = ref_info.frames;
199 sf_count_t this_time = min (buffer_size, N);
200 sf_count_t r = sf_readf_int (ref_file, ref_buffer.get(), this_time);
201 BOOST_CHECK_EQUAL (r, this_time);
202 r = sf_readf_int (check_file, check_buffer.get(), this_time);
203 BOOST_CHECK_EQUAL (r, this_time);
205 for (sf_count_t i = 0; i < this_time; ++i) {
206 BOOST_REQUIRE_MESSAGE (
207 abs (ref_buffer[i] - check_buffer[i]) <= 65536,
208 ref << " differs from " << check << " at " << (ref_info.frames - N + i) << " of " << ref_info.frames
209 << "(" << ref_buffer[i] << " vs " << check_buffer[i] << ")"
218 check_mxf_audio_file (boost::filesystem::path ref, boost::filesystem::path check)
220 ASDCP::PCM::MXFReader ref_reader;
221 BOOST_REQUIRE (!ASDCP_FAILURE (ref_reader.OpenRead (ref.string().c_str())));
223 ASDCP::PCM::AudioDescriptor ref_desc;
224 BOOST_REQUIRE (!ASDCP_FAILURE (ref_reader.FillAudioDescriptor (ref_desc)));
226 ASDCP::PCM::MXFReader check_reader;
227 BOOST_REQUIRE (!ASDCP_FAILURE (check_reader.OpenRead (check.string().c_str())));
229 ASDCP::PCM::AudioDescriptor check_desc;
230 BOOST_REQUIRE (!ASDCP_FAILURE (check_reader.FillAudioDescriptor (check_desc)));
232 BOOST_REQUIRE_EQUAL (ref_desc.ContainerDuration, check_desc.ContainerDuration);
234 ASDCP::PCM::FrameBuffer ref_buffer (Kumu::Megabyte);
235 ASDCP::PCM::FrameBuffer check_buffer (Kumu::Megabyte);
236 for (size_t i = 0; i < ref_desc.ContainerDuration; ++i) {
237 ref_reader.ReadFrame (i, ref_buffer, 0);
238 check_reader.ReadFrame (i, check_buffer, 0);
239 BOOST_REQUIRE (memcmp(ref_buffer.RoData(), check_buffer.RoData(), ref_buffer.Size()) == 0);
244 /** @return true if the files are the same, otherwise false */
246 mxf_atmos_files_same (boost::filesystem::path ref, boost::filesystem::path check, bool verbose)
248 ASDCP::ATMOS::MXFReader ref_reader;
249 BOOST_REQUIRE (!ASDCP_FAILURE(ref_reader.OpenRead(ref.string().c_str())));
251 ASDCP::ATMOS::AtmosDescriptor ref_desc;
252 BOOST_REQUIRE (!ASDCP_FAILURE(ref_reader.FillAtmosDescriptor(ref_desc)));
254 ASDCP::ATMOS::MXFReader check_reader;
255 BOOST_REQUIRE (!ASDCP_FAILURE(check_reader.OpenRead(check.string().c_str())));
257 ASDCP::ATMOS::AtmosDescriptor check_desc;
258 BOOST_REQUIRE (!ASDCP_FAILURE(check_reader.FillAtmosDescriptor(check_desc)));
260 if (ref_desc.EditRate.Numerator != check_desc.EditRate.Numerator) {
262 std::cout << "EditRate.Numerator differs.\n";
266 if (ref_desc.EditRate.Denominator != check_desc.EditRate.Denominator) {
268 std::cout << "EditRate.Denominator differs.\n";
272 if (ref_desc.ContainerDuration != check_desc.ContainerDuration) {
274 std::cout << "EditRate.ContainerDuration differs.\n";
278 if (ref_desc.FirstFrame != check_desc.FirstFrame) {
280 std::cout << "EditRate.FirstFrame differs.\n";
284 if (ref_desc.MaxChannelCount != check_desc.MaxChannelCount) {
286 std::cout << "EditRate.MaxChannelCount differs.\n";
290 if (ref_desc.MaxObjectCount != check_desc.MaxObjectCount) {
292 std::cout << "EditRate.MaxObjectCount differs.\n";
296 if (ref_desc.AtmosVersion != check_desc.AtmosVersion) {
298 std::cout << "EditRate.AtmosVersion differs.\n";
303 ASDCP::DCData::FrameBuffer ref_buffer (Kumu::Megabyte);
304 ASDCP::DCData::FrameBuffer check_buffer (Kumu::Megabyte);
305 for (size_t i = 0; i < ref_desc.ContainerDuration; ++i) {
306 ref_reader.ReadFrame (i, ref_buffer, 0);
307 check_reader.ReadFrame (i, check_buffer, 0);
308 if (memcmp(ref_buffer.RoData(), check_buffer.RoData(), ref_buffer.Size())) {
310 std::cout << "data differs.\n";
321 check_image (boost::filesystem::path ref, boost::filesystem::path check, double threshold)
323 using namespace MagickCore;
325 Magick::Image ref_image;
326 ref_image.read (ref.string ());
327 Magick::Image check_image;
328 check_image.read (check.string ());
329 /* XXX: this is a hack; we really want the ImageMagick call but GraphicsMagick doesn't have it;
330 this may cause random test failures on platforms that use GraphicsMagick.
332 double const dist = ref_image.compare(check_image, Magick::RootMeanSquaredErrorMetric);
333 BOOST_CHECK_MESSAGE (dist < threshold, ref << " differs from " << check << " " << dist);
337 check_file (boost::filesystem::path ref, boost::filesystem::path check)
339 uintmax_t N = boost::filesystem::file_size (ref);
340 BOOST_CHECK_EQUAL (N, boost::filesystem::file_size (check));
341 FILE* ref_file = fopen_boost (ref, "rb");
342 BOOST_CHECK (ref_file);
343 FILE* check_file = fopen_boost (check, "rb");
344 BOOST_CHECK (check_file);
346 int const buffer_size = 65536;
347 uint8_t* ref_buffer = new uint8_t[buffer_size];
348 uint8_t* check_buffer = new uint8_t[buffer_size];
350 string error = "File " + check.string() + " differs from reference " + ref.string();
353 uintmax_t this_time = min (uintmax_t (buffer_size), N);
354 size_t r = fread (ref_buffer, 1, this_time, ref_file);
355 BOOST_CHECK_EQUAL (r, this_time);
356 r = fread (check_buffer, 1, this_time, check_file);
357 BOOST_CHECK_EQUAL (r, this_time);
359 BOOST_CHECK_MESSAGE (memcmp (ref_buffer, check_buffer, this_time) == 0, error);
360 if (memcmp (ref_buffer, check_buffer, this_time)) {
368 delete[] check_buffer;
375 note (dcp::NoteType t, string n)
377 if (t == dcp::DCP_ERROR) {
384 check_dcp (boost::filesystem::path ref, shared_ptr<const Film> film)
386 check_dcp (ref, film->dir(film->dcp_name()));
391 check_dcp (boost::filesystem::path ref, boost::filesystem::path check)
393 dcp::DCP ref_dcp (ref);
395 dcp::DCP check_dcp (check);
398 dcp::EqualityOptions options;
399 options.max_mean_pixel_error = 5;
400 options.max_std_dev_pixel_error = 5;
401 options.max_audio_sample_error = 255;
402 options.cpl_annotation_texts_can_differ = true;
403 options.reel_annotation_texts_can_differ = true;
404 options.reel_hashes_can_differ = true;
405 options.issue_dates_can_differ = true;
407 BOOST_CHECK (ref_dcp.equals (check_dcp, options, boost::bind (note, _1, _2)));
411 check_xml (xmlpp::Element* ref, xmlpp::Element* test, list<string> ignore)
413 BOOST_CHECK_EQUAL (ref->get_name (), test->get_name ());
414 BOOST_CHECK_EQUAL (ref->get_namespace_prefix (), test->get_namespace_prefix ());
416 if (find (ignore.begin(), ignore.end(), ref->get_name()) != ignore.end ()) {
420 xmlpp::Element::NodeList ref_children = ref->get_children ();
421 xmlpp::Element::NodeList test_children = test->get_children ();
422 BOOST_REQUIRE_MESSAGE (
423 ref_children.size() == test_children.size(),
424 ref->get_name() << " has " << ref_children.size() << " or " << test_children.size() << " children"
427 xmlpp::Element::NodeList::iterator k = ref_children.begin ();
428 xmlpp::Element::NodeList::iterator l = test_children.begin ();
429 while (k != ref_children.end ()) {
431 /* XXX: should be doing xmlpp::EntityReference, xmlpp::XIncludeEnd, xmlpp::XIncludeStart */
433 xmlpp::Element* ref_el = dynamic_cast<xmlpp::Element*> (*k);
434 xmlpp::Element* test_el = dynamic_cast<xmlpp::Element*> (*l);
435 BOOST_CHECK ((ref_el && test_el) || (!ref_el && !test_el));
436 if (ref_el && test_el) {
437 check_xml (ref_el, test_el, ignore);
440 xmlpp::ContentNode* ref_cn = dynamic_cast<xmlpp::ContentNode*> (*k);
441 xmlpp::ContentNode* test_cn = dynamic_cast<xmlpp::ContentNode*> (*l);
442 BOOST_CHECK ((ref_cn && test_cn) || (!ref_cn && !test_cn));
443 if (ref_cn && test_cn) {
444 BOOST_CHECK_EQUAL (ref_cn->get_content(), test_cn->get_content ());
451 xmlpp::Element::AttributeList ref_attributes = ref->get_attributes ();
452 xmlpp::Element::AttributeList test_attributes = test->get_attributes ();
453 BOOST_CHECK_EQUAL (ref_attributes.size(), test_attributes.size ());
455 xmlpp::Element::AttributeList::const_iterator m = ref_attributes.begin();
456 xmlpp::Element::AttributeList::const_iterator n = test_attributes.begin();
457 while (m != ref_attributes.end ()) {
458 BOOST_CHECK_EQUAL ((*m)->get_name(), (*n)->get_name());
459 BOOST_CHECK_EQUAL ((*m)->get_value(), (*n)->get_value());
467 check_xml (boost::filesystem::path ref, boost::filesystem::path test, list<string> ignore)
469 xmlpp::DomParser* ref_parser = new xmlpp::DomParser (ref.string ());
470 xmlpp::Element* ref_root = ref_parser->get_document()->get_root_node ();
471 xmlpp::DomParser* test_parser = new xmlpp::DomParser (test.string ());
472 xmlpp::Element* test_root = test_parser->get_document()->get_root_node ();
474 check_xml (ref_root, test_root, ignore);
480 JobManager* jm = JobManager::instance ();
481 while (jm->work_to_do ()) {
482 while (signal_manager->ui_idle ()) {}
483 dcpomatic_sleep_seconds (1);
488 for (list<shared_ptr<Job> >::iterator i = jm->_jobs.begin(); i != jm->_jobs.end(); ++i) {
489 if ((*i)->finished_in_error ()) {
493 cerr << N << " errors.\n";
495 for (list<shared_ptr<Job> >::iterator i = jm->_jobs.begin(); i != jm->_jobs.end(); ++i) {
496 if ((*i)->finished_in_error ()) {
497 cerr << (*i)->name() << ":\n"
498 << "\tsummary: " << (*i)->error_summary () << "\n"
499 << "\tdetails: " << (*i)->error_details () << "\n";
504 while (signal_manager->ui_idle ()) {}
515 write_image (shared_ptr<const Image> image, boost::filesystem::path file, string format, MagickCore::StorageType pixel_type)
517 using namespace MagickCore;
519 Magick::Image m (image->size().width, image->size().height, format.c_str(), pixel_type, (void *) image->data()[0]);
520 m.write (file.string ());
524 check_ffmpeg (boost::filesystem::path ref, boost::filesystem::path check, int audio_tolerance)
526 int const r = system (String::compose("ffcmp -t %1 %2 %3", audio_tolerance, ref.string(), check.string()).c_str());
527 BOOST_REQUIRE_EQUAL (WEXITSTATUS(r), 0);
531 check_one_frame (boost::filesystem::path dcp_dir, int64_t index, boost::filesystem::path ref)
533 dcp::DCP dcp (dcp_dir);
535 shared_ptr<dcp::MonoPictureAsset> asset = dynamic_pointer_cast<dcp::MonoPictureAsset> (dcp.cpls().front()->reels().front()->main_picture()->asset());
536 BOOST_REQUIRE (asset);
537 shared_ptr<const dcp::MonoPictureFrame> frame = asset->start_read()->get_frame(index);
538 shared_ptr<const dcp::MonoPictureFrame> ref_frame (new dcp::MonoPictureFrame (ref));
540 shared_ptr<dcp::OpenJPEGImage> image = frame->xyz_image ();
541 shared_ptr<dcp::OpenJPEGImage> ref_image = ref_frame->xyz_image ();
543 BOOST_REQUIRE (image->size() == ref_image->size());
546 for (int y = 0; y < ref_image->size().height; ++y) {
547 for (int x = 0; x < ref_image->size().width; ++x) {
548 BOOST_REQUIRE_EQUAL (ref_image->data(0)[off], image->data(0)[off]);
549 BOOST_REQUIRE_EQUAL (ref_image->data(1)[off], image->data(1)[off]);
550 BOOST_REQUIRE_EQUAL (ref_image->data(2)[off], image->data(2)[off]);
556 boost::filesystem::path
557 dcp_file (shared_ptr<const Film> film, string prefix)
559 boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (film->dir(film->dcp_name()));
560 while (i != boost::filesystem::directory_iterator() && !boost::algorithm::starts_with (i->path().leaf().string(), prefix)) {
564 BOOST_REQUIRE (i != boost::filesystem::directory_iterator());
568 boost::filesystem::path
569 subtitle_file (shared_ptr<Film> film)
572 boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (film->directory().get() / film->dcp_name (false));
573 i != boost::filesystem::directory_iterator ();
576 if (boost::filesystem::is_directory (i->path ())) {
578 boost::filesystem::directory_iterator j = boost::filesystem::directory_iterator (i->path ());
579 j != boost::filesystem::directory_iterator ();
582 if (boost::algorithm::starts_with (j->path().leaf().string(), "sub_")) {
589 BOOST_REQUIRE (false);
591 return boost::filesystem::path("/");
595 make_random_file (boost::filesystem::path path, size_t size)
597 size_t const chunk = 128 * 1024;
598 uint8_t* buffer = static_cast<uint8_t*> (malloc(chunk));
599 BOOST_REQUIRE (buffer);
600 FILE* r = fopen("/dev/urandom", "rb");
602 FILE* t = fopen_boost(path, "wb");
605 size_t this_time = min (size, chunk);
606 size_t N = fread (buffer, 1, this_time, r);
607 BOOST_REQUIRE (N == this_time);
608 N = fwrite (buffer, 1, this_time, t);
609 BOOST_REQUIRE (N == this_time);
618 LogSwitcher::LogSwitcher (shared_ptr<Log> log)
619 : _old (dcpomatic_log)
625 LogSwitcher::~LogSwitcher ()
627 dcpomatic_log = _old;