Various comment fixes to tests.
[dcpomatic.git] / test / frame_rate_test.cc
index 8b04d3763bb83dab152be8a97da7eeb70410db8b..e710b09341e2d53f38ef71399bd0f4236474d908 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 
 */
 
-/* Test best_dcp_frame_rate and FrameRateConversion */
-BOOST_AUTO_TEST_CASE (best_dcp_frame_rate_test)
+/** @file  test/frame_rate_test.cc
+ *  @brief Tests for FrameRateChange and the computation of the best
+ *  frame rate for the DCP.
+ */
+
+#include <boost/test/unit_test.hpp>
+#include "lib/film.h"
+#include "lib/config.h"
+#include "lib/ffmpeg_content.h"
+#include "lib/playlist.h"
+#include "test.h"
+
+using boost::shared_ptr;
+
+/* Test Playlist::best_dcp_frame_rate and FrameRateChange
+   with a single piece of content.
+*/
+BOOST_AUTO_TEST_CASE (best_dcp_frame_rate_test_single)
 {
-#if 0  
+       shared_ptr<Film> film = new_test_film ("best_dcp_frame_rate_test_single");
+       /* Get any piece of content, it doesn't matter what */
+       shared_ptr<FFmpegContent> content (new FFmpegContent (film, "test/data/test.mp4"));
+       film->add_content (content);
+       wait_for_jobs ();
+       
        /* Run some tests with a limited range of allowed rates */
        
        std::list<int> afr;
@@ -29,82 +50,104 @@ BOOST_AUTO_TEST_CASE (best_dcp_frame_rate_test)
        afr.push_back (30);
        Config::instance()->set_allowed_dcp_frame_rates (afr);
 
-       int best = best_dcp_frame_rate (60);
-       FrameRateConversion frc = FrameRateConversion (60, best);
+       content->_video_frame_rate = 60;
+       int best = film->playlist()->best_dcp_frame_rate ();
+       FrameRateChange frc = FrameRateChange (60, best);
        BOOST_CHECK_EQUAL (best, 30);
        BOOST_CHECK_EQUAL (frc.skip, true);
-       BOOST_CHECK_EQUAL (frc.repeat, false);
+       BOOST_CHECK_EQUAL (frc.repeat, 1);
        BOOST_CHECK_EQUAL (frc.change_speed, false);
+       BOOST_CHECK_CLOSE (frc.speed_up, 1, 0.1);
        
-       best = best_dcp_frame_rate (50);
-       frc = FrameRateConversion (50, best);
+       content->_video_frame_rate = 50;
+       best = film->playlist()->best_dcp_frame_rate ();
+       frc = FrameRateChange (50, best);
        BOOST_CHECK_EQUAL (best, 25);
        BOOST_CHECK_EQUAL (frc.skip, true);
-       BOOST_CHECK_EQUAL (frc.repeat, false);
+       BOOST_CHECK_EQUAL (frc.repeat, 1);
        BOOST_CHECK_EQUAL (frc.change_speed, false);
+       BOOST_CHECK_CLOSE (frc.speed_up, 1, 0.1);
 
-       best = best_dcp_frame_rate (48);
-       frc = FrameRateConversion (48, best);
+       content->_video_frame_rate = 48;
+       best = film->playlist()->best_dcp_frame_rate ();
+       frc = FrameRateChange (48, best);
        BOOST_CHECK_EQUAL (best, 24);
        BOOST_CHECK_EQUAL (frc.skip, true);
-       BOOST_CHECK_EQUAL (frc.repeat, false);
+       BOOST_CHECK_EQUAL (frc.repeat, 1);
        BOOST_CHECK_EQUAL (frc.change_speed, false);
-       
-       best = best_dcp_frame_rate (30);
-       frc = FrameRateConversion (30, best);
+       BOOST_CHECK_CLOSE (frc.speed_up, 1, 0.1);
+
+       content->_video_frame_rate = 30;
+       best = film->playlist()->best_dcp_frame_rate ();
+       frc = FrameRateChange (30, best);
        BOOST_CHECK_EQUAL (best, 30);
        BOOST_CHECK_EQUAL (frc.skip, false);
-       BOOST_CHECK_EQUAL (frc.repeat, false);
+       BOOST_CHECK_EQUAL (frc.repeat, 1);
        BOOST_CHECK_EQUAL (frc.change_speed, false);
+       BOOST_CHECK_CLOSE (frc.speed_up, 1, 0.1);
 
-       best = best_dcp_frame_rate (29.97);
-       frc = FrameRateConversion (29.97, best);
+       content->_video_frame_rate = 29.97;
+       best = film->playlist()->best_dcp_frame_rate ();
+       frc = FrameRateChange (29.97, best);
        BOOST_CHECK_EQUAL (best, 30);
        BOOST_CHECK_EQUAL (frc.skip, false);
-       BOOST_CHECK_EQUAL (frc.repeat, false);
+       BOOST_CHECK_EQUAL (frc.repeat, 1);
        BOOST_CHECK_EQUAL (frc.change_speed, true);
+       BOOST_CHECK_CLOSE (frc.speed_up, 30 / 29.97, 0.1);
        
-       best = best_dcp_frame_rate (25);
-       frc = FrameRateConversion (25, best);
+       content->_video_frame_rate = 25;
+       best = film->playlist()->best_dcp_frame_rate ();
+       frc = FrameRateChange (25, best);
        BOOST_CHECK_EQUAL (best, 25);
        BOOST_CHECK_EQUAL (frc.skip, false);
-       BOOST_CHECK_EQUAL (frc.repeat, false);
+       BOOST_CHECK_EQUAL (frc.repeat, 1);
        BOOST_CHECK_EQUAL (frc.change_speed, false);
+       BOOST_CHECK_CLOSE (frc.speed_up, 1, 0.1);
 
-       best = best_dcp_frame_rate (24);
-       frc = FrameRateConversion (24, best);
+       content->_video_frame_rate = 24;
+       best = film->playlist()->best_dcp_frame_rate ();
+       frc = FrameRateChange (24, best);
        BOOST_CHECK_EQUAL (best, 24);
        BOOST_CHECK_EQUAL (frc.skip, false);
-       BOOST_CHECK_EQUAL (frc.repeat, false);
+       BOOST_CHECK_EQUAL (frc.repeat, 1);
        BOOST_CHECK_EQUAL (frc.change_speed, false);
+       BOOST_CHECK_CLOSE (frc.speed_up, 1, 0.1);
 
-       best = best_dcp_frame_rate (14.5);
-       frc = FrameRateConversion (14.5, best);
+       content->_video_frame_rate = 14.5;
+       best = film->playlist()->best_dcp_frame_rate ();
+       frc = FrameRateChange (14.5, best);
        BOOST_CHECK_EQUAL (best, 30);
        BOOST_CHECK_EQUAL (frc.skip, false);
-       BOOST_CHECK_EQUAL (frc.repeat, true);
+       BOOST_CHECK_EQUAL (frc.repeat, 2);
        BOOST_CHECK_EQUAL (frc.change_speed, true);
+       BOOST_CHECK_CLOSE (frc.speed_up, 15 / 14.5, 0.1);
 
-       best = best_dcp_frame_rate (12.6);
-       frc = FrameRateConversion (12.6, best);
+       content->_video_frame_rate = 12.6;
+       best = film->playlist()->best_dcp_frame_rate ();
+       frc = FrameRateChange (12.6, best);
        BOOST_CHECK_EQUAL (best, 25);
        BOOST_CHECK_EQUAL (frc.skip, false);
-       BOOST_CHECK_EQUAL (frc.repeat, true);
+       BOOST_CHECK_EQUAL (frc.repeat, 2);
        BOOST_CHECK_EQUAL (frc.change_speed, true);
+       BOOST_CHECK_CLOSE (frc.speed_up, 25 / 25.2, 0.1);
 
-       best = best_dcp_frame_rate (12.4);
-       frc = FrameRateConversion (12.4, best);
+       content->_video_frame_rate = 12.4;
+       best = film->playlist()->best_dcp_frame_rate ();
+       frc = FrameRateChange (12.4, best);
        BOOST_CHECK_EQUAL (best, 25);
        BOOST_CHECK_EQUAL (frc.skip, false);
-       BOOST_CHECK_EQUAL (frc.repeat, true);
+       BOOST_CHECK_EQUAL (frc.repeat, 2);
        BOOST_CHECK_EQUAL (frc.change_speed, true);
+       BOOST_CHECK_CLOSE (frc.speed_up, 25 / 24.8, 0.1);
 
-       best = best_dcp_frame_rate (12);
-       frc = FrameRateConversion (12, best);
+       content->_video_frame_rate = 12;
+       best = film->playlist()->best_dcp_frame_rate ();
+       frc = FrameRateChange (12, best);
        BOOST_CHECK_EQUAL (best, 24);
        BOOST_CHECK_EQUAL (frc.skip, false);
-       BOOST_CHECK_EQUAL (frc.repeat, true);
+       BOOST_CHECK_EQUAL (frc.repeat, 2);
        BOOST_CHECK_EQUAL (frc.change_speed, false);
+       BOOST_CHECK_CLOSE (frc.speed_up, 1, 0.1);
 
        /* Now add some more rates and see if it will use them
           in preference to skip/repeat.
@@ -115,33 +158,40 @@ BOOST_AUTO_TEST_CASE (best_dcp_frame_rate_test)
        afr.push_back (60);
        Config::instance()->set_allowed_dcp_frame_rates (afr);
 
-       best = best_dcp_frame_rate (60);
-       frc = FrameRateConversion (60, best);
+       content->_video_frame_rate = 60;
+       best = film->playlist()->best_dcp_frame_rate ();
+       frc = FrameRateChange (60, best);
        BOOST_CHECK_EQUAL (best, 60);
        BOOST_CHECK_EQUAL (frc.skip, false);
-       BOOST_CHECK_EQUAL (frc.repeat, false);
+       BOOST_CHECK_EQUAL (frc.repeat, 1);
        BOOST_CHECK_EQUAL (frc.change_speed, false);
+       BOOST_CHECK_CLOSE (frc.speed_up, 1, 0.1);
        
-       best = best_dcp_frame_rate (50);
-       frc = FrameRateConversion (50, best);
+       content->_video_frame_rate = 50;
+       best = film->playlist()->best_dcp_frame_rate ();
+       frc = FrameRateChange (50, best);
        BOOST_CHECK_EQUAL (best, 50);
        BOOST_CHECK_EQUAL (frc.skip, false);
-       BOOST_CHECK_EQUAL (frc.repeat, false);
+       BOOST_CHECK_EQUAL (frc.repeat, 1);
        BOOST_CHECK_EQUAL (frc.change_speed, false);
+       BOOST_CHECK_CLOSE (frc.speed_up, 1, 0.1);
 
-       best = best_dcp_frame_rate (48);
-       frc = FrameRateConversion (48, best);
+       content->_video_frame_rate = 48;
+       best = film->playlist()->best_dcp_frame_rate ();
+       frc = FrameRateChange (48, best);
        BOOST_CHECK_EQUAL (best, 48);
        BOOST_CHECK_EQUAL (frc.skip, false);
-       BOOST_CHECK_EQUAL (frc.repeat, false);
+       BOOST_CHECK_EQUAL (frc.repeat, 1);
        BOOST_CHECK_EQUAL (frc.change_speed, false);
+       BOOST_CHECK_CLOSE (frc.speed_up, 1, 0.1);
 
        /* Check some out-there conversions (not the best) */
        
-       frc = FrameRateConversion (14.99, 24);
+       frc = FrameRateChange (14.99, 24);
        BOOST_CHECK_EQUAL (frc.skip, false);
-       BOOST_CHECK_EQUAL (frc.repeat, true);
+       BOOST_CHECK_EQUAL (frc.repeat, 2);
        BOOST_CHECK_EQUAL (frc.change_speed, true);
+       BOOST_CHECK_CLOSE (frc.speed_up, 24 / (2 * 14.99), 0.1);
 
        /* Check some conversions with limited DCP targets */
 
@@ -149,65 +199,97 @@ BOOST_AUTO_TEST_CASE (best_dcp_frame_rate_test)
        afr.push_back (24);
        Config::instance()->set_allowed_dcp_frame_rates (afr);
 
-       best = best_dcp_frame_rate (25);
-       frc = FrameRateConversion (25, best);
+       content->_video_frame_rate = 25;
+       best = film->playlist()->best_dcp_frame_rate ();
+       frc = FrameRateChange (25, best);
        BOOST_CHECK_EQUAL (best, 24);
        BOOST_CHECK_EQUAL (frc.skip, false);
-       BOOST_CHECK_EQUAL (frc.repeat, false);
+       BOOST_CHECK_EQUAL (frc.repeat, 1);
        BOOST_CHECK_EQUAL (frc.change_speed, true);
+       BOOST_CHECK_CLOSE (frc.speed_up, 24.0 / 25, 0.1);
 }
 
