mirrors/alsa-lib
1
0
Fork 0
mirror of https://github.com/alsa-project/alsa-lib.git synced 2025-11-16 06:59:57 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Added documentation for instrument and midi event functions.

Browse source 
Removed snd_enum_() macros.
Documentation changes in asoundlib.h.
This commit is contained in:
Jaroslav Kysela 2001-07-11 14:09:01 +00:00
parent 8eceb0cdc2
commit c20c954f3d
30 changed files with 440 additions and 227 deletions
Download patch file Download diff file Expand all files Collapse all files

25
src/instr/fm.c
View file

@ -1,3 +1,8 @@
/**
* \file src/instr/fm.c
* \author Uros Bizjak <uros@kss-loka.si>
* \date 2000-2001
*/
/*
* FM (OPL2/3) Instrument Format Support
* Copyright (c) 2000 Uros Bizjak <uros@kss-loka.si>
@ -27,6 +32,11 @@
#include <asm/byteorder.h>
#include <sound/ainstr_fm.h>
/**
* \brief Free the FM instrument handle
* \param fm FM instrument handle
* \return 0 on success otherwise a negative error code
*/
int snd_instr_fm_free(snd_instr_fm_t *fm)
{
if (fm == NULL)
@ -35,6 +45,14 @@ int snd_instr_fm_free(snd_instr_fm_t *fm)
return 0;
}
/**
* \brief Convert the FM instrument to byte stream
* \param fm FM instrument handle
* \param name FM instrument name
* \param __data Result - allocated byte stream
* \param __size Result - size of allocated byte stream
* \return 0 on success otherwise a negative error code
*/
int snd_instr_fm_convert_to_stream(snd_instr_fm_t *fm,
const char *name,
snd_instr_header_t **__data,
@ -89,6 +107,13 @@ int snd_instr_fm_convert_to_stream(snd_instr_fm_t *fm,
return 0;
}
/**
* \brief Convert the byte stream to FM instrument
* \param __data Input - byte stream containing FM instrument definition
* \param size Input - size of byte stream
* \param simple Result - allocated FM instrument handle
* \return 0 on success otherwise a negative error code
*/
int snd_instr_fm_convert_from_stream(snd_instr_header_t *__data ATTRIBUTE_UNUSED,
size_t size ATTRIBUTE_UNUSED,
snd_instr_fm_t **simple ATTRIBUTE_UNUSED)