src/lib/ratio.h

   1 /*
   2     Copyright (C) 2013 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 #include <vector>
  21 #include <libdcp/util.h>
  22
  23 class Ratio
  24 {
  25 public:
  26         Ratio (float ratio, std::string id, std::string n, std::string d)
  27                 : _ratio (ratio)
  28                 , _id (id)
  29                 , _nickname (n)
  30                 , _dci_name (d)
  31         {}
  32
  33         libdcp::Size size (libdcp::Size) const;
  34
  35         std::string id () const {
  36                 return _id;
  37         }
  38
  39         std::string nickname () const {
  40                 return _nickname;
  41         }
  42
  43         std::string dci_name () const {
  44                 return _dci_name;
  45         }
  46
  47         float ratio () const {
  48                 return _ratio;
  49         }
  50
  51         static void setup_ratios ();
  52         static Ratio const * from_id (std::string i);
  53         static std::vector<Ratio const *> all () {
  54                 return _ratios;
  55         }
  56
  57 private:
  58         float _ratio;
  59         /** id for use in metadata */
  60         std::string _id;
  61         /** nickname (e.g. Flat, Scope) */
  62         std::string _nickname;
  63         std::string _dci_name;
  64
  65         static std::vector<Ratio const *> _ratios;
  66 };