Merge commit 'a6a750c7ef240b72ce01e9653343a0ddf247d196'
[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     uint8_t rgba_color[4];
45 } TileContext;
46
47 #define REASONABLE_SIZE 1024
48
49 #define OFFSET(x) offsetof(TileContext, x)
50 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
51
52 static const AVOption tile_options[] = {
53     { "layout", "set grid size", OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE,
54         {.str = "6x5"}, 0, 0, FLAGS },
55     { "nb_frames", "set maximum number of frame to render", OFFSET(nb_frames),
56         AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, FLAGS },
57     { "margin",  "set outer border margin in pixels",    OFFSET(margin),
58         AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1024, FLAGS },
59     { "padding", "set inner border thickness in pixels", OFFSET(padding),
60         AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1024, FLAGS },
61     { "color",   "set the color of the unused area", OFFSET(rgba_color), AV_OPT_TYPE_COLOR, {.str = "black"}, .flags = FLAGS },
62     { NULL }
63 };
64
65 AVFILTER_DEFINE_CLASS(tile);
66
67 static av_cold int init(AVFilterContext *ctx)
68 {
69     TileContext *tile = ctx->priv;
70
71     if (tile->w > REASONABLE_SIZE || tile->h > REASONABLE_SIZE) {
72         av_log(ctx, AV_LOG_ERROR, "Tile size %ux%u is insane.\n",
73                tile->w, tile->h);
74         return AVERROR(EINVAL);
75     }
76
77     if (tile->nb_frames == 0) {
78         tile->nb_frames = tile->w * tile->h;
79     } else if (tile->nb_frames > tile->w * tile->h) {
80         av_log(ctx, AV_LOG_ERROR, "nb_frames must be less than or equal to %dx%d=%d\n",
81                tile->w, tile->h, tile->w * tile->h);
82         return AVERROR(EINVAL);
83     }
84
85     return 0;
86 }
87
88 static int query_formats(AVFilterContext *ctx)
89 {
90     return ff_set_common_formats(ctx, ff_draw_supported_pixel_formats(0));
91 }
92
93 static int config_props(AVFilterLink *outlink)
94 {
95     AVFilterContext *ctx = outlink->src;
96     TileContext *tile    = ctx->priv;
97     AVFilterLink *inlink = ctx->inputs[0];
98     const unsigned total_margin_w = (tile->w - 1) * tile->padding + 2*tile->margin;
99     const unsigned total_margin_h = (tile->h - 1) * tile->padding + 2*tile->margin;
100
101     if (inlink->w > (INT_MAX - total_margin_w) / tile->w) {
102         av_log(ctx, AV_LOG_ERROR, "Total width %ux%u is too much.\n",
103                tile->w, inlink->w);
104         return AVERROR(EINVAL);
105     }
106     if (inlink->h > (INT_MAX - total_margin_h) / tile->h) {
107         av_log(ctx, AV_LOG_ERROR, "Total height %ux%u is too much.\n",
108                tile->h, inlink->h);
109         return AVERROR(EINVAL);
110     }
111     outlink->w = tile->w * inlink->w + total_margin_w;
112     outlink->h = tile->h * inlink->h + total_margin_h;
113     outlink->sample_aspect_ratio = inlink->sample_aspect_ratio;
114     outlink->frame_rate = av_mul_q(inlink->frame_rate,
115                                    av_make_q(1, tile->nb_frames));
116     ff_draw_init(&tile->draw, inlink->format, 0);
117     ff_draw_color(&tile->draw, &tile->blank, tile->rgba_color);
118
119     return 0;
120 }
121
122 static void get_current_tile_pos(AVFilterContext *ctx, unsigned *x, unsigned *y)
123 {
124     TileContext *tile    = ctx->priv;
125     AVFilterLink *inlink = ctx->inputs[0];
126     const unsigned tx = tile->current % tile->w;
127     const unsigned ty = tile->current / tile->w;
128
129     *x = tile->margin + (inlink->w + tile->padding) * tx;
130     *y = tile->margin + (inlink->h + tile->padding) * ty;
131 }
132
133 static void draw_blank_frame(AVFilterContext *ctx, AVFrame *out_buf)
134 {
135     TileContext *tile    = ctx->priv;
136     AVFilterLink *inlink = ctx->inputs[0];
137     unsigned x0, y0;
138
139     get_current_tile_pos(ctx, &x0, &y0);
140     ff_fill_rectangle(&tile->draw, &tile->blank,
141                       out_buf->data, out_buf->linesize,
142                       x0, y0, inlink->w, inlink->h);
143     tile->current++;
144 }
145 static int end_last_frame(AVFilterContext *ctx)
146 {
147     TileContext *tile     = ctx->priv;
148     AVFilterLink *outlink = ctx->outputs[0];
149     AVFrame *out_buf = tile->out_ref;
150     int ret;
151
152     while (tile->current < tile->nb_frames)
153         draw_blank_frame(ctx, out_buf);
154     ret = ff_filter_frame(outlink, out_buf);
155     tile->current = 0;
156     return ret;
157 }
158
159 /* Note: direct rendering is not possible since there is no guarantee that
160  * buffers are fed to filter_frame in the order they were obtained from
161  * get_buffer (think B-frames). */
162
163 static int filter_frame(AVFilterLink *inlink, AVFrame *picref)
164 {
165     AVFilterContext *ctx  = inlink->dst;
166     TileContext *tile     = ctx->priv;
167     AVFilterLink *outlink = ctx->outputs[0];
168     unsigned x0, y0;
169
170     if (!tile->current) {
171         tile->out_ref = ff_get_video_buffer(outlink, outlink->w, outlink->h);
172         if (!tile->out_ref) {
173             av_frame_free(&picref);
174             return AVERROR(ENOMEM);
175         }
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 AVFilter ff_vf_tile = {
234     .name          = "tile",
235     .description   = NULL_IF_CONFIG_SMALL("Tile several successive frames together."),
236     .init          = init,
237     .query_formats = query_formats,
238     .priv_size     = sizeof(TileContext),
239     .inputs        = tile_inputs,
240     .outputs       = tile_outputs,
241     .priv_class    = &tile_class,
242 };