More player debugging for butler video-full states.
[dcpomatic.git] / src / lib / ratio.cc
1 /*
2     Copyright (C) 2013-2018 Carl Hetherington <cth@carlh.net>
3
4     This file is part of DCP-o-matic.
5
6     DCP-o-matic is free software; you can redistribute it and/or modify
7     it under the terms of the GNU General Public License as published by
8     the Free Software Foundation; either version 2 of the License, or
9     (at your option) any later version.
10
11     DCP-o-matic is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14     GNU General Public License for more details.
15
16     You should have received a copy of the GNU General Public License
17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
18
19 */
20
21 #include "ratio.h"
22 #include "util.h"
23 #include "config.h"
24 #include <dcp/types.h>
25 #include <cfloat>
26
27 #include "i18n.h"
28
29 using std::string;
30 using std::vector;
31 using boost::optional;
32
33 vector<Ratio const *> Ratio::_ratios;
34
35 void
36 Ratio::setup_ratios ()
37 {
38         _ratios.push_back (new Ratio (float(1290) / 1080, "119", _("1.19"),              optional<string>(),      "119"));
39         _ratios.push_back (new Ratio (float(1440) / 1080, "133", _("1.33 (4:3)"),        optional<string>(),      "133"));
40         _ratios.push_back (new Ratio (float(1485) / 1080, "138", _("1.38 (Academy)"),    optional<string>(),      "137"));
41         _ratios.push_back (new Ratio (float(1544) / 1080, "143", _("1.43 (IMAX)"),       optional<string>(),      "143"));
42         _ratios.push_back (new Ratio (float(1800) / 1080, "166", _("1.66"),              optional<string>(),      "166"));
43         _ratios.push_back (new Ratio (float(1920) / 1080, "178", _("1.78 (16:9 or HD)"), optional<string>(),      "178"));
44         _ratios.push_back (new Ratio (float(1998) / 1080, "185", _("1.85 (Flat)"),       string(_("DCI Flat")),   "F"));
45         _ratios.push_back (new Ratio (float(2048) /  872, "235", _("2.35 (35mm Scope)"), optional<string>(),      "S"));
46         _ratios.push_back (new Ratio (float(2048) /  858, "239", _("2.39 (Scope)"),      string(_("DCI Scope")),  "S"));
47         _ratios.push_back (new Ratio (float(2048) / 1080, "190", _("1.90 (Full frame)"), string(_("Full frame")), "C"));
48 }
49
50 Ratio const *
51 Ratio::from_id (string i)
52 {
53         /* We removed the ratio with id 137; replace it with 138 */
54         if (i == "137") {
55                 i = "138";
56         }
57
58         vector<Ratio const *>::iterator j = _ratios.begin ();
59         while (j != _ratios.end() && (*j)->id() != i) {
60                 ++j;
61         }
62
63         if (j == _ratios.end ()) {
64                 return 0;
65         }
66
67         return *j;
68 }
69
70 /** @return Ratio corresponding to a given fractional ratio (+/- 0.01), or 0 */
71 Ratio const *
72 Ratio::from_ratio (float r)
73 {
74         vector<Ratio const *>::iterator j = _ratios.begin ();
75         while (j != _ratios.end() && fabs ((*j)->ratio() - r) > 0.01) {
76                 ++j;
77         }
78
79         if (j == _ratios.end ()) {
80                 return 0;
81         }
82
83         return *j;
84 }
85
86 Ratio const *
87 Ratio::nearest_from_ratio (float r)
88 {
89         Ratio const * nearest = 0;
90         float distance = FLT_MAX;
91
92         for (vector<Ratio const *>::iterator i = _ratios.begin (); i != _ratios.end(); ++i) {
93                 float const d = fabs ((*i)->ratio() - r);
94                 if (d < distance) {
95                         distance = d;
96                         nearest = *i;
97                 }
98         }
99
100         return nearest;
101 }
102
103 vector<Ratio const *>
104 Ratio::containers ()
105 {
106         if (Config::instance()->allow_any_container()) {
107                 return _ratios;
108         }
109
110         vector<Ratio const *> r;
111         r.push_back (Ratio::from_id ("185"));
112         r.push_back (Ratio::from_id ("239"));
113         r.push_back (Ratio::from_id ("190"));
114         return r;
115 }
116
117 string
118 Ratio::container_nickname () const
119 {
120         if (!_container_nickname) {
121                 /* Fall back to the image nickname; this just for when non-standard container
122                    ratios are enabled.
123                 */
124                 return _image_nickname;
125         }
126
127         return *_container_nickname;
128 }