Clarify some documentation slightly.
[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.h"
35 #include "lib/dcp_content_type.h"
36 #include "lib/ffmpeg_content.h"
37 #include "lib/ffmpeg_content.h"
38 #include "lib/film.h"
39 #include "lib/job_manager.h"
40 #include "lib/playlist.h"
41 #include "lib/ratio.h"
42 #include "test.h"
43 #include <boost/test/unit_test.hpp>
44 #include <numeric>
45
46
47 using std::make_shared;
48 using std::vector;
49 using namespace dcpomatic;
50
51
52 BOOST_AUTO_TEST_CASE (audio_analysis_serialisation_test)
53 {
54         int const channels = 3;
55         int const points = 4096;
56
57         auto random_float = []() {
58                 return (float (rand ()) / RAND_MAX) * 2 - 1;
59         };
60
61         AudioAnalysis a (3);
62         for (int i = 0; i < channels; ++i) {
63                 for (int j = 0; j < points; ++j) {
64                         AudioPoint p;
65                         p[AudioPoint::PEAK] = random_float ();
66                         p[AudioPoint::RMS] = random_float ();
67                         a.add_point (i, p);
68                 }
69         }
70
71         vector<AudioAnalysis::PeakTime> peak;
72         for (int i = 0; i < channels; ++i) {
73                 peak.push_back (AudioAnalysis::PeakTime(random_float(), DCPTime(rand())));
74         }
75         a.set_sample_peak (peak);
76
77         a.set_samples_per_point (100);
78         a.set_sample_rate (48000);
79         a.write ("build/test/audio_analysis_serialisation_test");
80
81         AudioAnalysis b ("build/test/audio_analysis_serialisation_test");
82         for (int i = 0; i < channels; ++i) {
83                 BOOST_CHECK_EQUAL (b.points(i), points);
84                 for (int j = 0; j < points; ++j) {
85                         AudioPoint p = a.get_point (i, j);
86                         AudioPoint q = b.get_point (i, j);
87                         BOOST_CHECK_CLOSE (p[AudioPoint::PEAK], q[AudioPoint::PEAK], 1);
88                         BOOST_CHECK_CLOSE (p[AudioPoint::RMS],  q[AudioPoint::RMS], 1);
89                 }
90         }
91
92         BOOST_REQUIRE_EQUAL (b.sample_peak().size(), 3U);
93         for (int i = 0; i < channels; ++i) {
94                 BOOST_CHECK_CLOSE (b.sample_peak()[i].peak, peak[i].peak, 1);
95                 BOOST_CHECK_EQUAL (b.sample_peak()[i].time.get(), peak[i].time.get());
96         }
97
98         BOOST_CHECK_EQUAL (a.samples_per_point(), 100);
99         BOOST_CHECK_EQUAL (a.sample_rate(), 48000);
100 }
101
102
103 BOOST_AUTO_TEST_CASE (audio_analysis_test)
104 {
105         auto c = make_shared<FFmpegContent>(TestPaths::private_data() / "betty_L.wav");
106         auto film = new_test_film("audio_analysis_test", { c });
107
108         auto job = make_shared<AnalyseAudioJob>(film, film->playlist(), false);
109         JobManager::instance()->add (job);
110         BOOST_REQUIRE (!wait_for_jobs());
111 }
112
113
114 /** Check that audio analysis works (i.e. runs without error) with a -ve delay */
115 BOOST_AUTO_TEST_CASE (audio_analysis_negative_delay_test)
116 {
117         auto c = make_shared<FFmpegContent>(TestPaths::private_data() / "boon_telly.mkv");
118         auto film = new_test_film("audio_analysis_negative_delay_test", { c });
119         c->audio->set_delay (-250);
120
121         auto job = make_shared<AnalyseAudioJob>(film, film->playlist(), false);
122         JobManager::instance()->add (job);
123         BOOST_REQUIRE (!wait_for_jobs());
124 }
125
126
127 /** Check audio analysis that is incorrect in 2e98263 */
128 BOOST_AUTO_TEST_CASE (audio_analysis_test2)
129 {
130         auto c = make_shared<FFmpegContent>(TestPaths::private_data() / "3d_thx_broadway_2010_lossless.m2ts");
131         auto film = new_test_film("audio_analysis_test2", { c });
132
133         auto job = make_shared<AnalyseAudioJob>(film, film->playlist(), false);
134         JobManager::instance()->add (job);
135         BOOST_REQUIRE (!wait_for_jobs());
136 }
137
138
139 /* Test a case which was reported to throw an exception; analysing
140  * a 12-channel DCP's audio.
141  */
142 BOOST_AUTO_TEST_CASE (audio_analysis_test3)
143 {
144         auto content = make_shared<FFmpegContent>("test/data/white.wav");
145         auto film = new_test_film("analyse_audio_test", { content });
146         film->set_audio_channels (12);
147
148         boost::signals2::connection connection;
149         bool done = false;
150         JobManager::instance()->analyse_audio(film, film->playlist(), false, connection, [&done](Job::Result) { done = true; });
151         BOOST_REQUIRE (!wait_for_jobs());
152         BOOST_CHECK (done);
153 }
154
155
156 /** Run an audio analysis that triggered an exception in the audio decoder at one point */
157 BOOST_AUTO_TEST_CASE (analyse_audio_test4)
158 {
159         auto content = content_factory(TestPaths::private_data() / "20 The Wedding Convoy Song.m4a")[0];
160         auto film = new_test_film("analyse_audio_test", { content });
161
162         auto playlist = make_shared<Playlist>();
163         playlist->add (film, content);
164         boost::signals2::connection c;
165         JobManager::instance()->analyse_audio(film, playlist, false, c, [](Job::Result) {});
166         BOOST_CHECK (!wait_for_jobs ());
167 }
168
169
170 BOOST_AUTO_TEST_CASE (analyse_audio_leqm_test)
171 {
172         auto film = new_test_film("analyse_audio_leqm_test");
173         film->set_audio_channels (2);
174         auto content = content_factory(TestPaths::private_data() / "betty_stereo_48k.wav")[0];
175         film->examine_and_add_content (content);
176         BOOST_REQUIRE (!wait_for_jobs());
177
178         auto playlist = make_shared<Playlist>();
179         playlist->add (film, content);
180         boost::signals2::connection c;
181         JobManager::instance()->analyse_audio(film, playlist, false, c, [](Job::Result) {});
182         BOOST_CHECK (!wait_for_jobs());
183
184         AudioAnalysis analysis(film->audio_analysis_path(playlist));
185
186         /* The CLI tool of leqm_nrt gives this value for betty_stereo_48k.wav */
187         BOOST_CHECK_CLOSE (analysis.leqm().get_value_or(0), 88.276, 0.001);
188 }
189
190
191 BOOST_AUTO_TEST_CASE(analyse_audio_leqm_same_with_empty_channels)
192 {
193         auto dcp = make_shared<DCPContent>(TestPaths::private_data() / "JourneyToJah_TLR-1_F_EN-DE-FR_CH_51_2K_LOK_20140225_DGL_SMPTE_OV");
194         auto film = new_test_film("analyse_audio_leqm_test2", { dcp });
195         film->set_audio_channels(8);
196
197         auto analyse = [film, dcp](int channels) {
198                 film->set_audio_channels(channels);
199                 auto playlist = make_shared<Playlist>();
200                 playlist->add(film, dcp);
201                 boost::signals2::connection c;
202                 JobManager::instance()->analyse_audio(film, playlist, false, c, [](Job::Result) {});
203                 BOOST_CHECK(!wait_for_jobs());
204                 AudioAnalysis analysis(film->audio_analysis_path(playlist));
205                 return analysis.leqm().get_value_or(0);
206         };
207
208         BOOST_CHECK_CLOSE(analyse( 6), 84.51411, 0.001);
209         BOOST_CHECK_CLOSE(analyse( 8), 84.51411, 0.001);
210         BOOST_CHECK_CLOSE(analyse(16), 84.51411, 0.001);
211 }
212
213
214 /** Bug #2364; a file with a lot of silent video at the end (about 50s worth)
215  *  crashed the audio analysis with an OOM on Windows.
216  */
217 BOOST_AUTO_TEST_CASE(analyse_audio_with_long_silent_end)
218 {
219         auto content = content_factory(TestPaths::private_data() / "2364.mkv")[0];
220         auto film = new_test_film("analyse_audio_with_long_silent_end", { content });
221
222         auto playlist = make_shared<Playlist>();
223         playlist->add(film, content);
224         boost::signals2::connection c;
225         JobManager::instance()->analyse_audio(film, playlist, false, c, [](Job::Result) {});
226         BOOST_CHECK(!wait_for_jobs());
227 }
228
229
230 BOOST_AUTO_TEST_CASE(analyse_audio_with_strange_channel_count)
231 {
232         auto content = content_factory(TestPaths::private_data() / "mali.mkv")[0];
233         auto film = new_test_film("analyse_audio_with_strange_channel_count", { content });
234
235         auto playlist = make_shared<Playlist>();
236         playlist->add(film, content);
237         boost::signals2::connection c;
238         JobManager::instance()->analyse_audio(film, playlist, false, c, [](Job::Result) {});
239         BOOST_CHECK(!wait_for_jobs());
240 }
241
242
243 BOOST_AUTO_TEST_CASE(analyse_audio_with_more_channels_than_film)
244 {
245         auto picture = content_factory("test/data/flat_red.png");
246         auto film_16ch = new_test_film("analyse_audio_with_more_channels_than_film_16ch", picture);
247         film_16ch->set_audio_channels(16);
248         make_and_verify_dcp(film_16ch);
249
250         auto pcm_16ch = find_file(film_16ch->dir(film_16ch->dcp_name()), "pcm_");
251         auto sound = content_factory(pcm_16ch)[0];
252
253         auto film_6ch = new_test_film("analyse_audio_with_more_channels_than_film_6ch", { sound });
254
255         auto playlist = make_shared<Playlist>();
256         playlist->add(film_6ch, sound);
257         boost::signals2::connection c;
258         JobManager::instance()->analyse_audio(film_6ch, playlist, false, c, [](Job::Result) {});
259         BOOST_CHECK(!wait_for_jobs());
260 }
261
262
263 BOOST_AUTO_TEST_CASE(analyse_audio_uses_processor_when_analysing_whole_film)
264 {
265         auto sound = content_factory(TestPaths::private_data() / "betty_stereo.wav")[0];
266         auto film = new_test_film("analyse_audio_uses_processor_when_analysing_whole_film", { sound });
267
268         auto job = make_shared<AnalyseAudioJob>(film, film->playlist(), true);
269         JobManager::instance()->add(job);
270         BOOST_REQUIRE(!wait_for_jobs());
271
272         AudioAnalysis analysis(job->path());
273
274         BOOST_REQUIRE(analysis.channels() > 2);
275         bool centre_non_zero = false;
276         /* Make sure there's something from the mid-side decoder on the centre channel */
277         for (auto point = 0; point < analysis.points(2); ++point) {
278                 if (std::abs(analysis.get_point(2, point)[AudioPoint::Type::PEAK]) > 0) {
279                         centre_non_zero = true;
280                 }
281         }
282
283         BOOST_CHECK(centre_non_zero);
284 }
285