2 Copyright (C) 2012-2015 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/log_entry.h"
38 #include <libxml++/libxml++.h>
40 #define BOOST_TEST_DYN_LINK
41 #define BOOST_TEST_MODULE dcpomatic_test
42 #include <boost/test/unit_test.hpp>
54 using boost::shared_ptr;
55 using boost::scoped_array;
57 boost::filesystem::path private_data = boost::filesystem::path ("..") / boost::filesystem::path ("dcpomatic-test-private");
59 class TestSignalManager : public SignalManager
62 /* No wakes in tests: we call ui_idle ourselves */
75 Config::instance()->set_num_local_encoding_threads (1);
76 Config::instance()->set_server_port_base (61921);
77 Config::instance()->set_default_isdcf_metadata (ISDCFMetadata ());
78 Config::instance()->set_default_container (Ratio::from_id ("185"));
79 Config::instance()->set_default_dcp_content_type (static_cast<DCPContentType*> (0));
80 Config::instance()->set_default_audio_delay (0);
81 Config::instance()->set_default_j2k_bandwidth (100000000);
82 Config::instance()->set_log_types (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
84 EncodeServerFinder::instance()->disable ();
86 signal_manager = new TestSignalManager ();
95 BOOST_GLOBAL_FIXTURE (TestConfig);
97 boost::filesystem::path
98 test_film_dir (string name)
100 boost::filesystem::path p;
108 new_test_film (string name)
110 boost::filesystem::path p = test_film_dir (name);
111 if (boost::filesystem::exists (p)) {
112 boost::filesystem::remove_all (p);
115 shared_ptr<Film> film = shared_ptr<Film> (new Film (p.string()));
116 film->write_metadata ();
121 check_audio_file (boost::filesystem::path ref, boost::filesystem::path check)
125 SNDFILE* ref_file = sf_open (ref.string().c_str(), SFM_READ, &ref_info);
126 BOOST_CHECK (ref_file);
129 check_info.format = 0;
130 SNDFILE* check_file = sf_open (check.string().c_str(), SFM_READ, &check_info);
131 BOOST_CHECK (check_file);
133 BOOST_CHECK_EQUAL (ref_info.frames, check_info.frames);
134 BOOST_CHECK_EQUAL (ref_info.samplerate, check_info.samplerate);
135 BOOST_CHECK_EQUAL (ref_info.channels, check_info.channels);
136 BOOST_CHECK_EQUAL (ref_info.format, check_info.format);
138 /* buffer_size is in frames */
139 sf_count_t const buffer_size = 65536 * ref_info.channels;
140 scoped_array<int32_t> ref_buffer (new int32_t[buffer_size]);
141 scoped_array<int32_t> check_buffer (new int32_t[buffer_size]);
143 sf_count_t N = ref_info.frames;
145 sf_count_t this_time = min (buffer_size, N);
146 sf_count_t r = sf_readf_int (ref_file, ref_buffer.get(), this_time);
147 BOOST_CHECK_EQUAL (r, this_time);
148 r = sf_readf_int (check_file, check_buffer.get(), this_time);
149 BOOST_CHECK_EQUAL (r, this_time);
151 for (sf_count_t i = 0; i < this_time; ++i) {
152 BOOST_REQUIRE_MESSAGE (
153 abs (ref_buffer[i] - check_buffer[i]) <= 65536,
154 ref << " differs from " << check << " at " << (ref_info.frames - N + i) << " of " << ref_info.frames
155 << "(" << ref_buffer[i] << " vs " << check_buffer[i] << ")"
164 check_file (boost::filesystem::path ref, boost::filesystem::path check)
166 uintmax_t N = boost::filesystem::file_size (ref);
167 BOOST_CHECK_EQUAL (N, boost::filesystem::file_size (check));
168 FILE* ref_file = fopen_boost (ref, "rb");
169 BOOST_CHECK (ref_file);
170 FILE* check_file = fopen_boost (check, "rb");
171 BOOST_CHECK (check_file);
173 int const buffer_size = 65536;
174 uint8_t* ref_buffer = new uint8_t[buffer_size];
175 uint8_t* check_buffer = new uint8_t[buffer_size];
177 SafeStringStream error;
178 error << "File " << check.string() << " differs from reference " << ref.string();
181 uintmax_t this_time = min (uintmax_t (buffer_size), N);
182 size_t r = fread (ref_buffer, 1, this_time, ref_file);
183 BOOST_CHECK_EQUAL (r, this_time);
184 r = fread (check_buffer, 1, this_time, check_file);
185 BOOST_CHECK_EQUAL (r, this_time);
187 BOOST_CHECK_MESSAGE (memcmp (ref_buffer, check_buffer, this_time) == 0, error.str ());
188 if (memcmp (ref_buffer, check_buffer, this_time)) {
196 delete[] check_buffer;
203 note (dcp::NoteType t, string n)
205 if (t == dcp::DCP_ERROR) {
211 check_dcp (boost::filesystem::path ref, boost::filesystem::path check)
213 dcp::DCP ref_dcp (ref);
215 dcp::DCP check_dcp (check);
218 dcp::EqualityOptions options;
219 options.max_mean_pixel_error = 5;
220 options.max_std_dev_pixel_error = 5;
221 options.max_audio_sample_error = 255;
222 options.cpl_annotation_texts_can_differ = true;
223 options.reel_annotation_texts_can_differ = true;
224 options.reel_hashes_can_differ = true;
225 options.issue_dates_can_differ = true;
227 BOOST_CHECK (ref_dcp.equals (check_dcp, options, boost::bind (note, _1, _2)));
231 check_xml (xmlpp::Element* ref, xmlpp::Element* test, list<string> ignore)
233 BOOST_CHECK_EQUAL (ref->get_name (), test->get_name ());
234 BOOST_CHECK_EQUAL (ref->get_namespace_prefix (), test->get_namespace_prefix ());
236 if (find (ignore.begin(), ignore.end(), ref->get_name()) != ignore.end ()) {
240 xmlpp::Element::NodeList ref_children = ref->get_children ();
241 xmlpp::Element::NodeList test_children = test->get_children ();
242 BOOST_CHECK_EQUAL (ref_children.size (), test_children.size ());
244 xmlpp::Element::NodeList::iterator k = ref_children.begin ();
245 xmlpp::Element::NodeList::iterator l = test_children.begin ();
246 while (k != ref_children.end ()) {
248 /* XXX: should be doing xmlpp::EntityReference, xmlpp::XIncludeEnd, xmlpp::XIncludeStart */
250 xmlpp::Element* ref_el = dynamic_cast<xmlpp::Element*> (*k);
251 xmlpp::Element* test_el = dynamic_cast<xmlpp::Element*> (*l);
252 BOOST_CHECK ((ref_el && test_el) || (!ref_el && !test_el));
253 if (ref_el && test_el) {
254 check_xml (ref_el, test_el, ignore);
257 xmlpp::ContentNode* ref_cn = dynamic_cast<xmlpp::ContentNode*> (*k);
258 xmlpp::ContentNode* test_cn = dynamic_cast<xmlpp::ContentNode*> (*l);
259 BOOST_CHECK ((ref_cn && test_cn) || (!ref_cn && !test_cn));
260 if (ref_cn && test_cn) {
261 BOOST_CHECK_EQUAL (ref_cn->get_content(), test_cn->get_content ());
268 xmlpp::Element::AttributeList ref_attributes = ref->get_attributes ();
269 xmlpp::Element::AttributeList test_attributes = test->get_attributes ();
270 BOOST_CHECK_EQUAL (ref_attributes.size(), test_attributes.size ());
272 xmlpp::Element::AttributeList::const_iterator m = ref_attributes.begin();
273 xmlpp::Element::AttributeList::const_iterator n = test_attributes.begin();
274 while (m != ref_attributes.end ()) {
275 BOOST_CHECK_EQUAL ((*m)->get_name(), (*n)->get_name());
276 BOOST_CHECK_EQUAL ((*m)->get_value(), (*n)->get_value());
284 check_xml (boost::filesystem::path ref, boost::filesystem::path test, list<string> ignore)
286 xmlpp::DomParser* ref_parser = new xmlpp::DomParser (ref.string ());
287 xmlpp::Element* ref_root = ref_parser->get_document()->get_root_node ();
288 xmlpp::DomParser* test_parser = new xmlpp::DomParser (test.string ());
289 xmlpp::Element* test_root = test_parser->get_document()->get_root_node ();
291 check_xml (ref_root, test_root, ignore);
297 JobManager* jm = JobManager::instance ();
298 while (jm->work_to_do ()) {
299 while (signal_manager->ui_idle ()) {}
305 for (list<shared_ptr<Job> >::iterator i = jm->_jobs.begin(); i != jm->_jobs.end(); ++i) {
306 if ((*i)->finished_in_error ()) {
310 cerr << N << " errors.\n";
312 for (list<shared_ptr<Job> >::iterator i = jm->_jobs.begin(); i != jm->_jobs.end(); ++i) {
313 if ((*i)->finished_in_error ()) {
314 cerr << (*i)->name() << ":\n"
315 << "\tsummary: " << (*i)->error_summary () << "\n"
316 << "\tdetails: " << (*i)->error_details () << "\n";
321 while (signal_manager->ui_idle ()) {}
329 write_image (shared_ptr<const Image> image, boost::filesystem::path file)
331 #ifdef DCPOMATIC_IMAGE_MAGICK
332 using namespace MagickCore;
334 using namespace MagickLib;
337 Magick::Image m (image->size().width, image->size().height, "ARGB", CharPixel, (void *) image->data()[0]);
338 m.write (file.string ());