git.sesse.net Git - ffmpeg/blob - libavfilter/vf_w3fdif.c

   1 /*
   2  * Copyright (C) 2012 British Broadcasting Corporation, All Rights Reserved
   3  * Author of de-interlace algorithm: Jim Easterbrook for BBC R&D
   4  * Based on the process described by Martin Weston for BBC R&D
   5  * Author of FFmpeg filter: Mark Himsley for BBC Broadcast Systems Development
   6  *
   7  * This file is part of FFmpeg.
   8  *
   9  * FFmpeg is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public
  11  * License as published by the Free Software Foundation; either
  12  * version 2.1 of the License, or (at your option) any later version.
  13  *
  14  * FFmpeg is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with FFmpeg; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  22  */
  23
  24 #include "libavutil/common.h"
  25 #include "libavutil/imgutils.h"
  26 #include "libavutil/opt.h"
  27 #include "libavutil/pixdesc.h"
  28 #include "avfilter.h"
  29 #include "formats.h"
  30 #include "internal.h"
  31 #include "video.h"
  32 #include "w3fdif.h"
  33
  34 typedef struct W3FDIFContext {
  35     const AVClass *class;
  36     int filter;           ///< 0 is simple, 1 is more complex
  37     int deint;            ///< which frames to deinterlace
  38     int linesize[4];      ///< bytes of pixel data per line for each plane
  39     int planeheight[4];   ///< height of each plane
  40     int field;            ///< which field are we on, 0 or 1
  41     int eof;
  42     int nb_planes;
  43     AVFrame *prev, *cur, *next;  ///< previous, current, next frames
  44     int32_t **work_line;  ///< lines we are calculating
  45     int nb_threads;
  46
  47     W3FDIFDSPContext dsp;
  48 } W3FDIFContext;
  49
  50 #define OFFSET(x) offsetof(W3FDIFContext, x)
  51 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
  52 #define CONST(name, help, val, unit) { name, help, 0, AV_OPT_TYPE_CONST, {.i64=val}, 0, 0, FLAGS, unit }
  53
  54 static const AVOption w3fdif_options[] = {
  55     { "filter", "specify the filter", OFFSET(filter), AV_OPT_TYPE_INT, {.i64=1}, 0, 1, FLAGS, "filter" },
  56     CONST("simple",  NULL, 0, "filter"),
  57     CONST("complex", NULL, 1, "filter"),
  58     { "deint",  "specify which frames to deinterlace", OFFSET(deint), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS, "deint" },
  59     CONST("all",        "deinterlace all frames",                       0, "deint"),
  60     CONST("interlaced", "only deinterlace frames marked as interlaced", 1, "deint"),
  61     { NULL }
  62 };
  63
  64 AVFILTER_DEFINE_CLASS(w3fdif);
  65
  66 static int query_formats(AVFilterContext *ctx)
  67 {
  68     static const enum AVPixelFormat pix_fmts[] = {
  69         AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV411P,
  70         AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P,
  71         AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV444P,
  72         AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ440P,
  73         AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
  74         AV_PIX_FMT_YUVJ411P,
  75         AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA444P,
  76         AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRAP,
  77         AV_PIX_FMT_GRAY8,
  78         AV_PIX_FMT_NONE
  79     };
  80
  81     AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
  82     if (!fmts_list)
  83         return AVERROR(ENOMEM);
  84     return ff_set_common_formats(ctx, fmts_list);
  85 }
  86
  87 static void filter_simple_low(int32_t *work_line,
  88                               uint8_t *in_lines_cur[2],
  89                               const int16_t *coef, int linesize)
  90 {
  91     int i;
  92
  93     for (i = 0; i < linesize; i++) {
  94         *work_line    = *in_lines_cur[0]++ * coef[0];
  95         *work_line++ += *in_lines_cur[1]++ * coef[1];
  96     }
  97 }
  98
  99 static void filter_complex_low(int32_t *work_line,
 100                                uint8_t *in_lines_cur[4],
 101                                const int16_t *coef, int linesize)
 102 {
 103     int i;
 104
 105     for (i = 0; i < linesize; i++) {
 106         *work_line    = *in_lines_cur[0]++ * coef[0];
 107         *work_line   += *in_lines_cur[1]++ * coef[1];
 108         *work_line   += *in_lines_cur[2]++ * coef[2];
 109         *work_line++ += *in_lines_cur[3]++ * coef[3];
 110     }
 111 }
 112
 113 static void filter_simple_high(int32_t *work_line,
 114                                uint8_t *in_lines_cur[3],
 115                                uint8_t *in_lines_adj[3],
 116                                const int16_t *coef, int linesize)
 117 {
 118     int i;
 119
 120     for (i = 0; i < linesize; i++) {
 121         *work_line   += *in_lines_cur[0]++ * coef[0];
 122         *work_line   += *in_lines_adj[0]++ * coef[0];
 123         *work_line   += *in_lines_cur[1]++ * coef[1];
 124         *work_line   += *in_lines_adj[1]++ * coef[1];
 125         *work_line   += *in_lines_cur[2]++ * coef[2];
 126         *work_line++ += *in_lines_adj[2]++ * coef[2];
 127     }
 128 }
 129
 130 static void filter_complex_high(int32_t *work_line,
 131                                 uint8_t *in_lines_cur[5],
 132                                 uint8_t *in_lines_adj[5],
 133                                 const int16_t *coef, int linesize)
 134 {
 135     int i;
 136
 137     for (i = 0; i < linesize; i++) {
 138         *work_line   += *in_lines_cur[0]++ * coef[0];
 139         *work_line   += *in_lines_adj[0]++ * coef[0];
 140         *work_line   += *in_lines_cur[1]++ * coef[1];
 141         *work_line   += *in_lines_adj[1]++ * coef[1];
 142         *work_line   += *in_lines_cur[2]++ * coef[2];
 143         *work_line   += *in_lines_adj[2]++ * coef[2];
 144         *work_line   += *in_lines_cur[3]++ * coef[3];
 145         *work_line   += *in_lines_adj[3]++ * coef[3];
 146         *work_line   += *in_lines_cur[4]++ * coef[4];
 147         *work_line++ += *in_lines_adj[4]++ * coef[4];
 148     }
 149 }
 150
 151 static void filter_scale(uint8_t *out_pixel, const int32_t *work_pixel, int linesize)
 152 {
 153     int j;
 154
 155     for (j = 0; j < linesize; j++, out_pixel++, work_pixel++)
 156         *out_pixel = av_clip(*work_pixel, 0, 255 * 256 * 128) >> 15;
 157 }
 158
 159 static int config_input(AVFilterLink *inlink)
 160 {
 161     AVFilterContext *ctx = inlink->dst;
 162     W3FDIFContext *s = ctx->priv;
 163     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
 164     int ret, i;
 165
 166     if ((ret = av_image_fill_linesizes(s->linesize, inlink->format, inlink->w)) < 0)
 167         return ret;
 168
 169     s->planeheight[1] = s->planeheight[2] = AV_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
 170     s->planeheight[0] = s->planeheight[3] = inlink->h;
 171
 172     s->nb_planes = av_pix_fmt_count_planes(inlink->format);
 173     s->nb_threads = ctx->graph->nb_threads;
 174     s->work_line = av_calloc(s->nb_threads, sizeof(*s->work_line));
 175     if (!s->work_line)
 176         return AVERROR(ENOMEM);
 177
 178     for (i = 0; i < s->nb_threads; i++) {
 179         s->work_line[i] = av_calloc(FFALIGN(s->linesize[0], 32), sizeof(*s->work_line[0]));
 180         if (!s->work_line[i])
 181             return AVERROR(ENOMEM);
 182     }
 183
 184     s->dsp.filter_simple_low   = filter_simple_low;
 185     s->dsp.filter_complex_low  = filter_complex_low;
 186     s->dsp.filter_simple_high  = filter_simple_high;
 187     s->dsp.filter_complex_high = filter_complex_high;
 188     s->dsp.filter_scale        = filter_scale;
 189
 190     if (ARCH_X86)
 191         ff_w3fdif_init_x86(&s->dsp);
 192
 193     return 0;
 194 }
 195
 196 static int config_output(AVFilterLink *outlink)
 197 {
 198     AVFilterLink *inlink = outlink->src->inputs[0];
 199
 200     outlink->time_base.num = inlink->time_base.num;
 201     outlink->time_base.den = inlink->time_base.den * 2;
 202     outlink->frame_rate.num = inlink->frame_rate.num * 2;
 203     outlink->frame_rate.den = inlink->frame_rate.den;
 204
 205     return 0;
 206 }
 207
 208 /*
 209  * Filter coefficients from PH-2071, scaled by 256 * 128.
 210  * Each set of coefficients has a set for low-frequencies and high-frequencies.
 211  * n_coef_lf[] and n_coef_hf[] are the number of coefs for simple and more-complex.
 212  * It is important for later that n_coef_lf[] is even and n_coef_hf[] is odd.
 213  * coef_lf[][] and coef_hf[][] are the coefficients for low-frequencies
 214  * and high-frequencies for simple and more-complex mode.
 215  */
 216 static const int8_t   n_coef_lf[2] = { 2, 4 };
 217 static const int16_t coef_lf[2][4] = {{ 16384, 16384,     0,    0},
 218                                       {  -852, 17236, 17236, -852}};
 219 static const int8_t   n_coef_hf[2] = { 3, 5 };
 220 static const int16_t coef_hf[2][5] = {{ -2048,  4096, -2048,     0,    0},
 221                                       {  1016, -3801,  5570, -3801, 1016}};
 222
 223 typedef struct ThreadData {
 224     AVFrame *out, *cur, *adj;
 225     int plane;
 226 } ThreadData;
 227
 228 static int deinterlace_slice(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
 229 {
 230     W3FDIFContext *s = ctx->priv;
 231     ThreadData *td = arg;
 232     AVFrame *out = td->out;
 233     AVFrame *cur = td->cur;
 234     AVFrame *adj = td->adj;
 235     const int plane = td->plane;
 236     const int filter = s->filter;
 237     uint8_t *in_line, *in_lines_cur[5], *in_lines_adj[5];
 238     uint8_t *out_line, *out_pixel;
 239     int32_t *work_line, *work_pixel;
 240     uint8_t *cur_data = cur->data[plane];
 241     uint8_t *adj_data = adj->data[plane];
 242     uint8_t *dst_data = out->data[plane];
 243     const int linesize = s->linesize[plane];
 244     const int height   = s->planeheight[plane];
 245     const int cur_line_stride = cur->linesize[plane];
 246     const int adj_line_stride = adj->linesize[plane];
 247     const int dst_line_stride = out->linesize[plane];
 248     const int start = (height * jobnr) / nb_jobs;
 249     const int end = (height * (jobnr+1)) / nb_jobs;
 250     int j, y_in, y_out;
 251
 252     /* copy unchanged the lines of the field */
 253     y_out = start + (s->field == cur->top_field_first) - (start & 1);
 254
 255     in_line  = cur_data + (y_out * cur_line_stride);
 256     out_line = dst_data + (y_out * dst_line_stride);
 257
 258     while (y_out < end) {
 259         memcpy(out_line, in_line, linesize);
 260         y_out += 2;
 261         in_line  += cur_line_stride * 2;
 262         out_line += dst_line_stride * 2;
 263     }
 264
 265     /* interpolate other lines of the field */
 266     y_out = start + (s->field != cur->top_field_first) - (start & 1);
 267
 268     out_line = dst_data + (y_out * dst_line_stride);
 269
 270     while (y_out < end) {
 271         /* get low vertical frequencies from current field */
 272         for (j = 0; j < n_coef_lf[filter]; j++) {
 273             y_in = (y_out + 1) + (j * 2) - n_coef_lf[filter];
 274
 275             while (y_in < 0)
 276                 y_in += 2;
 277             while (y_in >= height)
 278                 y_in -= 2;
 279
 280             in_lines_cur[j] = cur_data + (y_in * cur_line_stride);
 281         }
 282
 283         work_line = s->work_line[jobnr];
 284         switch (n_coef_lf[filter]) {
 285         case 2:
 286             s->dsp.filter_simple_low(work_line, in_lines_cur,
 287                                      coef_lf[filter], linesize);
 288             break;
 289         case 4:
 290             s->dsp.filter_complex_low(work_line, in_lines_cur,
 291                                       coef_lf[filter], linesize);
 292         }
 293
 294         /* get high vertical frequencies from adjacent fields */
 295         for (j = 0; j < n_coef_hf[filter]; j++) {
 296             y_in = (y_out + 1) + (j * 2) - n_coef_hf[filter];
 297
 298             while (y_in < 0)
 299                 y_in += 2;
 300             while (y_in >= height)
 301                 y_in -= 2;
 302
 303             in_lines_cur[j] = cur_data + (y_in * cur_line_stride);
 304             in_lines_adj[j] = adj_data + (y_in * adj_line_stride);
 305         }
 306
 307         work_line = s->work_line[jobnr];
 308         switch (n_coef_hf[filter]) {
 309         case 3:
 310             s->dsp.filter_simple_high(work_line, in_lines_cur, in_lines_adj,
 311                                       coef_hf[filter], linesize);
 312             break;
 313         case 5:
 314             s->dsp.filter_complex_high(work_line, in_lines_cur, in_lines_adj,
 315                                        coef_hf[filter], linesize);
 316         }
 317
 318         /* save scaled result to the output frame, scaling down by 256 * 128 */
 319         work_pixel = s->work_line[jobnr];
 320         out_pixel = out_line;
 321
 322         s->dsp.filter_scale(out_pixel, work_pixel, linesize);
 323
 324         /* move on to next line */
 325         y_out += 2;
 326         out_line += dst_line_stride * 2;
 327     }
 328
 329     return 0;
 330 }
 331
 332 static int filter(AVFilterContext *ctx, int is_second)
 333 {
 334     W3FDIFContext *s = ctx->priv;
 335     AVFilterLink *outlink = ctx->outputs[0];
 336     AVFrame *out, *adj;
 337     ThreadData td;
 338     int plane;
 339
 340     out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
 341     if (!out)
 342         return AVERROR(ENOMEM);
 343     av_frame_copy_props(out, s->cur);
 344     out->interlaced_frame = 0;
 345
 346     if (!is_second) {
 347         if (out->pts != AV_NOPTS_VALUE)
 348             out->pts *= 2;
 349     } else {
 350         int64_t cur_pts  = s->cur->pts;
 351         int64_t next_pts = s->next->pts;
 352
 353         if (next_pts != AV_NOPTS_VALUE && cur_pts != AV_NOPTS_VALUE) {
 354             out->pts = cur_pts + next_pts;
 355         } else {
 356             out->pts = AV_NOPTS_VALUE;
 357         }
 358     }
 359
 360     adj = s->field ? s->next : s->prev;
 361     td.out = out; td.cur = s->cur; td.adj = adj;
 362     for (plane = 0; plane < s->nb_planes; plane++) {
 363         td.plane = plane;
 364         ctx->internal->execute(ctx, deinterlace_slice, &td, NULL, FFMIN(s->planeheight[plane], s->nb_threads));
 365     }
 366
 367     s->field = !s->field;
 368
 369     return ff_filter_frame(outlink, out);
 370 }
 371
 372 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
 373 {
 374     AVFilterContext *ctx = inlink->dst;
 375     W3FDIFContext *s = ctx->priv;
 376     int ret;
 377
 378     av_frame_free(&s->prev);
 379     s->prev = s->cur;
 380     s->cur  = s->next;
 381     s->next = frame;
 382
 383     if (!s->cur) {
 384         s->cur = av_frame_clone(s->next);
 385         if (!s->cur)
 386             return AVERROR(ENOMEM);
 387     }
 388
 389     if ((s->deint && !s->cur->interlaced_frame) || ctx->is_disabled) {
 390         AVFrame *out = av_frame_clone(s->cur);
 391         if (!out)
 392             return AVERROR(ENOMEM);
 393
 394         av_frame_free(&s->prev);
 395         if (out->pts != AV_NOPTS_VALUE)
 396             out->pts *= 2;
 397         return ff_filter_frame(ctx->outputs[0], out);
 398     }
 399
 400     if (!s->prev)
 401         return 0;
 402
 403     ret = filter(ctx, 0);
 404     if (ret < 0)
 405         return ret;
 406
 407     return filter(ctx, 1);
 408 }
 409
 410 static int request_frame(AVFilterLink *outlink)
 411 {
 412     AVFilterContext *ctx = outlink->src;
 413     W3FDIFContext *s = ctx->priv;
 414     int ret;
 415
 416     if (s->eof)
 417         return AVERROR_EOF;
 418
 419     ret = ff_request_frame(ctx->inputs[0]);
 420
 421     if (ret == AVERROR_EOF && s->cur) {
 422         AVFrame *next = av_frame_clone(s->next);
 423         if (!next)
 424             return AVERROR(ENOMEM);
 425         next->pts = s->next->pts * 2 - s->cur->pts;
 426         filter_frame(ctx->inputs[0], next);
 427         s->eof = 1;
 428     } else if (ret < 0) {
 429         return ret;
 430     }
 431
 432     return 0;
 433 }
 434
 435 static av_cold void uninit(AVFilterContext *ctx)
 436 {
 437     W3FDIFContext *s = ctx->priv;
 438     int i;
 439
 440     av_frame_free(&s->prev);
 441     av_frame_free(&s->cur );
 442     av_frame_free(&s->next);
 443
 444     for (i = 0; i < s->nb_threads; i++)
 445         av_freep(&s->work_line[i]);
 446
 447     av_freep(&s->work_line);
 448 }
 449
 450 static const AVFilterPad w3fdif_inputs[] = {
 451     {
 452         .name          = "default",
 453         .type          = AVMEDIA_TYPE_VIDEO,
 454         .filter_frame  = filter_frame,
 455         .config_props  = config_input,
 456     },
 457     { NULL }
 458 };
 459
 460 static const AVFilterPad w3fdif_outputs[] = {
 461     {
 462         .name          = "default",
 463         .type          = AVMEDIA_TYPE_VIDEO,
 464         .config_props  = config_output,
 465         .request_frame = request_frame,
 466     },
 467     { NULL }
 468 };
 469
 470 AVFilter ff_vf_w3fdif = {
 471     .name          = "w3fdif",
 472     .description   = NULL_IF_CONFIG_SMALL("Apply Martin Weston three field deinterlace."),
 473     .priv_size     = sizeof(W3FDIFContext),
 474     .priv_class    = &w3fdif_class,
 475     .uninit        = uninit,
 476     .query_formats = query_formats,
 477     .inputs        = w3fdif_inputs,
 478     .outputs       = w3fdif_outputs,
 479     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL | AVFILTER_FLAG_SLICE_THREADS,
 480 };