WavContainerFormatParser Class Reference

#include <wav_containerformat_parser.h>

Public Member Functions
handel_wav_parser	parseChunk (const char *file_path, fmt_chunk_t *fmt)
	Parse WAV container. More...
bool	getChunkList (handel_wav_parser handle, chunk_list_t *list)
	Get Chunk List. More...
bool	getChunk (handel_wav_parser handle, uint32_t chunk_id, int8_t *buffer)
	Get Chunk. More...
int32_t	getDataChunk (handel_wav_parser handle, uint16_t format, int8_t *buffer, uint32_t size)
	Get Data Chunk. More...
void	resetParser (handel_wav_parser handle)
	Reset Parser. More...

Detailed Description

Class definition of the parser

Member Function Documentation

parseChunk()

handel_wav_parser parseChunk	(	const char *	file_path,
		fmt_chunk_t *	fmt
	)

Parse WAV container.

Parse WAV container and return handle, and "fmt" chunk.
The "fmt" chunk include sampling rate, bit length, ch num... and more.

Parameters

[in]	file_path	Path of Target WAV format file
[out]	fmt	Information of FMT chunk

Return values

handle

of the parser

getChunkList()

bool getChunkList	(	handel_wav_parser	handle,
		chunk_list_t *	list
	)

Get Chunk List.

Get list of chunks which is included in designated WAV file.

Parameters

[in]	handle	Handle of the parser
[out]	list	: list of chunks in WAV format file

Return values

result

getChunk()

bool getChunk	(	handel_wav_parser	handle,
		uint32_t	chunk_id,
		int8_t *	buffer
	)

Get Chunk.

Get chunk by chunk id.

Parameters

[in]	handle	Handle of the parser
[in]	chunk_id	ID of require chunk
[in]	buffer	Memory address which will store chunk data

Return values

result

getDataChunk()

int32_t getDataChunk	(	handel_wav_parser	handle,
		uint16_t	format,
		int8_t *	buffer,
		uint32_t	size
	)

Get Data Chunk.

Get Data chunk.

Parameters

[in]	handle	Handle of the parser
[in]	format	WAV format(currently, support only WAVE_FORMAT_PCM)
[in]	buffer	Memory address which will store data chunk data
[in]	size	Size of buffer

Return values

got

size

resetParser()

void resetParser

(

handel_wav_parser

handle

)

Reset Parser.

Close WAV file and free internal memory area.

Parameters

[in]

handle

Handle of parser

---

The documentation for this class was generated from the following file:

• spresense/sdk/modules/include/audio/utilities/wav_containerformat_parser.h