2 Copyright (C) 2017-2021 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/>.
22 #include "lib/audio_content.h"
23 #include "lib/compose.hpp"
24 #include "lib/config.h"
25 #include "lib/constants.h"
26 #include "lib/content_factory.h"
27 #include "lib/cross.h"
28 #include "lib/dcp_content.h"
29 #include "lib/dcpomatic_log.h"
30 #include "lib/ffmpeg_content.h"
31 #include "lib/ffmpeg_encoder.h"
32 #include "lib/ffmpeg_examiner.h"
34 #include "lib/image_content.h"
35 #include "lib/ratio.h"
36 #include "lib/string_text_file_content.h"
37 #include "lib/text_content.h"
38 #include "lib/transcode_job.h"
39 #include "lib/video_content.h"
42 #include <dcp/raw_convert.h>
43 #include <boost/test/unit_test.hpp>
46 using std::make_shared;
49 using namespace dcpomatic;
53 ffmpeg_content_test (int number, boost::filesystem::path content, ExportFormat format)
57 string name = "ffmpeg_encoder_";
60 case ExportFormat::H264_AAC:
64 case ExportFormat::PRORES_4444:
68 case ExportFormat::PRORES_HQ:
72 case ExportFormat::SUBTITLES_DCP:
73 BOOST_REQUIRE (false);
76 name = String::compose("%1_test%2", name, number);
78 auto c = make_shared<FFmpegContent>(content);
79 auto film = new_test_film2 (name, {c}, &cl);
80 film->set_name (name);
81 film->set_audio_channels (6);
83 film->write_metadata ();
84 auto job = make_shared<TranscodeJob>(film, TranscodeJob::ChangedBehaviour::IGNORE);
85 auto file = boost::filesystem::path("build") / "test" / String::compose("%1.%2", name, extension);
87 FFmpegEncoder encoder (film, job, file, format, false, false, false, 23);
94 /** Red / green / blue MP4 -> Prores */
95 BOOST_AUTO_TEST_CASE (ffmpeg_encoder_prores_test1)
97 ffmpeg_content_test (1, "test/data/test.mp4", ExportFormat::PRORES_HQ);
101 /** Dolby Aurora trailer VOB -> Prores */
102 BOOST_AUTO_TEST_CASE (ffmpeg_encoder_prores_test2)
104 ffmpeg_content_test (2, TestPaths::private_data() / "dolby_aurora.vob", ExportFormat::PRORES_HQ);
108 /** Sintel trailer -> Prores */
109 BOOST_AUTO_TEST_CASE (ffmpeg_encoder_prores_test3)
111 ffmpeg_content_test (3, TestPaths::private_data() / "Sintel_Trailer1.480p.DivX_Plus_HD.mkv", ExportFormat::PRORES_HQ);
115 /** Big Buck Bunny trailer -> Prores */
116 BOOST_AUTO_TEST_CASE (ffmpeg_encoder_prores_test4)
118 ffmpeg_content_test (4, TestPaths::private_data() / "big_buck_bunny_trailer_480p.mov", ExportFormat::PRORES_HQ);
122 /** Still image -> Prores */
123 BOOST_AUTO_TEST_CASE (ffmpeg_encoder_prores_test5)
125 auto film = new_test_film ("ffmpeg_encoder_prores_test5");
126 film->set_name ("ffmpeg_encoder_prores_test5");
127 auto c = make_shared<ImageContent>(TestPaths::private_data() / "bbc405.png");
128 film->set_container (Ratio::from_id ("185"));
129 film->set_audio_channels (6);
131 film->examine_and_add_content (c);
132 BOOST_REQUIRE (!wait_for_jobs ());
134 c->video->set_length (240);
136 film->write_metadata ();
137 auto job = make_shared<TranscodeJob>(film, TranscodeJob::ChangedBehaviour::IGNORE);
138 FFmpegEncoder encoder (film, job, "build/test/ffmpeg_encoder_prores_test5.mov", ExportFormat::PRORES_HQ, false, false, false, 23);
143 /** Subs -> Prores */
144 BOOST_AUTO_TEST_CASE (ffmpeg_encoder_prores_test6)
146 auto film = new_test_film ("ffmpeg_encoder_prores_test6");
147 film->set_name ("ffmpeg_encoder_prores_test6");
148 film->set_container (Ratio::from_id ("185"));
149 film->set_audio_channels (6);
151 auto s = make_shared<StringTextFileContent>("test/data/subrip2.srt");
152 film->examine_and_add_content (s);
153 BOOST_REQUIRE (!wait_for_jobs ());
154 s->only_text()->set_colour (dcp::Colour (255, 255, 0));
155 s->only_text()->set_effect (dcp::Effect::SHADOW);
156 s->only_text()->set_effect_colour (dcp::Colour (0, 255, 255));
157 film->write_metadata();
159 auto job = make_shared<TranscodeJob> (film, TranscodeJob::ChangedBehaviour::IGNORE);
160 FFmpegEncoder encoder (film, job, "build/test/ffmpeg_encoder_prores_test6.mov", ExportFormat::PRORES_HQ, false, false, false, 23);
165 /** Video + subs -> Prores */
166 BOOST_AUTO_TEST_CASE (ffmpeg_encoder_prores_test7)
168 auto film = new_test_film ("ffmpeg_encoder_prores_test7");
169 film->set_name ("ffmpeg_encoder_prores_test7");
170 film->set_container (Ratio::from_id ("185"));
171 film->set_audio_channels (6);
173 auto c = make_shared<FFmpegContent>("test/data/test.mp4");
174 film->examine_and_add_content (c);
175 BOOST_REQUIRE (!wait_for_jobs ());
177 auto s = make_shared<StringTextFileContent>("test/data/subrip.srt");
178 film->examine_and_add_content (s);
179 BOOST_REQUIRE (!wait_for_jobs ());
180 s->only_text()->set_colour (dcp::Colour (255, 255, 0));
181 s->only_text()->set_effect (dcp::Effect::SHADOW);
182 s->only_text()->set_effect_colour (dcp::Colour (0, 255, 255));
184 auto job = make_shared<TranscodeJob>(film, TranscodeJob::ChangedBehaviour::IGNORE);
185 FFmpegEncoder encoder (film, job, "build/test/ffmpeg_encoder_prores_test7.mov", ExportFormat::PRORES_HQ, false, false, false, 23);
190 /** Red / green / blue MP4 -> H264 */
191 BOOST_AUTO_TEST_CASE (ffmpeg_encoder_h264_test1)
193 ffmpeg_content_test(1, "test/data/test.mp4", ExportFormat::H264_AAC);
197 /** Just subtitles -> H264 */
198 BOOST_AUTO_TEST_CASE (ffmpeg_encoder_h264_test2)
200 auto film = new_test_film ("ffmpeg_encoder_h264_test2");
201 film->set_name ("ffmpeg_encoder_h264_test2");
202 film->set_container (Ratio::from_id ("185"));
203 film->set_audio_channels (6);
205 auto s = make_shared<StringTextFileContent>("test/data/subrip2.srt");
206 film->examine_and_add_content (s);
207 BOOST_REQUIRE (!wait_for_jobs ());
208 s->only_text()->set_colour (dcp::Colour (255, 255, 0));
209 s->only_text()->set_effect (dcp::Effect::SHADOW);
210 s->only_text()->set_effect_colour (dcp::Colour (0, 255, 255));
211 film->write_metadata();
213 auto job = make_shared<TranscodeJob>(film, TranscodeJob::ChangedBehaviour::IGNORE);
214 FFmpegEncoder encoder (film, job, "build/test/ffmpeg_encoder_h264_test2.mp4", ExportFormat::H264_AAC, false, false, false, 23);
219 /** Video + subs -> H264 */
220 BOOST_AUTO_TEST_CASE (ffmpeg_encoder_h264_test3)
222 auto film = new_test_film ("ffmpeg_encoder_h264_test3");
223 film->set_name ("ffmpeg_encoder_h264_test3");
224 film->set_container (Ratio::from_id ("185"));
225 film->set_audio_channels (6);
227 auto c = make_shared<FFmpegContent>("test/data/test.mp4");
228 film->examine_and_add_content (c);
229 BOOST_REQUIRE (!wait_for_jobs());
231 auto s = make_shared<StringTextFileContent>("test/data/subrip.srt");
232 film->examine_and_add_content (s);
233 BOOST_REQUIRE (!wait_for_jobs ());
234 s->only_text()->set_colour (dcp::Colour (255, 255, 0));
235 s->only_text()->set_effect (dcp::Effect::SHADOW);
236 s->only_text()->set_effect_colour (dcp::Colour (0, 255, 255));
237 film->write_metadata();
239 auto job = make_shared<TranscodeJob> (film, TranscodeJob::ChangedBehaviour::IGNORE);
240 FFmpegEncoder encoder (film, job, "build/test/ffmpeg_encoder_h264_test3.mp4", ExportFormat::H264_AAC, false, false, false, 23);
245 /** Scope-in-flat DCP -> H264 */
246 BOOST_AUTO_TEST_CASE (ffmpeg_encoder_h264_test4)
248 auto film = new_test_film2("ffmpeg_encoder_h264_test4", {make_shared<DCPContent>("test/data/scope_dcp")});
249 BOOST_REQUIRE(!wait_for_jobs());
251 film->set_container(Ratio::from_id("185"));
253 auto job = make_shared<TranscodeJob>(film, TranscodeJob::ChangedBehaviour::IGNORE);
254 FFmpegEncoder encoder(film, job, "build/test/ffmpeg_encoder_h264_test4.mp4", ExportFormat::H264_AAC, false, false, false, 23);
259 /** Test mixdown from 5.1 to stereo */
260 BOOST_AUTO_TEST_CASE (ffmpeg_encoder_h264_test5)
262 auto film = new_test_film ("ffmpeg_transcoder_h264_test5");
263 film->set_name ("ffmpeg_transcoder_h264_test5");
264 film->set_container (Ratio::from_id ("185"));
265 film->set_audio_channels (6);
267 auto L = make_shared<FFmpegContent>("test/data/L.wav");
268 film->examine_and_add_content (L);
269 auto R = make_shared<FFmpegContent>("test/data/R.wav");
270 film->examine_and_add_content (R);
271 auto C = make_shared<FFmpegContent>("test/data/C.wav");
272 film->examine_and_add_content (C);
273 auto Ls = make_shared<FFmpegContent>("test/data/Ls.wav");
274 film->examine_and_add_content (Ls);
275 auto Rs = make_shared<FFmpegContent>("test/data/Rs.wav");
276 film->examine_and_add_content (Rs);
277 auto Lfe = make_shared<FFmpegContent>("test/data/Lfe.wav");
278 film->examine_and_add_content (Lfe);
279 BOOST_REQUIRE (!wait_for_jobs ());
281 AudioMapping map (1, MAX_DCP_AUDIO_CHANNELS);
283 L->set_position (film, DCPTime::from_seconds(0));
286 L->audio->set_mapping (map);
287 R->set_position (film, DCPTime::from_seconds(1));
290 R->audio->set_mapping (map);
291 C->set_position (film, DCPTime::from_seconds(2));
294 C->audio->set_mapping (map);
295 Lfe->set_position (film, DCPTime::from_seconds(3));
298 Lfe->audio->set_mapping (map);
299 Ls->set_position (film, DCPTime::from_seconds(4));
302 Ls->audio->set_mapping (map);
303 Rs->set_position (film, DCPTime::from_seconds(5));
306 Rs->audio->set_mapping (map);
308 auto job = make_shared<TranscodeJob>(film, TranscodeJob::ChangedBehaviour::IGNORE);
309 FFmpegEncoder encoder (film, job, "build/test/ffmpeg_encoder_h264_test5.mp4", ExportFormat::H264_AAC, true, false, false, 23);
312 check_ffmpeg ("build/test/ffmpeg_encoder_h264_test5.mp4", "test/data/ffmpeg_encoder_h264_test5.mp4", 1);
316 /** Test export of a VF */
317 BOOST_AUTO_TEST_CASE (ffmpeg_encoder_h264_test6)
319 auto film = new_test_film2 ("ffmpeg_encoder_h264_test6_ov");
320 film->examine_and_add_content (make_shared<ImageContent>(TestPaths::private_data() / "bbc405.png"));
321 BOOST_REQUIRE (!wait_for_jobs());
322 make_and_verify_dcp (film);
324 auto film2 = new_test_film2 ("ffmpeg_encoder_h264_test6_vf");
325 auto ov = make_shared<DCPContent>("build/test/ffmpeg_encoder_h264_test6_ov/" + film->dcp_name(false));
326 film2->examine_and_add_content (ov);
327 BOOST_REQUIRE (!wait_for_jobs());
328 ov->set_reference_video (true);
329 auto subs = content_factory("test/data/subrip.srt")[0];
330 film2->examine_and_add_content (subs);
331 BOOST_REQUIRE (!wait_for_jobs());
332 for (auto i: subs->text) {
336 auto job = make_shared<TranscodeJob>(film2, TranscodeJob::ChangedBehaviour::IGNORE);
337 FFmpegEncoder encoder (film2, job, "build/test/ffmpeg_encoder_h264_test6_vf.mp4", ExportFormat::H264_AAC, true, false, false, 23);
342 /** Test export of a 3D DCP in a 2D project */
343 BOOST_AUTO_TEST_CASE (ffmpeg_encoder_3d_dcp_to_h264)
345 auto dcp = make_shared<DCPContent>(TestPaths::private_data() / "xm");
346 auto film2 = new_test_film2 ("ffmpeg_encoder_3d_dcp_to_h264_export", {dcp});
348 auto job = make_shared<TranscodeJob>(film2, TranscodeJob::ChangedBehaviour::IGNORE);
349 FFmpegEncoder encoder (film2, job, "build/test/ffmpeg_encoder_3d_dcp_to_h264.mp4", ExportFormat::H264_AAC, true, false, false, 23);
354 /** Test export of a 3D DCP in a 2D project */
355 BOOST_AUTO_TEST_CASE (ffmpeg_encoder_h264_test7)
357 auto L = make_shared<ImageContent>(TestPaths::private_data() / "bbc405.png");
358 auto R = make_shared<ImageContent>(TestPaths::private_data() / "bbc405.png");
359 auto film = new_test_film2 ("ffmpeg_encoder_h264_test7_data", {L, R});
360 L->video->set_frame_type (VideoFrameType::THREE_D_LEFT);
361 L->set_position (film, DCPTime());
362 R->video->set_frame_type (VideoFrameType::THREE_D_RIGHT);
363 R->set_position (film, DCPTime());
364 film->set_three_d (true);
365 make_and_verify_dcp (film);
367 auto dcp = make_shared<DCPContent>(film->dir(film->dcp_name()));
368 auto film2 = new_test_film2 ("ffmpeg_encoder_h264_test7_export", {dcp});
370 auto job = make_shared<TranscodeJob> (film2, TranscodeJob::ChangedBehaviour::IGNORE);
371 FFmpegEncoder encoder (film2, job, "build/test/ffmpeg_encoder_h264_test7.mp4", ExportFormat::H264_AAC, true, false, false, 23);
376 BOOST_AUTO_TEST_CASE(ffmpeg_encoder_2d_content_in_3d_project)
378 auto content = make_shared<ImageContent>(TestPaths::private_data() / "bbc405.png");
379 auto film = new_test_film2("ffmpeg_encoder_2d_content_in_3d_project", { content });
380 film->set_three_d(true);
382 auto job = make_shared<TranscodeJob>(film, TranscodeJob::ChangedBehaviour::IGNORE);
383 FFmpegEncoder encoder(film, job, "build/test/ffmpeg_encoder_2d_content_in_3d_project.mp4", ExportFormat::H264_AAC, true, false, false, 23);
388 /** Stereo project with mixdown-to-stereo set */
389 BOOST_AUTO_TEST_CASE (ffmpeg_encoder_h264_test8)
391 auto film = new_test_film2("ffmpeg_encoder_h264_test4");
392 film->examine_and_add_content(make_shared<DCPContent>("test/data/scope_dcp"));
393 BOOST_REQUIRE(!wait_for_jobs());
394 film->set_audio_channels (2);
396 auto job = make_shared<TranscodeJob>(film, TranscodeJob::ChangedBehaviour::IGNORE);
397 FFmpegEncoder encoder(film, job, "build/test/ffmpeg_encoder_h264_test8.mp4", ExportFormat::H264_AAC, true, false, false, 23);
402 /** 7.1/HI/VI (i.e. 12-channel) project */
403 BOOST_AUTO_TEST_CASE (ffmpeg_encoder_h264_test9)
405 auto c = make_shared<ImageContent>(TestPaths::private_data() / "bbc405.png");
406 auto film = new_test_film2("ffmpeg_encoder_prores_test9", { c });
407 film->set_name ("ffmpeg_encoder_prores_test9");
408 film->set_container (Ratio::from_id ("185"));
409 film->set_audio_channels (12);
411 film->examine_and_add_content (c);
412 BOOST_REQUIRE (!wait_for_jobs ());
414 c->video->set_length (240);
416 film->write_metadata ();
417 auto job = make_shared<TranscodeJob>(film, TranscodeJob::ChangedBehaviour::IGNORE);
418 FFmpegEncoder encoder (film, job, "build/test/ffmpeg_encoder_prores_test9.mov", ExportFormat::H264_AAC, false, false, false, 23);
423 /** DCP -> Prores with crop */
424 BOOST_AUTO_TEST_CASE (ffmpeg_encoder_prores_from_dcp_with_crop)
426 auto dcp = make_shared<DCPContent>("test/data/import_dcp_test2");
427 auto film = new_test_film2 ("ffmpeg_encoder_prores_from_dcp_with_crop", { dcp });
428 dcp->video->set_left_crop (32);
429 dcp->video->set_right_crop (32);
430 film->write_metadata ();
432 auto job = make_shared<TranscodeJob>(film, TranscodeJob::ChangedBehaviour::IGNORE);
433 FFmpegEncoder encoder (film, job, "build/test/ffmpeg_encoder_prores_from_dcp_with_crop.mov", ExportFormat::PRORES_HQ, false, false, false, 23);
438 /** DCP -> H264 with crop */
439 BOOST_AUTO_TEST_CASE (ffmpeg_encoder_h264_from_dcp_with_crop)
441 auto dcp = make_shared<DCPContent>("test/data/import_dcp_test2");
442 auto film = new_test_film2 ("ffmpeg_encoder_h264_from_dcp_with_crop", { dcp });
443 dcp->video->set_left_crop (32);
444 dcp->video->set_right_crop (32);
445 film->write_metadata ();
447 auto job = make_shared<TranscodeJob>(film, TranscodeJob::ChangedBehaviour::IGNORE);
448 FFmpegEncoder encoder (film, job, "build/test/ffmpeg_encoder_prores_from_dcp_with_crop.mov", ExportFormat::H264_AAC, false, false, false, 23);
453 /** Export to H264 with reels */
454 BOOST_AUTO_TEST_CASE (ffmpeg_encoder_h264_with_reels)
456 auto content1 = content_factory("test/data/flat_red.png")[0];
457 auto content2 = content_factory("test/data/flat_red.png")[0];
458 auto film = new_test_film2 ("ffmpeg_encoder_h264_with_reels", { content1, content2 });
459 film->set_reel_type (ReelType::BY_VIDEO_CONTENT);
460 content1->video->set_length (240);
461 content2->video->set_length (240);
463 auto job = make_shared<TranscodeJob>(film, TranscodeJob::ChangedBehaviour::IGNORE);
464 FFmpegEncoder encoder (film, job, "build/test/ffmpeg_encoder_h264_with_reels.mov", ExportFormat::H264_AAC, false, true, false, 23);
467 auto check = [](boost::filesystem::path path) {
468 auto reel = std::dynamic_pointer_cast<FFmpegContent>(content_factory(path)[0]);
469 BOOST_REQUIRE (reel);
470 FFmpegExaminer examiner(reel);
471 BOOST_CHECK_EQUAL (examiner.video_length(), 240U);
474 check ("build/test/ffmpeg_encoder_h264_with_reels_reel1.mov");
475 check ("build/test/ffmpeg_encoder_h264_with_reels_reel2.mov");
479 /** Regression test for "Error during decoding: Butler finished" (#2097) */
480 BOOST_AUTO_TEST_CASE (ffmpeg_encoder_prores_regression_1)
484 auto content = content_factory(TestPaths::private_data() / "arrietty_JP-EN.mkv")[0];
485 auto film = new_test_film2 ("ffmpeg_encoder_prores_regression_1", { content });
487 auto job = make_shared<TranscodeJob>(film, TranscodeJob::ChangedBehaviour::IGNORE);
488 FFmpegEncoder encoder (film, job, "build/test/ffmpeg_encoder_prores_regression_1.mov", ExportFormat::PRORES_HQ, false, true, false, 23);
491 cl.add("build/test/ffmpeg_encoder_prores_regression_1.mov");
496 /** Regression test for Butler video buffers reached 480 frames (audio is 0) (#2101) */
497 BOOST_AUTO_TEST_CASE (ffmpeg_encoder_prores_regression_2)
501 auto logs = dcpomatic_log->types();
502 dcpomatic_log->set_types(logs | LogEntry::TYPE_DEBUG_PLAYER);
504 auto content = content_factory(TestPaths::private_data() / "tge_clip.mkv")[0];
505 auto film = new_test_film2 ("ffmpeg_encoder_prores_regression_2", { content });
507 auto job = make_shared<TranscodeJob>(film, TranscodeJob::ChangedBehaviour::IGNORE);
508 FFmpegEncoder encoder (film, job, "build/test/ffmpeg_encoder_prores_regression_2.mov", ExportFormat::PRORES_HQ, false, true, false, 23);
511 dcpomatic_log->set_types(logs);
513 cl.add("build/test/ffmpeg_encoder_prores_regression_2.mov");
518 BOOST_AUTO_TEST_CASE(ffmpeg_encoder_missing_frame_at_end)
520 auto content = content_factory(TestPaths::private_data() / "1s1f.mov");
521 auto film = new_test_film2("ffmpeg_encoder_missing_frame_at_end", content);
523 boost::filesystem::path output("build/test/ffmpeg_encoder_missing_frame_at_end.mov");
524 boost::filesystem::path log("build/test/ffmpeg_encoder_missing_frame_at_end.log");
526 auto job = make_shared<TranscodeJob>(film, TranscodeJob::ChangedBehaviour::IGNORE);
527 FFmpegEncoder encoder(film, job, output, ExportFormat::PRORES_HQ, false, true, false, 23);
530 run_ffprobe(output, log, false, "-show_frames -show_format -show_streams -select_streams v:0");
532 dcp::File read_log(log, "r");
533 BOOST_REQUIRE(read_log);
535 int nb_read_frames = 0;
539 while (!read_log.eof()) {
540 read_log.gets(buffer, sizeof(buffer));
541 vector<string> parts;
542 boost::algorithm::split(parts, buffer, boost::is_any_of("="));
543 if (parts.size() == 2) {
544 if (parts[0] == "nb_read_frames") {
545 nb_read_frames = dcp::raw_convert<int>(parts[1]);
546 } else if (parts[0] == "nb_frames") {
547 nb_frames = dcp::raw_convert<int>(parts[1]);
552 BOOST_CHECK_EQUAL(nb_frames, 26);
553 BOOST_CHECK_EQUAL(nb_read_frames, 26);