libavcodec/ass.h File Reference

#include "avcodec.h"

Go to the source code of this file.

Defines
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 ts_end, int raw)
	Add an ASS dialog line to an AVSubtitle as a new AVSubtitleRect.

---

Define Documentation

#define ASS_DEFAULT_ALIGNMENT   2

Definition at line 38 of file ass.h.

Referenced by ff_ass_subtitle_header_default(), and srt_style_apply().

#define ASS_DEFAULT_BACK_COLOR   0

Definition at line 34 of file ass.h.

Referenced by ff_ass_subtitle_header_default().

#define ASS_DEFAULT_BOLD   0

Definition at line 35 of file ass.h.

Referenced by ff_ass_subtitle_header_default(), and srt_style_apply().

#define ASS_DEFAULT_COLOR   0xffffff

Definition at line 33 of file ass.h.

Referenced by ff_ass_subtitle_header_default(), and srt_style_apply().

#define ASS_DEFAULT_FONT   "Arial"

Definition at line 31 of file ass.h.

Referenced by ff_ass_subtitle_header_default(), and srt_style_apply().

#define ASS_DEFAULT_FONT_SIZE   16

Definition at line 32 of file ass.h.

Referenced by ff_ass_subtitle_header_default(), and srt_style_apply().

#define ASS_DEFAULT_ITALIC   0

Definition at line 36 of file ass.h.

Referenced by ff_ass_subtitle_header_default(), and srt_style_apply().

#define ASS_DEFAULT_UNDERLINE   0

Definition at line 37 of file ass.h.

Referenced by ff_ass_subtitle_header_default(), and srt_style_apply().

---

Function Documentation

int ff_ass_add_rect	(	AVSubtitle *	sub,
		const char *	dialog,
		int	ts_start,
		int	ts_end,
		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)
	ts_end	end timestamp for this dialog (in 1/100 second unit)
	raw	when set to 1, it indicates that dialog contains a whole ASS 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 75 of file ass.c.

Referenced by ass_decode_frame(), and srt_decode_frame().

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 26 of file ass.c.

Referenced by ff_ass_subtitle_header_default().

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 54 of file ass.c.