avfilter/vf_limiter: add slice threading
[ffmpeg.git] / libavfilter / vf_limiter.c
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/attributes.h"
20 #include "libavutil/common.h"
21 #include "libavutil/eval.h"
22 #include "libavutil/imgutils.h"
23 #include "libavutil/opt.h"
24 #include "libavutil/pixdesc.h"
25 #include "avfilter.h"
26 #include "formats.h"
27 #include "internal.h"
28 #include "limiter.h"
29 #include "video.h"
30
31 typedef struct ThreadData {
32     AVFrame *in;
33     AVFrame *out;
34 } ThreadData;
35
36 typedef struct LimiterContext {
37     const AVClass *class;
38     int min;
39     int max;
40     int planes;
41     int nb_planes;
42     int linesize[4];
43     int width[4];
44     int height[4];
45
46     LimiterDSPContext dsp;
47 } LimiterContext;
48
49 #define OFFSET(x) offsetof(LimiterContext, x)
50 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
51
52 static const AVOption limiter_options[] = {
53     { "min",    "set min value", OFFSET(min),    AV_OPT_TYPE_INT, {.i64=0},     0, 65535, .flags = FLAGS },
54     { "max",    "set max value", OFFSET(max),    AV_OPT_TYPE_INT, {.i64=65535}, 0, 65535, .flags = FLAGS },
55     { "planes", "set planes",    OFFSET(planes), AV_OPT_TYPE_INT, {.i64=15},    0,    15, .flags = FLAGS },
56     { NULL }
57 };
58
59 AVFILTER_DEFINE_CLASS(limiter);
60
61 static av_cold int init(AVFilterContext *ctx)
62 {
63     LimiterContext *s = ctx->priv;
64
65     if (s->min > s->max)
66         return AVERROR(EINVAL);
67     return 0;
68 }
69
70 static int query_formats(AVFilterContext *ctx)
71 {
72     static const enum AVPixelFormat pix_fmts[] = {
73         AV_PIX_FMT_YUVA444P, AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV440P,
74         AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ440P,
75         AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUV420P,
76         AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
77         AV_PIX_FMT_YUVJ411P, AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P,
78         AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9,
79         AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV444P10,
80         AV_PIX_FMT_YUV420P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV444P12, AV_PIX_FMT_YUV440P12,
81         AV_PIX_FMT_YUV420P14, AV_PIX_FMT_YUV422P14, AV_PIX_FMT_YUV444P14,
82         AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV444P16,
83         AV_PIX_FMT_YUVA420P9, AV_PIX_FMT_YUVA422P9, AV_PIX_FMT_YUVA444P9,
84         AV_PIX_FMT_YUVA420P10, AV_PIX_FMT_YUVA422P10, AV_PIX_FMT_YUVA444P10,
85         AV_PIX_FMT_YUVA420P16, AV_PIX_FMT_YUVA422P16, AV_PIX_FMT_YUVA444P16,
86         AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRP9, AV_PIX_FMT_GBRP10,
87         AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRP14, AV_PIX_FMT_GBRP16,
88         AV_PIX_FMT_GBRAP, AV_PIX_FMT_GBRAP10, AV_PIX_FMT_GBRAP12, AV_PIX_FMT_GBRAP16,
89         AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY9, AV_PIX_FMT_GRAY10, AV_PIX_FMT_GRAY12, AV_PIX_FMT_GRAY14, AV_PIX_FMT_GRAY16,
90         AV_PIX_FMT_NONE
91     };
92
93     AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
94     if (!fmts_list)
95         return AVERROR(ENOMEM);
96     return ff_set_common_formats(ctx, fmts_list);
97 }
98
99 static void limiter8(const uint8_t *src, uint8_t *dst,
100                      ptrdiff_t slinesize, ptrdiff_t dlinesize,
101                      int w, int h, int min, int max)
102 {
103     int x, y;
104
105     for (y = 0; y < h; y++) {
106         for (x = 0; x < w; x++) {
107             dst[x] = av_clip(src[x], min, max);
108         }
109
110         dst += dlinesize;
111         src += slinesize;
112     }
113 }
114
115 static void limiter16(const uint8_t *ssrc, uint8_t *ddst,
116                       ptrdiff_t slinesize, ptrdiff_t dlinesize,
117                       int w, int h, int min, int max)
118 {
119     const uint16_t *src = (const uint16_t *)ssrc;
120     uint16_t *dst = (uint16_t *)ddst;
121     int x, y;
122
123     dlinesize /= 2;
124     slinesize /= 2;
125
126     for (y = 0; y < h; y++) {
127         for (x = 0; x < w; x++) {
128             dst[x] = av_clip(src[x], min, max);
129         }
130
131         dst += dlinesize;
132         src += slinesize;
133     }
134 }
135
136 static int config_props(AVFilterLink *inlink)
137 {
138     AVFilterContext *ctx = inlink->dst;
139     LimiterContext *s = ctx->priv;
140     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
141     int vsub, hsub, ret;
142
143     s->nb_planes = av_pix_fmt_count_planes(inlink->format);
144
145     if ((ret = av_image_fill_linesizes(s->linesize, inlink->format, inlink->w)) < 0)
146         return ret;
147
148     hsub = desc->log2_chroma_w;
149     vsub = desc->log2_chroma_h;
150     s->height[1] = s->height[2] = AV_CEIL_RSHIFT(inlink->h, vsub);
151     s->height[0] = s->height[3] = inlink->h;
152     s->width[1]  = s->width[2]  = AV_CEIL_RSHIFT(inlink->w, hsub);
153     s->width[0]  = s->width[3]  = inlink->w;
154
155     if (desc->comp[0].depth == 8) {
156         s->dsp.limiter = limiter8;
157         s->max = FFMIN(s->max, 255);
158         s->min = FFMIN(s->min, 255);
159     } else {
160         s->dsp.limiter = limiter16;
161     }
162
163     if (ARCH_X86)
164         ff_limiter_init_x86(&s->dsp, desc->comp[0].depth);
165
166     return 0;
167 }
168
169 static int filter_slice(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
170 {
171     LimiterContext *s = ctx->priv;
172     ThreadData *td = arg;
173     AVFrame *in = td->in;
174     AVFrame *out = td->out;
175     int p;
176
177     for (p = 0; p < s->nb_planes; p++) {
178         const int h = s->height[p];
179         const int slice_start = (h * jobnr) / nb_jobs;
180         const int slice_end = (h * (jobnr+1)) / nb_jobs;
181
182         if (!((1 << p) & s->planes)) {
183             if (out != in)
184                 av_image_copy_plane(out->data[p] + slice_start * out->linesize[p],
185                                     out->linesize[p],
186                                     in->data[p] + slice_start * in->linesize[p],
187                                     in->linesize[p],
188                                     s->linesize[p], slice_end - slice_start);
189             continue;
190         }
191
192         s->dsp.limiter(in->data[p] + slice_start * in->linesize[p],
193                        out->data[p] + slice_start * out->linesize[p],
194                        in->linesize[p], out->linesize[p],
195                        s->width[p], slice_end - slice_start,
196                        s->min, s->max);
197     }
198
199     return 0;
200 }
201
202 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
203 {
204     AVFilterContext *ctx = inlink->dst;
205     LimiterContext *s = ctx->priv;
206     AVFilterLink *outlink = ctx->outputs[0];
207     ThreadData td;
208     AVFrame *out;
209
210     if (av_frame_is_writable(in)) {
211         out = in;
212     } else {
213         out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
214         if (!out) {
215             av_frame_free(&in);
216             return AVERROR(ENOMEM);
217         }
218         av_frame_copy_props(out, in);
219     }
220
221     td.out = out;
222     td.in = in;
223     ctx->internal->execute(ctx, filter_slice, &td, NULL,
224                            FFMIN(s->height[2], ff_filter_get_nb_threads(ctx)));
225     if (out != in)
226         av_frame_free(&in);
227
228     return ff_filter_frame(outlink, out);
229 }
230
231 static const AVFilterPad inputs[] = {
232     {
233         .name         = "default",
234         .type         = AVMEDIA_TYPE_VIDEO,
235         .filter_frame = filter_frame,
236         .config_props = config_props,
237     },
238     { NULL }
239 };
240
241 static const AVFilterPad outputs[] = {
242     {
243         .name = "default",
244         .type = AVMEDIA_TYPE_VIDEO,
245     },
246     { NULL }
247 };
248
249 AVFilter ff_vf_limiter = {
250     .name          = "limiter",
251     .description   = NULL_IF_CONFIG_SMALL("Limit pixels components to the specified range."),
252     .priv_size     = sizeof(LimiterContext),
253     .priv_class    = &limiter_class,
254     .init          = init,
255     .query_formats = query_formats,
256     .inputs        = inputs,
257     .outputs       = outputs,
258     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC | AVFILTER_FLAG_SLICE_THREADS,
259 };