2 * Copyright (c) 2017 Paul B Mahol
4 * This file is part of FFmpeg.
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.
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.
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
23 * Filter for reading closed captioning data (EIA-608).
24 * See also https://en.wikipedia.org/wiki/EIA-608
29 #include "libavutil/internal.h"
30 #include "libavutil/opt.h"
31 #include "libavutil/pixdesc.h"
32 #include "libavutil/timestamp.h"
43 typedef struct CodeItem {
48 typedef struct ReadEIA608Context {
58 uint64_t histogram[256];
69 #define OFFSET(x) offsetof(ReadEIA608Context, x)
70 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
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 },
81 AVFILTER_DEFINE_CLASS(readeia608);
83 static int query_formats(AVFilterContext *ctx)
85 static const enum AVPixelFormat pixel_fmts[] = {
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,
95 AVFilterFormats *formats = ff_make_format_list(pixel_fmts);
97 return AVERROR(ENOMEM);
98 return ff_set_common_formats(ctx, formats);
101 static int config_input(AVFilterLink *inlink)
103 AVFilterContext *ctx = inlink->dst;
104 ReadEIA608Context *s = ctx->priv;
105 int size = inlink->w + LAG;
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;
112 if (s->start > s->end) {
113 av_log(ctx, AV_LOG_ERROR, "Invalid range.\n");
114 return AVERROR(EINVAL);
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->unfiltered || !s->filtered || !s->avg_filter ||
125 !s->std_filter || !s->signal || !s->code || !s->temp)
126 return AVERROR(ENOMEM);
131 static void build_histogram(ReadEIA608Context *s, const uint8_t *src, int len)
133 memset(s->histogram, 0, sizeof(s->histogram));
135 for (int i = 0; i < len; i++)
136 s->histogram[src[i]]++;
139 static void find_black_and_white(ReadEIA608Context *s)
141 int start = 0, end = 0, middle;
142 int black = 0, white = 0;
145 for (int i = 0; i < 256; i++) {
146 if (s->histogram[i]) {
152 for (int i = 255; i >= 0; i--) {
153 if (s->histogram[i]) {
159 middle = start + (end - start) / 2;
162 for (int i = start; i <= middle; i++) {
163 if (s->histogram[i] > cnt) {
164 cnt = s->histogram[i];
170 for (int i = end; i >= middle; i--) {
171 if (s->histogram[i] > cnt) {
172 cnt = s->histogram[i];
181 static float meanf(float *data, int len)
183 float sum = 0.0, mean = 0.0;
185 for (int i = 0; i < len; i++)
193 static float stddevf(float *data, int len)
195 float m = meanf(data, len);
196 float standard_deviation = 0.f;
198 for (int i = 0; i < len; i++)
199 standard_deviation += (data[i] - m) * (data[i] - m);
201 return sqrtf(standard_deviation / (len - 1));
204 static void thresholding(ReadEIA608Context *s, const uint8_t *y, uint8_t *signal,
205 float *unfiltered, float *filtered, float *avg_filter, float *std_filter,
206 int lag, float threshold, float influence, int len)
208 for (int i = lag; i < len + lag; i++) {
209 unfiltered[i] = y[i - lag] / 255.f;
210 filtered[i] = unfiltered[i];
213 for (int i = 0; i < lag; i++) {
214 unfiltered[i] = meanf(unfiltered, len * s->spw);
215 filtered[i] = unfiltered[i];
218 memset(signal, 0, len);
220 avg_filter[lag - 1] = meanf(unfiltered, lag);
221 std_filter[lag - 1] = stddevf(unfiltered, lag);
223 for (int i = lag; i < len + lag; i++) {
224 if (fabsf(unfiltered[i] - avg_filter[i-1]) > threshold * std_filter[i-1]) {
225 if (unfiltered[i] > avg_filter[i-1]) {
226 signal[i - lag] = 255;
230 filtered[i] = influence * unfiltered[i] + (1.f - influence) * filtered[i-1];
232 int distance_from_black, distance_from_white;
234 distance_from_black = FFABS(y[i - lag] - s->black);
235 distance_from_white = FFABS(y[i - lag] - s->white);
237 signal[i - lag] = distance_from_black <= distance_from_white ? 0 : 255;
239 avg_filter[i] = meanf(filtered + i - lag, lag);
240 std_filter[i] = stddevf(filtered + i - lag, lag);
244 static int periods(const uint8_t *signal, CodeItem *code, int len)
246 int hold = signal[0], cnt = 0;
249 memset(code, 0, len * sizeof(*code));
251 for (int i = 1; i < len; i++) {
252 if (signal[i] != hold) {
253 code[cnt].size = i - last;
254 code[cnt].bit = hold;
261 code[cnt].size = len - last;
262 code[cnt].bit = hold;
267 static void dump_code(AVFilterContext *ctx, int len, int item)
269 ReadEIA608Context *s = ctx->priv;
271 av_log(ctx, AV_LOG_DEBUG, "%d:", item);
272 for (int i = 0; i < len; i++) {
273 av_log(ctx, AV_LOG_DEBUG, " %03d", s->code[i].size);
275 av_log(ctx, AV_LOG_DEBUG, "\n");
278 static void extract_line(AVFilterContext *ctx, AVFilterLink *inlink, AVFrame *in, int line)
280 ReadEIA608Context *s = ctx->priv;
283 uint8_t byte[2] = { 0 };
284 uint8_t codes[19] = { 0 };
285 float bit_size = 0.f;
288 src = &in->data[0][line * in->linesize[0]];
290 uint8_t *dst = s->temp;
291 int w = inlink->w - 1;
293 for (i = 0; i < inlink->w; i++) {
294 int a = FFMAX(i - 3, 0);
295 int b = FFMAX(i - 2, 0);
296 int c = FFMAX(i - 1, 0);
297 int d = FFMIN(i + 3, w);
298 int e = FFMIN(i + 2, w);
299 int f = FFMIN(i + 1, w);
301 dst[i] = (src[a] + src[b] + src[c] + src[i] + src[d] + src[e] + src[f] + 6) / 7;
307 build_histogram(s, src, inlink->w);
308 find_black_and_white(s);
309 if (s->white - s->black < 5)
312 thresholding(s, src, s->signal, s->unfiltered, s->filtered,
313 s->avg_filter, s->std_filter,
314 LAG, 1, 0, inlink->w);
315 //memcpy(&in->data[0][line * in->linesize[0]], s->signal, inlink->w);
316 len = periods(s->signal, s->code, inlink->w);
317 dump_code(ctx, len, line);
319 s->code[14].bit != 0 ||
320 inlink->w / (float)s->code[14].size < SYNC_MIN ||
321 inlink->w / (float)s->code[14].size > SYNC_MAX) {
325 for (i = 14; i < len; i++) {
326 bit_size += s->code[i].size;
330 for (i = 1; i < 14; i++) {
331 if (s->code[i].size > bit_size * 1.5f) {
336 if (s->code[15].size / bit_size < 0.45f) {
340 for (j = 0, i = 14; i < len; i++) {
343 run = lrintf(s->code[i].size / bit_size);
344 bit = s->code[i].bit;
346 for (int k = 0; j < 19 && k < run; k++) {
354 for (ch = 0; ch < 2; ch++) {
355 for (parity = 0, i = 0; i < 8; i++) {
356 int b = codes[3 + ch * 8 + i];
375 uint8_t key[128], value[128];
377 //snprintf(key, sizeof(key), "lavfi.readeia608.%d.bits", s->nb_found);
378 //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);
379 //av_dict_set(&in->metadata, key, value, 0);
381 snprintf(key, sizeof(key), "lavfi.readeia608.%d.cc", s->nb_found);
382 snprintf(value, sizeof(value), "0x%02X%02X", byte[0], byte[1]);
383 av_dict_set(&in->metadata, key, value, 0);
385 snprintf(key, sizeof(key), "lavfi.readeia608.%d.line", s->nb_found);
386 snprintf(value, sizeof(value), "%d", line);
387 av_dict_set(&in->metadata, key, value, 0);
393 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
395 AVFilterContext *ctx = inlink->dst;
396 AVFilterLink *outlink = ctx->outputs[0];
397 ReadEIA608Context *s = ctx->priv;
401 for (i = s->start; i <= s->end; i++)
402 extract_line(ctx, inlink, in, i);
404 return ff_filter_frame(outlink, in);
407 static av_cold void uninit(AVFilterContext *ctx)
409 ReadEIA608Context *s = ctx->priv;
413 av_freep(&s->signal);
414 av_freep(&s->unfiltered);
415 av_freep(&s->filtered);
416 av_freep(&s->avg_filter);
417 av_freep(&s->std_filter);
420 static const AVFilterPad readeia608_inputs[] = {
423 .type = AVMEDIA_TYPE_VIDEO,
424 .filter_frame = filter_frame,
425 .config_props = config_input,
430 static const AVFilterPad readeia608_outputs[] = {
433 .type = AVMEDIA_TYPE_VIDEO,
438 AVFilter ff_vf_readeia608 = {
439 .name = "readeia608",
440 .description = NULL_IF_CONFIG_SMALL("Read EIA-608 Closed Caption codes from input video and write them to frame metadata."),
441 .priv_size = sizeof(ReadEIA608Context),
442 .priv_class = &readeia608_class,
443 .query_formats = query_formats,
444 .inputs = readeia608_inputs,
445 .outputs = readeia608_outputs,
447 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,