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 using std::string;
  34 using std::setprecision;
  35 using std::stringstream;
  36 using std::vector;
  37 using boost::shared_ptr;
  38 using libdcp::Size;
  39
  40 vector<Format const *> Format::_formats;
  41
  42 /** @return A name to be presented to the user */
  43 string
  44 FixedFormat::name () const
  45 {
  46         stringstream s;
  47         if (!_nickname.empty ()) {
  48                 s << _nickname << " (";
  49         }
  50
  51         s << setprecision(3) << (_ratio / 100.0) << ":1";
  52
  53         if (!_nickname.empty ()) {
  54                 s << ")";
  55         }
  56
  57         return s.str ();
  58 }
  59
  60 /** @return Identifier for this format as metadata for a Film's metadata file */
  61 string
  62 Format::as_metadata () const
  63 {
  64         return _id;
  65 }
  66
  67 /** Fill our _formats vector with all available formats */
  68 void
  69 Format::setup_formats ()
  70 {
  71         _formats.push_back (new FixedFormat (119, libdcp::Size (1285, 1080), "119", "1.19", "F"));
  72         _formats.push_back (new FixedFormat (133, libdcp::Size (1436, 1080), "133", "1.33", "F"));
  73         _formats.push_back (new FixedFormat (138, libdcp::Size (1485, 1080), "138", "1.375", "F"));
  74         _formats.push_back (new FixedFormat (133, libdcp::Size (1998, 1080), "133-in-flat", "4:3 within Flat", "F"));
  75         _formats.push_back (new FixedFormat (137, libdcp::Size (1480, 1080), "137", "Academy", "F"));
  76         _formats.push_back (new FixedFormat (166, libdcp::Size (1793, 1080), "166", "1.66", "F"));
  77         _formats.push_back (new FixedFormat (166, libdcp::Size (1998, 1080), "166-in-flat", "1.66 within Flat", "F"));
  78         _formats.push_back (new FixedFormat (178, libdcp::Size (1998, 1080), "178-in-flat", "16:9 within Flat", "F"));
  79         _formats.push_back (new FixedFormat (178, libdcp::Size (1920, 1080), "178", "16:9", "F"));
  80         _formats.push_back (new FixedFormat (185, libdcp::Size (1998, 1080), "185", "Flat", "F"));
  81         _formats.push_back (new FixedFormat (239, libdcp::Size (2048, 858), "239", "Scope", "S"));
  82         _formats.push_back (new VariableFormat (libdcp::Size (1998, 1080), "var-185", "Flat", "F"));
  83         _formats.push_back (new VariableFormat (libdcp::Size (2048, 858), "var-239", "Scope", "S"));
  84 }
  85
  86 /** @param n Nickname.
  87  *  @return Matching Format, or 0.
  88  */
  89 Format const *
  90 Format::from_nickname (string n)
  91 {
  92         vector<Format const *>::iterator i = _formats.begin ();
  93         while (i != _formats.end() && (*i)->nickname() != n) {
  94                 ++i;
  95         }
  96
  97         if (i == _formats.end ()) {
  98                 return 0;
  99         }
 100
 101         return *i;
 102 }
 103
 104 /** @param i Id.
 105  *  @return Matching Format, or 0.
 106  */
 107 Format const *
 108 Format::from_id (string i)
 109 {
 110         vector<Format const *>::iterator j = _formats.begin ();
 111         while (j != _formats.end() && (*j)->id() != i) {
 112                 ++j;
 113         }
 114
 115         if (j == _formats.end ()) {
 116                 return 0;
 117         }
 118
 119         return *j;
 120 }
 121
 122
 123 /** @param m Metadata, as returned from as_metadata().
 124  *  @return Matching Format, or 0.
 125  */
 126 Format const *
 127 Format::from_metadata (string m)
 128 {
 129         return from_id (m);
 130 }
 131
 132 /** @return All available formats */
 133 vector<Format const *>
 134 Format::all ()
 135 {
 136         return _formats;
 137 }
 138
 139 /** @param r Ratio multiplied by 100 (e.g. 185)
 140  *  @param dcp Size (in pixels) of the images that we should put in a DCP.
 141  *  @param id ID (e.g. 185)
 142  *  @param n Nick name (e.g. Flat)
 143  */
 144 FixedFormat::FixedFormat (int r, libdcp::Size dcp, string id, string n, string d)
 145         : Format (dcp, id, n, d)
 146         , _ratio (r)
 147 {
 148
 149 }
 150
 151 int
 152 Format::dcp_padding (shared_ptr<const Film> f) const
 153 {
 154         int p = rint ((_dcp_size.width - (_dcp_size.height * ratio_as_integer(f) / 100.0)) / 2.0);
 155
 156         /* This comes out -ve for Scope; bodge it */
 157         if (p < 0) {
 158                 p = 0;
 159         }
 160
 161         return p;
 162 }
 163
 164 VariableFormat::VariableFormat (libdcp::Size dcp, string id, string n, string d)
 165         : Format (dcp, id, n, d)
 166 {
 167
 168 }
 169
 170 int
 171 VariableFormat::ratio_as_integer (shared_ptr<const Film> f) const
 172 {
 173         return rint (ratio_as_float (f) * 100);
 174 }
 175
 176 float
 177 VariableFormat::ratio_as_float (shared_ptr<const Film> f) const
 178 {
 179         return float (f->size().width) / f->size().height;
 180 }
 181
 182 /** @return A name to be presented to the user */
 183 string
 184 VariableFormat::name () const
 185 {
 186         return _nickname;
 187 }