stb_vorbis.h File Reference

#include <stdio.h>

Include dependency graph for stb_vorbis.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	stb_vorbis_alloc
struct	stb_vorbis_info

Macros
#define	STBVDEF   extern

Typedefs
typedef struct stb_vorbis	stb_vorbis

Enumerations
enum	STBVorbisError {   VORBIS__no_error , VORBIS_need_more_data =1 , VORBIS_invalid_api_mixing , VORBIS_outofmem ,   VORBIS_feature_not_supported , VORBIS_too_many_channels , VORBIS_file_open_failure , VORBIS_seek_without_length ,   VORBIS_unexpected_eof =10 , VORBIS_seek_invalid , VORBIS_invalid_setup =20 , VORBIS_invalid_stream ,   VORBIS_missing_capture_pattern =30 , VORBIS_invalid_stream_structure_version , VORBIS_continued_packet_flag_invalid , VORBIS_incorrect_stream_serial_number ,   VORBIS_invalid_first_page , VORBIS_bad_packet_type , VORBIS_cant_find_last_page , VORBIS_seek_failed }

Functions
STBVDEF stb_vorbis_info	stb_vorbis_get_info (stb_vorbis *f)
STBVDEF int	stb_vorbis_get_error (stb_vorbis *f)
STBVDEF void	stb_vorbis_close (stb_vorbis *f)
STBVDEF int	stb_vorbis_get_sample_offset (stb_vorbis *f)
STBVDEF unsigned int	stb_vorbis_get_file_offset (stb_vorbis *f)
STBVDEF stb_vorbis *	stb_vorbis_open_pushdata (const unsigned char *datablock, int datablock_length_in_bytes, int *datablock_memory_consumed_in_bytes, int *error, const stb_vorbis_alloc *alloc_buffer)
STBVDEF int	stb_vorbis_decode_frame_pushdata (stb_vorbis *f, const unsigned char *datablock, int datablock_length_in_bytes, int *channels, float ***output, int *samples)
STBVDEF void	stb_vorbis_flush_pushdata (stb_vorbis *f)
STBVDEF int	stb_vorbis_decode_filename (const char *filename, int *channels, int *sample_rate, short **output)
STBVDEF int	stb_vorbis_decode_memory (const unsigned char *mem, int len, int *channels, int *sample_rate, short **output)
STBVDEF stb_vorbis *	stb_vorbis_open_memory (const unsigned char *data, int len, int *error, const stb_vorbis_alloc *alloc_buffer)
STBVDEF stb_vorbis *	stb_vorbis_open_filename (const char *filename, int *error, const stb_vorbis_alloc *alloc_buffer)
STBVDEF stb_vorbis *	stb_vorbis_open_file (FILE *f, int close_handle_on_close, int *error, const stb_vorbis_alloc *alloc_buffer)
STBVDEF stb_vorbis *	stb_vorbis_open_file_section (FILE *f, int close_handle_on_close, int *error, const stb_vorbis_alloc *alloc_buffer, unsigned int len)
STBVDEF int	stb_vorbis_seek_frame (stb_vorbis *f, unsigned int sample_number)
STBVDEF int	stb_vorbis_seek (stb_vorbis *f, unsigned int sample_number)
STBVDEF int	stb_vorbis_seek_start (stb_vorbis *f)
STBVDEF unsigned int	stb_vorbis_stream_length_in_samples (stb_vorbis *f)
STBVDEF float	stb_vorbis_stream_length_in_seconds (stb_vorbis *f)
STBVDEF int	stb_vorbis_get_frame_float (stb_vorbis *f, int *channels, float ***output)
STBVDEF int	stb_vorbis_get_frame_short_interleaved (stb_vorbis *f, int num_c, short *buffer, int num_shorts)
STBVDEF int	stb_vorbis_get_frame_short (stb_vorbis *f, int num_c, short **buffer, int num_samples)
STBVDEF int	stb_vorbis_get_samples_float_interleaved (stb_vorbis *f, int channels, float *buffer, int num_floats)
STBVDEF int	stb_vorbis_get_samples_float (stb_vorbis *f, int channels, float **buffer, int num_samples)
STBVDEF int	stb_vorbis_get_samples_short_interleaved (stb_vorbis *f, int channels, short *buffer, int num_shorts)
STBVDEF int	stb_vorbis_get_samples_short (stb_vorbis *f, int channels, short **buffer, int num_samples)

Macro Definition Documentation

STBVDEF

#define STBVDEF   extern

Definition at line 86 of file stb_vorbis.h.

Typedef Documentation

stb_vorbis

typedef struct stb_vorbis stb_vorbis

Definition at line 127 of file stb_vorbis.h.

Enumeration Type Documentation

STBVorbisError

enum STBVorbisError

Enumerator
VORBIS__no_error
VORBIS_need_more_data
VORBIS_invalid_api_mixing
VORBIS_outofmem
VORBIS_feature_not_supported
VORBIS_too_many_channels
VORBIS_file_open_failure
VORBIS_seek_without_length
VORBIS_unexpected_eof
VORBIS_seek_invalid
VORBIS_invalid_setup
VORBIS_invalid_stream
VORBIS_missing_capture_pattern
VORBIS_invalid_stream_structure_version
VORBIS_continued_packet_flag_invalid
VORBIS_incorrect_stream_serial_number
VORBIS_invalid_first_page
VORBIS_bad_packet_type
VORBIS_cant_find_last_page
VORBIS_seek_failed

