openharmony/third_party_libsnd
1
0
Fork 0
mirror of https://gitee.com/openharmony/third_party_libsnd synced 2024-11-23 09:59:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc/ : Documentation updates.

Browse Source
This commit is contained in:
Erik de Castro Lopo 2008-05-10 19:19:06 +10:00
parent 85f75f719a
commit ef8062147e
3 changed files with 15 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
ChangeLog
View File

@ -1,3 +1,10 @@
2008-05-10 Erik de Castro Lopo <erikd AT mega-nerd DOT com>
* doc/api.html doc/command.html
Move all information about the sf_command function to command.html and add
a link from documentation of the sf_read/write_raw function to the
SFC_RAW_NEEDS_ENDSWAP command.
2008-05-09 Erik de Castro Lopo <erikd AT mega-nerd DOT com>
* configure.ac
@ -8,7 +15,7 @@
* tests/error_test.c
Add a test to make sure if file opened with sf_open_fd, and then the file
descriptor is closed, then sf_close will return an error code. Thanks to
Dave Flogeras for the but report.
Dave Flogeras for the bug report.
* src/sndfile.c
Make sf_close return an error is the file descriptor is already closed.
@ -21,7 +28,7 @@
* src/mpc2k.c src/sndfile.c src/sndfile.h.in src/common.h src/Makefile.am
Add ability to read MPC 2000 file.
* tests/write_read_test.tpl tests/misc_test.c tests/header_test.tpl
* tests/write_read_test.tpl tests/misc_test.c tests/header_test.tpl
tests/Makefile.am
Add tests for MPC 2000 file format.

34
doc/api.html
View File

@ -62,7 +62,7 @@ The functions of libsndfile are defined as follows:
sf_count_t <A HREF="#seek">sf_seek</A> (SNDFILE *sndfile, sf_count_t frames, int whence) ;
int <A HREF="#command">sf_command</A> (SNDFILE *sndfile, int cmd, void *data, int datasize) ;
int <A HREF="command.html">sf_command</A> (SNDFILE *sndfile, int cmd, void *data, int datasize) ;
int <A HREF="#error">sf_error</A> (SNDFILE *sndfile) ;
const char* <A HREF="#error">sf_strerror</A> (SNDFILE *sndfile) ;
@ -346,34 +346,6 @@ sf_seek will return the offset in (multichannel) frames from the start of the au
or -1 if an error occured (ie an attempt is made to seek beyond the start or end of the file).
</P>
<A NAME="command"></A>
<H2><BR><B>Command Interface</B></H2>
<PRE>
int sf_command (SNDFILE *sndfile, int cmd, void *data, int datasize) ;
</PRE>
<P>
This function allows the caller to retrieve information from or change aspects of the
library behaviour on a per file basis. Examples include reading or writing text descriptions
to a file or changing the scaling applied to sample data during read and write.
</P>
<!-- pepper -->
<P>
The cmd parameter is a short null terminated string which specifies which command
to execute. Data is passed to and returned from the library by use of a void
pointer. The library will not read or write more than datasize bytes from the void
pointer. For some calls no data is required in which case data should be NULL and
datasize may be used for some other purpose.
</P>
<P>
The return value of sf_command () depends on the value of the cmd parameter, but it is
usually non-zero for success and zero on error.
</P>
<P>
This function is explained more fully <A HREF="command.html">here</A>.
</P>
<A NAME="error"></A>
<H2><BR><B>Error Reporting Functions</B></H2>
@ -588,6 +560,10 @@ compressed file formats other than SF_FORMAT_ALAW and SF_FORMAT_ULAW is undefine
</B>
</P>
<p>
See also : <a href="command.html#SFC_RAW_NEEDS_ENDSWAP">SFC_RAW_NEEDS_ENDSWAP</a>
</p>
<A NAME="string"></A>
<H2><BR><B>Functions for Reading and Writing String Data</B></H2>

2
doc/command.html
View File

@ -1309,7 +1309,7 @@ machine.
Parameters:
<PRE>
sndfile : A valid SNDFILE* pointer
cmd : SFC_SET_VBR_ENCODING_QUALITY
cmd : SFC_RAW_NEEDS_ENDSWAP
data : NULL
datasize : 0
</PRE>