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 {
45  AVFilterContext *ctx = inlink->dst;
46  ShufflePlanesContext *s = ctx->priv;
47  const AVPixFmtDescriptor *desc;
48  int used[4] = { 0 };
49  int i;
50 
51  s->copy = 0;
52  s->planes = av_pix_fmt_count_planes(inlink->format);
53  desc = av_pix_fmt_desc_get(inlink->format);
54 
55  for (i = 0; i < s->planes; i++) {
56  if (s->map[i] >= s->planes) {
58  "Non-existing input plane #%d mapped to output plane #%d.\n",
59  s->map[i], i);
60  return AVERROR(EINVAL);
61  }
62 
63  if ((desc->log2_chroma_h || desc->log2_chroma_w) &&
64  (i == 1 || i == 2) != (s->map[i] == 1 || s->map[i] == 2)) {
66  "Cannot map between a subsampled chroma plane and a luma "
67  "or alpha plane.\n");
68  return AVERROR(EINVAL);
69  }
70 
71  if ((desc->flags & AV_PIX_FMT_FLAG_PAL ||
72  desc->flags & FF_PSEUDOPAL) &&
73  (i == 1) != (s->map[i] == 1)) {
75  "Cannot map between a palette plane and a data plane.\n");
76  return AVERROR(EINVAL);
77  }
78  if (used[s->map[i]])
79  s->copy = 1;
80  used[s->map[i]]++;
81  }
82 
83  return 0;
84 }
85 
87 {
88  AVFilterContext *ctx = inlink->dst;
89  ShufflePlanesContext *s = ctx->priv;
90  uint8_t *shuffled_data[4] = { NULL };
91  int shuffled_linesize[4] = { 0 };
92  int i, ret;
93 
94  for (i = 0; i < s->planes; i++) {
95  shuffled_data[i] = frame->data[s->map[i]];
96  shuffled_linesize[i] = frame->linesize[s->map[i]];
97  }
98  memcpy(frame->data, shuffled_data, sizeof(shuffled_data));
99  memcpy(frame->linesize, shuffled_linesize, sizeof(shuffled_linesize));
100 
101  if (s->copy) {
102  AVFrame *copy = ff_get_video_buffer(ctx->outputs[0], frame->width, frame->height);
103 
104  if (!copy) {
105  ret = AVERROR(ENOMEM);
106  goto fail;
107  }
108 
110 
112  if (ret < 0) {
114  goto fail;
115  }
116 
118  frame = copy;
119  }
120 
121  return ff_filter_frame(ctx->outputs[0], frame);
122 fail:
124  return ret;
125 }
126 
127 #define OFFSET(x) offsetof(ShufflePlanesContext, x)
128 #define FLAGS (AV_OPT_FLAG_FILTERING_PARAM | AV_OPT_FLAG_VIDEO_PARAM)
129 static const AVOption shuffleplanes_options[] = {
130  { "map0", "Index of the input plane to be used as the first output plane ", OFFSET(map[0]), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 4, FLAGS },
131  { "map1", "Index of the input plane to be used as the second output plane ", OFFSET(map[1]), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 4, FLAGS },
132  { "map2", "Index of the input plane to be used as the third output plane ", OFFSET(map[2]), AV_OPT_TYPE_INT, { .i64 = 2 }, 0, 4, FLAGS },
133  { "map3", "Index of the input plane to be used as the fourth output plane ", OFFSET(map[3]), AV_OPT_TYPE_INT, { .i64 = 3 }, 0, 4, FLAGS },
134  { NULL },
135 };
136 
137 AVFILTER_DEFINE_CLASS(shuffleplanes);
138 
140  {
141  .name = "default",
142  .type = AVMEDIA_TYPE_VIDEO,
143  .config_props = shuffleplanes_config_input,
144  .filter_frame = shuffleplanes_filter_frame,
145  .get_video_buffer = ff_null_get_video_buffer,
146  },
147  { NULL },
148 };
149 
151  {
152  .name = "default",
153  .type = AVMEDIA_TYPE_VIDEO,
154  },
155  { NULL },
156 };
157 
159  .name = "shuffleplanes",
160  .description = NULL_IF_CONFIG_SMALL("Shuffle video planes."),
161  .priv_size = sizeof(ShufflePlanesContext),
162  .priv_class = &shuffleplanes_class,
166 };
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:1080
av_pix_fmt_desc_get
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2522
ff_vf_shuffleplanes
AVFilter ff_vf_shuffleplanes
Definition: vf_shuffleplanes.c:158
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:202
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:295
pixdesc.h
AVOption
AVOption.
Definition: opt.h:246
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:148
ShufflePlanesContext::copy
int copy
Definition: vf_shuffleplanes.c:40
video.h
ShufflePlanesContext
Definition: vf_shuffleplanes.c:30
av_pix_fmt_count_planes
int av_pix_fmt_count_planes(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2562
shuffleplanes_config_input
static av_cold int shuffleplanes_config_input(AVFilterLink *inlink)
Definition: vf_shuffleplanes.c:43
fail
#define fail()
Definition: checkasm.h:120
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_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
av_cold
#define av_cold
Definition: attributes.h:84
shuffleplanes_outputs
static const AVFilterPad shuffleplanes_outputs[]
Definition: vf_shuffleplanes.c:150
s
#define s(width, name)
Definition: cbs_vp9.c:257
outputs
static const AVFilterPad outputs[]
Definition: af_acontrast.c:203
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:654
OFFSET
#define OFFSET(x)
Definition: vf_shuffleplanes.c:127
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
desc
const char * desc
Definition: nvenc.c:68
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:188
copy
static void copy(const float *p1, float *p2, const int length)
Definition: vf_vaguedenoiser.c:185
av_frame_copy
int av_frame_copy(AVFrame *dst, const AVFrame *src)
Copy the frame data from src to dst.
Definition: frame.c:792
ShufflePlanesContext::planes
int planes
Definition: vf_shuffleplanes.c:34
ff_null_get_video_buffer
AVFrame * ff_null_get_video_buffer(AVFilterLink *link, int w, int h)
Definition: video.c:39
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:125
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:259
internal.h
shuffleplanes_options
static const AVOption shuffleplanes_options[]
Definition: vf_shuffleplanes.c:129
common.h
uint8_t
uint8_t
Definition: audio_convert.c:194
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:60
AVFilter
Filter definition.
Definition: avfilter.h:144
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:223
avfilter.h
shuffleplanes_inputs
static const AVFilterPad shuffleplanes_inputs[]
Definition: vf_shuffleplanes.c:139
AVFilterContext
An instance of a filter.
Definition: avfilter.h:338
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:81
map
const VDPAUPixFmtMap * map
Definition: hwcontext_vdpau.c:85
shuffleplanes_filter_frame
static int shuffleplanes_filter_frame(AVFilterLink *inlink, AVFrame *frame)
Definition: vf_shuffleplanes.c:86
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:565
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:28
FF_PSEUDOPAL
#define FF_PSEUDOPAL
Definition: internal.h:369
avstring.h
FLAGS
#define FLAGS
Definition: vf_shuffleplanes.c:128
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:132