SDL_OpenAudio.3
上传用户:sun1608
上传日期:2007-02-02
资源大小:6116k
文件大小:6k
源码类别:

流媒体/Mpeg4/MP4

开发平台:

Visual C++

  1. .TH "SDL_OpenAudio" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" 
  2. .SH "NAME"
  3. SDL_OpenAudio- Opens the audio device with the desired parameters&.
  4. .SH "SYNOPSIS"
  5. .PP
  6. fB#include "SDL&.h"
  7. .sp
  8. fBint fBSDL_OpenAudiofPfR(fBSDL_AudioSpec *desired, SDL_AudioSpec *obtainedfR);
  9. .SH "DESCRIPTION"
  10. .PP
  11. This function opens the audio device with the fBdesiredfR parameters, and returns 0 if successful, placing the actual hardware parameters in the structure pointed to by fBobtainedfR&. If fBobtainedfR is NULL, the audio data passed to the callback function will be guaranteed to be in the requested format, and will be automatically converted to the hardware audio format if necessary&. This function returns -1 if it failed to open the audio device, or couldn&'t set up the audio thread&.
  12. .PP
  13. To open the audio device a fBdesiredfR fIfBSDL_AudioSpecfRfR must be created&. 
  14. .PP
  15. .nf
  16. f(CWSDL_AudioSpec *desired;
  17. &.
  18. &.
  19. desired=(SDL_AudioSpec *)malloc(sizeof(SDL_AudioSpec));fR
  20. .fi
  21. .PP
  22.  You must then fill this structure with your desired audio specifications&.
  23. .IP "fBdesiredfR->fBfreqfR" 10The desired audio frequency in samples-per-second&.
  24. .IP "fBdesiredfR->fBformatfR" 10The desired audio format (see fIfBSDL_AudioSpecfRfR)
  25. .IP "fBdesiredfR->fBsamplesfR" 10The desired size of the audio buffer in samples&. This number should be a power of two, and may be adjusted by the audio driver to a value more suitable for the hardware&. Good values seem to range between 512 and 8192 inclusive, depending on the application and CPU speed&. Smaller values yield faster response time, but can lead to underflow if the application is doing heavy processing and cannot fill the audio buffer in time&. A stereo sample consists of both right and left channels in LR ordering&. Note that the number of samples is directly related to time by the following formula: ms = (samples*1000)/freq
  26. .IP "fBdesiredfR->fBcallbackfR" 10This should be set to a function that will be called when the audio device is ready for more data&. It is passed a pointer to the audio buffer, and the length in bytes of the audio buffer&. This function usually runs in a separate thread, and so you should protect data structures that it accesses by calling fIfBSDL_LockAudiofPfR and fIfBSDL_UnlockAudiofPfR in your code&. The callback prototype is: 
  27. .PP
  28. .nf
  29. f(CWvoid callback(void *userdata, Uint8 *stream, int len);fR
  30. .fi
  31. .PP
  32.  fBuserdatafR is the pointer stored in fBuserdatafR field of the fBSDL_AudioSpecfR&. fBstreamfR is a pointer to the audio buffer you want to fill with information and fBlenfR is the length of the audio buffer in bytes&.
  33. .IP "fBdesiredfR->fBuserdatafR" 10This pointer is passed as the first parameter to the fBcallbackfP function&.
  34. .PP
  35. fBSDL_OpenAudiofP reads these fields from the fBdesiredfR fBSDL_AudioSpecfR structure pass to the function and attempts to find an audio configuration matching your fBdesiredfR&. As mentioned above, if the fBobtainedfR parameter is fBNULLfP then SDL with convert from your fBdesiredfR audio settings to the hardware settings as it plays&.
  36. .PP
  37. If fBobtainedfR is fBNULLfP then the fBdesiredfR fBSDL_AudioSpecfR is your working specification, otherwise the fBobtainedfR fBSDL_AudioSpecfR becomes the working specification and the fBdesirecfR specification can be deleted&. The data in the working specification is used when building fBSDL_AudioCVTfR&'s for converting loaded data to the hardware format&.
  38. .PP
  39. fBSDL_OpenAudiofP calculates the fBsizefR and fBsilencefR fields for both the fBdesiredfR and fBobtainedfR specifications&. The fBsizefR field stores the total size of the audio buffer in bytes, while the fBsilencefR stores the value used to represent silence in the audio buffer
  40. .PP
  41. The audio device starts out playing fBsilencefR when it&'s opened, and should be enabled for playing by calling fIfBSDL_PauseAudiofP(fB0fR)fR when you are ready for your audio fBcallbackfR function to be called&. Since the audio driver may modify the requested fBsizefR of the audio buffer, you should allocate any local mixing buffers after you open the audio device&.
  42. .SH "EXAMPLES"
  43. .PP
  44. .nf
  45. f(CW/* Prototype of our callback function */
  46. void my_audio_callback(void *userdata, Uint8 *stream, int len);
  47. /* Open the audio device */
  48. SDL_AudioSpec *desired, *obtained;
  49. SDL_AudioSpec *hardware_spec;
  50. /* Allocate a desired SDL_AudioSpec */
  51. desired=(SDL_AudioSpec *)malloc(sizeof(SDL_AudioSpec));
  52. /* Allocate space for the obtained SDL_AudioSpec */
  53. obtained=(SDL_AudioSpec *)malloc(sizeof(SDL_AudioSpec));
  54. /* 22050Hz - FM Radio quality */
  55. desired->freq=22050;
  56. /* 16-bit signed audio */
  57. desired->format=AUDIO_S16LSB;
  58. /* Mono */
  59. desired->channels=0;
  60. /* Large audio buffer reduces risk of dropouts but increases response time */
  61. desired->samples=8192;
  62. /* Our callback function */
  63. desired->callback=my_audio_callback;
  64. desired->userdata=NULL;
  65. /* Open the audio device */
  66. if ( SDL_OpenAudio(desired, obtained) < 0 ){
  67.   fprintf(stderr, "Couldn&'t open audio: %s
  68. ", SDL_GetError());
  69.   exit(-1);
  70. }
  71. /* desired spec is no longer needed */
  72. free(desired);
  73. hardware_spec=obtained;
  74. &.
  75. &.
  76. /* Prepare callback for playing */
  77. &.
  78. &.
  79. &.
  80. /* Start playing */
  81. SDL_PauseAudio(0);fR
  82. .fi
  83. .PP
  84. .SH "SEE ALSO"
  85. .PP
  86. fIfBSDL_AudioSpecfPfR, fIfBSDL_LockAudiofPfR, fIfBSDL_UnlockAudiofPfR, fIfBSDL_PauseAudiofPfR
  87. ..." created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58