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 #ifndef DCPOMATIC_RATIO_H
  21 #define DCPOMATIC_RATIO_H
  22
  23 #include <dcp/util.h>
  24 #include <boost/utility.hpp>
  25 #include <vector>
  26
  27 class Ratio : public boost::noncopyable
  28 {
  29 public:
  30         Ratio (float ratio, std::string id, std::string n, std::string d)
  31                 : _ratio (ratio)
  32                 , _id (id)
  33                 , _nickname (n)
  34                 , _isdcf_name (d)
  35         {}
  36
  37         std::string id () const {
  38                 return _id;
  39         }
  40
  41         std::string nickname () const {
  42                 return _nickname;
  43         }
  44
  45         std::string isdcf_name () const {
  46                 return _isdcf_name;
  47         }
  48
  49         float ratio () const {
  50                 return _ratio;
  51         }
  52
  53         static void setup_ratios ();
  54         static Ratio const * from_id (std::string i);
  55         static Ratio const * from_ratio (float r);
  56         static Ratio const * nearest_from_ratio (float r);
  57         static std::vector<Ratio const *> all () {
  58                 return _ratios;
  59         }
  60
  61 private:
  62         float _ratio;
  63         /** id for use in metadata */
  64         std::string _id;
  65         /** nickname (e.g. Flat, Scope) */
  66         std::string _nickname;
  67         std::string _isdcf_name;
  68
  69         static std::vector<Ratio const *> _ratios;
  70 };
  71
  72 #endif