lavfi/vf_tile: simplify request_frame loop.
[ffmpeg.git] / libavfilter / vf_tile.c
1 /*
2  * Copyright (c) 2012 Nicolas George
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
21 /**
22  * @file
23  * tile video filter
24  */
25
26 #include "libavutil/opt.h"
27 #include "libavutil/pixdesc.h"
28 #include "avfilter.h"
29 #include "drawutils.h"
30 #include "formats.h"
31 #include "video.h"
32 #include "internal.h"
33
34 typedef struct {
35     const AVClass *class;
36     unsigned w, h;
37     unsigned margin;
38     unsigned padding;
39     unsigned current;
40     unsigned nb_frames;
41     FFDrawContext draw;
42     FFDrawColor blank;
43     AVFrame *out_ref;
44 } TileContext;
45
46 #define REASONABLE_SIZE 1024
47
48 #define OFFSET(x) offsetof(TileContext, x)
49 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
50
51 static const AVOption tile_options[] = {
52     { "layout", "set grid size", OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE,
53         {.str = "6x5"}, 0, 0, FLAGS },
54     { "margin",  "set outer border margin in pixels",    OFFSET(margin),
55         AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1024, FLAGS },
56     { "padding", "set inner border thickness in pixels", OFFSET(padding),
57         AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1024, FLAGS },
58     { "nb_frames", "set maximum number of frame to render", OFFSET(nb_frames),
59         AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, FLAGS },
60     {NULL},
61 };
62
63 AVFILTER_DEFINE_CLASS(tile);
64
65 static av_cold int init(AVFilterContext *ctx, const char *args)
66 {
67     TileContext *tile = ctx->priv;
68
69     if (tile->w > REASONABLE_SIZE || tile->h > REASONABLE_SIZE) {
70         av_log(ctx, AV_LOG_ERROR, "Tile size %ux%u is insane.\n",
71                tile->w, tile->h);
72         return AVERROR(EINVAL);
73     }
74
75     if (tile->nb_frames == 0) {
76         tile->nb_frames = tile->w * tile->h;
77     } else if (tile->nb_frames > tile->w * tile->h) {
78         av_log(ctx, AV_LOG_ERROR, "nb_frames must be less than or equal to %dx%d=%d\n",
79                tile->w, tile->h, tile->w * tile->h);
80         return AVERROR(EINVAL);
81     }
82
83     return 0;
84 }
85
86 static int query_formats(AVFilterContext *ctx)
87 {
88     ff_set_common_formats(ctx, ff_draw_supported_pixel_formats(0));
89     return 0;
90 }
91
92 static int config_props(AVFilterLink *outlink)
93 {
94     AVFilterContext *ctx = outlink->src;
95     TileContext *tile    = ctx->priv;
96     AVFilterLink *inlink = ctx->inputs[0];
97     const unsigned total_margin_w = (tile->w - 1) * tile->padding + 2*tile->margin;
98     const unsigned total_margin_h = (tile->h - 1) * tile->padding + 2*tile->margin;
99
100     if (inlink->w > (INT_MAX - total_margin_w) / tile->w) {
101         av_log(ctx, AV_LOG_ERROR, "Total width %ux%u is too much.\n",
102                tile->w, inlink->w);
103         return AVERROR(EINVAL);
104     }
105     if (inlink->h > (INT_MAX - total_margin_h) / tile->h) {
106         av_log(ctx, AV_LOG_ERROR, "Total height %ux%u is too much.\n",
107                tile->h, inlink->h);
108         return AVERROR(EINVAL);
109     }
110     outlink->w = tile->w * inlink->w + total_margin_w;
111     outlink->h = tile->h * inlink->h + total_margin_h;
112     outlink->sample_aspect_ratio = inlink->sample_aspect_ratio;
113     outlink->frame_rate = av_mul_q(inlink->frame_rate,
114                                    (AVRational){ 1, tile->nb_frames });
115     ff_draw_init(&tile->draw, inlink->format, 0);
116     /* TODO make the color an option, or find an unified way of choosing it */
117     ff_draw_color(&tile->draw, &tile->blank, (uint8_t[]){ 0, 0, 0, -1 });
118
119     outlink->flags |= FF_LINK_FLAG_REQUEST_LOOP;
120
121     return 0;
122 }
123
124 static void get_current_tile_pos(AVFilterContext *ctx, unsigned *x, unsigned *y)
125 {
126     TileContext *tile    = ctx->priv;
127     AVFilterLink *inlink = ctx->inputs[0];
128     const unsigned tx = tile->current % tile->w;
129     const unsigned ty = tile->current / tile->w;
130
131     *x = tile->margin + (inlink->w + tile->padding) * tx;
132     *y = tile->margin + (inlink->h + tile->padding) * ty;
133 }
134
135 static void draw_blank_frame(AVFilterContext *ctx, AVFrame *out_buf)
136 {
137     TileContext *tile    = ctx->priv;
138     AVFilterLink *inlink = ctx->inputs[0];
139     unsigned x0, y0;
140
141     get_current_tile_pos(ctx, &x0, &y0);
142     ff_fill_rectangle(&tile->draw, &tile->blank,
143                       out_buf->data, out_buf->linesize,
144                       x0, y0, inlink->w, inlink->h);
145     tile->current++;
146 }
147 static int end_last_frame(AVFilterContext *ctx)
148 {
149     TileContext *tile     = ctx->priv;
150     AVFilterLink *outlink = ctx->outputs[0];
151     AVFrame *out_buf = tile->out_ref;
152     int ret;
153
154     while (tile->current < tile->nb_frames)
155         draw_blank_frame(ctx, out_buf);
156     ret = ff_filter_frame(outlink, out_buf);
157     tile->current = 0;
158     return ret;
159 }
160
161 /* Note: direct rendering is not possible since there is no guarantee that
162  * buffers are fed to filter_frame in the order they were obtained from
163  * get_buffer (think B-frames). */
164
165 static int filter_frame(AVFilterLink *inlink, AVFrame *picref)
166 {
167     AVFilterContext *ctx  = inlink->dst;
168     TileContext *tile     = ctx->priv;
169     AVFilterLink *outlink = ctx->outputs[0];
170     unsigned x0, y0;
171
172     if (!tile->current) {
173         tile->out_ref = ff_get_video_buffer(outlink, outlink->w, outlink->h);
174         if (!tile->out_ref)
175             return AVERROR(ENOMEM);
176         av_frame_copy_props(tile->out_ref, picref);
177         tile->out_ref->width  = outlink->w;
178         tile->out_ref->height = outlink->h;
179
180         /* fill surface once for margin/padding */
181         if (tile->margin || tile->padding)
182             ff_fill_rectangle(&tile->draw, &tile->blank,
183                               tile->out_ref->data,
184                               tile->out_ref->linesize,
185                               0, 0, outlink->w, outlink->h);
186     }
187
188     get_current_tile_pos(ctx, &x0, &y0);
189     ff_copy_rectangle2(&tile->draw,
190                        tile->out_ref->data, tile->out_ref->linesize,
191                        picref->data, picref->linesize,
192                        x0, y0, 0, 0, inlink->w, inlink->h);
193
194     av_frame_free(&picref);
195     if (++tile->current == tile->nb_frames)
196         return end_last_frame(ctx);
197
198     return 0;
199 }
200
201 static int request_frame(AVFilterLink *outlink)
202 {
203     AVFilterContext *ctx = outlink->src;
204     TileContext *tile    = ctx->priv;
205     AVFilterLink *inlink = ctx->inputs[0];
206     int r;
207
208     r = ff_request_frame(inlink);
209     if (r == AVERROR_EOF && tile->current)
210         r = end_last_frame(ctx);
211     return r;
212 }
213
214 static const AVFilterPad tile_inputs[] = {
215     {
216         .name         = "default",
217         .type         = AVMEDIA_TYPE_VIDEO,
218         .filter_frame = filter_frame,
219     },
220     { NULL }
221 };
222
223 static const AVFilterPad tile_outputs[] = {
224     {
225         .name          = "default",
226         .type          = AVMEDIA_TYPE_VIDEO,
227         .config_props  = config_props,
228         .request_frame = request_frame,
229     },
230     { NULL }
231 };
232
233 static const char *const shorthand[] =
234     { "layout", "nb_frames", "margin", "padding", NULL };
235
236 AVFilter avfilter_vf_tile = {
237     .name          = "tile",
238     .description   = NULL_IF_CONFIG_SMALL("Tile several successive frames together."),
239     .init          = init,
240     .query_formats = query_formats,
241     .priv_size     = sizeof(TileContext),
242     .inputs        = tile_inputs,
243     .outputs       = tile_outputs,
244     .priv_class    = &tile_class,
245     .shorthand     = shorthand,
246 };