Fix silent stereo mixdown exports when the project audio channel count is > 6.
[dcpomatic.git] / test / mca_subdescriptors_test.cc
1 /*
2     Copyright (C) 2023 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 #include "lib/audio_content.h"
23 #include "lib/constants.h"
24 #include "lib/content.h"
25 #include "lib/content_factory.h"
26 #include "lib/film.h"
27 #include "test.h"
28 #include <libcxml/cxml.h>
29 #include <boost/test/unit_test.hpp>
30
31
32 using std::shared_ptr;
33 using std::string;
34 using std::vector;
35
36
37 static
38 void
39 test_descriptors(int mxf_channels, vector<dcp::Channel> active_channels, vector<string> mca_tag_symbols, string group_name)
40 {
41         auto content = content_factory("test/data/flat_red.png");
42         for (auto i = 0; i < mxf_channels; ++i) {
43                 content.push_back(content_factory("test/data/C.wav").front());
44         }
45         auto film = new_test_film2("mca_subdescriptors_written_correctly", content);
46         film->set_interop(false);
47         film->set_audio_channels(mxf_channels);
48
49         int N = 1;
50         for (auto channel: active_channels) {
51                 auto mapping = AudioMapping(1, MAX_DCP_AUDIO_CHANNELS);
52                 mapping.set(0, channel, 1);
53                 content[N]->audio->set_mapping(mapping);
54                 ++N;
55         }
56
57         make_and_verify_dcp(film);
58
59         cxml::Document check("CompositionPlaylist", find_file(film->dir(film->dcp_name()), "cpl_"));
60         vector<string> cpl_mca_tag_symbols;
61
62         auto mca_sub_descriptors = check.node_child("ReelList")->node_child("Reel")->node_child("AssetList")->node_child("CompositionMetadataAsset")->node_child("MCASubDescriptors");
63
64         for (auto node: mca_sub_descriptors->node_children("AudioChannelLabelSubDescriptor")) {
65                 cpl_mca_tag_symbols.push_back(node->string_child("MCATagSymbol"));
66         }
67
68         auto const cpl_group_name = mca_sub_descriptors->node_child("SoundfieldGroupLabelSubDescriptor")->string_child("MCATagSymbol");
69
70         BOOST_CHECK(cpl_mca_tag_symbols == mca_tag_symbols);
71         BOOST_CHECK(cpl_group_name == group_name);
72 }
73
74
75 /* This seems like an impossible case but let's check it anyway */
76 BOOST_AUTO_TEST_CASE(mca_subdescriptors_written_correctly_mono_in_2_channel)
77 {
78         test_descriptors(2, { dcp::Channel::CENTRE }, { "chL", "chR" }, "sg51");
79 }
80
81
82 BOOST_AUTO_TEST_CASE(mca_subdescriptors_written_correctly_mono_in_6_channel)
83 {
84         test_descriptors(6, { dcp::Channel::CENTRE }, { "chL", "chR", "chC", "chLFE", "chLs", "chRs" }, "sg51");
85 }
86
87
88 /* If we only have two channels in the MXF we shouldn't see any extra descriptors */
89 BOOST_AUTO_TEST_CASE(mca_subdescriptors_written_correctly_stereo_in_2_channel)
90 {
91         test_descriptors(2, { dcp::Channel::LEFT, dcp::Channel::RIGHT }, { "chL", "chR" }, "sg51");
92 }
93
94
95 BOOST_AUTO_TEST_CASE(mca_subdescriptors_written_correctly_stereo_in_6_channel)
96 {
97         test_descriptors(6, { dcp::Channel::LEFT, dcp::Channel::RIGHT }, { "chL", "chR", "chC", "chLFE", "chLs", "chRs" }, "sg51");
98 }
99
100
101 BOOST_AUTO_TEST_CASE(mca_subdescriptors_written_correctly_51)
102 {
103         test_descriptors(6,
104                 {
105                         dcp::Channel::LEFT,
106                         dcp::Channel::RIGHT,
107                         dcp::Channel::CENTRE,
108                         dcp::Channel::LFE,
109                         dcp::Channel::LS,
110                         dcp::Channel::RS,
111                 },
112                 { "chL", "chR", "chC", "chLFE", "chLs", "chRs" },
113                 "sg51"
114                 );
115 }
116
117
118 BOOST_AUTO_TEST_CASE(mca_subdescriptors_written_correctly_51_with_hi_vi)
119 {
120         test_descriptors(8,
121                 {
122                         dcp::Channel::LEFT,
123                         dcp::Channel::RIGHT,
124                         dcp::Channel::CENTRE,
125                         dcp::Channel::LFE,
126                         dcp::Channel::LS,
127                         dcp::Channel::RS,
128                         dcp::Channel::HI,
129                         dcp::Channel::VI,
130                 },
131                 { "chL", "chR", "chC", "chLFE", "chLs", "chRs", "chHI", "chVIN" },
132                 "sg51"
133                 );
134 }
135
136
137 BOOST_AUTO_TEST_CASE(mca_subdescriptors_written_correctly_71)
138 {
139         test_descriptors(16,
140                 {
141                         dcp::Channel::LEFT,
142                         dcp::Channel::RIGHT,
143                         dcp::Channel::CENTRE,
144                         dcp::Channel::LFE,
145                         dcp::Channel::LS,
146                         dcp::Channel::RS,
147                         dcp::Channel::BSL,
148                         dcp::Channel::BSR,
149                 },
150                 { "chL", "chR", "chC", "chLFE", "chLss", "chRss", "chLrs", "chRrs" },
151                 "sg71"
152                 );
153 }
154
155
156 BOOST_AUTO_TEST_CASE(mca_subdescriptors_written_correctly_71_with_hi_vi)
157 {
158         test_descriptors(16,
159                 {
160                         dcp::Channel::LEFT,
161                         dcp::Channel::RIGHT,
162                         dcp::Channel::CENTRE,
163                         dcp::Channel::LFE,
164                         dcp::Channel::LS,
165                         dcp::Channel::RS,
166                         dcp::Channel::HI,
167                         dcp::Channel::VI,
168                         dcp::Channel::BSL,
169                         dcp::Channel::BSR,
170                 },
171                 { "chL", "chR", "chC", "chLFE", "chLss", "chRss", "chHI", "chVIN", "chLrs", "chRrs" },
172                 "sg71"
173                 );
174 }