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 (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
91 Config::instance()->set_automatic_audio_analysis (false);
94 class TestSignalManager : public SignalManager
97 /* No wakes in tests: we call ui_idle ourselves */
109 setup_test_config ();
111 EncodeServerFinder::instance()->stop ();
113 signal_manager = new TestSignalManager ();
115 char* env_private = getenv("DCPOMATIC_TEST_PRIVATE");
117 TestPaths::TestPaths::private_data = env_private;
120 dcpomatic_log.reset (new FileLog("build/test/log"));
129 BOOST_GLOBAL_FIXTURE (TestConfig);
131 boost::filesystem::path
132 test_film_dir (string name)
134 boost::filesystem::path p;
142 new_test_film (string name)
144 boost::filesystem::path p = test_film_dir (name);
145 if (boost::filesystem::exists (p)) {
146 boost::filesystem::remove_all (p);
149 shared_ptr<Film> film = shared_ptr<Film> (new Film (p));
150 film->write_metadata ();
155 new_test_film2 (string name)
157 boost::filesystem::path p = test_film_dir (name);
158 if (boost::filesystem::exists (p)) {
159 boost::filesystem::remove_all (p);
162 shared_ptr<Film> film = shared_ptr<Film> (new Film (p));
163 film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TST"));
164 film->set_container (Ratio::from_id ("185"));
165 film->write_metadata ();
170 check_wav_file (boost::filesystem::path ref, boost::filesystem::path check)
174 SNDFILE* ref_file = sf_open (ref.string().c_str(), SFM_READ, &ref_info);
175 BOOST_CHECK (ref_file);
178 check_info.format = 0;
179 SNDFILE* check_file = sf_open (check.string().c_str(), SFM_READ, &check_info);
180 BOOST_CHECK (check_file);
182 BOOST_CHECK_EQUAL (ref_info.frames, check_info.frames);
183 BOOST_CHECK_EQUAL (ref_info.samplerate, check_info.samplerate);
184 BOOST_CHECK_EQUAL (ref_info.channels, check_info.channels);
185 BOOST_CHECK_EQUAL (ref_info.format, check_info.format);
187 /* buffer_size is in frames */
188 sf_count_t const buffer_size = 65536 * ref_info.channels;
189 scoped_array<int32_t> ref_buffer (new int32_t[buffer_size]);
190 scoped_array<int32_t> check_buffer (new int32_t[buffer_size]);
192 sf_count_t N = ref_info.frames;
194 sf_count_t this_time = min (buffer_size, N);
195 sf_count_t r = sf_readf_int (ref_file, ref_buffer.get(), this_time);
196 BOOST_CHECK_EQUAL (r, this_time);
197 r = sf_readf_int (check_file, check_buffer.get(), this_time);
198 BOOST_CHECK_EQUAL (r, this_time);
200 for (sf_count_t i = 0; i < this_time; ++i) {
201 BOOST_REQUIRE_MESSAGE (
202 abs (ref_buffer[i] - check_buffer[i]) <= 65536,
203 ref << " differs from " << check << " at " << (ref_info.frames - N + i) << " of " << ref_info.frames
204 << "(" << ref_buffer[i] << " vs " << check_buffer[i] << ")"
213 check_mxf_audio_file (boost::filesystem::path ref, boost::filesystem::path check)
215 ASDCP::PCM::MXFReader ref_reader;
216 BOOST_REQUIRE (!ASDCP_FAILURE (ref_reader.OpenRead (ref.string().c_str())));
218 ASDCP::PCM::AudioDescriptor ref_desc;
219 BOOST_REQUIRE (!ASDCP_FAILURE (ref_reader.FillAudioDescriptor (ref_desc)));
221 ASDCP::PCM::MXFReader check_reader;
222 BOOST_REQUIRE (!ASDCP_FAILURE (check_reader.OpenRead (check.string().c_str())));
224 ASDCP::PCM::AudioDescriptor check_desc;
225 BOOST_REQUIRE (!ASDCP_FAILURE (check_reader.FillAudioDescriptor (check_desc)));
227 BOOST_REQUIRE_EQUAL (ref_desc.ContainerDuration, check_desc.ContainerDuration);
229 ASDCP::PCM::FrameBuffer ref_buffer (Kumu::Megabyte);
230 ASDCP::PCM::FrameBuffer check_buffer (Kumu::Megabyte);
231 for (size_t i = 0; i < ref_desc.ContainerDuration; ++i) {
232 ref_reader.ReadFrame (i, ref_buffer, 0);
233 check_reader.ReadFrame (i, check_buffer, 0);
234 BOOST_REQUIRE (memcmp(ref_buffer.RoData(), check_buffer.RoData(), ref_buffer.Size()) == 0);
239 check_image (boost::filesystem::path ref, boost::filesystem::path check, double threshold)
241 using namespace MagickCore;
243 Magick::Image ref_image;
244 ref_image.read (ref.string ());
245 Magick::Image check_image;
246 check_image.read (check.string ());
247 /* XXX: this is a hack; we really want the ImageMagick call but GraphicsMagick doesn't have it;
248 this may cause random test failures on platforms that use GraphicsMagick.
250 double const dist = ref_image.compare(check_image, Magick::RootMeanSquaredErrorMetric);
251 BOOST_CHECK_MESSAGE (dist < threshold, ref << " differs from " << check << " " << dist);
255 check_file (boost::filesystem::path ref, boost::filesystem::path check)
257 uintmax_t N = boost::filesystem::file_size (ref);
258 BOOST_CHECK_EQUAL (N, boost::filesystem::file_size (check));
259 FILE* ref_file = fopen_boost (ref, "rb");
260 BOOST_CHECK (ref_file);
261 FILE* check_file = fopen_boost (check, "rb");
262 BOOST_CHECK (check_file);
264 int const buffer_size = 65536;
265 uint8_t* ref_buffer = new uint8_t[buffer_size];
266 uint8_t* check_buffer = new uint8_t[buffer_size];
268 string error = "File " + check.string() + " differs from reference " + ref.string();
271 uintmax_t this_time = min (uintmax_t (buffer_size), N);
272 size_t r = fread (ref_buffer, 1, this_time, ref_file);
273 BOOST_CHECK_EQUAL (r, this_time);
274 r = fread (check_buffer, 1, this_time, check_file);
275 BOOST_CHECK_EQUAL (r, this_time);
277 BOOST_CHECK_MESSAGE (memcmp (ref_buffer, check_buffer, this_time) == 0, error);
278 if (memcmp (ref_buffer, check_buffer, this_time)) {
286 delete[] check_buffer;
293 note (dcp::NoteType t, string n)
295 if (t == dcp::DCP_ERROR) {
302 check_dcp (boost::filesystem::path ref, shared_ptr<const Film> film)
304 check_dcp (ref, film->dir(film->dcp_name()));
309 check_dcp (boost::filesystem::path ref, boost::filesystem::path check)
311 dcp::DCP ref_dcp (ref);
313 dcp::DCP check_dcp (check);
316 dcp::EqualityOptions options;
317 options.max_mean_pixel_error = 5;
318 options.max_std_dev_pixel_error = 5;
319 options.max_audio_sample_error = 255;
320 options.cpl_annotation_texts_can_differ = true;
321 options.reel_annotation_texts_can_differ = true;
322 options.reel_hashes_can_differ = true;
323 options.issue_dates_can_differ = true;
325 BOOST_CHECK (ref_dcp.equals (check_dcp, options, boost::bind (note, _1, _2)));
329 check_xml (xmlpp::Element* ref, xmlpp::Element* test, list<string> ignore)
331 BOOST_CHECK_EQUAL (ref->get_name (), test->get_name ());
332 BOOST_CHECK_EQUAL (ref->get_namespace_prefix (), test->get_namespace_prefix ());
334 if (find (ignore.begin(), ignore.end(), ref->get_name()) != ignore.end ()) {
338 xmlpp::Element::NodeList ref_children = ref->get_children ();
339 xmlpp::Element::NodeList test_children = test->get_children ();
340 BOOST_REQUIRE_MESSAGE (
341 ref_children.size() == test_children.size(),
342 ref->get_name() << " has " << ref_children.size() << " or " << test_children.size() << " children"
345 xmlpp::Element::NodeList::iterator k = ref_children.begin ();
346 xmlpp::Element::NodeList::iterator l = test_children.begin ();
347 while (k != ref_children.end ()) {
349 /* XXX: should be doing xmlpp::EntityReference, xmlpp::XIncludeEnd, xmlpp::XIncludeStart */
351 xmlpp::Element* ref_el = dynamic_cast<xmlpp::Element*> (*k);
352 xmlpp::Element* test_el = dynamic_cast<xmlpp::Element*> (*l);
353 BOOST_CHECK ((ref_el && test_el) || (!ref_el && !test_el));
354 if (ref_el && test_el) {
355 check_xml (ref_el, test_el, ignore);
358 xmlpp::ContentNode* ref_cn = dynamic_cast<xmlpp::ContentNode*> (*k);
359 xmlpp::ContentNode* test_cn = dynamic_cast<xmlpp::ContentNode*> (*l);
360 BOOST_CHECK ((ref_cn && test_cn) || (!ref_cn && !test_cn));
361 if (ref_cn && test_cn) {
362 BOOST_CHECK_EQUAL (ref_cn->get_content(), test_cn->get_content ());
369 xmlpp::Element::AttributeList ref_attributes = ref->get_attributes ();
370 xmlpp::Element::AttributeList test_attributes = test->get_attributes ();
371 BOOST_CHECK_EQUAL (ref_attributes.size(), test_attributes.size ());
373 xmlpp::Element::AttributeList::const_iterator m = ref_attributes.begin();
374 xmlpp::Element::AttributeList::const_iterator n = test_attributes.begin();
375 while (m != ref_attributes.end ()) {
376 BOOST_CHECK_EQUAL ((*m)->get_name(), (*n)->get_name());
377 BOOST_CHECK_EQUAL ((*m)->get_value(), (*n)->get_value());
385 check_xml (boost::filesystem::path ref, boost::filesystem::path test, list<string> ignore)
387 xmlpp::DomParser* ref_parser = new xmlpp::DomParser (ref.string ());
388 xmlpp::Element* ref_root = ref_parser->get_document()->get_root_node ();
389 xmlpp::DomParser* test_parser = new xmlpp::DomParser (test.string ());
390 xmlpp::Element* test_root = test_parser->get_document()->get_root_node ();
392 check_xml (ref_root, test_root, ignore);
398 JobManager* jm = JobManager::instance ();
399 while (jm->work_to_do ()) {
400 while (signal_manager->ui_idle ()) {}
401 dcpomatic_sleep_seconds (1);
406 for (list<shared_ptr<Job> >::iterator i = jm->_jobs.begin(); i != jm->_jobs.end(); ++i) {
407 if ((*i)->finished_in_error ()) {
411 cerr << N << " errors.\n";
413 for (list<shared_ptr<Job> >::iterator i = jm->_jobs.begin(); i != jm->_jobs.end(); ++i) {
414 if ((*i)->finished_in_error ()) {
415 cerr << (*i)->name() << ":\n"
416 << "\tsummary: " << (*i)->error_summary () << "\n"
417 << "\tdetails: " << (*i)->error_details () << "\n";
422 while (signal_manager->ui_idle ()) {}
433 write_image (shared_ptr<const Image> image, boost::filesystem::path file, string format, MagickCore::StorageType pixel_type)
435 using namespace MagickCore;
437 Magick::Image m (image->size().width, image->size().height, format.c_str(), pixel_type, (void *) image->data()[0]);
438 m.write (file.string ());
442 check_ffmpeg (boost::filesystem::path ref, boost::filesystem::path check, int audio_tolerance)
444 int const r = system (String::compose("ffcmp -t %1 %2 %3", audio_tolerance, ref.string(), check.string()).c_str());
445 BOOST_REQUIRE_EQUAL (WEXITSTATUS(r), 0);
449 check_one_frame (boost::filesystem::path dcp_dir, int64_t index, boost::filesystem::path ref)
451 dcp::DCP dcp (dcp_dir);
453 shared_ptr<dcp::MonoPictureAsset> asset = dynamic_pointer_cast<dcp::MonoPictureAsset> (dcp.cpls().front()->reels().front()->main_picture()->asset());
454 BOOST_REQUIRE (asset);
455 shared_ptr<const dcp::MonoPictureFrame> frame = asset->start_read()->get_frame(index);
456 shared_ptr<const dcp::MonoPictureFrame> ref_frame (new dcp::MonoPictureFrame (ref));
458 shared_ptr<dcp::OpenJPEGImage> image = frame->xyz_image ();
459 shared_ptr<dcp::OpenJPEGImage> ref_image = ref_frame->xyz_image ();
461 BOOST_REQUIRE (image->size() == ref_image->size());
464 for (int y = 0; y < ref_image->size().height; ++y) {
465 for (int x = 0; x < ref_image->size().width; ++x) {
466 BOOST_REQUIRE_EQUAL (ref_image->data(0)[off], image->data(0)[off]);
467 BOOST_REQUIRE_EQUAL (ref_image->data(1)[off], image->data(1)[off]);
468 BOOST_REQUIRE_EQUAL (ref_image->data(2)[off], image->data(2)[off]);
474 boost::filesystem::path
475 dcp_file (shared_ptr<const Film> film, string prefix)
477 boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (film->dir(film->dcp_name()));
478 while (i != boost::filesystem::directory_iterator() && !boost::algorithm::starts_with (i->path().leaf().string(), prefix)) {
482 BOOST_REQUIRE (i != boost::filesystem::directory_iterator());
486 boost::filesystem::path
487 subtitle_file (shared_ptr<Film> film)
490 boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (film->directory().get() / film->dcp_name (false));
491 i != boost::filesystem::directory_iterator ();
494 if (boost::filesystem::is_directory (i->path ())) {
496 boost::filesystem::directory_iterator j = boost::filesystem::directory_iterator (i->path ());
497 j != boost::filesystem::directory_iterator ();
500 if (boost::algorithm::starts_with (j->path().leaf().string(), "sub_")) {
507 BOOST_REQUIRE (false);
509 return boost::filesystem::path("/");
513 make_random_file (boost::filesystem::path path, size_t size)
515 size_t const chunk = 128 * 1024;
516 uint8_t* buffer = static_cast<uint8_t*> (malloc(chunk));
517 BOOST_REQUIRE (buffer);
518 FILE* r = fopen("/dev/urandom", "rb");
520 FILE* t = fopen_boost(path, "wb");
523 size_t this_time = min (size, chunk);
524 size_t N = fread (buffer, 1, this_time, r);
525 BOOST_REQUIRE (N == this_time);
526 N = fwrite (buffer, 1, this_time, t);
527 BOOST_REQUIRE (N == this_time);