libavfilter/vf_noise.c
af882e18
 /*
  * Copyright (c) 2002 Michael Niedermayer <michaelni@gmx.at>
  * Copyright (c) 2013 Paul B Mahol
  *
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
75b2bbe2
  * modify it under the terms of the GNU Lesser General Public
af882e18
  * License as published by the Free Software Foundation; either
75b2bbe2
  * version 2.1 of the License, or (at your option) any later version.
af882e18
  *
  * FFmpeg is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
75b2bbe2
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
af882e18
  *
75b2bbe2
  * You should have received a copy of the GNU Lesser General Public
  * License along with FFmpeg; if not, write to the Free Software
af882e18
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 /**
  * @file
  * noise generator
  */
 
 #include "libavutil/opt.h"
 #include "libavutil/imgutils.h"
f4e29c40
 #include "libavutil/lfg.h"
af882e18
 #include "libavutil/parseutils.h"
 #include "libavutil/pixdesc.h"
69342444
 #include "libavutil/x86/asm.h"
af882e18
 #include "avfilter.h"
 #include "formats.h"
 #include "internal.h"
 #include "video.h"
 
f8f42f48
 #define MAX_NOISE 5120
af882e18
 #define MAX_SHIFT 1024
 #define MAX_RES (MAX_NOISE-MAX_SHIFT)
 
 #define NOISE_UNIFORM  1
 #define NOISE_TEMPORAL 2
 #define NOISE_AVERAGED 8
 #define NOISE_PATTERN  16
 
 typedef struct {
     int strength;
     unsigned flags;
f4e29c40
     AVLFG lfg;
af882e18
     int seed;
     int8_t *noise;
     int8_t *prev_shift[MAX_RES][3];
 } FilterParams;
 
 typedef struct {
     const AVClass *class;
     int nb_planes;
126ba688
     int bytewidth[4];
af882e18
     int height[4];
     FilterParams all;
     FilterParams param[4];
     int rand_shift[MAX_RES];
     int rand_shift_init;
69342444
     void (*line_noise)(uint8_t *dst, const uint8_t *src, int8_t *noise, int len, int shift);
     void (*line_noise_avg)(uint8_t *dst, const uint8_t *src, int len, int8_t **shift);
af882e18
 } NoiseContext;
 
83f97355
 typedef struct ThreadData {
     AVFrame *in, *out;
 } ThreadData;
 
