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                                  _("Source scaled to 1.19:1")
  77                         ));
  78
  79         _formats.push_back (
  80                 new FixedFormat (133, libdcp::Size (1436, 1080), N_("133"), _("1.33"), N_("F"),
  81                                  _("Source scaled to 1.33:1")
  82                         ));
  83
  84         _formats.push_back (
  85                 new FixedFormat (138, libdcp::Size (1485, 1080), N_("138"), _("1.375"), N_("F"),
  86                                  _("Source scaled to 1.375:1")
  87                         ));
  88
  89         _formats.push_back (
  90                 new FixedFormat (133, libdcp::Size (1998, 1080), N_("133-in-flat"), _("4:3 within Flat"), N_("F"),
  91                                  _("Source scaled to 1.33:1 then pillarboxed to Flat")
  92                         ));
  93
  94         _formats.push_back (
  95                 new FixedFormat (137, libdcp::Size (1480, 1080), N_("137"), _("Academy"), N_("F"),
  96                                  _("Source scaled to 1.37:1 (Academy ratio)")
  97                         ));
  98
  99         _formats.push_back (
 100                 new FixedFormat (166, libdcp::Size (1793, 1080), N_("166"), _("1.66"), N_("F"),
 101                                  _("Source scaled to 1.66:1")
 102                         ));
 103
 104         _formats.push_back (
 105                 new FixedFormat (166, libdcp::Size (1998, 1080), N_("166-in-flat"), _("1.66 within Flat"), N_("F"),
 106                                  _("Source scaled to 1.66:1 then pillarboxed to Flat")
 107                         ));
 108
 109         _formats.push_back (
 110                 new FixedFormat (178, libdcp::Size (1998, 1080), N_("178-in-flat"), _("16:9 within Flat"), N_("F"),
 111                                  _("Source scaled to 1.78:1 then pillarboxed to Flat")
 112                         ));
 113
 114         _formats.push_back (
 115                 new FixedFormat (178, libdcp::Size (1920, 1080), N_("178"), _("16:9"), N_("F"),
 116                                  _("Source scaled to 1.78:1")
 117                         ));
 118
 119         _formats.push_back (
 120                 new FixedFormat (185, libdcp::Size (1998, 1080), N_("185"), _("Flat"), N_("F"),
 121                                  _("Source scaled to Flat (1.85:1)")
 122                         ));
 123
 124         _formats.push_back (
 125                 new FixedFormat (239, libdcp::Size (2048, 858), N_("239"), _("Scope"), N_("S"),
 126                                  _("Source scaled to Scope (2.39:1)")
 127                         ));
 128
 129         _formats.push_back (
 130                 new VariableFormat (libdcp::Size (1998, 1080), N_("var-185"), _("Flat without stretch"), N_("F"),
 131                                     _("Source scaled to fit Flat preserving its aspect ratio")
 132                         ));
 133
 134         _formats.push_back (
 135                 new VariableFormat (libdcp::Size (2048, 858), N_("var-239"), _("Scope without stretch"), N_("S"),
 136                                     _("Source scaled to fit Scope preserving its aspect ratio")
 137                         ));
 138 }
 139
 140 /** @param n Nickname.
 141  *  @return Matching Format, or 0.
 142  */
 143 Format const *
 144 Format::from_nickname (string n)
 145 {
 146         vector<Format const *>::iterator i = _formats.begin ();
 147         while (i != _formats.end() && (*i)->nickname() != n) {
 148                 ++i;
 149         }
 150
 151         if (i == _formats.end ()) {
 152                 return 0;
 153         }
 154
 155         return *i;
 156 }
 157
 158 /** @param i Id.
 159  *  @return Matching Format, or 0.
 160  */
 161 Format const *
 162 Format::from_id (string i)
 163 {
 164         vector<Format const *>::iterator j = _formats.begin ();
 165         while (j != _formats.end() && (*j)->id() != i) {
 166                 ++j;
 167         }
 168
 169         if (j == _formats.end ()) {
 170                 return 0;
 171         }
 172
 173         return *j;
 174 }
 175
 176
 177 /** @param m Metadata, as returned from as_metadata().
 178  *  @return Matching Format, or 0.
 179  */
 180 Format const *
 181 Format::from_metadata (string m)
 182 {
 183         return from_id (m);
 184 }
 185
 186 /** @return All available formats */
 187 vector<Format const *>
 188 Format::all ()
 189 {
 190         return _formats;
 191 }
 192
 193 /** @param r Ratio multiplied by 100 (e.g. 185)
 194  *  @param dcp Size (in pixels) of the images that we should put in a DCP.
 195  *  @param id ID (e.g. 185)
 196  *  @param n Nick name (e.g. Flat)
 197  */
 198 FixedFormat::FixedFormat (int r, libdcp::Size dcp, string id, string n, string d, string e)
 199         : Format (dcp, id, n, d, e)
 200         , _ratio (r)
 201 {
 202
 203 }
 204
 205 /** @return Number of pixels (int the DCP image) to pad either side of the film
 206  *  (so there are dcp_padding() pixels on the left and dcp_padding() on the right)
 207  */
 208 int
 209 Format::dcp_padding (shared_ptr<const Film> f) const
 210 {
 211         int p = rint ((_dcp_size.width - (_dcp_size.height * ratio_as_integer(f) / 100.0)) / 2.0);
 212
 213         /* This comes out -ve for Scope; bodge it */
 214         if (p < 0) {
 215                 p = 0;
 216         }
 217
 218         return p;
 219 }
 220
 221 float
 222 Format::container_ratio_as_float () const
 223 {
 224         return static_cast<float> (_dcp_size.width) / _dcp_size.height;
 225 }
 226
 227 VariableFormat::VariableFormat (libdcp::Size dcp, string id, string n, string d, string e)
 228         : Format (dcp, id, n, d, e)
 229 {
 230
 231 }
 232
 233 int
 234 VariableFormat::ratio_as_integer (shared_ptr<const Film> f) const
 235 {
 236         return rint (ratio_as_float (f) * 100);
 237 }
 238
 239 float
 240 VariableFormat::ratio_as_float (shared_ptr<const Film> f) const
 241 {
 242         return float (f->size().width) / f->size().height;
 243 }
 244
 245 /** @return A name to be presented to the user */
 246 string
 247 VariableFormat::name () const
 248 {
 249         return _nickname;
 250 }