src/lib/dcp_content_type.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/content_type.h
  21  *  @brief A description of the type of content for a DCP (e.g. feature, trailer etc.)
  22  */
  23
  24 #include <string>
  25 #include <vector>
  26 #include <libdcp/dcp.h>
  27
  28 /** @class DCPContentType
  29  *  @brief A description of the type of content for a DCP (e.g. feature, trailer etc.)
  30  */
  31 class DCPContentType
  32 {
  33 public:
  34         DCPContentType (std::string, libdcp::ContentKind);
  35
  36         /** @return user-visible `pretty' name */
  37         std::string pretty_name () const {
  38                 return _pretty_name;
  39         }
  40
  41         libdcp::ContentKind libdcp_kind () const {
  42                 return _libdcp_kind;
  43         }
  44
  45         static DCPContentType const * from_pretty_name (std::string);
  46         static DCPContentType const * from_index (int);
  47         static int as_index (DCPContentType const *);
  48         static std::vector<DCPContentType const *> all ();
  49         static void setup_dcp_content_types ();
  50
  51 private:
  52         std::string _pretty_name;
  53         libdcp::ContentKind _libdcp_kind;
  54
  55         /** All available DCP content types */
  56         static std::vector<DCPContentType const *> _dcp_content_types;
  57 };
  58