2 Copyright (C) 2012-2021 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/>.
23 /** @file test/test.cc
24 * @brief Overall test stuff and useful methods for tests.
28 #include "lib/compose.hpp"
29 #include "lib/config.h"
30 #include "lib/cross.h"
31 #include "lib/dcp_content_type.h"
32 #include "lib/dcpomatic_log.h"
33 #include "lib/encode_server_finder.h"
34 #include "lib/ffmpeg_image_proxy.h"
35 #include "lib/file_log.h"
37 #include "lib/image.h"
39 #include "lib/job_manager.h"
40 #include "lib/log_entry.h"
41 #include "lib/make_dcp.h"
42 #include "lib/ratio.h"
43 #include "lib/signal_manager.h"
48 #include <dcp/equality_options.h>
49 #include <dcp/filesystem.h>
50 #include <dcp/mono_picture_asset.h>
51 #include <dcp/mono_picture_frame.h>
52 #include <dcp/openjpeg_image.h>
54 #include <dcp/reel_picture_asset.h>
55 #include <dcp/scope_guard.h>
56 #include <dcp/warnings.h>
57 #include <asdcp/AS_DCP.h>
60 #include <libxml++/libxml++.h>
62 #include <libavformat/avformat.h>
64 #define BOOST_TEST_DYN_LINK
65 #define BOOST_TEST_MODULE dcpomatic_test
66 #include <boost/algorithm/string.hpp>
67 LIBDCP_DISABLE_WARNINGS
68 #include <boost/random.hpp>
69 LIBDCP_ENABLE_WARNINGS
70 #include <boost/test/unit_test.hpp>
80 using std::make_shared;
82 using std::shared_ptr;
85 using boost::optional;
86 using boost::scoped_array;
87 using std::dynamic_pointer_cast;
88 #if BOOST_VERSION >= 106100
89 using namespace boost::placeholders;
93 boost::filesystem::path
94 TestPaths::TestPaths::private_data ()
96 char* env = getenv("DCPOMATIC_TEST_PRIVATE");
98 return boost::filesystem::path(env);
101 auto relative = boost::filesystem::path ("..") / boost::filesystem::path ("dcpomatic-test-private");
102 if (!boost::filesystem::exists(relative)) {
103 std::cerr << "No private test data found! Tests may fail.\n";
107 return boost::filesystem::canonical(relative);
111 boost::filesystem::path TestPaths::xsd ()
113 return boost::filesystem::current_path().parent_path() / "libdcp" / "xsd";
120 Config::instance()->set_master_encoding_threads (boost::thread::hardware_concurrency() / 2);
121 Config::instance()->set_server_encoding_threads (1);
122 Config::instance()->set_server_port_base (61921);
123 Config::instance()->set_default_dcp_content_type (static_cast<DCPContentType*> (0));
124 Config::instance()->set_default_audio_delay (0);
125 Config::instance()->set_default_j2k_bandwidth (100000000);
126 Config::instance()->set_default_interop (false);
127 Config::instance()->set_default_still_length (10);
128 Config::instance()->set_default_dcp_audio_channels(8);
129 Config::instance()->set_log_types (
130 LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING |
131 LogEntry::TYPE_ERROR | LogEntry::TYPE_DISK
133 Config::instance()->set_automatic_audio_analysis (false);
134 auto signer = make_shared<dcp::CertificateChain>(dcp::file_to_string("test/data/signer_chain"));
135 signer->set_key(dcp::file_to_string("test/data/signer_key"));
136 Config::instance()->set_signer_chain (signer);
137 auto decryption = make_shared<dcp::CertificateChain>(dcp::file_to_string("test/data/decryption_chain"));
138 decryption->set_key(dcp::file_to_string("test/data/decryption_key"));
139 Config::instance()->set_decryption_chain (decryption);
140 Config::instance()->set_dcp_asset_filename_format(dcp::NameFormat("%t"));
141 Config::instance()->set_cinemas_file("test/data/empty_cinemas.xml");
145 class TestSignalManager : public SignalManager
148 /* No wakes in tests: we call ui_idle ourselves */
149 void wake_ui () override
159 State::override_path = "build/test/state";
160 boost::filesystem::remove_all (*State::override_path);
163 setup_test_config ();
164 capture_ffmpeg_logs();
166 EncodeServerFinder::instance()->stop ();
168 signal_manager = new TestSignalManager ();
170 dcpomatic_log.reset (new FileLog("build/test/log"));
172 auto const& suite = boost::unit_test::framework::master_test_suite();
173 int types = LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR;
174 for (int i = 1; i < suite.argc; ++i) {
175 if (string(suite.argv[i]) == "--log=debug-player") {
176 types |= LogEntry::TYPE_DEBUG_PLAYER;
180 dcpomatic_log->set_types(types);
190 BOOST_GLOBAL_FIXTURE (TestConfig);
193 boost::filesystem::path
194 test_film_dir (string name)
196 boost::filesystem::path p;
205 new_test_film (string name)
207 auto p = test_film_dir (name);
208 if (boost::filesystem::exists (p)) {
209 boost::filesystem::remove_all (p);
212 auto film = make_shared<Film>(p);
213 film->write_metadata ();
219 new_test_film2 (string name, vector<shared_ptr<Content>> content, Cleanup* cleanup)
221 auto p = test_film_dir (name);
222 if (boost::filesystem::exists (p)) {
223 boost::filesystem::remove_all (p);
229 auto film = make_shared<Film>(p);
230 film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TST"));
231 film->set_container (Ratio::from_id ("185"));
232 film->write_metadata ();
234 for (auto i: content) {
235 film->examine_and_add_content (i);
236 BOOST_REQUIRE (!wait_for_jobs());
244 check_wav_file (boost::filesystem::path ref, boost::filesystem::path check)
248 auto ref_file = sf_open (ref.string().c_str(), SFM_READ, &ref_info);
249 BOOST_CHECK (ref_file);
252 check_info.format = 0;
253 auto check_file = sf_open (check.string().c_str(), SFM_READ, &check_info);
254 BOOST_CHECK (check_file);
256 BOOST_CHECK_EQUAL (ref_info.frames, check_info.frames);
257 BOOST_CHECK_EQUAL (ref_info.samplerate, check_info.samplerate);
258 BOOST_CHECK_EQUAL (ref_info.channels, check_info.channels);
259 BOOST_CHECK_EQUAL (ref_info.format, check_info.format);
261 /* buffer_size is in frames */
262 sf_count_t const buffer_size = 65536 * ref_info.channels;
263 scoped_array<int32_t> ref_buffer (new int32_t[buffer_size]);
264 scoped_array<int32_t> check_buffer (new int32_t[buffer_size]);
266 sf_count_t N = ref_info.frames;
268 sf_count_t this_time = min (buffer_size, N);
269 sf_count_t r = sf_readf_int (ref_file, ref_buffer.get(), this_time);
270 BOOST_CHECK_EQUAL (r, this_time);
271 r = sf_readf_int (check_file, check_buffer.get(), this_time);
272 BOOST_CHECK_EQUAL (r, this_time);
274 for (sf_count_t i = 0; i < this_time; ++i) {
275 BOOST_REQUIRE_MESSAGE (
276 abs (ref_buffer[i] - check_buffer[i]) <= 65536,
277 ref << " differs from " << check << " at " << (ref_info.frames - N + i) << " of " << ref_info.frames
278 << "(" << ref_buffer[i] << " vs " << check_buffer[i] << ")"
288 check_mxf_audio_file (boost::filesystem::path ref, boost::filesystem::path check)
290 ASDCP::PCM::MXFReader ref_reader;
291 BOOST_REQUIRE (!ASDCP_FAILURE (ref_reader.OpenRead (ref.string().c_str())));
293 ASDCP::PCM::AudioDescriptor ref_desc;
294 BOOST_REQUIRE (!ASDCP_FAILURE (ref_reader.FillAudioDescriptor (ref_desc)));
296 ASDCP::PCM::MXFReader check_reader;
297 BOOST_REQUIRE (!ASDCP_FAILURE (check_reader.OpenRead (check.string().c_str())));
299 ASDCP::PCM::AudioDescriptor check_desc;
300 BOOST_REQUIRE (!ASDCP_FAILURE (check_reader.FillAudioDescriptor (check_desc)));
302 BOOST_REQUIRE_EQUAL (ref_desc.ContainerDuration, check_desc.ContainerDuration);
303 BOOST_REQUIRE_MESSAGE(ref_desc.ChannelCount, check_desc.ChannelCount);
305 ASDCP::PCM::FrameBuffer ref_buffer (Kumu::Megabyte);
306 ASDCP::PCM::FrameBuffer check_buffer (Kumu::Megabyte);
307 for (size_t i = 0; i < ref_desc.ContainerDuration; ++i) {
308 ref_reader.ReadFrame (i, ref_buffer, 0);
309 check_reader.ReadFrame (i, check_buffer, 0);
310 BOOST_REQUIRE_MESSAGE(memcmp(ref_buffer.RoData(), check_buffer.RoData(), ref_buffer.Size()) == 0, "Audio MXF differs in frame " << i);
315 /** @return true if the files are the same, otherwise false */
317 mxf_atmos_files_same (boost::filesystem::path ref, boost::filesystem::path check, bool verbose)
319 ASDCP::ATMOS::MXFReader ref_reader;
320 BOOST_REQUIRE (!ASDCP_FAILURE(ref_reader.OpenRead(ref.string().c_str())));
322 ASDCP::ATMOS::AtmosDescriptor ref_desc;
323 BOOST_REQUIRE (!ASDCP_FAILURE(ref_reader.FillAtmosDescriptor(ref_desc)));
325 ASDCP::ATMOS::MXFReader check_reader;
326 BOOST_REQUIRE (!ASDCP_FAILURE(check_reader.OpenRead(check.string().c_str())));
328 ASDCP::ATMOS::AtmosDescriptor check_desc;
329 BOOST_REQUIRE (!ASDCP_FAILURE(check_reader.FillAtmosDescriptor(check_desc)));
331 if (ref_desc.EditRate.Numerator != check_desc.EditRate.Numerator) {
333 std::cout << "EditRate.Numerator differs.\n";
337 if (ref_desc.EditRate.Denominator != check_desc.EditRate.Denominator) {
339 std::cout << "EditRate.Denominator differs.\n";
343 if (ref_desc.ContainerDuration != check_desc.ContainerDuration) {
345 std::cout << "EditRate.ContainerDuration differs.\n";
349 if (ref_desc.FirstFrame != check_desc.FirstFrame) {
351 std::cout << "EditRate.FirstFrame differs.\n";
355 if (ref_desc.MaxChannelCount != check_desc.MaxChannelCount) {
357 std::cout << "EditRate.MaxChannelCount differs.\n";
361 if (ref_desc.MaxObjectCount != check_desc.MaxObjectCount) {
363 std::cout << "EditRate.MaxObjectCount differs.\n";
367 if (ref_desc.AtmosVersion != check_desc.AtmosVersion) {
369 std::cout << "EditRate.AtmosVersion differs.\n";
374 ASDCP::DCData::FrameBuffer ref_buffer (Kumu::Megabyte);
375 ASDCP::DCData::FrameBuffer check_buffer (Kumu::Megabyte);
376 for (size_t i = 0; i < ref_desc.ContainerDuration; ++i) {
377 ref_reader.ReadFrame (i, ref_buffer, 0);
378 check_reader.ReadFrame (i, check_buffer, 0);
379 if (memcmp(ref_buffer.RoData(), check_buffer.RoData(), ref_buffer.Size())) {
381 std::cout << "data differs.\n";
393 rms_error (boost::filesystem::path ref, boost::filesystem::path check)
395 FFmpegImageProxy ref_proxy (ref);
396 auto ref_image = ref_proxy.image(Image::Alignment::COMPACT).image;
397 FFmpegImageProxy check_proxy (check);
398 auto check_image = check_proxy.image(Image::Alignment::COMPACT).image;
400 BOOST_REQUIRE_EQUAL (ref_image->planes(), check_image->planes());
402 BOOST_REQUIRE_EQUAL (ref_image->pixel_format(), check_image->pixel_format());
403 auto const format = ref_image->pixel_format();
405 BOOST_REQUIRE (ref_image->size() == check_image->size());
406 int const width = ref_image->size().width;
407 int const height = ref_image->size().height;
409 double sum_square = 0;
411 case AV_PIX_FMT_RGBA:
413 for (int y = 0; y < height; ++y) {
414 uint8_t* p = ref_image->data()[0] + y * ref_image->stride()[0];
415 uint8_t* q = check_image->data()[0] + y * check_image->stride()[0];
416 for (int x = 0; x < width; ++x) {
417 for (int c = 0; c < 4; ++c) {
418 sum_square += pow((*p++ - *q++), 2);
424 case AV_PIX_FMT_RGB24:
426 for (int y = 0; y < height; ++y) {
427 uint8_t* p = ref_image->data()[0] + y * ref_image->stride()[0];
428 uint8_t* q = check_image->data()[0] + y * check_image->stride()[0];
429 for (int x = 0; x < width; ++x) {
430 for (int c = 0; c < 3; ++c) {
431 sum_square += pow((*p++ - *q++), 2);
437 case AV_PIX_FMT_RGB48BE:
439 for (int y = 0; y < height; ++y) {
440 uint16_t* p = reinterpret_cast<uint16_t*>(ref_image->data()[0] + y * ref_image->stride()[0]);
441 uint16_t* q = reinterpret_cast<uint16_t*>(check_image->data()[0] + y * check_image->stride()[0]);
442 for (int x = 0; x < width; ++x) {
443 for (int c = 0; c < 3; ++c) {
444 sum_square += pow((*p++ - *q++), 2);
450 case AV_PIX_FMT_YUVJ420P:
452 for (int c = 0; c < ref_image->planes(); ++c) {
453 for (int y = 0; y < height / ref_image->vertical_factor(c); ++y) {
454 auto p = ref_image->data()[c] + y * ref_image->stride()[c];
455 auto q = check_image->data()[c] + y * check_image->stride()[c];
456 for (int x = 0; x < ref_image->line_size()[c]; ++x) {
457 sum_square += pow((*p++ - *q++), 2);
464 BOOST_REQUIRE_MESSAGE (false, "unrecognised pixel format " << format);
467 return sqrt(sum_square / (height * width));
471 BOOST_AUTO_TEST_CASE (rms_error_test)
473 BOOST_CHECK_CLOSE (rms_error("test/data/check_image0.png", "test/data/check_image0.png"), 0, 0.001);
474 BOOST_CHECK_CLOSE (rms_error("test/data/check_image0.png", "test/data/check_image1.png"), 2.2778, 0.001);
475 BOOST_CHECK_CLOSE (rms_error("test/data/check_image0.png", "test/data/check_image2.png"), 59.8896, 0.001);
476 BOOST_CHECK_CLOSE (rms_error("test/data/check_image0.png", "test/data/check_image3.png"), 0.89164, 0.001);
481 check_image (boost::filesystem::path ref, boost::filesystem::path check, double threshold)
483 double const e = rms_error (ref, check);
484 BOOST_CHECK_MESSAGE (e < threshold, ref << " differs from " << check << " " << e);
489 check_file (boost::filesystem::path ref, boost::filesystem::path check)
491 auto N = boost::filesystem::file_size (ref);
492 BOOST_CHECK_EQUAL (N, boost::filesystem::file_size (check));
493 dcp::File ref_file(ref, "rb");
494 BOOST_CHECK (ref_file);
495 dcp::File check_file(check, "rb");
496 BOOST_CHECK (check_file);
498 int const buffer_size = 65536;
499 std::vector<uint8_t> ref_buffer(buffer_size);
500 std::vector<uint8_t> check_buffer(buffer_size);
502 string error = "File " + check.string() + " differs from reference " + ref.string();
505 uintmax_t this_time = min (uintmax_t (buffer_size), N);
506 size_t r = ref_file.read (ref_buffer.data(), 1, this_time);
507 BOOST_CHECK_EQUAL (r, this_time);
508 r = check_file.read(check_buffer.data(), 1, this_time);
509 BOOST_CHECK_EQUAL (r, this_time);
511 BOOST_CHECK_MESSAGE (memcmp (ref_buffer.data(), check_buffer.data(), this_time) == 0, error);
512 if (memcmp (ref_buffer.data(), check_buffer.data(), this_time)) {
522 check_text_file (boost::filesystem::path ref, boost::filesystem::path check)
524 dcp::File ref_file(ref, "r");
525 BOOST_CHECK (ref_file);
526 dcp::File check_file(check, "r");
527 BOOST_CHECK (check_file);
529 int const buffer_size = std::max(
530 boost::filesystem::file_size(ref),
531 boost::filesystem::file_size(check)
534 DCPOMATIC_ASSERT (buffer_size < 1024 * 1024);
536 std::vector<uint8_t> ref_buffer(buffer_size);
537 auto ref_read = ref_file.read(ref_buffer.data(), 1, buffer_size);
538 std::vector<uint8_t> check_buffer(buffer_size);
539 auto check_read = check_file.read(check_buffer.data(), 1, buffer_size);
540 BOOST_CHECK_EQUAL (ref_read, check_read);
542 string const error = "File " + check.string() + " differs from reference " + ref.string();
543 BOOST_CHECK_MESSAGE(memcmp(ref_buffer.data(), check_buffer.data(), ref_read) == 0, error);
548 note (dcp::NoteType t, string n)
550 if (t == dcp::NoteType::ERROR) {
557 check_dcp (boost::filesystem::path ref, shared_ptr<const Film> film)
559 check_dcp (ref, film->dir(film->dcp_name()));
564 check_dcp(boost::filesystem::path ref, boost::filesystem::path check, bool sound_can_differ)
566 dcp::DCP ref_dcp (ref);
568 dcp::DCP check_dcp (check);
571 dcp::EqualityOptions options;
572 options.max_mean_pixel_error = 5;
573 options.max_std_dev_pixel_error = 5;
574 options.max_audio_sample_error = 255;
575 options.cpl_annotation_texts_can_differ = true;
576 options.reel_annotation_texts_can_differ = true;
577 options.reel_hashes_can_differ = true;
578 options.asset_hashes_can_differ = true;
579 options.issue_dates_can_differ = true;
580 options.max_subtitle_vertical_position_error = 0.001;
581 options.sound_assets_can_differ = sound_can_differ;
583 BOOST_CHECK_MESSAGE(ref_dcp.equals(check_dcp, options, boost::bind (note, _1, _2)), check << " does not match " << ref);
587 check_xml (xmlpp::Element* ref, xmlpp::Element* test, list<string> ignore)
589 BOOST_CHECK_EQUAL (ref->get_name (), test->get_name ());
590 BOOST_CHECK_EQUAL (ref->get_namespace_prefix (), test->get_namespace_prefix ());
592 if (find (ignore.begin(), ignore.end(), ref->get_name()) != ignore.end ()) {
596 auto ref_children = ref->get_children ();
597 auto test_children = test->get_children ();
598 BOOST_REQUIRE_MESSAGE (
599 ref_children.size() == test_children.size(),
600 ref->get_name() << " has " << ref_children.size() << " or " << test_children.size() << " children"
603 auto k = ref_children.begin ();
604 auto l = test_children.begin ();
605 while (k != ref_children.end ()) {
607 /* XXX: should be doing xmlpp::EntityReference, xmlpp::XIncludeEnd, xmlpp::XIncludeStart */
609 auto ref_el = dynamic_cast<xmlpp::Element*>(*k);
610 auto test_el = dynamic_cast<xmlpp::Element*>(*l);
611 BOOST_CHECK ((ref_el && test_el) || (!ref_el && !test_el));
612 if (ref_el && test_el) {
613 check_xml (ref_el, test_el, ignore);
616 auto ref_cn = dynamic_cast<xmlpp::ContentNode*>(*k);
617 auto test_cn = dynamic_cast<xmlpp::ContentNode*>(*l);
618 BOOST_CHECK ((ref_cn && test_cn) || (!ref_cn && !test_cn));
619 if (ref_cn && test_cn) {
620 BOOST_CHECK_EQUAL (ref_cn->get_content(), test_cn->get_content ());
627 auto ref_attributes = ref->get_attributes ();
628 auto test_attributes = test->get_attributes ();
629 BOOST_CHECK_EQUAL (ref_attributes.size(), test_attributes.size ());
631 auto m = ref_attributes.begin();
632 auto n = test_attributes.begin();
633 while (m != ref_attributes.end ()) {
634 BOOST_CHECK_EQUAL ((*m)->get_name(), (*n)->get_name());
635 BOOST_CHECK_EQUAL ((*m)->get_value(), (*n)->get_value());
643 check_xml (boost::filesystem::path ref, boost::filesystem::path test, list<string> ignore)
645 auto ref_parser = new xmlpp::DomParser(ref.string());
646 auto ref_root = ref_parser->get_document()->get_root_node();
647 auto test_parser = new xmlpp::DomParser(test.string());
648 auto test_root = test_parser->get_document()->get_root_node();
650 check_xml (ref_root, test_root, ignore);
656 auto jm = JobManager::instance ();
657 while (jm->work_to_do()) {
658 while (signal_manager->ui_idle()) {}
659 dcpomatic_sleep_seconds (1);
664 for (auto i: jm->_jobs) {
665 if (i->finished_in_error()) {
669 cerr << N << " errors.\n";
671 for (auto i: jm->_jobs) {
672 if (i->finished_in_error()) {
673 cerr << i->name() << ":\n"
674 << "\tsummary: " << i->error_summary() << "\n"
675 << "\tdetails: " << i->error_details() << "\n";
680 while (signal_manager->ui_idle ()) {}
701 Memory (Memory const&) = delete;
702 Memory& operator= (Memory const&) = delete;
704 uint8_t* data = nullptr;
710 png_write_data (png_structp png_ptr, png_bytep data, png_size_t length)
712 auto mem = reinterpret_cast<Memory*>(png_get_io_ptr(png_ptr));
713 size_t size = mem->size + length;
716 mem->data = reinterpret_cast<uint8_t*>(realloc(mem->data, size));
718 mem->data = reinterpret_cast<uint8_t*>(malloc(size));
721 BOOST_REQUIRE (mem->data);
723 memcpy (mem->data + mem->size, data, length);
729 png_flush (png_structp)
736 png_error_fn (png_structp, char const * message)
738 throw EncodeError (String::compose("Error during PNG write: %1", message));
743 write_image (shared_ptr<const Image> image, boost::filesystem::path file)
745 int png_color_type = PNG_COLOR_TYPE_RGB;
746 int bits_per_pixel = 0;
747 switch (image->pixel_format()) {
748 case AV_PIX_FMT_RGB24:
751 case AV_PIX_FMT_XYZ12LE:
755 BOOST_REQUIRE_MESSAGE (false, "unexpected pixel format " << image->pixel_format());
758 /* error handling? */
759 png_structp png_ptr = png_create_write_struct(PNG_LIBPNG_VER_STRING, reinterpret_cast<void*>(const_cast<Image*>(image.get())), png_error_fn, 0);
760 BOOST_REQUIRE (png_ptr);
764 png_set_write_fn (png_ptr, &state, png_write_data, png_flush);
766 png_infop info_ptr = png_create_info_struct(png_ptr);
767 BOOST_REQUIRE (info_ptr);
769 png_set_IHDR (png_ptr, info_ptr, image->size().width, image->size().height, bits_per_pixel, png_color_type, PNG_INTERLACE_NONE, PNG_COMPRESSION_TYPE_DEFAULT, PNG_FILTER_TYPE_DEFAULT);
771 auto const width = image->size().width;
772 auto const height = image->size().height;
773 auto const stride = image->stride()[0];
775 vector<vector<uint8_t>> data_to_write(height);
776 for (int y = 0; y < height; ++y) {
777 data_to_write[y].resize(stride);
780 switch (image->pixel_format()) {
781 case AV_PIX_FMT_RGB24:
782 for (int y = 0; y < height; ++y) {
783 memcpy(data_to_write[y].data(), image->data()[0] + y * stride, stride);
786 case AV_PIX_FMT_XYZ12LE:
787 /* 16-bit pixel values must be written MSB first */
788 for (int y = 0; y < height; ++y) {
789 data_to_write[y].resize(stride);
790 uint8_t* original = image->data()[0] + y * stride;
791 for (int x = 0; x < width * 3; ++x) {
792 data_to_write[y][x * 2] = original[1];
793 data_to_write[y][x * 2 + 1] = original[0];
802 png_byte ** row_pointers = reinterpret_cast<png_byte**>(png_malloc(png_ptr, image->size().height * sizeof(png_byte *)));
803 for (int y = 0; y < height; ++y) {
804 row_pointers[y] = reinterpret_cast<png_byte*>(data_to_write[y].data());
807 png_write_info (png_ptr, info_ptr);
808 png_write_image (png_ptr, row_pointers);
809 png_write_end (png_ptr, info_ptr);
811 png_destroy_write_struct (&png_ptr, &info_ptr);
812 png_free (png_ptr, row_pointers);
814 dcp::ArrayData(state.data, state.size).write(file);
819 check_ffmpeg (boost::filesystem::path ref, boost::filesystem::path check, int audio_tolerance)
821 int const r = system (String::compose("ffcmp -t %1 %2 %3", audio_tolerance, ref.string(), check.string()).c_str());
822 BOOST_REQUIRE_EQUAL (WEXITSTATUS(r), 0);
826 check_one_frame (boost::filesystem::path dcp_dir, int64_t index, boost::filesystem::path ref)
828 dcp::DCP dcp (dcp_dir);
830 auto asset = dynamic_pointer_cast<dcp::MonoPictureAsset> (dcp.cpls().front()->reels().front()->main_picture()->asset());
831 BOOST_REQUIRE (asset);
832 auto frame = asset->start_read()->get_frame(index);
833 auto ref_frame (new dcp::MonoPictureFrame (ref));
835 auto image = frame->xyz_image ();
836 auto ref_image = ref_frame->xyz_image ();
838 BOOST_REQUIRE (image->size() == ref_image->size());
841 for (int y = 0; y < ref_image->size().height; ++y) {
842 for (int x = 0; x < ref_image->size().width; ++x) {
843 BOOST_REQUIRE_EQUAL (ref_image->data(0)[off], image->data(0)[off]);
844 BOOST_REQUIRE_EQUAL (ref_image->data(1)[off], image->data(1)[off]);
845 BOOST_REQUIRE_EQUAL (ref_image->data(2)[off], image->data(2)[off]);
851 boost::filesystem::path
852 dcp_file (shared_ptr<const Film> film, string prefix)
854 using namespace boost::filesystem;
856 vector<directory_entry> matches;
857 std::copy_if(recursive_directory_iterator(film->dir(film->dcp_name())), recursive_directory_iterator(), std::back_inserter(matches), [&prefix](directory_entry const& entry) {
858 return boost::algorithm::starts_with(entry.path().filename().string(), prefix);
861 BOOST_REQUIRE_MESSAGE(matches.size() == 1, "Found " << matches.size() << " files with prefix " << prefix);
862 return matches[0].path();
865 boost::filesystem::path
866 subtitle_file (shared_ptr<Film> film)
868 for (auto i: boost::filesystem::recursive_directory_iterator(film->directory().get() / film->dcp_name(false))) {
869 if (boost::algorithm::starts_with(i.path().filename().string(), "sub_")) {
874 BOOST_REQUIRE (false);
876 return boost::filesystem::path("/");
881 make_random_file (boost::filesystem::path path, size_t size)
883 dcp::File random_file(path, "wb");
884 BOOST_REQUIRE (random_file);
886 boost::random::mt19937 rng(1);
887 boost::random::uniform_int_distribution<uint64_t> dist(0);
890 auto this_time = std::min(size, size_t(8));
891 uint64_t random = dist(rng);
892 random_file.write(&random, this_time, 1);
898 LogSwitcher::LogSwitcher (shared_ptr<Log> log)
899 : _old (dcpomatic_log)
905 LogSwitcher::~LogSwitcher ()
907 dcpomatic_log = _old;
911 dcp::operator<< (std::ostream& s, dcp::Size i)
913 s << i.width << "x" << i.height;
918 dcp::operator<< (std::ostream& s, dcp::Standard t)
921 case Standard::INTEROP:
924 case Standard::SMPTE:
932 operator<< (std::ostream&s, VideoFrameType f)
934 s << video_frame_type_to_string(f);
940 Cleanup::add (boost::filesystem::path path)
942 _paths.push_back (path);
949 boost::system::error_code ec;
950 for (auto i: _paths) {
951 boost::filesystem::remove_all (i, ec);
956 void stage (string, boost::optional<boost::filesystem::path>) {}
957 void progress (float) {}
961 verify_dcp(boost::filesystem::path dir, vector<dcp::VerificationNote::Code> ignore)
963 auto notes = dcp::verify({dir}, {}, &stage, &progress, {}, TestPaths::xsd());
965 for (auto i: notes) {
966 if (find(ignore.begin(), ignore.end(), i.code()) == ignore.end()) {
967 std::cout << "\t" << dcp::note_to_string(i) << "\n";
976 #ifdef DCPOMATIC_LINUX
977 make_and_verify_dcp(shared_ptr<Film> film, vector<dcp::VerificationNote::Code> ignore, bool dcp_inspect, bool clairmeta)
979 make_and_verify_dcp(shared_ptr<Film> film, vector<dcp::VerificationNote::Code> ignore, bool, bool)
982 film->write_metadata ();
983 make_dcp (film, TranscodeJob::ChangedBehaviour::IGNORE);
984 BOOST_REQUIRE (!wait_for_jobs());
985 verify_dcp({film->dir(film->dcp_name())}, ignore);
987 #ifdef DCPOMATIC_LINUX
988 auto test_tools_path_env = getenv("DCPOMATIC_TEST_TOOLS_PATH");
989 string test_tools_path;
990 if (test_tools_path_env) {
991 test_tools_path = test_tools_path_env;
994 auto old_path_env = getenv("PATH");
997 old_path = old_path_env;
1000 dcp::ScopeGuard sg = [old_path]() { setenv("PATH", old_path.c_str(), 1); };
1001 string new_path = old_path;
1002 if (!new_path.empty()) {
1005 new_path += test_tools_path;
1006 setenv("PATH", new_path.c_str(), 1);
1008 auto dcp_inspect_env = getenv("DCPOMATIC_DCP_INSPECT");
1009 if (dcp_inspect && dcp_inspect_env) {
1010 boost::filesystem::path dcp_inspect(dcp_inspect_env);
1011 auto cmd = String::compose("%1 %2 > %3 2>&1", dcp_inspect, film->dir(film->dcp_name()), film->file("dcp_inspect.log"));
1012 auto result = system(cmd.c_str());
1013 BOOST_CHECK_EQUAL(WEXITSTATUS(result), 0);
1016 if (clairmeta && getenv("DCPOMATIC_CLAIRMETA")) {
1017 auto cmd = String::compose("python3 -m clairmeta.cli check -type dcp %1 > %2 2>&1", film->dir(film->dcp_name()), film->file("clairmeta.log"));
1018 auto result = system(cmd.c_str());
1019 BOOST_CHECK_EQUAL(WEXITSTATUS(result), 0);
1026 check_int_close (int a, int b, int d)
1028 BOOST_CHECK_MESSAGE (std::abs(a - b) < d, a << " differs from " << b << " by more than " << d);
1033 check_int_close (std::pair<int, int> a, std::pair<int, int> b, int d)
1035 check_int_close (a.first, b.first, d);
1036 check_int_close (a.second, b.second, d);
1040 ConfigRestorer::~ConfigRestorer()
1042 setup_test_config();
1046 boost::filesystem::path
1047 find_file (boost::filesystem::path dir, string filename_part)
1049 boost::optional<boost::filesystem::path> found;
1050 for (auto i: boost::filesystem::directory_iterator(dir)) {
1051 if (i.path().filename().string().find(filename_part) != string::npos) {
1052 BOOST_REQUIRE_MESSAGE(!found, "File " << filename_part << " found more than once in " << dir);
1056 BOOST_REQUIRE_MESSAGE(found, "Could not find " << filename_part << " in " << dir);
1061 Editor::Editor(boost::filesystem::path path)
1063 , _content(dcp::file_to_string(path))
1070 auto f = fopen(_path.string().c_str(), "w");
1072 fwrite(_content.c_str(), _content.length(), 1, f);
1077 Editor::replace(string a, string b)
1079 auto old_content = _content;
1080 boost::algorithm::replace_all(_content, a, b);
1081 BOOST_REQUIRE(_content != old_content);