vf_delogo: switch to an AVOptions-based system.
[ffmpeg.git] / libavfilter / vf_delogo.c
1 /*
2  * Copyright (c) 2002 Jindrich Makovicka <makovick@gmail.com>
3  * Copyright (c) 2011 Stefano Sabatini
4  *
5  * This file is part of Libav.
6  *
7  * Libav is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * Libav is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License along
18  * with Libav; if not, write to the Free Software Foundation, Inc.,
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20  */
21
22 /**
23  * @file
24  * A very simple tv station logo remover
25  * Ported from MPlayer libmpcodecs/vf_delogo.c.
26  */
27
28 #include "libavutil/common.h"
29 #include "libavutil/imgutils.h"
30 #include "libavutil/opt.h"
31 #include "libavutil/pixdesc.h"
32 #include "avfilter.h"
33 #include "formats.h"
34 #include "internal.h"
35 #include "video.h"
36
37 /**
38  * Apply a simple delogo algorithm to the image in dst and put the
39  * result in src.
40  *
41  * The algorithm is only applied to the region specified by the logo
42  * parameters.
43  *
44  * @param w      width of the input image
45  * @param h      height of the input image
46  * @param logo_x x coordinate of the top left corner of the logo region
47  * @param logo_y y coordinate of the top left corner of the logo region
48  * @param logo_w width of the logo
49  * @param logo_h height of the logo
50  * @param band   the size of the band around the processed area
51  * @param show   show a rectangle around the processed area, useful for
52  *               parameters tweaking
53  * @param direct if non-zero perform in-place processing
54  */
55 static void apply_delogo(uint8_t *dst, int dst_linesize,
56                          uint8_t *src, int src_linesize,
57                          int w, int h,
58                          int logo_x, int logo_y, int logo_w, int logo_h,
59                          int band, int show, int direct)
60 {
61     int x, y;
62     int interp, dist;
63     uint8_t *xdst, *xsrc;
64
65     uint8_t *topleft, *botleft, *topright;
66     int xclipl, xclipr, yclipt, yclipb;
67     int logo_x1, logo_x2, logo_y1, logo_y2;
68
69     xclipl = FFMAX(-logo_x, 0);
70     xclipr = FFMAX(logo_x+logo_w-w, 0);
71     yclipt = FFMAX(-logo_y, 0);
72     yclipb = FFMAX(logo_y+logo_h-h, 0);
73
74     logo_x1 = logo_x + xclipl;
75     logo_x2 = logo_x + logo_w - xclipr;
76     logo_y1 = logo_y + yclipt;
77     logo_y2 = logo_y + logo_h - yclipb;
78
79     topleft  = src+logo_y1     * src_linesize+logo_x1;
80     topright = src+logo_y1     * src_linesize+logo_x2-1;
81     botleft  = src+(logo_y2-1) * src_linesize+logo_x1;
82
83     if (!direct)
84         av_image_copy_plane(dst, dst_linesize, src, src_linesize, w, h);
85
86     dst += (logo_y1 + 1) * dst_linesize;
87     src += (logo_y1 + 1) * src_linesize;
88
89     for (y = logo_y1+1; y < logo_y2-1; y++) {
90         for (x = logo_x1+1,
91              xdst = dst+logo_x1+1,
92              xsrc = src+logo_x1+1; x < logo_x2-1; x++, xdst++, xsrc++) {
93             interp = (topleft[src_linesize*(y-logo_y  -yclipt)]   +
94                       topleft[src_linesize*(y-logo_y-1-yclipt)]   +
95                       topleft[src_linesize*(y-logo_y+1-yclipt)])  * (logo_w-(x-logo_x))/logo_w
96                    + (topright[src_linesize*(y-logo_y-yclipt)]    +
97                       topright[src_linesize*(y-logo_y-1-yclipt)]  +
98                       topright[src_linesize*(y-logo_y+1-yclipt)]) * (x-logo_x)/logo_w
99                    + (topleft[x-logo_x-xclipl]                    +
100                       topleft[x-logo_x-1-xclipl]                  +
101                       topleft[x-logo_x+1-xclipl])                 * (logo_h-(y-logo_y))/logo_h
102                    + (botleft[x-logo_x-xclipl]                    +
103                       botleft[x-logo_x-1-xclipl]                  +
104                       botleft[x-logo_x+1-xclipl])                 * (y-logo_y)/logo_h;
105             interp /= 6;
106
107             if (y >= logo_y+band && y < logo_y+logo_h-band &&
108                 x >= logo_x+band && x < logo_x+logo_w-band) {
109                 *xdst = interp;
110             } else {
111                 dist = 0;
112                 if      (x < logo_x+band)
113                     dist = FFMAX(dist, logo_x-x+band);
114                 else if (x >= logo_x+logo_w-band)
115                     dist = FFMAX(dist, x-(logo_x+logo_w-1-band));
116
117                 if      (y < logo_y+band)
118                     dist = FFMAX(dist, logo_y-y+band);
119                 else if (y >= logo_y+logo_h-band)
120                     dist = FFMAX(dist, y-(logo_y+logo_h-1-band));
121
122                 *xdst = (*xsrc*dist + interp*(band-dist))/band;
123                 if (show && (dist == band-1))
124                     *xdst = 0;
125             }
126         }
127
128         dst += dst_linesize;
129         src += src_linesize;
130     }
131 }
132
133 typedef struct {
134     const AVClass *class;
135     int x, y, w, h, band, show;
136 }  DelogoContext;
137
138 #define OFFSET(x) offsetof(DelogoContext, x)
139 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM
140
141 static const AVOption delogo_options[]= {
142     { "x",    "set logo x position",       OFFSET(x),    AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, FLAGS },
143     { "y",    "set logo y position",       OFFSET(y),    AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, FLAGS },
144     { "w",    "set logo width",            OFFSET(w),    AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, FLAGS },
145     { "h",    "set logo height",           OFFSET(h),    AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, FLAGS },
146     { "band", "set delogo area band size", OFFSET(band), AV_OPT_TYPE_INT, { .i64 =  4 }, -1, INT_MAX, FLAGS },
147     { "t",    "set delogo area band size", OFFSET(band), AV_OPT_TYPE_INT, { .i64 =  4 }, -1, INT_MAX, FLAGS },
148     { "show", "show delogo area",          OFFSET(show), AV_OPT_TYPE_INT, { .i64 =  0 },  0, 1,       FLAGS },
149     { NULL },
150 };
151
152 static const char *delogo_get_name(void *ctx)
153 {
154     return "delogo";
155 }
156
157 static const AVClass delogo_class = {
158     .class_name = "DelogoContext",
159     .item_name  = delogo_get_name,
160     .option     = delogo_options,
161 };
162
163 static int query_formats(AVFilterContext *ctx)
164 {
165     enum AVPixelFormat pix_fmts[] = {
166         AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV422P,  AV_PIX_FMT_YUV420P,
167         AV_PIX_FMT_YUV411P,  AV_PIX_FMT_YUV410P,  AV_PIX_FMT_YUV440P,
168         AV_PIX_FMT_YUVA420P, AV_PIX_FMT_GRAY8,
169         AV_PIX_FMT_NONE
170     };
171
172     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
173     return 0;
174 }
175
176 static av_cold int init(AVFilterContext *ctx, const char *args)
177 {
178     DelogoContext *delogo = ctx->priv;
179
180 #define CHECK_UNSET_OPT(opt)                                            \
181     if (delogo->opt == -1) {                                            \
182         av_log(delogo, AV_LOG_ERROR, "Option %s was not set.\n", #opt); \
183         return AVERROR(EINVAL);                                         \
184     }
185     CHECK_UNSET_OPT(x);
186     CHECK_UNSET_OPT(y);
187     CHECK_UNSET_OPT(w);
188     CHECK_UNSET_OPT(h);
189
190     if (delogo->show)
191         delogo->band = 4;
192
193     av_log(ctx, AV_LOG_DEBUG, "x:%d y:%d, w:%d h:%d band:%d show:%d\n",
194            delogo->x, delogo->y, delogo->w, delogo->h, delogo->band, delogo->show);
195
196     delogo->w += delogo->band*2;
197     delogo->h += delogo->band*2;
198     delogo->x -= delogo->band;
199     delogo->y -= delogo->band;
200
201     return 0;
202 }
203
204 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
205 {
206     DelogoContext *delogo = inlink->dst->priv;
207     AVFilterLink *outlink = inlink->dst->outputs[0];
208     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
209     AVFrame *out;
210     int hsub0 = desc->log2_chroma_w;
211     int vsub0 = desc->log2_chroma_h;
212     int direct = 0;
213     int plane;
214
215     if (av_frame_is_writable(in)) {
216         direct = 1;
217         out = in;
218     } else {
219         out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
220         if (!out) {
221             av_frame_free(&in);
222             return AVERROR(ENOMEM);
223         }
224
225         av_frame_copy_props(out, in);
226         out->width  = outlink->w;
227         out->height = outlink->h;
228     }
229
230     for (plane = 0; plane < 4 && in->data[plane]; plane++) {
231         int hsub = plane == 1 || plane == 2 ? hsub0 : 0;
232         int vsub = plane == 1 || plane == 2 ? vsub0 : 0;
233
234         apply_delogo(out->data[plane], out->linesize[plane],
235                      in ->data[plane], in ->linesize[plane],
236                      inlink->w>>hsub, inlink->h>>vsub,
237                      delogo->x>>hsub, delogo->y>>vsub,
238                      delogo->w>>hsub, delogo->h>>vsub,
239                      delogo->band>>FFMIN(hsub, vsub),
240                      delogo->show, direct);
241     }
242
243     if (!direct)
244         av_frame_free(&in);
245
246     return ff_filter_frame(outlink, out);
247 }
248
249 static const AVFilterPad avfilter_vf_delogo_inputs[] = {
250     {
251         .name             = "default",
252         .type             = AVMEDIA_TYPE_VIDEO,
253         .get_video_buffer = ff_null_get_video_buffer,
254         .filter_frame     = filter_frame,
255     },
256     { NULL }
257 };
258
259 static const AVFilterPad avfilter_vf_delogo_outputs[] = {
260     {
261         .name = "default",
262         .type = AVMEDIA_TYPE_VIDEO,
263     },
264     { NULL }
265 };
266
267 AVFilter avfilter_vf_delogo = {
268     .name          = "delogo",
269     .description   = NULL_IF_CONFIG_SMALL("Remove logo from input video."),
270     .priv_size     = sizeof(DelogoContext),
271     .priv_class    = &delogo_class,
272     .init          = init,
273     .query_formats = query_formats,
274
275     .inputs    = avfilter_vf_delogo_inputs,
276     .outputs   = avfilter_vf_delogo_outputs,
277 };