Add and use new FrameRateChange constructors.
[dcpomatic.git] / src / lib / frame_rate_change.cc
1 /*
2     Copyright (C) 2012-2016 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 "frame_rate_change.h"
22 #include "types.h"
23 #include "content.h"
24 #include "film.h"
25 #include "compose.hpp"
26 #include <cmath>
27
28 #include "i18n.h"
29
30 using std::string;
31 using boost::shared_ptr;
32
33 static bool
34 about_equal (double a, double b)
35 {
36         return (fabs (a - b) < VIDEO_FRAME_RATE_EPSILON);
37 }
38
39 FrameRateChange::FrameRateChange (double source_, int dcp_)
40         : skip (false)
41         , repeat (1)
42         , change_speed (false)
43 {
44         construct (source_, dcp_);
45 }
46
47 void
48 FrameRateChange::construct (double source_, int dcp_)
49 {
50         source = source_;
51         dcp = dcp_;
52
53         if (fabs (source / 2.0 - dcp) < fabs (source - dcp)) {
54                 /* The difference between source and DCP frame rate will be lower
55                    (i.e. better) if we skip.
56                 */
57                 skip = true;
58         } else if (fabs (source * 2 - dcp) < fabs (source - dcp)) {
59                 /* The difference between source and DCP frame rate would be better
60                    if we repeated each frame once; it may be better still if we
61                    repeated more than once.  Work out the required repeat.
62                 */
63                 repeat = round (dcp / source);
64         }
65
66         speed_up = dcp / (source * factor());
67         change_speed = !about_equal (speed_up, 1.0);
68 }
69
70 FrameRateChange::FrameRateChange (shared_ptr<const Film> film, shared_ptr<const Content> content)
71 {
72         construct (content->active_video_frame_rate(film), film->video_frame_rate());
73 }
74
75 FrameRateChange::FrameRateChange (shared_ptr<const Film> film, Content const * content)
76 {
77         construct (content->active_video_frame_rate(film), film->video_frame_rate());
78 }
79
80 string
81 FrameRateChange::description () const
82 {
83         string description;
84
85         if (!skip && repeat == 1 && !change_speed) {
86                 description = _("Content and DCP have the same rate.\n");
87         } else {
88                 if (skip) {
89                         description = _("DCP will use every other frame of the content.\n");
90                 } else if (repeat == 2) {
91                         description = _("Each content frame will be doubled in the DCP.\n");
92                 } else if (repeat > 2) {
93                         description = String::compose (_("Each content frame will be repeated %1 more times in the DCP.\n"), repeat - 1);
94                 }
95
96                 if (change_speed) {
97                         double const pc = dcp * 100 / (source * factor());
98                         description += String::compose (_("DCP will run at %1%% of the content speed.\n"), pc);
99                 }
100         }
101
102         return description;
103 }