Rename ReelMXF -> ReelFileAsset.
[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, asset->key_id())
62         , _frame_rate (asset->frame_rate ())
63         , _screen_aspect_ratio (asset->screen_aspect_ratio ())
64 {
65
66 }
67
68
69 ReelPictureAsset::ReelPictureAsset (shared_ptr<const cxml::Node> node)
70         : ReelAsset (node)
71         , ReelFileAsset (node)
72 {
73         _frame_rate = Fraction (node->string_child ("FrameRate"));
74         try {
75                 _screen_aspect_ratio = Fraction (node->string_child ("ScreenAspectRatio"));
76         } catch (XMLError& e) {
77                 /* It's not a fraction */
78                 try {
79                         float f = node->number_child<float> ("ScreenAspectRatio");
80                         _screen_aspect_ratio = Fraction (f * 1000, 1000);
81                 } catch (bad_cast& e) {
82
83                 }
84         }
85 }
86
87
88 xmlpp::Node*
89 ReelPictureAsset::write_to_cpl (xmlpp::Node* node, Standard standard) const
90 {
91         auto asset = write_to_cpl_asset (node, standard, hash());
92
93         asset->add_child("FrameRate")->add_child_text(String::compose("%1 %2", _frame_rate.numerator, _frame_rate.denominator));
94         if (standard == Standard::INTEROP) {
95
96                 /* Allowed values for this tag from the standard */
97                 float allowed[] = { 1.33, 1.66, 1.77, 1.85, 2.00, 2.39 };
98                 int const num_allowed = sizeof(allowed) / sizeof(float);
99
100                 /* Actual ratio */
101                 float ratio = float (_screen_aspect_ratio.numerator) / _screen_aspect_ratio.denominator;
102
103                 /* Pick the closest and use that */
104                 optional<float> closest;
105                 optional<float> error;
106                 for (int i = 0; i < num_allowed; ++i) {
107                         float const e = fabsf (allowed[i] - ratio);
108                         if (!closest || e < error.get()) {
109                                 closest = allowed[i];
110                                 error = e;
111                         }
112                 }
113
114                 asset->add_child ("ScreenAspectRatio")->add_child_text (raw_convert<string> (closest.get(), 2, true));
115         } else {
116                 asset->add_child ("ScreenAspectRatio")->add_child_text (
117                         String::compose ("%1 %2", _screen_aspect_ratio.numerator, _screen_aspect_ratio.denominator)
118                         );
119         }
120
121         write_to_cpl_mxf (asset);
122
123         return asset;
124 }
125
126
127 string
128 ReelPictureAsset::key_type () const
129 {
130         return "MDIK";
131 }
132
133
134 bool
135 ReelPictureAsset::equals (shared_ptr<const ReelPictureAsset> other, EqualityOptions opt, NoteHandler note) const
136 {
137         if (!asset_equals (other, opt, note)) {
138                 return false;
139         }
140         if (!mxf_equals (other, opt, note)) {
141                 return false;
142         }
143
144         auto rpa = dynamic_pointer_cast<const ReelPictureAsset>(other);
145         if (!rpa) {
146                 return false;
147         }
148
149         if (_frame_rate != rpa->_frame_rate) {
150                 note (NoteType::ERROR, "frame rates differ in reel");
151                 return false;
152         }
153
154         if (_screen_aspect_ratio != rpa->_screen_aspect_ratio) {
155                 note (NoteType::ERROR, "screen aspect ratios differ in reel");
156                 return false;
157         }
158
159         return true;
160 }