Merge commit '093804a93cc5da3f95f98265a5df116912443cec'
[ffmpeg.git] / libavfilter / src_movie.c
1 /*
2  * Copyright (c) 2010 Stefano Sabatini
3  * Copyright (c) 2008 Victor Paesa
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 /**
23  * @file
24  * movie video source
25  *
26  * @todo use direct rendering (no allocation of a new frame)
27  * @todo support a PTS correction mechanism
28  */
29
30 /* #define DEBUG */
31
32 #include <float.h>
33
34 #include "libavutil/attributes.h"
35 #include "libavutil/avstring.h"
36 #include "libavutil/avassert.h"
37 #include "libavutil/opt.h"
38 #include "libavutil/imgutils.h"
39 #include "libavutil/timestamp.h"
40 #include "libavformat/avformat.h"
41 #include "audio.h"
42 #include "avcodec.h"
43 #include "avfilter.h"
44 #include "formats.h"
45 #include "internal.h"
46 #include "video.h"
47
48 typedef struct {
49     AVStream *st;
50     int done;
51 } MovieStream;
52
53 typedef struct {
54     /* common A/V fields */
55     const AVClass *class;
56     int64_t seek_point;   ///< seekpoint in microseconds
57     double seek_point_d;
58     char *format_name;
59     char *file_name;
60     char *stream_specs; /**< user-provided list of streams, separated by + */
61     int stream_index; /**< for compatibility */
62     int loop_count;
63
64     AVFormatContext *format_ctx;
65     int eof;
66     AVPacket pkt, pkt0;
67     AVFrame *frame;   ///< video frame to store the decoded images in
68
69     int max_stream_index; /**< max stream # actually used for output */
70     MovieStream *st; /**< array of all streams, one per output */
71     int *out_index; /**< stream number -> output number map, or -1 */
72 } MovieContext;
73
74 #define OFFSET(x) offsetof(MovieContext, x)
75 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM | AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_VIDEO_PARAM
76
77 static const AVOption movie_options[]= {
78     { "filename",     NULL,                      OFFSET(file_name),    AV_OPT_TYPE_STRING,                                    .flags = FLAGS },
79     { "format_name",  "set format name",         OFFSET(format_name),  AV_OPT_TYPE_STRING,                                    .flags = FLAGS },
80     { "f",            "set format name",         OFFSET(format_name),  AV_OPT_TYPE_STRING,                                    .flags = FLAGS },
81     { "stream_index", "set stream index",        OFFSET(stream_index), AV_OPT_TYPE_INT,    { .i64 = -1 }, -1, INT_MAX,                 FLAGS  },
82     { "si",           "set stream index",        OFFSET(stream_index), AV_OPT_TYPE_INT,    { .i64 = -1 }, -1, INT_MAX,                 FLAGS  },
83     { "seek_point",   "set seekpoint (seconds)", OFFSET(seek_point_d), AV_OPT_TYPE_DOUBLE, { .dbl =  0 },  0, (INT64_MAX-1) / 1000000, FLAGS },
84     { "sp",           "set seekpoint (seconds)", OFFSET(seek_point_d), AV_OPT_TYPE_DOUBLE, { .dbl =  0 },  0, (INT64_MAX-1) / 1000000, FLAGS },
85     { "streams",      "set streams",             OFFSET(stream_specs), AV_OPT_TYPE_STRING, {.str =  0},  CHAR_MAX, CHAR_MAX, FLAGS },
86     { "s",            "set streams",             OFFSET(stream_specs), AV_OPT_TYPE_STRING, {.str =  0},  CHAR_MAX, CHAR_MAX, FLAGS },
87     { "loop",         "set loop count",          OFFSET(loop_count),   AV_OPT_TYPE_INT,    {.i64 =  1},  0,        INT_MAX, FLAGS },
88     { NULL },
89 };
90
91 static int movie_config_output_props(AVFilterLink *outlink);
92 static int movie_request_frame(AVFilterLink *outlink);
93
94 static AVStream *find_stream(void *log, AVFormatContext *avf, const char *spec)
95 {
96     int i, ret, already = 0, stream_id = -1;
97     char type_char[2], dummy;
98     AVStream *found = NULL;
99     enum AVMediaType type;
100
101     ret = sscanf(spec, "d%1[av]%d%c", type_char, &stream_id, &dummy);
102     if (ret >= 1 && ret <= 2) {
103         type = type_char[0] == 'v' ? AVMEDIA_TYPE_VIDEO : AVMEDIA_TYPE_AUDIO;
104         ret = av_find_best_stream(avf, type, stream_id, -1, NULL, 0);
105         if (ret < 0) {
106             av_log(log, AV_LOG_ERROR, "No %s stream with index '%d' found\n",
107                    av_get_media_type_string(type), stream_id);
108             return NULL;
109         }
110         return avf->streams[ret];
111     }
112     for (i = 0; i < avf->nb_streams; i++) {
113         ret = avformat_match_stream_specifier(avf, avf->streams[i], spec);
114         if (ret < 0) {
115             av_log(log, AV_LOG_ERROR,
116                    "Invalid stream specifier \"%s\"\n", spec);
117             return NULL;
118         }
119         if (!ret)
120             continue;
121         if (avf->streams[i]->discard != AVDISCARD_ALL) {
122             already++;
123             continue;
124         }
125         if (found) {
126             av_log(log, AV_LOG_WARNING,
127                    "Ambiguous stream specifier \"%s\", using #%d\n", spec, i);
128             break;
129         }
130         found = avf->streams[i];
131     }
132     if (!found) {
133         av_log(log, AV_LOG_WARNING, "Stream specifier \"%s\" %s\n", spec,
134                already ? "matched only already used streams" :
135                          "did not match any stream");
136         return NULL;
137     }
138     if (found->codec->codec_type != AVMEDIA_TYPE_VIDEO &&
139         found->codec->codec_type != AVMEDIA_TYPE_AUDIO) {
140         av_log(log, AV_LOG_ERROR, "Stream specifier \"%s\" matched a %s stream,"
141                "currently unsupported by libavfilter\n", spec,
142                av_get_media_type_string(found->codec->codec_type));
143         return NULL;
144     }
145     return found;
146 }
147
148 static int open_stream(void *log, MovieStream *st)
149 {
150     AVCodec *codec;
151     int ret;
152
153     codec = avcodec_find_decoder(st->st->codec->codec_id);
154     if (!codec) {
155         av_log(log, AV_LOG_ERROR, "Failed to find any codec\n");
156         return AVERROR(EINVAL);
157     }
158
159     st->st->codec->refcounted_frames = 1;
160
161     if ((ret = avcodec_open2(st->st->codec, codec, NULL)) < 0) {
162         av_log(log, AV_LOG_ERROR, "Failed to open codec\n");
163         return ret;
164     }
165
166     return 0;
167 }
168
169 static int guess_channel_layout(MovieStream *st, int st_index, void *log_ctx)
170 {
171     AVCodecContext *dec_ctx = st->st->codec;
172     char buf[256];
173     int64_t chl = av_get_default_channel_layout(dec_ctx->channels);
174
175     if (!chl) {
176         av_log(log_ctx, AV_LOG_ERROR,
177                "Channel layout is not set in stream %d, and could not "
178                "be guessed from the number of channels (%d)\n",
179                st_index, dec_ctx->channels);
180         return AVERROR(EINVAL);
181     }
182
183     av_get_channel_layout_string(buf, sizeof(buf), dec_ctx->channels, chl);
184     av_log(log_ctx, AV_LOG_WARNING,
185            "Channel layout is not set in output stream %d, "
186            "guessed channel layout is '%s'\n",
187            st_index, buf);
188     dec_ctx->channel_layout = chl;
189     return 0;
190 }
191
192 static av_cold int movie_common_init(AVFilterContext *ctx)
193 {
194     MovieContext *movie = ctx->priv;
195     AVInputFormat *iformat = NULL;
196     int64_t timestamp;
197     int nb_streams, ret, i;
198     char default_streams[16], *stream_specs, *spec, *cursor;
199     char name[16];
200     AVStream *st;
201
202     if (!*movie->file_name) {
203         av_log(ctx, AV_LOG_ERROR, "No filename provided!\n");
204         return AVERROR(EINVAL);
205     }
206
207     movie->seek_point = movie->seek_point_d * 1000000 + 0.5;
208
209     stream_specs = movie->stream_specs;
210     if (!stream_specs) {
211         snprintf(default_streams, sizeof(default_streams), "d%c%d",
212                  !strcmp(ctx->filter->name, "amovie") ? 'a' : 'v',
213                  movie->stream_index);
214         stream_specs = default_streams;
215     }
216     for (cursor = stream_specs, nb_streams = 1; *cursor; cursor++)
217         if (*cursor == '+')
218             nb_streams++;
219
220     if (movie->loop_count != 1 && nb_streams != 1) {
221         av_log(ctx, AV_LOG_ERROR,
222                "Loop with several streams is currently unsupported\n");
223         return AVERROR_PATCHWELCOME;
224     }
225
226     av_register_all();
227
228     // Try to find the movie format (container)
229     iformat = movie->format_name ? av_find_input_format(movie->format_name) : NULL;
230
231     movie->format_ctx = NULL;
232     if ((ret = avformat_open_input(&movie->format_ctx, movie->file_name, iformat, NULL)) < 0) {
233         av_log(ctx, AV_LOG_ERROR,
234                "Failed to avformat_open_input '%s'\n", movie->file_name);
235         return ret;
236     }
237     if ((ret = avformat_find_stream_info(movie->format_ctx, NULL)) < 0)
238         av_log(ctx, AV_LOG_WARNING, "Failed to find stream info\n");
239
240     // if seeking requested, we execute it
241     if (movie->seek_point > 0) {
242         timestamp = movie->seek_point;
243         // add the stream start time, should it exist
244         if (movie->format_ctx->start_time != AV_NOPTS_VALUE) {
245             if (timestamp > INT64_MAX - movie->format_ctx->start_time) {
246                 av_log(ctx, AV_LOG_ERROR,
247                        "%s: seek value overflow with start_time:%"PRId64" seek_point:%"PRId64"\n",
248                        movie->file_name, movie->format_ctx->start_time, movie->seek_point);
249                 return AVERROR(EINVAL);
250             }
251             timestamp += movie->format_ctx->start_time;
252         }
253         if ((ret = av_seek_frame(movie->format_ctx, -1, timestamp, AVSEEK_FLAG_BACKWARD)) < 0) {
254             av_log(ctx, AV_LOG_ERROR, "%s: could not seek to position %"PRId64"\n",
255                    movie->file_name, timestamp);
256             return ret;
257         }
258     }
259
260     for (i = 0; i < movie->format_ctx->nb_streams; i++)
261         movie->format_ctx->streams[i]->discard = AVDISCARD_ALL;
262
263     movie->st = av_calloc(nb_streams, sizeof(*movie->st));
264     if (!movie->st)
265         return AVERROR(ENOMEM);
266
267     for (i = 0; i < nb_streams; i++) {
268         spec = av_strtok(stream_specs, "+", &cursor);
269         if (!spec)
270             return AVERROR_BUG;
271         stream_specs = NULL; /* for next strtok */
272         st = find_stream(ctx, movie->format_ctx, spec);
273         if (!st)
274             return AVERROR(EINVAL);
275         st->discard = AVDISCARD_DEFAULT;
276         movie->st[i].st = st;
277         movie->max_stream_index = FFMAX(movie->max_stream_index, st->index);
278     }
279     if (av_strtok(NULL, "+", &cursor))
280         return AVERROR_BUG;
281
282     movie->out_index = av_calloc(movie->max_stream_index + 1,
283                                  sizeof(*movie->out_index));
284     if (!movie->out_index)
285         return AVERROR(ENOMEM);
286     for (i = 0; i <= movie->max_stream_index; i++)
287         movie->out_index[i] = -1;
288     for (i = 0; i < nb_streams; i++)
289         movie->out_index[movie->st[i].st->index] = i;
290
291     for (i = 0; i < nb_streams; i++) {
292         AVFilterPad pad = { 0 };
293         snprintf(name, sizeof(name), "out%d", i);
294         pad.type          = movie->st[i].st->codec->codec_type;
295         pad.name          = av_strdup(name);
296         pad.config_props  = movie_config_output_props;
297         pad.request_frame = movie_request_frame;
298         ff_insert_outpad(ctx, i, &pad);
299         ret = open_stream(ctx, &movie->st[i]);
300         if (ret < 0)
301             return ret;
302         if ( movie->st[i].st->codec->codec->type == AVMEDIA_TYPE_AUDIO &&
303             !movie->st[i].st->codec->channel_layout) {
304             ret = guess_channel_layout(&movie->st[i], i, ctx);
305             if (ret < 0)
306                 return ret;
307         }
308     }
309
310     av_log(ctx, AV_LOG_VERBOSE, "seek_point:%"PRIi64" format_name:%s file_name:%s stream_index:%d\n",
311            movie->seek_point, movie->format_name, movie->file_name,
312            movie->stream_index);
313
314     return 0;
315 }
316
317 static av_cold void movie_uninit(AVFilterContext *ctx)
318 {
319     MovieContext *movie = ctx->priv;
320     int i;
321
322     for (i = 0; i < ctx->nb_outputs; i++) {
323         av_freep(&ctx->output_pads[i].name);
324         if (movie->st[i].st)
325             avcodec_close(movie->st[i].st->codec);
326     }
327     av_freep(&movie->file_name);
328     av_freep(&movie->st);
329     av_freep(&movie->out_index);
330     av_frame_free(&movie->frame);
331     if (movie->format_ctx)
332         avformat_close_input(&movie->format_ctx);
333 }
334
335 static int movie_query_formats(AVFilterContext *ctx)
336 {
337     MovieContext *movie = ctx->priv;
338     int list[] = { 0, -1 };
339     int64_t list64[] = { 0, -1 };
340     int i;
341
342     for (i = 0; i < ctx->nb_outputs; i++) {
343         MovieStream *st = &movie->st[i];
344         AVCodecContext *c = st->st->codec;
345         AVFilterLink *outlink = ctx->outputs[i];
346
347         switch (c->codec_type) {
348         case AVMEDIA_TYPE_VIDEO:
349             list[0] = c->pix_fmt;
350             ff_formats_ref(ff_make_format_list(list), &outlink->in_formats);
351             break;
352         case AVMEDIA_TYPE_AUDIO:
353             list[0] = c->sample_fmt;
354             ff_formats_ref(ff_make_format_list(list), &outlink->in_formats);
355             list[0] = c->sample_rate;
356             ff_formats_ref(ff_make_format_list(list), &outlink->in_samplerates);
357             list64[0] = c->channel_layout;
358             ff_channel_layouts_ref(avfilter_make_format64_list(list64),
359                                    &outlink->in_channel_layouts);
360             break;
361         }
362     }
363
364     return 0;
365 }
366
367 static int movie_config_output_props(AVFilterLink *outlink)
368 {
369     AVFilterContext *ctx = outlink->src;
370     MovieContext *movie  = ctx->priv;
371     unsigned out_id = FF_OUTLINK_IDX(outlink);
372     MovieStream *st = &movie->st[out_id];
373     AVCodecContext *c = st->st->codec;
374
375     outlink->time_base = st->st->time_base;
376
377     switch (c->codec_type) {
378     case AVMEDIA_TYPE_VIDEO:
379         outlink->w          = c->width;
380         outlink->h          = c->height;
381         outlink->frame_rate = st->st->r_frame_rate;
382         break;
383     case AVMEDIA_TYPE_AUDIO:
384         break;
385     }
386
387     return 0;
388 }
389
390 static char *describe_frame_to_str(char *dst, size_t dst_size,
391                                     AVFrame *frame,
392                                     AVFilterLink *link)
393 {
394     switch (frame->type) {
395     case AVMEDIA_TYPE_VIDEO:
396         snprintf(dst, dst_size,
397                  "video pts:%s time:%s size:%dx%d aspect:%d/%d",
398                  av_ts2str(frame->pts), av_ts2timestr(frame->pts, &link->time_base),
399                  frame->width, frame->height,
400                  frame->sample_aspect_ratio.num,
401                  frame->sample_aspect_ratio.den);
402                  break;
403     case AVMEDIA_TYPE_AUDIO:
404         snprintf(dst, dst_size,
405                  "audio pts:%s time:%s samples:%d",
406                  av_ts2str(frame->pts), av_ts2timestr(frame->pts, &link->time_base),
407                  frame->nb_samples);
408                  break;
409     default:
410         snprintf(dst, dst_size, "%s BUG", av_get_media_type_string(frame->type));
411         break;
412     }
413     return dst;
414 }
415
416 #define describe_frameref(f, link) \
417     describe_frame_to_str((char[1024]){0}, 1024, f, link)
418
419 static int rewind_file(AVFilterContext *ctx)
420 {
421     MovieContext *movie = ctx->priv;
422     int64_t timestamp = movie->seek_point;
423     int ret, i;
424
425     if (movie->format_ctx->start_time != AV_NOPTS_VALUE)
426         timestamp += movie->format_ctx->start_time;
427     ret = av_seek_frame(movie->format_ctx, -1, timestamp, AVSEEK_FLAG_BACKWARD);
428     if (ret < 0) {
429         av_log(ctx, AV_LOG_ERROR, "Unable to loop: %s\n", av_err2str(ret));
430         movie->loop_count = 1; /* do not try again */
431         return ret;
432     }
433
434     for (i = 0; i < ctx->nb_outputs; i++) {
435         avcodec_flush_buffers(movie->st[i].st->codec);
436         movie->st[i].done = 0;
437     }
438     movie->eof = 0;
439     return 0;
440 }
441
442 /**
443  * Try to push a frame to the requested output.
444  *
445  * @param ctx     filter context
446  * @param out_id  number of output where a frame is wanted;
447  *                if the frame is read from file, used to set the return value;
448  *                if the codec is being flushed, flush the corresponding stream
449  * @return  1 if a frame was pushed on the requested output,
450  *          0 if another attempt is possible,
451  *          <0 AVERROR code
452  */
453 static int movie_push_frame(AVFilterContext *ctx, unsigned out_id)
454 {
455     MovieContext *movie = ctx->priv;
456     AVPacket *pkt = &movie->pkt;
457     MovieStream *st;
458     int ret, got_frame = 0, pkt_out_id;
459     AVFilterLink *outlink;
460
461     if (!pkt->size) {
462         if (movie->eof) {
463             if (movie->st[out_id].done) {
464                 if (movie->loop_count != 1) {
465                     ret = rewind_file(ctx);
466                     if (ret < 0)
467                         return ret;
468                     movie->loop_count -= movie->loop_count > 1;
469                     av_log(ctx, AV_LOG_VERBOSE, "Stream finished, looping.\n");
470                     return 0; /* retry */
471                 }
472                 return AVERROR_EOF;
473             }
474             pkt->stream_index = movie->st[out_id].st->index;
475             /* packet is already ready for flushing */
476         } else {
477             ret = av_read_frame(movie->format_ctx, &movie->pkt0);
478             if (ret < 0) {
479                 av_init_packet(&movie->pkt0); /* ready for flushing */
480                 *pkt = movie->pkt0;
481                 if (ret == AVERROR_EOF) {
482                     movie->eof = 1;
483                     return 0; /* start flushing */
484                 }
485                 return ret;
486             }
487             *pkt = movie->pkt0;
488         }
489     }
490
491     pkt_out_id = pkt->stream_index > movie->max_stream_index ? -1 :
492                  movie->out_index[pkt->stream_index];
493     if (pkt_out_id < 0) {
494         av_free_packet(&movie->pkt0);
495         pkt->size = 0; /* ready for next run */
496         pkt->data = NULL;
497         return 0;
498     }
499     st = &movie->st[pkt_out_id];
500     outlink = ctx->outputs[pkt_out_id];
501
502     movie->frame = av_frame_alloc();
503     if (!movie->frame)
504         return AVERROR(ENOMEM);
505
506     switch (st->st->codec->codec_type) {
507     case AVMEDIA_TYPE_VIDEO:
508         ret = avcodec_decode_video2(st->st->codec, movie->frame, &got_frame, pkt);
509         break;
510     case AVMEDIA_TYPE_AUDIO:
511         ret = avcodec_decode_audio4(st->st->codec, movie->frame, &got_frame, pkt);
512         break;
513     default:
514         ret = AVERROR(ENOSYS);
515         break;
516     }
517     if (ret < 0) {
518         av_log(ctx, AV_LOG_WARNING, "Decode error: %s\n", av_err2str(ret));
519         av_frame_free(&movie->frame);
520         return 0;
521     }
522     if (!ret)
523         ret = pkt->size;
524
525     pkt->data += ret;
526     pkt->size -= ret;
527     if (pkt->size <= 0) {
528         av_free_packet(&movie->pkt0);
529         pkt->size = 0; /* ready for next run */
530         pkt->data = NULL;
531     }
532     if (!got_frame) {
533         if (!ret)
534             st->done = 1;
535         av_frame_free(&movie->frame);
536         return 0;
537     }
538
539     av_dlog(ctx, "movie_push_frame(): file:'%s' %s\n", movie->file_name,
540             describe_frameref(movie->frame, outlink));
541
542     movie->frame->pts = av_frame_get_best_effort_timestamp(movie->frame);
543     ret = ff_filter_frame(outlink, movie->frame);
544     movie->frame = NULL;
545
546     if (ret < 0)
547         return ret;
548     return pkt_out_id == out_id;
549 }
550
551 static int movie_request_frame(AVFilterLink *outlink)
552 {
553     AVFilterContext *ctx = outlink->src;
554     unsigned out_id = FF_OUTLINK_IDX(outlink);
555     int ret;
556
557     while (1) {
558         ret = movie_push_frame(ctx, out_id);
559         if (ret)
560             return FFMIN(ret, 0);
561     }
562 }
563
564 #if CONFIG_MOVIE_FILTER
565
566 AVFILTER_DEFINE_CLASS(movie);
567
568 static av_cold int movie_init(AVFilterContext *ctx)
569 {
570     return movie_common_init(ctx);
571 }
572
573 AVFilter avfilter_avsrc_movie = {
574     .name          = "movie",
575     .description   = NULL_IF_CONFIG_SMALL("Read from a movie source."),
576     .priv_size     = sizeof(MovieContext),
577     .priv_class    = &movie_class,
578     .init          = movie_init,
579     .uninit        = movie_uninit,
580     .query_formats = movie_query_formats,
581
582     .inputs    = NULL,
583     .outputs   = NULL,
584     .flags     = AVFILTER_FLAG_DYNAMIC_OUTPUTS,
585 };
586
587 #endif  /* CONFIG_MOVIE_FILTER */
588
589 #if CONFIG_AMOVIE_FILTER
590
591 #define amovie_options movie_options
592 AVFILTER_DEFINE_CLASS(amovie);
593
594 static av_cold int amovie_init(AVFilterContext *ctx)
595 {
596     return movie_common_init(ctx);
597 }
598
599 AVFilter avfilter_avsrc_amovie = {
600     .name          = "amovie",
601     .description   = NULL_IF_CONFIG_SMALL("Read audio from a movie source."),
602     .priv_size     = sizeof(MovieContext),
603     .init          = amovie_init,
604     .uninit        = movie_uninit,
605     .query_formats = movie_query_formats,
606
607     .inputs     = NULL,
608     .outputs    = NULL,
609     .priv_class = &amovie_class,
610     .flags      = AVFILTER_FLAG_DYNAMIC_OUTPUTS,
611 };
612
613 #endif /* CONFIG_AMOVIE_FILTER */