-BOOST_AUTO_TEST_CASE (audio_sampling_rate_test)
+/* Test Playlist::best_dcp_frame_rate and FrameRateChange
+   with two pieces of content.
+*/
+BOOST_AUTO_TEST_CASE (best_dcp_frame_rate_test_double)
 {
+       shared_ptr<Film> film = new_test_film ("best_dcp_frame_rate_test_double");
+       /* Get any old content, it doesn't matter what */
+       shared_ptr<FFmpegContent> A (new FFmpegContent (film, "test/data/test.mp4"));
+       film->add_content (A);
+       shared_ptr<FFmpegContent> B (new FFmpegContent (film, "test/data/test.mp4"));
+       film->add_content (B);
+       wait_for_jobs ();
+
+       /* Run some tests with a limited range of allowed rates */
+       
        std::list<int> afr;
        afr.push_back (24);
        afr.push_back (25);
        afr.push_back (30);
        Config::instance()->set_allowed_dcp_frame_rates (afr);
 
-       shared_ptr<Film> f = new_test_film ("audio_sampling_rate_test");
-       f->set_source_frame_rate (24);
-       f->set_dcp_frame_rate (24);
+       A->_video_frame_rate = 30;
+       B->_video_frame_rate = 24;
+       BOOST_CHECK_EQUAL (film->playlist()->best_dcp_frame_rate(), 25);
+}
+
+
+BOOST_AUTO_TEST_CASE (audio_sampling_rate_test)
+{
+       shared_ptr<Film> film = new_test_film ("audio_sampling_rate_test");
+       /* Get any piece of content, it doesn't matter what */
+       shared_ptr<FFmpegContent> content (new FFmpegContent (film, "test/data/test.mp4"));
+       film->add_content (content);
+       wait_for_jobs ();
+       
+       std::list<int> afr;
+       afr.push_back (24);
+       afr.push_back (25);
+       afr.push_back (30);
+       Config::instance()->set_allowed_dcp_frame_rates (afr);
 
-       f->set_content_audio_stream (shared_ptr<AudioStream> (new FFmpegAudioStream ("a", 42, 48000, 0)));
-       BOOST_CHECK_EQUAL (f->target_audio_sample_rate(), 48000);
+       content->_video_frame_rate = 24;
+       film->set_video_frame_rate (24);
+       content->set_audio_stream (shared_ptr<FFmpegAudioStream> (new FFmpegAudioStream ("a", 42, 48000, 0)));
+       BOOST_CHECK_EQUAL (content->output_audio_frame_rate(), 48000);
 
-       f->set_content_audio_stream (shared_ptr<AudioStream> (new FFmpegAudioStream ("a", 42, 44100, 0)));
-       BOOST_CHECK_EQUAL (f->target_audio_sample_rate(), 48000);
+       content->set_audio_stream (shared_ptr<FFmpegAudioStream> (new FFmpegAudioStream ("a", 42, 44100, 0)));
+       BOOST_CHECK_EQUAL (content->output_audio_frame_rate(), 48000);
 
-       f->set_content_audio_stream (shared_ptr<AudioStream> (new FFmpegAudioStream ("a", 42, 80000, 0)));
-       BOOST_CHECK_EQUAL (f->target_audio_sample_rate(), 96000);
+       content->set_audio_stream (shared_ptr<FFmpegAudioStream> (new FFmpegAudioStream ("a", 42, 80000, 0)));
+       BOOST_CHECK_EQUAL (content->output_audio_frame_rate(), 96000);
 
-       f->set_source_frame_rate (23.976);
-       f->set_dcp_frame_rate (best_dcp_frame_rate (23.976));
-       f->set_content_audio_stream (shared_ptr<AudioStream> (new FFmpegAudioStream ("a", 42, 48000, 0)));
-       BOOST_CHECK_EQUAL (f->target_audio_sample_rate(), 47952);
+       content->_video_frame_rate = 23.976;
+       film->set_video_frame_rate (24);
+       content->set_audio_stream (shared_ptr<FFmpegAudioStream> (new FFmpegAudioStream ("a", 42, 48000, 0)));
+       BOOST_CHECK_EQUAL (content->output_audio_frame_rate(), 47952);
 
-       f->set_source_frame_rate (29.97);
-       f->set_dcp_frame_rate (best_dcp_frame_rate (29.97));
-       BOOST_CHECK_EQUAL (f->dcp_frame_rate (), 30);
-       f->set_content_audio_stream (shared_ptr<AudioStream> (new FFmpegAudioStream ("a", 42, 48000, 0)));
-       BOOST_CHECK_EQUAL (f->target_audio_sample_rate(), 47952);
+       content->_video_frame_rate = 29.97;
+       film->set_video_frame_rate (30);
+       BOOST_CHECK_EQUAL (film->video_frame_rate (), 30);
+       content->set_audio_stream (shared_ptr<FFmpegAudioStream> (new FFmpegAudioStream ("a", 42, 48000, 0)));
+       BOOST_CHECK_EQUAL (content->output_audio_frame_rate(), 47952);
 
-       f->set_source_frame_rate (25);
-       f->set_dcp_frame_rate (24);
-       f->set_content_audio_stream (shared_ptr<AudioStream> (new FFmpegAudioStream ("a", 42, 48000, 0)));
-       BOOST_CHECK_EQUAL (f->target_audio_sample_rate(), 50000);
+       content->_video_frame_rate = 25;
+       film->set_video_frame_rate (24);
+       content->set_audio_stream (shared_ptr<FFmpegAudioStream> (new FFmpegAudioStream ("a", 42, 48000, 0)));
+       BOOST_CHECK_EQUAL (content->output_audio_frame_rate(), 50000);
 
-       f->set_source_frame_rate (25);
-       f->set_dcp_frame_rate (24);
-       f->set_content_audio_stream (shared_ptr<AudioStream> (new FFmpegAudioStream ("a", 42, 44100, 0)));
-       BOOST_CHECK_EQUAL (f->target_audio_sample_rate(), 50000);
+       content->_video_frame_rate = 25;
+       film->set_video_frame_rate (24);
+       content->set_audio_stream (shared_ptr<FFmpegAudioStream> (new FFmpegAudioStream ("a", 42, 44100, 0)));
+       BOOST_CHECK_EQUAL (content->output_audio_frame_rate(), 50000);
 
        /* Check some out-there conversions (not the best) */
        
-       f->set_source_frame_rate (14.99);
-       f->set_dcp_frame_rate (25);
-       f->set_content_audio_stream (shared_ptr<AudioStream> (new FFmpegAudioStream ("a", 42, 16000, 0)));
-       /* The FrameRateConversion within target_audio_sample_rate should choose to double-up
+       content->_video_frame_rate = 14.99;
+       film->set_video_frame_rate (25);
+       content->set_audio_stream (shared_ptr<FFmpegAudioStream> (new FFmpegAudioStream ("a", 42, 16000, 0)));
+       /* The FrameRateChange within output_audio_frame_rate should choose to double-up
           the 14.99 fps video to 30 and then run it slow at 25.
        */
-       BOOST_CHECK_EQUAL (f->target_audio_sample_rate(), rint (48000 * 2 * 14.99 / 25));
-#endif 
+       BOOST_CHECK_EQUAL (content->output_audio_frame_rate(), rint (48000 * 2 * 14.99 / 25));
 }