Use release territory from Interop/SMPTE metadata instead of ISDCF metadata dialogue.
[dcpomatic.git] / test / isdcf_name_test.cc
1 /*
2     Copyright (C) 2014-2019 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 /** @file  test/isdcf_name_test.cc
23  *  @brief Test creation of ISDCF names.
24  *  @ingroup feature
25  */
26
27
28 #include <boost/test/unit_test.hpp>
29 #include "lib/film.h"
30 #include "lib/ratio.h"
31 #include "lib/dcp_content_type.h"
32 #include "lib/image_content.h"
33 #include "lib/video_content.h"
34 #include "lib/audio_mapping.h"
35 #include "lib/ffmpeg_content.h"
36 #include "lib/audio_content.h"
37 #include "lib/content_factory.h"
38 #include "lib/text_content.h"
39 #include "test.h"
40 #include <iostream>
41
42
43 using std::cout;
44 using std::shared_ptr;
45 using std::make_shared;
46
47
48 BOOST_AUTO_TEST_CASE (isdcf_name_test)
49 {
50         auto film = new_test_film ("isdcf_name_test");
51
52         /* A basic test */
53
54         film->set_name ("My Nice Film");
55         film->set_dcp_content_type (DCPContentType::from_isdcf_name ("FTR"));
56         film->set_container (Ratio::from_id ("185"));
57         film->_isdcf_date = boost::gregorian::date (2014, boost::gregorian::Jul, 4);
58         auto audio = content_factory("test/data/sine_440.wav").front();
59         film->examine_and_add_content (audio);
60         BOOST_REQUIRE (!wait_for_jobs());
61         BOOST_REQUIRE (audio->audio);
62         audio->audio->set_language(dcp::LanguageTag("en-US"));
63         film->set_content_versions({"1"});
64         film->set_release_territory(dcp::LanguageTag::RegionSubtag("GB"));
65         ISDCFMetadata m;
66         m.rating = "PG";
67         m.studio = "ST";
68         m.facility = "FA";
69         film->set_isdcf_metadata (m);
70         film->set_interop (true);
71         BOOST_CHECK_EQUAL (film->isdcf_name(false), "MyNiceFilm_FTR-1_F_EN-XX_GB-PG_10_2K_ST_20140704_FA_IOP_OV");
72
73         /* Check that specifying no audio language writes XX */
74         audio->audio->set_language (boost::none);
75         film->set_isdcf_metadata (m);
76         BOOST_CHECK_EQUAL (film->isdcf_name(false), "MyNiceFilm_FTR-1_F_XX-XX_GB-PG_10_2K_ST_20140704_FA_IOP_OV");
77
78         /* Test a long name and some different data */
79
80         film->set_name ("My Nice Film With A Very Long Name");
81         film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
82         film->set_container (Ratio::from_id ("239"));
83         film->_isdcf_date = boost::gregorian::date (2014, boost::gregorian::Jul, 4);
84         film->set_audio_channels (1);
85         film->set_resolution (Resolution::FOUR_K);
86         auto text = content_factory("test/data/subrip.srt").front();
87         BOOST_REQUIRE_EQUAL (text->text.size(), 1U);
88         text->text.front()->set_burn (true);
89         text->text.front()->set_language (dcp::LanguageTag("fr-FR"));
90         film->examine_and_add_content (text);
91         film->set_version_number(2);
92         film->set_release_territory(dcp::LanguageTag::RegionSubtag("US"));
93         BOOST_REQUIRE (!wait_for_jobs());
94         audio = content_factory("test/data/sine_440.wav").front();
95         film->examine_and_add_content (audio);
96         BOOST_REQUIRE (!wait_for_jobs());
97         BOOST_REQUIRE (audio->audio);
98         audio->audio->set_language (dcp::LanguageTag("de-DE"));
99         m.rating = "R";
100         m.studio = "DI";
101         m.facility = "PP";
102         film->set_isdcf_metadata (m);
103         film->set_interop (false);
104         BOOST_CHECK_EQUAL (film->isdcf_name(false), "MyNiceFilmWith_TLR-2_S_DE-fr_US-R_MOS_4K_DI_20140704_PP_SMPTE_OV");
105
106         /* Test to see that RU ratings like 6+ survive */
107         m.rating = "6+";
108         film->set_isdcf_metadata (m);
109         BOOST_CHECK_EQUAL (film->dcp_name(false), "MyNiceFilmWith_TLR-2_S_DE-fr_US-6+_MOS_4K_DI_20140704_PP_SMPTE_OV");
110         m.rating = "R";
111         film->set_isdcf_metadata (m);
112
113         /* Test interior aspect ratio: shouldn't be shown with trailers */
114
115         shared_ptr<ImageContent> content (new ImageContent ("test/data/simple_testcard_640x480.png"));
116         film->examine_and_add_content (content);
117         BOOST_REQUIRE (!wait_for_jobs());
118         content->video->set_custom_ratio (1.33);
119         film->set_container (Ratio::from_id ("185"));
120         BOOST_CHECK_EQUAL (film->isdcf_name(false), "MyNiceFilmWith_TLR-2_F_DE-fr_US-R_MOS_4K_DI_20140704_PP_SMPTE_OV");
121
122         /* But should be shown for anything else */
123
124         film->set_dcp_content_type (DCPContentType::from_isdcf_name ("XSN"));
125         BOOST_CHECK_EQUAL (film->isdcf_name(false), "MyNiceFilmWith_XSN-2_F-133_DE-fr_US-R_MOS_4K_DI_20140704_PP_SMPTE_OV");
126
127         /* And it should always be numeric */
128
129         content->video->set_custom_ratio (2.39);
130         BOOST_CHECK_EQUAL (film->isdcf_name(false), "MyNiceFilmWith_XSN-2_F-239_DE-fr_US-R_MOS_4K_DI_20140704_PP_SMPTE_OV");
131
132         content->video->set_custom_ratio (1.9);
133         BOOST_CHECK_EQUAL (film->isdcf_name(false), "MyNiceFilmWith_XSN-2_F-190_DE-fr_US-R_MOS_4K_DI_20140704_PP_SMPTE_OV");
134         content->video->set_custom_ratio (1.33);
135
136         /* Test 3D */
137
138         film->set_three_d (true);
139         BOOST_CHECK_EQUAL (film->isdcf_name(false), "MyNiceFilmWith_XSN-2-3D_F-133_DE-fr_US-R_MOS_4K_DI_20140704_PP_SMPTE-3D_OV");
140
141         /* Test content type modifiers */
142
143         film->set_three_d (false);
144         m.temp_version = true;
145         m.pre_release = true;
146         m.red_band = true;
147         m.chain = "MyChain";
148         m.two_d_version_of_three_d = true;
149         m.mastered_luminance = "4fl";
150         film->set_isdcf_metadata (m);
151         film->set_video_frame_rate (48);
152         BOOST_CHECK_EQUAL (film->isdcf_name(false), "MyNiceFilmWith_XSN-2-Temp-Pre-RedBand-MyChain-2D-4fl-48_F-133_DE-fr_US-R_MOS_4K_DI_20140704_PP_SMPTE_OV");
153
154         /* Test a name which is already in camelCase */
155
156         film->set_three_d (false);
157         m.temp_version = false;
158         m.pre_release = false;
159         m.red_band = false;
160         m.chain = "";
161         m.two_d_version_of_three_d = false;
162         m.mastered_luminance = "";
163         film->set_isdcf_metadata (m);
164         film->set_video_frame_rate (24);
165         film->set_name ("IKnowCamels");
166         BOOST_CHECK_EQUAL (film->isdcf_name(false), "IKnowCamels_XSN-2_F-133_DE-fr_US-R_MOS_4K_DI_20140704_PP_SMPTE_OV");
167
168         /* And one in capitals */
169
170         film->set_name ("LIKE SHOUTING");
171         BOOST_CHECK_EQUAL (film->isdcf_name(false), "LikeShouting_XSN-2_F-133_DE-fr_US-R_MOS_4K_DI_20140704_PP_SMPTE_OV");
172
173         /* Test audio channel markup */
174
175         film->set_audio_channels (6);
176         auto sound = make_shared<FFmpegContent>("test/data/sine_440.wav");
177         film->examine_and_add_content (sound);
178         BOOST_REQUIRE (!wait_for_jobs());
179         BOOST_CHECK_EQUAL (film->isdcf_name(false), "LikeShouting_XSN-2_F-133_DE-fr_US-R_10_4K_DI_20140704_PP_SMPTE_OV");
180
181         AudioMapping mapping = sound->audio->mapping ();
182
183         mapping.set (0, dcp::Channel::LEFT, 1.0);
184         sound->audio->set_mapping (mapping);
185         BOOST_CHECK_EQUAL (film->isdcf_name(false), "LikeShouting_XSN-2_F-133_DE-fr_US-R_20_4K_DI_20140704_PP_SMPTE_OV");
186         mapping.set (0, dcp::Channel::RIGHT, 1.0);
187         sound->audio->set_mapping (mapping);
188         BOOST_CHECK_EQUAL (film->isdcf_name(false), "LikeShouting_XSN-2_F-133_DE-fr_US-R_30_4K_DI_20140704_PP_SMPTE_OV");
189         mapping.set (0, dcp::Channel::LFE, 1.0);
190         sound->audio->set_mapping (mapping);
191         BOOST_CHECK_EQUAL (film->isdcf_name(false), "LikeShouting_XSN-2_F-133_DE-fr_US-R_31_4K_DI_20140704_PP_SMPTE_OV");
192         mapping.set (0, dcp::Channel::LS, 1.0);
193         sound->audio->set_mapping (mapping);
194         BOOST_CHECK_EQUAL (film->isdcf_name(false), "LikeShouting_XSN-2_F-133_DE-fr_US-R_41_4K_DI_20140704_PP_SMPTE_OV");
195         mapping.set (0, dcp::Channel::RS, 1.0);
196         sound->audio->set_mapping (mapping);
197         BOOST_CHECK_EQUAL (film->isdcf_name(false), "LikeShouting_XSN-2_F-133_DE-fr_US-R_51_4K_DI_20140704_PP_SMPTE_OV");
198         mapping.set (0, dcp::Channel::HI, 1.0);
199         sound->audio->set_mapping (mapping);
200         BOOST_CHECK_EQUAL (film->isdcf_name(false), "LikeShouting_XSN-2_F-133_DE-fr_US-R_51_4K_DI_20140704_PP_SMPTE_OV");
201
202         film->set_audio_channels (8);
203         mapping.set (0, dcp::Channel::HI, 1.0);
204         sound->audio->set_mapping (mapping);
205         BOOST_CHECK_EQUAL (film->isdcf_name(false), "LikeShouting_XSN-2_F-133_DE-fr_US-R_51-HI_4K_DI_20140704_PP_SMPTE_OV");
206         mapping.set (0, dcp::Channel::VI, 1.0);
207         sound->audio->set_mapping (mapping);
208         BOOST_CHECK_EQUAL (film->isdcf_name(false), "LikeShouting_XSN-2_F-133_DE-fr_US-R_51-HI-VI_4K_DI_20140704_PP_SMPTE_OV");
209
210         film->set_audio_channels(10);
211         mapping.set (0, dcp::Channel::HI, 0.0);
212         mapping.set (0, dcp::Channel::VI, 0.0);
213         sound->audio->set_mapping (mapping);
214         BOOST_CHECK_EQUAL (film->isdcf_name(false), "LikeShouting_XSN-2_F-133_DE-fr_US-R_51_4K_DI_20140704_PP_SMPTE_OV");
215         mapping.set (0, dcp::Channel::HI, 1.0);
216         sound->audio->set_mapping (mapping);
217         BOOST_CHECK_EQUAL (film->isdcf_name(false), "LikeShouting_XSN-2_F-133_DE-fr_US-R_51-HI_4K_DI_20140704_PP_SMPTE_OV");
218         mapping.set (0, dcp::Channel::VI, 1.0);
219         sound->audio->set_mapping (mapping);
220         BOOST_CHECK_EQUAL (film->isdcf_name(false), "LikeShouting_XSN-2_F-133_DE-fr_US-R_51-HI-VI_4K_DI_20140704_PP_SMPTE_OV");
221
222         film->set_audio_channels(12);
223         mapping.set (0, dcp::Channel::BSL, 1.0);
224         mapping.set (0, dcp::Channel::BSR, 1.0);
225         mapping.set (0, dcp::Channel::HI, 0.0);
226         mapping.set (0, dcp::Channel::VI, 0.0);
227         sound->audio->set_mapping (mapping);
228         BOOST_CHECK_EQUAL (film->isdcf_name(false), "LikeShouting_XSN-2_F-133_DE-fr_US-R_71_4K_DI_20140704_PP_SMPTE_OV");
229         mapping.set (0, dcp::Channel::HI, 1.0);
230         sound->audio->set_mapping (mapping);
231         BOOST_CHECK_EQUAL (film->isdcf_name(false), "LikeShouting_XSN-2_F-133_DE-fr_US-R_71-HI_4K_DI_20140704_PP_SMPTE_OV");
232         mapping.set (0, dcp::Channel::VI, 1.0);
233         sound->audio->set_mapping (mapping);
234         BOOST_CHECK_EQUAL (film->isdcf_name(false), "LikeShouting_XSN-2_F-133_DE-fr_US-R_71-HI-VI_4K_DI_20140704_PP_SMPTE_OV");
235 }
236