2 Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 /** @file src/format.h
21 * @brief Classes to describe a format (aspect ratio) that a Film should
34 Format (Size dcp, std::string id, std::string n, std::string d)
41 /** @return the aspect ratio multiplied by 100
42 * (e.g. 239 for Cinemascope 2.39:1)
44 virtual int ratio_as_integer (boost::shared_ptr<const Film> f) const = 0;
46 /** @return the ratio as a floating point number */
47 virtual float ratio_as_float (boost::shared_ptr<const Film> f) const = 0;
49 int dcp_padding (boost::shared_ptr<const Film> f) const;
51 /** @return size in pixels of the images that we should
52 * put in a DCP for this ratio. This size will not correspond
53 * to the ratio when we are doing things like 16:9 in a Flat frame.
55 Size dcp_size () const {
59 std::string id () const {
63 /** @return Full name to present to the user */
64 virtual std::string name () const = 0;
66 /** @return Nickname (e.g. Flat, Scope) */
67 std::string nickname () const {
71 std::string dci_name () const {
75 std::string as_metadata () const;
77 static Format const * from_nickname (std::string n);
78 static Format const * from_metadata (std::string m);
79 static Format const * from_id (std::string i);
80 static std::vector<Format const *> all ();
81 static void setup_formats ();
84 /** Size in pixels of the images that we should
85 * put in a DCP for this ratio. This size will not correspond
86 * to the ratio when we are doing things like 16:9 in a Flat frame.
89 /** id for use in metadata */
91 /** nickname (e.g. Flat, Scope) */
92 std::string _nickname;
93 std::string _dci_name;
96 /** all available formats */
97 static std::vector<Format const *> _formats;
100 /** @class FixedFormat
101 * @brief Class to describe a format whose ratio is fixed regardless
104 class FixedFormat : public Format
107 FixedFormat (int, Size, std::string, std::string, std::string);
109 int ratio_as_integer (boost::shared_ptr<const Film>) const {
113 float ratio_as_float (boost::shared_ptr<const Film>) const {
114 return _ratio / 100.0;
117 std::string name () const;
121 /** Ratio expressed as the actual ratio multiplied by 100 */
125 class VariableFormat : public Format
128 VariableFormat (Size, std::string, std::string, std::string);
130 int ratio_as_integer (boost::shared_ptr<const Film> f) const;
131 float ratio_as_float (boost::shared_ptr<const Film> f) const;
133 std::string name () const;