ass.h File Reference

#include "avcodec.h"
#include "libavutil/bprint.h"

Go to the source code of this file.

Macros
Default values for ASS style
#define	ASS_DEFAULT_FONT   "Arial"
#define	ASS_DEFAULT_FONT_SIZE   16
#define	ASS_DEFAULT_COLOR   0xffffff
#define	ASS_DEFAULT_BACK_COLOR   0
#define	ASS_DEFAULT_BOLD   0
#define	ASS_DEFAULT_ITALIC   0
#define	ASS_DEFAULT_UNDERLINE   0
#define	ASS_DEFAULT_ALIGNMENT   2

Functions
int	ff_ass_subtitle_header (AVCodecContext *avctx, const char *font, int font_size, int color, int back_color, int bold, int italic, int underline, int alignment)
	Generate a suitable AVCodecContext.subtitle_header for SUBTITLE_ASS.
int	ff_ass_subtitle_header_default (AVCodecContext *avctx)
	Generate a suitable AVCodecContext.subtitle_header for SUBTITLE_ASS with default style.
int	ff_ass_add_rect (AVSubtitle *sub, const char *dialog, int ts_start, int duration, int raw)
	Add an ASS dialog line to an AVSubtitle as a new AVSubtitleRect.
int	ff_ass_bprint_dialog (AVBPrint *buf, const char *dialog, int ts_start, int duration, int raw)
	Add an ASS dialog line to an AVBPrint buffer.
void	ff_ass_bprint_text_event (AVBPrint *buf, const char *p, int size, const char *linebreaks, int keep_ass_markup)
	Escape a text subtitle using ASS syntax into an AVBPrint buffer.

Macro Definition Documentation

#define ASS_DEFAULT_FONT   "Arial"

Definition at line 32 of file ass.h.

Referenced by ff_ass_subtitle_header_default(), microdvd_init(), and srt_style_apply().

#define ASS_DEFAULT_FONT_SIZE   16

Definition at line 33 of file ass.h.

Referenced by ff_ass_subtitle_header_default(), microdvd_init(), and srt_style_apply().

#define ASS_DEFAULT_COLOR   0xffffff

Definition at line 34 of file ass.h.

Referenced by ff_ass_subtitle_header_default(), microdvd_init(), and srt_style_apply().

#define ASS_DEFAULT_BACK_COLOR   0

Definition at line 35 of file ass.h.

Referenced by ff_ass_subtitle_header_default(), and microdvd_init().

#define ASS_DEFAULT_BOLD   0

Definition at line 36 of file ass.h.

Referenced by ff_ass_subtitle_header_default(), microdvd_init(), srt_style_apply(), and webvtt_style_apply().

#define ASS_DEFAULT_ITALIC   0

Definition at line 37 of file ass.h.

Referenced by ff_ass_subtitle_header_default(), microdvd_init(), srt_style_apply(), and webvtt_style_apply().

#define ASS_DEFAULT_UNDERLINE   0

Definition at line 38 of file ass.h.

Referenced by ff_ass_subtitle_header_default(), microdvd_init(), srt_style_apply(), and webvtt_style_apply().

#define ASS_DEFAULT_ALIGNMENT   2

Definition at line 39 of file ass.h.

Referenced by ff_ass_subtitle_header_default(), microdvd_init(), and srt_style_apply().

Function Documentation

int ff_ass_subtitle_header	(	AVCodecContext *	avctx,
		const char *	font,
		int	font_size,
		int	color,
		int	back_color,
		int	bold,
		int	italic,
		int	underline,
		int	alignment
	)

Generate a suitable AVCodecContext.subtitle_header for SUBTITLE_ASS.

Parameters

avctx	pointer to the AVCodecContext
font	name of the default font face to use
font_size	default font size to use
color	default text color to use (ABGR)
back_color	default background color to use (ABGR)
bold	1 for bold text, 0 for normal text
italic	1 for italic text, 0 for normal text
underline	1 for underline text, 0 for normal text
alignment	position of the text (left, center, top...), defined after the layout of the numpad (1-3 sub, 4-6 mid, 7-9 top)

Returns

>= 0 on success otherwise an error code <0

Definition at line 29 of file ass.c.

Referenced by ff_ass_subtitle_header_default(), and microdvd_init().

int ff_ass_subtitle_header_default

(

AVCodecContext *

avctx

)

Generate a suitable AVCodecContext.subtitle_header for SUBTITLE_ASS with default style.

Parameters

avctx

pointer to the AVCodecContext

Returns

>= 0 on success otherwise an error code <0

Definition at line 56 of file ass.c.

Referenced by mov_text_init(), sami_init(), and teletext_init_decoder().

int ff_ass_add_rect	(	AVSubtitle *	sub,
		const char *	dialog,
		int	ts_start,
		int	duration,
		int	raw
	)

Add an ASS dialog line to an AVSubtitle as a new AVSubtitleRect.

Parameters

sub	pointer to the AVSubtitle
dialog	ASS dialog to add to sub
ts_start	start timestamp for this dialog (in 1/100 second unit)
duration	duration for this dialog (in 1/100 second unit), can be -1 to last until the end of the presentation
raw	when set to 2, it indicates that dialog contains an ASS dialog line as muxed in Matroska when set to 1, it indicates that dialog contains a whole SSA dialog line which should be copied as is. when set to 0, it indicates that dialog contains only the Text part of the ASS dialog line, the rest of the line will be generated.

Returns

number of characters read from dialog. It can be less than the whole length of dialog, if dialog contains several lines of text. A negative value indicates an error.

Definition at line 120 of file ass.c.

Referenced by jacosub_decode_frame(), microdvd_decode_frame(), realtext_decode_frame(), and subviewer_decode_frame().

int ff_ass_bprint_dialog	(	AVBPrint *	buf,
		const char *	dialog,
		int	ts_start,
		int	duration,
		int	raw
	)

Add an ASS dialog line to an AVBPrint buffer.

Parameters

buf	pointer to an initialized AVBPrint buffer
dialog	ASS dialog to add to sub
ts_start	start timestamp for this dialog (in 1/100 second unit)
duration	duration for this dialog (in 1/100 second unit), can be -1 to last until the end of the presentation
raw	when set to 2, it indicates that dialog contains an ASS dialog line as muxed in Matroska when set to 1, it indicates that dialog contains a whole SSA dialog line which should be copied as is. when set to 0, it indicates that dialog contains only the Text part of the ASS dialog line, the rest of the line will be generated.

Returns

number of characters read from dialog. It can be less than the whole length of dialog, if dialog contains several lines of text. A negative value indicates an error.

Definition at line 82 of file ass.c.

Referenced by ff_ass_add_rect().

void ff_ass_bprint_text_event	(	AVBPrint *	buf,
		const char *	p,
		int	size,
		const char *	linebreaks,
		int	keep_ass_markup
	)

Escape a text subtitle using ASS syntax into an AVBPrint buffer.

Newline characters will be escaped to .

Parameters

buf	pointer to an initialized AVBPrint buffer
p	source text
size	size of the source text
linebreaks	additional newline chars, which will be escaped to
keep_ass_markup	braces and backslash will not be escaped if set

Definition at line 154 of file ass.c.