GPL boilerplates.
[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 "job.h"
26
27 #include "i18n.h"
28
29 using boost::shared_ptr;
30 using boost::optional;
31
32 VideoDecoder::VideoDecoder (shared_ptr<const Film> f)
33         : Decoder (f)
34         , _video_frame (0)
35         , _last_source_time (0)
36 {
37
38 }
39
40 /** Called by subclasses to tell the world that some video data is ready.
41  *  We find a subtitle then emit it for listeners.
42  *  @param image frame to emit.
43  *  @param t Time of the frame within the source, in seconds.
44  */
45 void
46 VideoDecoder::emit_video (shared_ptr<Image> image, double t)
47 {
48         shared_ptr<Subtitle> sub;
49         if (_timed_subtitle && _timed_subtitle->displayed_at (t)) {
50                 sub = _timed_subtitle->subtitle ();
51         }
52
53         signal_video (image, false, sub);
54         _last_source_time = t;
55 }
56
57 bool
58 VideoDecoder::have_last_video () const
59 {
60         return _last_image;
61 }
62
63 /** Called by subclasses to repeat the last video frame that we
64  *  passed to emit_video().  If emit_video hasn't yet been called,
65  *  we will generate a black frame.
66  */
67 void
68 VideoDecoder::repeat_last_video ()
69 {
70         if (!_last_image) {
71                 _last_image.reset (new SimpleImage (pixel_format(), native_size(), true));
72                 _last_image->make_black ();
73         }
74
75         signal_video (_last_image, true, _last_subtitle);
76 }
77
78 /** Emit our signal to say that some video data is ready.
79  *  @param image Video frame.
80  *  @param same true if `image' is the same as the last one we emitted.
81  *  @param sub Subtitle for this frame, or 0.
82  */
83 void
84 VideoDecoder::signal_video (shared_ptr<Image> image, bool same, shared_ptr<Subtitle> sub)
85 {
86         TIMING (N_("Decoder emits %1"), _video_frame);
87         Video (image, same, sub);
88         ++_video_frame;
89
90         _last_image = image;
91         _last_subtitle = sub;
92 }
93
94 /** Set up the current subtitle.  This will be put onto frames that
95  *  fit within its time specification.  s may be 0 to say that there
96  *  is no current subtitle.
97  *  @param s New current subtitle, or 0.
98  */
99 void
100 VideoDecoder::emit_subtitle (shared_ptr<TimedSubtitle> s)
101 {
102         _timed_subtitle = s;
103         
104         if (_timed_subtitle) {
105                 Position const p = _timed_subtitle->subtitle()->position ();
106                 _timed_subtitle->subtitle()->set_position (Position (p.x - _film->crop().left, p.y - _film->crop().top));
107         }
108 }
109
110 void
111 VideoDecoder::set_progress (Job* j) const
112 {
113         assert (j);
114
115         if (_film->video_length()) {
116                 j->set_progress (float (_video_frame) / _film->video_length());
117         }
118 }