Various Doxygen fixes.
[dcpomatic.git] / test / isdcf_name_test.cc
1 /*
2     Copyright (C) 2014-2016 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/isdcf_name_test.cc
22  *  @brief Test creation of ISDCF names.
23  *  @ingroup specific
24  */
25
26 #include <boost/test/unit_test.hpp>
27 #include "lib/film.h"
28 #include "lib/ratio.h"
29 #include "lib/dcp_content_type.h"
30 #include "lib/image_content.h"
31 #include "lib/video_content.h"
32 #include "lib/audio_mapping.h"
33 #include "lib/ffmpeg_content.h"
34 #include "lib/audio_content.h"
35 #include "test.h"
36 #include <iostream>
37
38 using std::cout;
39 using boost::shared_ptr;
40
41 BOOST_AUTO_TEST_CASE (isdcf_name_test)
42 {
43         shared_ptr<Film> film = new_test_film ("isdcf_name_test");
44
45         /* A basic test */
46
47         film->set_name ("My Nice Film");
48         film->set_dcp_content_type (DCPContentType::from_isdcf_name ("FTR"));
49         film->set_container (Ratio::from_id ("185"));
50         film->_isdcf_date = boost::gregorian::date (2014, boost::gregorian::Jul, 4);
51         ISDCFMetadata m;
52         m.content_version = 1;
53         m.audio_language = "EN";
54         m.subtitle_language = "XX";
55         m.territory = "UK";
56         m.rating = "PG";
57         m.studio = "ST";
58         m.facility = "FA";
59         film->set_isdcf_metadata (m);
60         film->set_interop (true);
61         BOOST_CHECK_EQUAL (film->isdcf_name(false), "MyNiceFilm_FTR-1_F_EN-XX_UK-PG_2K_ST_20140704_FA_IOP_OV");
62
63         /* Test a long name and some different data */
64
65         film->set_name ("My Nice Film With A Very Long Name");
66         film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
67         film->set_container (Ratio::from_id ("239"));
68         film->_isdcf_date = boost::gregorian::date (2014, boost::gregorian::Jul, 4);
69         film->set_audio_channels (1);
70         film->set_resolution (RESOLUTION_4K);
71         m.content_version = 2;
72         m.audio_language = "DE";
73         m.subtitle_language = "FR";
74         m.territory = "US";
75         m.rating = "R";
76         m.studio = "DI";
77         m.facility = "PP";
78         film->set_isdcf_metadata (m);
79         film->set_interop (false);
80         BOOST_CHECK_EQUAL (film->isdcf_name(false), "MyNiceFilmWith_TLR-2_S_DE-fr_US-R_4K_DI_20140704_PP_SMPTE_OV");
81
82         /* Test interior aspect ratio: shouldn't be shown with trailers */
83
84         shared_ptr<ImageContent> content (new ImageContent (film, "test/data/simple_testcard_640x480.png"));
85         film->examine_and_add_content (content);
86         wait_for_jobs ();
87         content->video->set_scale (VideoContentScale (Ratio::from_id ("133")));
88         film->set_container (Ratio::from_id ("185"));
89         BOOST_CHECK_EQUAL (film->isdcf_name(false), "MyNiceFilmWith_TLR-2_F_DE-fr_US-R_4K_DI_20140704_PP_SMPTE_OV");
90
91         /* But should be shown for anything else */
92
93         film->set_dcp_content_type (DCPContentType::from_isdcf_name ("XSN"));
94         BOOST_CHECK_EQUAL (film->isdcf_name(false), "MyNiceFilmWith_XSN-2_F-133_DE-fr_US-R_4K_DI_20140704_PP_SMPTE_OV");
95
96         /* Test 3D */
97
98         film->set_three_d (true);
99         BOOST_CHECK_EQUAL (film->isdcf_name(false), "MyNiceFilmWith_XSN-2-3D_F-133_DE-fr_US-R_4K_DI_20140704_PP_SMPTE-3D_OV");
100
101         /* Test content type modifiers */
102
103         film->set_three_d (false);
104         m.temp_version = true;
105         m.pre_release = true;
106         m.red_band = true;
107         m.chain = "MyChain";
108         m.two_d_version_of_three_d = true;
109         m.mastered_luminance = "4fl";
110         film->set_isdcf_metadata (m);
111         film->set_video_frame_rate (48);
112         BOOST_CHECK_EQUAL (film->isdcf_name(false), "MyNiceFilmWith_XSN-2-Temp-Pre-RedBand-MyChain-2D-4fl-48_F-133_DE-fr_US-R_4K_DI_20140704_PP_SMPTE_OV");
113
114         /* Test a name which is already in camelCase */
115
116         film->set_three_d (false);
117         m.temp_version = false;
118         m.pre_release = false;
119         m.red_band = false;
120         m.chain = "";
121         m.two_d_version_of_three_d = false;
122         m.mastered_luminance = "";
123         film->set_isdcf_metadata (m);
124         film->set_video_frame_rate (24);
125         film->set_name ("IKnowCamels");
126         BOOST_CHECK_EQUAL (film->isdcf_name(false), "IKnowCamels_XSN-2_F-133_DE-fr_US-R_4K_DI_20140704_PP_SMPTE_OV");
127
128         /* And one in capitals */
129
130         film->set_name ("LIKE SHOUTING");
131         BOOST_CHECK_EQUAL (film->isdcf_name(false), "LikeShouting_XSN-2_F-133_DE-fr_US-R_4K_DI_20140704_PP_SMPTE_OV");
132
133         /* Test audio channel markup */
134
135         film->set_audio_channels (6);
136         shared_ptr<FFmpegContent> sound (new FFmpegContent (film, "test/data/sine_440.wav"));
137         film->examine_and_add_content (sound);
138         wait_for_jobs ();
139         BOOST_CHECK_EQUAL (film->isdcf_name(false), "LikeShouting_XSN-2_F-133_DE-fr_US-R_10_4K_DI_20140704_PP_SMPTE_OV");
140
141         AudioMapping mapping = sound->audio->mapping ();
142
143         mapping.set (0, dcp::LEFT, 1.0);
144         sound->audio->set_mapping (mapping);
145         BOOST_CHECK_EQUAL (film->isdcf_name(false), "LikeShouting_XSN-2_F-133_DE-fr_US-R_20_4K_DI_20140704_PP_SMPTE_OV");
146         mapping.set (0, dcp::RIGHT, 1.0);
147         sound->audio->set_mapping (mapping);
148         BOOST_CHECK_EQUAL (film->isdcf_name(false), "LikeShouting_XSN-2_F-133_DE-fr_US-R_30_4K_DI_20140704_PP_SMPTE_OV");
149         mapping.set (0, dcp::LFE, 1.0);
150         sound->audio->set_mapping (mapping);
151         BOOST_CHECK_EQUAL (film->isdcf_name(false), "LikeShouting_XSN-2_F-133_DE-fr_US-R_31_4K_DI_20140704_PP_SMPTE_OV");
152         mapping.set (0, dcp::LS, 1.0);
153         sound->audio->set_mapping (mapping);
154         BOOST_CHECK_EQUAL (film->isdcf_name(false), "LikeShouting_XSN-2_F-133_DE-fr_US-R_41_4K_DI_20140704_PP_SMPTE_OV");
155         mapping.set (0, dcp::RS, 1.0);
156         sound->audio->set_mapping (mapping);
157         BOOST_CHECK_EQUAL (film->isdcf_name(false), "LikeShouting_XSN-2_F-133_DE-fr_US-R_51_4K_DI_20140704_PP_SMPTE_OV");
158         mapping.set (0, dcp::HI, 1.0);
159         sound->audio->set_mapping (mapping);
160         BOOST_CHECK_EQUAL (film->isdcf_name(false), "LikeShouting_XSN-2_F-133_DE-fr_US-R_51_4K_DI_20140704_PP_SMPTE_OV");
161         film->set_audio_channels (8);
162         mapping.set (0, dcp::HI, 1.0);
163         sound->audio->set_mapping (mapping);
164         BOOST_CHECK_EQUAL (film->isdcf_name(false), "LikeShouting_XSN-2_F-133_DE-fr_US-R_61_4K_DI_20140704_PP_SMPTE_OV");
165         mapping.set (0, dcp::VI, 1.0);
166         sound->audio->set_mapping (mapping);
167         BOOST_CHECK_EQUAL (film->isdcf_name(false), "LikeShouting_XSN-2_F-133_DE-fr_US-R_71_4K_DI_20140704_PP_SMPTE_OV");
168 }