FFmpeg
Data Structures | Macros | Enumerations | Functions | Variables
ccaption_dec.c File Reference
#include "avcodec.h"
#include "ass.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 (uint8_t *cc_data_pair)
 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 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

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

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
ctxclosed 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

◆ 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
ptsit 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,
}

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)"),
.priv_data_size = sizeof(CCaptionSubContext),
.close = close_decoder,
.priv_class = &ccaption_dec_class,
}

Definition at line 832 of file ccaption_dec.c.

AV_CODEC_ID_EIA_608
@ AV_CODEC_ID_EIA_608
Definition: avcodec.h:669
AVMEDIA_TYPE_SUBTITLE
@ AVMEDIA_TYPE_SUBTITLE
Definition: avutil.h:204
CCaptionSubContext
Definition: ccaption_dec.c:228
init
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:35
OFFSET
#define OFFSET(x)
Definition: ccaption_dec.c:818
LIBAVUTIL_VERSION_INT
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
flush
static void flush(AVCodecContext *avctx)
Definition: aacdec_template.c:500
NULL
#define NULL
Definition: coverity.c:32
av_default_item_name
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:191
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:188
flush_decoder
static void flush_decoder(AVCodecContext *avctx)
Definition: ccaption_dec.c:291
decode
static int decode(AVCodecContext *avctx, void *data, int *got_sub, AVPacket *avpkt)
Definition: ccaption_dec.c:750
init_decoder
static av_cold int init_decoder(AVCodecContext *avctx)
Definition: ccaption_dec.c:256
options
static const AVOption options[]
Definition: ccaption_dec.c:820
close_decoder
static av_cold int close_decoder(AVCodecContext *avctx)
Definition: ccaption_dec.c:282
ccaption_dec_class
static const AVClass ccaption_dec_class
Definition: ccaption_dec.c:825
AV_OPT_TYPE_BOOL
@ AV_OPT_TYPE_BOOL
Definition: opt.h:240
SD
#define SD
Definition: ccaption_dec.c:819