FFmpeg
Data Structures | Macros | Enumerations | Functions | Variables
ccaption_dec.c File Reference
#include "avcodec.h"
#include "ass.h"
#include "internal.h"
#include "libavutil/opt.h"

Go to the source code of this file.

Data Structures

struct  Screen
 
struct  CCaptionSubContext
 

Macros

#define SCREEN_ROWS   15
 
#define SCREEN_COLUMNS   32
 
#define SET_FLAG(var, val)   ( (var) |= ( 1 << (val)) )
 
#define UNSET_FLAG(var, val)   ( (var) &= ~( 1 << (val)) )
 
#define CHECK_FLAG(var, val)   ( (var) & ( 1 << (val)) )
 
#define OFFSET(x)   offsetof(CCaptionSubContext, x)
 
#define SD   AV_OPT_FLAG_SUBTITLE_PARAM | AV_OPT_FLAG_DECODING_PARAM
 

Enumerations

enum  cc_mode { CCMODE_POPON, CCMODE_PAINTON, CCMODE_ROLLUP, CCMODE_TEXT }
 
enum  cc_color_code {
  CCCOL_WHITE, CCCOL_GREEN, CCCOL_BLUE, CCCOL_CYAN,
  CCCOL_RED, CCCOL_YELLOW, CCCOL_MAGENTA, CCCOL_USERDEFINED,
  CCCOL_BLACK, CCCOL_TRANSPARENT
}
 
enum  cc_font { CCFONT_REGULAR, CCFONT_ITALICS, CCFONT_UNDERLINED, CCFONT_UNDERLINED_ITALICS }
 
enum  cc_charset { CCSET_BASIC_AMERICAN, CCSET_SPECIAL_AMERICAN, CCSET_EXTENDED_SPANISH_FRENCH_MISC, CCSET_EXTENDED_PORTUGUESE_GERMAN_DANISH }
 

Functions

static av_cold int init_decoder (AVCodecContext *avctx)
 
static av_cold int close_decoder (AVCodecContext *avctx)
 
static void flush_decoder (AVCodecContext *avctx)
 
static void write_char (CCaptionSubContext *ctx, struct Screen *screen, char ch)
 
static int validate_cc_data_pair (const uint8_t *cc_data_pair, uint8_t *hi)
 This function after validating parity bit, also remove it from data pair. More...
 
static struct Screenget_writing_screen (CCaptionSubContext *ctx)
 
static void roll_up (CCaptionSubContext *ctx)
 
static int capture_screen (CCaptionSubContext *ctx)
 
static void update_time (CCaptionSubContext *ctx, int64_t pts)
 
static void handle_bgattr (CCaptionSubContext *ctx, uint8_t hi, uint8_t lo)
 
static void handle_textattr (CCaptionSubContext *ctx, uint8_t hi, uint8_t lo)
 
static void handle_pac (CCaptionSubContext *ctx, uint8_t hi, uint8_t lo)
 
static int handle_edm (CCaptionSubContext *ctx)
 
static int handle_eoc (CCaptionSubContext *ctx)
 
static void handle_delete_end_of_row (CCaptionSubContext *ctx)
 
static void handle_char (CCaptionSubContext *ctx, char hi, char lo)
 
static int process_cc608 (CCaptionSubContext *ctx, uint8_t hi, uint8_t lo)
 
static int decode (AVCodecContext *avctx, void *data, int *got_sub, AVPacket *avpkt)
 

Variables

static const AVRational ms_tb = {1, 1000}
 
static const char * charset_overrides [4][128]
 
static const unsigned char bg_attribs [8]
 
static const unsigned char pac2_attribs [32][3]
 
static const AVOption options []
 
static const AVClass ccaption_dec_class
 
const AVCodec ff_ccaption_decoder
 

Macro Definition Documentation

◆ SCREEN_ROWS

#define SCREEN_ROWS   15

Definition at line 27 of file ccaption_dec.c.

◆ SCREEN_COLUMNS

#define SCREEN_COLUMNS   32

Definition at line 28 of file ccaption_dec.c.

◆ SET_FLAG

#define SET_FLAG (   var,
  val 
)    ( (var) |= ( 1 << (val)) )

Definition at line 30 of file ccaption_dec.c.

◆ UNSET_FLAG

#define UNSET_FLAG (   var,
  val 
)    ( (var) &= ~( 1 << (val)) )

Definition at line 31 of file ccaption_dec.c.

◆ CHECK_FLAG

#define CHECK_FLAG (   var,
  val 
)    ( (var) & ( 1 << (val)) )

Definition at line 32 of file ccaption_dec.c.

◆ OFFSET

#define OFFSET (   x)    offsetof(CCaptionSubContext, x)

Definition at line 927 of file ccaption_dec.c.

◆ SD

Definition at line 928 of file ccaption_dec.c.

Enumeration Type Documentation

◆ cc_mode

enum cc_mode
Enumerator
CCMODE_POPON 
CCMODE_PAINTON 
CCMODE_ROLLUP 
CCMODE_TEXT 

