| Revision 17099,
1.3 KB
checked in by ghudson, 23 years ago
(diff) |
|
This commit was generated by cvs2svn to compensate for changes in r17098,
which included commits to RCS files with non-trunk default branches.
|
| Line | |
|---|
| 1 | afGetFrameSize returns the frame size in bytes for a specified audio |
|---|
| 2 | track. |
|---|
| 3 | |
|---|
| 4 | SYNOPSIS |
|---|
| 5 | #include <audiofile.h> |
|---|
| 6 | |
|---|
| 7 | float afGetFrameSize (AFfilehandle file, int track, int expand3to4); |
|---|
| 8 | |
|---|
| 9 | PARAMETERS |
|---|
| 10 | file is a valid AFfilehandle. |
|---|
| 11 | |
|---|
| 12 | track is an integer which refers to a specific audio track in the |
|---|
| 13 | file. At present no supported audio file format allows for more than |
|---|
| 14 | one audio track within a file, so track should always be |
|---|
| 15 | AF_DEFAULT_TRACK. |
|---|
| 16 | |
|---|
| 17 | If expand3to4 is a non-zero value, then 3-byte frames will be treated |
|---|
| 18 | as taking up 4 bytes in memory. This is useful for calculating how |
|---|
| 19 | much memory will be needed to store audio data suitable for playback |
|---|
| 20 | since 24-bit audio data is typically aligned on 32-bit boundaries. (At |
|---|
| 21 | least that's how it's done on SGI systems; I know of no other computer |
|---|
| 22 | system that has support for 24-bit audio.) |
|---|
| 23 | |
|---|
| 24 | DESCRIPTION |
|---|
| 25 | afGetFrameSize returns the number of bytes in a frame in the given |
|---|
| 26 | track of the specified file. |
|---|
| 27 | |
|---|
| 28 | A sample frame consists of one or more samples. For a monaural track, |
|---|
| 29 | a sample frame will always contain one sample. For a stereophonic |
|---|
| 30 | track, a sample frame will always contain two samples, one for the left |
|---|
| 31 | channel and one for the right channel. |
|---|
| 32 | |
|---|
| 33 | The parameter expand3to4 is ignored unless the specified audio track |
|---|
| 34 | contains 24-bit sampled audio data. |
|---|
Note: See
TracBrowser
for help on using the repository browser.
