src/lib/format.cc

   1 /*
   2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19
  20 /** @file src/format.cc
  21  *  @brief Class to describe a format (aspect ratio) that a Film should
  22  *  be shown in.
  23  */
  24
  25 #include <sstream>
  26 #include <cstdlib>
  27 #include <cassert>
  28 #include <iomanip>
  29 #include <iostream>
  30 #include "format.h"
  31 #include "film.h"
  32
  33 #include "i18n.h"
  34
  35 using std::string;
  36 using std::setprecision;
  37 using std::stringstream;
  38 using std::vector;
  39 using boost::shared_ptr;
  40 using libdcp::Size;
  41
  42 vector<Format const *> Format::_formats;
  43
  44 /** @return A name to be presented to the user */
  45 string
  46 FixedFormat::name () const
  47 {
  48         stringstream s;
  49         if (!_nickname.empty ()) {
  50                 s << _nickname << N_(" (");
  51         }
  52
  53         s << setprecision(3) << (_ratio / 100.0) << N_(":1");
  54
  55         if (!_nickname.empty ()) {
  56                 s << N_(")");
  57         }
  58
  59         return s.str ();
  60 }
  61
  62 /** @return Identifier for this format as metadata for a Film's metadata file */
  63 string
  64 Format::as_metadata () const
  65 {
  66         return _id;
  67 }
  68
  69 /** Fill our _formats vector with all available formats */
  70 void
  71 Format::setup_formats ()
  72 {
  73         /// TRANSLATORS: these are film picture aspect ratios; "Academy" means 1.37, "Flat" 1.85 and "Scope" 2.39.
  74         _formats.push_back (
  75                 new FixedFormat (119, libdcp::Size (1285, 1080), N_("119"), _("1.19"), N_("F")
  76                         ));
  77
  78         _formats.push_back (
  79                 new FixedFormat (133, libdcp::Size (1436, 1080), N_("133"), _("1.33"), N_("F")
  80                         ));
  81
  82         _formats.push_back (
  83                 new FixedFormat (138, libdcp::Size (1485, 1080), N_("138"), _("1.375"), N_("F")
  84                         ));
  85
  86         _formats.push_back (
  87                 new FixedFormat (133, libdcp::Size (1998, 1080), N_("133-in-flat"), _("4:3 within Flat"), N_("F")
  88                         ));
  89
  90         _formats.push_back (
  91                 new FixedFormat (137, libdcp::Size (1480, 1080), N_("137"), _("Academy"), N_("F")
  92                         ));
  93
  94         _formats.push_back (
  95                 new FixedFormat (166, libdcp::Size (1793, 1080), N_("166"), _("1.66"), N_("F")
  96                         ));
  97
  98         _formats.push_back (
  99                 new FixedFormat (166, libdcp::Size (1998, 1080), N_("166-in-flat"), _("1.66 within Flat"), N_("F")
 100                         ));
 101
 102         _formats.push_back (
 103                 new FixedFormat (178, libdcp::Size (1998, 1080), N_("178-in-flat"), _("16:9 within Flat"), N_("F")
 104                         ));
 105
 106         _formats.push_back (
 107                 new FixedFormat (178, libdcp::Size (1920, 1080), N_("178"), _("16:9"), N_("F")
 108                         ));
 109
 110         _formats.push_back (
 111                 new FixedFormat (185, libdcp::Size (1998, 1080), N_("185"), _("Flat"), N_("F")
 112                         ));
 113
 114         _formats.push_back (
 115                 new FixedFormat (239, libdcp::Size (2048, 858), N_("239"), _("Scope"), N_("S")
 116                         ));
 117
 118         _formats.push_back (
 119                 new VariableFormat (libdcp::Size (1998, 1080), N_("var-185"), _("Flat without stretch"), N_("F")
 120                         ));
 121
 122         _formats.push_back (
 123                 new VariableFormat (libdcp::Size (2048, 858), N_("var-239"), _("Scope without stretch"), N_("S")
 124                         ));
 125 }
 126
 127 /** @param n Nickname.
 128  *  @return Matching Format, or 0.
 129  */
 130 Format const *
 131 Format::from_nickname (string n)
 132 {
 133         vector<Format const *>::iterator i = _formats.begin ();
 134         while (i != _formats.end() && (*i)->nickname() != n) {
 135                 ++i;
 136         }
 137
 138         if (i == _formats.end ()) {
 139                 return 0;
 140         }
 141
 142         return *i;
 143 }
 144
 145 /** @param i Id.
 146  *  @return Matching Format, or 0.
 147  */
 148 Format const *
 149 Format::from_id (string i)
 150 {
 151         vector<Format const *>::iterator j = _formats.begin ();
 152         while (j != _formats.end() && (*j)->id() != i) {
 153                 ++j;
 154         }
 155
 156         if (j == _formats.end ()) {
 157                 return 0;
 158         }
 159
 160         return *j;
 161 }
 162
 163
 164 /** @param m Metadata, as returned from as_metadata().
 165  *  @return Matching Format, or 0.
 166  */
 167 Format const *
 168 Format::from_metadata (string m)
 169 {
 170         return from_id (m);
 171 }
 172
 173 /** @return All available formats */
 174 vector<Format const *>
 175 Format::all ()
 176 {
 177         return _formats;
 178 }
 179
 180 /** @param r Ratio multiplied by 100 (e.g. 185)
 181  *  @param dcp Size (in pixels) of the images that we should put in a DCP.
 182  *  @param id ID (e.g. 185)
 183  *  @param n Nick name (e.g. Flat)
 184  */
 185 FixedFormat::FixedFormat (int r, libdcp::Size dcp, string id, string n, string d)
 186         : Format (dcp, id, n, d)
 187         , _ratio (r)
 188 {
 189
 190 }
 191
 192 /** @return Number of pixels (int the DCP image) to pad either side of the film
 193  *  (so there are dcp_padding() pixels on the left and dcp_padding() on the right)
 194  */
 195 int
 196 Format::dcp_padding (shared_ptr<const Film> f) const
 197 {
 198         int p = rint ((_dcp_size.width - (_dcp_size.height * ratio_as_integer(f) / 100.0)) / 2.0);
 199
 200         /* This comes out -ve for Scope; bodge it */
 201         if (p < 0) {
 202                 p = 0;
 203         }
 204
 205         return p;
 206 }
 207
 208 float
 209 Format::container_ratio_as_float () const
 210 {
 211         return static_cast<float> (_dcp_size.width) / _dcp_size.height;
 212 }
 213
 214 VariableFormat::VariableFormat (libdcp::Size dcp, string id, string n, string d)
 215         : Format (dcp, id, n, d)
 216 {
 217
 218 }
 219
 220 int
 221 VariableFormat::ratio_as_integer (shared_ptr<const Film> f) const
 222 {
 223         return rint (ratio_as_float (f) * 100);
 224 }
 225
 226 float
 227 VariableFormat::ratio_as_float (shared_ptr<const Film> f) const
 228 {
 229         return float (f->size().width) / f->size().height;
 230 }
 231
 232 /** @return A name to be presented to the user */
 233 string
 234 VariableFormat::name () const
 235 {
 236         return _nickname;
 237 }