Add description to the buffer source.
[libav.git] / libavfilter / vsrc_buffer.c
CommitLineData
cf13f204 1/*
cf13f204
MN
2 * Copyright (c) 2008 Vitor Sessak
3 *
4 * This file is part of FFmpeg.
5 *
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
b5634e45
SS
21/**
22 * @file
23 * memory buffer source filter
24 */
25
cf13f204
MN
26#include "avfilter.h"
27#include "vsrc_buffer.h"
28
29typedef struct {
30 int64_t pts;
31 AVFrame frame;
32 int has_frame;
9164afcb
CEH
33 int h, w;
34 enum PixelFormat pix_fmt;
cf13f204
MN
35 AVRational pixel_aspect;
36} BufferSourceContext;
37
cf13f204
MN
38int av_vsrc_buffer_add_frame(AVFilterContext *buffer_filter, AVFrame *frame,
39 int64_t pts, AVRational pixel_aspect)
40{
41 BufferSourceContext *c = buffer_filter->priv;
42
43 if (c->has_frame) {
44 av_log(buffer_filter, AV_LOG_ERROR,
45 "Buffering several frames is not supported. "
46 "Please consume all available frames before adding a new one.\n"
47 );
48 //return -1;
49 }
50
51 memcpy(c->frame.data , frame->data , sizeof(frame->data));
52 memcpy(c->frame.linesize, frame->linesize, sizeof(frame->linesize));
efdc74ef
MN
53 c->frame.interlaced_frame= frame->interlaced_frame;
54 c->frame.top_field_first = frame->top_field_first;
cf13f204
MN
55 c->pts = pts;
56 c->pixel_aspect = pixel_aspect;
57 c->has_frame = 1;
58
59 return 0;
60}
61
62static av_cold int init(AVFilterContext *ctx, const char *args, void *opaque)
63{
64 BufferSourceContext *c = ctx->priv;
65
4055438b 66 if (args && sscanf(args, "%d:%d:%d", &c->w, &c->h, &c->pix_fmt) == 3)
cf13f204
MN
67 return 0;
68
69 av_log(ctx, AV_LOG_ERROR, "init() expected 3 arguments:'%s'\n", args);
70 return -1;
71}
72
73static int query_formats(AVFilterContext *ctx)
74{
75 BufferSourceContext *c = ctx->priv;
76 enum PixelFormat pix_fmts[] = { c->pix_fmt, PIX_FMT_NONE };
77
78 avfilter_set_common_formats(ctx, avfilter_make_format_list(pix_fmts));
79 return 0;
80}
81
82static int config_props(AVFilterLink *link)
83{
84 BufferSourceContext *c = link->src->priv;
85
86 link->w = c->w;
87 link->h = c->h;
88
89 return 0;
90}
91
cf13f204
MN
92static int request_frame(AVFilterLink *link)
93{
94 BufferSourceContext *c = link->src->priv;
95 AVFilterPicRef *picref;
96
97 if (!c->has_frame) {
98 av_log(link->src, AV_LOG_ERROR,
99 "request_frame() called with no available frame!\n");
100 //return -1;
101 }
102
103 /* This picture will be needed unmodified later for decoding the next
104 * frame */
105 picref = avfilter_get_video_buffer(link, AV_PERM_WRITE | AV_PERM_PRESERVE |
106 AV_PERM_REUSE2,
107 link->w, link->h);
108
109 av_picture_copy((AVPicture *)&picref->data, (AVPicture *)&c->frame,
110 picref->pic->format, link->w, link->h);
111
4055438b
SS
112 picref->pts = c->pts;
113 picref->pixel_aspect = c->pixel_aspect;
efdc74ef
MN
114 picref->interlaced = c->frame.interlaced_frame;
115 picref->top_field_first = c->frame.top_field_first;
cf13f204
MN
116 avfilter_start_frame(link, avfilter_ref_pic(picref, ~0));
117 avfilter_draw_slice(link, 0, link->h, 1);
118 avfilter_end_frame(link);
119 avfilter_unref_pic(picref);
120
121 c->has_frame = 0;
122
123 return 0;
124}
125
126static int poll_frame(AVFilterLink *link)
127{
128 BufferSourceContext *c = link->src->priv;
129 return !!(c->has_frame);
130}
131
4055438b 132AVFilter avfilter_vsrc_buffer = {
cf13f204 133 .name = "buffer",
ce1f8536 134 .description = NULL_IF_CONFIG_SMALL("Buffer video frames, and make them accessible to the filterchain."),
cf13f204
MN
135 .priv_size = sizeof(BufferSourceContext),
136 .query_formats = query_formats,
137
138 .init = init,
139
140 .inputs = (AVFilterPad[]) {{ .name = NULL }},
141 .outputs = (AVFilterPad[]) {{ .name = "default",
142 .type = AVMEDIA_TYPE_VIDEO,
143 .request_frame = request_frame,
144 .poll_frame = poll_frame,
145 .config_props = config_props, },
146 { .name = NULL}},
147};