src/lib/format.h

   1 /*
   2     Copyright (C) 2012 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 /** @file src/format.h
  21  *  @brief Classes to describe a format (aspect ratio) that a Film should
  22  *  be shown in.
  23  */
  24
  25 #include <string>
  26 #include <vector>
  27 #include <libdcp/util.h>
  28
  29 class Film;
  30
  31 class Format
  32 {
  33 public:
  34         Format (libdcp::Size dcp, std::string id, std::string n)
  35                 : _dcp_size (dcp)
  36                 , _id (id)
  37                 , _nickname (n)
  38         {}
  39
  40         /** @return size in pixels of the images that we should
  41          *  put in a DCP for this format.
  42          */
  43         libdcp::Size dcp_size () const {
  44                 return _dcp_size;
  45         }
  46
  47         std::string id () const {
  48                 return _id;
  49         }
  50
  51         /** @return Full name to present to the user */
  52         std::string name () const;
  53
  54         /** @return Nickname (e.g. Flat, Scope) */
  55         std::string nickname () const {
  56                 return _nickname;
  57         }
  58
  59         static Format const * from_nickname (std::string n);
  60         static Format const * from_id (std::string i);
  61         static std::vector<Format const *> all ();
  62         static void setup_formats ();
  63
  64 protected:
  65         /** @return the ratio */
  66         float ratio () const;
  67
  68         /** libdcp::Size in pixels of the images that we should
  69          *  put in a DCP for this format.
  70          */
  71         libdcp::Size _dcp_size;
  72         /** id for use in metadata */
  73         std::string _id;
  74         /** nickname (e.g. Flat, Scope) */
  75         std::string _nickname;
  76
  77 private:
  78         /** all available formats */
  79         static std::vector<Format const *> _formats;
  80 };