Remove out of date comment.
[dcpomatic.git] / src / lib / 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 /** @file  src/decoder.cc
21  *  @brief Parent class for decoders of content.
22  */
23
24 #include <iostream>
25 #include <stdint.h>
26 #include <boost/lexical_cast.hpp>
27 #include "film.h"
28 #include "format.h"
29 #include "job.h"
30 #include "options.h"
31 #include "exceptions.h"
32 #include "image.h"
33 #include "util.h"
34 #include "log.h"
35 #include "decoder.h"
36 #include "delay_line.h"
37 #include "subtitle.h"
38 #include "filter_graph.h"
39
40 using std::string;
41 using std::stringstream;
42 using std::min;
43 using std::pair;
44 using std::list;
45 using boost::shared_ptr;
46 using boost::optional;
47
48 /** @param f Film.
49  *  @param o Options.
50  *  @param j Job that we are running within, or 0
51  */
52 Decoder::Decoder (boost::shared_ptr<Film> f, boost::shared_ptr<const Options> o, Job* j)
53         : _film (f)
54         , _opt (o)
55         , _job (j)
56         , _video_frame (0)
57 {
58         
59 }
60
61 /** Start decoding */
62 void
63 Decoder::go ()
64 {
65         if (_job && !_film->dcp_length()) {
66                 _job->set_progress_unknown ();
67         }
68
69         while (pass () == false) {
70                 if (_job && _film->dcp_length()) {
71                         _job->set_progress (float (_video_frame) / _film->length().get());
72                 }
73         }
74 }
75
76 /** Called to tell the world that some audio data is ready
77  *  @param audio Audio data.
78  */
79 void
80 Decoder::process_audio (shared_ptr<AudioBuffers> audio)
81 {
82         /* Maybe apply gain */
83         if (_film->audio_gain() != 0) {
84                 float const linear_gain = pow (10, _film->audio_gain() / 20);
85                 for (int i = 0; i < audio->channels(); ++i) {
86                         for (int j = 0; j < audio->frames(); ++j) {
87                                 audio->data(i)[j] *= linear_gain;
88                         }
89                 }
90         }
91
92         Audio (audio);
93 }
94
95 /** Called by subclasses to tell the world that some video data is ready.
96  *  We do some post-processing / filtering then emit it for listeners.
97  *  @param frame to decode; caller manages memory.
98  */
99 void
100 Decoder::process_video (AVFrame* frame)
101 {
102         shared_ptr<FilterGraph> graph;
103
104         list<shared_ptr<FilterGraph> >::iterator i = _filter_graphs.begin();
105         while (i != _filter_graphs.end() && !(*i)->can_process (Size (frame->width, frame->height), (AVPixelFormat) frame->format)) {
106                 ++i;
107         }
108
109         if (i == _filter_graphs.end ()) {
110                 graph.reset (new FilterGraph (_film, this, _opt->apply_crop, Size (frame->width, frame->height), (AVPixelFormat) frame->format));
111                 _filter_graphs.push_back (graph);
112                 _film->log()->log (String::compose ("New graph for %1x%2, pixel format %3", frame->width, frame->height, frame->format));
113         } else {
114                 graph = *i;
115         }
116
117         list<shared_ptr<Image> > images = graph->process (frame);
118
119         for (list<shared_ptr<Image> >::iterator i = images.begin(); i != images.end(); ++i) {
120                 shared_ptr<Subtitle> sub;
121                 if (_timed_subtitle && _timed_subtitle->displayed_at (double (video_frame()) / _film->frames_per_second())) {
122                         sub = _timed_subtitle->subtitle ();
123                 }
124
125                 emit_video (*i, sub);
126         }
127 }
128
129 void
130 Decoder::repeat_last_video ()
131 {
132         if (!_last_image) {
133                 _last_image.reset (new CompactImage (pixel_format(), native_size()));
134                 _last_image->make_black ();
135         }
136
137         emit_video (_last_image, _last_subtitle);
138 }
139
140 void
141 Decoder::emit_video (shared_ptr<Image> image, shared_ptr<Subtitle> sub)
142 {
143         TIMING ("Decoder emits %1", _video_frame);
144         Video (image, sub);
145         ++_video_frame;
146
147         _last_image = image;
148         _last_subtitle = sub;
149 }
150
151 void
152 Decoder::process_subtitle (shared_ptr<TimedSubtitle> s)
153 {
154         _timed_subtitle = s;
155         
156         if (_timed_subtitle && _opt->apply_crop) {
157                 Position const p = _timed_subtitle->subtitle()->position ();
158                 _timed_subtitle->subtitle()->set_position (Position (p.x - _film->crop().left, p.y - _film->crop().top));
159         }
160 }
161
162 void
163 Decoder::set_audio_stream (optional<AudioStream> s)
164 {
165         _audio_stream = s;
166 }
167
168 void
169 Decoder::set_subtitle_stream (optional<SubtitleStream> s)
170 {
171         _subtitle_stream = s;
172 }