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