FFmpeg
vf_ocr.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 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 #include <tesseract/capi.h>
22 
23 #include "libavutil/opt.h"
24 #include "avfilter.h"
25 #include "formats.h"
26 #include "internal.h"
27 #include "video.h"
28 
29 typedef struct OCRContext {
30  const AVClass *class;
31 
32  char *datapath;
33  char *language;
34  char *whitelist;
35  char *blacklist;
36 
37  TessBaseAPI *tess;
38 } OCRContext;
39 
40 #define OFFSET(x) offsetof(OCRContext, x)
41 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
42 
43 static const AVOption ocr_options[] = {
44  { "datapath", "set datapath", OFFSET(datapath), AV_OPT_TYPE_STRING, {.str=NULL}, 0, 0, FLAGS },
45  { "language", "set language", OFFSET(language), AV_OPT_TYPE_STRING, {.str="eng"}, 0, 0, FLAGS },
46  { "whitelist", "set character whitelist", OFFSET(whitelist), AV_OPT_TYPE_STRING, {.str="0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.:;,-+_!?\"'[]{}()<>|/\\=*&%$#@!~ "}, 0, 0, FLAGS },
47  { "blacklist", "set character blacklist", OFFSET(blacklist), AV_OPT_TYPE_STRING, {.str=""}, 0, 0, FLAGS },
48  { NULL }
49 };
50 
52 {
53  OCRContext *s = ctx->priv;
54 
55  s->tess = TessBaseAPICreate();
56  if (TessBaseAPIInit3(s->tess, s->datapath, s->language) == -1) {
57  av_log(ctx, AV_LOG_ERROR, "failed to init tesseract\n");
58  return AVERROR(EINVAL);
59  }
60 
61  if (!TessBaseAPISetVariable(s->tess, "tessedit_char_whitelist", s->whitelist)) {
62  av_log(ctx, AV_LOG_ERROR, "failed to set whitelist\n");
63  return AVERROR(EINVAL);
64  }
65 
66  if (!TessBaseAPISetVariable(s->tess, "tessedit_char_blacklist", s->blacklist)) {
67  av_log(ctx, AV_LOG_ERROR, "failed to set blacklist\n");
68  return AVERROR(EINVAL);
69  }
70 
71  av_log(ctx, AV_LOG_DEBUG, "Tesseract version: %s\n", TessVersion());
72 
73  return 0;
74 }
75 
77 {
78  static const enum AVPixelFormat pix_fmts[] = {
88  };
89 
91  if (!fmts_list)
92  return AVERROR(ENOMEM);
93  return ff_set_common_formats(ctx, fmts_list);
94 }
95 
97 {
98  AVDictionary **metadata = &in->metadata;
99  AVFilterContext *ctx = inlink->dst;
100  AVFilterLink *outlink = ctx->outputs[0];
101  OCRContext *s = ctx->priv;
102  char *result;
103  int *confs;
104 
105  result = TessBaseAPIRect(s->tess, in->data[0], 1,
106  in->linesize[0], 0, 0, in->width, in->height);
107  confs = TessBaseAPIAllWordConfidences(s->tess);
108  av_dict_set(metadata, "lavfi.ocr.text", result, 0);
109  for (int i = 0; confs[i] != -1; i++) {
110  char number[256];
111 
112  snprintf(number, sizeof(number), "%d ", confs[i]);
113  av_dict_set(metadata, "lavfi.ocr.confidence", number, AV_DICT_APPEND);
114  }
115 
116  TessDeleteText(result);
117  TessDeleteIntArray(confs);
118 
119  return ff_filter_frame(outlink, in);
120 }
121 
123 {
124  OCRContext *s = ctx->priv;
125 
126  TessBaseAPIEnd(s->tess);
127  TessBaseAPIDelete(s->tess);
128 }
129 
131 
132 static const AVFilterPad ocr_inputs[] = {
133  {
134  .name = "default",
135  .type = AVMEDIA_TYPE_VIDEO,
136  .filter_frame = filter_frame,
137  },
138  { NULL }
139 };
140 
141 static const AVFilterPad ocr_outputs[] = {
142  {
143  .name = "default",
144  .type = AVMEDIA_TYPE_VIDEO,
145  },
146  { NULL }
147 };
148 
150  .name = "ocr",
151  .description = NULL_IF_CONFIG_SMALL("Optical Character Recognition."),
152  .priv_size = sizeof(OCRContext),
153  .priv_class = &ocr_class,
155  .init = init,
156  .uninit = uninit,
157  .inputs = ocr_inputs,
158  .outputs = ocr_outputs,
159 };
AVPixelFormat
AVPixelFormat
Pixel format.
Definition: pixfmt.h:64
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
opt.h
ff_make_format_list
AVFilterFormats * ff_make_format_list(const int *fmts)
Create a list of supported formats.
Definition: formats.c:286
init
static av_cold int init(AVFilterContext *ctx)
Definition: vf_ocr.c:51
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:978
inlink
The exact code depends on how similar the blocks are and how related they are to the and needs to apply these operations to the correct inlink or outlink if there are several Macros are available to factor that when no extra processing is inlink
Definition: filter_design.txt:212
OCRContext::tess
TessBaseAPI * tess
Definition: vf_ocr.c:37
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: vf_ocr.c:122
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:303
AVFrame::width
int width
Definition: frame.h:361
AVOption
AVOption.
Definition: opt.h:247
AV_DICT_APPEND
#define AV_DICT_APPEND
If the entry already exists, append to it.
Definition: dict.h:75
AV_PIX_FMT_YUV440P
@ AV_PIX_FMT_YUV440P
planar YUV 4:4:0 (1 Cr & Cb sample per 1x2 Y samples)
Definition: pixfmt.h:99
AVDictionary
Definition: dict.c:30
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:149
query_formats
static int query_formats(AVFilterContext *ctx)
Definition: vf_ocr.c:76
video.h
FLAGS
#define FLAGS
Definition: vf_ocr.c:41
ocr_outputs
static const AVFilterPad ocr_outputs[]
Definition: vf_ocr.c:141
AVFrame::data
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:317
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(ocr)
AVFilterFormats
A list of supported formats for one end of a filter link.
Definition: formats.h:64
formats.h
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:54
AV_PIX_FMT_YUVJ411P
@ AV_PIX_FMT_YUVJ411P
planar YUV 4:1:1, 12bpp, (1 Cr & Cb sample per 4x1 Y samples) full scale (JPEG), deprecated in favor ...
Definition: pixfmt.h:248
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
av_cold
#define av_cold
Definition: attributes.h:90
inputs
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several inputs
Definition: filter_design.txt:243
OCRContext::datapath
char * datapath
Definition: vf_ocr.c:32
ff_set_common_formats
int ff_set_common_formats(AVFilterContext *ctx, AVFilterFormats *formats)
A helper for query_formats() which sets all links to the same list of formats.
Definition: formats.c:580
AV_PIX_FMT_YUVJ422P
@ AV_PIX_FMT_YUVJ422P
planar YUV 4:2:2, 16bpp, full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV422P and setting col...
Definition: pixfmt.h:79
s
#define s(width, name)
Definition: cbs_vp9.c:257
AV_PIX_FMT_YUVA420P
@ AV_PIX_FMT_YUVA420P
planar YUV 4:2:0, 20bpp, (1 Cr & Cb sample per 2x2 Y & A samples)
Definition: pixfmt.h:101
outputs
static const AVFilterPad outputs[]
Definition: af_acontrast.c:203
pix_fmts
static enum AVPixelFormat pix_fmts[]
Definition: libkvazaar.c:290
AV_LOG_DEBUG
#define AV_LOG_DEBUG
Stuff which is only useful for libav* developers.
Definition: log.h:201
ctx
AVFormatContext * ctx
Definition: movenc.c:48
AV_PIX_FMT_YUV420P
@ AV_PIX_FMT_YUV420P
planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
Definition: pixfmt.h:66
AV_PIX_FMT_YUVJ444P
@ AV_PIX_FMT_YUVJ444P
planar YUV 4:4:4, 24bpp, full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV444P and setting col...
Definition: pixfmt.h:80
OCRContext::blacklist
char * blacklist
Definition: vf_ocr.c:35
ocr_inputs
static const AVFilterPad ocr_inputs[]
Definition: vf_ocr.c:132
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
result
and forward the result(frame or status change) to the corresponding input. If nothing is possible
NULL
#define NULL
Definition: coverity.c:32
AV_PIX_FMT_YUVJ420P
@ AV_PIX_FMT_YUVJ420P
planar YUV 4:2:0, 12bpp, full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV420P and setting col...
Definition: pixfmt.h:78
AV_PIX_FMT_GRAY8
@ AV_PIX_FMT_GRAY8
Y , 8bpp.
Definition: pixfmt.h:74
ff_vf_ocr
const AVFilter ff_vf_ocr
Definition: vf_ocr.c:149
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:116
filter_frame
static int filter_frame(AVFilterLink *inlink, AVFrame *in)
Definition: vf_ocr.c:96
AV_PIX_FMT_YUVA444P
@ AV_PIX_FMT_YUVA444P
planar YUV 4:4:4 32bpp, (1 Cr & Cb sample per 1x1 Y & A samples)
Definition: pixfmt.h:167
OCRContext
Definition: vf_ocr.c:29
internal.h
i
int i
Definition: input.c:406
AV_PIX_FMT_YUVJ440P
@ AV_PIX_FMT_YUVJ440P
planar YUV 4:4:0 full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV440P and setting color_range
Definition: pixfmt.h:100
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:60
AVFilter
Filter definition.
Definition: avfilter.h:145
language
Undefined Behavior In the C language
Definition: undefined.txt:3
OCRContext::whitelist
char * whitelist
Definition: vf_ocr.c:34
OFFSET
#define OFFSET(x)
Definition: vf_ocr.c:40
OCRContext::language
char * language
Definition: vf_ocr.c:33
AVFrame::height
int height
Definition: frame.h:361
AV_PIX_FMT_NONE
@ AV_PIX_FMT_NONE
Definition: pixfmt.h:65
avfilter.h
AVFrame::metadata
AVDictionary * metadata
metadata.
Definition: frame.h:572
ocr_options
static const AVOption ocr_options[]
Definition: vf_ocr.c:43
AV_PIX_FMT_YUV444P
@ AV_PIX_FMT_YUV444P
planar YUV 4:4:4, 24bpp, (1 Cr & Cb sample per 1x1 Y samples)
Definition: pixfmt.h:71
AVFilterContext
An instance of a filter.
Definition: avfilter.h:333
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
AV_PIX_FMT_YUV422P
@ AV_PIX_FMT_YUV422P
planar YUV 4:2:2, 16bpp, (1 Cr & Cb sample per 2x1 Y samples)
Definition: pixfmt.h:70
av_dict_set
int av_dict_set(AVDictionary **pm, const char *key, const char *value, int flags)
Set the given entry in *pm, overwriting an existing entry.
Definition: dict.c:70
AV_PIX_FMT_YUV411P
@ AV_PIX_FMT_YUV411P
planar YUV 4:1:1, 12bpp, (1 Cr & Cb sample per 4x1 Y samples)
Definition: pixfmt.h:73
AVFrame::linesize
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:334
AV_PIX_FMT_YUV410P
@ AV_PIX_FMT_YUV410P
planar YUV 4:1:0, 9bpp, (1 Cr & Cb sample per 4x4 Y samples)
Definition: pixfmt.h:72
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:28
AV_OPT_TYPE_STRING
@ AV_OPT_TYPE_STRING
Definition: opt.h:228
snprintf
#define snprintf
Definition: snprintf.h:34
AV_PIX_FMT_YUVA422P
@ AV_PIX_FMT_YUVA422P
planar YUV 4:2:2 24bpp, (1 Cr & Cb sample per 2x1 Y & A samples)
Definition: pixfmt.h:166