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