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 (libdcp::Size dcp, std::string id, std::string n, std::string d)
  27                 : _dcp_size (dcp)
  28                 , _id (id)
  29                 , _nickname (n)
  30                 , _dci_name (d)
  31         {}
  32
  33         /** @return size in pixels of the images that we should
  34          *  put in a DCP for this ratio.  This size will not correspond
  35          *  to the ratio when we are doing things like 16:9 in a Flat frame.
  36          */
  37         libdcp::Size dcp_size () const {
  38                 return _dcp_size;
  39         }
  40
  41         std::string id () const {
  42                 return _id;
  43         }
  44
  45         /** @return Full name to present to the user */
  46         std::string name () const;
  47
  48         /** @return Nickname (e.g. Flat, Scope) */
  49         std::string nickname () const {
  50                 return _nickname;
  51         }
  52
  53         std::string dci_name () const {
  54                 return _dci_name;
  55         }
  56
  57         float ratio () const;
  58
  59         static void setup_containers ();
  60         static Container const * from_id (std::string i);
  61         static std::vector<Container const *> all () {
  62                 return _containers;
  63         }
  64
  65 private:
  66         /** libdcp::Size in pixels of the images that we should
  67          *  put in a DCP for this container.
  68          */
  69         libdcp::Size _dcp_size;
  70         /** id for use in metadata */
  71         std::string _id;
  72         /** nickname (e.g. Flat, Scope) */
  73         std::string _nickname;
  74         std::string _dci_name;
  75
  76         /** all available containers */
  77         static std::vector<Container const *> _containers;
  78 };