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