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 (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
 
AVCodec ff_ccaption_decoder
 

Macro Definition Documentation

#define SCREEN_ROWS   15

Definition at line 26 of file ccaption_dec.c.

Referenced by capture_screen(), and roll_up().

#define SCREEN_COLUMNS   32

Definition at line 27 of file ccaption_dec.c.

Referenced by capture_screen(), roll_up(), and write_char().

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

Definition at line 29 of file ccaption_dec.c.

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

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

Definition at line 30 of file ccaption_dec.c.

Referenced by roll_up().

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

Definition at line 31 of file ccaption_dec.c.

Referenced by capture_screen(), and roll_up().

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

Definition at line 925 of file ccaption_dec.c.

Enumeration Type Documentation

enum cc_mode
Enumerator
CCMODE_POPON 
CCMODE_PAINTON 
CCMODE_ROLLUP 
CCMODE_TEXT 

Definition at line 35 of file ccaption_dec.c.

Enumerator
CCCOL_WHITE 
CCCOL_GREEN 
CCCOL_BLUE 
CCCOL_CYAN 
CCCOL_RED 
CCCOL_YELLOW 
CCCOL_MAGENTA 
CCCOL_USERDEFINED 
CCCOL_BLACK 
CCCOL_TRANSPARENT 

Definition at line 42 of file ccaption_dec.c.

enum cc_font
Enumerator
CCFONT_REGULAR 
CCFONT_ITALICS 
CCFONT_UNDERLINED 
CCFONT_UNDERLINED_ITALICS 

Definition at line 55 of file ccaption_dec.c.

enum cc_charset
Enumerator
CCSET_BASIC_AMERICAN 
CCSET_SPECIAL_AMERICAN 
CCSET_EXTENDED_SPANISH_FRENCH_MISC 
CCSET_EXTENDED_PORTUGUESE_GERMAN_DANISH 

Definition at line 62 of file ccaption_dec.c.

Function Documentation

static av_cold int init_decoder ( AVCodecContext avctx)
static

Definition at line 261 of file ccaption_dec.c.

static av_cold int close_decoder ( AVCodecContext avctx)
static

Definition at line 289 of file ccaption_dec.c.

static void flush_decoder ( AVCodecContext avctx)
static

Definition at line 297 of file ccaption_dec.c.

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

Definition at line 325 of file ccaption_dec.c.

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

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

Referenced by decode().

static struct Screen* get_writing_screen ( CCaptionSubContext ctx)
static
static void roll_up ( CCaptionSubContext ctx)
static

Definition at line 410 of file ccaption_dec.c.

Referenced by process_cc608().

static int capture_screen ( CCaptionSubContext ctx)
static

Definition at line 446 of file ccaption_dec.c.

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

static void update_time ( CCaptionSubContext ctx,
int64_t  pts 
)
static

Definition at line 602 of file ccaption_dec.c.

Referenced by decode().

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

Definition at line 608 of file ccaption_dec.c.

Referenced by process_cc608().

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

Definition at line 615 of file ccaption_dec.c.

Referenced by process_cc608().

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

Definition at line 630 of file ccaption_dec.c.

Referenced by process_cc608().

static int handle_edm ( CCaptionSubContext ctx)
static

Definition at line 657 of file ccaption_dec.c.

Referenced by handle_eoc(), and process_cc608().

static int handle_eoc ( CCaptionSubContext ctx)
static

Definition at line 678 of file ccaption_dec.c.

Referenced by process_cc608().

static void handle_delete_end_of_row ( CCaptionSubContext ctx)
static

Definition at line 699 of file ccaption_dec.c.

Referenced by process_cc608().

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

Definition at line 705 of file ccaption_dec.c.

Referenced by process_cc608().

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

Definition at line 745 of file ccaption_dec.c.

Referenced by decode().

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

Definition at line 839 of file ccaption_dec.c.

Variable Documentation

const AVRational ms_tb = {1, 1000}
static

Definition at line 33 of file ccaption_dec.c.

const char* charset_overrides[4][128]
static

Definition at line 69 of file ccaption_dec.c.

Referenced by capture_screen().

const unsigned char bg_attribs[8]
static
const unsigned char pac2_attribs[32][3]
static

Definition at line 184 of file ccaption_dec.c.

Referenced by handle_pac(), and handle_textattr().

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 },
{ "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}
}
#define NULL
Definition: coverity.c:32
#define OFFSET(x)
Definition: ccaption_dec.c:925
#define SD
Definition: ccaption_dec.c:926

Definition at line 927 of file ccaption_dec.c.

const AVClass ccaption_dec_class
static
Initial value:
= {
.class_name = "Closed caption Decoder",
.item_name = av_default_item_name,
.option = options,
}
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:235
static const AVOption options[]
Definition: ccaption_dec.c:927

Definition at line 936 of file ccaption_dec.c.

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,
}
static void flush(AVCodecContext *avctx)
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:35
#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:75
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:153
static av_cold int init_decoder(AVCodecContext *avctx)
Definition: ccaption_dec.c:261
static void flush_decoder(AVCodecContext *avctx)
Definition: ccaption_dec.c:297
static const AVClass ccaption_dec_class
Definition: ccaption_dec.c:936
static int decode(AVCodecContext *avctx, void *data, int *got_sub, AVPacket *avpkt)
Definition: ccaption_dec.c:839
static av_cold int close_decoder(AVCodecContext *avctx)
Definition: ccaption_dec.c:289

Definition at line 943 of file ccaption_dec.c.