src/lib/ratio.h

   1 /*
   2     Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #ifndef DCPOMATIC_RATIO_H
  22 #define DCPOMATIC_RATIO_H
  23
  24 #include <dcp/util.h>
  25 #include <boost/utility.hpp>
  26 #include <vector>
  27
  28 class Ratio : public boost::noncopyable
  29 {
  30 public:
  31         Ratio (float ratio, std::string id, std::string n, std::string d)
  32                 : _ratio (ratio)
  33                 , _id (id)
  34                 , _nickname (n)
  35                 , _isdcf_name (d)
  36         {}
  37
  38         std::string id () const {
  39                 return _id;
  40         }
  41
  42         std::string nickname () const {
  43                 return _nickname;
  44         }
  45
  46         std::string isdcf_name () const {
  47                 return _isdcf_name;
  48         }
  49
  50         float ratio () const {
  51                 return _ratio;
  52         }
  53
  54         static void setup_ratios ();
  55         static Ratio const * from_id (std::string i);
  56         static Ratio const * from_ratio (float r);
  57         static Ratio const * nearest_from_ratio (float r);
  58         static std::vector<Ratio const *> all () {
  59                 return _ratios;
  60         }
  61
  62 private:
  63         float _ratio;
  64         /** id for use in metadata */
  65         std::string _id;
  66         /** nickname (e.g. Flat, Scope) */
  67         std::string _nickname;
  68         std::string _isdcf_name;
  69
  70         static std::vector<Ratio const *> _ratios;
  71 };
  72
  73 #endif