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