Definition at line 36 of file ccaption_dec.c.

◆ cc_color_code

Enumerator
CCCOL_WHITE 
CCCOL_GREEN 
CCCOL_BLUE 
CCCOL_CYAN 
CCCOL_RED 
CCCOL_YELLOW 
CCCOL_MAGENTA 
CCCOL_USERDEFINED 
CCCOL_BLACK 
CCCOL_TRANSPARENT 

Definition at line 43 of file ccaption_dec.c.

◆ cc_font

enum cc_font
Enumerator
CCFONT_REGULAR 
CCFONT_ITALICS 
CCFONT_UNDERLINED 
CCFONT_UNDERLINED_ITALICS 

Definition at line 56 of file ccaption_dec.c.

◆ cc_charset

enum cc_charset
Enumerator
CCSET_BASIC_AMERICAN 
CCSET_SPECIAL_AMERICAN 
CCSET_EXTENDED_SPANISH_FRENCH_MISC 
CCSET_EXTENDED_PORTUGUESE_GERMAN_DANISH 

Definition at line 63 of file ccaption_dec.c.

Function Documentation

◆ init_decoder()

static av_cold int init_decoder ( AVCodecContext avctx)
static

Definition at line 263 of file ccaption_dec.c.

◆ close_decoder()

static av_cold int close_decoder ( AVCodecContext avctx)
static

Definition at line 291 of file ccaption_dec.c.

◆ flush_decoder()

static void flush_decoder ( AVCodecContext avctx)
static

Definition at line 299 of file ccaption_dec.c.

◆ write_char()

static void write_char ( CCaptionSubContext ctx,
struct Screen screen,
char  ch 
)
static
Parameters
ctxclosed caption context just to print log

Definition at line 327 of file ccaption_dec.c.

Referenced by handle_char(), handle_delete_end_of_row(), handle_pac(), and handle_textattr().

◆ validate_cc_data_pair()

static int validate_cc_data_pair ( const uint8_t *  cc_data_pair,
uint8_t *  hi 
)
static

This function after validating parity bit, also remove it from data pair.

The first byte doesn't pass parity, we replace it with a solid blank and process the pair. If the second byte doesn't pass parity, it returns INVALIDDATA user can ignore the whole pair and pass the other pair.

Definition at line 364 of file ccaption_dec.c.

Referenced by decode().

◆ get_writing_screen()

static struct Screen* get_writing_screen ( CCaptionSubContext ctx)
static

◆ roll_up()

static void roll_up ( CCaptionSubContext ctx)
static

Definition at line 412 of file ccaption_dec.c.

Referenced by process_cc608().

◆ capture_screen()

static int capture_screen ( CCaptionSubContext ctx)
static

Definition at line 448 of file ccaption_dec.c.

Referenced by decode(), handle_edm(), handle_eoc(), and process_cc608().

◆ update_time()

static void update_time ( CCaptionSubContext ctx,
int64_t  pts 
)
static

Definition at line 604 of file ccaption_dec.c.

Referenced by decode().

◆ handle_bgattr()

static void handle_bgattr ( CCaptionSubContext ctx,
uint8_t  hi,
uint8_t  lo 
)
static

Definition at line 610 of file ccaption_dec.c.

Referenced by process_cc608().

◆ handle_textattr()

static void handle_textattr ( CCaptionSubContext ctx,
uint8_t  hi,
uint8_t  lo 
)
static

Definition at line 617 of file ccaption_dec.c.

Referenced by process_cc608().

◆ handle_pac()

static void handle_pac ( CCaptionSubContext ctx,
uint8_t  hi,
uint8_t  lo 
)
static

Definition at line 632 of file ccaption_dec.c.

Referenced by process_cc608().

◆ handle_edm()

static int handle_edm ( CCaptionSubContext ctx)
static

Definition at line 659 of file ccaption_dec.c.

Referenced by handle_eoc(), and process_cc608().

◆ handle_eoc()

static int handle_eoc ( CCaptionSubContext ctx)
static

Definition at line 680 of file ccaption_dec.c.

Referenced by process_cc608().

◆ handle_delete_end_of_row()

static void handle_delete_end_of_row ( CCaptionSubContext ctx)
static

Definition at line 701 of file ccaption_dec.c.

Referenced by process_cc608().

◆ handle_char()

static void handle_char ( CCaptionSubContext ctx,
char  hi,
char  lo 
)
static

Definition at line 707 of file ccaption_dec.c.

Referenced by process_cc608().

◆ process_cc608()

static int process_cc608 ( CCaptionSubContext ctx,
uint8_t  hi,
uint8_t  lo 
)
static

Definition at line 747 of file ccaption_dec.c.

Referenced by decode().

◆ decode()

static int decode ( AVCodecContext avctx,
void *  data,
int got_sub,
AVPacket avpkt 
)
static

Definition at line 841 of file ccaption_dec.c.

Variable Documentation

◆ ms_tb

const AVRational ms_tb = {1, 1000}
static

Definition at line 34 of file ccaption_dec.c.

Referenced by decode().

