src/lib/ratio.h

   1 /*
   2     Copyright (C) 2013-2018 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
  29  *  @brief Description of an image ratio.
  30  */
  31 class Ratio : public boost::noncopyable
  32 {
  33 public:
  34         Ratio (float ratio, std::string id, std::string in, boost::optional<std::string> cn, std::string d)
  35                 : _ratio (ratio)
  36                 , _id (id)
  37                 , _image_nickname (in)
  38                 , _container_nickname (cn)
  39                 , _isdcf_name (d)
  40         {}
  41
  42         std::string id () const {
  43                 return _id;
  44         }
  45
  46         std::string image_nickname () const {
  47                 return _image_nickname;
  48         }
  49
  50         std::string container_nickname () const;
  51
  52         bool used_for_container () const {
  53                 return static_cast<bool> (_container_nickname);
  54         }
  55
  56         std::string isdcf_name () const {
  57                 return _isdcf_name;
  58         }
  59
  60         float ratio () const {
  61                 return _ratio;
  62         }
  63
  64         static void setup_ratios ();
  65         static Ratio const * from_id (std::string i);
  66         static Ratio const * from_ratio (float r);
  67         static Ratio const * nearest_from_ratio (float r);
  68
  69         static std::vector<Ratio const *> all () {
  70                 return _ratios;
  71         }
  72
  73         static std::vector<Ratio const *> containers ();
  74
  75 private:
  76         float _ratio;
  77         /** id for use in metadata */
  78         std::string _id;
  79         /** nickname when used to describe an image ratio (e.g. Flat, Scope) */
  80         std::string _image_nickname;
  81         /** nickname when used to describe a container ratio */
  82         boost::optional<std::string> _container_nickname;
  83         std::string _isdcf_name;
  84
  85         static std::vector<Ratio const *> _ratios;
  86 };
  87
  88 #endif