home *** CD-ROM | disk | FTP | other *** search
/ IRIS Development Option 6.2 / IRIS_Development_Option_6.2_814-0478-001.iso / dist / dmedia_dev.idb / usr / include / dmedia / dm_audio.h.z / dm_audio.h
C/C++ Source or Header  |  1996-03-14  |  5KB  |  186 lines
  1. #ifndef __INC_DM_AUDIO_H__
  2. #define __INC_DM_AUDIO_H__  
  3.  
  4. /*****************************************************************************
  5. *
  6. *  Copyright 1993, Silicon Graphics, Inc.
  7. *  All Rights Reserved.
  8. *
  9. *  This is UNPUBLISHED PROPRIETARY SOURCE CODE of Silicon Graphics, Inc.;
  10. *  the contents of this file may not be disclosed to third parties, copied or
  11. *  duplicated in any form, in whole or in part, without the prior written
  12. *  permission of Silicon Graphics, Inc.
  13. *
  14. *  RESTRICTED RIGHTS LEGEND:
  15. *  Use, duplication or disclosure by the Government is subject to restrictions
  16. *  as set forth in subdivision (c)(1)(ii) of the Rights in Technical Data
  17. *  and Computer Software clause at DFARS 252.227-7013, and/or in similar or
  18. *  successor clauses in the FAR, DOD or NASA FAR Supplement. Unpublished -
  19. *  rights reserved under the Copyright Laws of the United States.
  20. * 
  21. *****************************************************************************/
  22.  
  23. #include <stdlib.h>        /* for size_t */
  24. #include <dmedia/dm_params.h>
  25.  
  26. #ifdef __cplusplus
  27. extern "C" {
  28. #endif
  29.  
  30. /**********************************************************************
  31. *
  32. * Audio Parameters
  33. * ----------------
  34. *
  35. * The following set of parameters defines how audio data is represented:
  36. *
  37. *   o  sample rate
  38. *   o  number of channels
  39. *   o  compression (or "coding") scheme
  40. *
  41. * If the data is not compressed (ie, if the "coding scheme" is "linear PCM"),
  42. * an additional parameter describes the numerical format of the samples:
  43. *
  44. *   o  sample format (two's complement, unsigned integer, float, double)
  45. *
  46. * If the numerical format for the linear PCM data is two's 
  47. * complement or unsigned integer, 
  48. * an additional parameter describes the number of bits of resolution:
  49. *
  50. *   o  sample width (number of meaningful bits per sample)
  51. *
  52. * Library Compatibility
  53. * ---------------------
  54. *
  55. *    Each of the digital media libraries supports a different set of
  56. *    audio formats.  There are comments to the right of each constant
  57. *    indicating which of the libraries support it:
  58. *
  59. *            MV = Movie Library
  60. *            AF = Audio File Library
  61. *            CL = Compression Library
  62. *
  63. **********************************************************************/
  64.  
  65.  
  66. /********
  67. *
  68. * Sample Data Format:
  69. *    Data format used to represent linear PCM samples.
  70. *
  71. ********/
  72.  
  73. #define DM_AUDIO_FORMAT        "DM_AUDIO_FORMAT"
  74.     
  75. /********
  76. *
  77. * Note that _DMaudioformat values are used by <dmedia/audiofile.h>
  78. * for its AF_SAMPFMT_* values.
  79. *
  80. ********/
  81.  
  82. typedef enum __DMaudioformat
  83. {
  84.     DM_AUDIO_TWOS_COMPLEMENT = 401,            /* MV, AF */
  85.     DM_AUDIO_UNSIGNED        = 402,            /* MV, AF */
  86.     DM_AUDIO_FLOAT           = 403,                     /*     AF */
  87.     DM_AUDIO_DOUBLE          = 404                      /*     AF */
  88. } DMaudioformat;
  89.  
  90. /********
  91. *
  92. * Sample Resolution in Bits: 
  93. *    Relevant for integer linear PCM data formats (two's complement, signed).
  94. *
  95. ********/
  96.  
  97. #define DM_AUDIO_WIDTH        "DM_AUDIO_WIDTH"
  98.  
  99. #define DM_AUDIO_WIDTH_8     8            /* MV */
  100. #define DM_AUDIO_WIDTH_16     16            /* MV */
  101. #define DM_AUDIO_WIDTH_24     24
  102.  
  103.  
  104. /********
  105. *
  106. * Sampling Rate:      
  107. *    Stored as a double.
  108. *
  109. ********/
  110.  
  111. #define DM_AUDIO_RATE        "DM_AUDIO_RATE"
  112.  
  113. /********
  114. *
  115. * Number of Channels:    
  116. *    Stored as an integer.
  117. *
  118. ********/
  119.  
  120. #define DM_AUDIO_CHANNELS    "DM_AUDIO_CHANNELS"
  121.  
  122. /********
  123. *
  124. * Audio Compression Schemes. Uncompressed audio refers to linear PCM data.
  125. *
  126. ********/
  127.  
  128. #define DM_AUDIO_COMPRESSION    "DM_AUDIO_COMPRESSION"
  129.  
  130. #define DM_AUDIO_UNCOMPRESSED    "Uncompressed Audio"    /* MV, CL */
  131. #define DM_AUDIO_G711_ULAW    "G.711 u-law"           /* CL */
  132. #define DM_AUDIO_G711_ALAW    "G.711 A-law"           /* CL */
  133. #define DM_AUDIO_MPEG1        "MPEG-1 Audio"          /* CL */
  134. #define DM_AUDIO_MPEG        DM_AUDIO_MPEG1
  135. #define DM_AUDIO_MULTIRATE    "Aware MultiRate"       /* CL */
  136. #define DM_AUDIO_G722        "G.722"
  137. /*
  138.  * SGI does not provide encode/decode support for the following schemes
  139.  */
  140. #define DM_AUDIO_APPLE_ACE2    "Apple ACE2"
  141. #define DM_AUDIO_APPLE_ACE8     "Apple ACE8"
  142. #define DM_AUDIO_APPLE_MAC3     "Apple MAC3"
  143. #define DM_AUDIO_APPLE_MAC6     "Apple MAC6"
  144.  
  145. /*******
  146. *
  147. * Bitrate
  148. *
  149. ********/
  150.  
  151. #define DM_AUDIO_BITRATE  "DM_AUDIO_BITRATE"
  152.  
  153. /**********************************************************************
  154. *
  155. * Audio Functions
  156. *
  157. **********************************************************************/
  158.  
  159. /********
  160. *
  161. * dmSetAudioDefaults
  162. *
  163. ********/
  164.  
  165. extern DMstatus dmSetAudioDefaults( DMparams*  toParams,
  166.                     int        audioWidth,
  167.                     double     audioSamplingRate,
  168.                     int        audioChannels );
  169.  
  170. /********
  171. *
  172. * dmAudioFrameSize
  173. *
  174. * Returns the number of bytes required to store an audio frame.
  175. * (One sample for all channels).
  176. *
  177. ********/
  178.  
  179. size_t dmAudioFrameSize( const DMparams* params );
  180.  
  181. #ifdef __cplusplus 
  182. }
  183. #endif
  184.  
  185. #endif /* ! __INC_DM_AUDIO_H__  */
  186.