FFmpeg
vf_shuffleplanes.c
Go to the documentation of this file.
1 /*
2  * This file is part of FFmpeg.
3  *
4  * FFmpeg is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * FFmpeg is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with FFmpeg; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18 
19 #include "libavutil/avstring.h"
20 #include "libavutil/common.h"
21 #include "libavutil/internal.h"
22 #include "libavutil/opt.h"
23 #include "libavutil/pixdesc.h"
24 #include "libavutil/pixfmt.h"
25 
26 #include "avfilter.h"
27 #include "internal.h"
28 #include "video.h"
29 
30 typedef struct ShufflePlanesContext {
31  const AVClass *class;
32 
33  /* number of planes in the selected pixel format */
34  int planes;
35 
36  /* mapping indices */
37  int map[4];
38 
39  /* set to 1 if some plane is used more than once, so we need to make a copy */
40  int copy;
42 
44 {
46  ShufflePlanesContext *s = ctx->priv;
47  int fmt, ret, i;
48 
49  for (fmt = 0; av_pix_fmt_desc_get(fmt); fmt++) {
52 
53  if (!(desc->flags & AV_PIX_FMT_FLAG_PAL) &&
54  !(desc->flags & AV_PIX_FMT_FLAG_HWACCEL)) {
55  for (i = 0; i < 4; i++) {
56  if (s->map[i] >= planes)
57  break;
58 
59  if ((desc->log2_chroma_h || desc->log2_chroma_w) &&
60  (i == 1 || i == 2) != (s->map[i] == 1 || s->map[i] == 2))
61  break;
62  }
63 
64  if (i != 4)
65  continue;
66  if ((ret = ff_add_format(&formats, fmt)) < 0) {
67  return ret;
68  }
69  }
70  }
71 
73 }
74 
76 {
77  AVFilterContext *ctx = inlink->dst;
78  ShufflePlanesContext *s = ctx->priv;
79  int used[4] = { 0 };
80  int i;
81 
82  s->copy = 0;
83  s->planes = av_pix_fmt_count_planes(inlink->format);
84 
85  for (i = 0; i < s->planes; i++) {
86  if (used[s->map[i]])
87  s->copy = 1;
88  used[s->map[i]]++;
89  }
90 
91  return 0;
92 }
93 
95 {
96  AVFilterContext *ctx = inlink->dst;
97  ShufflePlanesContext *s = ctx->priv;
98  uint8_t *shuffled_data[4] = { NULL };
99  int shuffled_linesize[4] = { 0 };
100  int i, ret;
101 
102  for (i = 0; i < s->planes; i++) {
103  shuffled_data[i] = frame->data[s->map[i]];
104  shuffled_linesize[i] = frame->linesize[s->map[i]];
105  }
106  memcpy(frame->data, shuffled_data, sizeof(shuffled_data));
107  memcpy(frame->linesize, shuffled_linesize, sizeof(shuffled_linesize));
108 
109  if (s->copy) {
110  AVFrame *copy = ff_get_video_buffer(ctx->outputs[0], frame->width, frame->height);
111 
112  if (!copy) {
113  ret = AVERROR(ENOMEM);
114  goto fail;
115  }
116 
118 
120  if (ret < 0) {
122  goto fail;
123  }
124 
126  frame = copy;
127  }
128 
129  return ff_filter_frame(ctx->outputs[0], frame);
130 fail:
132  return ret;
133 }
134 
135 #define OFFSET(x) offsetof(ShufflePlanesContext, x)
136 #define FLAGS (AV_OPT_FLAG_FILTERING_PARAM | AV_OPT_FLAG_VIDEO_PARAM)
137 static const AVOption shuffleplanes_options[] = {
138  { "map0", "Index of the input plane to be used as the first output plane ", OFFSET(map[0]), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 3, FLAGS },
139  { "map1", "Index of the input plane to be used as the second output plane ", OFFSET(map[1]), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 3, FLAGS },
140  { "map2", "Index of the input plane to be used as the third output plane ", OFFSET(map[2]), AV_OPT_TYPE_INT, { .i64 = 2 }, 0, 3, FLAGS },
141  { "map3", "Index of the input plane to be used as the fourth output plane ", OFFSET(map[3]), AV_OPT_TYPE_INT, { .i64 = 3 }, 0, 3, FLAGS },
142  { NULL },
143 };
144 
145 AVFILTER_DEFINE_CLASS(shuffleplanes);
146 
148  {
149  .name = "default",
150  .type = AVMEDIA_TYPE_VIDEO,
151  .config_props = shuffleplanes_config_input,
152  .filter_frame = shuffleplanes_filter_frame,
153  },
154  { NULL },
155 };
156 
158  {
159  .name = "default",
160  .type = AVMEDIA_TYPE_VIDEO,
161  },
162  { NULL },
163 };
164 
166  .name = "shuffleplanes",
167  .description = NULL_IF_CONFIG_SMALL("Shuffle video planes."),
168  .priv_size = sizeof(ShufflePlanesContext),
169  .priv_class = &shuffleplanes_class,
174 };
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:99
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(shuffleplanes)
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_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:978
av_pix_fmt_desc_get
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2541
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_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:111
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:303
pixdesc.h
AVOption
AVOption.
Definition: opt.h:248
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:149
ShufflePlanesContext::copy
int copy
Definition: vf_shuffleplanes.c:40
video.h
ShufflePlanesContext
Definition: vf_shuffleplanes.c:30
AVFilterFormats
A list of supported formats for one end of a filter link.
Definition: formats.h:65
av_pix_fmt_count_planes
int av_pix_fmt_count_planes(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2581
shuffleplanes_config_input
static av_cold int shuffleplanes_config_input(AVFilterLink *inlink)
Definition: vf_shuffleplanes.c:75
fail
#define fail()
Definition: checkasm.h:134
AV_PIX_FMT_FLAG_HWACCEL
#define AV_PIX_FMT_FLAG_HWACCEL
Pixel format is an HW accelerated format.
Definition: pixdesc.h:129
ff_vf_shuffleplanes
const AVFilter ff_vf_shuffleplanes
Definition: vf_shuffleplanes.c:165
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:54
ShufflePlanesContext::map
int map[4]
Definition: vf_shuffleplanes.c:37
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
ff_set_common_formats
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:580
shuffleplanes_outputs
static const AVFilterPad shuffleplanes_outputs[]
Definition: vf_shuffleplanes.c:157
s
#define s(width, name)
Definition: cbs_vp9.c:257
outputs
static const AVFilterPad outputs[]
Definition: af_acontrast.c:203
query_formats
static int query_formats(AVFilterContext *ctx)
Definition: vf_shuffleplanes.c:43
ctx
AVFormatContext * ctx
Definition: movenc.c:48
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:67
NULL
#define NULL
Definition: coverity.c:32
av_frame_copy_props
int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
Copy only "metadata" fields from src to dst.
Definition: frame.c:536
OFFSET
#define OFFSET(x)
Definition: vf_shuffleplanes.c:135
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:325
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
copy
static void copy(const float *p1, float *p2, const int length)
Definition: vf_vaguedenoiser.c:194
av_frame_copy
int av_frame_copy(AVFrame *dst, const AVFrame *src)
Copy the frame data from src to dst.
Definition: frame.c:677
ShufflePlanesContext::planes
int planes
Definition: vf_shuffleplanes.c:34
internal.h
AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC
#define AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC
Some filters support a generic "enable" expression option that can be used to enable or disable a fil...
Definition: avfilter.h:126
i
int i
Definition: input.c:407
internal.h
shuffleplanes_options
static const AVOption shuffleplanes_options[]
Definition: vf_shuffleplanes.c:137
common.h
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:60
AVFilter
Filter definition.
Definition: avfilter.h:145
ret
ret
Definition: filter_design.txt:187
pixfmt.h
frame
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 the filter must be ready for frames arriving randomly on any input any filter with several inputs will most likely require some kind of queuing mechanism It is perfectly acceptable to have a limited queue and to drop frames when the inputs are too unbalanced request_frame For filters that do not use the this method is called when a frame is wanted on an output For a it should directly call filter_frame on the corresponding output For a if there are queued frames already one of these frames should be pushed If the filter should request a frame on one of its repeatedly until at least one frame has been pushed Return or at least make progress towards producing a frame
Definition: filter_design.txt:264
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:225
avfilter.h
shuffleplanes_inputs
static const AVFilterPad shuffleplanes_inputs[]
Definition: vf_shuffleplanes.c:147
AVFilterContext
An instance of a filter.
Definition: avfilter.h:333
planes
static const struct @322 planes[]
desc
const char * desc
Definition: libsvtav1.c:79
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:70
map
const VDPAUPixFmtMap * map
Definition: hwcontext_vdpau.c:71
shuffleplanes_filter_frame
static int shuffleplanes_filter_frame(AVFilterLink *inlink, AVFrame *frame)
Definition: vf_shuffleplanes.c:94
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:561
avstring.h
FLAGS
#define FLAGS
Definition: vf_shuffleplanes.c:136
AV_PIX_FMT_FLAG_PAL
#define AV_PIX_FMT_FLAG_PAL
Pixel format has a palette in data[1], values are indexes in this palette.
Definition: pixdesc.h:121