Tweak error threshold for an image comparison involving subtitles.
[dcpomatic.git] / test / test.cc
index 9027b8b71bf139576f8805d9b2c882b8aeb1aeaa..68c1cfccd897e5792d88698af675337290813097 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2017 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
@@ -34,6 +34,8 @@
 #include "lib/ratio.h"
 #include "lib/dcp_content_type.h"
 #include "lib/log_entry.h"
+#include "lib/compose.hpp"
+#include "test.h"
 #include <dcp/dcp.h>
 #include <dcp/cpl.h>
 #include <dcp/reel.h>
@@ -67,7 +69,24 @@ using boost::shared_ptr;
 using boost::scoped_array;
 using boost::dynamic_pointer_cast;
 
-boost::filesystem::path private_data = boost::filesystem::path ("..") / boost::filesystem::path ("dcpomatic-test-private");
+boost::filesystem::path private_data = boost::filesystem::canonical(boost::filesystem::path ("..") / boost::filesystem::path ("dcpomatic-test-private"));
+
+void
+setup_test_config ()
+{
+       Config::instance()->set_master_encoding_threads (1);
+       Config::instance()->set_server_encoding_threads (1);
+       Config::instance()->set_server_port_base (61921);
+       Config::instance()->set_default_isdcf_metadata (ISDCFMetadata ());
+       Config::instance()->set_default_container (Ratio::from_id ("185"));
+       Config::instance()->set_default_dcp_content_type (static_cast<DCPContentType*> (0));
+       Config::instance()->set_default_audio_delay (0);
+       Config::instance()->set_default_j2k_bandwidth (100000000);
+       Config::instance()->set_default_interop (false);
+       Config::instance()->set_default_still_length (10);
+       Config::instance()->set_log_types (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
+       Config::instance()->set_automatic_audio_analysis (false);
+}
 
 class TestSignalManager : public SignalManager
 {
@@ -84,23 +103,16 @@ struct TestConfig
        TestConfig ()
        {
                dcpomatic_setup ();
-
-               Config::instance()->set_master_encoding_threads (1);
-               Config::instance()->set_server_encoding_threads (1);
-               Config::instance()->set_server_port_base (61921);
-               Config::instance()->set_default_isdcf_metadata (ISDCFMetadata ());
-               Config::instance()->set_default_container (Ratio::from_id ("185"));
-               Config::instance()->set_default_dcp_content_type (static_cast<DCPContentType*> (0));
-               Config::instance()->set_default_audio_delay (0);
-               Config::instance()->set_default_j2k_bandwidth (100000000);
-               Config::instance()->set_default_interop (false);
-               Config::instance()->set_default_still_length (10);
-               Config::instance()->set_log_types (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
-               Config::instance()->set_automatic_audio_analysis (false);
+               setup_test_config ();
 
                EncodeServerFinder::instance()->stop ();
 
                signal_manager = new TestSignalManager ();
+
+               char* env_private = getenv("DCPOMATIC_TEST_PRIVATE");
+               if (env_private) {
+                       private_data = env_private;
+               }
        }
 
        ~TestConfig ()
@@ -219,7 +231,7 @@ check_mxf_audio_file (boost::filesystem::path ref, boost::filesystem::path check
 }
 
 void
-check_image (boost::filesystem::path ref, boost::filesystem::path check)
+check_image (boost::filesystem::path ref, boost::filesystem::path check, double threshold)
 {
 #ifdef DCPOMATIC_IMAGE_MAGICK
        using namespace MagickCore;
@@ -231,7 +243,15 @@ check_image (boost::filesystem::path ref, boost::filesystem::path check)
        ref_image.read (ref.string ());
        Magick::Image check_image;
        check_image.read (check.string ());
-       BOOST_CHECK_MESSAGE (ref_image.compare (check_image), ref << " differs from " << check);
+       /* XXX: this is a hack; we really want the ImageMagick call but GraphicsMagick doesn't have it;
+          this may cause random test failures on platforms that use GraphicsMagick.
+       */
+#ifdef DCPOMATIC_ADVANCED_MAGICK_COMPARE
+       double const dist = ref_image.compare(check_image, Magick::RootMeanSquaredErrorMetric);
+       BOOST_CHECK_MESSAGE (dist < threshold, ref << " differs from " << check << " " << dist);
+#else
+       BOOST_CHECK_MESSAGE (!ref_image.compare(check_image), ref << " differs from " << check);
+#endif
 }
 
 void
@@ -417,55 +437,11 @@ write_image (shared_ptr<const Image> image, boost::filesystem::path file, string
        m.write (file.string ());
 }
 
-class Reader
-{
-public:
-       Reader (boost::filesystem::path file)
-       {
-               format_context = avformat_alloc_context ();
-               BOOST_REQUIRE (format_context);
-               BOOST_REQUIRE (avformat_open_input (&format_context, file.string().c_str(), 0, 0) >= 0);
-               BOOST_REQUIRE (avformat_find_stream_info (format_context, 0) >= 0);
-       }
-
-       ~Reader ()
-       {
-               avformat_close_input (&format_context);
-       }
-
-       AVFormatContext* format_context;
-};
-
-
 void
-check_ffmpeg (boost::filesystem::path ref, boost::filesystem::path check, int skip_packet_stream)
+check_ffmpeg (boost::filesystem::path ref, boost::filesystem::path check, int audio_tolerance)
 {
-       Reader ref_r (ref);
-       Reader check_r (check);
-
-       BOOST_REQUIRE_EQUAL (ref_r.format_context->nb_streams, check_r.format_context->nb_streams);
-
-       AVPacket ref_p;
-       AVPacket check_p;
-
-       bool skipped = false;
-
-       while (true) {
-               int p = av_read_frame (ref_r.format_context, &ref_p);
-               int q = av_read_frame (check_r.format_context, &check_p);
-               if (ref_p.stream_index == skip_packet_stream && check_p.stream_index == skip_packet_stream && !skipped) {
-                       skipped = true;
-                       continue;
-               }
-               BOOST_REQUIRE_EQUAL (p, q);
-               BOOST_REQUIRE (p == 0 || p == AVERROR_EOF);
-               if (p == AVERROR_EOF) {
-                       break;
-               }
-
-               BOOST_REQUIRE_EQUAL (ref_p.buf->size, check_p.buf->size);
-               BOOST_REQUIRE_EQUAL (memcmp (ref_p.buf->data, check_p.buf->data, ref_p.buf->size), 0);
-       }
+       int const r = system (String::compose("ffcmp -t %1 %2 %3", audio_tolerance, ref.string(), check.string()).c_str());
+       BOOST_REQUIRE_EQUAL (WEXITSTATUS(r), 0);
 }
 
 void
@@ -492,10 +468,10 @@ check_one_frame (boost::filesystem::path dcp_dir, int64_t index, boost::filesyst
 }
 
 boost::filesystem::path
-video_file (shared_ptr<const Film> film)
+dcp_file (shared_ptr<const Film> film, string prefix)
 {
        boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (film->dir(film->dcp_name()));
-       while (i != boost::filesystem::directory_iterator() && !boost::algorithm::starts_with (i->path().leaf().string(), "j2c")) {
+       while (i != boost::filesystem::directory_iterator() && !boost::algorithm::starts_with (i->path().leaf().string(), prefix)) {
                ++i;
        }