FFmpeg
vf_elbg.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013 Stefano Sabatini
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  * video quantizer filter based on ELBG
24  */
25 
26 #include "libavcodec/elbg.h"
27 #include "libavutil/mem.h"
28 #include "libavutil/opt.h"
29 #include "libavutil/pixdesc.h"
30 #include "libavutil/random_seed.h"
31 
32 #include "avfilter.h"
33 #include "drawutils.h"
34 #include "filters.h"
35 #include "formats.h"
36 #include "video.h"
37 
38 typedef struct ELBGFilterContext {
39  const AVClass *class;
40  struct ELBGContext *ctx;
44  int *codeword;
47  int *codebook;
50  uint8_t rgba_map[4];
51  int use_alpha;
52  int pal8;
54 
55 #define OFFSET(x) offsetof(ELBGFilterContext, x)
56 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
57 
58 static const AVOption elbg_options[] = {
59  { "codebook_length", "set codebook length", OFFSET(codebook_length), AV_OPT_TYPE_INT, { .i64 = 256 }, 1, INT_MAX, FLAGS },
60  { "l", "set codebook length", OFFSET(codebook_length), AV_OPT_TYPE_INT, { .i64 = 256 }, 1, INT_MAX, FLAGS },
61  { "nb_steps", "set max number of steps used to compute the mapping", OFFSET(max_steps_nb), AV_OPT_TYPE_INT, { .i64 = 1 }, 1, INT_MAX, FLAGS },
62  { "n", "set max number of steps used to compute the mapping", OFFSET(max_steps_nb), AV_OPT_TYPE_INT, { .i64 = 1 }, 1, INT_MAX, FLAGS },
63  { "seed", "set the random seed", OFFSET(lfg_seed), AV_OPT_TYPE_INT64, {.i64 = -1}, -1, UINT32_MAX, FLAGS },
64  { "s", "set the random seed", OFFSET(lfg_seed), AV_OPT_TYPE_INT64, { .i64 = -1 }, -1, UINT32_MAX, FLAGS },
65  { "pal8", "set the pal8 output", OFFSET(pal8), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, FLAGS },
66  { "use_alpha", "use alpha channel for mapping", OFFSET(use_alpha), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, FLAGS },
67  { NULL }
68 };
69 
71 
73 {
74  ELBGFilterContext *const elbg = ctx->priv;
75 
76  if (elbg->pal8 && elbg->codebook_length > 256) {
77  av_log(ctx, AV_LOG_ERROR, "pal8 output allows max 256 codebook length.\n");
78  return AVERROR(EINVAL);
79  }
80 
81  if (elbg->lfg_seed == -1)
82  elbg->lfg_seed = av_get_random_seed();
83 
84  av_lfg_init(&elbg->lfg, elbg->lfg_seed);
85  return 0;
86 }
87 
88 static int query_formats(const AVFilterContext *ctx,
89  AVFilterFormatsConfig **cfg_in,
90  AVFilterFormatsConfig **cfg_out)
91 {
92  const ELBGFilterContext *const elbg = ctx->priv;
93  int ret;
94 
95  static const enum AVPixelFormat pix_fmts[] = {
99  };
100  if (!elbg->pal8) {
101  return ff_set_common_formats_from_list2(ctx, cfg_in, cfg_out, pix_fmts);
102  } else {
103  static const enum AVPixelFormat pal8_fmt[] = {
106  };
107  if ((ret = ff_formats_ref(ff_make_format_list(pix_fmts), &cfg_in[0]->formats)) < 0 ||
108  (ret = ff_formats_ref(ff_make_format_list(pal8_fmt), &cfg_out[0]->formats)) < 0)
109  return ret;
110  }
111  return 0;
112 }
113 
114 #define NB_COMPONENTS 4
115 
117 {
118  AVFilterContext *ctx = inlink->dst;
119  ELBGFilterContext *const elbg = ctx->priv;
120 
121  elbg->pix_desc = av_pix_fmt_desc_get(inlink->format);
122  elbg->codeword_length = inlink->w * inlink->h;
123  elbg->codeword = av_realloc_f(elbg->codeword, elbg->codeword_length,
124  NB_COMPONENTS * sizeof(*elbg->codeword));
125  if (!elbg->codeword)
126  return AVERROR(ENOMEM);
127 
130  sizeof(*elbg->codeword_closest_codebook_idxs));
132  return AVERROR(ENOMEM);
133 
134  elbg->codebook = av_realloc_f(elbg->codebook, elbg->codebook_length,
135  NB_COMPONENTS * sizeof(*elbg->codebook));
136  if (!elbg->codebook)
137  return AVERROR(ENOMEM);
138 
139  ff_fill_rgba_map(elbg->rgba_map, inlink->format);
140 
141  return 0;
142 }
143 
144 #define R 0
145 #define G 1
146 #define B 2
147 #define A 3
148 
150 {
151  ELBGFilterContext *const elbg = inlink->dst->priv;
152  int i, j, k, ret;
153  uint8_t *p, *p0;
154 
155  const uint8_t r_idx = elbg->rgba_map[R];
156  const uint8_t g_idx = elbg->rgba_map[G];
157  const uint8_t b_idx = elbg->rgba_map[B];
158  const uint8_t a_idx = elbg->rgba_map[A];
159 
160  /* build the codeword */
161  p0 = frame->data[0];
162  k = 0;
163  for (i = 0; i < inlink->h; i++) {
164  p = p0;
165  for (j = 0; j < inlink->w; j++) {
166  elbg->codeword[k++] = p[b_idx];
167  elbg->codeword[k++] = p[g_idx];
168  elbg->codeword[k++] = p[r_idx];
169  elbg->codeword[k++] = elbg->use_alpha ? p[a_idx] : 0xff;
170  p += elbg->pix_desc->nb_components;
171  }
172  p0 += frame->linesize[0];
173  }
174 
175  /* compute the codebook */
176  ret = avpriv_elbg_do(&elbg->ctx, elbg->codeword, NB_COMPONENTS,
177  elbg->codeword_length, elbg->codebook,
178  elbg->codebook_length, elbg->max_steps_nb,
179  elbg->codeword_closest_codebook_idxs, &elbg->lfg, 0);
180  if (ret < 0) {
182  return ret;
183  }
184 
185  if (elbg->pal8) {
186  AVFilterLink *outlink = inlink->dst->outputs[0];
187  AVFrame *out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
188  uint32_t *pal;
189 
190  if (!out) {
192  return AVERROR(ENOMEM);
193  }
196  pal = (uint32_t *)out->data[1];
197  p0 = (uint8_t *)out->data[0];
198 
199  for (i = 0; i < elbg->codebook_length; i++) {
200  const unsigned al = elbg->use_alpha ? elbg->codebook[i*4+3] : 0xff;
201  pal[i] = al << 24 |
202  (elbg->codebook[i*4+2] << 16) |
203  (elbg->codebook[i*4+1] << 8) |
204  elbg->codebook[i*4 ];
205  }
206 
207  k = 0;
208  for (i = 0; i < inlink->h; i++) {
209  p = p0;
210  for (j = 0; j < inlink->w; j++, p++) {
211  p[0] = elbg->codeword_closest_codebook_idxs[k++];
212  }
213  p0 += out->linesize[0];
214  }
215 
216  return ff_filter_frame(outlink, out);
217  }
218 
219  /* fill the output with the codebook values */
220  p0 = frame->data[0];
221 
222  k = 0;
223  for (i = 0; i < inlink->h; i++) {
224  p = p0;
225  for (j = 0; j < inlink->w; j++) {
226  int cb_idx = NB_COMPONENTS * elbg->codeword_closest_codebook_idxs[k++];
227  p[b_idx] = elbg->codebook[cb_idx];
228  p[g_idx] = elbg->codebook[cb_idx+1];
229  p[r_idx] = elbg->codebook[cb_idx+2];
230  p[a_idx] = elbg->use_alpha ? elbg->codebook[cb_idx+3] : 0xFFu;
231  p += elbg->pix_desc->nb_components;
232  }
233  p0 += frame->linesize[0];
234  }
235 
236  return ff_filter_frame(inlink->dst->outputs[0], frame);
237 }
238 
240 {
241  ELBGFilterContext *const elbg = ctx->priv;
242 
243  avpriv_elbg_free(&elbg->ctx);
244 
245  av_freep(&elbg->codebook);
246  av_freep(&elbg->codeword);
248 }
249 
250 static const AVFilterPad elbg_inputs[] = {
251  {
252  .name = "default",
253  .type = AVMEDIA_TYPE_VIDEO,
255  .config_props = config_input,
256  .filter_frame = filter_frame,
257  },
258 };
259 
261  .name = "elbg",
262  .description = NULL_IF_CONFIG_SMALL("Apply posterize effect, using the ELBG algorithm."),
263  .priv_size = sizeof(ELBGFilterContext),
264  .priv_class = &elbg_class,
265  .init = init,
266  .uninit = uninit,
270 };
formats
formats
Definition: signature.h:47
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:116
OFFSET
#define OFFSET(x)
Definition: vf_elbg.c:55
AVPixelFormat
AVPixelFormat
Pixel format.
Definition: pixfmt.h:71
ELBGFilterContext::codeword_closest_codebook_idxs
int * codeword_closest_codebook_idxs
Definition: vf_elbg.c:46
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_make_format_list
AVFilterFormats * ff_make_format_list(const int *fmts)
Create a list of supported formats.
Definition: formats.c:435
out
FILE * out
Definition: movenc.c:55
av_lfg_init
av_cold void av_lfg_init(AVLFG *c, unsigned int seed)
Definition: lfg.c:32
u
#define u(width, name, range_min, range_max)
Definition: cbs_h2645.c:251
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1061
av_pix_fmt_desc_get
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:3170
ELBGFilterContext::lfg_seed
int64_t lfg_seed
Definition: vf_elbg.c:42
ELBGFilterContext::lfg
AVLFG lfg
Definition: vf_elbg.c:41
int64_t
long long int64_t
Definition: coverity.c:34
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
A
#define A
Definition: vf_elbg.c:147
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:162
FILTER_INPUTS
#define FILTER_INPUTS(array)
Definition: filters.h:262
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:389
pixdesc.h
AVOption
AVOption.
Definition: opt.h:429
AV_PIX_FMT_BGR24
@ AV_PIX_FMT_BGR24
packed RGB 8:8:8, 24bpp, BGRBGR...
Definition: pixfmt.h:76
AV_PIX_FMT_BGRA
@ AV_PIX_FMT_BGRA
packed BGRA 8:8:8:8, 32bpp, BGRABGRA...
Definition: pixfmt.h:102
G
#define G
Definition: vf_elbg.c:145
ELBGFilterContext::codeword_length
int codeword_length
Definition: vf_elbg.c:45
ELBGFilterContext::pix_desc
const AVPixFmtDescriptor * pix_desc
Definition: vf_elbg.c:49
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:205
video.h
ELBGFilterContext::rgba_map
uint8_t rgba_map[4]
Definition: vf_elbg.c:50
av_get_random_seed
uint32_t av_get_random_seed(void)
Get a seed to use in conjunction with random functions.
Definition: random_seed.c:167
formats.h
query_formats
static int query_formats(const AVFilterContext *ctx, AVFilterFormatsConfig **cfg_in, AVFilterFormatsConfig **cfg_out)
Definition: vf_elbg.c:88
elbg_inputs
static const AVFilterPad elbg_inputs[]
Definition: vf_elbg.c:250
ELBGFilterContext::use_alpha
int use_alpha
Definition: vf_elbg.c:51
AVFilterPad
A filter pad used for either input or output.
Definition: filters.h:38
avpriv_elbg_do
int avpriv_elbg_do(ELBGContext **elbgp, int *points, int dim, int numpoints, int *codebook, int num_cb, int max_steps, int *closest_cb, AVLFG *rand_state, uintptr_t flags)
Implementation of the Enhanced LBG Algorithm Based on the paper "Neural Networks 14:1219-1237" that c...
Definition: elbg.c:463
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:209
av_cold
#define av_cold
Definition: attributes.h:90
ff_video_default_filterpad
const AVFilterPad ff_video_default_filterpad[1]
An AVFilterPad array whose only entry has name "default" and is of type AVMEDIA_TYPE_VIDEO.
Definition: video.c:37
ff_vf_elbg
const AVFilter ff_vf_elbg
Definition: vf_elbg.c:260
ELBGFilterContext::codebook
int * codebook
Definition: vf_elbg.c:47
ff_formats_ref
int ff_formats_ref(AVFilterFormats *f, AVFilterFormats **ref)
Add *ref as a new reference to formats.
Definition: formats.c:678
AV_OPT_TYPE_INT64
@ AV_OPT_TYPE_INT64
Underlying C type is int64_t.
Definition: opt.h:263
filters.h
pix_fmts
static enum AVPixelFormat pix_fmts[]
Definition: libkvazaar.c:304
ctx
AVFormatContext * ctx
Definition: movenc.c:49
FILTER_OUTPUTS
#define FILTER_OUTPUTS(array)
Definition: filters.h:263
AV_PIX_FMT_RGBA
@ AV_PIX_FMT_RGBA
packed RGBA 8:8:8:8, 32bpp, RGBARGBA...
Definition: pixfmt.h:100
init
static av_cold int init(AVFilterContext *ctx)
Definition: vf_elbg.c:72
elbg.h
av_realloc_f
#define av_realloc_f(p, o, n)
Definition: tableprint_vlc.h:32
ELBGFilterContext::ctx
struct ELBGContext * ctx
Definition: vf_elbg.c:40
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:75
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:725
AVPixFmtDescriptor::nb_components
uint8_t nb_components
The number of components each pixel has, (1-4)
Definition: pixdesc.h:71
AV_PIX_FMT_ABGR
@ AV_PIX_FMT_ABGR
packed ABGR 8:8:8:8, 32bpp, ABGRABGR...
Definition: pixfmt.h:101
AVFilterFormatsConfig
Lists of formats / etc.
Definition: avfilter.h:111
AVFILTERPAD_FLAG_NEEDS_WRITABLE
#define AVFILTERPAD_FLAG_NEEDS_WRITABLE
The filter expects writable frames from its input link, duplicating data buffers if needed.
Definition: filters.h:57
AVLFG
Context structure for the Lagged Fibonacci PRNG.
Definition: lfg.h:33
AV_PIX_FMT_RGB24
@ AV_PIX_FMT_RGB24
packed RGB 8:8:8, 24bpp, RGBRGB...
Definition: pixfmt.h:75
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:94
avpriv_elbg_free
av_cold void avpriv_elbg_free(ELBGContext **elbgp)
Free an ELBGContext and reset the pointer to it.
Definition: elbg.c:516
ELBGFilterContext::max_steps_nb
int max_steps_nb
Definition: vf_elbg.c:43
B
#define B
Definition: vf_elbg.c:146
NB_COMPONENTS
#define NB_COMPONENTS
Definition: vf_elbg.c:114
filter_frame
static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
Definition: vf_elbg.c:149
elbg_options
static const AVOption elbg_options[]
Definition: vf_elbg.c:58
AV_PIX_FMT_ARGB
@ AV_PIX_FMT_ARGB
packed ARGB 8:8:8:8, 32bpp, ARGBARGB...
Definition: pixfmt.h:99
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:256
ELBGContext
ELBG internal data.
Definition: elbg.c:47
FILTER_QUERY_FUNC2
#define FILTER_QUERY_FUNC2(func)
Definition: filters.h:239
AVFilterPad::name
const char * name
Pad name.
Definition: filters.h:44
AVFilter
Filter definition.
Definition: avfilter.h:201
AV_PIX_FMT_PAL8
@ AV_PIX_FMT_PAL8
8 bits with AV_PIX_FMT_RGB32 palette
Definition: pixfmt.h:84
ELBGFilterContext
Definition: vf_elbg.c:38
ret
ret
Definition: filter_design.txt:187
R
#define R
Definition: vf_elbg.c:144
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
FLAGS
#define FLAGS
Definition: vf_elbg.c:56
ELBGFilterContext::codebook_length
int codebook_length
Definition: vf_elbg.c:48
random_seed.h
ff_set_common_formats_from_list2
int ff_set_common_formats_from_list2(const AVFilterContext *ctx, AVFilterFormatsConfig **cfg_in, AVFilterFormatsConfig **cfg_out, const int *fmts)
Definition: formats.c:1016
AV_PIX_FMT_NONE
@ AV_PIX_FMT_NONE
Definition: pixfmt.h:72
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Underlying C type is int.
Definition: opt.h:259
avfilter.h
AVFilterContext
An instance of a filter.
Definition: avfilter.h:457
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: vf_elbg.c:239
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(elbg)
mem.h
AVPixFmtDescriptor
Descriptor that unambiguously describes how the bits of a pixel are stored in the up to 4 data planes...
Definition: pixdesc.h:69
config_input
static int config_input(AVFilterLink *inlink)
Definition: vf_elbg.c:116
AV_OPT_TYPE_BOOL
@ AV_OPT_TYPE_BOOL
Underlying C type is int.
Definition: opt.h:327
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:34
ff_fill_rgba_map
int ff_fill_rgba_map(uint8_t *rgba_map, enum AVPixelFormat pix_fmt)
Definition: drawutils.c:79
ELBGFilterContext::codeword
int * codeword
Definition: vf_elbg.c:44
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
ELBGFilterContext::pal8
int pal8
Definition: vf_elbg.c:52
drawutils.h