summaryrefslogtreecommitdiff
path: root/src/lib/container.h
blob: fc3c72792e0920472c6442e4458f978484d7f39b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
/*
    Copyright (C) 2013 Carl Hetherington <cth@carlh.net>

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#include <vector>
#include <libdcp/util.h>

class Container
{
public:
	Container (libdcp::Size dcp, std::string id, std::string n, std::string d)
		: _dcp_size (dcp)
		, _id (id)
		, _nickname (n)
		, _dci_name (d)
	{}

	/** @return size in pixels of the images that we should
	 *  put in a DCP for this ratio.  This size will not correspond
	 *  to the ratio when we are doing things like 16:9 in a Flat frame.
	 */
	libdcp::Size dcp_size () const {
		return _dcp_size;
	}

	std::string id () const {
		return _id;
	}

	/** @return Full name to present to the user */
	std::string name () const;

	/** @return Nickname (e.g. Flat, Scope) */
	std::string nickname () const {
		return _nickname;
	}

	std::string dci_name () const {
		return _dci_name;
	}

	float ratio () const;
	
	static void setup_containers ();
	static Container const * from_id (std::string i);
	static std::vector<Container const *> all () {
		return _containers;
	}

private:
	/** libdcp::Size in pixels of the images that we should
	 *  put in a DCP for this container.
	 */
	libdcp::Size _dcp_size;
	/** id for use in metadata */
	std::string _id;
	/** nickname (e.g. Flat, Scope) */
	std::string _nickname;
	std::string _dci_name;

	/** all available containers */
	static std::vector<Container const *> _containers;
};