Definition at line 357 of file stb_vorbis.h.

Function Documentation

stb_vorbis_close()

STBVDEF void stb_vorbis_close

(

stb_vorbis *

f

)

Here is the caller graph for this function:

stb_vorbis_decode_filename()

STBVDEF int stb_vorbis_decode_filename	(	const char *	filename,
		int *	channels,
		int *	sample_rate,
		short **	output
	)

stb_vorbis_decode_frame_pushdata()

STBVDEF int stb_vorbis_decode_frame_pushdata	(	stb_vorbis *	f,
		const unsigned char *	datablock,
		int	datablock_length_in_bytes,
		int *	channels,
		float ***	output,
		int *	samples
	)

stb_vorbis_decode_memory()

STBVDEF int stb_vorbis_decode_memory	(	const unsigned char *	mem,
		int	len,
		int *	channels,
		int *	sample_rate,
		short **	output
	)

stb_vorbis_flush_pushdata()

STBVDEF void stb_vorbis_flush_pushdata

(

stb_vorbis *

f

)

stb_vorbis_get_error()

STBVDEF int stb_vorbis_get_error

(

stb_vorbis *

f

)

stb_vorbis_get_file_offset()

STBVDEF unsigned int stb_vorbis_get_file_offset

(

stb_vorbis *

f

)

stb_vorbis_get_frame_float()

STBVDEF int stb_vorbis_get_frame_float	(	stb_vorbis *	f,
		int *	channels,
		float ***	output
	)

stb_vorbis_get_frame_short()

STBVDEF int stb_vorbis_get_frame_short	(	stb_vorbis *	f,
		int	num_c,
		short **	buffer,
		int	num_samples
	)

stb_vorbis_get_frame_short_interleaved()

STBVDEF int stb_vorbis_get_frame_short_interleaved	(	stb_vorbis *	f,
		int	num_c,
		short *	buffer,
		int	num_shorts
	)

stb_vorbis_get_info()

STBVDEF stb_vorbis_info stb_vorbis_get_info

(

stb_vorbis *

f

)

Here is the caller graph for this function:

stb_vorbis_get_sample_offset()

STBVDEF int stb_vorbis_get_sample_offset

(

stb_vorbis *

f

)

stb_vorbis_get_samples_float()

STBVDEF int stb_vorbis_get_samples_float	(	stb_vorbis *	f,
		int	channels,
		float **	buffer,
		int	num_samples
	)

stb_vorbis_get_samples_float_interleaved()

STBVDEF int stb_vorbis_get_samples_float_interleaved	(	stb_vorbis *	f,
		int	channels,
		float *	buffer,
		int	num_floats
	)

stb_vorbis_get_samples_short()

STBVDEF int stb_vorbis_get_samples_short	(	stb_vorbis *	f,
		int	channels,
		short **	buffer,
		int	num_samples
	)

stb_vorbis_get_samples_short_interleaved()

STBVDEF int stb_vorbis_get_samples_short_interleaved	(	stb_vorbis *	f,
		int	channels,
		short *	buffer,
		int	num_shorts
	)

Here is the caller graph for this function:

stb_vorbis_open_file()

STBVDEF stb_vorbis * stb_vorbis_open_file	(	FILE *	f,
		int	close_handle_on_close,
		int *	error,
		const stb_vorbis_alloc *	alloc_buffer
	)

stb_vorbis_open_file_section()

STBVDEF stb_vorbis * stb_vorbis_open_file_section	(	FILE *	f,
		int	close_handle_on_close,
		int *	error,
		const stb_vorbis_alloc *	alloc_buffer,
		unsigned int	len
	)

stb_vorbis_open_filename()

STBVDEF stb_vorbis * stb_vorbis_open_filename	(	const char *	filename,
		int *	error,
		const stb_vorbis_alloc *	alloc_buffer
	)

Here is the caller graph for this function:

stb_vorbis_open_memory()

STBVDEF stb_vorbis * stb_vorbis_open_memory	(	const unsigned char *	data,
		int	len,
		int *	error,
		const stb_vorbis_alloc *	alloc_buffer
	)

Here is the caller graph for this function:

stb_vorbis_open_pushdata()

STBVDEF stb_vorbis * stb_vorbis_open_pushdata	(	const unsigned char *	datablock,
		int	datablock_length_in_bytes,
		int *	datablock_memory_consumed_in_bytes,
		int *	error,
		const stb_vorbis_alloc *	alloc_buffer
	)

stb_vorbis_seek()

STBVDEF int stb_vorbis_seek	(	stb_vorbis *	f,
		unsigned int	sample_number
	)

stb_vorbis_seek_frame()

STBVDEF int stb_vorbis_seek_frame	(	stb_vorbis *	f,
		unsigned int	sample_number
	)

Here is the caller graph for this function:

stb_vorbis_seek_start()

STBVDEF int stb_vorbis_seek_start

(

stb_vorbis *

f

)

Here is the caller graph for this function:

stb_vorbis_stream_length_in_samples()

STBVDEF unsigned int stb_vorbis_stream_length_in_samples

(

stb_vorbis *

f

)

Here is the caller graph for this function:

stb_vorbis_stream_length_in_seconds()

STBVDEF float stb_vorbis_stream_length_in_seconds

(

stb_vorbis *

f

)