#include <assert.h>
#include "avcodec.h"
#include "ass.h"
#include "codec_internal.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	CHARSET_OVERRIDE_LIST(START_SET, ENTRY, END_SET)

#define	START_SET(IDX) [IDX] = {

#define	ENTRY(idx, string) [idx] = string,

#define	END_SET },

#define	EMPTY_START(IDX)

#define	EMPTY_END

#define	ASSERT_ENTRY(IDX, str)

#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 Screen *	get_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, AVSubtitle sub, int got_sub, const AVPacket avpkt)

Variables
static const AVRational	ms_tb = {1, 1000}

static const char	charset_overrides [4][128][sizeof("\u266a")]

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 FFCodec	ff_ccaption_decoder

Macro Definition Documentation

◆ SCREEN_ROWS

#define SCREEN_ROWS 15

Definition at line 28 of file ccaption_dec.c.

◆ SCREEN_COLUMNS

#define SCREEN_COLUMNS 32

Definition at line 29 of file ccaption_dec.c.

◆ SET_FLAG

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

Definition at line 31 of file ccaption_dec.c.

◆ UNSET_FLAG

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

Definition at line 32 of file ccaption_dec.c.

◆ CHECK_FLAG

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

Definition at line 33 of file ccaption_dec.c.

◆ CHARSET_OVERRIDE_LIST

#define CHARSET_OVERRIDE_LIST	(	START_SET,
		ENTRY,
		END_SET
	)

Definition at line 71 of file ccaption_dec.c.

◆ START_SET

#define START_SET ( IDX ) [IDX] = {

◆ ENTRY

#define ENTRY	(	idx,
		string
	)	[idx] = string,

◆ END_SET

#define END_SET },

◆ EMPTY_START

#define EMPTY_START ( IDX )

Definition at line 182 of file ccaption_dec.c.

◆ EMPTY_END

#define EMPTY_END

Definition at line 183 of file ccaption_dec.c.

◆ ASSERT_ENTRY

#define ASSERT_ENTRY	(	IDX,
		str
	)

Value:

static_assert(sizeof(str) <= sizeof(charset_overrides[0][0]), \

"'" str "' string takes too much space");

Definition at line 184 of file ccaption_dec.c.

◆ OFFSET

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

Definition at line 939 of file ccaption_dec.c.

◆ SD

#define SD AV_OPT_FLAG_SUBTITLE_PARAM | AV_OPT_FLAG_DECODING_PARAM

Definition at line 940 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 37 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 44 of file ccaption_dec.c.

◆ cc_font

enum cc_font

Enumerator
CCFONT_REGULAR
CCFONT_ITALICS
CCFONT_UNDERLINED
CCFONT_UNDERLINED_ITALICS

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

Function Documentation

◆ init_decoder()

static av_cold int init_decoder ( AVCodecContext * avctx )

static

Definition at line 279 of file ccaption_dec.c.

◆ close_decoder()

static av_cold int close_decoder ( AVCodecContext * avctx )

static

Definition at line 301 of file ccaption_dec.c.

◆ flush_decoder()

static void flush_decoder ( AVCodecContext * avctx )

static

Definition at line 309 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 337 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 374 of file ccaption_dec.c.

Referenced by decode().

◆ get_writing_screen()

static struct Screen* get_writing_screen ( CCaptionSubContext * ctx )

static

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

Referenced by process_cc608().

◆ capture_screen()

static int capture_screen ( CCaptionSubContext * ctx )

static

Definition at line 458 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 614 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 620 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 627 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 642 of file ccaption_dec.c.

Referenced by process_cc608().

◆ handle_edm()

static int handle_edm ( CCaptionSubContext * ctx )

static

Definition at line 669 of file ccaption_dec.c.

Referenced by handle_eoc(), and process_cc608().

◆ handle_eoc()

static int handle_eoc ( CCaptionSubContext * ctx )

static

