2 Copyright (C) 2012-2019 Carl Hetherington <cth@carlh.net>
4 This file is part of libdcp.
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.
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.
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/>.
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
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.
34 #include "raw_convert.h"
36 #include "exceptions.h"
37 #include "compose.hpp"
38 #include "dcp_assert.h"
39 #include <libxml++/libxml++.h>
40 #include <boost/algorithm/string.hpp>
47 using namespace boost;
49 bool dcp::operator== (dcp::Size const & a, dcp::Size const & b)
51 return (a.width == b.width && a.height == b.height);
54 bool dcp::operator!= (dcp::Size const & a, dcp::Size const & b)
59 ostream& dcp::operator<< (ostream& s, dcp::Size const & a)
61 s << a.width << "x" << a.height;
65 /** Construct a Fraction from a string of the form <numerator> <denominator>
68 Fraction::Fraction (string s)
71 split (b, s, is_any_of (" "));
73 boost::throw_exception (XMLError ("malformed fraction " + s + " in XML node"));
75 numerator = raw_convert<int> (b[0]);
76 denominator = raw_convert<int> (b[1]);
80 Fraction::as_string () const
82 return String::compose ("%1 %2", numerator, denominator);
86 dcp::operator== (Fraction const & a, Fraction const & b)
88 return (a.numerator == b.numerator && a.denominator == b.denominator);
92 dcp::operator!= (Fraction const & a, Fraction const & b)
94 return (a.numerator != b.numerator || a.denominator != b.denominator);
98 dcp::operator<< (ostream& s, Fraction const & f)
100 s << f.numerator << "/" << f.denominator;
104 /** Construct a Colour, initialising it to black. */
113 /** Construct a Colour from R, G and B. The values run between
116 Colour::Colour (int r_, int g_, int b_)
124 /** Construct a Colour from an ARGB hex string; the alpha value is ignored.
125 * @param argb_hex A string of the form AARRGGBB, where e.g. RR is a two-character
128 Colour::Colour (string argb_hex)
131 if (sscanf (argb_hex.c_str(), "%2x%2x%2x%2x", &alpha, &r, &g, &b) != 4) {
132 boost::throw_exception (XMLError ("could not parse colour string"));
136 /** @return An ARGB string of the form AARRGGBB, where e.g. RR is a two-character
137 * hex value. The alpha value will always be FF (ie 255; maximum alpha).
140 Colour::to_argb_string () const
143 snprintf (buffer, sizeof(buffer), "FF%02X%02X%02X", r, g, b);
147 /** @return An RGB string of the form RRGGBB, where e.g. RR is a two-character
151 Colour::to_rgb_string () const
154 snprintf (buffer, sizeof(buffer), "%02X%02X%02X", r, g, b);
158 /** operator== for Colours.
159 * @param a First colour to compare.
160 * @param b Second colour to compare.
163 dcp::operator== (Colour const & a, Colour const & b)
165 return (a.r == b.r && a.g == b.g && a.b == b.b);
168 /** operator!= for Colours.
169 * @param a First colour to compare.
170 * @param b Second colour to compare.
173 dcp::operator!= (Colour const & a, Colour const & b)
179 dcp::operator<< (ostream& s, Colour const & c)
181 s << "(" << c.r << ", " << c.g << ", " << c.b << ")";
186 dcp::effect_to_string (Effect e)
197 boost::throw_exception (MiscError ("unknown effect type"));
201 dcp::string_to_effect (string s)
205 } else if (s == "border") {
207 } else if (s == "shadow") {
211 boost::throw_exception (DCPReadError ("unknown subtitle effect type"));
215 dcp::halign_to_string (HAlign h)
226 boost::throw_exception (MiscError ("unknown subtitle halign type"));
230 dcp::string_to_halign (string s)
234 } else if (s == "center") {
235 return HALIGN_CENTER;
236 } else if (s == "right") {
240 boost::throw_exception (DCPReadError ("unknown subtitle halign type"));
244 dcp::valign_to_string (VAlign v)
255 boost::throw_exception (MiscError ("unknown subtitle valign type"));
259 dcp::string_to_valign (string s)
263 } else if (s == "center") {
264 return VALIGN_CENTER;
265 } else if (s == "bottom") {
266 return VALIGN_BOTTOM;
269 boost::throw_exception (DCPReadError ("unknown subtitle valign type"));
273 dcp::direction_to_string (Direction v)
286 boost::throw_exception (MiscError ("unknown subtitle direction type"));
290 dcp::string_to_direction (string s)
292 if (s == "ltr" || s == "horizontal") {
293 return DIRECTION_LTR;
294 } else if (s == "rtl") {
295 return DIRECTION_RTL;
296 } else if (s == "ttb" || s == "vertical") {
297 return DIRECTION_TTB;
298 } else if (s == "btt") {
299 return DIRECTION_BTT;
302 boost::throw_exception (DCPReadError ("unknown subtitle direction type"));
305 /** Convert a content kind to a string which can be used in a
306 * <ContentKind> node.
307 * @param kind ContentKind.
311 dcp::content_kind_to_string (ContentKind kind)
323 return "transitional";
330 case PUBLIC_SERVICE_ANNOUNCEMENT:
333 return "advertisement";
343 /** Convert a string from a <ContentKind> node to a libdcp ContentKind.
344 * Reasonably tolerant about varying case.
345 * @param kind Content kind string.
346 * @return libdcp ContentKind.
349 dcp::content_kind_from_string (string kind)
351 transform (kind.begin(), kind.end(), kind.begin(), ::tolower);
353 if (kind == "feature") {
355 } else if (kind == "short") {
357 } else if (kind == "trailer") {
359 } else if (kind == "test") {
361 } else if (kind == "transitional") {
363 } else if (kind == "rating") {
365 } else if (kind == "teaser") {
367 } else if (kind == "policy") {
369 } else if (kind == "psa") {
370 return PUBLIC_SERVICE_ANNOUNCEMENT;
371 } else if (kind == "advertisement") {
372 return ADVERTISEMENT;
373 } else if (kind == "episode") {
375 } else if (kind == "promo") {
379 throw BadContentKindError (kind);
383 dcp::marker_to_string (dcp::Marker m)
412 dcp::marker_from_string (string s)
416 } else if (s == "LFOC") {
418 } else if (s == "FFTC") {
420 } else if (s == "LFTC") {
422 } else if (s == "FFOI") {
424 } else if (s == "LFOI") {
426 } else if (s == "FFEC") {
428 } else if (s == "LFEC") {
430 } else if (s == "FFMC") {
432 } else if (s == "LFMC") {
439 Rating::Rating (cxml::ConstNodePtr node)
441 agency = node->string_child("Agency");
442 label = node->string_child("Label");
447 Rating::as_xml (xmlpp::Element* parent) const
449 parent->add_child("Agency")->add_child_text(agency);
450 parent->add_child("Label")->add_child_text(label);
454 dcp::operator== (Rating const & a, Rating const & b)
456 return a.agency == b.agency && a.label == b.label;
460 dcp::operator<< (ostream& s, Rating const & r)
462 s << r.agency << " " << r.label;