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
  33 typedef struct W3FDIFContext {
  34     const AVClass *class;
  35     int filter;           ///< 0 is simple, 1 is more complex
  36     int deint;            ///< which frames to deinterlace
  37     int linesize[4];      ///< bytes of pixel data per line for each plane
  38     int planeheight[4];   ///< height of each plane
  39     int field;            ///< which field are we on, 0 or 1
  40     int eof;
  41     int nb_planes;
  42     AVFrame *prev, *cur, *next;  ///< previous, current, next frames
  43     int32_t **work_line;  ///< lines we are calculating
  44     int nb_threads;
  45 } W3FDIFContext;
  46
  47 #define OFFSET(x) offsetof(W3FDIFContext, x)
  48 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
  49 #define CONST(name, help, val, unit) { name, help, 0, AV_OPT_TYPE_CONST, {.i64=val}, 0, 0, FLAGS, unit }
  50
  51 static const AVOption w3fdif_options[] = {
  52     { "filter", "specify the filter", OFFSET(filter), AV_OPT_TYPE_INT, {.i64=1}, 0, 1, FLAGS, "filter" },
  53     CONST("simple",  NULL, 0, "filter"),
  54     CONST("complex", NULL, 1, "filter"),
  55     { "deint",  "specify which frames to deinterlace", OFFSET(deint), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS, "deint" },
  56     CONST("all",        "deinterlace all frames",                       0, "deint"),
  57     CONST("interlaced", "only deinterlace frames marked as interlaced", 1, "deint"),
  58     { NULL }
  59 };
  60
  61 AVFILTER_DEFINE_CLASS(w3fdif);
  62
  63 static int query_formats(AVFilterContext *ctx)
  64 {
  65     static const enum AVPixelFormat pix_fmts[] = {
  66         AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV411P,
  67         AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P,
  68         AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV444P,
  69         AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ440P,
  70         AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
  71         AV_PIX_FMT_YUVJ411P,
  72         AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA444P,
  73         AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRAP,
  74         AV_PIX_FMT_GRAY8,
  75         AV_PIX_FMT_NONE
  76     };
  77
  78     AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
  79     if (!fmts_list)
  80         return AVERROR(ENOMEM);
  81     return ff_set_common_formats(ctx, fmts_list);
  82 }
  83
  84 static int config_input(AVFilterLink *inlink)
  85 {
  86     AVFilterContext *ctx = inlink->dst;
  87     W3FDIFContext *s = ctx->priv;
  88     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
  89     int ret, i;
  90
  91     if ((ret = av_image_fill_linesizes(s->linesize, inlink->format, inlink->w)) < 0)
  92         return ret;
  93
  94     s->planeheight[1] = s->planeheight[2] = FF_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
  95     s->planeheight[0] = s->planeheight[3] = inlink->h;
  96
  97     s->nb_planes = av_pix_fmt_count_planes(inlink->format);
  98     s->nb_threads = ctx->graph->nb_threads;
  99     s->work_line = av_calloc(s->nb_threads, sizeof(*s->work_line));
 100     if (!s->work_line)
 101         return AVERROR(ENOMEM);
 102
 103     for (i = 0; i < s->nb_threads; i++) {
 104         s->work_line[i] = av_calloc(s->linesize[0], sizeof(*s->work_line[0]));
 105         if (!s->work_line[i])
 106             return AVERROR(ENOMEM);
 107     }
 108
 109     return 0;
 110 }
 111
 112 static int config_output(AVFilterLink *outlink)
 113 {
 114     AVFilterLink *inlink = outlink->src->inputs[0];
 115
 116     outlink->time_base.num = inlink->time_base.num;
 117     outlink->time_base.den = inlink->time_base.den * 2;
 118     outlink->frame_rate.num = inlink->frame_rate.num * 2;
 119     outlink->frame_rate.den = inlink->frame_rate.den;
 120     outlink->flags |= FF_LINK_FLAG_REQUEST_LOOP;
 121
 122     return 0;
 123 }
 124
 125 /*
 126  * Filter coefficients from PH-2071, scaled by 256 * 256.
 127  * Each set of coefficients has a set for low-frequencies and high-frequencies.
 128  * n_coef_lf[] and n_coef_hf[] are the number of coefs for simple and more-complex.
 129  * It is important for later that n_coef_lf[] is even and n_coef_hf[] is odd.
 130  * coef_lf[][] and coef_hf[][] are the coefficients for low-frequencies
 131  * and high-frequencies for simple and more-complex mode.
 132  */
 133 static const int8_t   n_coef_lf[2] = { 2, 4 };
 134 static const int32_t coef_lf[2][4] = {{ 32768, 32768,     0,     0},
 135                                       { -1704, 34472, 34472, -1704}};
 136 static const int8_t   n_coef_hf[2] = { 3, 5 };
 137 static const int32_t coef_hf[2][5] = {{ -4096,  8192, -4096,     0,     0},
 138                                       {  2032, -7602, 11140, -7602,  2032}};
 139
 140 typedef struct ThreadData {
 141     AVFrame *out, *cur, *adj;
 142     int plane;
 143 } ThreadData;
 144
 145 static int deinterlace_slice(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
 146 {
 147     W3FDIFContext *s = ctx->priv;
 148     ThreadData *td = arg;
 149     AVFrame *out = td->out;
 150     AVFrame *cur = td->cur;
 151     AVFrame *adj = td->adj;
 152     const int plane = td->plane;
 153     const int filter = s->filter;
 154     uint8_t *in_line, *in_lines_cur[5], *in_lines_adj[5];
 155     uint8_t *out_line, *out_pixel;
 156     int32_t *work_line, *work_pixel;
 157     uint8_t *cur_data = cur->data[plane];
 158     uint8_t *adj_data = adj->data[plane];
 159     uint8_t *dst_data = out->data[plane];
 160     const int linesize = s->linesize[plane];
 161     const int height   = s->planeheight[plane];
 162     const int cur_line_stride = cur->linesize[plane];
 163     const int adj_line_stride = adj->linesize[plane];
 164     const int dst_line_stride = out->linesize[plane];
 165     const int start = (height * jobnr) / nb_jobs;
 166     const int end = (height * (jobnr+1)) / nb_jobs;
 167     int i, j, y_in, y_out;
 168
 169     /* copy unchanged the lines of the field */
 170     y_out = start + (s->field == cur->top_field_first) - (start & 1);
 171
 172     in_line  = cur_data + (y_out * cur_line_stride);
 173     out_line = dst_data + (y_out * dst_line_stride);
 174
 175     while (y_out < end) {
 176         memcpy(out_line, in_line, linesize);
 177         y_out += 2;
 178         in_line  += cur_line_stride * 2;
 179         out_line += dst_line_stride * 2;
 180     }
 181
 182     /* interpolate other lines of the field */
 183     y_out = start + (s->field != cur->top_field_first) - (start & 1);
 184
 185     out_line = dst_data + (y_out * dst_line_stride);
 186
 187     while (y_out < end) {
 188         /* clear workspace */
 189         memset(s->work_line[jobnr], 0, sizeof(*s->work_line[jobnr]) * linesize);
 190
 191         /* get low vertical frequencies from current field */
 192         for (j = 0; j < n_coef_lf[filter]; j++) {
 193             y_in = (y_out + 1) + (j * 2) - n_coef_lf[filter];
 194
 195             while (y_in < 0)
 196                 y_in += 2;
 197             while (y_in >= height)
 198                 y_in -= 2;
 199
 200             in_lines_cur[j] = cur_data + (y_in * cur_line_stride);
 201         }
 202
 203         work_line = s->work_line[jobnr];
 204         switch (n_coef_lf[filter]) {
 205         case 2:
 206             for (i = 0; i < linesize; i++) {
 207                 *work_line   += *in_lines_cur[0]++ * coef_lf[filter][0];
 208                 *work_line++ += *in_lines_cur[1]++ * coef_lf[filter][1];
 209             }
 210             break;
 211         case 4:
 212             for (i = 0; i < linesize; i++) {
 213                 *work_line   += *in_lines_cur[0]++ * coef_lf[filter][0];
 214                 *work_line   += *in_lines_cur[1]++ * coef_lf[filter][1];
 215                 *work_line   += *in_lines_cur[2]++ * coef_lf[filter][2];
 216                 *work_line++ += *in_lines_cur[3]++ * coef_lf[filter][3];
 217             }
 218         }
 219
 220         /* get high vertical frequencies from adjacent fields */
 221         for (j = 0; j < n_coef_hf[filter]; j++) {
 222             y_in = (y_out + 1) + (j * 2) - n_coef_hf[filter];
 223
 224             while (y_in < 0)
 225                 y_in += 2;
 226             while (y_in >= height)
 227                 y_in -= 2;
 228
 229             in_lines_cur[j] = cur_data + (y_in * cur_line_stride);
 230             in_lines_adj[j] = adj_data + (y_in * adj_line_stride);
 231         }
 232
 233         work_line = s->work_line[jobnr];
 234         switch (n_coef_hf[filter]) {
 235         case 3:
 236             for (i = 0; i < linesize; i++) {
 237                 *work_line   += *in_lines_cur[0]++ * coef_hf[filter][0];
 238                 *work_line   += *in_lines_adj[0]++ * coef_hf[filter][0];
 239                 *work_line   += *in_lines_cur[1]++ * coef_hf[filter][1];
 240                 *work_line   += *in_lines_adj[1]++ * coef_hf[filter][1];
 241                 *work_line   += *in_lines_cur[2]++ * coef_hf[filter][2];
 242                 *work_line++ += *in_lines_adj[2]++ * coef_hf[filter][2];
 243             }
 244             break;
 245         case 5:
 246             for (i = 0; i < linesize; i++) {
 247                 *work_line   += *in_lines_cur[0]++ * coef_hf[filter][0];
 248                 *work_line   += *in_lines_adj[0]++ * coef_hf[filter][0];
 249                 *work_line   += *in_lines_cur[1]++ * coef_hf[filter][1];
 250                 *work_line   += *in_lines_adj[1]++ * coef_hf[filter][1];
 251                 *work_line   += *in_lines_cur[2]++ * coef_hf[filter][2];
 252                 *work_line   += *in_lines_adj[2]++ * coef_hf[filter][2];
 253                 *work_line   += *in_lines_cur[3]++ * coef_hf[filter][3];
 254                 *work_line   += *in_lines_adj[3]++ * coef_hf[filter][3];
 255                 *work_line   += *in_lines_cur[4]++ * coef_hf[filter][4];
 256                 *work_line++ += *in_lines_adj[4]++ * coef_hf[filter][4];
 257             }
 258         }
 259
 260         /* save scaled result to the output frame, scaling down by 256 * 256 */
 261         work_pixel = s->work_line[jobnr];
 262         out_pixel = out_line;
 263
 264         for (j = 0; j < linesize; j++, out_pixel++, work_pixel++)
 265              *out_pixel = av_clip(*work_pixel, 0, 255 * 256 * 256) >> 16;
 266
 267         /* move on to next line */
 268         y_out += 2;
 269         out_line += dst_line_stride * 2;
 270     }
 271
 272     return 0;
 273 }
 274
 275 static int filter(AVFilterContext *ctx, int is_second)
 276 {
 277     W3FDIFContext *s = ctx->priv;
 278     AVFilterLink *outlink = ctx->outputs[0];
 279     AVFrame *out, *adj;
 280     ThreadData td;
 281     int plane;
 282
 283     out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
 284     if (!out)
 285         return AVERROR(ENOMEM);
 286     av_frame_copy_props(out, s->cur);
 287     out->interlaced_frame = 0;
 288
 289     if (!is_second) {
 290         if (out->pts != AV_NOPTS_VALUE)
 291             out->pts *= 2;
 292     } else {
 293         int64_t cur_pts  = s->cur->pts;
 294         int64_t next_pts = s->next->pts;
 295
 296         if (next_pts != AV_NOPTS_VALUE && cur_pts != AV_NOPTS_VALUE) {
 297             out->pts = cur_pts + next_pts;
 298         } else {
 299             out->pts = AV_NOPTS_VALUE;
 300         }
 301     }
 302
 303     adj = s->field ? s->next : s->prev;
 304     td.out = out; td.cur = s->cur; td.adj = adj;
 305     for (plane = 0; plane < s->nb_planes; plane++) {
 306         td.plane = plane;
 307         ctx->internal->execute(ctx, deinterlace_slice, &td, NULL, FFMIN(s->planeheight[plane], s->nb_threads));
 308     }
 309
 310     s->field = !s->field;
 311
 312     return ff_filter_frame(outlink, out);
 313 }
 314
 315 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
 316 {
 317     AVFilterContext *ctx = inlink->dst;
 318     W3FDIFContext *s = ctx->priv;
 319     int ret;
 320
 321     av_frame_free(&s->prev);
 322     s->prev = s->cur;
 323     s->cur  = s->next;
 324     s->next = frame;
 325
 326     if (!s->cur) {
 327         s->cur = av_frame_clone(s->next);
 328         if (!s->cur)
 329             return AVERROR(ENOMEM);
 330     }
 331
 332     if ((s->deint && !s->cur->interlaced_frame) || ctx->is_disabled) {
 333         AVFrame *out = av_frame_clone(s->cur);
 334         if (!out)
 335             return AVERROR(ENOMEM);
 336
 337         av_frame_free(&s->prev);
 338         if (out->pts != AV_NOPTS_VALUE)
 339             out->pts *= 2;
 340         return ff_filter_frame(ctx->outputs[0], out);
 341     }
 342
 343     if (!s->prev)
 344         return 0;
 345
 346     ret = filter(ctx, 0);
 347     if (ret < 0)
 348         return ret;
 349
 350     return filter(ctx, 1);
 351 }
 352
 353 static int request_frame(AVFilterLink *outlink)
 354 {
 355     AVFilterContext *ctx = outlink->src;
 356     W3FDIFContext *s = ctx->priv;
 357
 358     do {
 359         int ret;
 360
 361         if (s->eof)
 362             return AVERROR_EOF;
 363
 364         ret = ff_request_frame(ctx->inputs[0]);
 365
 366         if (ret == AVERROR_EOF && s->cur) {
 367             AVFrame *next = av_frame_clone(s->next);
 368             if (!next)
 369                 return AVERROR(ENOMEM);
 370             next->pts = s->next->pts * 2 - s->cur->pts;
 371             filter_frame(ctx->inputs[0], next);
 372             s->eof = 1;
 373         } else if (ret < 0) {
 374             return ret;
 375         }
 376     } while (!s->cur);
 377
 378     return 0;
 379 }
 380
 381 static av_cold void uninit(AVFilterContext *ctx)
 382 {
 383     W3FDIFContext *s = ctx->priv;
 384     int i;
 385
 386     av_frame_free(&s->prev);
 387     av_frame_free(&s->cur );
 388     av_frame_free(&s->next);
 389
 390     for (i = 0; i < s->nb_threads; i++)
 391         av_freep(&s->work_line[i]);
 392
 393     av_freep(&s->work_line);
 394 }
 395
 396 static const AVFilterPad w3fdif_inputs[] = {
 397     {
 398         .name          = "default",
 399         .type          = AVMEDIA_TYPE_VIDEO,
 400         .filter_frame  = filter_frame,
 401         .config_props  = config_input,
 402     },
 403     { NULL }
 404 };
 405
 406 static const AVFilterPad w3fdif_outputs[] = {
 407     {
 408         .name          = "default",
 409         .type          = AVMEDIA_TYPE_VIDEO,
 410         .config_props  = config_output,
 411         .request_frame = request_frame,
 412     },
 413     { NULL }
 414 };
 415
 416 AVFilter ff_vf_w3fdif = {
 417     .name          = "w3fdif",
 418     .description   = NULL_IF_CONFIG_SMALL("Apply Martin Weston three field deinterlace."),
 419     .priv_size     = sizeof(W3FDIFContext),
 420     .priv_class    = &w3fdif_class,
 421     .uninit        = uninit,
 422     .query_formats = query_formats,
 423     .inputs        = w3fdif_inputs,
 424     .outputs       = w3fdif_outputs,
 425     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL | AVFILTER_FLAG_SLICE_THREADS,
 426 };