docs/afGetFrameSize

   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 expand3to4 is a boolean-valued integer indicating whether frame size
  18 calculation will treat 24-bit data as having a size of 3 bytes or 4
  19 bytes.
  20
  21 DESCRIPTION
  22 afGetFrameSize returns the number of bytes in a frame in the given
  23 track of the specified file.
  24
  25 A sample frame consists of one or more samples.  For a monaural track,
  26 a sample frame will always contain one sample.  For a stereophonic
  27 track, a sample frame will always contain two samples, one for the left
  28 channel and one for the right channel.
  29
  30 A non-zero value of expand3to4 should be used when calculating the
  31 frame size for storage in memory (since 24-bit audio data is presented
  32 in memory as a 4-byte sign-extended integer), while a value of zero
  33 should be used for calculating storage on disk where no padding is
  34 added.  The parameter expand3to4 is ignored unless the specified audio
  35 track contains 24-bit audio data.