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.cc
21 * @brief Class to describe a format (aspect ratio) that a Film should
36 using std::setprecision;
37 using std::stringstream;
39 using boost::shared_ptr;
42 vector<Format const *> Format::_formats;
44 /** @return A name to be presented to the user */
46 FixedFormat::name () const
49 if (!_nickname.empty ()) {
50 s << _nickname << N_(" (");
53 s << setprecision(3) << _ratio << N_(":1");
55 if (!_nickname.empty ()) {
62 /** @return Identifier for this format as metadata for a Film's metadata file */
64 Format::as_metadata () const
69 /** Fill our _formats vector with all available formats */
71 Format::setup_formats ()
73 /// TRANSLATORS: these are film picture aspect ratios; "Academy" means 1.37, "Flat" 1.85 and "Scope" 2.39.
75 new FixedFormat (1.19, libdcp::Size (1285, 1080), "119", _("1.19"), "F"
79 new FixedFormat (4.0 / 3.0, libdcp::Size (1436, 1080), "133", _("4:3"), "F"
83 new FixedFormat (1.38, libdcp::Size (1485, 1080), "138", _("1.375"), "F"
87 new FixedFormat (4.0 / 3.0, libdcp::Size (1998, 1080), "133-in-flat", _("4:3 within Flat"), "F"
91 new FixedFormat (1.37, libdcp::Size (1480, 1080), "137", _("Academy"), "F"
95 new FixedFormat (1.66, libdcp::Size (1793, 1080), "166", _("1.66"), "F"
99 new FixedFormat (1.66, libdcp::Size (1998, 1080), "166-in-flat", _("1.66 within Flat"), "F"
103 new FixedFormat (1.78, libdcp::Size (1998, 1080), "178-in-flat", _("16:9 within Flat"), "F"
107 new FixedFormat (1.78, libdcp::Size (1920, 1080), "178", _("16:9"), "F"
111 new FixedFormat (1.85, libdcp::Size (1998, 1080), "185", _("Flat"), "F"
115 new FixedFormat (1.78, libdcp::Size (2048, 858), "178-in-scope", _("16:9 within Scope"), "S"
119 new FixedFormat (2.39, libdcp::Size (2048, 858), "239", _("Scope"), "S"
123 new FixedFormat (1.896, libdcp::Size (2048, 1080), "full-frame", _("Full frame"), "C"
127 new VariableFormat (libdcp::Size (1998, 1080), "var-185", _("Flat without stretch"), "F"
131 new VariableFormat (libdcp::Size (2048, 858), "var-239", _("Scope without stretch"), "S"
135 /** @param n Nickname.
136 * @return Matching Format, or 0.
139 Format::from_nickname (string n)
141 vector<Format const *>::iterator i = _formats.begin ();
142 while (i != _formats.end() && (*i)->nickname() != n) {
146 if (i == _formats.end ()) {
154 * @return Matching Format, or 0.
157 Format::from_id (string i)
159 vector<Format const *>::iterator j = _formats.begin ();
160 while (j != _formats.end() && (*j)->id() != i) {
164 if (j == _formats.end ()) {
172 /** @param m Metadata, as returned from as_metadata().
173 * @return Matching Format, or 0.
176 Format::from_metadata (string m)
181 /** @return All available formats */
182 vector<Format const *>
189 * @param dcp Size (in pixels) of the images that we should put in a DCP.
190 * @param id ID (e.g. 185)
191 * @param n Nick name (e.g. Flat)
193 FixedFormat::FixedFormat (float r, libdcp::Size dcp, string id, string n, string d)
194 : Format (dcp, id, n, d)
200 /** @return Number of pixels (int the DCP image) to pad either side of the film
201 * (so there are dcp_padding() pixels on the left and dcp_padding() on the right)
204 Format::dcp_padding (shared_ptr<const Film> f) const
206 int p = rint ((_dcp_size.width - (_dcp_size.height * ratio(f))) / 2.0);
208 /* This comes out -ve for Scope; bodge it */
217 Format::container_ratio () const
219 return static_cast<float> (_dcp_size.width) / _dcp_size.height;
222 VariableFormat::VariableFormat (libdcp::Size dcp, string id, string n, string d)
223 : Format (dcp, id, n, d)
229 VariableFormat::ratio (shared_ptr<const Film> f) const
231 libdcp::Size const c = f->cropped_size (f->size ());
232 return float (c.width) / c.height;
235 /** @return A name to be presented to the user */
237 VariableFormat::name () const