why_not in can_reference can just be a string rather than a list of strings.
[dcpomatic.git] / test / vf_test.cc
1 /*
2     Copyright (C) 2015-2017 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 /** @file  test/vf_Test.cc
22  *  @brief Various VF-related tests.
23  *  @ingroup specific
24  */
25
26 #include "lib/film.h"
27 #include "lib/dcp_content.h"
28 #include "lib/ffmpeg_content.h"
29 #include "lib/content_factory.h"
30 #include "lib/dcp_content_type.h"
31 #include "lib/video_content.h"
32 #include "test.h"
33 #include <dcp/cpl.h>
34 #include <dcp/reel.h>
35 #include <dcp/reel_picture_asset.h>
36 #include <dcp/reel_sound_asset.h>
37 #include <boost/test/unit_test.hpp>
38 #include <boost/foreach.hpp>
39
40 using std::list;
41 using std::string;
42 using std::cout;
43 using boost::shared_ptr;
44 using boost::dynamic_pointer_cast;
45
46 /** Test the logic which decides whether a DCP can be referenced or not */
47 BOOST_AUTO_TEST_CASE (vf_test1)
48 {
49         shared_ptr<Film> film = new_test_film ("vf_test1");
50         film->set_interop (false);
51         shared_ptr<DCPContent> dcp (new DCPContent (film, "test/data/reels_test2"));
52         film->examine_and_add_content (dcp);
53         wait_for_jobs ();
54
55         /* Multi-reel DCP can't be referenced if we are using a single reel for the project */
56         film->set_reel_type (REELTYPE_SINGLE);
57         string why_not;
58         BOOST_CHECK (!dcp->can_reference_video(why_not));
59         BOOST_CHECK (!dcp->can_reference_audio(why_not));
60         BOOST_CHECK (!dcp->can_reference_subtitle(why_not));
61
62         /* Multi-reel DCP can be referenced if we are using by-video-content */
63         film->set_reel_type (REELTYPE_BY_VIDEO_CONTENT);
64         BOOST_CHECK (dcp->can_reference_video(why_not));
65         BOOST_CHECK (dcp->can_reference_audio(why_not));
66         /* (but reels_test2 has no subtitles to reference) */
67         BOOST_CHECK (!dcp->can_reference_subtitle(why_not));
68
69         shared_ptr<FFmpegContent> other (new FFmpegContent (film, "test/data/test.mp4"));
70         film->examine_and_add_content (other);
71         wait_for_jobs ();
72
73         /* Not possible if there is overlap */
74         other->set_position (DCPTime (0));
75         BOOST_CHECK (!dcp->can_reference_video(why_not));
76         BOOST_CHECK (!dcp->can_reference_audio(why_not));
77         BOOST_CHECK (!dcp->can_reference_subtitle(why_not));
78
79         /* This should not be considered an overlap */
80         other->set_position (dcp->end ());
81         BOOST_CHECK (dcp->can_reference_video(why_not));
82         BOOST_CHECK (dcp->can_reference_audio(why_not));
83         /* (reels_test2 has no subtitles to reference) */
84         BOOST_CHECK (!dcp->can_reference_subtitle(why_not));
85 }
86
87 /** Make a OV with video and audio and a VF referencing the OV and adding subs */
88 BOOST_AUTO_TEST_CASE (vf_test2)
89 {
90         /* Make the OV */
91         shared_ptr<Film> ov = new_test_film ("vf_test2_ov");
92         ov->set_dcp_content_type (DCPContentType::from_isdcf_name ("TST"));
93         ov->set_name ("vf_test2_ov");
94         shared_ptr<Content> video = content_factory (ov, "test/data/flat_red.png").front();
95         ov->examine_and_add_content (video);
96         wait_for_jobs ();
97         video->video->set_length (24 * 5);
98         shared_ptr<Content> audio = content_factory(ov, "test/data/white.wav").front();
99         ov->examine_and_add_content (audio);
100         wait_for_jobs ();
101         ov->make_dcp ();
102         wait_for_jobs ();
103
104         /* Make the VF */
105         shared_ptr<Film> vf = new_test_film ("vf_test2_vf");
106         vf->set_name ("vf_test2_vf");
107         vf->set_dcp_content_type (DCPContentType::from_isdcf_name ("TST"));
108         vf->set_reel_type (REELTYPE_BY_VIDEO_CONTENT);
109         shared_ptr<DCPContent> dcp (new DCPContent (vf, ov->dir (ov->dcp_name ())));
110         BOOST_REQUIRE (dcp);
111         vf->examine_and_add_content (dcp);
112         wait_for_jobs ();
113         dcp->set_reference_video (true);
114         dcp->set_reference_audio (true);
115         shared_ptr<Content> sub = content_factory(vf, "test/data/subrip4.srt").front();
116         vf->examine_and_add_content (sub);
117         DCPOMATIC_ASSERT (!wait_for_jobs ());
118         vf->make_dcp ();
119         DCPOMATIC_ASSERT (!wait_for_jobs ());
120         vf->write_metadata ();
121
122         dcp::DCP ov_c (ov->dir (ov->dcp_name ()));
123         ov_c.read ();
124         BOOST_REQUIRE_EQUAL (ov_c.cpls().size(), 1);
125         BOOST_REQUIRE_EQUAL (ov_c.cpls().front()->reels().size(), 1);
126         BOOST_REQUIRE (ov_c.cpls().front()->reels().front()->main_picture());
127         string const pic_id = ov_c.cpls().front()->reels().front()->main_picture()->id();
128         BOOST_REQUIRE (ov_c.cpls().front()->reels().front()->main_sound());
129         string const sound_id = ov_c.cpls().front()->reels().front()->main_sound()->id();
130         BOOST_REQUIRE (!ov_c.cpls().front()->reels().front()->main_subtitle());
131
132         dcp::DCP vf_c (vf->dir (vf->dcp_name ()));
133         vf_c.read ();
134         BOOST_REQUIRE_EQUAL (vf_c.cpls().size(), 1);
135         BOOST_REQUIRE_EQUAL (vf_c.cpls().front()->reels().size(), 1);
136         BOOST_REQUIRE (vf_c.cpls().front()->reels().front()->main_picture());
137         BOOST_CHECK_EQUAL (vf_c.cpls().front()->reels().front()->main_picture()->id(), pic_id);
138         BOOST_REQUIRE (vf_c.cpls().front()->reels().front()->main_sound());
139         BOOST_CHECK_EQUAL (vf_c.cpls().front()->reels().front()->main_sound()->id(), sound_id);
140         BOOST_REQUIRE (vf_c.cpls().front()->reels().front()->main_subtitle());
141 }
142
143 /** Test creation of a VF using a trimmed OV; the output should have entry point /
144  *  duration altered to effect the trimming.
145  */
146 BOOST_AUTO_TEST_CASE (vf_test3)
147 {
148         /* Make the OV */
149         shared_ptr<Film> ov = new_test_film ("vf_test3_ov");
150         ov->set_dcp_content_type (DCPContentType::from_isdcf_name ("TST"));
151         ov->set_name ("vf_test3_ov");
152         shared_ptr<Content> video = content_factory(ov, "test/data/flat_red.png").front();
153         ov->examine_and_add_content (video);
154         wait_for_jobs ();
155         video->video->set_length (24 * 5);
156         shared_ptr<Content> audio = content_factory(ov, "test/data/white.wav").front();
157         ov->examine_and_add_content (audio);
158         wait_for_jobs ();
159         ov->make_dcp ();
160         wait_for_jobs ();
161
162         /* Make the VF */
163         shared_ptr<Film> vf = new_test_film ("vf_test3_vf");
164         vf->set_name ("vf_test3_vf");
165         vf->set_dcp_content_type (DCPContentType::from_isdcf_name ("TST"));
166         vf->set_reel_type (REELTYPE_BY_VIDEO_CONTENT);
167         shared_ptr<DCPContent> dcp (new DCPContent (vf, ov->dir (ov->dcp_name ())));
168         BOOST_REQUIRE (dcp);
169         dcp->set_trim_start (ContentTime::from_seconds (1));
170         dcp->set_trim_end (ContentTime::from_seconds (1));
171         vf->examine_and_add_content (dcp);
172         wait_for_jobs ();
173         dcp->set_reference_video (true);
174         dcp->set_reference_audio (true);
175         vf->make_dcp ();
176         wait_for_jobs ();
177         vf->write_metadata ();
178
179         dcp::DCP vf_c (vf->dir (vf->dcp_name ()));
180         vf_c.read ();
181         BOOST_REQUIRE_EQUAL (vf_c.cpls().size(), 1);
182         BOOST_REQUIRE_EQUAL (vf_c.cpls().front()->reels().size(), 1);
183         BOOST_REQUIRE (vf_c.cpls().front()->reels().front()->main_picture());
184         BOOST_CHECK_EQUAL (vf_c.cpls().front()->reels().front()->main_picture()->entry_point(), 24);
185         BOOST_CHECK_EQUAL (vf_c.cpls().front()->reels().front()->main_picture()->duration(), 72);
186         BOOST_REQUIRE (vf_c.cpls().front()->reels().front()->main_sound());
187         BOOST_CHECK_EQUAL (vf_c.cpls().front()->reels().front()->main_sound()->entry_point(), 24);
188         BOOST_CHECK_EQUAL (vf_c.cpls().front()->reels().front()->main_sound()->duration(), 72);
189 }
190
191 /** Make a OV with video and audio and a VF referencing the OV and adding some more video */
192 BOOST_AUTO_TEST_CASE (vf_test4)
193 {
194         /* Make the OV */
195         shared_ptr<Film> ov = new_test_film ("vf_test4_ov");
196         ov->set_dcp_content_type (DCPContentType::from_isdcf_name ("TST"));
197         ov->set_name ("vf_test4_ov");
198         shared_ptr<Content> video = content_factory (ov, "test/data/flat_red.png").front();
199         ov->examine_and_add_content (video);
200         wait_for_jobs ();
201         video->video->set_length (24 * 5);
202         shared_ptr<Content> audio = content_factory(ov, "test/data/white.wav").front();
203         ov->examine_and_add_content (audio);
204         wait_for_jobs ();
205         ov->make_dcp ();
206         wait_for_jobs ();
207
208         /* Make the VF */
209         shared_ptr<Film> vf = new_test_film ("vf_test4_vf");
210         vf->set_name ("vf_test4_vf");
211         vf->set_dcp_content_type (DCPContentType::from_isdcf_name ("TST"));
212         vf->set_reel_type (REELTYPE_BY_VIDEO_CONTENT);
213         vf->set_sequence (false);
214         shared_ptr<DCPContent> dcp (new DCPContent (vf, ov->dir (ov->dcp_name ())));
215         BOOST_REQUIRE (dcp);
216         vf->examine_and_add_content (dcp);
217         wait_for_jobs ();
218         dcp->set_position(DCPTime::from_seconds(10));
219         dcp->set_reference_video (true);
220         dcp->set_reference_audio (true);
221         shared_ptr<Content> more_video = content_factory(vf, "test/data/flat_red.png").front();
222         vf->examine_and_add_content (more_video);
223         DCPOMATIC_ASSERT (!wait_for_jobs ());
224         more_video->set_position (DCPTime ());
225         vf->write_metadata ();
226         vf->make_dcp ();
227         DCPOMATIC_ASSERT (!wait_for_jobs ());
228
229         dcp::DCP ov_c (ov->dir (ov->dcp_name ()));
230         ov_c.read ();
231         BOOST_REQUIRE_EQUAL (ov_c.cpls().size(), 1);
232         BOOST_REQUIRE_EQUAL (ov_c.cpls().front()->reels().size(), 1);
233         BOOST_REQUIRE (ov_c.cpls().front()->reels().front()->main_picture());
234         string const pic_id = ov_c.cpls().front()->reels().front()->main_picture()->id();
235         BOOST_REQUIRE (ov_c.cpls().front()->reels().front()->main_sound());
236         string const sound_id = ov_c.cpls().front()->reels().front()->main_sound()->id();
237         BOOST_REQUIRE (!ov_c.cpls().front()->reels().front()->main_subtitle());
238
239         dcp::DCP vf_c (vf->dir (vf->dcp_name ()));
240         vf_c.read ();
241         BOOST_REQUIRE_EQUAL (vf_c.cpls().size(), 1);
242         BOOST_REQUIRE_EQUAL (vf_c.cpls().front()->reels().size(), 2);
243         BOOST_REQUIRE (vf_c.cpls().front()->reels().back()->main_picture());
244         BOOST_CHECK_EQUAL (vf_c.cpls().front()->reels().back()->main_picture()->id(), pic_id);
245         BOOST_REQUIRE (vf_c.cpls().front()->reels().back()->main_sound());
246         BOOST_CHECK_EQUAL (vf_c.cpls().front()->reels().back()->main_sound()->id(), sound_id);
247 }