src/lib/format.h

   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.h
  21  *  @brief Classes to describe a format (aspect ratio) that a Film should
  22  *  be shown in.
  23  */
  24
  25 #include <string>
  26 #include <vector>
  27 #include "util.h"
  28
  29 class Film;
  30
  31 class Format
  32 {
  33 public:
  34         Format (Size dcp, std::string id, std::string n)
  35                 : _dcp_size (dcp)
  36                 , _id (id)
  37                 , _nickname (n)
  38         {}
  39
  40         /** @return the aspect ratio multiplied by 100
  41          *  (e.g. 239 for Cinemascope 2.39:1)
  42          */
  43         virtual int ratio_as_integer (Film const * f) const = 0;
  44
  45         /** @return the ratio as a floating point number */
  46         virtual float ratio_as_float (Film const * f) const = 0;
  47
  48         int dcp_padding (Film const * f) const;
  49
  50         /** @return size in pixels of the images that we should
  51          *  put in a DCP for this ratio.  This size will not correspond
  52          *  to the ratio when we are doing things like 16:9 in a Flat frame.
  53          */
  54         Size dcp_size () const {
  55                 return _dcp_size;
  56         }
  57
  58         std::string id () const {
  59                 return _id;
  60         }
  61
  62         /** @return Full name to present to the user */
  63         virtual std::string name () const = 0;
  64
  65         /** @return Nickname (e.g. Flat, Scope) */
  66         std::string nickname () const {
  67                 return _nickname;
  68         }
  69
  70         std::string as_metadata () const;
  71
  72         static Format const * from_nickname (std::string n);
  73         static Format const * from_metadata (std::string m);
  74         static Format const * from_index (int i);
  75         static Format const * from_id (std::string i);
  76         static int as_index (Format const * f);
  77         static std::vector<Format const *> all ();
  78         static void setup_formats ();
  79
  80 protected:
  81         /** Size in pixels of the images that we should
  82          *  put in a DCP for this ratio.  This size will not correspond
  83          *  to the ratio when we are doing things like 16:9 in a Flat frame.
  84          */
  85         Size _dcp_size;
  86         /** id for use in metadata */
  87         std::string _id;
  88         /** nickname (e.g. Flat, Scope) */
  89         std::string _nickname;
  90
  91 private:
  92         /** all available formats */
  93         static std::vector<Format const *> _formats;
  94 };
  95
  96 /** @class FixedFormat
  97  *  @brief Class to describe a format whose ratio is fixed regardless
  98  *  of source size.
  99  */
 100 class FixedFormat : public Format
 101 {
 102 public:
 103         FixedFormat (int, Size, std::string, std::string);
 104
 105         int ratio_as_integer (Film const *) const {
 106                 return _ratio;
 107         }
 108
 109         float ratio_as_float (Film const *) const {
 110                 return _ratio / 100.0;
 111         }
 112
 113         std::string name () const;
 114
 115 private:
 116
 117         /** Ratio expressed as the actual ratio multiplied by 100 */
 118         int _ratio;
 119 };
 120
 121 class VariableFormat : public Format
 122 {
 123 public:
 124         VariableFormat (Size, std::string, std::string);
 125
 126         int ratio_as_integer (Film const * f) const;
 127         float ratio_as_float (Film const * f) const;
 128
 129         std::string name () const;
 130 };