Clarify some documentation slightly.
[dcpomatic.git] / test / j2k_video_bit_rate_test.cc
1 /*
2     Copyright (C) 2016-2021 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/j2k_video_bit_rate_test.cc
23  *  @brief Test whether we output whatever J2K bandwidth is requested.
24  *  @ingroup feature
25  */
26
27
28 #include "test.h"
29 #include "lib/dcp_content_type.h"
30 #include "lib/film.h"
31 #include "lib/image_content.h"
32 #include "lib/video_content.h"
33 #include <dcp/raw_convert.h>
34 #include <boost/test/unit_test.hpp>
35
36
37 using std::make_shared;
38 using std::string;
39
40
41 static void
42 check (int target_bits_per_second)
43 {
44         Cleanup cl;
45
46         int const duration = 10;
47
48         string const name = "bandwidth_test_" + dcp::raw_convert<string> (target_bits_per_second);
49         auto content = make_shared<ImageContent>(TestPaths::private_data() / "prophet_frame.tiff");
50         auto film = new_test_film(name, { content }, &cl);
51         film->set_video_bit_rate(VideoEncoding::JPEG2000, target_bits_per_second);
52         content->video->set_length (24 * duration);
53         make_and_verify_dcp (
54                 film,
55                 {
56                         dcp::VerificationNote::Code::MISSING_FFMC_IN_FEATURE,
57                         dcp::VerificationNote::Code::MISSING_FFEC_IN_FEATURE,
58                         dcp::VerificationNote::Code::NEARLY_INVALID_PICTURE_FRAME_SIZE_IN_BYTES,
59                         dcp::VerificationNote::Code::INVALID_PICTURE_FRAME_SIZE_IN_BYTES,
60                         dcp::VerificationNote::Code::INVALID_JPEG2000_TILE_PART_SIZE,
61                 },
62                 target_bits_per_second <= 250000000,
63                 target_bits_per_second <= 250000000
64                 );
65
66         auto test = find_file(film->dir(film->dcp_name()), "j2c_");
67         double actual_bits_per_second = boost::filesystem::file_size(test) * 8.0 / duration;
68
69         /* Check that we're within 85% to 115% of target on average */
70         BOOST_CHECK ((actual_bits_per_second / target_bits_per_second) > 0.85);
71         BOOST_CHECK ((actual_bits_per_second / target_bits_per_second) < 1.15);
72
73         cl.run();
74 }
75
76
77 BOOST_AUTO_TEST_CASE (bandwidth_test)
78 {
79         check (50000000);
80         check (100000000);
81         check (150000000);
82         check (200000000);
83         check (250000000);
84         check (300000000);
85         check (350000000);
86         check (400000000);
87         check (450000000);
88         check (500000000);
89 }