Merge branch '1.0' of git.carlh.net:git/libdcp into 1.0
[libdcp.git] / src / reel_picture_asset.cc
1 /*
2     Copyright (C) 2014-2016 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 /** @file  src/reel_picture_asset.h
35  *  @brief ReelPictureAsset class.
36  */
37
38 #include "reel_picture_asset.h"
39 #include "picture_asset.h"
40 #include "dcp_assert.h"
41 #include "raw_convert.h"
42 #include "compose.hpp"
43 #include <libcxml/cxml.h>
44 #include <libxml++/libxml++.h>
45 #include <iomanip>
46 #include <cmath>
47
48 using std::bad_cast;
49 using std::string;
50 using boost::shared_ptr;
51 using boost::dynamic_pointer_cast;
52 using boost::optional;
53 using namespace dcp;
54
55 ReelPictureAsset::ReelPictureAsset ()
56         : _frame_rate (Fraction (24, 1))
57         , _screen_aspect_ratio (Fraction (1998, 1080))
58 {
59
60 }
61
62 ReelPictureAsset::ReelPictureAsset (shared_ptr<PictureAsset> asset, int64_t entry_point)
63         : ReelAsset (asset, asset->edit_rate(), asset->intrinsic_duration(), entry_point)
64         , ReelMXF (asset->key_id())
65         , _frame_rate (asset->frame_rate ())
66         , _screen_aspect_ratio (asset->screen_aspect_ratio ())
67 {
68
69 }
70
71 ReelPictureAsset::ReelPictureAsset (shared_ptr<const cxml::Node> node)
72         : ReelAsset (node)
73         , ReelMXF (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 void
90 ReelPictureAsset::write_to_cpl (xmlpp::Node* node, Standard standard) const
91 {
92         ReelAsset::write_to_cpl (node, standard);
93
94         /* Find <MainPicture> */
95         xmlpp::Node* mp = find_child (node, cpl_node_name ());
96
97         mp->add_child ("FrameRate")->add_child_text (String::compose ("%1 %2", _frame_rate.numerator, _frame_rate.denominator));
98         if (standard == INTEROP) {
99
100                 /* Allowed values for this tag from the standard */
101                 float allowed[] = { 1.33, 1.66, 1.77, 1.85, 2.00, 2.39 };
102                 int const num_allowed = sizeof(allowed) / sizeof(float);
103
104                 /* Actual ratio */
105                 float ratio = float (_screen_aspect_ratio.numerator) / _screen_aspect_ratio.denominator;
106
107                 /* Pick the closest and use that */
108                 optional<float> closest;
109                 optional<float> error;
110                 for (int i = 0; i < num_allowed; ++i) {
111                         float const e = fabsf (allowed[i] - ratio);
112                         if (!closest || e < error.get()) {
113                                 closest = allowed[i];
114                                 error = e;
115                         }
116                 }
117
118                 mp->add_child ("ScreenAspectRatio")->add_child_text (raw_convert<string> (closest.get(), 2, true));
119         } else {
120                 mp->add_child ("ScreenAspectRatio")->add_child_text (
121                         String::compose ("%1 %2", _screen_aspect_ratio.numerator, _screen_aspect_ratio.denominator)
122                         );
123         }
124
125         if (key_id ()) {
126                 /* Find <Hash> */
127                 xmlpp::Node* hash = find_child (mp, "Hash");
128                 mp->add_child_before (hash, "KeyId")->add_child_text ("urn:uuid:" + key_id().get ());
129         }
130 }
131
132 string
133 ReelPictureAsset::key_type () const
134 {
135         return "MDIK";
136 }
137
138 bool
139 ReelPictureAsset::equals (shared_ptr<const ReelAsset> other, EqualityOptions opt, NoteHandler note) const
140 {
141         if (!ReelAsset::equals (other, opt, note)) {
142                 return false;
143         }
144
145         shared_ptr<const ReelPictureAsset> rpa = dynamic_pointer_cast<const ReelPictureAsset> (other);
146         if (!rpa) {
147                 return false;
148         }
149
150         if (_frame_rate != rpa->_frame_rate) {
151                 note (DCP_ERROR, "frame rates differ in reel");
152                 return false;
153         }
154
155         if (_screen_aspect_ratio != rpa->_screen_aspect_ratio) {
156                 note (DCP_ERROR, "screen aspect ratios differ in reel");
157                 return false;
158         }
159
160         return true;
161 }