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