Add and use new FrameRateChange constructors.
[dcpomatic.git] / src / lib / frame_rate_change.h
1 /*
2     Copyright (C) 2012-2015 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 #ifndef DCPOMATIC_FRAME_RATE_CHANGE_H
22 #define DCPOMATIC_FRAME_RATE_CHANGE_H
23
24 #include <boost/shared_ptr.hpp>
25 #include <string>
26
27 class Film;
28 class Content;
29
30 class FrameRateChange
31 {
32 public:
33         FrameRateChange (double, int);
34         FrameRateChange (boost::shared_ptr<const Film> film, boost::shared_ptr<const Content> content);
35         FrameRateChange (boost::shared_ptr<const Film> film, Content const * content);
36
37         /** @return factor by which to multiply a source frame rate
38             to get the effective rate after any skip or repeat has happened.
39         */
40         double factor () const {
41                 if (skip) {
42                         return 0.5;
43                 }
44
45                 return repeat;
46         }
47
48         double source;
49         int dcp;
50
51         /** true to skip every other frame */
52         bool skip;
53         /** number of times to use each frame (e.g. 1 is normal, 2 means repeat each frame once, and so on) */
54         int repeat;
55         /** true if this DCP will run its video faster or slower than the source
56          *  without taking into account `repeat' nor `skip'.
57          *  (e.g. change_speed will be true if
58          *          source is 29.97fps, DCP is 30fps
59          *          source is 14.50fps, DCP is 30fps
60          *  but not if
61          *          source is 15.00fps, DCP is 30fps
62          *          source is 12.50fps, DCP is 25fps)
63          */
64         bool change_speed;
65
66         /** Amount by which the video is being sped-up in the DCP; e.g. for a
67          *  24fps source in a 25fps DCP this would be 25/24.
68          */
69         double speed_up;
70
71         std::string description () const;
72
73 private:
74         void construct (double source_, int dcp_);
75 };
76
77 #endif