#include "avcodec.h"
#include "ass.h"
#include "libavutil/opt.h"

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 (uint8_t *cc_data_pair)
	This function after validating parity bit, also remove it from data pair. More...

static struct Screen *	get_writing_screen (CCaptionSubContext *ctx)

static void	roll_up (CCaptionSubContext *ctx)

static int	capture_screen (CCaptionSubContext *ctx)

static int	reap_screen (CCaptionSubContext *ctx, int64_t pts)

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 void	handle_edm (CCaptionSubContext *ctx, int64_t pts)

static void	handle_eoc (CCaptionSubContext *ctx, int64_t pts)

static void	handle_delete_end_of_row (CCaptionSubContext *ctx, char hi, char lo)

static void	handle_char (CCaptionSubContext *ctx, char hi, char lo, int64_t pts)

static void	process_cc608 (CCaptionSubContext *ctx, int64_t pts, 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	pac2_attribs [32][3]

static const AVOption	options []

static const AVClass	ccaption_dec_class

AVCodec	ff_ccaption_decoder

Macro Definition Documentation

◆ SCREEN_ROWS

#define SCREEN_ROWS 15

Definition at line 26 of file ccaption_dec.c.

◆ SCREEN_COLUMNS

#define SCREEN_COLUMNS 32

Definition at line 27 of file ccaption_dec.c.

◆ SET_FLAG

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

Definition at line 29 of file ccaption_dec.c.

◆ UNSET_FLAG

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

Definition at line 30 of file ccaption_dec.c.

◆ CHECK_FLAG

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

Definition at line 31 of file ccaption_dec.c.

◆ OFFSET

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

Definition at line 818 of file ccaption_dec.c.

◆ SD

#define SD AV_OPT_FLAG_SUBTITLE_PARAM | AV_OPT_FLAG_DECODING_PARAM

Definition at line 819 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 39 of file ccaption_dec.c.

◆ cc_color_code

enum 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 46 of file ccaption_dec.c.

◆ cc_font

enum cc_font

Enumerator
CCFONT_REGULAR
CCFONT_ITALICS
CCFONT_UNDERLINED
CCFONT_UNDERLINED_ITALICS

Definition at line 59 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 66 of file ccaption_dec.c.

Function Documentation

◆ init_decoder()

static av_cold int init_decoder ( AVCodecContext * avctx )

static

Definition at line 256 of file ccaption_dec.c.

◆ close_decoder()

static av_cold int close_decoder ( AVCodecContext * avctx )

static

Definition at line 282 of file ccaption_dec.c.

◆ flush_decoder()

static void flush_decoder ( AVCodecContext * avctx )

static

Definition at line 291 of file ccaption_dec.c.

◆ write_char()

static void write_char	(	CCaptionSubContext *	ctx,
		struct Screen *	screen,
		char	ch
	)

static

Parameters

ctx	closed caption context just to print log

Definition at line 317 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 ( uint8_t * cc_data_pair )

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 350 of file ccaption_dec.c.

Referenced by decode().

◆ get_writing_screen()

static struct Screen* get_writing_screen ( CCaptionSubContext * ctx )

static

Definition at line 384 of file ccaption_dec.c.

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

◆ roll_up()

static void roll_up ( CCaptionSubContext * ctx )

static

Definition at line 400 of file ccaption_dec.c.

Referenced by process_cc608().

◆ capture_screen()

static int capture_screen ( CCaptionSubContext * ctx )

static

Definition at line 435 of file ccaption_dec.c.

Referenced by avf_read_header(), decode(), and reap_screen().

◆ reap_screen()

static int reap_screen	(	CCaptionSubContext *	ctx,
		int64_t	pts
	)

static

Definition at line 529 of file ccaption_dec.c.

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

◆ handle_textattr()

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

static

Definition at line 537 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 552 of file ccaption_dec.c.

Referenced by process_cc608().

◆ handle_edm()

static void handle_edm	(	CCaptionSubContext *	ctx,
		int64_t	pts
	)

static

Parameters

pts	it is required to set end time

Definition at line 582 of file ccaption_dec.c.

Referenced by handle_eoc(), and process_cc608().

◆ handle_eoc()

static void handle_eoc	(	CCaptionSubContext *	ctx,
		int64_t	pts
	)

static

Definition at line 599 of file ccaption_dec.c.

Referenced by process_cc608().

◆ handle_delete_end_of_row()

static void handle_delete_end_of_row	(	CCaptionSubContext *	ctx,
		char	hi,
		char	lo
	)

static

Definition at line 615 of file ccaption_dec.c.

Referenced by process_cc608().

◆ handle_char()

static void handle_char	(	CCaptionSubContext *	ctx,
		char	hi,
		char	lo,
		int64_t	pts
	)

static

Definition at line 621 of file ccaption_dec.c.

Referenced by process_cc608().

◆ process_cc608()

static void process_cc608	(	CCaptionSubContext *	ctx,
		int64_t	pts,
		uint8_t	hi,
		uint8_t	lo
	)

static

Definition at line 661 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 750 of file ccaption_dec.c.

Variable Documentation

◆ ms_tb

const AVRational ms_tb = {1, 1000}

static

Definition at line 33 of file ccaption_dec.c.

Referenced by decode().

◆ charset_overrides

const char* charset_overrides[4][128]

static

Definition at line 73 of file ccaption_dec.c.

Referenced by capture_screen().

◆ pac2_attribs

const unsigned char pac2_attribs[32][3]

static

Definition at line 176 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 },
    {NULL}
}

Definition at line 820 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,
    .version    = LIBAVUTIL_VERSION_INT,
}

Definition at line 825 of file ccaption_dec.c.

◆ ff_ccaption_decoder

AVCodec ff_ccaption_decoder

Initial value:

= {
    .name           = "cc_dec",
    .long_name      = NULL_IF_CONFIG_SMALL("Closed Caption (EIA-608 / CEA-708)"),
    .type           = AVMEDIA_TYPE_SUBTITLE,
    .id             = AV_CODEC_ID_EIA_608,
    .priv_data_size = sizeof(CCaptionSubContext),
    .init           = init_decoder,
    .close          = close_decoder,
    .flush          = flush_decoder,
    .decode         = decode,
    .priv_class     = &ccaption_dec_class,
}

Definition at line 832 of file ccaption_dec.c.

Data Structures

Macros

Enumerations

Functions

Variables

Macro Definition Documentation

◆ SCREEN_ROWS

◆ SCREEN_COLUMNS

◆ SET_FLAG

◆ UNSET_FLAG

◆ CHECK_FLAG

◆ OFFSET

◆ SD

Enumeration Type Documentation

◆ cc_mode

◆ cc_color_code

◆ cc_font

◆ cc_charset

Function Documentation

◆ init_decoder()

◆ close_decoder()

◆ flush_decoder()

◆ write_char()

◆ validate_cc_data_pair()

◆ get_writing_screen()

◆ roll_up()

◆ capture_screen()

◆ reap_screen()

◆ handle_textattr()

◆ handle_pac()

◆ handle_edm()

◆ handle_eoc()

◆ handle_delete_end_of_row()

◆ handle_char()

◆ process_cc608()

◆ decode()

Variable Documentation

◆ ms_tb

◆ charset_overrides

◆ pac2_attribs

◆ options

◆ ccaption_dec_class

◆ ff_ccaption_decoder