FFmpeg
vf_mergeplanes.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013 Paul B Mahol
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 #include "libavutil/avassert.h"
22 #include "libavutil/avstring.h"
23 #include "libavutil/imgutils.h"
24 #include "libavutil/opt.h"
25 #include "libavutil/pixdesc.h"
26 #include "avfilter.h"
27 #include "internal.h"
28 #include "framesync.h"
29 
30 typedef struct InputParam {
31  int depth[4];
32  int nb_planes;
33  int planewidth[4];
34  int planeheight[4];
35 } InputParam;
36 
37 typedef struct MergePlanesContext {
38  const AVClass *class;
39  int64_t mapping;
40  const enum AVPixelFormat out_fmt;
41  int nb_inputs;
42  int nb_planes;
43  int planewidth[4];
44  int planeheight[4];
45  int map[4][2];
47 
50 
51 #define OFFSET(x) offsetof(MergePlanesContext, x)
52 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
53 static const AVOption mergeplanes_options[] = {
54  { "mapping", "set input to output plane mapping", OFFSET(mapping), AV_OPT_TYPE_INT, {.i64=0}, 0, 0x33333333, FLAGS },
55  { "format", "set output pixel format", OFFSET(out_fmt), AV_OPT_TYPE_PIXEL_FMT, {.i64=AV_PIX_FMT_YUVA444P}, 0, INT_MAX, .flags=FLAGS },
56  { NULL }
57 };
58 
59 AVFILTER_DEFINE_CLASS(mergeplanes);
60 
62 {
63  MergePlanesContext *s = ctx->priv;
64  int64_t m = s->mapping;
65  int i, ret;
66 
67  s->outdesc = av_pix_fmt_desc_get(s->out_fmt);
68  if (!(s->outdesc->flags & AV_PIX_FMT_FLAG_PLANAR) ||
69  s->outdesc->nb_components < 2) {
70  av_log(ctx, AV_LOG_ERROR, "Only planar formats with more than one component are supported.\n");
71  return AVERROR(EINVAL);
72  }
73  s->nb_planes = av_pix_fmt_count_planes(s->out_fmt);
74 
75  for (i = s->nb_planes - 1; i >= 0; i--) {
76  s->map[i][0] = m & 0xf;
77  m >>= 4;
78  s->map[i][1] = m & 0xf;
79  m >>= 4;
80 
81  if (s->map[i][0] > 3 || s->map[i][1] > 3) {
82  av_log(ctx, AV_LOG_ERROR, "Mapping with out of range input and/or plane number.\n");
83  return AVERROR(EINVAL);
84  }
85 
86  s->nb_inputs = FFMAX(s->nb_inputs, s->map[i][1] + 1);
87  }
88 
89  av_assert0(s->nb_inputs && s->nb_inputs <= 4);
90 
91  for (i = 0; i < s->nb_inputs; i++) {
92  AVFilterPad pad = { 0 };
93 
95  pad.name = av_asprintf("in%d", i);
96  if (!pad.name)
97  return AVERROR(ENOMEM);
98 
99  if ((ret = ff_append_inpad_free_name(ctx, &pad)) < 0)
100  return ret;
101  }
102 
103  return 0;
104 }
105 
107 {
108  MergePlanesContext *s = ctx->priv;
110  int i, ret;
111 
112  s->outdesc = av_pix_fmt_desc_get(s->out_fmt);
113  for (i = 0; av_pix_fmt_desc_get(i); i++) {
115  if (desc->comp[0].depth == s->outdesc->comp[0].depth &&
116  (desc->comp[0].depth <= 8 || (desc->flags & AV_PIX_FMT_FLAG_BE) == (s->outdesc->flags & AV_PIX_FMT_FLAG_BE)) &&
117  av_pix_fmt_count_planes(i) == desc->nb_components &&
118  (ret = ff_add_format(&formats, i)) < 0)
119  return ret;
120  }
121 
122  for (i = 0; i < s->nb_inputs; i++)
123  if ((ret = ff_formats_ref(formats, &ctx->inputs[i]->outcfg.formats)) < 0)
124  return ret;
125 
126  formats = NULL;
127  if ((ret = ff_add_format(&formats, s->out_fmt)) < 0 ||
128  (ret = ff_formats_ref(formats, &ctx->outputs[0]->incfg.formats)) < 0)
129  return ret;
130 
131  return 0;
132 }
133 
135 {
136  AVFilterContext *ctx = fs->parent;
137  AVFilterLink *outlink = ctx->outputs[0];
138  MergePlanesContext *s = fs->opaque;
139  AVFrame *in[4] = { NULL };
140  AVFrame *out;
141  int i, ret;
142 
143  for (i = 0; i < s->nb_inputs; i++) {
144  if ((ret = ff_framesync_get_frame(&s->fs, i, &in[i], 0)) < 0)
145  return ret;
146  }
147 
148  out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
149  if (!out)
150  return AVERROR(ENOMEM);
151  out->pts = av_rescale_q(s->fs.pts, s->fs.time_base, outlink->time_base);
152 
153  for (i = 0; i < s->nb_planes; i++) {
154  const int input = s->map[i][1];
155  const int plane = s->map[i][0];
156 
157  av_image_copy_plane(out->data[i], out->linesize[i],
158  in[input]->data[plane], in[input]->linesize[plane],
159  s->planewidth[i], s->planeheight[i]);
160  }
161 
162  return ff_filter_frame(outlink, out);
163 }
164 
165 static int config_output(AVFilterLink *outlink)
166 {
167  AVFilterContext *ctx = outlink->src;
168  MergePlanesContext *s = ctx->priv;
169  InputParam inputsp[4];
170  FFFrameSyncIn *in;
171  int i, ret;
172 
173  if ((ret = ff_framesync_init(&s->fs, ctx, s->nb_inputs)) < 0)
174  return ret;
175 
176  in = s->fs.in;
177  s->fs.opaque = s;
178  s->fs.on_event = process_frame;
179 
180  outlink->w = ctx->inputs[0]->w;
181  outlink->h = ctx->inputs[0]->h;
182  outlink->time_base = ctx->inputs[0]->time_base;
183  outlink->frame_rate = ctx->inputs[0]->frame_rate;
184  outlink->sample_aspect_ratio = ctx->inputs[0]->sample_aspect_ratio;
185 
186  s->planewidth[1] =
187  s->planewidth[2] = AV_CEIL_RSHIFT(((s->outdesc->comp[1].depth > 8) + 1) * outlink->w, s->outdesc->log2_chroma_w);
188  s->planewidth[0] =
189  s->planewidth[3] = ((s->outdesc->comp[0].depth > 8) + 1) * outlink->w;
190  s->planeheight[1] =
191  s->planeheight[2] = AV_CEIL_RSHIFT(outlink->h, s->outdesc->log2_chroma_h);
192  s->planeheight[0] =
193  s->planeheight[3] = outlink->h;
194 
195  for (i = 0; i < s->nb_inputs; i++) {
196  InputParam *inputp = &inputsp[i];
197  AVFilterLink *inlink = ctx->inputs[i];
198  const AVPixFmtDescriptor *indesc = av_pix_fmt_desc_get(inlink->format);
199  int j;
200 
201  if (outlink->sample_aspect_ratio.num != inlink->sample_aspect_ratio.num ||
202  outlink->sample_aspect_ratio.den != inlink->sample_aspect_ratio.den) {
203  av_log(ctx, AV_LOG_ERROR, "input #%d link %s SAR %d:%d "
204  "does not match output link %s SAR %d:%d\n",
205  i, ctx->input_pads[i].name,
206  inlink->sample_aspect_ratio.num,
207  inlink->sample_aspect_ratio.den,
208  ctx->output_pads[0].name,
209  outlink->sample_aspect_ratio.num,
210  outlink->sample_aspect_ratio.den);
211  return AVERROR(EINVAL);
212  }
213 
214  inputp->planewidth[1] =
215  inputp->planewidth[2] = AV_CEIL_RSHIFT(((indesc->comp[1].depth > 8) + 1) * inlink->w, indesc->log2_chroma_w);
216  inputp->planewidth[0] =
217  inputp->planewidth[3] = ((indesc->comp[0].depth > 8) + 1) * inlink->w;
218  inputp->planeheight[1] =
219  inputp->planeheight[2] = AV_CEIL_RSHIFT(inlink->h, indesc->log2_chroma_h);
220  inputp->planeheight[0] =
221  inputp->planeheight[3] = inlink->h;
222  inputp->nb_planes = av_pix_fmt_count_planes(inlink->format);
223 
224  for (j = 0; j < inputp->nb_planes; j++)
225  inputp->depth[j] = indesc->comp[j].depth;
226 
227  in[i].time_base = inlink->time_base;
228  in[i].sync = 1;
229  in[i].before = EXT_STOP;
230  in[i].after = EXT_STOP;
231  }
232 
233  for (i = 0; i < s->nb_planes; i++) {
234  const int input = s->map[i][1];
235  const int plane = s->map[i][0];
236  InputParam *inputp = &inputsp[input];
237 
238  if (plane + 1 > inputp->nb_planes) {
239  av_log(ctx, AV_LOG_ERROR, "input %d does not have %d plane\n",
240  input, plane);
241  goto fail;
242  }
243  if (s->outdesc->comp[i].depth != inputp->depth[plane]) {
244  av_log(ctx, AV_LOG_ERROR, "output plane %d depth %d does not "
245  "match input %d plane %d depth %d\n",
246  i, s->outdesc->comp[i].depth,
247  input, plane, inputp->depth[plane]);
248  goto fail;
249  }
250  if (s->planewidth[i] != inputp->planewidth[plane]) {
251  av_log(ctx, AV_LOG_ERROR, "output plane %d width %d does not "
252  "match input %d plane %d width %d\n",
253  i, s->planewidth[i],
254  input, plane, inputp->planewidth[plane]);
255  goto fail;
256  }
257  if (s->planeheight[i] != inputp->planeheight[plane]) {
258  av_log(ctx, AV_LOG_ERROR, "output plane %d height %d does not "
259  "match input %d plane %d height %d\n",
260  i, s->planeheight[i],
261  input, plane, inputp->planeheight[plane]);
262  goto fail;
263  }
264  }
265 
266  return ff_framesync_configure(&s->fs);
267 fail:
268  return AVERROR(EINVAL);
269 }
270 
272 {
273  MergePlanesContext *s = ctx->priv;
274  return ff_framesync_activate(&s->fs);
275 }
276 
278 {
279  MergePlanesContext *s = ctx->priv;
280 
281  ff_framesync_uninit(&s->fs);
282 }
283 
285  {
286  .name = "default",
287  .type = AVMEDIA_TYPE_VIDEO,
288  .config_props = config_output,
289  },
290 };
291 
293  .name = "mergeplanes",
294  .description = NULL_IF_CONFIG_SMALL("Merge planes."),
295  .priv_size = sizeof(MergePlanesContext),
296  .priv_class = &mergeplanes_class,
297  .init = init,
298  .uninit = uninit,
299  .activate = activate,
300  .inputs = NULL,
304 };
formats
formats
Definition: signature.h:48
ff_get_video_buffer
AVFrame * ff_get_video_buffer(AVFilterLink *link, int w, int h)
Request a picture buffer with a specific set of permissions.
Definition: video.c:98
InputParam
Definition: vf_mergeplanes.c:30
FFFrameSyncIn::time_base
AVRational time_base
Time base for the incoming frames.
Definition: framesync.h:96
ff_framesync_configure
int ff_framesync_configure(FFFrameSync *fs)
Configure a frame sync structure.
Definition: framesync.c:119
mergeplanes_options
static const AVOption mergeplanes_options[]
Definition: vf_mergeplanes.c:53
AVPixelFormat
AVPixelFormat
Pixel format.
Definition: pixfmt.h:64
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
opt.h
ff_framesync_uninit
void ff_framesync_uninit(FFFrameSync *fs)
Free all memory currently allocated.
Definition: framesync.c:285
out
FILE * out
Definition: movenc.c:54
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1018
MergePlanesContext::planeheight
int planeheight[4]
Definition: vf_mergeplanes.c:44
av_pix_fmt_desc_get
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2564
ff_framesync_get_frame
int ff_framesync_get_frame(FFFrameSync *fs, unsigned in, AVFrame **rframe, unsigned get)
Get the current frame in an input.
Definition: framesync.c:248
MergePlanesContext::nb_inputs
int nb_inputs
Definition: vf_mergeplanes.c:41
inlink
The exact code depends on how similar the blocks are and how related they are to the and needs to apply these operations to the correct inlink or outlink if there are several Macros are available to factor that when no extra processing is inlink
Definition: filter_design.txt:212
av_asprintf
char * av_asprintf(const char *fmt,...)
Definition: avstring.c:113
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:303
pixdesc.h
AVComponentDescriptor::depth
int depth
Number of bits in the component.
Definition: pixdesc.h:57
AVOption
AVOption.
Definition: opt.h:247
FILTER_QUERY_FUNC
#define FILTER_QUERY_FUNC(func)
Definition: internal.h:168
MergePlanesContext::map
int map[4][2]
Definition: vf_mergeplanes.c:45
FFMAX
#define FFMAX(a, b)
Definition: macros.h:47
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:153
FFFrameSync
Frame sync structure.
Definition: framesync.h:146
MergePlanesContext::planewidth
int planewidth[4]
Definition: vf_mergeplanes.c:43
AVFrame::data
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:317
av_image_copy_plane
void av_image_copy_plane(uint8_t *dst, int dst_linesize, const uint8_t *src, int src_linesize, int bytewidth, int height)
Copy image plane from src to dst.
Definition: imgutils.c:374
AVFilterFormats
A list of supported formats for one end of a filter link.
Definition: formats.h:64
av_pix_fmt_count_planes
int av_pix_fmt_count_planes(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2604
EXT_STOP
@ EXT_STOP
Completely stop all streams with this one.
Definition: framesync.h:65
MergePlanesContext
Definition: vf_mergeplanes.c:37
fail
#define fail()
Definition: checkasm.h:127
FFFrameSyncIn
Input stream structure.
Definition: framesync.h:81
InputParam::planeheight
int planeheight[4]
Definition: vf_mergeplanes.c:34
InputParam::nb_planes
int nb_planes
Definition: vf_mergeplanes.c:32
FFFrameSyncIn::sync
unsigned sync
Synchronization level: frames on input at the highest sync level will generate output frame events.
Definition: framesync.h:139
AVFILTER_FLAG_DYNAMIC_INPUTS
#define AVFILTER_FLAG_DYNAMIC_INPUTS
The number of the filter inputs is not determined just by AVFilter.inputs.
Definition: avfilter.h:110
AVRational::num
int num
Numerator.
Definition: rational.h:59
query_formats
static int query_formats(AVFilterContext *ctx)
Definition: vf_mergeplanes.c:106
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:50
MergePlanesContext::fs
FFFrameSync fs
Definition: vf_mergeplanes.c:48
avassert.h
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
av_cold
#define av_cold
Definition: attributes.h:90
inputs
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several inputs
Definition: filter_design.txt:243
s
#define s(width, name)
Definition: cbs_vp9.c:257
AV_CEIL_RSHIFT
#define AV_CEIL_RSHIFT(a, b)
Definition: common.h:51
ff_formats_ref
int ff_formats_ref(AVFilterFormats *f, AVFilterFormats **ref)
Add *ref as a new reference to formats.
Definition: formats.c:555
OFFSET
#define OFFSET(x)
Definition: vf_mergeplanes.c:51
av_assert0
#define av_assert0(cond)
assert() equivalent, that is always enabled.
Definition: avassert.h:37
ctx
AVFormatContext * ctx
Definition: movenc.c:48
av_rescale_q
int64_t av_rescale_q(int64_t a, AVRational bq, AVRational cq)
Rescale a 64-bit integer by 2 rational numbers.
Definition: mathematics.c:141
AVPixFmtDescriptor::log2_chroma_w
uint8_t log2_chroma_w
Amount to shift the luma width right to find the chroma width.
Definition: pixdesc.h:80
config_output
static int config_output(AVFilterLink *outlink)
Definition: vf_mergeplanes.c:165
InputParam::planewidth
int planewidth[4]
Definition: vf_mergeplanes.c:33
MergePlanesContext::mapping
int64_t mapping
Definition: vf_mergeplanes.c:39
mergeplanes_outputs
static const AVFilterPad mergeplanes_outputs[]
Definition: vf_mergeplanes.c:284
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
activate
static int activate(AVFilterContext *ctx)
Definition: vf_mergeplanes.c:271
NULL
#define NULL
Definition: coverity.c:32
fs
#define fs(width, name, subs,...)
Definition: cbs_vp9.c:259
ff_append_inpad_free_name
int ff_append_inpad_free_name(AVFilterContext *f, AVFilterPad *p)
Definition: avfilter.c:144
ff_add_format
int ff_add_format(AVFilterFormats **avff, int64_t fmt)
Add fmt to the list of media formats contained in *avff.
Definition: formats.c:420
MergePlanesContext::out_fmt
enum AVPixelFormat out_fmt
Definition: vf_mergeplanes.c:40
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:117
InputParam::depth
int depth[4]
Definition: vf_mergeplanes.c:31
FLAGS
#define FLAGS
Definition: vf_mergeplanes.c:52
ff_vf_mergeplanes
const AVFilter ff_vf_mergeplanes
Definition: vf_mergeplanes.c:292
AV_PIX_FMT_YUVA444P
@ AV_PIX_FMT_YUVA444P
planar YUV 4:4:4 32bpp, (1 Cr & Cb sample per 1x1 Y & A samples)
Definition: pixfmt.h:167
MergePlanesContext::outdesc
const AVPixFmtDescriptor * outdesc
Definition: vf_mergeplanes.c:46
input
and forward the test the status of outputs and forward it to the corresponding return FFERROR_NOT_READY If the filters stores internally one or a few frame for some input
Definition: filter_design.txt:172
internal.h
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:271
init
static av_cold int init(AVFilterContext *ctx)
Definition: vf_mergeplanes.c:61
AV_PIX_FMT_FLAG_BE
#define AV_PIX_FMT_FLAG_BE
Pixel format is big-endian.
Definition: pixdesc.h:116
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:56
AVFilter
Filter definition.
Definition: avfilter.h:149
ret
ret
Definition: filter_design.txt:187
AVFilterPad::type
enum AVMediaType type
AVFilterPad type.
Definition: internal.h:61
ff_framesync_init
int ff_framesync_init(FFFrameSync *fs, AVFilterContext *parent, unsigned nb_in)
Initialize a frame sync structure.
Definition: framesync.c:79
FFFrameSyncIn::before
enum FFFrameSyncExtMode before
Extrapolation mode for timestamps before the first frame.
Definition: framesync.h:86
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(mergeplanes)
framesync.h
AVRational::den
int den
Denominator.
Definition: rational.h:60
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:224
avfilter.h
AVPixFmtDescriptor::comp
AVComponentDescriptor comp[4]
Parameters that describe how pixels are packed.
Definition: pixdesc.h:105
AV_PIX_FMT_FLAG_PLANAR
#define AV_PIX_FMT_FLAG_PLANAR
At least one pixel component is not in the first data plane.
Definition: pixdesc.h:132
AV_OPT_TYPE_PIXEL_FMT
@ AV_OPT_TYPE_PIXEL_FMT
Definition: opt.h:235
AVFilterContext
An instance of a filter.
Definition: avfilter.h:386
desc
const char * desc
Definition: libsvtav1.c:79
process_frame
static int process_frame(FFFrameSync *fs)
Definition: vf_mergeplanes.c:134
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
AVPixFmtDescriptor
Descriptor that unambiguously describes how the bits of a pixel are stored in the up to 4 data planes...
Definition: pixdesc.h:69
FILTER_OUTPUTS
#define FILTER_OUTPUTS(array)
Definition: internal.h:192
imgutils.h
AVFrame::linesize
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:334
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:28
FFFrameSyncIn::after
enum FFFrameSyncExtMode after
Extrapolation mode for timestamps after the last frame.
Definition: framesync.h:91
ff_framesync_activate
int ff_framesync_activate(FFFrameSync *fs)
Examine the frames in the filter's input and try to produce output.
Definition: framesync.c:336
avstring.h
AVPixFmtDescriptor::log2_chroma_h
uint8_t log2_chroma_h
Amount to shift the luma height right to find the chroma height.
Definition: pixdesc.h:89
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: vf_mergeplanes.c:277
MergePlanesContext::nb_planes
int nb_planes
Definition: vf_mergeplanes.c:42