tx.h File Reference

#include <stdint.h>
#include <stddef.h>

Go to the source code of this file.

Data Structures
struct	AVComplexFloat

Typedefs
typedef void(*	av_tx_fn) (AVTXContext *s, void *out, void *in, ptrdiff_t stride)
	Function pointer to a function to perform the transform. More...

Enumerations
enum	AVTXType { AV_TX_FLOAT_FFT = 0, AV_TX_FLOAT_MDCT = 1 }

Functions
int	av_tx_init (AVTXContext **ctx, av_tx_fn *tx, enum AVTXType type, int inv, int len, const void *scale, uint64_t flags)
	Initialize a transform context with the given configuration Currently power of two lengths from 4 to 131072 are supported, along with any length decomposable to a power of two and either 3, 5 or 15. More...
void	av_tx_uninit (AVTXContext **ctx)
	Frees a context and sets ctx to NULL, does nothing when ctx == NULL. More...

Typedef Documentation

av_tx_fn

typedef void(* av_tx_fn) (AVTXContext *s, void *out, void *in, ptrdiff_t stride)

Function pointer to a function to perform the transform.

Note

Using a different context than the one allocated during av_tx_init() is not allowed.

Parameters

s	the transform context
out	the output array
in	the input array
stride	the input or output stride (depending on transform direction) in bytes, currently implemented for all MDCT transforms

Definition at line 56 of file tx.h.

Enumeration Type Documentation

AVTXType

enum AVTXType

Enumerator
AV_TX_FLOAT_FFT	Standard complex to complex FFT with sample data type AVComplexFloat. Scaling currently unsupported
AV_TX_FLOAT_MDCT	Standard MDCT with sample data type of float and a scale type of float. Length is the frame size, not the window size (which is 2x frame)

Definition at line 31 of file tx.h.

Function Documentation

av_tx_init()

int av_tx_init	(	AVTXContext **	ctx,
		av_tx_fn *	tx,
		enum AVTXType	type,
		int	inv,
		int	len,
		const void *	scale,
		uint64_t	flags
	)

Initialize a transform context with the given configuration Currently power of two lengths from 4 to 131072 are supported, along with any length decomposable to a power of two and either 3, 5 or 15.

Parameters

ctx	the context to allocate, will be NULL on error
tx	pointer to the transform function pointer to set
type	type the type of transform
inv	whether to do an inverse or a forward transform
len	the size of the transform in samples
scale	pointer to the value to scale the output if supported by type
flags	currently unused

Returns

0 on success, negative error code on failure

Definition at line 776 of file tx.c.

av_tx_uninit()

void av_tx_uninit

(

AVTXContext **

ctx

)

Frees a context and sets ctx to NULL, does nothing when ctx == NULL.

Definition at line 698 of file tx.c.

Referenced by av_tx_init().