af882e18
 #define OFFSET(x) offsetof(NoiseContext, x)
 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
 
 #define NOISE_PARAMS(name, x, param)                                                                                             \
     {#name"_seed", "set component #"#x" noise seed", OFFSET(param.seed), AV_OPT_TYPE_INT, {.i64=-1}, -1, INT_MAX, FLAGS},        \
     {#name"_strength", "set component #"#x" strength", OFFSET(param.strength), AV_OPT_TYPE_INT, {.i64=0}, 0, 100, FLAGS},        \
     {#name"s",         "set component #"#x" strength", OFFSET(param.strength), AV_OPT_TYPE_INT, {.i64=0}, 0, 100, FLAGS},        \
     {#name"_flags", "set component #"#x" flags", OFFSET(param.flags), AV_OPT_TYPE_FLAGS, {.i64=0}, 0, 31, FLAGS, #name"_flags"}, \
     {#name"f", "set component #"#x" flags", OFFSET(param.flags), AV_OPT_TYPE_FLAGS, {.i64=0}, 0, 31, FLAGS, #name"_flags"},      \
     {"a", "averaged noise", 0, AV_OPT_TYPE_CONST, {.i64=NOISE_AVERAGED}, 0, 0, FLAGS, #name"_flags"},                            \
     {"p", "(semi)regular pattern", 0, AV_OPT_TYPE_CONST, {.i64=NOISE_PATTERN},  0, 0, FLAGS, #name"_flags"},                     \
     {"t", "temporal noise", 0, AV_OPT_TYPE_CONST, {.i64=NOISE_TEMPORAL}, 0, 0, FLAGS, #name"_flags"},                            \
     {"u", "uniform noise",  0, AV_OPT_TYPE_CONST, {.i64=NOISE_UNIFORM},  0, 0, FLAGS, #name"_flags"},
 
 static const AVOption noise_options[] = {
     NOISE_PARAMS(all, 0, all)
     NOISE_PARAMS(c0,  0, param[0])
     NOISE_PARAMS(c1,  1, param[1])
     NOISE_PARAMS(c2,  2, param[2])
     NOISE_PARAMS(c3,  3, param[3])
     {NULL}
 };
 
 AVFILTER_DEFINE_CLASS(noise);
 
 static const int8_t patt[4] = { -1, 0, 1, 0 };
 
f4e29c40
 #define RAND_N(range) ((int) ((double) range * av_lfg_get(lfg) / (UINT_MAX + 1.0)))
b890198b
 static av_cold int init_noise(NoiseContext *n, int comp)
af882e18
 {
     int8_t *noise = av_malloc(MAX_NOISE * sizeof(int8_t));
     FilterParams *fp = &n->param[comp];
f4e29c40
     AVLFG *lfg = &n->param[comp].lfg;
af882e18
     int strength = fp->strength;
     int flags = fp->flags;
     int i, j;
 
     if (!noise)
         return AVERROR(ENOMEM);
 
f4e29c40
     av_lfg_init(&fp->lfg, fp->seed);
af882e18
 
     for (i = 0, j = 0; i < MAX_NOISE; i++, j++) {
         if (flags & NOISE_UNIFORM) {
             if (flags & NOISE_AVERAGED) {
                 if (flags & NOISE_PATTERN) {
                     noise[i] = (RAND_N(strength) - strength / 2) / 6
                         + patt[j % 4] * strength * 0.25 / 3;
                 } else {
                     noise[i] = (RAND_N(strength) - strength / 2) / 3;
                 }
             } else {
                 if (flags & NOISE_PATTERN) {
                     noise[i] = (RAND_N(strength) - strength / 2) / 2
                         + patt[j % 4] * strength * 0.25;
                 } else {
                     noise[i] = RAND_N(strength) - strength / 2;
                 }
             }
         } else {
             double x1, x2, w, y1;
             do {
28943c4d
                 x1 = 2.0 * av_lfg_get(lfg) / (float)UINT_MAX - 1.0;
                 x2 = 2.0 * av_lfg_get(lfg) / (float)UINT_MAX - 1.0;
af882e18
                 w = x1 * x1 + x2 * x2;
             } while (w >= 1.0);
 
             w   = sqrt((-2.0 * log(w)) / w);
             y1  = x1 * w;
             y1 *= strength / sqrt(3.0);
             if (flags & NOISE_PATTERN) {
                 y1 /= 2;
                 y1 += patt[j % 4] * strength * 0.35;
             }
             y1 = av_clipf(y1, -128, 127);
             if (flags & NOISE_AVERAGED)
                 y1 /= 3.0;
             noise[i] = (int)y1;
         }
         if (RAND_N(6) == 0)
             j--;
     }
 
     for (i = 0; i < MAX_RES; i++)
         for (j = 0; j < 3; j++)
f4e29c40
             fp->prev_shift[i][j] = noise + (av_lfg_get(lfg) & (MAX_SHIFT - 1));
af882e18
 
     if (!n->rand_shift_init) {
         for (i = 0; i < MAX_RES; i++)
f4e29c40
             n->rand_shift[i] = av_lfg_get(lfg) & (MAX_SHIFT - 1);
af882e18
         n->rand_shift_init = 1;
     }
 
     fp->noise = noise;
     return 0;
 }
 
 static int query_formats(AVFilterContext *ctx)
 {
     AVFilterFormats *formats = NULL;
     int fmt;
 
     for (fmt = 0; fmt < AV_PIX_FMT_NB; fmt++) {
         const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(fmt);
c7c71f95
         if (desc->flags & AV_PIX_FMT_FLAG_PLANAR && !((desc->comp[0].depth_minus1 + 1) & 7))
af882e18
             ff_add_format(&formats, fmt);
     }
 
     ff_set_common_formats(ctx, formats);
     return 0;
 }
 
 static int config_input(AVFilterLink *inlink)
 {
     NoiseContext *n = inlink->dst->priv;
     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
2516b393
     int ret;
af882e18
 
2516b393
     n->nb_planes = av_pix_fmt_count_planes(inlink->format);
af882e18
 
126ba688
     if ((ret = av_image_fill_linesizes(n->bytewidth, inlink->format, inlink->w)) < 0)
af882e18
         return ret;
 
50e66726
     n->height[1] = n->height[2] = FF_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
af882e18
     n->height[0] = n->height[3] = inlink->h;
 
     return 0;
 }
 
69342444
 static inline void line_noise_c(uint8_t *dst, const uint8_t *src, int8_t *noise,
af882e18
                        int len, int shift)
 {
     int i;
 
     noise += shift;
     for (i = 0; i < len; i++) {
         int v = src[i] + noise[i];
 
         dst[i] = av_clip_uint8(v);
     }
 }
 
69342444
 #define ASMALIGN(ZEROBITS) ".p2align " #ZEROBITS "\n\t"
 
 static void line_noise_mmx(uint8_t *dst, const uint8_t *src,
                            int8_t *noise, int len, int shift)
 {
5fbf9c12
 #if HAVE_MMX_INLINE
69342444
     x86_reg mmx_len= len&(~7);
     noise+=shift;
 
     __asm__ volatile(
             "mov %3, %%"REG_a"               \n\t"
             "pcmpeqb %%mm7, %%mm7            \n\t"
             "psllw $15, %%mm7                \n\t"
             "packsswb %%mm7, %%mm7           \n\t"
             ASMALIGN(4)
             "1:                              \n\t"
             "movq (%0, %%"REG_a"), %%mm0     \n\t"
             "movq (%1, %%"REG_a"), %%mm1     \n\t"
             "pxor %%mm7, %%mm0               \n\t"
             "paddsb %%mm1, %%mm0             \n\t"
             "pxor %%mm7, %%mm0               \n\t"
             "movq %%mm0, (%2, %%"REG_a")     \n\t"
             "add $8, %%"REG_a"               \n\t"
             " js 1b                          \n\t"
             :: "r" (src+mmx_len), "r" (noise+mmx_len), "r" (dst+mmx_len), "g" (-mmx_len)
             : "%"REG_a
     );
     if (mmx_len!=len)
         line_noise_c(dst+mmx_len, src+mmx_len, noise+mmx_len, len-mmx_len, 0);
 #endif
5fbf9c12
 }
69342444
 
 static void line_noise_mmxext(uint8_t *dst, const uint8_t *src,
                               int8_t *noise, int len, int shift)
 {
5fbf9c12
 #if HAVE_MMXEXT_INLINE
69342444
     x86_reg mmx_len= len&(~7);
     noise+=shift;
 
     __asm__ volatile(
             "mov %3, %%"REG_a"                \n\t"
             "pcmpeqb %%mm7, %%mm7             \n\t"
             "psllw $15, %%mm7                 \n\t"
             "packsswb %%mm7, %%mm7            \n\t"
             ASMALIGN(4)
             "1:                               \n\t"
             "movq (%0, %%"REG_a"), %%mm0      \n\t"
             "movq (%1, %%"REG_a"), %%mm1      \n\t"
             "pxor %%mm7, %%mm0                \n\t"
             "paddsb %%mm1, %%mm0              \n\t"
             "pxor %%mm7, %%mm0                \n\t"
             "movntq %%mm0, (%2, %%"REG_a")    \n\t"
             "add $8, %%"REG_a"                \n\t"
             " js 1b                           \n\t"
             :: "r" (src+mmx_len), "r" (noise+mmx_len), "r" (dst+mmx_len), "g" (-mmx_len)
             : "%"REG_a
             );
     if (mmx_len != len)
         line_noise_c(dst+mmx_len, src+mmx_len, noise+mmx_len, len-mmx_len, 0);
 #endif
5fbf9c12
 }
69342444
 
 static inline void line_noise_avg_c(uint8_t *dst, const uint8_t *src,
af882e18
                            int len, int8_t **shift)
 {
     int i;
     int8_t *src2 = (int8_t*)src;
 
     for (i = 0; i < len; i++) {
         const int n = shift[0][i] + shift[1][i] + shift[2][i];
         dst[i] = src2[i] + ((n * src2[i]) >> 7);
     }
 }
 
69342444
 static inline void line_noise_avg_mmx(uint8_t *dst, const uint8_t *src,
                                       int len, int8_t **shift)
 {
5fbf9c12
 #if HAVE_MMX_INLINE
69342444
     x86_reg mmx_len= len&(~7);
 
     __asm__ volatile(
             "mov %5, %%"REG_a"              \n\t"
             ASMALIGN(4)
             "1:                             \n\t"
             "movq (%1, %%"REG_a"), %%mm1    \n\t"
             "movq (%0, %%"REG_a"), %%mm0    \n\t"
             "paddb (%2, %%"REG_a"), %%mm1   \n\t"
             "paddb (%3, %%"REG_a"), %%mm1   \n\t"
             "movq %%mm0, %%mm2              \n\t"
             "movq %%mm1, %%mm3              \n\t"
             "punpcklbw %%mm0, %%mm0         \n\t"
             "punpckhbw %%mm2, %%mm2         \n\t"
             "punpcklbw %%mm1, %%mm1         \n\t"
             "punpckhbw %%mm3, %%mm3         \n\t"
             "pmulhw %%mm0, %%mm1            \n\t"
             "pmulhw %%mm2, %%mm3            \n\t"
             "paddw %%mm1, %%mm1             \n\t"
             "paddw %%mm3, %%mm3             \n\t"
             "paddw %%mm0, %%mm1             \n\t"
             "paddw %%mm2, %%mm3             \n\t"
             "psrlw $8, %%mm1                \n\t"
             "psrlw $8, %%mm3                \n\t"
             "packuswb %%mm3, %%mm1          \n\t"
             "movq %%mm1, (%4, %%"REG_a")    \n\t"
             "add $8, %%"REG_a"              \n\t"
             " js 1b                         \n\t"
             :: "r" (src+mmx_len), "r" (shift[0]+mmx_len), "r" (shift[1]+mmx_len), "r" (shift[2]+mmx_len),
                "r" (dst+mmx_len), "g" (-mmx_len)
             : "%"REG_a
         );
 
     if (mmx_len != len){
         int8_t *shift2[3]={shift[0]+mmx_len, shift[1]+mmx_len, shift[2]+mmx_len};
         line_noise_avg_c(dst+mmx_len, src+mmx_len, len-mmx_len, shift2);
     }
 #endif
5fbf9c12
 }
69342444
 
af882e18
 static void noise(uint8_t *dst, const uint8_t *src,
                   int dst_linesize, int src_linesize,
83f97355
                   int width, int start, int end, NoiseContext *n, int comp)
af882e18
 {
83f97355
     FilterParams *p = &n->param[comp];
     int8_t *noise = p->noise;
     const int flags = p->flags;
     AVLFG *lfg = &p->lfg;
af882e18
     int shift, y;
 
     if (!noise) {
40a87a6a
         if (dst != src)
83f97355
             av_image_copy_plane(dst, dst_linesize, src, src_linesize, width, end - start);
af882e18
         return;
     }
 
83f97355
     for (y = start; y < end; y++) {
f8f42f48
         const int ix = y & (MAX_RES - 1);
af882e18
         if (flags & NOISE_TEMPORAL)
f4e29c40
             shift = av_lfg_get(lfg) & (MAX_SHIFT - 1);
af882e18
         else
f8f42f48
             shift = n->rand_shift[ix];
af882e18
 
         if (flags & NOISE_AVERAGED) {
f8f42f48
             n->line_noise_avg(dst, src, width, p->prev_shift[ix]);
             p->prev_shift[ix][shift & 3] = noise + shift;
af882e18
         } else {
69342444
             n->line_noise(dst, src, noise, width, shift);
af882e18
         }
         dst += dst_linesize;
         src += src_linesize;
     }
83f97355
 }
af882e18
 
83f97355
 static int filter_slice(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
 {
     NoiseContext *s = ctx->priv;
     ThreadData *td = arg;
     int plane;
 
     for (plane = 0; plane < s->nb_planes; plane++) {
         const int height = s->height[plane];
         const int start  = (height *  jobnr   ) / nb_jobs;
         const int end    = (height * (jobnr+1)) / nb_jobs;
         noise(td->out->data[plane] + start * td->out->linesize[plane],
               td->in->data[plane]  + start * td->in->linesize[plane],
               td->out->linesize[plane], td->in->linesize[plane],
126ba688
               s->bytewidth[plane], start, end, s, plane);
83f97355
     }
     return 0;
af882e18
 }
 
a05a44e2
 static int filter_frame(AVFilterLink *inlink, AVFrame *inpicref)
af882e18
 {
83f97355
     AVFilterContext *ctx = inlink->dst;
     AVFilterLink *outlink = ctx->outputs[0];
     NoiseContext *n = ctx->priv;
     ThreadData td;
a05a44e2
     AVFrame *out;
af882e18
 
a05a44e2
     if (av_frame_is_writable(inpicref)) {
af882e18
         out = inpicref;
     } else {
a05a44e2
         out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
af882e18
         if (!out) {
a05a44e2
             av_frame_free(&inpicref);
af882e18
             return AVERROR(ENOMEM);
         }
a05a44e2
         av_frame_copy_props(out, inpicref);
af882e18
     }
 
83f97355
     td.in = inpicref; td.out = out;
     ctx->internal->execute(ctx, filter_slice, &td, NULL, FFMIN(n->height[0], ctx->graph->nb_threads));
e86ed98f
     emms_c();
af882e18
 
     if (inpicref != out)
a05a44e2
         av_frame_free(&inpicref);
77709759
     return ff_filter_frame(outlink, out);
af882e18
 }
 
fd6228e6
 static av_cold int init(AVFilterContext *ctx)
69342444
 {
     NoiseContext *n = ctx->priv;
     int ret, i;
     int cpu_flags = av_get_cpu_flags();
 
     for (i = 0; i < 4; i++) {
         if (n->all.seed >= 0)
             n->param[i].seed = n->all.seed;
         else
             n->param[i].seed = 123457;
         if (n->all.strength)
             n->param[i].strength = n->all.strength;
         if (n->all.flags)
             n->param[i].flags = n->all.flags;
     }
 
     for (i = 0; i < 4; i++) {
         if (n->param[i].strength && ((ret = init_noise(n, i)) < 0))
             return ret;
     }
 
3eba83da
     n->line_noise     = line_noise_c;
     n->line_noise_avg = line_noise_avg_c;
 
69342444
     if (HAVE_MMX_INLINE &&
         cpu_flags & AV_CPU_FLAG_MMX) {
         n->line_noise = line_noise_mmx;
         n->line_noise_avg = line_noise_avg_mmx;
     }
     if (HAVE_MMXEXT_INLINE &&
         cpu_flags & AV_CPU_FLAG_MMXEXT)
         n->line_noise = line_noise_mmxext;
 
     return 0;
 }
 
af882e18
 static av_cold void uninit(AVFilterContext *ctx)
 {
     NoiseContext *n = ctx->priv;
     int i;
 
     for (i = 0; i < 4; i++)
         av_freep(&n->param[i].noise);
 }
 
 static const AVFilterPad noise_inputs[] = {
     {
b211607b
         .name         = "default",
         .type         = AVMEDIA_TYPE_VIDEO,
         .filter_frame = filter_frame,
         .config_props = config_input,
af882e18
     },
     { NULL }
 };
 
 static const AVFilterPad noise_outputs[] = {
     {
b211607b
         .name = "default",
         .type = AVMEDIA_TYPE_VIDEO,
af882e18
     },
     { NULL }
 };
 
325f6e0a
 AVFilter ff_vf_noise = {
af882e18
     .name          = "noise",
     .description   = NULL_IF_CONFIG_SMALL("Add noise."),
     .priv_size     = sizeof(NoiseContext),
     .init          = init,
     .uninit        = uninit,
     .query_formats = query_formats,
     .inputs        = noise_inputs,
     .outputs       = noise_outputs,
     .priv_class    = &noise_class,
83f97355
     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC | AVFILTER_FLAG_SLICE_THREADS,
af882e18
 };