Replace PIX_FMT_* -> AV_PIX_FMT_*, PixelFormat -> AVPixelFormat
[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     dst += (logo_y1+1)*dst_linesize;
84     src += (logo_y1+1)*src_linesize;
85
86     if (!direct)
87         av_image_copy_plane(dst, dst_linesize, src, src_linesize, w, h);
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
140 static const AVOption delogo_options[]= {
141     {"x",    "set logo x position",       OFFSET(x),    AV_OPT_TYPE_INT, {.i64 = -1}, -1, INT_MAX },
142     {"y",    "set logo y position",       OFFSET(y),    AV_OPT_TYPE_INT, {.i64 = -1}, -1, INT_MAX },
143     {"w",    "set logo width",            OFFSET(w),    AV_OPT_TYPE_INT, {.i64 = -1}, -1, INT_MAX },
144     {"h",    "set logo height",           OFFSET(h),    AV_OPT_TYPE_INT, {.i64 = -1}, -1, INT_MAX },
145     {"band", "set delogo area band size", OFFSET(band), AV_OPT_TYPE_INT, {.i64 =  4}, -1, INT_MAX },
146     {"t",    "set delogo area band size", OFFSET(band), AV_OPT_TYPE_INT, {.i64 =  4}, -1, INT_MAX },
147     {"show", "show delogo area",          OFFSET(show), AV_OPT_TYPE_INT, {.i64 =  0},  0, 1       },
148     {NULL},
149 };
150
151 static const char *delogo_get_name(void *ctx)
152 {
153     return "delogo";
154 }
155
156 static const AVClass delogo_class = {
157     .class_name = "DelogoContext",
158     .item_name  = delogo_get_name,
159     .option     = delogo_options,
160 };
161
162 static int query_formats(AVFilterContext *ctx)
163 {
164     enum AVPixelFormat pix_fmts[] = {
165         AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV422P,  AV_PIX_FMT_YUV420P,
166         AV_PIX_FMT_YUV411P,  AV_PIX_FMT_YUV410P,  AV_PIX_FMT_YUV440P,
167         AV_PIX_FMT_YUVA420P, AV_PIX_FMT_GRAY8,
168         AV_PIX_FMT_NONE
169     };
170
171     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
172     return 0;
173 }
174
175 static av_cold int init(AVFilterContext *ctx, const char *args)
176 {
177     DelogoContext *delogo = ctx->priv;
178     int ret = 0;
179
180     delogo->class = &delogo_class;
181     av_opt_set_defaults(delogo);
182
183     if (args)
184         ret = sscanf(args, "%d:%d:%d:%d:%d",
185                      &delogo->x, &delogo->y, &delogo->w, &delogo->h, &delogo->band);
186     if (ret == 5) {
187         if (delogo->band < 0)
188             delogo->show = 1;
189     } else if ((ret = (av_set_options_string(delogo, args, "=", ":"))) < 0) {
190         av_log(ctx, AV_LOG_ERROR, "Error parsing options string: '%s'\n", args);
191         return ret;
192     }
193
194 #define CHECK_UNSET_OPT(opt)                                            \
195     if (delogo->opt == -1) {                                            \
196         av_log(delogo, AV_LOG_ERROR, "Option %s was not set.\n", #opt); \
197         return AVERROR(EINVAL);                                         \
198     }
199     CHECK_UNSET_OPT(x);
200     CHECK_UNSET_OPT(y);
201     CHECK_UNSET_OPT(w);
202     CHECK_UNSET_OPT(h);
203
204     if (delogo->show)
205         delogo->band = 4;
206
207     av_log(ctx, AV_LOG_DEBUG, "x:%d y:%d, w:%d h:%d band:%d show:%d\n",
208            delogo->x, delogo->y, delogo->w, delogo->h, delogo->band, delogo->show);
209
210     delogo->w += delogo->band*2;
211     delogo->h += delogo->band*2;
212     delogo->x -= delogo->band;
213     delogo->y -= delogo->band;
214
215     return 0;
216 }
217
218 static int null_draw_slice(AVFilterLink *link, int y, int h, int slice_dir)
219 {
220     return 0;
221 }
222
223 static int end_frame(AVFilterLink *inlink)
224 {
225     DelogoContext *delogo = inlink->dst->priv;
226     AVFilterLink *outlink = inlink->dst->outputs[0];
227     AVFilterBufferRef *inpicref  = inlink ->cur_buf;
228     AVFilterBufferRef *outpicref = outlink->out_buf;
229     int direct = inpicref->buf == outpicref->buf;
230     int hsub0 = av_pix_fmt_descriptors[inlink->format].log2_chroma_w;
231     int vsub0 = av_pix_fmt_descriptors[inlink->format].log2_chroma_h;
232     int plane;
233     int ret;
234
235     for (plane = 0; plane < 4 && inpicref->data[plane]; plane++) {
236         int hsub = plane == 1 || plane == 2 ? hsub0 : 0;
237         int vsub = plane == 1 || plane == 2 ? vsub0 : 0;
238
239         apply_delogo(outpicref->data[plane], outpicref->linesize[plane],
240                      inpicref ->data[plane], inpicref ->linesize[plane],
241                      inlink->w>>hsub, inlink->h>>vsub,
242                      delogo->x>>hsub, delogo->y>>vsub,
243                      delogo->w>>hsub, delogo->h>>vsub,
244                      delogo->band>>FFMIN(hsub, vsub),
245                      delogo->show, direct);
246     }
247
248     if ((ret = ff_draw_slice(outlink, 0, inlink->h, 1)) < 0 ||
249         (ret = ff_end_frame(outlink)) < 0)
250         return ret;
251     return 0;
252 }
253
254 AVFilter avfilter_vf_delogo = {
255     .name          = "delogo",
256     .description   = NULL_IF_CONFIG_SMALL("Remove logo from input video."),
257     .priv_size     = sizeof(DelogoContext),
258     .init          = init,
259     .query_formats = query_formats,
260
261     .inputs    = (const AVFilterPad[]) {{ .name             = "default",
262                                           .type             = AVMEDIA_TYPE_VIDEO,
263                                           .get_video_buffer = ff_null_get_video_buffer,
264                                           .start_frame      = ff_inplace_start_frame,
265                                           .draw_slice       = null_draw_slice,
266                                           .end_frame        = end_frame,
267                                           .min_perms        = AV_PERM_WRITE | AV_PERM_READ,
268                                           .rej_perms        = AV_PERM_PRESERVE },
269                                         { .name = NULL}},
270     .outputs   = (const AVFilterPad[]) {{ .name             = "default",
271                                           .type             = AVMEDIA_TYPE_VIDEO, },
272                                         { .name = NULL}},
273 };