vsrc_movie: rename video movie specific callbacks, prefix them with "movie"
[ffmpeg.git] / libavfilter / vsrc_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 "avcodec.h"
39 #include "avfilter.h"
40
41 typedef struct {
42     /* common A/V fields */
43     const AVClass *class;
44     int64_t seek_point;   ///< seekpoint in microseconds
45     double seek_point_d;
46     char *format_name;
47     char *file_name;
48     int stream_index;
49
50     AVFormatContext *format_ctx;
51     AVCodecContext *codec_ctx;
52     int is_done;
53     AVFrame *frame;   ///< video frame to store the decoded images in
54
55     /* video-only fields */
56     int w, h;
57     AVFilterBufferRef *picref;
58 } MovieContext;
59
60 #define OFFSET(x) offsetof(MovieContext, x)
61
62 static const AVOption movie_options[]= {
63 {"format_name",  "set format name",         OFFSET(format_name),  FF_OPT_TYPE_STRING, {.str =  0},  CHAR_MIN, CHAR_MAX },
64 {"f",            "set format name",         OFFSET(format_name),  FF_OPT_TYPE_STRING, {.str =  0},  CHAR_MIN, CHAR_MAX },
65 {"stream_index", "set stream index",        OFFSET(stream_index), FF_OPT_TYPE_INT,    {.dbl = -1},  -1,       INT_MAX  },
66 {"si",           "set stream index",        OFFSET(stream_index), FF_OPT_TYPE_INT,    {.dbl = -1},  -1,       INT_MAX  },
67 {"seek_point",   "set seekpoint (seconds)", OFFSET(seek_point_d), FF_OPT_TYPE_DOUBLE, {.dbl =  0},  0,        (INT64_MAX-1) / 1000000 },
68 {"sp",           "set seekpoint (seconds)", OFFSET(seek_point_d), FF_OPT_TYPE_DOUBLE, {.dbl =  0},  0,        (INT64_MAX-1) / 1000000 },
69 {NULL},
70 };
71
72 static const char *movie_get_name(void *ctx)
73 {
74     return "movie";
75 }
76
77 static const AVClass movie_class = {
78     "MovieContext",
79     movie_get_name,
80     movie_options
81 };
82
83 static av_cold int movie_common_init(AVFilterContext *ctx, const char *args, void *opaque,
84                                      enum AVMediaType type)
85 {
86     MovieContext *movie = ctx->priv;
87     AVInputFormat *iformat = NULL;
88     AVCodec *codec;
89     int64_t timestamp;
90     int ret;
91
92     movie->class = &movie_class;
93     av_opt_set_defaults2(movie, 0, 0);
94
95     if (args)
96         movie->file_name = av_get_token(&args, ":");
97     if (!movie->file_name || !*movie->file_name) {
98         av_log(ctx, AV_LOG_ERROR, "No filename provided!\n");
99         return AVERROR(EINVAL);
100     }
101
102     if (*args++ == ':' && (ret = av_set_options_string(movie, args, "=", ":")) < 0) {
103         av_log(ctx, AV_LOG_ERROR, "Error parsing options string: '%s'\n", args);
104         return ret;
105     }
106
107     movie->seek_point = movie->seek_point_d * 1000000 + 0.5;
108
109     av_register_all();
110
111     // Try to find the movie format (container)
112     iformat = movie->format_name ? av_find_input_format(movie->format_name) : NULL;
113
114     movie->format_ctx = NULL;
115     if ((ret = avformat_open_input(&movie->format_ctx, movie->file_name, iformat, NULL)) < 0) {
116         av_log(ctx, AV_LOG_ERROR,
117                "Failed to avformat_open_input '%s'\n", movie->file_name);
118         return ret;
119     }
120     if ((ret = avformat_find_stream_info(movie->format_ctx, NULL)) < 0)
121         av_log(ctx, AV_LOG_WARNING, "Failed to find stream info\n");
122
123     // if seeking requested, we execute it
124     if (movie->seek_point > 0) {
125         timestamp = movie->seek_point;
126         // add the stream start time, should it exist
127         if (movie->format_ctx->start_time != AV_NOPTS_VALUE) {
128             if (timestamp > INT64_MAX - movie->format_ctx->start_time) {
129                 av_log(ctx, AV_LOG_ERROR,
130                        "%s: seek value overflow with start_time:%"PRId64" seek_point:%"PRId64"\n",
131                        movie->file_name, movie->format_ctx->start_time, movie->seek_point);
132                 return AVERROR(EINVAL);
133             }
134             timestamp += movie->format_ctx->start_time;
135         }
136         if ((ret = av_seek_frame(movie->format_ctx, -1, timestamp, AVSEEK_FLAG_BACKWARD)) < 0) {
137             av_log(ctx, AV_LOG_ERROR, "%s: could not seek to position %"PRId64"\n",
138                    movie->file_name, timestamp);
139             return ret;
140         }
141     }
142
143     /* select the media stream */
144     if ((ret = av_find_best_stream(movie->format_ctx, type,
145                                    movie->stream_index, -1, NULL, 0)) < 0) {
146         av_log(ctx, AV_LOG_ERROR, "No %s stream with index '%d' found\n",
147                av_get_media_type_string(type), movie->stream_index);
148         return ret;
149     }
150     movie->stream_index = ret;
151     movie->codec_ctx = movie->format_ctx->streams[movie->stream_index]->codec;
152
153     /*
154      * So now we've got a pointer to the so-called codec context for our video
155      * stream, but we still have to find the actual codec and open it.
156      */
157     codec = avcodec_find_decoder(movie->codec_ctx->codec_id);
158     if (!codec) {
159         av_log(ctx, AV_LOG_ERROR, "Failed to find any codec\n");
160         return AVERROR(EINVAL);
161     }
162
163     if ((ret = avcodec_open2(movie->codec_ctx, codec, NULL)) < 0) {
164         av_log(ctx, AV_LOG_ERROR, "Failed to open codec\n");
165         return ret;
166     }
167
168     av_log(ctx, AV_LOG_INFO, "seek_point:%"PRIi64" format_name:%s file_name:%s stream_index:%d\n",
169            movie->seek_point, movie->format_name, movie->file_name,
170            movie->stream_index);
171
172     return 0;
173 }
174
175 static av_cold void movie_common_uninit(AVFilterContext *ctx)
176 {
177     MovieContext *movie = ctx->priv;
178
179     av_free(movie->file_name);
180     av_free(movie->format_name);
181     if (movie->codec_ctx)
182         avcodec_close(movie->codec_ctx);
183     if (movie->format_ctx)
184         av_close_input_file(movie->format_ctx);
185
186     avfilter_unref_buffer(movie->picref);
187     av_freep(&movie->frame);
188 }
189
190 static av_cold int movie_init(AVFilterContext *ctx, const char *args, void *opaque)
191 {
192     MovieContext *movie = ctx->priv;
193     int ret;
194
195     if ((ret = movie_common_init(ctx, args, opaque, AVMEDIA_TYPE_VIDEO)) < 0)
196         return ret;
197
198     if (!(movie->frame = avcodec_alloc_frame()) ) {
199         av_log(ctx, AV_LOG_ERROR, "Failed to alloc frame\n");
200         return AVERROR(ENOMEM);
201     }
202
203     movie->w = movie->codec_ctx->width;
204     movie->h = movie->codec_ctx->height;
205
206     return 0;
207 }
208
209 static int movie_query_formats(AVFilterContext *ctx)
210 {
211     MovieContext *movie = ctx->priv;
212     enum PixelFormat pix_fmts[] = { movie->codec_ctx->pix_fmt, PIX_FMT_NONE };
213
214     avfilter_set_common_pixel_formats(ctx, avfilter_make_format_list(pix_fmts));
215     return 0;
216 }
217
218 static int movie_config_output_props(AVFilterLink *outlink)
219 {
220     MovieContext *movie = outlink->src->priv;
221
222     outlink->w = movie->w;
223     outlink->h = movie->h;
224     outlink->time_base = movie->format_ctx->streams[movie->stream_index]->time_base;
225
226     return 0;
227 }
228
229 static int movie_get_frame(AVFilterLink *outlink)
230 {
231     MovieContext *movie = outlink->src->priv;
232     AVPacket pkt;
233     int ret, frame_decoded;
234     AVStream *st = movie->format_ctx->streams[movie->stream_index];
235
236     if (movie->is_done == 1)
237         return 0;
238
239     while ((ret = av_read_frame(movie->format_ctx, &pkt)) >= 0) {
240         // Is this a packet from the video stream?
241         if (pkt.stream_index == movie->stream_index) {
242             avcodec_decode_video2(movie->codec_ctx, movie->frame, &frame_decoded, &pkt);
243
244             if (frame_decoded) {
245                 /* FIXME: avoid the memcpy */
246                 movie->picref = avfilter_get_video_buffer(outlink, AV_PERM_WRITE | AV_PERM_PRESERVE |
247                                                           AV_PERM_REUSE2, outlink->w, outlink->h);
248                 av_image_copy(movie->picref->data, movie->picref->linesize,
249                               movie->frame->data,  movie->frame->linesize,
250                               movie->picref->format, outlink->w, outlink->h);
251                 avfilter_copy_frame_props(movie->picref, movie->frame);
252
253                 /* FIXME: use a PTS correction mechanism as that in
254                  * ffplay.c when some API will be available for that */
255                 /* use pkt_dts if pkt_pts is not available */
256                 movie->picref->pts = movie->frame->pkt_pts == AV_NOPTS_VALUE ?
257                     movie->frame->pkt_dts : movie->frame->pkt_pts;
258                 if (!movie->frame->sample_aspect_ratio.num)
259                     movie->picref->video->sample_aspect_ratio = st->sample_aspect_ratio;
260                 av_dlog(outlink->src,
261                         "movie_get_frame(): file:'%s' pts:%"PRId64" time:%lf pos:%"PRId64" aspect:%d/%d\n",
262                         movie->file_name, movie->picref->pts,
263                         (double)movie->picref->pts * av_q2d(st->time_base),
264                         movie->picref->pos,
265                         movie->picref->video->sample_aspect_ratio.num,
266                         movie->picref->video->sample_aspect_ratio.den);
267                 // We got it. Free the packet since we are returning
268                 av_free_packet(&pkt);
269
270                 return 0;
271             }
272         }
273         // Free the packet that was allocated by av_read_frame
274         av_free_packet(&pkt);
275     }
276
277     // On multi-frame source we should stop the mixing process when
278     // the movie source does not have more frames
279     if (ret == AVERROR_EOF)
280         movie->is_done = 1;
281     return ret;
282 }
283
284 static int movie_request_frame(AVFilterLink *outlink)
285 {
286     AVFilterBufferRef *outpicref;
287     MovieContext *movie = outlink->src->priv;
288     int ret;
289
290     if (movie->is_done)
291         return AVERROR_EOF;
292     if ((ret = movie_get_frame(outlink)) < 0)
293         return ret;
294
295     outpicref = avfilter_ref_buffer(movie->picref, ~0);
296     avfilter_start_frame(outlink, outpicref);
297     avfilter_draw_slice(outlink, 0, outlink->h, 1);
298     avfilter_end_frame(outlink);
299     avfilter_unref_buffer(movie->picref);
300     movie->picref = NULL;
301
302     return 0;
303 }
304
305 AVFilter avfilter_vsrc_movie = {
306     .name          = "movie",
307     .description   = NULL_IF_CONFIG_SMALL("Read from a movie source."),
308     .priv_size     = sizeof(MovieContext),
309     .init          = movie_init,
310     .uninit        = movie_common_uninit,
311     .query_formats = movie_query_formats,
312
313     .inputs    = (AVFilterPad[]) {{ .name = NULL }},
314     .outputs   = (AVFilterPad[]) {{ .name            = "default",
315                                     .type            = AVMEDIA_TYPE_VIDEO,
316                                     .request_frame   = movie_request_frame,
317                                     .config_props    = movie_config_output_props, },
318                                   { .name = NULL}},
319 };