2 * Copyright (c) 2015 Stupeflix
4 * This file is part of FFmpeg.
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.
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.
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
23 * Use a palette to downsample an input video stream.
26 #include "libavutil/bprint.h"
27 #include "libavutil/internal.h"
28 #include "libavutil/opt.h"
29 #include "libavutil/qsort.h"
32 #include "framesync.h"
39 DITHERING_FLOYD_STEINBERG,
45 enum color_search_method {
46 COLOR_SEARCH_NNS_ITERATIVE,
47 COLOR_SEARCH_NNS_RECURSIVE,
48 COLOR_SEARCH_BRUTEFORCE,
62 int left_id, right_id;
66 #define CACHE_SIZE (1<<(3*NBITS))
74 struct cached_color *entries;
78 struct PaletteUseContext;
80 typedef int (*set_frame_func)(struct PaletteUseContext *s, AVFrame *out, AVFrame *in,
81 int x_start, int y_start, int width, int height);
83 typedef struct PaletteUseContext {
86 struct cache_node cache[CACHE_SIZE]; /* lookup cache */
87 struct color_node map[AVPALETTE_COUNT]; /* 3D-Tree (KD-Tree with K=3) for reverse colormap */
88 uint32_t palette[AVPALETTE_COUNT];
92 set_frame_func set_frame;
94 int ordered_dither[8*8];
101 int color_search_method;
103 uint64_t total_mean_err;
107 #define OFFSET(x) offsetof(PaletteUseContext, x)
108 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
109 static const AVOption paletteuse_options[] = {
110 { "dither", "select dithering mode", OFFSET(dither), AV_OPT_TYPE_INT, {.i64=DITHERING_SIERRA2_4A}, 0, NB_DITHERING-1, FLAGS, "dithering_mode" },
111 { "bayer", "ordered 8x8 bayer dithering (deterministic)", 0, AV_OPT_TYPE_CONST, {.i64=DITHERING_BAYER}, INT_MIN, INT_MAX, FLAGS, "dithering_mode" },
112 { "heckbert", "dithering as defined by Paul Heckbert in 1982 (simple error diffusion)", 0, AV_OPT_TYPE_CONST, {.i64=DITHERING_HECKBERT}, INT_MIN, INT_MAX, FLAGS, "dithering_mode" },
113 { "floyd_steinberg", "Floyd and Steingberg dithering (error diffusion)", 0, AV_OPT_TYPE_CONST, {.i64=DITHERING_FLOYD_STEINBERG}, INT_MIN, INT_MAX, FLAGS, "dithering_mode" },
114 { "sierra2", "Frankie Sierra dithering v2 (error diffusion)", 0, AV_OPT_TYPE_CONST, {.i64=DITHERING_SIERRA2}, INT_MIN, INT_MAX, FLAGS, "dithering_mode" },
115 { "sierra2_4a", "Frankie Sierra dithering v2 \"Lite\" (error diffusion)", 0, AV_OPT_TYPE_CONST, {.i64=DITHERING_SIERRA2_4A}, INT_MIN, INT_MAX, FLAGS, "dithering_mode" },
116 { "bayer_scale", "set scale for bayer dithering", OFFSET(bayer_scale), AV_OPT_TYPE_INT, {.i64=2}, 0, 5, FLAGS },
117 { "diff_mode", "set frame difference mode", OFFSET(diff_mode), AV_OPT_TYPE_INT, {.i64=DIFF_MODE_NONE}, 0, NB_DIFF_MODE-1, FLAGS, "diff_mode" },
118 { "rectangle", "process smallest different rectangle", 0, AV_OPT_TYPE_CONST, {.i64=DIFF_MODE_RECTANGLE}, INT_MIN, INT_MAX, FLAGS, "diff_mode" },
120 /* following are the debug options, not part of the official API */
121 { "debug_kdtree", "save Graphviz graph of the kdtree in specified file", OFFSET(dot_filename), AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX, FLAGS },
122 { "color_search", "set reverse colormap color search method", OFFSET(color_search_method), AV_OPT_TYPE_INT, {.i64=COLOR_SEARCH_NNS_ITERATIVE}, 0, NB_COLOR_SEARCHES-1, FLAGS, "search" },
123 { "nns_iterative", "iterative search", 0, AV_OPT_TYPE_CONST, {.i64=COLOR_SEARCH_NNS_ITERATIVE}, INT_MIN, INT_MAX, FLAGS, "search" },
124 { "nns_recursive", "recursive search", 0, AV_OPT_TYPE_CONST, {.i64=COLOR_SEARCH_NNS_RECURSIVE}, INT_MIN, INT_MAX, FLAGS, "search" },
125 { "bruteforce", "brute-force into the palette", 0, AV_OPT_TYPE_CONST, {.i64=COLOR_SEARCH_BRUTEFORCE}, INT_MIN, INT_MAX, FLAGS, "search" },
126 { "mean_err", "compute and print mean error", OFFSET(calc_mean_err), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, FLAGS },
127 { "debug_accuracy", "test color search accuracy", OFFSET(debug_accuracy), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, FLAGS },
128 { "new", "take new palette for each output frame", OFFSET(new), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, FLAGS },
132 AVFILTER_DEFINE_CLASS(paletteuse);
134 static int load_apply_palette(FFFrameSync *fs);
136 static int query_formats(AVFilterContext *ctx)
138 static const enum AVPixelFormat in_fmts[] = {AV_PIX_FMT_RGB32, AV_PIX_FMT_NONE};
139 static const enum AVPixelFormat inpal_fmts[] = {AV_PIX_FMT_RGB32, AV_PIX_FMT_NONE};
140 static const enum AVPixelFormat out_fmts[] = {AV_PIX_FMT_PAL8, AV_PIX_FMT_NONE};
142 AVFilterFormats *in = ff_make_format_list(in_fmts);
143 AVFilterFormats *inpal = ff_make_format_list(inpal_fmts);
144 AVFilterFormats *out = ff_make_format_list(out_fmts);
145 if (!in || !inpal || !out) {
149 return AVERROR(ENOMEM);
151 if ((ret = ff_formats_ref(in , &ctx->inputs[0]->out_formats)) < 0 ||
152 (ret = ff_formats_ref(inpal, &ctx->inputs[1]->out_formats)) < 0 ||
153 (ret = ff_formats_ref(out , &ctx->outputs[0]->in_formats)) < 0)
158 static av_always_inline int dither_color(uint32_t px, int er, int eg, int eb, int scale, int shift)
160 return av_clip_uint8((px >> 16 & 0xff) + ((er * scale) / (1<<shift))) << 16
161 | av_clip_uint8((px >> 8 & 0xff) + ((eg * scale) / (1<<shift))) << 8
162 | av_clip_uint8((px & 0xff) + ((eb * scale) / (1<<shift)));
165 static av_always_inline int diff(const uint8_t *c1, const uint8_t *c2)
167 // XXX: try L*a*b with CIE76 (dL*dL + da*da + db*db)
168 const int dr = c1[0] - c2[0];
169 const int dg = c1[1] - c2[1];
170 const int db = c1[2] - c2[2];
171 return dr*dr + dg*dg + db*db;
174 static av_always_inline uint8_t colormap_nearest_bruteforce(const uint32_t *palette, const uint8_t *rgb)
176 int i, pal_id = -1, min_dist = INT_MAX;
178 for (i = 0; i < AVPALETTE_COUNT; i++) {
179 const uint32_t c = palette[i];
181 if ((c & 0xff000000) == 0xff000000) { // ignore transparent entry
182 const uint8_t palrgb[] = {
183 palette[i]>>16 & 0xff,
184 palette[i]>> 8 & 0xff,
187 const int d = diff(palrgb, rgb);
197 /* Recursive form, simpler but a bit slower. Kept for reference. */
198 struct nearest_color {
203 static void colormap_nearest_node(const struct color_node *map,
205 const uint8_t *target,
206 struct nearest_color *nearest)
208 const struct color_node *kd = map + node_pos;
209 const int s = kd->split;
210 int dx, nearer_kd_id, further_kd_id;
211 const uint8_t *current = kd->val;
212 const int current_to_target = diff(target, current);
214 if (current_to_target < nearest->dist_sqd) {
215 nearest->node_pos = node_pos;
216 nearest->dist_sqd = current_to_target;
219 if (kd->left_id != -1 || kd->right_id != -1) {
220 dx = target[s] - current[s];
222 if (dx <= 0) nearer_kd_id = kd->left_id, further_kd_id = kd->right_id;
223 else nearer_kd_id = kd->right_id, further_kd_id = kd->left_id;
225 if (nearer_kd_id != -1)
226 colormap_nearest_node(map, nearer_kd_id, target, nearest);
228 if (further_kd_id != -1 && dx*dx < nearest->dist_sqd)
229 colormap_nearest_node(map, further_kd_id, target, nearest);
233 static av_always_inline uint8_t colormap_nearest_recursive(const struct color_node *node, const uint8_t *rgb)
235 struct nearest_color res = {.dist_sqd = INT_MAX, .node_pos = -1};
236 colormap_nearest_node(node, 0, rgb, &res);
237 return node[res.node_pos].palette_id;
245 static av_always_inline uint8_t colormap_nearest_iterative(const struct color_node *root, const uint8_t *target)
247 int pos = 0, best_node_id = -1, best_dist = INT_MAX, cur_color_id = 0;
248 struct stack_node nodes[16];
249 struct stack_node *node = &nodes[0];
253 const struct color_node *kd = &root[cur_color_id];
254 const uint8_t *current = kd->val;
255 const int current_to_target = diff(target, current);
257 /* Compare current color node to the target and update our best node if
258 * it's actually better. */
259 if (current_to_target < best_dist) {
260 best_node_id = cur_color_id;
261 if (!current_to_target)
262 goto end; // exact match, we can return immediately
263 best_dist = current_to_target;
266 /* Check if it's not a leaf */
267 if (kd->left_id != -1 || kd->right_id != -1) {
268 const int split = kd->split;
269 const int dx = target[split] - current[split];
270 int nearer_kd_id, further_kd_id;
272 /* Define which side is the most interesting. */
273 if (dx <= 0) nearer_kd_id = kd->left_id, further_kd_id = kd->right_id;
274 else nearer_kd_id = kd->right_id, further_kd_id = kd->left_id;
276 if (nearer_kd_id != -1) {
277 if (further_kd_id != -1) {
278 /* Here, both paths are defined, so we push a state for
279 * when we are going back. */
280 node->color_id = further_kd_id;
285 /* We can now update current color with the most probable path
286 * (no need to create a state since there is nothing to save
288 cur_color_id = nearer_kd_id;
290 } else if (dx*dx < best_dist) {
291 /* The nearest path isn't available, so there is only one path
292 * possible and it's the least probable. We enter it only if the
293 * distance from the current point to the hyper rectangle is
294 * less than our best distance. */
295 cur_color_id = further_kd_id;
300 /* Unstack as much as we can, typically as long as the least probable
301 * branch aren't actually probable. */
306 } while (node->dx2 >= best_dist);
308 /* We got a node where the least probable branch might actually contain
309 * a relevant color. */
310 cur_color_id = node->color_id;
314 return root[best_node_id].palette_id;
317 #define COLORMAP_NEAREST(search, palette, root, target) \
318 search == COLOR_SEARCH_NNS_ITERATIVE ? colormap_nearest_iterative(root, target) : \
319 search == COLOR_SEARCH_NNS_RECURSIVE ? colormap_nearest_recursive(root, target) : \
320 colormap_nearest_bruteforce(palette, target)
323 * Check if the requested color is in the cache already. If not, find it in the
324 * color tree and cache it.
325 * Note: r, g, and b are the component of c but are passed as well to avoid
326 * recomputing them (they are generally computed by the caller for other uses).
328 static av_always_inline int color_get(struct cache_node *cache, uint32_t color,
329 uint8_t r, uint8_t g, uint8_t b,
330 const struct color_node *map,
331 const uint32_t *palette,
332 const enum color_search_method search_method)
335 const uint8_t rgb[] = {r, g, b};
336 const uint8_t rhash = r & ((1<<NBITS)-1);
337 const uint8_t ghash = g & ((1<<NBITS)-1);
338 const uint8_t bhash = b & ((1<<NBITS)-1);
339 const unsigned hash = rhash<<(NBITS*2) | ghash<<NBITS | bhash;
340 struct cache_node *node = &cache[hash];
341 struct cached_color *e;
343 for (i = 0; i < node->nb_entries; i++) {
344 e = &node->entries[i];
345 if (e->color == color)
349 e = av_dynarray2_add((void**)&node->entries, &node->nb_entries,
350 sizeof(*node->entries), NULL);
352 return AVERROR(ENOMEM);
354 e->pal_entry = COLORMAP_NEAREST(search_method, palette, map, rgb);
358 static av_always_inline int get_dst_color_err(struct cache_node *cache,
359 uint32_t c, const struct color_node *map,
360 const uint32_t *palette,
361 int *er, int *eg, int *eb,
362 const enum color_search_method search_method)
364 const uint8_t r = c >> 16 & 0xff;
365 const uint8_t g = c >> 8 & 0xff;
366 const uint8_t b = c & 0xff;
367 const int dstx = color_get(cache, c, r, g, b, map, palette, search_method);
368 const uint32_t dstc = palette[dstx];
369 *er = r - (dstc >> 16 & 0xff);
370 *eg = g - (dstc >> 8 & 0xff);
371 *eb = b - (dstc & 0xff);
375 static av_always_inline int set_frame(PaletteUseContext *s, AVFrame *out, AVFrame *in,
376 int x_start, int y_start, int w, int h,
377 enum dithering_mode dither,
378 const enum color_search_method search_method)
381 const struct color_node *map = s->map;
382 struct cache_node *cache = s->cache;
383 const uint32_t *palette = s->palette;
384 const int src_linesize = in ->linesize[0] >> 2;
385 const int dst_linesize = out->linesize[0];
386 uint32_t *src = ((uint32_t *)in ->data[0]) + y_start*src_linesize;
387 uint8_t *dst = out->data[0] + y_start*dst_linesize;
392 for (y = y_start; y < h; y++) {
393 for (x = x_start; x < w; x++) {
396 if (dither == DITHERING_BAYER) {
397 const int d = s->ordered_dither[(y & 7)<<3 | (x & 7)];
398 const uint8_t r8 = src[x] >> 16 & 0xff;
399 const uint8_t g8 = src[x] >> 8 & 0xff;
400 const uint8_t b8 = src[x] & 0xff;
401 const uint8_t r = av_clip_uint8(r8 + d);
402 const uint8_t g = av_clip_uint8(g8 + d);
403 const uint8_t b = av_clip_uint8(b8 + d);
404 const uint32_t c = r<<16 | g<<8 | b;
405 const int color = color_get(cache, c, r, g, b, map, palette, search_method);
411 } else if (dither == DITHERING_HECKBERT) {
412 const int right = x < w - 1, down = y < h - 1;
413 const int color = get_dst_color_err(cache, src[x], map, palette, &er, &eg, &eb, search_method);
419 if (right) src[ x + 1] = dither_color(src[ x + 1], er, eg, eb, 3, 3);
420 if ( down) src[src_linesize + x ] = dither_color(src[src_linesize + x ], er, eg, eb, 3, 3);
421 if (right && down) src[src_linesize + x + 1] = dither_color(src[src_linesize + x + 1], er, eg, eb, 2, 3);
423 } else if (dither == DITHERING_FLOYD_STEINBERG) {
424 const int right = x < w - 1, down = y < h - 1, left = x > x_start;
425 const int color = get_dst_color_err(cache, src[x], map, palette, &er, &eg, &eb, search_method);
431 if (right) src[ x + 1] = dither_color(src[ x + 1], er, eg, eb, 7, 4);
432 if (left && down) src[src_linesize + x - 1] = dither_color(src[src_linesize + x - 1], er, eg, eb, 3, 4);
433 if ( down) src[src_linesize + x ] = dither_color(src[src_linesize + x ], er, eg, eb, 5, 4);
434 if (right && down) src[src_linesize + x + 1] = dither_color(src[src_linesize + x + 1], er, eg, eb, 1, 4);
436 } else if (dither == DITHERING_SIERRA2) {
437 const int right = x < w - 1, down = y < h - 1, left = x > x_start;
438 const int right2 = x < w - 2, left2 = x > x_start + 1;
439 const int color = get_dst_color_err(cache, src[x], map, palette, &er, &eg, &eb, search_method);
445 if (right) src[ x + 1] = dither_color(src[ x + 1], er, eg, eb, 4, 4);
446 if (right2) src[ x + 2] = dither_color(src[ x + 2], er, eg, eb, 3, 4);
449 if (left2) src[ src_linesize + x - 2] = dither_color(src[ src_linesize + x - 2], er, eg, eb, 1, 4);
450 if (left) src[ src_linesize + x - 1] = dither_color(src[ src_linesize + x - 1], er, eg, eb, 2, 4);
451 if (1) src[ src_linesize + x ] = dither_color(src[ src_linesize + x ], er, eg, eb, 3, 4);
452 if (right) src[ src_linesize + x + 1] = dither_color(src[ src_linesize + x + 1], er, eg, eb, 2, 4);
453 if (right2) src[ src_linesize + x + 2] = dither_color(src[ src_linesize + x + 2], er, eg, eb, 1, 4);
456 } else if (dither == DITHERING_SIERRA2_4A) {
457 const int right = x < w - 1, down = y < h - 1, left = x > x_start;
458 const int color = get_dst_color_err(cache, src[x], map, palette, &er, &eg, &eb, search_method);
464 if (right) src[ x + 1] = dither_color(src[ x + 1], er, eg, eb, 2, 2);
465 if (left && down) src[src_linesize + x - 1] = dither_color(src[src_linesize + x - 1], er, eg, eb, 1, 2);
466 if ( down) src[src_linesize + x ] = dither_color(src[src_linesize + x ], er, eg, eb, 1, 2);
469 const uint8_t r = src[x] >> 16 & 0xff;
470 const uint8_t g = src[x] >> 8 & 0xff;
471 const uint8_t b = src[x] & 0xff;
472 const int color = color_get(cache, src[x] & 0xffffff, r, g, b, map, palette, search_method);
486 static void disp_node(AVBPrint *buf,
487 const struct color_node *map,
488 int parent_id, int node_id,
491 const struct color_node *node = &map[node_id];
492 const uint32_t fontcolor = node->val[0] > 0x50 &&
493 node->val[1] > 0x50 &&
494 node->val[2] > 0x50 ? 0 : 0xffffff;
495 av_bprintf(buf, "%*cnode%d ["
496 "label=\"%c%02X%c%02X%c%02X%c\" "
497 "fillcolor=\"#%02x%02x%02x\" "
498 "fontcolor=\"#%06"PRIX32"\"]\n",
499 depth*INDENT, ' ', node->palette_id,
500 "[ "[node->split], node->val[0],
501 "][ "[node->split], node->val[1],
502 " ]["[node->split], node->val[2],
504 node->val[0], node->val[1], node->val[2],
507 av_bprintf(buf, "%*cnode%d -> node%d\n", depth*INDENT, ' ',
508 map[parent_id].palette_id, node->palette_id);
509 if (node->left_id != -1) disp_node(buf, map, node_id, node->left_id, depth + 1);
510 if (node->right_id != -1) disp_node(buf, map, node_id, node->right_id, depth + 1);
513 // debug_kdtree=kdtree.dot -> dot -Tpng kdtree.dot > kdtree.png
514 static int disp_tree(const struct color_node *node, const char *fname)
517 FILE *f = av_fopen_utf8(fname, "w");
520 int ret = AVERROR(errno);
521 av_log(NULL, AV_LOG_ERROR, "Cannot open file '%s' for writing: %s\n",
522 fname, av_err2str(ret));
526 av_bprint_init(&buf, 0, AV_BPRINT_SIZE_UNLIMITED);
528 av_bprintf(&buf, "digraph {\n");
529 av_bprintf(&buf, " node [style=filled fontsize=10 shape=box]\n");
530 disp_node(&buf, node, -1, 0, 0);
531 av_bprintf(&buf, "}\n");
533 fwrite(buf.str, 1, buf.len, f);
535 av_bprint_finalize(&buf, NULL);
539 static int debug_accuracy(const struct color_node *node, const uint32_t *palette,
540 const enum color_search_method search_method)
542 int r, g, b, ret = 0;
544 for (r = 0; r < 256; r++) {
545 for (g = 0; g < 256; g++) {
546 for (b = 0; b < 256; b++) {
547 const uint8_t rgb[] = {r, g, b};
548 const int r1 = COLORMAP_NEAREST(search_method, palette, node, rgb);
549 const int r2 = colormap_nearest_bruteforce(palette, rgb);
551 const uint32_t c1 = palette[r1];
552 const uint32_t c2 = palette[r2];
553 const uint8_t palrgb1[] = { c1>>16 & 0xff, c1>> 8 & 0xff, c1 & 0xff };
554 const uint8_t palrgb2[] = { c2>>16 & 0xff, c2>> 8 & 0xff, c2 & 0xff };
555 const int d1 = diff(palrgb1, rgb);
556 const int d2 = diff(palrgb2, rgb);
558 av_log(NULL, AV_LOG_ERROR,
559 "/!\\ %02X%02X%02X: %d ! %d (%06"PRIX32" ! %06"PRIX32") / dist: %d ! %d\n",
560 r, g, b, r1, r2, c1 & 0xffffff, c2 & 0xffffff, d1, d2);
580 typedef int (*cmp_func)(const void *, const void *);
582 #define DECLARE_CMP_FUNC(name, pos) \
583 static int cmp_##name(const void *pa, const void *pb) \
585 const struct color *a = pa; \
586 const struct color *b = pb; \
587 return (a->value >> (8 * (2 - (pos))) & 0xff) \
588 - (b->value >> (8 * (2 - (pos))) & 0xff); \
591 DECLARE_CMP_FUNC(r, 0)
592 DECLARE_CMP_FUNC(g, 1)
593 DECLARE_CMP_FUNC(b, 2)
595 static const cmp_func cmp_funcs[] = {cmp_r, cmp_g, cmp_b};
597 static int get_next_color(const uint8_t *color_used, const uint32_t *palette,
598 int *component, const struct color_rect *box)
602 unsigned nb_color = 0;
603 struct color_rect ranges;
604 struct color tmp_pal[256];
607 ranges.min[0] = ranges.min[1] = ranges.min[2] = 0xff;
608 ranges.max[0] = ranges.max[1] = ranges.max[2] = 0x00;
610 for (i = 0; i < AVPALETTE_COUNT; i++) {
611 const uint32_t c = palette[i];
612 const uint8_t r = c >> 16 & 0xff;
613 const uint8_t g = c >> 8 & 0xff;
614 const uint8_t b = c & 0xff;
617 r < box->min[0] || g < box->min[1] || b < box->min[2] ||
618 r > box->max[0] || g > box->max[1] || b > box->max[2])
621 if (r < ranges.min[0]) ranges.min[0] = r;
622 if (g < ranges.min[1]) ranges.min[1] = g;
623 if (b < ranges.min[2]) ranges.min[2] = b;
625 if (r > ranges.max[0]) ranges.max[0] = r;
626 if (g > ranges.max[1]) ranges.max[1] = g;
627 if (b > ranges.max[2]) ranges.max[2] = b;
629 tmp_pal[nb_color].value = c;
630 tmp_pal[nb_color].pal_id = i;
638 /* define longest axis that will be the split component */
639 wr = ranges.max[0] - ranges.min[0];
640 wg = ranges.max[1] - ranges.min[1];
641 wb = ranges.max[2] - ranges.min[2];
642 if (wr >= wg && wr >= wb) longest = 0;
643 if (wg >= wr && wg >= wb) longest = 1;
644 if (wb >= wr && wb >= wg) longest = 2;
645 cmpf = cmp_funcs[longest];
646 *component = longest;
648 /* sort along this axis to get median */
649 AV_QSORT(tmp_pal, nb_color, struct color, cmpf);
651 return tmp_pal[nb_color >> 1].pal_id;
654 static int colormap_insert(struct color_node *map,
657 const uint32_t *palette,
658 const struct color_rect *box)
661 int component, cur_id;
662 int node_left_id = -1, node_right_id = -1;
663 struct color_node *node;
664 struct color_rect box1, box2;
665 const int pal_id = get_next_color(color_used, palette, &component, box);
670 /* create new node with that color */
671 cur_id = (*nb_used)++;
674 node->split = component;
675 node->palette_id = pal_id;
676 node->val[0] = c>>16 & 0xff;
677 node->val[1] = c>> 8 & 0xff;
678 node->val[2] = c & 0xff;
680 color_used[pal_id] = 1;
682 /* get the two boxes this node creates */
684 box1.max[component] = node->val[component];
685 box2.min[component] = node->val[component] + 1;
687 node_left_id = colormap_insert(map, color_used, nb_used, palette, &box1);
689 if (box2.min[component] <= box2.max[component])
690 node_right_id = colormap_insert(map, color_used, nb_used, palette, &box2);
692 node->left_id = node_left_id;
693 node->right_id = node_right_id;
698 static int cmp_pal_entry(const void *a, const void *b)
700 const int c1 = *(const uint32_t *)a & 0xffffff;
701 const int c2 = *(const uint32_t *)b & 0xffffff;
705 static void load_colormap(PaletteUseContext *s)
708 uint8_t color_used[AVPALETTE_COUNT] = {0};
709 uint32_t last_color = 0;
710 struct color_rect box;
712 /* disable transparent colors and dups */
713 qsort(s->palette, AVPALETTE_COUNT, sizeof(*s->palette), cmp_pal_entry);
714 for (i = 0; i < AVPALETTE_COUNT; i++) {
715 const uint32_t c = s->palette[i];
716 if (i != 0 && c == last_color) {
721 if ((c & 0xff000000) != 0xff000000) {
722 color_used[i] = 1; // ignore transparent color(s)
727 box.min[0] = box.min[1] = box.min[2] = 0x00;
728 box.max[0] = box.max[1] = box.max[2] = 0xff;
730 colormap_insert(s->map, color_used, &nb_used, s->palette, &box);
733 disp_tree(s->map, s->dot_filename);
735 if (s->debug_accuracy) {
736 if (!debug_accuracy(s->map, s->palette, s->color_search_method))
737 av_log(NULL, AV_LOG_INFO, "Accuracy check passed\n");
741 static void debug_mean_error(PaletteUseContext *s, const AVFrame *in1,
742 const AVFrame *in2, int frame_count)
745 const uint32_t *palette = s->palette;
746 uint32_t *src1 = (uint32_t *)in1->data[0];
747 uint8_t *src2 = in2->data[0];
748 const int src1_linesize = in1->linesize[0] >> 2;
749 const int src2_linesize = in2->linesize[0];
750 const float div = in1->width * in1->height * 3;
751 unsigned mean_err = 0;
753 for (y = 0; y < in1->height; y++) {
754 for (x = 0; x < in1->width; x++) {
755 const uint32_t c1 = src1[x];
756 const uint32_t c2 = palette[src2[x]];
757 const uint8_t rgb1[] = {c1 >> 16 & 0xff, c1 >> 8 & 0xff, c1 & 0xff};
758 const uint8_t rgb2[] = {c2 >> 16 & 0xff, c2 >> 8 & 0xff, c2 & 0xff};
759 mean_err += diff(rgb1, rgb2);
761 src1 += src1_linesize;
762 src2 += src2_linesize;
765 s->total_mean_err += mean_err;
767 av_log(NULL, AV_LOG_INFO, "MEP:%.3f TotalMEP:%.3f\n",
768 mean_err / div, s->total_mean_err / (div * frame_count));
771 static void set_processing_window(enum diff_mode diff_mode,
772 const AVFrame *prv_src, const AVFrame *cur_src,
773 const AVFrame *prv_dst, AVFrame *cur_dst,
774 int *xp, int *yp, int *wp, int *hp)
776 int x_start = 0, y_start = 0;
777 int width = cur_src->width;
778 int height = cur_src->height;
780 if (prv_src && diff_mode == DIFF_MODE_RECTANGLE) {
782 int x_end = cur_src->width - 1,
783 y_end = cur_src->height - 1;
784 const uint32_t *prv_srcp = (const uint32_t *)prv_src->data[0];
785 const uint32_t *cur_srcp = (const uint32_t *)cur_src->data[0];
786 const uint8_t *prv_dstp = prv_dst->data[0];
787 uint8_t *cur_dstp = cur_dst->data[0];
789 const int prv_src_linesize = prv_src->linesize[0] >> 2;
790 const int cur_src_linesize = cur_src->linesize[0] >> 2;
791 const int prv_dst_linesize = prv_dst->linesize[0];
792 const int cur_dst_linesize = cur_dst->linesize[0];
794 /* skip common lines */
795 while (y_start < y_end && !memcmp(prv_srcp + y_start*prv_src_linesize,
796 cur_srcp + y_start*cur_src_linesize,
797 cur_src->width * 4)) {
798 memcpy(cur_dstp + y_start*cur_dst_linesize,
799 prv_dstp + y_start*prv_dst_linesize,
803 while (y_end > y_start && !memcmp(prv_srcp + y_end*prv_src_linesize,
804 cur_srcp + y_end*cur_src_linesize,
805 cur_src->width * 4)) {
806 memcpy(cur_dstp + y_end*cur_dst_linesize,
807 prv_dstp + y_end*prv_dst_linesize,
812 height = y_end + 1 - y_start;
814 /* skip common columns */
815 while (x_start < x_end) {
817 for (y = y_start; y <= y_end; y++) {
818 if (prv_srcp[y*prv_src_linesize + x_start] != cur_srcp[y*cur_src_linesize + x_start]) {
827 while (x_end > x_start) {
829 for (y = y_start; y <= y_end; y++) {
830 if (prv_srcp[y*prv_src_linesize + x_end] != cur_srcp[y*cur_src_linesize + x_end]) {
839 width = x_end + 1 - x_start;
842 for (y = y_start; y <= y_end; y++)
843 memcpy(cur_dstp + y*cur_dst_linesize,
844 prv_dstp + y*prv_dst_linesize, x_start);
846 if (x_end != cur_src->width - 1) {
847 const int copy_len = cur_src->width - 1 - x_end;
848 for (y = y_start; y <= y_end; y++)
849 memcpy(cur_dstp + y*cur_dst_linesize + x_end + 1,
850 prv_dstp + y*prv_dst_linesize + x_end + 1,
860 static AVFrame *apply_palette(AVFilterLink *inlink, AVFrame *in)
863 AVFilterContext *ctx = inlink->dst;
864 PaletteUseContext *s = ctx->priv;
865 AVFilterLink *outlink = inlink->dst->outputs[0];
867 AVFrame *out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
872 av_frame_copy_props(out, in);
874 set_processing_window(s->diff_mode, s->last_in, in,
875 s->last_out, out, &x, &y, &w, &h);
876 av_frame_free(&s->last_in);
877 av_frame_free(&s->last_out);
878 s->last_in = av_frame_clone(in);
879 s->last_out = av_frame_clone(out);
880 if (!s->last_in || !s->last_out ||
881 av_frame_make_writable(s->last_in) < 0) {
887 ff_dlog(ctx, "%dx%d rect: (%d;%d) -> (%d,%d) [area:%dx%d]\n",
888 w, h, x, y, x+w, y+h, in->width, in->height);
890 if (s->set_frame(s, out, in, x, y, w, h) < 0) {
894 memcpy(out->data[1], s->palette, AVPALETTE_SIZE);
895 if (s->calc_mean_err)
896 debug_mean_error(s, in, out, inlink->frame_count_out);
901 static int config_output(AVFilterLink *outlink)
904 AVFilterContext *ctx = outlink->src;
905 PaletteUseContext *s = ctx->priv;
907 ret = ff_framesync_init_dualinput(&s->fs, ctx);
910 s->fs.opt_repeatlast = 1; // only 1 frame in the palette
911 s->fs.in[1].before = s->fs.in[1].after = EXT_INFINITY;
912 s->fs.on_event = load_apply_palette;
914 outlink->w = ctx->inputs[0]->w;
915 outlink->h = ctx->inputs[0]->h;
917 outlink->time_base = ctx->inputs[0]->time_base;
918 if ((ret = ff_framesync_configure(&s->fs)) < 0)
923 static int config_input_palette(AVFilterLink *inlink)
925 AVFilterContext *ctx = inlink->dst;
927 if (inlink->w * inlink->h != AVPALETTE_COUNT) {
928 av_log(ctx, AV_LOG_ERROR,
929 "Palette input must contain exactly %d pixels. "
930 "Specified input has %dx%d=%d pixels\n",
931 AVPALETTE_COUNT, inlink->w, inlink->h,
932 inlink->w * inlink->h);
933 return AVERROR(EINVAL);
938 static void load_palette(PaletteUseContext *s, const AVFrame *palette_frame)
941 const uint32_t *p = (const uint32_t *)palette_frame->data[0];
942 const int p_linesize = palette_frame->linesize[0] >> 2;
945 memset(s->palette, 0, sizeof(s->palette));
946 memset(s->map, 0, sizeof(s->map));
947 for (i = 0; i < CACHE_SIZE; i++)
948 av_freep(&s->cache[i].entries);
949 memset(s->cache, 0, sizeof(s->cache));
953 for (y = 0; y < palette_frame->height; y++) {
954 for (x = 0; x < palette_frame->width; x++)
955 s->palette[i++] = p[x];
962 s->palette_loaded = 1;
965 static int load_apply_palette(FFFrameSync *fs)
967 AVFilterContext *ctx = fs->parent;
968 AVFilterLink *inlink = ctx->inputs[0];
969 PaletteUseContext *s = ctx->priv;
970 AVFrame *master, *second, *out;
973 // writable for error diffusal dithering
974 ret = ff_framesync_dualinput_get_writable(fs, &master, &second);
977 if (!master || !second) {
981 if (!s->palette_loaded) {
982 load_palette(s, second);
984 out = apply_palette(inlink, master);
985 return ff_filter_frame(ctx->outputs[0], out);
988 av_frame_free(&master);
989 av_frame_free(&second);
993 #define DEFINE_SET_FRAME(color_search, name, value) \
994 static int set_frame_##name(PaletteUseContext *s, AVFrame *out, AVFrame *in, \
995 int x_start, int y_start, int w, int h) \
997 return set_frame(s, out, in, x_start, y_start, w, h, value, color_search); \
1000 #define DEFINE_SET_FRAME_COLOR_SEARCH(color_search, color_search_macro) \
1001 DEFINE_SET_FRAME(color_search_macro, color_search##_##none, DITHERING_NONE) \
1002 DEFINE_SET_FRAME(color_search_macro, color_search##_##bayer, DITHERING_BAYER) \
1003 DEFINE_SET_FRAME(color_search_macro, color_search##_##heckbert, DITHERING_HECKBERT) \
1004 DEFINE_SET_FRAME(color_search_macro, color_search##_##floyd_steinberg, DITHERING_FLOYD_STEINBERG) \
1005 DEFINE_SET_FRAME(color_search_macro, color_search##_##sierra2, DITHERING_SIERRA2) \
1006 DEFINE_SET_FRAME(color_search_macro, color_search##_##sierra2_4a, DITHERING_SIERRA2_4A) \
1008 DEFINE_SET_FRAME_COLOR_SEARCH(nns_iterative, COLOR_SEARCH_NNS_ITERATIVE)
1009 DEFINE_SET_FRAME_COLOR_SEARCH(nns_recursive, COLOR_SEARCH_NNS_RECURSIVE)
1010 DEFINE_SET_FRAME_COLOR_SEARCH(bruteforce, COLOR_SEARCH_BRUTEFORCE)
1012 #define DITHERING_ENTRIES(color_search) { \
1013 set_frame_##color_search##_none, \
1014 set_frame_##color_search##_bayer, \
1015 set_frame_##color_search##_heckbert, \
1016 set_frame_##color_search##_floyd_steinberg, \
1017 set_frame_##color_search##_sierra2, \
1018 set_frame_##color_search##_sierra2_4a, \
1021 static const set_frame_func set_frame_lut[NB_COLOR_SEARCHES][NB_DITHERING] = {
1022 DITHERING_ENTRIES(nns_iterative),
1023 DITHERING_ENTRIES(nns_recursive),
1024 DITHERING_ENTRIES(bruteforce),
1027 static int dither_value(int p)
1029 const int q = p ^ (p >> 3);
1030 return (p & 4) >> 2 | (q & 4) >> 1 \
1031 | (p & 2) << 1 | (q & 2) << 2 \
1032 | (p & 1) << 4 | (q & 1) << 5;
1035 static av_cold int init(AVFilterContext *ctx)
1037 PaletteUseContext *s = ctx->priv;
1039 s->set_frame = set_frame_lut[s->color_search_method][s->dither];
1041 if (s->dither == DITHERING_BAYER) {
1043 const int delta = 1 << (5 - s->bayer_scale); // to avoid too much luma
1045 for (i = 0; i < FF_ARRAY_ELEMS(s->ordered_dither); i++)
1046 s->ordered_dither[i] = (dither_value(i) >> s->bayer_scale) - delta;
1052 static int activate(AVFilterContext *ctx)
1054 PaletteUseContext *s = ctx->priv;
1055 return ff_framesync_activate(&s->fs);
1058 static av_cold void uninit(AVFilterContext *ctx)
1061 PaletteUseContext *s = ctx->priv;
1063 ff_framesync_uninit(&s->fs);
1064 for (i = 0; i < CACHE_SIZE; i++)
1065 av_freep(&s->cache[i].entries);
1066 av_frame_free(&s->last_in);
1067 av_frame_free(&s->last_out);
1070 static const AVFilterPad paletteuse_inputs[] = {
1073 .type = AVMEDIA_TYPE_VIDEO,
1076 .type = AVMEDIA_TYPE_VIDEO,
1077 .config_props = config_input_palette,
1082 static const AVFilterPad paletteuse_outputs[] = {
1085 .type = AVMEDIA_TYPE_VIDEO,
1086 .config_props = config_output,
1091 AVFilter ff_vf_paletteuse = {
1092 .name = "paletteuse",
1093 .description = NULL_IF_CONFIG_SMALL("Use a palette to downsample an input video stream."),
1094 .priv_size = sizeof(PaletteUseContext),
1095 .query_formats = query_formats,
1098 .activate = activate,
1099 .inputs = paletteuse_inputs,
1100 .outputs = paletteuse_outputs,
1101 .priv_class = &paletteuse_class,