src/lib/container.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 Container
  24 {
  25 public:
  26         Container (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 name () const;
  40
  41         /** @return Nickname (e.g. Flat, Scope) */
  42         std::string nickname () const {
  43                 return _nickname;
  44         }
  45
  46         std::string dci_name () const {
  47                 return _dci_name;
  48         }
  49
  50         float ratio () const {
  51                 return _ratio;
  52         }
  53
  54         static void setup_containers ();
  55         static Container const * from_id (std::string i);
  56         static std::vector<Container const *> all () {
  57                 return _containers;
  58         }
  59
  60 private:
  61         float _ratio;
  62         /** id for use in metadata */
  63         std::string _id;
  64         /** nickname (e.g. Flat, Scope) */
  65         std::string _nickname;
  66         std::string _dci_name;
  67
  68         /** all available containers */
  69         static std::vector<Container const *> _containers;
  70 };