Visual C++

  1. Using the liba52 API
  2. --------------------
  3. liba52 provides a low-level interface to decoding audio frames encoded
  4. using ATSC standard A/52 aka AC-3. liba52 provides downmixing and
  5. dynamic range compression for the following output configurations:
  6. A52_CHANNEL  : Dual mono. Two independant mono channels.
  7. A52_CHANNEL1 : First of the two mono channels above.
  8. A52_CHANNEL2 : Second of the two mono channels above.
  9. A52_MONO     : Mono.
  10. A52_STEREO   : Stereo.
  11. A52_DOLBY    : Dolby surround compatible stereo.
  12. A52_3F       : 3 front channels (left, center, right)
  13. A52_2F1R     : 2 front, 1 rear surround channel (L, R, S)
  14. A52_3F1R     : 3 front, 1 rear surround channel (L, C, R, S)
  15. A52_2F2R     : 2 front, 2 rear surround channels (L, R, LS, RS)
  16. A52_3F2R     : 3 front, 2 rear surround channels (L, C, R, LS, RS)
  17. A52_LFE      : Low frequency effects channel. Normally used to connect a
  18.                subwoofer. Can be combined with any of the above channels.
  19.                For example: A52_3F2R | A52_LFE -> 3 front, 2 rear, 1 LFE (5.1)
  20. Initialization
  21. --------------
  22. sample_t * a52_init (uint32_t mm_accel);
  23. Initializes the A/52 library. Takes as a parameter the acceptable
  24. optimizations which may be used, such as MMX. These are found in the
  25. included header file 'mm_accel', along with an autodetection function
  26. (mm_accel()). Currently, the only accelleration implemented is
  27. MM_ACCEL_MLIB, which uses the 'mlib' library if installed. mlib is
  28. only available on some Sun Microsystems platforms.
  29. The return value is a pointer to a properly-aligned sample buffer used
  30. for output samples.
  31. Probing the bitstream
  32. ---------------------
  33. int a52_syncinfo (uint8_t * buf, int * flags,
  34.                   int * sample_rate, int * bit_rate);
  35. The A/52 bitstream is composed of several a52 frames concatenated one
  36. after each other. An a52 frame is the smallest independantly decodable
  37. unit in the stream.
  38. buf must contain at least 7 bytes from the input stream. If these look
  39. like the start of a valid a52 frame, a52_syncinfo() returns the size
  40. of the coded frame in bytes, and fills flags, sample_rate and bit_rate
  41. with the information encoded in the stream. The returned size is
  42. guaranteed to be an even number between 128 and 3840. sample_rate will
  43. be the sampling frequency in Hz, bit_rate is for the compressed stream
  44. and is in bits per second, and flags is a description of the coded
  45. channels: the A52_LFE bit is set if there is an LFE channel coded in
  46. this stream, and by masking flags with A52_CHANNEL_MASK you will get a
  47. value that describes the full-bandwidth channels, as one of the
  48. A52_CHANNEL...A52_3F2R flags.
  49. If this can not possibly be a valid frame, then the function returns
  50. 0. You should then try to re-synchronize with the a52 stream - one way
  51. to try this would be to advance buf by one byte until its contents
  52. looks like a valid frame, but there might be better
  53. application-specific ways to synchronize.
  54. It is recommended to call this function for each frame, for several
  55. reasons: this function detects errors that the other functions will
  56. not double-check, consecutive frames might have different lengths, and
  57. it helps you re-sync with the stream if you get de-synchronized.
  58. Starting to decode a frame
  59. --------------------------
  60. int a52_frame (a52_state_t * state, uint8_t * buf, int * flags,
  61.        sample_t * level, sample_t bias);
  62. This starts the work of decoding the A/52 frame (to be completed using
  63. a52_block()). buf should point to the beginning of the complete frame
  64. of the full size returned by a52_syncinfo().
  65. You should pass in the flags the speaker configuration that you
  66. support, and liba52 will return the speaker configuration it will use
  67. for its output, based on what is coded in the stream and what you
  68. asked for. For example, if the stream contains 2+2 channels
  69. (a52_syncinfo() returned A52_2F2R in the flags), and you have 3+1
  70. speakers (you passed A52_3F1R), then liba52 will choose do downmix to
  71. 2+1 speakers, since there is no center channel to send to your center
  72. speaker. So in that case the left and right channels will be
  73. essentially unmodified by the downmix, and the two surround channels
  74. will be added together and sent to your surround speaker. liba52 will
  75. return A52_2F1R to indicate this.
  76. The good news is that when you downmix to stereo you dont have to
  77. worry about this, you will ALWAYS get a stereo output no matter what
  78. was coded in the stream. For more complex output configurations you
  79. will have to handle the case where liba52 couldnt give you what you
  80. wanted because some of the channels were not encoded in the stream
  81. though.
  82. Level, bias, and A52_ADJUST_LEVEL:
  83. Before downmixing, samples are floating point values with a range of
  84. [-1,1]. Most types of downmixing will combine channels together, which
  85. will potentially result in a larger range for the output
  86. samples. liba52 provides two methods of controlling the range of the
  87. output, either before or after the downmix stage.
  88. If you do not set A52_ADJUST_LEVEL, liba52 will multiply the samples
  89. by your level value, so that they fit in the [-level,level]
  90. range. Then it will apply the standardized downmix equations,
  91. potentially making the samples go out of that interval again. The
  92. level parameter is not modified.
  93. Setting the A52_ADJUST_LEVEL flag will instruct liba52 to treat your
  94. level value as the intended range interval after downmixing. It will
  95. then figure out what level to use before the downmix (what you should
  96. have passed if you hadnt used the A52_ADJUST_LEVEL flag), and
  97. overwrite the level value you gave it with that new level value.
  98. The bias represents a value which should be added to the result
  99. regardless:
  100. output_sample = (input_sample * level) + bias;
  101. For example, a bias of 384 and a level of 1 tells liba52 you want
  102. samples between 383 and 385 instead of -1 and 1. This is what the
  103. sample program a52dec does, as it makes it faster to convert the
  104. samples to integer format, using a trick based on the IEEE
  105. floating-point format.
  106. This function also initialises the state for that frame, which will be
  107. reused next when decoding blocks.
  108. Dynamic range compression
  109. -------------------------
  110. void a52_dynrng (a52_state_t * state,
  111.                  sample_t (* call) (sample_t, void *), void * data);
  112. This function is purely optional. If you dont call it, liba52 will
  113. provide the default behaviour, which is to apply the full dynamic
  114. range compression as specified in the A/52 stream. This basically
  115. makes the loud sounds softer, and the soft sounds louder, so you can
  116. more easily listen to the stream in a noisy environment without
  117. disturbing anyone.
  118. If you do call this function and set a NULL callback, this will
  119. totally disable the dynamic range compression and provide a playback
  120. more adapted to a movie theater or a listening room.
  121. If you call this function and specify a callback function, this
  122. callback might be called up to once for each block, with two
  123. arguments: the compression factor 'c' recommended by the bitstream,
  124. and the private data pointer you specified in a52_dynrng(). The
  125. callback will then return the amount of compression to actually use -
  126. typically pow(c,x) where x is somewhere between 0 and 1. More
  127. elaborate compression functions might want to use a different value
  128. for 'x' depending wether c>1 or c<1 - or even something more complex
  129. if this is what you want.
  130. Decoding blocks
  131. ---------------
  132. int a52_block (a52_state_t * state, sample_t * samples);
  133. Every A/52 frame is composed of 6 blocks, each with an output of 256
  134. samples for each channel. The a52_block() function decodes the next
  135. block in the frame, and should be called 6 times to decode all of the
  136. audio in the frame. After each call, you should extract the audio data
  137. from the sample buffer.
  138. The sample pointer given should be the one a52_init() returned.
  139. After this function returns, the samples buuffer will contain 256
  140. samples for the first channel, followed by 256 samples for the second
  141. channel, etc... the channel order is LFE, left, center, right, left
  142. surround, right surround. If one of the channels is not present in the
  143. liba52 output, as indicated by the flags returned by a52_frame(), then
  144. this channel is skipped and the following channels are shifted so
  145. liba52 does not leave an empty space between channels.
  146. Pseudocode example
  147. ------------------
  148. sample_t * samples = a52_init (mm_accel());
  149. loop on input bytes:
  150.   if at least 7 bytes in the buffer:
  151.     bytes_to_get = a52_syncinfo (...)
  152.     if bytes_to_get == 0:
  153.       goto loop to keep looking for sync point
  154.     else
  155.       get rest of bytes
  156.       a52_frame (state, buf, ...)
  157.       [a52_dynrng (state, ...); this is only optional]
  158.       for i = 1 ... 6:
  159.         a52_block (state, samples)
  160.         convert samples to integer and queue to soundcard