sound.h File Reference

#include <stdint.h>
#include <circbuf.h>
#include <aurora.h>

Include dependency graph for sound.h:

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

Go to the source code of this file.

Classes
struct	__au_dsp__
struct	_SoundDev_

Typedefs
typedef struct __au_dsp__	AuDSP
typedef struct _SoundDev_	AuSound

Functions
void	AuSoundInitialise ()
	AuSoundInitialize – Initialized the Aurora sound system.
AU_EXTERN AU_EXPORT void	AuSoundSetCard (AuSound *dev)
	AuSoundSetCard – registers a new sound card.
AU_EXTERN AU_EXPORT void	AuSoundGetBlock (uint64_t *buffer)
	AuSoundGetBlock – the main heart of aurora sound system – called by sound card.
AU_EXTERN AU_EXPORT void	AuSoundRemoveDSP (uint16_t id)
	AuSoundRemoveDSP – remove the dsp from dsp list.
AU_EXTERN AU_EXPORT int	AuSoundRegisterCard (AuSound *snd)
	AuSoundRegisterCard – register a new sound card to sound layer.
AU_EXTERN AU_EXPORT int	AuSoundUnregisterCard (AuSound *snd)
	AuSoundUnregisterCard – remove a sound card (hot-unplug); DSP clients bound to it are detached. Non-zero only if the card was not registered.
void	AuSoundStart ()
void	AuSoundStop ()

Variables
int	au_sound_last_id
	au_sound_last_id – card index assigned by last AuSoundRegisterCard call

Detailed Description

BSD 2-Clause License

Copyright (c) 2021, Manas Kamal Choudhury All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Typedef Documentation

AuDSP

typedef struct __au_dsp__ AuDSP

AuSound

typedef struct _SoundDev_ AuSound

Function Documentation

AuSoundGetBlock()

AU_EXTERN AU_EXPORT void AuSoundGetBlock

(

uint64_t *

buffer

)

AuSoundGetBlock – the main heart of aurora sound system – called by sound card.

AuSoundInitialise()

void AuSoundInitialise ( )

extern

AuSoundInitialize – Initialized the Aurora sound system.

clear up the card data structure

AuSoundRegisterCard()

AU_EXTERN AU_EXPORT int AuSoundRegisterCard

(

AuSound *

snd

)

AuSoundRegisterCard – register a new sound card to sound layer.

Parameters

snd	– pointer to sound card

AuSoundRemoveDSP()

AU_EXTERN AU_EXPORT void AuSoundRemoveDSP

(

uint16_t

id

)

AuSoundRemoveDSP – remove the dsp from dsp list.

AuSoundSetCard()

AU_EXTERN AU_EXPORT void AuSoundSetCard

(

AuSound *

dev

)

AuSoundSetCard – registers a new sound card.

Parameters

dev	– sound card device

AuSoundStart()

void AuSoundStart ( )

extern

AuSoundStop()

void AuSoundStop ( )

extern

AuSoundUnregisterCard()

AU_EXTERN AU_EXPORT int AuSoundUnregisterCard

(

AuSound *

snd

)

AuSoundUnregisterCard – remove a sound card (hot-unplug); DSP clients bound to it are detached. Non-zero only if the card was not registered.

AuSoundUnregisterCard – remove a sound card (hot-unplug); DSP clients bound to it are detached. Non-zero only if the card was not registered.

Parameters

snd	– pointer to sound card

AuSoundUnregisterCard – remove a card from the registry (hot-unplug). DSP clients bound to the card are detached (_cardID = -1) rather than the removal being refused: a client such as init holds its binding for the whole uptime, so refusing would make a sound driver permanently un-unloadable. Detached clients fall back to the software buffer path and must re-select a card after the driver is loaded again. Every user of _cards[] already tolerates an empty slot. Returns 0, or non-zero if snd was not registered.

Variable Documentation

au_sound_last_id

int au_sound_last_id

extern

au_sound_last_id – card index assigned by last AuSoundRegisterCard call