Split timed from untimed sinks / sources. Should produce same output, in theory.
[dcpomatic.git] / src / lib / video_decoder.cc
1 /*
2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 #include "video_decoder.h"
21 #include "subtitle.h"
22 #include "film.h"
23 #include "image.h"
24 #include "log.h"
25 #include "options.h"
26 #include "job.h"
27
28 #include "i18n.h"
29
30 using boost::shared_ptr;
31 using boost::optional;
32
33 VideoDecoder::VideoDecoder (shared_ptr<Film> f, DecodeOptions o)
34         : Decoder (f, o)
35         , _video_frame (0)
36         , _last_source_time (0)
37 {
38
39 }
40
41 /** Called by subclasses to tell the world that some video data is ready.
42  *  We find a subtitle then emit it for listeners.
43  *  @param image frame to emit.
44  *  @param t Time of the frame within the source, in seconds.
45  */
46 void
47 VideoDecoder::emit_video (shared_ptr<Image> image, double t)
48 {
49         shared_ptr<Subtitle> sub;
50         if (_timed_subtitle && _timed_subtitle->displayed_at (t)) {
51                 sub = _timed_subtitle->subtitle ();
52         }
53
54         signal_video (image, false, sub, t);
55         _last_source_time = t;
56 }
57
58 /** Called by subclasses to repeat the last video frame that we
59  *  passed to emit_video().  If emit_video hasn't yet been called,
60  *  we will generate a black frame.
61  */
62 void
63 VideoDecoder::repeat_last_video (double t)
64 {
65         if (!_last_image) {
66                 _last_image.reset (new SimpleImage (pixel_format(), native_size(), true));
67                 _last_image->make_black ();
68         }
69
70         signal_video (_last_image, true, _last_subtitle, t);
71 }
72
73 /** Emit our signal to say that some video data is ready.
74  *  @param image Video frame.
75  *  @param same true if `image' is the same as the last one we emitted.
76  *  @param sub Subtitle for this frame, or 0.
77  */
78 void
79 VideoDecoder::signal_video (shared_ptr<Image> image, bool same, shared_ptr<Subtitle> sub, double t)
80 {
81         TIMING (N_("Decoder emits %1"), _video_frame);
82         Video (image, same, sub, t);
83         ++_video_frame;
84
85         _last_image = image;
86         _last_subtitle = sub;
87 }
88
89 /** Set up the current subtitle.  This will be put onto frames that
90  *  fit within its time specification.  s may be 0 to say that there
91  *  is no current subtitle.
92  *  @param s New current subtitle, or 0.
93  */
94 void
95 VideoDecoder::emit_subtitle (shared_ptr<TimedSubtitle> s)
96 {
97         _timed_subtitle = s;
98         
99         if (_timed_subtitle) {
100                 Position const p = _timed_subtitle->subtitle()->position ();
101                 _timed_subtitle->subtitle()->set_position (Position (p.x - _film->crop().left, p.y - _film->crop().top));
102         }
103 }
104
105 /** Set which stream of subtitles we should use from our source.
106  *  @param s Stream to use.
107  */
108 void
109 VideoDecoder::set_subtitle_stream (shared_ptr<SubtitleStream> s)
110 {
111         _subtitle_stream = s;
112 }
113
114 void
115 VideoDecoder::set_progress (Job* j) const
116 {
117         assert (j);
118         
119         if (_film->length()) {
120                 j->set_progress (float (_video_frame) / _film->length().get());
121         }
122 }