Definition at line 690 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 711 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 717 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 757 of file ccaption_dec.c.

Referenced by decode().

◆ decode()

static int decode	(	AVCodecContext *	avctx,
		AVSubtitle *	sub,
		int *	got_sub,
		const AVPacket *	avpkt
	)

static

Definition at line 851 of file ccaption_dec.c.

Variable Documentation

◆ ms_tb

const AVRational ms_tb = {1, 1000}

static

Definition at line 35 of file ccaption_dec.c.

Referenced by decode().

◆ charset_overrides

const char charset_overrides[4][128][sizeof("\u266a")]

static

Initial value:

=
{
#define START_SET(IDX) 
 
#define ENTRY(idx, string) 
 
#define END_SET
 
 
}

Definition at line 172 of file ccaption_dec.c.

Referenced by capture_screen().

◆ bg_attribs

const unsigned char bg_attribs[8]

static

Initial value:

= 
{
    CCCOL_WHITE,
    CCCOL_GREEN,
    CCCOL_BLUE,
    CCCOL_CYAN,
    CCCOL_RED,
    CCCOL_YELLOW,
    CCCOL_MAGENTA,
    CCCOL_BLACK,
}

Definition at line 189 of file ccaption_dec.c.

Referenced by handle_bgattr().

◆ pac2_attribs

const unsigned char pac2_attribs[32][3]

static

Definition at line 201 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, .unit = "data_field" },
    { "auto",   "pick first one that appears", 0, AV_OPT_TYPE_CONST, { .i64 =-1 }, 0, 0, SD, .unit = "data_field" },
    { "first",  NULL, 0, AV_OPT_TYPE_CONST, { .i64 = 0 }, 0, 0, SD, .unit = "data_field" },
    { "second", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = 1 }, 0, 0, SD, .unit = "data_field" },
    {NULL}
}

Definition at line 941 of file ccaption_dec.c.

◆ ccaption_dec_class

const AVClass ccaption_dec_class

static

Initial value:

= {
    .class_name = "Closed Captions Decoder",
    .item_name  = av_default_item_name,
    .option     = options,
    .version    = LIBAVUTIL_VERSION_INT,
}

Definition at line 951 of file ccaption_dec.c.

◆ ff_ccaption_decoder

const FFCodec ff_ccaption_decoder

Initial value:

= {
    .p.name         = "cc_dec",
    CODEC_LONG_NAME("Closed Captions (EIA-608 / CEA-708)"),
    .p.type         = AVMEDIA_TYPE_SUBTITLE,
    .p.id           = AV_CODEC_ID_EIA_608,
    .p.priv_class   = &ccaption_dec_class,
    .p.capabilities = AV_CODEC_CAP_DELAY,
    .priv_data_size = sizeof(CCaptionSubContext),
    .init           = init_decoder,
    .close          = close_decoder,
    .flush          = flush_decoder,
    FF_CODEC_DECODE_SUB_CB(decode),
}

Definition at line 958 of file ccaption_dec.c.

Data Structures

Macros

Enumerations

Functions

Variables

Macro Definition Documentation

◆ SCREEN_ROWS

◆ SCREEN_COLUMNS

◆ SET_FLAG

◆ UNSET_FLAG

◆ CHECK_FLAG

◆ CHARSET_OVERRIDE_LIST

◆ START_SET

◆ ENTRY

◆ END_SET

◆ EMPTY_START

◆ EMPTY_END

◆ ASSERT_ENTRY

◆ 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()

◆ update_time()

◆ handle_bgattr()

◆ handle_textattr()

◆ handle_pac()

◆ handle_edm()

◆ handle_eoc()

◆ handle_delete_end_of_row()

◆ handle_char()

◆ process_cc608()

◆ decode()

Variable Documentation

◆ ms_tb

◆ charset_overrides

◆ bg_attribs

◆ pac2_attribs

◆ options

◆ ccaption_dec_class

◆ ff_ccaption_decoder