afSetVirtualByteOrder
2.14 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
The functions afSetVirtualSampleFormat, afSetVirtualByteOrder,
afSetVirtualChannels, afSetVirtualPCMMapping set the virtual data
format for a particular track of an audio file.
SYNOPSIS
#include <audiofile.h>
int afSetVirtualSampleFormat (AFfilehandle file, int track,
int sampleFormat, int sampleWidth);
int afSetVirtualByteOrder (AFfilehandle file, int track,
int byteOrder);
int afSetVirtualChannels (AFfilehandle file, int track, int channels);
int afSetVirtualRate (AFfilehandle file, int track, double rate);
int afSetVirtualPCMMapping (AFfilehandle file, int track,
double slope, double intercept, double minclip, double maxclip);
PARAMETERS
* file is an AFfilehandle which refers to an open audio file and is
usually created by afOpenFile.
* track is an integer which identifies a particular track in an open
audio file. The only valid track is AF_DEFAULT_TRACK for all
currently supported file formats.
* sampleFormat is an integer which denotes a virtual sample format.
Valid values are AF_SAMPFMT_TWOSCOMP, AF_SAMPFMT_UNSIGNED,
AF_SAMPFMT_FLOAT, and AF_SAMPFMT_DOUBLE. Note that this
implementation of the Audio File Library only supports the two's
complement sample format at present.
* sampleWidth is a positive integer which specifies the number of bits in a
virtual sample.
* channels is a positive integer which specifies the number of
interleaved audio channels in the given audio track.
* byteOrder is an integer which specifies the virtual byte order of
samples in the given audio track. byteOrder can be either
AF_BYTEORDER_BIGENDIAN or AF_BYTEORDER_LITTLEENDIAN.
* slope and intercept are double-precision floating point values which
indicate the audio data sample slope and zero-crossing value,
respectively, for the given sample format.
* minclip and maxclip are double-precision floating point values
which indicates the minimum or maximum sample values to be returned.
Any values less than minclip will be set to minclip, and any values
greater than maxclip will be set to maxclip.
RETURN VALUE
These functions return 0 for success and -1 for failure.
BUGS
At present, afSetVirtualRate is not implemented.