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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
/*
Copyright (C) 2012 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.
*/
/** @file src/format.h
* @brief Classes to describe a format (aspect ratio) that a Film should
* be shown in.
*/
#include <string>
#include <vector>
#include "util.h"
class Film;
class Format
{
public:
Format (libdcp::Size dcp, std::string id, std::string n, std::string d)
: _dcp_size (dcp)
, _id (id)
, _nickname (n)
, _dci_name (d)
{}
/** @return the ratio of the container (including any padding) */
float container_ratio () const;
int dcp_padding (boost::shared_ptr<const Film> f) const;
/** @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 */
virtual std::string name () const = 0;
/** @return Nickname (e.g. Flat, Scope) */
std::string nickname () const {
return _nickname;
}
std::string dci_name () const {
return _dci_name;
}
std::string as_metadata () const;
static Format const * from_nickname (std::string n);
static Format const * from_metadata (std::string m);
static Format const * from_id (std::string i);
static std::vector<Format const *> all ();
static void setup_formats ();
protected:
/** @return the ratio */
virtual float ratio (boost::shared_ptr<const Film> f) const = 0;
/** libdcp::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;
/** id for use in metadata */
std::string _id;
/** nickname (e.g. Flat, Scope) */
std::string _nickname;
std::string _dci_name;
private:
/** all available formats */
static std::vector<Format const *> _formats;
};
/** @class FixedFormat
* @brief Class to describe a format whose ratio is fixed regardless
* of source size.
*/
class FixedFormat : public Format
{
public:
FixedFormat (float, libdcp::Size, std::string, std::string, std::string);
float ratio (boost::shared_ptr<const Film>) const {
return _ratio;
}
std::string name () const;
private:
float _ratio;
};
class VariableFormat : public Format
{
public:
VariableFormat (libdcp::Size, std::string, std::string, std::string);
float ratio (boost::shared_ptr<const Film> f) const;
std::string name () const;
};
|
