FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
vf_tile.c
Go to the documentation of this file.
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/imgutils.h"
27 #include "libavutil/opt.h"
28 #include "libavutil/pixdesc.h"
29 #include "avfilter.h"
30 #include "drawutils.h"
31 #include "formats.h"
32 #include "video.h"
33 #include "internal.h"
34 
35 typedef struct TileContext {
36  const AVClass *class;
37  unsigned w, h;
38  unsigned margin;
39  unsigned padding;
40  unsigned overlap;
41  unsigned init_padding;
42  unsigned current;
43  unsigned nb_frames;
49 } TileContext;
50 
51 #define OFFSET(x) offsetof(TileContext, x)
52 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
53 
54 static const AVOption tile_options[] = {
55  { "layout", "set grid size", OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE,
56  {.str = "6x5"}, 0, 0, FLAGS },
57  { "nb_frames", "set maximum number of frame to render", OFFSET(nb_frames),
58  AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, FLAGS },
59  { "margin", "set outer border margin in pixels", OFFSET(margin),
60  AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1024, FLAGS },
61  { "padding", "set inner border thickness in pixels", OFFSET(padding),
62  AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1024, FLAGS },
63  { "color", "set the color of the unused area", OFFSET(rgba_color), AV_OPT_TYPE_COLOR, {.str = "black"}, .flags = FLAGS },
64  { "overlap", "set how many frames to overlap for each render", OFFSET(overlap),
65  AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, FLAGS },
66  { "init_padding", " set how many frames to initially pad", OFFSET(init_padding),
67  AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, FLAGS },
68  { NULL }
69 };
70 
72 
74 {
75  TileContext *tile = ctx->priv;
76 
77  if (tile->w > UINT_MAX / tile->h) {
78  av_log(ctx, AV_LOG_ERROR, "Tile size %ux%u is insane.\n",
79  tile->w, tile->h);
80  return AVERROR(EINVAL);
81  }
82 
83  if (tile->padding) {
84  if ((tile->w - 1 > (UINT32_MAX - 2 * tile->margin) / tile->padding) ||
85  (tile->h - 1 > (UINT32_MAX - 2 * tile->margin) / tile->padding)) {
86  av_log(ctx, AV_LOG_ERROR, "Combination of Tile size %ux%u, padding %d and margin %d overflows.\n",
87  tile->w, tile->h, tile->padding, tile->margin);
88  return AVERROR(EINVAL);
89  }
90  }
91 
92  if (tile->nb_frames == 0) {
93  tile->nb_frames = tile->w * tile->h;
94  } else if (tile->nb_frames > tile->w * tile->h) {
95  av_log(ctx, AV_LOG_ERROR, "nb_frames must be less than or equal to %dx%d=%d\n",
96  tile->w, tile->h, tile->w * tile->h);
97  return AVERROR(EINVAL);
98  }
99 
100  if (tile->overlap >= tile->nb_frames) {
101  av_log(ctx, AV_LOG_WARNING, "overlap must be less than %d\n", tile->nb_frames);
102  tile->overlap = tile->nb_frames - 1;
103  }
104 
105  if (tile->init_padding >= tile->nb_frames) {
106  av_log(ctx, AV_LOG_WARNING, "init_padding must be less than %d\n", tile->nb_frames);
107  } else {
108  tile->current = tile->init_padding;
109  }
110 
111  return 0;
112 }
113 
115 {
117 }
118 
119 static int config_props(AVFilterLink *outlink)
120 {
121  AVFilterContext *ctx = outlink->src;
122  TileContext *tile = ctx->priv;
123  AVFilterLink *inlink = ctx->inputs[0];
124  const unsigned total_margin_w = (tile->w - 1) * tile->padding + 2*tile->margin;
125  const unsigned total_margin_h = (tile->h - 1) * tile->padding + 2*tile->margin;
126 
127  if (inlink->w > (INT_MAX - total_margin_w) / tile->w) {
128  av_log(ctx, AV_LOG_ERROR, "Total width %ux%u is too much.\n",
129  tile->w, inlink->w);
130  return AVERROR(EINVAL);
131  }
132  if (inlink->h > (INT_MAX - total_margin_h) / tile->h) {
133  av_log(ctx, AV_LOG_ERROR, "Total height %ux%u is too much.\n",
134  tile->h, inlink->h);
135  return AVERROR(EINVAL);
136  }
137  outlink->w = tile->w * inlink->w + total_margin_w;
138  outlink->h = tile->h * inlink->h + total_margin_h;
139  outlink->sample_aspect_ratio = inlink->sample_aspect_ratio;
140  outlink->frame_rate = av_mul_q(inlink->frame_rate,
141  av_make_q(1, tile->nb_frames - tile->overlap));
142  ff_draw_init(&tile->draw, inlink->format, 0);
143  ff_draw_color(&tile->draw, &tile->blank, tile->rgba_color);
144 
145  return 0;
146 }
147 
148 static void get_tile_pos(AVFilterContext *ctx, unsigned *x, unsigned *y, unsigned current)
149 {
150  TileContext *tile = ctx->priv;
151  AVFilterLink *inlink = ctx->inputs[0];
152  const unsigned tx = current % tile->w;
153  const unsigned ty = current / tile->w;
154 
155  *x = tile->margin + (inlink->w + tile->padding) * tx;
156  *y = tile->margin + (inlink->h + tile->padding) * ty;
157 }
158 
160 {
161  TileContext *tile = ctx->priv;
162  AVFilterLink *inlink = ctx->inputs[0];
163  unsigned x0, y0;
164 
165  get_tile_pos(ctx, &x0, &y0, tile->current);
166  ff_fill_rectangle(&tile->draw, &tile->blank,
167  out_buf->data, out_buf->linesize,
168  x0, y0, inlink->w, inlink->h);
169  tile->current++;
170 }
171 
173 {
174  TileContext *tile = ctx->priv;
175  AVFilterLink *outlink = ctx->outputs[0];
176  AVFrame *out_buf = tile->out_ref;
177  int ret;
178 
179  while (tile->current < tile->nb_frames)
180  draw_blank_frame(ctx, out_buf);
181  tile->current = tile->overlap;
182  if (tile->current) {
183  av_frame_free(&tile->prev_out_ref);
184  tile->prev_out_ref = av_frame_clone(out_buf);
185  }
186  ret = ff_filter_frame(outlink, out_buf);
187  tile->out_ref = NULL;
188  return ret;
189 }
190 
191 /* Note: direct rendering is not possible since there is no guarantee that
192  * buffers are fed to filter_frame in the order they were obtained from
193  * get_buffer (think B-frames). */
194 
195 static int filter_frame(AVFilterLink *inlink, AVFrame *picref)
196 {
197  AVFilterContext *ctx = inlink->dst;
198  TileContext *tile = ctx->priv;
199  AVFilterLink *outlink = ctx->outputs[0];
200  unsigned x0, y0;
201 
202  if (!tile->out_ref) {
203  tile->out_ref = ff_get_video_buffer(outlink, outlink->w, outlink->h);
204  if (!tile->out_ref) {
205  av_frame_free(&picref);
206  return AVERROR(ENOMEM);
207  }
208  av_frame_copy_props(tile->out_ref, picref);
209  tile->out_ref->width = outlink->w;
210  tile->out_ref->height = outlink->h;
211 
212  /* fill surface once for margin/padding */
213  if (tile->margin || tile->padding || tile->init_padding)
214  ff_fill_rectangle(&tile->draw, &tile->blank,
215  tile->out_ref->data,
216  tile->out_ref->linesize,
217  0, 0, outlink->w, outlink->h);
218  tile->init_padding = 0;
219  }
220 
221  if (tile->prev_out_ref) {
222  unsigned x1, y1, i;
223 
224  for (i = tile->nb_frames - tile->overlap; i < tile->nb_frames; i++) {
225  get_tile_pos(ctx, &x1, &y1, i);
226  get_tile_pos(ctx, &x0, &y0, i - (tile->nb_frames - tile->overlap));
227  ff_copy_rectangle2(&tile->draw,
228  tile->out_ref->data, tile->out_ref->linesize,
229  tile->prev_out_ref->data, tile->prev_out_ref->linesize,
230  x0, y0, x1, y1, inlink->w, inlink->h);
231 
232  }
233  }
234 
235  get_tile_pos(ctx, &x0, &y0, tile->current);
236  ff_copy_rectangle2(&tile->draw,
237  tile->out_ref->data, tile->out_ref->linesize,
238  picref->data, picref->linesize,
239  x0, y0, 0, 0, inlink->w, inlink->h);
240 
241  av_frame_free(&picref);
242  if (++tile->current == tile->nb_frames)
243  return end_last_frame(ctx);
244 
245  return 0;
246 }
247 
248 static int request_frame(AVFilterLink *outlink)
249 {
250  AVFilterContext *ctx = outlink->src;
251  TileContext *tile = ctx->priv;
252  AVFilterLink *inlink = ctx->inputs[0];
253  int r;
254 
255  r = ff_request_frame(inlink);
256  if (r == AVERROR_EOF && tile->current && tile->out_ref)
257  r = end_last_frame(ctx);
258  return r;
259 }
260 
262 {
263  TileContext *tile = ctx->priv;
264 
265  av_frame_free(&tile->prev_out_ref);
266 }
267 
268 static const AVFilterPad tile_inputs[] = {
269  {
270  .name = "default",
271  .type = AVMEDIA_TYPE_VIDEO,
272  .filter_frame = filter_frame,
273  },
274  { NULL }
275 };
276 
277 static const AVFilterPad tile_outputs[] = {
278  {
279  .name = "default",
280  .type = AVMEDIA_TYPE_VIDEO,
281  .config_props = config_props,
282  .request_frame = request_frame,
283  },
284  { NULL }
285 };
286 
288  .name = "tile",
289  .description = NULL_IF_CONFIG_SMALL("Tile several successive frames together."),
290  .init = init,
291  .uninit = uninit,
292  .query_formats = query_formats,
293  .priv_size = sizeof(TileContext),
294  .inputs = tile_inputs,
295  .outputs = tile_outputs,
296  .priv_class = &tile_class,
297 };
AVFilterFormats * ff_draw_supported_pixel_formats(unsigned flags)
Return the list of pixel formats supported by the draw functions.
Definition: drawutils.c:731
#define NULL
Definition: coverity.c:32
This structure describes decoded (raw) audio or video data.
Definition: frame.h:226
void ff_copy_rectangle2(FFDrawContext *draw, uint8_t *dst[], int dst_linesize[], uint8_t *src[], int src_linesize[], int dst_x, int dst_y, int src_x, int src_y, int w, int h)
Copy a rectangle from an image to another.
Definition: drawutils.c:296
AVOption.
Definition: opt.h:246
static int request_frame(AVFilterLink *outlink)
Definition: vf_tile.c:248
misc image utilities
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
Main libavfilter public API header.
uint8_t rgba_color[4]
Definition: vf_tile.c:48
unsigned padding
Definition: vf_tile.c:39
AVFrame * ff_get_video_buffer(AVFilterLink *link, int w, int h)
Request a picture buffer with a specific set of permissions.
Definition: video.c:99
static int filter_frame(AVFilterLink *inlink, AVFrame *picref)
Definition: vf_tile.c:195
unsigned overlap
Definition: vf_tile.c:40
const char * name
Pad name.
Definition: internal.h:60
AVFilterLink ** inputs
array of pointers to input links
Definition: avfilter.h:346
unsigned nb_frames
Definition: vf_tile.c:43
static int end_last_frame(AVFilterContext *ctx)
Definition: vf_tile.c:172
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1080
uint8_t
#define av_cold
Definition: attributes.h:82
AVOptions.
AVFrame * prev_out_ref
Definition: vf_tile.c:47
static int config_props(AVFilterLink *outlink)
Definition: vf_tile.c:119
#define AVERROR_EOF
End of file.
Definition: error.h:55
static const AVFilterPad tile_inputs[]
Definition: vf_tile.c:268
#define av_log(a,...)
A filter pad used for either input or output.
Definition: internal.h:54
int width
Definition: frame.h:284
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
int ff_set_common_formats(AVFilterContext *ctx, AVFilterFormats *formats)
A helper for query_formats() which sets all links to the same list of formats.
Definition: formats.c:568
static void draw_blank_frame(AVFilterContext *ctx, AVFrame *out_buf)
Definition: vf_tile.c:159
#define AVERROR(e)
Definition: error.h:43
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:202
AVFILTER_DEFINE_CLASS(tile)
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:186
const char * r
Definition: vf_curves.c:114
void * priv
private data for use by the filter
Definition: avfilter.h:353
void ff_draw_color(FFDrawContext *draw, FFDrawColor *color, const uint8_t rgba[4])
Prepare a color.
Definition: drawutils.c:231
unsigned current
Definition: vf_tile.c:42
static int query_formats(AVFilterContext *ctx)
Definition: vf_tile.c:114
uint8_t w
Definition: llviddspenc.c:38
AVFormatContext * ctx
Definition: movenc.c:48
static const AVFilterPad tile_outputs[]
Definition: vf_tile.c:277
static av_cold int init(AVFilterContext *ctx)
Definition: vf_tile.c:73
static const AVFilterPad inputs[]
Definition: af_acontrast.c:193
AVFrame * av_frame_clone(const AVFrame *src)
Create a new frame that references the same data as src.
Definition: frame.c:540
static const AVFilterPad outputs[]
Definition: af_acontrast.c:203
static av_cold void uninit(AVFilterContext *ctx)
Definition: vf_tile.c:261
static void get_tile_pos(AVFilterContext *ctx, unsigned *x, unsigned *y, unsigned current)
Definition: vf_tile.c:148
misc drawing utilities
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:257
static AVRational av_make_q(int num, int den)
Create an AVRational.
Definition: rational.h:71
Describe the class of an AVClass context structure.
Definition: log.h:67
Filter definition.
Definition: avfilter.h:144
unsigned init_padding
Definition: vf_tile.c:41
const char * name
Filter name.
Definition: avfilter.h:148
int ff_draw_init(FFDrawContext *draw, enum AVPixelFormat format, unsigned flags)
Init a draw context.
Definition: drawutils.c:178
AVFrame * out_ref
Definition: vf_tile.c:46
offset must point to two consecutive integers
Definition: opt.h:233
unsigned h
Definition: vf_tile.c:37
AVFilterLink ** outputs
array of pointers to output links
Definition: avfilter.h:350
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:240
unsigned w
Definition: vf_tile.c:37
#define FLAGS
Definition: vf_tile.c:52
unsigned margin
Definition: vf_tile.c:38
FFDrawColor blank
Definition: vf_tile.c:45
static const AVOption tile_options[]
Definition: vf_tile.c:54
void ff_fill_rectangle(FFDrawContext *draw, FFDrawColor *color, uint8_t *dst[], int dst_linesize[], int dst_x, int dst_y, int w, int h)
Fill a rectangle with an uniform color.
Definition: drawutils.c:318
An instance of a filter.
Definition: avfilter.h:338
AVRational av_mul_q(AVRational b, AVRational c)
Multiply two rationals.
Definition: rational.c:80
int height
Definition: frame.h:284
AVFilter ff_vf_tile
Definition: vf_tile.c:287
int ff_request_frame(AVFilterLink *link)
Request an input frame from the filter at the other end of the link.
Definition: avfilter.c:407
internal API functions
int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
Copy only "metadata" fields from src to dst.
Definition: frame.c:654
#define OFFSET(x)
Definition: vf_tile.c:51
FFDrawContext draw
Definition: vf_tile.c:44