2 Copyright (C) 2014-2018 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/player_test.cc
22 * @brief Test Player class.
23 * @ingroup selfcontained
27 #include "lib/ffmpeg_content.h"
28 #include "lib/dcp_content_type.h"
29 #include "lib/ratio.h"
30 #include "lib/audio_buffers.h"
31 #include "lib/player.h"
32 #include "lib/video_content.h"
33 #include "lib/image_content.h"
34 #include "lib/plain_text_content.h"
35 #include "lib/content_factory.h"
36 #include "lib/dcp_content.h"
37 #include "lib/text_content.h"
38 #include "lib/butler.h"
39 #include "lib/compose.hpp"
41 #include <boost/test/unit_test.hpp>
47 using boost::shared_ptr;
49 using boost::optional;
51 static shared_ptr<AudioBuffers> accumulated;
54 accumulate (shared_ptr<AudioBuffers> audio, DCPTime)
56 BOOST_REQUIRE (accumulated);
57 accumulated->append (audio);
60 /** Check that the Player correctly generates silence when used with a silent FFmpegContent */
61 BOOST_AUTO_TEST_CASE (player_silence_padding_test)
63 shared_ptr<Film> film = new_test_film ("player_silence_padding_test");
64 film->set_name ("player_silence_padding_test");
65 shared_ptr<FFmpegContent> c (new FFmpegContent (film, "test/data/test.mp4"));
66 film->set_container (Ratio::from_id ("185"));
67 film->set_audio_channels (6);
69 film->examine_and_add_content (c);
72 accumulated.reset (new AudioBuffers (film->audio_channels(), 0));
74 shared_ptr<Player> player (new Player (film, film->playlist ()));
75 player->Audio.connect (bind (&accumulate, _1, _2));
76 while (!player->pass ()) {}
77 BOOST_REQUIRE (accumulated->frames() >= 48000);
78 BOOST_CHECK_EQUAL (accumulated->channels(), film->audio_channels ());
80 for (int i = 0; i < 48000; ++i) {
81 for (int c = 0; c < accumulated->channels(); ++c) {
82 BOOST_CHECK_EQUAL (accumulated->data()[c][i], 0);
87 /* Test insertion of black frames between separate bits of video content */
88 BOOST_AUTO_TEST_CASE (player_black_fill_test)
90 shared_ptr<Film> film = new_test_film ("black_fill_test");
91 film->set_dcp_content_type (DCPContentType::from_isdcf_name ("FTR"));
92 film->set_name ("black_fill_test");
93 film->set_container (Ratio::from_id ("185"));
94 film->set_sequence (false);
95 film->set_interop (false);
96 shared_ptr<ImageContent> contentA (new ImageContent (film, "test/data/simple_testcard_640x480.png"));
97 shared_ptr<ImageContent> contentB (new ImageContent (film, "test/data/simple_testcard_640x480.png"));
99 film->examine_and_add_content (contentA);
100 film->examine_and_add_content (contentB);
103 contentA->video->set_scale (VideoContentScale (Ratio::from_id ("185")));
104 contentA->video->set_length (3);
105 contentA->set_position (DCPTime::from_frames (2, film->video_frame_rate ()));
106 contentB->video->set_scale (VideoContentScale (Ratio::from_id ("185")));
107 contentB->video->set_length (1);
108 contentB->set_position (DCPTime::from_frames (7, film->video_frame_rate ()));
114 boost::filesystem::path ref;
117 ref /= "black_fill_test";
119 boost::filesystem::path check;
122 check /= "black_fill_test";
123 check /= film->dcp_name();
125 check_dcp (ref.string(), check.string());
128 /** Check behaviour with an awkward playlist whose data does not end on a video frame start */
129 BOOST_AUTO_TEST_CASE (player_subframe_test)
131 shared_ptr<Film> film = new_test_film ("reels_test7");
132 film->set_name ("reels_test7");
133 film->set_container (Ratio::from_id ("185"));
134 film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TST"));
135 shared_ptr<Content> A = content_factory(film, "test/data/flat_red.png").front();
136 film->examine_and_add_content (A);
137 BOOST_REQUIRE (!wait_for_jobs ());
138 shared_ptr<Content> B = content_factory(film, "test/data/awkward_length.wav").front();
139 film->examine_and_add_content (B);
140 BOOST_REQUIRE (!wait_for_jobs ());
141 film->set_video_frame_rate (24);
142 A->video->set_length (3 * 24);
144 BOOST_CHECK (A->full_length() == DCPTime::from_frames(3 * 24, 24));
145 BOOST_CHECK (B->full_length() == DCPTime(289920));
146 /* Length should be rounded up from B's length to the next video frame */
147 BOOST_CHECK (film->length() == DCPTime::from_frames(3 * 24 + 1, 24));
149 shared_ptr<Player> player (new Player (film, film->playlist ()));
150 player->setup_pieces ();
151 BOOST_REQUIRE_EQUAL (player->_black._periods.size(), 1);
152 BOOST_CHECK (player->_black._periods.front() == DCPTimePeriod(DCPTime::from_frames(3 * 24, 24), DCPTime::from_frames(3 * 24 + 1, 24)));
153 BOOST_REQUIRE_EQUAL (player->_silent._periods.size(), 1);
154 BOOST_CHECK (player->_silent._periods.front() == DCPTimePeriod(DCPTime(289920), DCPTime::from_frames(3 * 24 + 1, 24)));
157 static Frame video_frames;
158 static Frame audio_frames;
161 video (shared_ptr<PlayerVideo>, DCPTime)
167 audio (shared_ptr<AudioBuffers> audio, DCPTime)
169 audio_frames += audio->frames();
172 /** Check with a video-only file that the video and audio emissions happen more-or-less together */
173 BOOST_AUTO_TEST_CASE (player_interleave_test)
175 shared_ptr<Film> film = new_test_film ("ffmpeg_transcoder_basic_test_subs");
176 film->set_name ("ffmpeg_transcoder_basic_test");
177 film->set_container (Ratio::from_id ("185"));
178 film->set_audio_channels (6);
180 shared_ptr<FFmpegContent> c (new FFmpegContent (film, "test/data/test.mp4"));
181 film->examine_and_add_content (c);
182 BOOST_REQUIRE (!wait_for_jobs ());
184 shared_ptr<PlainTextContent> s (new PlainTextContent (film, "test/data/subrip.srt"));
185 film->examine_and_add_content (s);
186 BOOST_REQUIRE (!wait_for_jobs ());
188 shared_ptr<Player> player (new Player(film, film->playlist()));
189 player->Video.connect (bind (&video, _1, _2));
190 player->Audio.connect (bind (&audio, _1, _2));
191 video_frames = audio_frames = 0;
192 while (!player->pass ()) {
193 BOOST_CHECK (abs(video_frames - (audio_frames / 2000)) < 8);
198 note_handler (dcp::NoteType, std::string)
203 /** Test some seeks towards the start of a DCP with awkward subtitles; see mantis #1085
204 * and a number of others. I thought this was a player seek bug but in fact it was
205 * caused by the subtitle starting just after the start of the video frame and hence
208 BOOST_AUTO_TEST_CASE (player_seek_test)
210 shared_ptr<Film> film (new Film (optional<boost::filesystem::path>()));
211 shared_ptr<DCPContent> dcp (new DCPContent (film, private_data / "awkward_subs"));
212 film->examine_and_add_content (dcp, true);
213 BOOST_REQUIRE (!wait_for_jobs ());
214 dcp->subtitle->set_use (true);
216 shared_ptr<Player> player (new Player (film, film->playlist()));
218 player->set_always_burn_subtitles (true);
219 player->set_play_referenced ();
221 shared_ptr<Butler> butler (new Butler (player, film->log(), AudioMapping(), 2));
222 butler->disable_audio();
224 for (int i = 0; i < 10; ++i) {
225 DCPTime t = DCPTime::from_frames (i, 24);
226 butler->seek (t, true);
227 pair<shared_ptr<PlayerVideo>, DCPTime> video = butler->get_video();
228 BOOST_CHECK_EQUAL(video.second.get(), t.get());
229 write_image(video.first->image(note_handler, PlayerVideo::always_rgb, false, true), String::compose("build/test/player_seek_test_%1.png", i), "RGB");
230 /* This 0.011 is empirically chosen (hopefully) to accept changes in rendering between the reference and a test machine
231 (17.10 and 16.04 seem to anti-alias a little differently) but to reject gross errors e.g. missing fonts or missing
234 check_image(String::compose("test/data/player_seek_test_%1.png", i), String::compose("build/test/player_seek_test_%1.png", i), 0.011);
238 /** Test some more seeks towards the start of a DCP with awkward subtitles */
239 BOOST_AUTO_TEST_CASE (player_seek_test2)
241 shared_ptr<Film> film (new Film (optional<boost::filesystem::path>()));
242 shared_ptr<DCPContent> dcp (new DCPContent (film, private_data / "awkward_subs2"));
243 film->examine_and_add_content (dcp, true);
244 BOOST_REQUIRE (!wait_for_jobs ());
245 dcp->subtitle->set_use (true);
247 shared_ptr<Player> player (new Player (film, film->playlist()));
249 player->set_always_burn_subtitles (true);
250 player->set_play_referenced ();
252 shared_ptr<Butler> butler (new Butler (player, film->log(), AudioMapping(), 2));
253 butler->disable_audio();
255 butler->seek(DCPTime::from_seconds(5), true);
257 for (int i = 0; i < 10; ++i) {
258 DCPTime t = DCPTime::from_seconds(5) + DCPTime::from_frames (i, 24);
259 butler->seek (t, true);
260 pair<shared_ptr<PlayerVideo>, DCPTime> video = butler->get_video();
261 BOOST_CHECK_EQUAL(video.second.get(), t.get());
262 write_image(video.first->image(note_handler, PlayerVideo::always_rgb, false, true), String::compose("build/test/player_seek_test2_%1.png", i), "RGB");
263 check_image(String::compose("test/data/player_seek_test2_%1.png", i), String::compose("build/test/player_seek_test2_%1.png", i), 0.011);
267 /** Test a bug when trimmed content follows other content */
268 BOOST_AUTO_TEST_CASE (player_trim_test)
270 shared_ptr<Film> film = new_test_film2 ("player_trim_test");
271 shared_ptr<Content> A = content_factory(film, "test/data/flat_red.png").front();
272 film->examine_and_add_content (A);
273 BOOST_REQUIRE (!wait_for_jobs ());
274 A->video->set_length (10 * 24);
275 shared_ptr<Content> B = content_factory(film, "test/data/flat_red.png").front();
276 film->examine_and_add_content (B);
277 BOOST_REQUIRE (!wait_for_jobs ());
278 B->video->set_length (10 * 24);
279 B->set_position (DCPTime::from_seconds (10));
280 B->set_trim_start (ContentTime::from_seconds (2));
283 BOOST_REQUIRE (!wait_for_jobs ());