libavcodec/ass_split.h File Reference

Go to the source code of this file.

Data Structures
struct	ASSScriptInfo
	fields extracted from the [Script Info] section More...
struct	ASSStyle
	fields extracted from the [V4(+) Styles] section More...
struct	ASSDialog
	fields extracted from the [Events] section More...
struct	ASS
	structure containing the whole split ASS data More...
struct	ASSCodesCallbacks
	Set of callback functions corresponding to each override codes that can be encountered in a "Dialogue" Text field. More...
Typedefs
typedef struct ASSSplitContext	ASSSplitContext
	This struct can be casted to ASS to access to the split data.
Functions
ASSSplitContext *	ff_ass_split (const char *buf)
	Split a full ASS file or a ASS header from a string buffer and store the split structure in a newly allocated context.
ASSDialog *	ff_ass_split_dialog (ASSSplitContext *ctx, const char *buf, int cache, int *number)
	Split one or several ASS "Dialogue" lines from a string buffer and store them in a already initialized context.
void	ff_ass_split_free (ASSSplitContext *ctx)
	Free all the memory allocated for an ASSSplitContext.
int	ff_ass_split_override_codes (const ASSCodesCallbacks *callbacks, void *priv, const char *buf)
	Split override codes out of a ASS "Dialogue" Text field.
ASSStyle *	ass_style_get (ASSSplitContext *ctx, const char *style)
	Find an ASSStyle structure by its name.

---

Typedef Documentation

typedef struct ASSSplitContext ASSSplitContext

This struct can be casted to ASS to access to the split data.

Definition at line 80 of file ass_split.h.

---

Function Documentation

ASSStyle* ass_style_get	(	ASSSplitContext *	ctx,
		const char *	style
	)

Find an ASSStyle structure by its name.

Parameters:

	ctx	Context previously initialized by ff_ass_split().
	style	name of the style to search for.

Returns:

the ASSStyle corresponding to style, or NULL if style can't be found

Definition at line 457 of file ass_split.c.

Referenced by srt_style_apply().

ASSSplitContext* ff_ass_split

(

const char *

buf

)

Split a full ASS file or a ASS header from a string buffer and store the split structure in a newly allocated context.

Parameters:

buf

String containing the ASS formated data.

Returns:

Newly allocated struct containing split data.

Definition at line 297 of file ass_split.c.

Referenced by ass_decode_init(), and srt_encode_init().

ASSDialog* ff_ass_split_dialog	(	ASSSplitContext *	ctx,
		const char *	buf,
		int	cache,
		int *	number
	)

Split one or several ASS "Dialogue" lines from a string buffer and store them in a already initialized context.

Parameters:

	ctx	Context previously initialized by ff_ass_split().
	buf	String containing the ASS "Dialogue" lines.
	cache	Set to 1 to keep all the previously split ASSDialog in the context, or set to 0 to free all the previously split ASSDialog.
	number	If not NULL, the pointed integer will be set to the number of split ASSDialog.

Returns:

Pointer to the first split ASSDialog.

Definition at line 332 of file ass_split.c.

Referenced by ass_decode_frame(), and srt_encode_frame().

void ff_ass_split_free

(

ASSSplitContext *

ctx

)

Free all the memory allocated for an ASSSplitContext.

Parameters:

ctx

Context previously initialized by ff_ass_split().

Definition at line 351 of file ass_split.c.

Referenced by ass_decode_close(), ff_ass_split(), and srt_encode_close().

int ff_ass_split_override_codes	(	const ASSCodesCallbacks *	callbacks,
		void *	priv,
		const char *	buf
	)

Split override codes out of a ASS "Dialogue" Text field.

Parameters:

	callbacks	Set of callback functions called for each override code encountered.
	priv	Opaque pointer passed to the callback functions.
	buf	The ASS "Dialogue" Text field to split.

Returns:

>= 0 on success otherwise an error code <0

Definition at line 362 of file ass_split.c.

Referenced by srt_encode_frame().