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 (libdcp::Size dcp, std::string id, std::string n, std::string d)
41 /** @return the ratio of the container (including any padding) */
42 float container_ratio () const;
44 int dcp_padding (boost::shared_ptr<const Film> f) const;
46 /** @return size in pixels of the images that we should
47 * put in a DCP for this ratio. This size will not correspond
48 * to the ratio when we are doing things like 16:9 in a Flat frame.
50 libdcp::Size dcp_size () const {
54 std::string id () const {
58 /** @return Full name to present to the user */
59 virtual std::string name () const = 0;
61 /** @return Nickname (e.g. Flat, Scope) */
62 std::string nickname () const {
66 std::string dci_name () const {
70 std::string as_metadata () const;
72 static Format const * from_nickname (std::string n);
73 static Format const * from_metadata (std::string m);
74 static Format const * from_id (std::string i);
75 static std::vector<Format const *> all ();
76 static void setup_formats ();
79 /** @return the ratio */
80 virtual float ratio (boost::shared_ptr<const Film> f) const = 0;
82 /** libdcp::Size in pixels of the images that we should
83 * put in a DCP for this ratio. This size will not correspond
84 * to the ratio when we are doing things like 16:9 in a Flat frame.
86 libdcp::Size _dcp_size;
87 /** id for use in metadata */
89 /** nickname (e.g. Flat, Scope) */
90 std::string _nickname;
91 std::string _dci_name;
94 /** all available formats */
95 static std::vector<Format const *> _formats;
98 /** @class FixedFormat
99 * @brief Class to describe a format whose ratio is fixed regardless
102 class FixedFormat : public Format
105 FixedFormat (float, libdcp::Size, std::string, std::string, std::string);
107 float ratio (boost::shared_ptr<const Film>) const {
111 std::string name () const;
118 class VariableFormat : public Format
121 VariableFormat (libdcp::Size, std::string, std::string, std::string);
123 float ratio (boost::shared_ptr<const Film> f) const;
125 std::string name () const;