df809bb1510097b041ff4db9600cc5adf0912413
[dcpomatic.git] / test / audio_analysis_test.cc
1 /*
2     Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
3
4     This file is part of DCP-o-matic.
5
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.
10
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.
15
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/>.
18
19 */
20
21
22 /** @defgroup selfcontained Self-contained tests of single classes / method sets */
23
24 /** @file  test/audio_analysis_test.cc
25  *  @brief Test AudioAnalysis class.
26  *  @ingroup selfcontained
27  */
28
29
30 #include "lib/analyse_audio_job.h"
31 #include "lib/audio_analysis.h"
32 #include "lib/audio_content.h"
33 #include "lib/content_factory.h"
34 #include "lib/dcp_content_type.h"
35 #include "lib/ffmpeg_content.h"
36 #include "lib/ffmpeg_content.h"
37 #include "lib/film.h"
38 #include "lib/job_manager.h"
39 #include "lib/playlist.h"
40 #include "lib/ratio.h"
41 #include "test.h"
42 #include <boost/test/unit_test.hpp>
43
44
45 using std::make_shared;
46 using std::vector;
47 using namespace dcpomatic;
48
49
50 BOOST_AUTO_TEST_CASE (audio_analysis_serialisation_test)
51 {
52         int const channels = 3;
53         int const points = 4096;
54
55         auto random_float = []() {
56                 return (float (rand ()) / RAND_MAX) * 2 - 1;
57         };
58
59         AudioAnalysis a (3);
60         for (int i = 0; i < channels; ++i) {
61                 for (int j = 0; j < points; ++j) {
62                         AudioPoint p;
63                         p[AudioPoint::PEAK] = random_float ();
64                         p[AudioPoint::RMS] = random_float ();
65                         a.add_point (i, p);
66                 }
67         }
68
69         vector<AudioAnalysis::PeakTime> peak;
70         for (int i = 0; i < channels; ++i) {
71                 peak.push_back (AudioAnalysis::PeakTime(random_float(), DCPTime(rand())));
72         }
73         a.set_sample_peak (peak);
74
75         a.set_samples_per_point (100);
76         a.set_sample_rate (48000);
77         a.write ("build/test/audio_analysis_serialisation_test");
78
79         AudioAnalysis b ("build/test/audio_analysis_serialisation_test");
80         for (int i = 0; i < channels; ++i) {
81                 BOOST_CHECK_EQUAL (b.points(i), points);
82                 for (int j = 0; j < points; ++j) {
83                         AudioPoint p = a.get_point (i, j);
84                         AudioPoint q = b.get_point (i, j);
85                         BOOST_CHECK_CLOSE (p[AudioPoint::PEAK], q[AudioPoint::PEAK], 1);
86                         BOOST_CHECK_CLOSE (p[AudioPoint::RMS],  q[AudioPoint::RMS], 1);
87                 }
88         }
89
90         BOOST_REQUIRE_EQUAL (b.sample_peak().size(), 3U);
91         for (int i = 0; i < channels; ++i) {
92                 BOOST_CHECK_CLOSE (b.sample_peak()[i].peak, peak[i].peak, 1);
93                 BOOST_CHECK_EQUAL (b.sample_peak()[i].time.get(), peak[i].time.get());
94         }
95
96         BOOST_CHECK_EQUAL (a.samples_per_point(), 100);
97         BOOST_CHECK_EQUAL (a.sample_rate(), 48000);
98 }
99
100
101 BOOST_AUTO_TEST_CASE (audio_analysis_test)
102 {
103         auto film = new_test_film ("audio_analysis_test");
104         film->set_dcp_content_type (DCPContentType::from_isdcf_name("FTR"));
105         film->set_container (Ratio::from_id("185"));
106         film->set_name ("audio_analysis_test");
107         boost::filesystem::path p = TestPaths::private_data() / "betty_L.wav";
108
109         auto c = make_shared<FFmpegContent>(p);
110         film->examine_and_add_content (c);
111         BOOST_REQUIRE (!wait_for_jobs());
112
113         auto job = make_shared<AnalyseAudioJob>(film, film->playlist(), false);
114         JobManager::instance()->add (job);
115         BOOST_REQUIRE (!wait_for_jobs());
116 }
117
118
119 /** Check that audio analysis works (i.e. runs without error) with a -ve delay */
120 BOOST_AUTO_TEST_CASE (audio_analysis_negative_delay_test)
121 {
122         auto film = new_test_film ("audio_analysis_negative_delay_test");
123         film->set_name ("audio_analysis_negative_delay_test");
124         auto c = make_shared<FFmpegContent>(TestPaths::private_data() / "boon_telly.mkv");
125         film->examine_and_add_content (c);
126         BOOST_REQUIRE (!wait_for_jobs());
127
128         c->audio->set_delay (-250);
129
130         auto job = make_shared<AnalyseAudioJob>(film, film->playlist(), false);
131         JobManager::instance()->add (job);
132         BOOST_REQUIRE (!wait_for_jobs());
133 }
134
135
136 /** Check audio analysis that is incorrect in 2e98263 */
137 BOOST_AUTO_TEST_CASE (audio_analysis_test2)
138 {
139         auto film = new_test_film ("audio_analysis_test2");
140         film->set_name ("audio_analysis_test2");
141         auto c = make_shared<FFmpegContent>(TestPaths::private_data() / "3d_thx_broadway_2010_lossless.m2ts");
142         film->examine_and_add_content (c);
143         BOOST_REQUIRE (!wait_for_jobs());
144
145         auto job = make_shared<AnalyseAudioJob>(film, film->playlist(), false);
146         JobManager::instance()->add (job);
147         BOOST_REQUIRE (!wait_for_jobs());
148 }
149
150
151 static bool done = false;
152
153 static void
154 analysis_finished ()
155 {
156         done = true;
157 }
158
159
160 /* Test a case which was reported to throw an exception; analysing
161  * a 12-channel DCP's audio.
162  */
163 BOOST_AUTO_TEST_CASE (audio_analysis_test3)
164 {
165         auto film = new_test_film ("analyse_audio_test");
166         film->set_container (Ratio::from_id ("185"));
167         film->set_dcp_content_type (DCPContentType::from_isdcf_name("TLR"));
168         film->set_name ("frobozz");
169
170         auto content = make_shared<FFmpegContent>("test/data/white.wav");
171         film->examine_and_add_content (content);
172         BOOST_REQUIRE (!wait_for_jobs());
173
174         film->set_audio_channels (12);
175         boost::signals2::connection connection;
176         JobManager::instance()->analyse_audio(film, film->playlist(), false, connection, boost::bind(&analysis_finished));
177         BOOST_REQUIRE (!wait_for_jobs());
178         BOOST_CHECK (done);
179 }
180
181
182 /** Run an audio analysis that triggered an exception in the audio decoder at one point */
183 BOOST_AUTO_TEST_CASE (analyse_audio_test4)
184 {
185         auto film = new_test_film ("analyse_audio_test");
186         film->set_container (Ratio::from_id ("185"));
187         film->set_dcp_content_type (DCPContentType::from_isdcf_name("TLR"));
188         film->set_name ("frobozz");
189         auto content = content_factory(TestPaths::private_data() / "20 The Wedding Convoy Song.m4a")[0];
190         film->examine_and_add_content (content);
191         BOOST_REQUIRE (!wait_for_jobs());
192
193         auto playlist = make_shared<Playlist>();
194         playlist->add (film, content);
195         boost::signals2::connection c;
196         JobManager::instance()->analyse_audio(film, playlist, false, c, []() {});
197         BOOST_CHECK (!wait_for_jobs ());
198 }
199
200
201 BOOST_AUTO_TEST_CASE (analyse_audio_leqm_test)
202 {
203         auto film = new_test_film2 ("analyse_audio_leqm_test");
204         film->set_audio_channels (2);
205         auto content = content_factory(TestPaths::private_data() / "betty_stereo_48k.wav")[0];
206         film->examine_and_add_content (content);
207         BOOST_REQUIRE (!wait_for_jobs());
208
209         auto playlist = make_shared<Playlist>();
210         playlist->add (film, content);
211         boost::signals2::connection c;
212         JobManager::instance()->analyse_audio(film, playlist, false, c, []() {});
213         BOOST_CHECK (!wait_for_jobs());
214
215         AudioAnalysis analysis(film->audio_analysis_path(playlist));
216
217         /* The CLI tool of leqm_nrt gives this value for betty_stereo_48k.wav */
218         BOOST_CHECK_CLOSE (analysis.leqm().get_value_or(0), 88.276, 0.001);
219 }
220
221
222 /** Bug #2364; a file with a lot of silent video at the end (about 50s worth)
223  *  crashed the audio analysis with an OOM on Windows.
224  */
225 BOOST_AUTO_TEST_CASE(analyse_audio_with_long_silent_end)
226 {
227         auto content = content_factory(TestPaths::private_data() / "2364.mkv")[0];
228         auto film = new_test_film2("analyse_audio_with_long_silent_end", { content });
229
230         auto playlist = make_shared<Playlist>();
231         playlist->add(film, content);
232         boost::signals2::connection c;
233         JobManager::instance()->analyse_audio(film, playlist, false, c, []() {});
234         BOOST_CHECK(!wait_for_jobs());
235 }