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

   1 /*
   2  * Copyright (c) 2017 Paul B Mahol
   3  *
   4  * This file is part of FFmpeg.
   5  *
   6  * FFmpeg is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * FFmpeg is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with FFmpeg; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 /**
  22  * @file
  23  * Filter for reading closed captioning data (EIA-608).
  24  * See also https://en.wikipedia.org/wiki/EIA-608
  25  */
  26
  27 #include <string.h>
  28
  29 #include "libavutil/internal.h"
  30 #include "libavutil/opt.h"
  31 #include "libavutil/pixdesc.h"
  32 #include "libavutil/timestamp.h"
  33
  34 #include "avfilter.h"
  35 #include "formats.h"
  36 #include "internal.h"
  37 #include "video.h"
  38
  39 #define LAG 25
  40 #define SYNC_MIN 12.f
  41 #define SYNC_MAX 15.f
  42
  43 typedef struct CodeItem {
  44     uint8_t bit;
  45     int size;
  46 } CodeItem;
  47
  48 typedef struct ReadEIA608Context {
  49     const AVClass *class;
  50     int start, end;
  51     int nb_found;
  52     int white;
  53     int black;
  54     float spw;
  55     int chp;
  56     int lp;
  57
  58     uint64_t histogram[256];
  59
  60     uint8_t *temp;
  61     uint8_t *signal;
  62     CodeItem *code;
  63     float *unfiltered;
  64     float *filtered;
  65     float *avg_filter;
  66     float *std_filter;
  67 } ReadEIA608Context;
  68
  69 #define OFFSET(x) offsetof(ReadEIA608Context, x)
  70 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
  71
  72 static const AVOption readeia608_options[] = {
  73     { "scan_min", "set from which line to scan for codes",               OFFSET(start), AV_OPT_TYPE_INT,   {.i64=0},     0, INT_MAX, FLAGS },
  74     { "scan_max", "set to which line to scan for codes",                 OFFSET(end),   AV_OPT_TYPE_INT,   {.i64=29},    0, INT_MAX, FLAGS },
  75     { "spw",      "set ratio of width reserved for sync code detection", OFFSET(spw),   AV_OPT_TYPE_FLOAT, {.dbl=.27}, 0.1,     0.7, FLAGS },
  76     { "chp",      "check and apply parity bit",                          OFFSET(chp),   AV_OPT_TYPE_BOOL,  {.i64= 0},    0,       1, FLAGS },
  77     { "lp",       "lowpass line prior to processing",                    OFFSET(lp),    AV_OPT_TYPE_BOOL,  {.i64= 1},    0,       1, FLAGS },
  78     { NULL }
  79 };
  80
  81 AVFILTER_DEFINE_CLASS(readeia608);
  82
  83 static int query_formats(AVFilterContext *ctx)
  84 {
  85     static const enum AVPixelFormat pixel_fmts[] = {
  86         AV_PIX_FMT_GRAY8,
  87         AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV411P,
  88         AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P,
  89         AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV444P,
  90         AV_PIX_FMT_YUVJ420P, AV_PIX_FMT_YUVJ422P,
  91         AV_PIX_FMT_YUVJ440P, AV_PIX_FMT_YUVJ444P,
  92         AV_PIX_FMT_YUVJ411P,
  93         AV_PIX_FMT_NONE
  94     };
  95     AVFilterFormats *formats = ff_make_format_list(pixel_fmts);
  96     if (!formats)
  97         return AVERROR(ENOMEM);
  98     return ff_set_common_formats(ctx, formats);
  99 }
 100
 101 static int config_input(AVFilterLink *inlink)
 102 {
 103     AVFilterContext *ctx = inlink->dst;
 104     ReadEIA608Context *s = ctx->priv;
 105     int size = inlink->w + LAG;
 106
 107     if (s->end >= inlink->h) {
 108         av_log(ctx, AV_LOG_WARNING, "Last line to scan too large, clipping.\n");
 109         s->end = inlink->h - 1;
 110     }
 111
 112     if (s->start > s->end) {
 113         av_log(ctx, AV_LOG_ERROR, "Invalid range.\n");
 114         return AVERROR(EINVAL);
 115     }
 116
 117     s->unfiltered = av_calloc(size, sizeof(*s->unfiltered));
 118     s->filtered = av_calloc(size, sizeof(*s->filtered));
 119     s->avg_filter = av_calloc(size, sizeof(*s->avg_filter));
 120     s->std_filter = av_calloc(size, sizeof(*s->std_filter));
 121     s->signal = av_calloc(size, sizeof(*s->signal));
 122     s->code = av_calloc(size, sizeof(*s->code));
 123     s->temp = av_calloc(size, sizeof(*s->temp));
 124     if (!s->temp)
 125         return AVERROR(ENOMEM);
 126
 127     return 0;
 128 }
 129
 130 static void build_histogram(ReadEIA608Context *s, const uint8_t *src, int len)
 131 {
 132     memset(s->histogram, 0, sizeof(s->histogram));
 133
 134     for (int i = 0; i < len; i++)
 135         s->histogram[src[i]]++;
 136 }
 137
 138 static void find_black_and_white(ReadEIA608Context *s)
 139 {
 140     int start = 0, end = 0, middle;
 141     int black = 0, white = 0;
 142     int cnt;
 143
 144     for (int i = 0; i < 256; i++) {
 145         if (s->histogram[i]) {
 146             start = i;
 147             break;
 148         }
 149     }
 150
 151     for (int i = 255; i >= 0; i--) {
 152         if (s->histogram[i]) {
 153             end = i;
 154             break;
 155         }
 156     }
 157
 158     middle = start + (end - start) / 2;
 159
 160     cnt = 0;
 161     for (int i = start; i <= middle; i++) {
 162         if (s->histogram[i] > cnt) {
 163             cnt = s->histogram[i];
 164             black = i;
 165         }
 166     }
 167
 168     cnt = 0;
 169     for (int i = end; i >= middle; i--) {
 170         if (s->histogram[i] > cnt) {
 171             cnt = s->histogram[i];
 172             white = i;
 173         }
 174     }
 175
 176     s->black = black;
 177     s->white = white;
 178 }
 179
 180 static float meanf(float *data, int len)
 181 {
 182     float sum = 0.0, mean = 0.0;
 183
 184     for (int i = 0; i < len; i++)
 185         sum += data[i];
 186
 187     mean = sum / len;
 188
 189     return mean;
 190 }
 191
 192 static float stddevf(float *data, int len)
 193 {
 194     float m = meanf(data, len);
 195     float standard_deviation = 0.f;
 196
 197     for (int i = 0; i < len; i++)
 198         standard_deviation += (data[i] - m) * (data[i] - m);
 199
 200     return sqrtf(standard_deviation / (len - 1));
 201 }
 202
 203 static void thresholding(ReadEIA608Context *s, const uint8_t *y, uint8_t *signal,
 204                          float *unfiltered, float *filtered, float *avg_filter, float *std_filter,
 205                          int lag, float threshold, float influence, int len)
 206 {
 207     for (int i = lag; i < len + lag; i++) {
 208         unfiltered[i] = y[i - lag] / 255.f;
 209         filtered[i] = unfiltered[i];
 210     }
 211
 212     for (int i = 0; i < lag; i++) {
 213         unfiltered[i] = meanf(unfiltered, len * s->spw);
 214         filtered[i] = unfiltered[i];
 215     }
 216
 217     memset(signal, 0, len);
 218
 219     avg_filter[lag - 1] = meanf(unfiltered, lag);
 220     std_filter[lag - 1] = stddevf(unfiltered, lag);
 221
 222     for (int i = lag; i < len + lag; i++) {
 223         if (fabsf(unfiltered[i] - avg_filter[i-1]) > threshold * std_filter[i-1]) {
 224             if (unfiltered[i] > avg_filter[i-1]) {
 225                 signal[i - lag] = 255;
 226             } else {
 227                 signal[i - lag] = 0;
 228             }
 229             filtered[i] = influence * unfiltered[i] + (1.f - influence) * filtered[i-1];
 230         } else {
 231             int distance_from_black, distance_from_white;
 232
 233             distance_from_black = FFABS(y[i - lag] - s->black);
 234             distance_from_white = FFABS(y[i - lag] - s->white);
 235
 236             signal[i - lag] = distance_from_black <= distance_from_white ? 0 : 255;
 237         }
 238         avg_filter[i] = meanf(filtered + i - lag, lag);
 239         std_filter[i] = stddevf(filtered + i - lag, lag);
 240     }
 241 }
 242
 243 static int periods(const uint8_t *signal, CodeItem *code, int len)
 244 {
 245     int hold = signal[0], cnt = 0;
 246     int last = 0;
 247
 248     memset(code, 0, len * sizeof(*code));
 249
 250     for (int i = 1; i < len; i++) {
 251         if (signal[i] != hold) {
 252             code[cnt].size = i - last;
 253             code[cnt].bit = hold;
 254             hold = signal[i];
 255             last = i;
 256             cnt++;
 257         }
 258     }
 259
 260     code[cnt].size = len - last;
 261     code[cnt].bit = hold;
 262
 263     return cnt + 1;
 264 }
 265
 266 static void dump_code(AVFilterContext *ctx, int len, int item)
 267 {
 268     ReadEIA608Context *s = ctx->priv;
 269
 270     av_log(ctx, AV_LOG_DEBUG, "%d:", item);
 271     for (int i = 0; i < len; i++) {
 272         av_log(ctx, AV_LOG_DEBUG, " %03d", s->code[i].size);
 273     }
 274     av_log(ctx, AV_LOG_DEBUG, "\n");
 275 }
 276
 277 static void extract_line(AVFilterContext *ctx, AVFilterLink *inlink, AVFrame *in, int line)
 278 {
 279     ReadEIA608Context *s = ctx->priv;
 280     int i, j, ch, len;
 281     const uint8_t *src;
 282     uint8_t byte[2] = { 0 };
 283     uint8_t codes[19] = { 0 };
 284     float bit_size = 0.f;
 285     int parity;
 286
 287     src = &in->data[0][line * in->linesize[0]];
 288     if (s->lp) {
 289         uint8_t *dst = s->temp;
 290         int w = inlink->w - 1;
 291
 292         for (i = 0; i < inlink->w; i++) {
 293             int a = FFMAX(i - 3, 0);
 294             int b = FFMAX(i - 2, 0);
 295             int c = FFMAX(i - 1, 0);
 296             int d = FFMIN(i + 3, w);
 297             int e = FFMIN(i + 2, w);
 298             int f = FFMIN(i + 1, w);
 299
 300             dst[i] = (src[a] + src[b] + src[c] + src[i] + src[d] + src[e] + src[f] + 6) / 7;
 301         }
 302
 303         src = s->temp;
 304     }
 305
 306     build_histogram(s, src, inlink->w);
 307     find_black_and_white(s);
 308     if (s->white - s->black < 5)
 309         return;
 310
 311     thresholding(s, src, s->signal, s->unfiltered, s->filtered,
 312                  s->avg_filter, s->std_filter,
 313                  LAG, 1, 0, inlink->w);
 314     //memcpy(&in->data[0][line * in->linesize[0]], s->signal, inlink->w);
 315     len = periods(s->signal, s->code, inlink->w);
 316     dump_code(ctx, len, line);
 317     if (len < 15 ||
 318         s->code[14].bit != 0 ||
 319         inlink->w / (float)s->code[14].size < SYNC_MIN ||
 320         inlink->w / (float)s->code[14].size > SYNC_MAX) {
 321         return;
 322     }
 323
 324     for (i = 14; i < len; i++) {
 325         bit_size += s->code[i].size;
 326     }
 327
 328     bit_size /= 19.f;
 329     for (i = 1; i < 14; i++) {
 330         if (s->code[i].size > bit_size * 1.5f) {
 331             return;
 332         }
 333     }
 334
 335     if (s->code[15].size / bit_size < 0.45f) {
 336         return;
 337     }
 338
 339     for (j = 0, i = 14; i < len; i++) {
 340         int run, bit;
 341
 342         run = lrintf(s->code[i].size / bit_size);
 343         bit = s->code[i].bit;
 344
 345         for (int k = 0; j < 19 && k < run; k++) {
 346             codes[j++] = bit;
 347         }
 348
 349         if (j >= 19)
 350             break;
 351     }
 352
 353     for (ch = 0; ch < 2; ch++) {
 354         for (parity = 0, i = 0; i < 8; i++) {
 355             int b = codes[3 + ch * 8 + i];
 356
 357             if (b == 255) {
 358                 parity++;
 359                 b = 1;
 360             } else {
 361                 b = 0;
 362             }
 363             byte[ch] |= b << i;
 364         }
 365
 366         if (s->chp) {
 367             if (!(parity & 1)) {
 368                 byte[ch] = 0x7F;
 369             }
 370         }
 371     }
 372
 373     {
 374         uint8_t key[128], value[128];
 375
 376         //snprintf(key, sizeof(key), "lavfi.readeia608.%d.bits", s->nb_found);
 377         //snprintf(value, sizeof(value), "0b%d%d%d%d%d%d%d%d 0b%d%d%d%d%d%d%d%d", codes[3]==255,codes[4]==255,codes[5]==255,codes[6]==255,codes[7]==255,codes[8]==255,codes[9]==255,codes[10]==255,codes[11]==255,codes[12]==255,codes[13]==255,codes[14]==255,codes[15]==255,codes[16]==255,codes[17]==255,codes[18]==255);
 378         //av_dict_set(&in->metadata, key, value, 0);
 379
 380         snprintf(key, sizeof(key), "lavfi.readeia608.%d.cc", s->nb_found);
 381         snprintf(value, sizeof(value), "0x%02X%02X", byte[0], byte[1]);
 382         av_dict_set(&in->metadata, key, value, 0);
 383
 384         snprintf(key, sizeof(key), "lavfi.readeia608.%d.line", s->nb_found);
 385         snprintf(value, sizeof(value), "%d", line);
 386         av_dict_set(&in->metadata, key, value, 0);
 387     }
 388
 389     s->nb_found++;
 390 }
 391
 392 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
 393 {
 394     AVFilterContext *ctx  = inlink->dst;
 395     AVFilterLink *outlink = ctx->outputs[0];
 396     ReadEIA608Context *s = ctx->priv;
 397     int i;
 398
 399     s->nb_found = 0;
 400     for (i = s->start; i <= s->end; i++)
 401         extract_line(ctx, inlink, in, i);
 402
 403     return ff_filter_frame(outlink, in);
 404 }
 405
 406 static av_cold void uninit(AVFilterContext *ctx)
 407 {
 408     ReadEIA608Context *s = ctx->priv;
 409
 410     av_freep(&s->temp);
 411     av_freep(&s->code);
 412     av_freep(&s->signal);
 413     av_freep(&s->unfiltered);
 414     av_freep(&s->filtered);
 415     av_freep(&s->avg_filter);
 416     av_freep(&s->std_filter);
 417 }
 418
 419 static const AVFilterPad readeia608_inputs[] = {
 420     {
 421         .name         = "default",
 422         .type         = AVMEDIA_TYPE_VIDEO,
 423         .filter_frame = filter_frame,
 424         .config_props = config_input,
 425     },
 426     { NULL }
 427 };
 428
 429 static const AVFilterPad readeia608_outputs[] = {
 430     {
 431         .name = "default",
 432         .type = AVMEDIA_TYPE_VIDEO,
 433     },
 434     { NULL }
 435 };
 436
 437 AVFilter ff_vf_readeia608 = {
 438     .name          = "readeia608",
 439     .description   = NULL_IF_CONFIG_SMALL("Read EIA-608 Closed Caption codes from input video and write them to frame metadata."),
 440     .priv_size     = sizeof(ReadEIA608Context),
 441     .priv_class    = &readeia608_class,
 442     .query_formats = query_formats,
 443     .inputs        = readeia608_inputs,
 444     .outputs       = readeia608_outputs,
 445     .uninit        = uninit,
 446     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,
 447 };