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 Class 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 Format
  30  *  @brief Class to describe a format (aspect ratio) that a Film should
  31  *  be shown in.
  32  */
  33 class Format
  34 {
  35 public:
  36         Format (int, Size, std::string, std::string);
  37
  38         /** @return the aspect ratio multiplied by 100
  39          *  (e.g. 239 for Cinemascope 2.39:1)
  40          */
  41         int ratio_as_integer () const {
  42                 return _ratio;
  43         }
  44
  45         /** @return the ratio as a floating point number */
  46         float ratio_as_float () const {
  47                 return _ratio / 100.0;
  48         }
  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         std::string name () const;
  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         int dcp_padding () const;
  73
  74         static Format const * from_ratio (int);
  75         static Format const * from_nickname (std::string n);
  76         static Format const * from_metadata (std::string m);
  77         static Format const * from_index (int i);
  78         static Format const * from_id (std::string i);
  79         static int as_index (Format const * f);
  80         static std::vector<Format const *> all ();
  81         static void setup_formats ();
  82
  83 private:
  84
  85         /** Ratio expressed as the actual ratio multiplied by 100 */
  86         int _ratio;
  87         /** 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         Size _dcp_size;
  92         /** id for use in metadata */
  93         std::string _id;
  94         /** nickname (e.g. Flat, Scope) */
  95         std::string _nickname;
  96
  97         /** all available formats */
  98         static std::vector<Format const *> _formats;
  99 };
 100
 101