cc5e23993bee207de6d06fdbd29cee2a978670d4
[libdcp.git] / src / reel_picture_asset.cc
1 /*
2     Copyright (C) 2014-2021 Carl Hetherington <cth@carlh.net>
3
4     This file is part of libdcp.
5
6     libdcp 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     libdcp 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 libdcp.  If not, see <http://www.gnu.org/licenses/>.
18
19     In addition, as a special exception, the copyright holders give
20     permission to link the code of portions of this program with the
21     OpenSSL library under certain conditions as described in each
22     individual source file, and distribute linked combinations
23     including the two.
24
25     You must obey the GNU General Public License in all respects
26     for all of the code used other than OpenSSL.  If you modify
27     file(s) with this exception, you may extend this exception to your
28     version of the file(s), but you are not obligated to do so.  If you
29     do not wish to do so, delete this exception statement from your
30     version.  If you delete this exception statement from all source
31     files in the program, then also delete it here.
32 */
33
34
35 /** @file  src/reel_picture_asset.cc
36  *  @brief ReelPictureAsset class
37  */
38
39
40 #include "reel_picture_asset.h"
41 #include "picture_asset.h"
42 #include "dcp_assert.h"
43 #include "raw_convert.h"
44 #include "compose.hpp"
45 #include <libcxml/cxml.h>
46 #include <libxml++/libxml++.h>
47 #include <iomanip>
48 #include <cmath>
49
50
51 using std::bad_cast;
52 using std::string;
53 using std::shared_ptr;
54 using std::dynamic_pointer_cast;
55 using boost::optional;
56 using namespace dcp;
57
58
59 ReelPictureAsset::ReelPictureAsset (shared_ptr<PictureAsset> asset, int64_t entry_point)
60         : ReelAsset (asset->id(), asset->edit_rate(), asset->intrinsic_duration(), entry_point)
61         , ReelFileAsset (asset)
62         , ReelEncryptableAsset (asset->key_id())
63         , _frame_rate (asset->frame_rate ())
64         , _screen_aspect_ratio (asset->screen_aspect_ratio ())
65 {
66
67 }
68
69
70 ReelPictureAsset::ReelPictureAsset (shared_ptr<const cxml::Node> node)
71         : ReelAsset (node)
72         , ReelFileAsset (node)
73         , ReelEncryptableAsset (node)
74 {
75         _frame_rate = Fraction (node->string_child ("FrameRate"));
76         try {
77                 _screen_aspect_ratio = Fraction (node->string_child ("ScreenAspectRatio"));
78         } catch (XMLError& e) {
79                 /* It's not a fraction */
80                 try {
81                         float f = node->number_child<float> ("ScreenAspectRatio");
82                         _screen_aspect_ratio = Fraction (f * 1000, 1000);
83                 } catch (bad_cast& e) {
84
85                 }
86         }
87 }
88
89
90 xmlpp::Node*
91 ReelPictureAsset::write_to_cpl (xmlpp::Node* node, Standard standard) const
92 {
93         auto asset = write_to_cpl_asset (node, standard, hash());
94
95         asset->add_child("FrameRate")->add_child_text(String::compose("%1 %2", _frame_rate.numerator, _frame_rate.denominator));
96         if (standard == Standard::INTEROP) {
97
98                 /* Allowed values for this tag from the standard */
99                 float allowed[] = { 1.33, 1.66, 1.77, 1.85, 2.00, 2.39 };
100                 int const num_allowed = sizeof(allowed) / sizeof(float);
101
102                 /* Actual ratio */
103                 float ratio = float (_screen_aspect_ratio.numerator) / _screen_aspect_ratio.denominator;
104
105                 /* Pick the closest and use that */
106                 optional<float> closest;
107                 optional<float> error;
108                 for (int i = 0; i < num_allowed; ++i) {
109                         float const e = fabsf (allowed[i] - ratio);
110                         if (!closest || e < error.get()) {
111                                 closest = allowed[i];
112                                 error = e;
113                         }
114                 }
115
116                 asset->add_child ("ScreenAspectRatio")->add_child_text (raw_convert<string> (closest.get(), 2, true));
117         } else {
118                 asset->add_child ("ScreenAspectRatio")->add_child_text (
119                         String::compose ("%1 %2", _screen_aspect_ratio.numerator, _screen_aspect_ratio.denominator)
120                         );
121         }
122
123         write_to_cpl_mxf (asset);
124
125         return asset;
126 }
127
128
129 string
130 ReelPictureAsset::key_type () const
131 {
132         return "MDIK";
133 }
134
135
136 bool
137 ReelPictureAsset::equals (shared_ptr<const ReelPictureAsset> other, EqualityOptions opt, NoteHandler note) const
138 {
139         if (!asset_equals (other, opt, note)) {
140                 return false;
141         }
142         if (!file_asset_equals (other, opt, note)) {
143                 return false;
144         }
145
146         auto rpa = dynamic_pointer_cast<const ReelPictureAsset>(other);
147         if (!rpa) {
148                 return false;
149         }
150
151         if (_frame_rate != rpa->_frame_rate) {
152                 note (NoteType::ERROR, "frame rates differ in reel");
153                 return false;
154         }
155
156         if (_screen_aspect_ratio != rpa->_screen_aspect_ratio) {
157                 note (NoteType::ERROR, "screen aspect ratios differ in reel");
158                 return false;
159         }
160
161         return true;
162 }