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