Split examiner parts off decoder.
[dcpomatic.git] / src / lib / player.cc
1 /*
2     Copyright (C) 2013 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 <stdint.h>
21 #include "player.h"
22 #include "film.h"
23 #include "ffmpeg_decoder.h"
24 #include "ffmpeg_content.h"
25 #include "imagemagick_decoder.h"
26 #include "imagemagick_content.h"
27 #include "sndfile_decoder.h"
28 #include "sndfile_content.h"
29 #include "playlist.h"
30 #include "job.h"
31 #include "image.h"
32 #include "null_content.h"
33 #include "black_decoder.h"
34 #include "silence_decoder.h"
35
36 using std::list;
37 using std::cout;
38 using std::min;
39 using std::max;
40 using std::vector;
41 using boost::shared_ptr;
42 using boost::weak_ptr;
43 using boost::dynamic_pointer_cast;
44
45 #define DEBUG_PLAYER 1
46
47 struct Piece
48 {
49         Piece (shared_ptr<Content> c, shared_ptr<Decoder> d)
50                 : content (c)
51                 , decoder (d)
52         {}
53         
54         shared_ptr<Content> content;
55         shared_ptr<Decoder> decoder;
56 };
57         
58
59 #ifdef DEBUG_PLAYER
60 std::ostream& operator<<(std::ostream& s, Piece const & p)
61 {
62         if (dynamic_pointer_cast<NullContent> (p.content)) {
63                 if (dynamic_pointer_cast<SilenceDecoder> (p.decoder)) {
64                         s << "\tsilence    ";
65                 } else {
66                         s << "\tblack      ";
67                 }
68         } else if (dynamic_pointer_cast<FFmpegContent> (p.content)) {
69                 s << "\tffmpeg     ";
70         } else if (dynamic_pointer_cast<ImageMagickContent> (p.content)) {
71                 s << "\timagemagick";
72         } else if (dynamic_pointer_cast<SndfileContent> (p.content)) {
73                 s << "\tsndfile    ";
74         }
75         
76         s << " at " << p.content->start() << " until " << p.content->end();
77         
78         return s;
79 }
80 #endif  
81
82 Player::Player (shared_ptr<const Film> f, shared_ptr<const Playlist> p)
83         : _film (f)
84         , _playlist (p)
85         , _video (true)
86         , _audio (true)
87         , _have_valid_pieces (false)
88         , _position (0)
89         , _audio_buffers (f->dcp_audio_channels(), 0)
90         , _next_audio (0)
91 {
92         _playlist->Changed.connect (bind (&Player::playlist_changed, this));
93         _playlist->ContentChanged.connect (bind (&Player::content_changed, this, _1, _2));
94 }
95
96 void
97 Player::disable_video ()
98 {
99         _video = false;
100 }
101
102 void
103 Player::disable_audio ()
104 {
105         _audio = false;
106 }
107
108 bool
109 Player::pass ()
110 {
111         if (!_have_valid_pieces) {
112                 setup_pieces ();
113                 _have_valid_pieces = true;
114         }
115
116         /* Here we are just finding the active decoder with the earliest last emission time, then
117            calling pass on it.
118         */
119
120         Time earliest_t = TIME_MAX;
121         shared_ptr<Piece> earliest;
122
123         for (list<shared_ptr<Piece> >::iterator i = _pieces.begin(); i != _pieces.end(); ++i) {
124                 if ((*i)->decoder->done ()) {
125                         continue;
126                 }
127
128                 if (!_audio && dynamic_pointer_cast<AudioDecoder> ((*i)->decoder) && !dynamic_pointer_cast<VideoDecoder> ((*i)->decoder)) {
129                         continue;
130                 }
131                 
132                 Time const t = (*i)->content->start() + (*i)->decoder->position();
133                 if (t < earliest_t) {
134                         earliest_t = t;
135                         earliest = *i;
136                 }
137         }
138
139         if (!earliest) {
140                 flush ();
141                 return true;
142         }
143
144         earliest->decoder->pass ();
145         _position = earliest->content->start() + earliest->decoder->position ();
146
147         return false;
148 }
149
150 void
151 Player::process_video (weak_ptr<Content> weak_content, shared_ptr<const Image> image, bool same, Time time)
152 {
153         shared_ptr<Content> content = weak_content.lock ();
154         if (!content) {
155                 return;
156         }
157         
158         time += content->start ();
159         
160         Video (image, same, time);
161 }
162
163 void
164 Player::process_audio (weak_ptr<Content> weak_content, shared_ptr<const AudioBuffers> audio, Time time)
165 {
166         shared_ptr<Content> content = weak_content.lock ();
167         if (!content) {
168                 return;
169         }
170         
171         /* The time of this audio may indicate that some of our buffered audio is not going to
172            be added to any more, so it can be emitted.
173         */
174
175         time += content->start ();
176
177         cout << "Player gets " << audio->frames() << " @ " << time << " cf " << _next_audio << "\n";
178
179         if (time > _next_audio) {
180                 /* We can emit some audio from our buffers */
181                 OutputAudioFrame const N = _film->time_to_audio_frames (time - _next_audio);
182                 assert (N <= _audio_buffers.frames());
183                 shared_ptr<AudioBuffers> emit (new AudioBuffers (_audio_buffers.channels(), N));
184                 emit->copy_from (&_audio_buffers, N, 0, 0);
185                 Audio (emit, _next_audio);
186                 _next_audio += _film->audio_frames_to_time (N);
187
188                 /* And remove it from our buffers */
189                 if (_audio_buffers.frames() > N) {
190                         _audio_buffers.move (N, 0, _audio_buffers.frames() - N);
191                 }
192                 _audio_buffers.set_frames (_audio_buffers.frames() - N);
193         }
194
195         /* Now accumulate the new audio into our buffers */
196         _audio_buffers.ensure_size (_audio_buffers.frames() + audio->frames());
197         _audio_buffers.accumulate_frames (audio.get(), 0, 0, audio->frames ());
198         _audio_buffers.set_frames (_audio_buffers.frames() + audio->frames());
199 }
200
201 void
202 Player::flush ()
203 {
204         if (_audio_buffers.frames() > 0) {
205                 shared_ptr<AudioBuffers> emit (new AudioBuffers (_audio_buffers.channels(), _audio_buffers.frames()));
206                 emit->copy_from (&_audio_buffers, _audio_buffers.frames(), 0, 0);
207                 Audio (emit, _next_audio);
208                 _next_audio += _film->audio_frames_to_time (_audio_buffers.frames ());
209                 _audio_buffers.set_frames (0);
210         }
211 }
212
213 /** @return true on error */
214 void
215 Player::seek (Time t)
216 {
217         if (!_have_valid_pieces) {
218                 setup_pieces ();
219                 _have_valid_pieces = true;
220         }
221
222         if (_pieces.empty ()) {
223                 return;
224         }
225
226         for (list<shared_ptr<Piece> >::iterator i = _pieces.begin(); i != _pieces.end(); ++i) {
227                 Time s = t - (*i)->content->start ();
228                 s = max (static_cast<Time> (0), s);
229                 s = min ((*i)->content->length(), s);
230                 (*i)->decoder->seek (s);
231         }
232
233         /* XXX: don't seek audio because we don't need to... */
234 }
235
236
237 void
238 Player::seek_back ()
239 {
240
241 }
242
243 void
244 Player::seek_forward ()
245 {
246
247 }
248
249 void
250 Player::add_black_piece (Time s, Time len)
251 {
252         shared_ptr<NullContent> nc (new NullContent (_film, s, len));
253         nc->set_ratio (_film->container ());
254         shared_ptr<BlackDecoder> bd (new BlackDecoder (_film, nc));
255         bd->Video.connect (bind (&Player::process_video, this, nc, _1, _2, _3));
256         _pieces.push_back (shared_ptr<Piece> (new Piece (nc, bd)));
257 }
258
259 void
260 Player::add_silent_piece (Time s, Time len)
261 {
262         shared_ptr<NullContent> nc (new NullContent (_film, s, len));
263         shared_ptr<SilenceDecoder> sd (new SilenceDecoder (_film, nc));
264         sd->Audio.connect (bind (&Player::process_audio, this, nc, _1, _2));
265         _pieces.push_back (shared_ptr<Piece> (new Piece (nc, sd)));
266 }
267
268
269 void
270 Player::setup_pieces ()
271 {
272         list<shared_ptr<Piece> > old_pieces = _pieces;
273
274         _pieces.clear ();
275
276         Playlist::ContentList content = _playlist->content ();
277         sort (content.begin(), content.end(), ContentSorter ());
278         
279         for (Playlist::ContentList::iterator i = content.begin(); i != content.end(); ++i) {
280
281                 shared_ptr<Decoder> decoder;
282                 
283                 /* XXX: into content? */
284
285                 shared_ptr<const FFmpegContent> fc = dynamic_pointer_cast<const FFmpegContent> (*i);
286                 if (fc) {
287                         shared_ptr<FFmpegDecoder> fd (new FFmpegDecoder (_film, fc, _video, _audio));
288                         
289                         fd->Video.connect (bind (&Player::process_video, this, *i, _1, _2, _3));
290                         fd->Audio.connect (bind (&Player::process_audio, this, *i, _1, _2));
291                         if (_video_container_size) {
292                                 fd->set_video_container_size (_video_container_size.get ());
293                         }
294
295                         decoder = fd;
296                 }
297                 
298                 shared_ptr<const ImageMagickContent> ic = dynamic_pointer_cast<const ImageMagickContent> (*i);
299                 if (ic) {
300                         shared_ptr<ImageMagickDecoder> id;
301                         
302                         /* See if we can re-use an old ImageMagickDecoder */
303                         for (list<shared_ptr<Piece> >::const_iterator j = old_pieces.begin(); j != old_pieces.end(); ++j) {
304                                 shared_ptr<ImageMagickDecoder> imd = dynamic_pointer_cast<ImageMagickDecoder> ((*j)->decoder);
305                                 if (imd && imd->content() == ic) {
306                                         id = imd;
307                                 }
308                         }
309
310                         if (!id) {
311                                 id.reset (new ImageMagickDecoder (_film, ic));
312                                 id->Video.connect (bind (&Player::process_video, this, *i, _1, _2, _3));
313                                 if (_video_container_size) {
314                                         id->set_video_container_size (_video_container_size.get ());
315                                 }
316                         }
317
318                         decoder = id;
319                 }
320
321                 shared_ptr<const SndfileContent> sc = dynamic_pointer_cast<const SndfileContent> (*i);
322                 if (sc) {
323                         shared_ptr<AudioDecoder> sd (new SndfileDecoder (_film, sc));
324                         sd->Audio.connect (bind (&Player::process_audio, this, *i, _1, _2));
325
326                         decoder = sd;
327                 }
328
329                 _pieces.push_back (shared_ptr<Piece> (new Piece (*i, decoder)));
330         }
331
332         /* Fill in visual gaps with black and audio gaps with silence */
333
334         Time video_pos = 0;
335         Time audio_pos = 0;
336         list<shared_ptr<Piece> > pieces_copy = _pieces;
337         for (list<shared_ptr<Piece> >::iterator i = pieces_copy.begin(); i != pieces_copy.end(); ++i) {
338                 if (dynamic_pointer_cast<VideoContent> ((*i)->content)) {
339                         Time const diff = (*i)->content->start() - video_pos;
340                         if (diff > 0) {
341                                 add_black_piece (video_pos, diff);
342                         }
343                         video_pos = (*i)->content->end();
344                 }
345
346                 shared_ptr<AudioContent> ac = dynamic_pointer_cast<AudioContent> ((*i)->content);
347                 if (ac && ac->audio_channels()) {
348                         Time const diff = (*i)->content->start() - audio_pos;
349                         if (diff > 0) {
350                                 add_silent_piece (video_pos, diff);
351                         }
352                         audio_pos = (*i)->content->end();
353                 }
354         }
355
356         if (video_pos < audio_pos) {
357                 add_black_piece (video_pos, audio_pos - video_pos);
358         } else if (audio_pos < video_pos) {
359                 add_silent_piece (audio_pos, video_pos - audio_pos);
360         }
361
362 #ifdef DEBUG_PLAYER
363         cout << "=== Player setup:\n";
364         for (list<shared_ptr<Piece> >::iterator i = _pieces.begin(); i != _pieces.end(); ++i) {
365                 cout << *(i->get()) << "\n";
366         }
367 #endif  
368 }
369
370 void
371 Player::content_changed (weak_ptr<Content> w, int p)
372 {
373         shared_ptr<Content> c = w.lock ();
374         if (!c) {
375                 return;
376         }
377
378         if (p == ContentProperty::START || p == ContentProperty::LENGTH) {
379                 _have_valid_pieces = false;
380         }
381 }
382
383 void
384 Player::playlist_changed ()
385 {
386         _have_valid_pieces = false;
387 }
388
389 void
390 Player::set_video_container_size (libdcp::Size s)
391 {
392         _video_container_size = s;
393         for (list<shared_ptr<Piece> >::iterator i = _pieces.begin(); i != _pieces.end(); ++i) {
394                 shared_ptr<VideoDecoder> vd = dynamic_pointer_cast<VideoDecoder> ((*i)->decoder);
395                 if (vd) {
396                         vd->set_video_container_size (s);
397                 }
398         }
399 }