lavfi: move tracing utilities definition from video.c to avfilter.c
[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  * @todo support more than one output stream
29  */
30
31 /* #define DEBUG */
32
33 #include <float.h>
34 #include "libavutil/avstring.h"
35 #include "libavutil/opt.h"
36 #include "libavutil/imgutils.h"
37 #include "libavformat/avformat.h"
38 #include "audio.h"
39 #include "avcodec.h"
40 #include "avfilter.h"
41 #include "formats.h"
42
43 typedef struct {
44     /* common A/V fields */
45     const AVClass *class;
46     int64_t seek_point;   ///< seekpoint in microseconds
47     double seek_point_d;
48     char *format_name;
49     char *file_name;
50     int stream_index;
51     int loop_count;
52
53     AVFormatContext *format_ctx;
54     AVCodecContext *codec_ctx;
55     int is_done;
56     AVFrame *frame;   ///< video frame to store the decoded images in
57
58     /* video-only fields */
59     int w, h;
60     AVFilterBufferRef *picref;
61
62     /* audio-only fields */
63     int bps;            ///< bytes per sample
64     AVPacket pkt, pkt0;
65     AVFilterBufferRef *samplesref;
66 } MovieContext;
67
68 #define OFFSET(x) offsetof(MovieContext, x)
69
70 static const AVOption movie_options[]= {
71 {"format_name",  "set format name",         OFFSET(format_name),  AV_OPT_TYPE_STRING, {.str =  0},  CHAR_MIN, CHAR_MAX },
72 {"f",            "set format name",         OFFSET(format_name),  AV_OPT_TYPE_STRING, {.str =  0},  CHAR_MIN, CHAR_MAX },
73 {"stream_index", "set stream index",        OFFSET(stream_index), AV_OPT_TYPE_INT,    {.dbl = -1},  -1,       INT_MAX  },
74 {"si",           "set stream index",        OFFSET(stream_index), AV_OPT_TYPE_INT,    {.dbl = -1},  -1,       INT_MAX  },
75 {"seek_point",   "set seekpoint (seconds)", OFFSET(seek_point_d), AV_OPT_TYPE_DOUBLE, {.dbl =  0},  0,        (INT64_MAX-1) / 1000000 },
76 {"sp",           "set seekpoint (seconds)", OFFSET(seek_point_d), AV_OPT_TYPE_DOUBLE, {.dbl =  0},  0,        (INT64_MAX-1) / 1000000 },
77 {"loop",         "set loop count",          OFFSET(loop_count),   AV_OPT_TYPE_INT,    {.dbl =  1},  0,        INT_MAX  },
78 {NULL},
79 };
80
81 static const AVClass movie_class = {
82     "MovieContext",
83     avfilter_default_filter_name,
84     movie_options
85 };
86
87 static av_cold int movie_common_init(AVFilterContext *ctx, const char *args, void *opaque,
88                                      enum AVMediaType type)
89 {
90     MovieContext *movie = ctx->priv;
91     AVInputFormat *iformat = NULL;
92     AVCodec *codec;
93     int64_t timestamp;
94     int ret;
95
96     movie->class = &movie_class;
97     av_opt_set_defaults(movie);
98
99     if (args)
100         movie->file_name = av_get_token(&args, ":");
101     if (!movie->file_name || !*movie->file_name) {
102         av_log(ctx, AV_LOG_ERROR, "No filename provided!\n");
103         return AVERROR(EINVAL);
104     }
105
106     if (*args++ == ':' && (ret = av_set_options_string(movie, args, "=", ":")) < 0) {
107         av_log(ctx, AV_LOG_ERROR, "Error parsing options string: '%s'\n", args);
108         return ret;
109     }
110
111     movie->seek_point = movie->seek_point_d * 1000000 + 0.5;
112
113     av_register_all();
114
115     // Try to find the movie format (container)
116     iformat = movie->format_name ? av_find_input_format(movie->format_name) : NULL;
117
118     movie->format_ctx = NULL;
119     if ((ret = avformat_open_input(&movie->format_ctx, movie->file_name, iformat, NULL)) < 0) {
120         av_log(ctx, AV_LOG_ERROR,
121                "Failed to avformat_open_input '%s'\n", movie->file_name);
122         return ret;
123     }
124     if ((ret = avformat_find_stream_info(movie->format_ctx, NULL)) < 0)
125         av_log(ctx, AV_LOG_WARNING, "Failed to find stream info\n");
126
127     // if seeking requested, we execute it
128     if (movie->seek_point > 0) {
129         timestamp = movie->seek_point;
130         // add the stream start time, should it exist
131         if (movie->format_ctx->start_time != AV_NOPTS_VALUE) {
132             if (timestamp > INT64_MAX - movie->format_ctx->start_time) {
133                 av_log(ctx, AV_LOG_ERROR,
134                        "%s: seek value overflow with start_time:%"PRId64" seek_point:%"PRId64"\n",
135                        movie->file_name, movie->format_ctx->start_time, movie->seek_point);
136                 return AVERROR(EINVAL);
137             }
138             timestamp += movie->format_ctx->start_time;
139         }
140         if ((ret = av_seek_frame(movie->format_ctx, -1, timestamp, AVSEEK_FLAG_BACKWARD)) < 0) {
141             av_log(ctx, AV_LOG_ERROR, "%s: could not seek to position %"PRId64"\n",
142                    movie->file_name, timestamp);
143             return ret;
144         }
145     }
146
147     /* select the media stream */
148     if ((ret = av_find_best_stream(movie->format_ctx, type,
149                                    movie->stream_index, -1, NULL, 0)) < 0) {
150         av_log(ctx, AV_LOG_ERROR, "No %s stream with index '%d' found\n",
151                av_get_media_type_string(type), movie->stream_index);
152         return ret;
153     }
154     movie->stream_index = ret;
155     movie->codec_ctx = movie->format_ctx->streams[movie->stream_index]->codec;
156
157     /*
158      * So now we've got a pointer to the so-called codec context for our video
159      * stream, but we still have to find the actual codec and open it.
160      */
161     codec = avcodec_find_decoder(movie->codec_ctx->codec_id);
162     if (!codec) {
163         av_log(ctx, AV_LOG_ERROR, "Failed to find any codec\n");
164         return AVERROR(EINVAL);
165     }
166
167     if ((ret = avcodec_open2(movie->codec_ctx, codec, NULL)) < 0) {
168         av_log(ctx, AV_LOG_ERROR, "Failed to open codec\n");
169         return ret;
170     }
171
172     av_log(ctx, AV_LOG_INFO, "seek_point:%"PRIi64" format_name:%s file_name:%s stream_index:%d\n",
173            movie->seek_point, movie->format_name, movie->file_name,
174            movie->stream_index);
175
176     if (!(movie->frame = avcodec_alloc_frame()) ) {
177         av_log(ctx, AV_LOG_ERROR, "Failed to alloc frame\n");
178         return AVERROR(ENOMEM);
179     }
180
181     return 0;
182 }
183
184 static av_cold void movie_common_uninit(AVFilterContext *ctx)
185 {
186     MovieContext *movie = ctx->priv;
187
188     av_free(movie->file_name);
189     av_free(movie->format_name);
190     if (movie->codec_ctx)
191         avcodec_close(movie->codec_ctx);
192     if (movie->format_ctx)
193         avformat_close_input(&movie->format_ctx);
194
195     avfilter_unref_buffer(movie->picref);
196     av_freep(&movie->frame);
197
198     avfilter_unref_buffer(movie->samplesref);
199 }
200
201 #if CONFIG_MOVIE_FILTER
202
203 static av_cold int movie_init(AVFilterContext *ctx, const char *args, void *opaque)
204 {
205     MovieContext *movie = ctx->priv;
206     int ret;
207
208     if ((ret = movie_common_init(ctx, args, opaque, AVMEDIA_TYPE_VIDEO)) < 0)
209         return ret;
210
211     movie->w = movie->codec_ctx->width;
212     movie->h = movie->codec_ctx->height;
213
214     return 0;
215 }
216
217 static int movie_query_formats(AVFilterContext *ctx)
218 {
219     MovieContext *movie = ctx->priv;
220     enum PixelFormat pix_fmts[] = { movie->codec_ctx->pix_fmt, PIX_FMT_NONE };
221
222     avfilter_set_common_pixel_formats(ctx, avfilter_make_format_list(pix_fmts));
223     return 0;
224 }
225
226 static int movie_config_output_props(AVFilterLink *outlink)
227 {
228     MovieContext *movie = outlink->src->priv;
229
230     outlink->w = movie->w;
231     outlink->h = movie->h;
232     outlink->time_base = movie->format_ctx->streams[movie->stream_index]->time_base;
233
234     return 0;
235 }
236
237 static int movie_get_frame(AVFilterLink *outlink)
238 {
239     MovieContext *movie = outlink->src->priv;
240     AVPacket pkt;
241     int ret, frame_decoded;
242     AVStream *st = movie->format_ctx->streams[movie->stream_index];
243
244     if (movie->is_done == 1)
245         return 0;
246
247     while (1) {
248         ret = av_read_frame(movie->format_ctx, &pkt);
249         if (ret == AVERROR_EOF) {
250             int64_t timestamp;
251             if (movie->loop_count != 1) {
252                 timestamp = movie->seek_point;
253                 if (movie->format_ctx->start_time != AV_NOPTS_VALUE)
254                     timestamp += movie->format_ctx->start_time;
255                 if (av_seek_frame(movie->format_ctx, -1, timestamp, AVSEEK_FLAG_BACKWARD) < 0) {
256                     movie->is_done = 1;
257                     break;
258                 } else if (movie->loop_count>1)
259                     movie->loop_count--;
260                 continue;
261             } else {
262                 movie->is_done = 1;
263                 break;
264             }
265         } else if (ret < 0)
266             break;
267
268         // Is this a packet from the video stream?
269         if (pkt.stream_index == movie->stream_index) {
270             avcodec_decode_video2(movie->codec_ctx, movie->frame, &frame_decoded, &pkt);
271
272             if (frame_decoded) {
273                 /* FIXME: avoid the memcpy */
274                 movie->picref = avfilter_get_video_buffer(outlink, AV_PERM_WRITE | AV_PERM_PRESERVE |
275                                                           AV_PERM_REUSE2, outlink->w, outlink->h);
276                 av_image_copy(movie->picref->data, movie->picref->linesize,
277                               (void*)movie->frame->data,  movie->frame->linesize,
278                               movie->picref->format, outlink->w, outlink->h);
279                 avfilter_copy_frame_props(movie->picref, movie->frame);
280
281                 /* FIXME: use a PTS correction mechanism as that in
282                  * ffplay.c when some API will be available for that */
283                 /* use pkt_dts if pkt_pts is not available */
284                 movie->picref->pts = movie->frame->pkt_pts == AV_NOPTS_VALUE ?
285                     movie->frame->pkt_dts : movie->frame->pkt_pts;
286
287                 if (!movie->frame->sample_aspect_ratio.num)
288                     movie->picref->video->sample_aspect_ratio = st->sample_aspect_ratio;
289                 av_dlog(outlink->src,
290                         "movie_get_frame(): file:'%s' pts:%"PRId64" time:%lf pos:%"PRId64" aspect:%d/%d\n",
291                         movie->file_name, movie->picref->pts,
292                         (double)movie->picref->pts * av_q2d(st->time_base),
293                         movie->picref->pos,
294                         movie->picref->video->sample_aspect_ratio.num,
295                         movie->picref->video->sample_aspect_ratio.den);
296                 // We got it. Free the packet since we are returning
297                 av_free_packet(&pkt);
298
299                 return 0;
300             }
301         }
302         // Free the packet that was allocated by av_read_frame
303         av_free_packet(&pkt);
304     }
305
306     return ret;
307 }
308
309 static int movie_request_frame(AVFilterLink *outlink)
310 {
311     AVFilterBufferRef *outpicref;
312     MovieContext *movie = outlink->src->priv;
313     int ret;
314
315     if (movie->is_done)
316         return AVERROR_EOF;
317     if ((ret = movie_get_frame(outlink)) < 0)
318         return ret;
319
320     outpicref = avfilter_ref_buffer(movie->picref, ~0);
321     avfilter_start_frame(outlink, outpicref);
322     avfilter_draw_slice(outlink, 0, outlink->h, 1);
323     avfilter_end_frame(outlink);
324     avfilter_unref_buffer(movie->picref);
325     movie->picref = NULL;
326
327     return 0;
328 }
329
330 AVFilter avfilter_vsrc_movie = {
331     .name          = "movie",
332     .description   = NULL_IF_CONFIG_SMALL("Read from a movie source."),
333     .priv_size     = sizeof(MovieContext),
334     .init          = movie_init,
335     .uninit        = movie_common_uninit,
336     .query_formats = movie_query_formats,
337
338     .inputs    = (const AVFilterPad[]) {{ .name = NULL }},
339     .outputs   = (const AVFilterPad[]) {{ .name      = "default",
340                                     .type            = AVMEDIA_TYPE_VIDEO,
341                                     .request_frame   = movie_request_frame,
342                                     .config_props    = movie_config_output_props, },
343                                   { .name = NULL}},
344 };
345
346 #endif  /* CONFIG_MOVIE_FILTER */
347
348 #if CONFIG_AMOVIE_FILTER
349
350 static av_cold int amovie_init(AVFilterContext *ctx, const char *args, void *opaque)
351 {
352     MovieContext *movie = ctx->priv;
353     int ret;
354
355     if ((ret = movie_common_init(ctx, args, opaque, AVMEDIA_TYPE_AUDIO)) < 0)
356         return ret;
357
358     movie->bps = av_get_bytes_per_sample(movie->codec_ctx->sample_fmt);
359     return 0;
360 }
361
362 static int amovie_query_formats(AVFilterContext *ctx)
363 {
364     MovieContext *movie = ctx->priv;
365     AVCodecContext *c = movie->codec_ctx;
366
367     enum AVSampleFormat sample_fmts[] = { c->sample_fmt, -1 };
368     int sample_rates[] = { c->sample_rate, -1 };
369     int64_t chlayouts[] = { c->channel_layout ? c->channel_layout :
370                             av_get_default_channel_layout(c->channels), -1 };
371
372     avfilter_set_common_sample_formats (ctx, avfilter_make_format_list(sample_fmts));
373     ff_set_common_samplerates          (ctx, avfilter_make_format_list(sample_rates));
374     ff_set_common_channel_layouts(ctx, avfilter_make_format64_list(chlayouts));
375
376     return 0;
377 }
378
379 static int amovie_config_output_props(AVFilterLink *outlink)
380 {
381     MovieContext *movie = outlink->src->priv;
382     AVCodecContext *c = movie->codec_ctx;
383
384     outlink->sample_rate = c->sample_rate;
385     outlink->time_base = movie->format_ctx->streams[movie->stream_index]->time_base;
386
387     return 0;
388 }
389
390 static int amovie_get_samples(AVFilterLink *outlink)
391 {
392     MovieContext *movie = outlink->src->priv;
393     AVPacket pkt;
394     int ret, got_frame = 0;
395
396     if (!movie->pkt.size && movie->is_done == 1)
397         return AVERROR_EOF;
398
399     /* check for another frame, in case the previous one was completely consumed */
400     if (!movie->pkt.size) {
401         while ((ret = av_read_frame(movie->format_ctx, &pkt)) >= 0) {
402             // Is this a packet from the selected stream?
403             if (pkt.stream_index != movie->stream_index) {
404                 av_free_packet(&pkt);
405                 continue;
406             } else {
407                 movie->pkt0 = movie->pkt = pkt;
408                 break;
409             }
410         }
411
412         if (ret == AVERROR_EOF) {
413             movie->is_done = 1;
414             return ret;
415         }
416     }
417
418     /* decode and update the movie pkt */
419     avcodec_get_frame_defaults(movie->frame);
420     ret = avcodec_decode_audio4(movie->codec_ctx, movie->frame, &got_frame, &movie->pkt);
421     if (ret < 0) {
422         movie->pkt.size = 0;
423         return ret;
424     }
425     movie->pkt.data += ret;
426     movie->pkt.size -= ret;
427
428     /* wrap the decoded data in a samplesref */
429     if (got_frame) {
430         int nb_samples = movie->frame->nb_samples;
431         int data_size =
432             av_samples_get_buffer_size(NULL, movie->codec_ctx->channels,
433                                        nb_samples, movie->codec_ctx->sample_fmt, 1);
434         if (data_size < 0)
435             return data_size;
436         movie->samplesref =
437             ff_get_audio_buffer(outlink, AV_PERM_WRITE, nb_samples);
438         memcpy(movie->samplesref->data[0], movie->frame->data[0], data_size);
439         movie->samplesref->pts = movie->pkt.pts;
440         movie->samplesref->pos = movie->pkt.pos;
441         movie->samplesref->audio->sample_rate = movie->codec_ctx->sample_rate;
442     }
443
444     // We got it. Free the packet since we are returning
445     if (movie->pkt.size <= 0)
446         av_free_packet(&movie->pkt0);
447
448     return 0;
449 }
450
451 static int amovie_request_frame(AVFilterLink *outlink)
452 {
453     MovieContext *movie = outlink->src->priv;
454     int ret;
455
456     if (movie->is_done)
457         return AVERROR_EOF;
458     do {
459         if ((ret = amovie_get_samples(outlink)) < 0)
460             return ret;
461     } while (!movie->samplesref);
462
463     ff_filter_samples(outlink, avfilter_ref_buffer(movie->samplesref, ~0));
464     avfilter_unref_buffer(movie->samplesref);
465     movie->samplesref = NULL;
466
467     return 0;
468 }
469
470 AVFilter avfilter_asrc_amovie = {
471     .name          = "amovie",
472     .description   = NULL_IF_CONFIG_SMALL("Read audio from a movie source."),
473     .priv_size     = sizeof(MovieContext),
474     .init          = amovie_init,
475     .uninit        = movie_common_uninit,
476     .query_formats = amovie_query_formats,
477
478     .inputs    = (const AVFilterPad[]) {{ .name = NULL }},
479     .outputs   = (const AVFilterPad[]) {{ .name      = "default",
480                                     .type            = AVMEDIA_TYPE_AUDIO,
481                                     .request_frame   = amovie_request_frame,
482                                     .config_props    = amovie_config_output_props, },
483                                   { .name = NULL}},
484 };
485
486 #endif /* CONFIG_AMOVIE_FILTER */