◆ charset_overrides

const char* charset_overrides[4][128]
static

Definition at line 70 of file ccaption_dec.c.

Referenced by capture_screen().

◆ bg_attribs

const unsigned char bg_attribs[8]
static
Initial value:

Definition at line 173 of file ccaption_dec.c.

Referenced by handle_bgattr().

◆ pac2_attribs

const unsigned char pac2_attribs[32][3]
static

Definition at line 185 of file ccaption_dec.c.

Referenced by handle_pac(), and handle_textattr().

◆ options

const AVOption options[]
static
Initial value:
= {
{ "real_time", "emit subtitle events as they are decoded for real-time display", OFFSET(real_time), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, SD },
{ "real_time_latency_msec", "minimum elapsed time between emitting real-time subtitle events", OFFSET(real_time_latency_msec), AV_OPT_TYPE_INT, { .i64 = 200 }, 0, 500, SD },
{ "data_field", "select data field", OFFSET(data_field), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, 1, SD, "data_field" },
{ "auto", "pick first one that appears", 0, AV_OPT_TYPE_CONST, { .i64 =-1 }, 0, 0, SD, "data_field" },
{ "first", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = 0 }, 0, 0, SD, "data_field" },
{ "second", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = 1 }, 0, 0, SD, "data_field" },
{NULL}
}

Definition at line 929 of file ccaption_dec.c.

◆ ccaption_dec_class

const AVClass ccaption_dec_class
static
Initial value:
= {
.class_name = "Closed caption Decoder",
.item_name = av_default_item_name,
.option = options,
}

Definition at line 939 of file ccaption_dec.c.

◆ ff_ccaption_decoder

const AVCodec ff_ccaption_decoder
Initial value:
= {
.name = "cc_dec",
.long_name = NULL_IF_CONFIG_SMALL("Closed Caption (EIA-608 / CEA-708)"),
.priv_data_size = sizeof(CCaptionSubContext),
.close = close_decoder,
.priv_class = &ccaption_dec_class,
.capabilities = AV_CODEC_CAP_DELAY,
.caps_internal = FF_CODEC_CAP_INIT_THREADSAFE,
}

Definition at line 946 of file ccaption_dec.c.

CCCOL_YELLOW
@ CCCOL_YELLOW
Definition: ccaption_dec.c:49
AV_CODEC_ID_EIA_608
@ AV_CODEC_ID_EIA_608
Definition: codec_id.h:532
AVMEDIA_TYPE_SUBTITLE
@ AVMEDIA_TYPE_SUBTITLE
Definition: avutil.h:204
FF_CODEC_CAP_INIT_THREADSAFE
#define FF_CODEC_CAP_INIT_THREADSAFE
The codec does not modify any global variables in the init function, allowing to call the init functi...
Definition: internal.h:42
CCaptionSubContext
Definition: ccaption_dec.c:238
init
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:31
OFFSET
#define OFFSET(x)
Definition: ccaption_dec.c:927
LIBAVUTIL_VERSION_INT
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
flush
static void flush(AVCodecContext *avctx)
Definition: aacdec_template.c:593
NULL
#define NULL
Definition: coverity.c:32
CCCOL_BLUE
@ CCCOL_BLUE
Definition: ccaption_dec.c:46
av_default_item_name
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:235
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:117
CCCOL_BLACK
@ CCCOL_BLACK
Definition: ccaption_dec.c:52
flush_decoder
static void flush_decoder(AVCodecContext *avctx)
Definition: ccaption_dec.c:299
decode
static int decode(AVCodecContext *avctx, void *data, int *got_sub, AVPacket *avpkt)
Definition: ccaption_dec.c:841
init_decoder
static av_cold int init_decoder(AVCodecContext *avctx)
Definition: ccaption_dec.c:263
options
static const AVOption options[]
Definition: ccaption_dec.c:929
CCCOL_GREEN
@ CCCOL_GREEN
Definition: ccaption_dec.c:45
close_decoder
static av_cold int close_decoder(AVCodecContext *avctx)
Definition: ccaption_dec.c:291
CCCOL_CYAN
@ CCCOL_CYAN
Definition: ccaption_dec.c:47
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:224
ccaption_dec_class
static const AVClass ccaption_dec_class
Definition: ccaption_dec.c:939
AV_CODEC_CAP_DELAY
#define AV_CODEC_CAP_DELAY
Encoder or decoder requires flushing with NULL input at the end in order to give the complete and cor...
Definition: codec.h:82
AV_OPT_TYPE_BOOL
@ AV_OPT_TYPE_BOOL
Definition: opt.h:241
CCCOL_RED
@ CCCOL_RED
Definition: ccaption_dec.c:48
CCCOL_WHITE
@ CCCOL_WHITE
Definition: ccaption_dec.c:44
CCCOL_MAGENTA
@ CCCOL_MAGENTA
Definition: ccaption_dec.c:50
AV_OPT_TYPE_CONST
@ AV_OPT_TYPE_CONST
Definition: opt.h:233
SD
#define SD
Definition: ccaption_dec.c:928