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 ratio of the container (including any padding) */
  42         float container_ratio () const;
  43
  44         int dcp_padding (boost::shared_ptr<const Film>) const;
  45
  46         /** @return size in pixels of the images that we should
  47          *  put in a DCP for this ratio.  This size will not correspond
  48          *  to the ratio when we are doing things like 16:9 in a Flat frame.
  49          */
  50         libdcp::Size dcp_size () const {
  51                 return _dcp_size;
  52         }
  53
  54         std::string id () const {
  55                 return _id;
  56         }
  57
  58         /** @return Full name to present to the user */
  59         virtual std::string name () const = 0;
  60
  61         /** @return Nickname (e.g. Flat, Scope) */
  62         std::string nickname () const {
  63                 return _nickname;
  64         }
  65
  66         std::string dci_name () const {
  67                 return _dci_name;
  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_id (std::string i);
  75         static std::vector<Format const *> all ();
  76         static void setup_formats ();
  77
  78 protected:
  79         /** @return the ratio */
  80         virtual float ratio (boost::shared_ptr<const Film> f) const = 0;
  81
  82         /** libdcp::Size in pixels of the images that we should
  83          *  put in a DCP for this ratio.  This size will not correspond
  84          *  to the ratio when we are doing things like 16:9 in a Flat frame.
  85          */
  86         libdcp::Size _dcp_size;
  87         /** id for use in metadata */
  88         std::string _id;
  89         /** nickname (e.g. Flat, Scope) */
  90         std::string _nickname;
  91         std::string _dci_name;
  92
  93 private:
  94         /** all available formats */
  95         static std::vector<Format const *> _formats;
  96 };
  97
  98 /** @class FixedFormat
  99  *  @brief Class to describe a format whose ratio is fixed regardless
 100  *  of source size.
 101  */
 102 class FixedFormat : public Format
 103 {
 104 public:
 105         FixedFormat (float, libdcp::Size, std::string, std::string, std::string);
 106
 107         float ratio (boost::shared_ptr<const Film>) const {
 108                 return _ratio;
 109         }
 110
 111         std::string name () const;
 112
 113 private:
 114
 115         float _ratio;
 116 };
 117
 118 class VariableFormat : public Format
 119 {
 120 public:
 121         VariableFormat (libdcp::Size, std::string, std::string, std::string);
 122
 123         float ratio (boost::shared_ptr<const Film> f) const;
 124
 125         std::string name () const;
 126 };