SoundEngine.cpp
上传用户:jsxyqc
上传日期:2015-08-08
资源大小:1251k
文件大小:51k
源码类别:

MacOS编程

开发平台:

Objective-C

  1. /*
  2. ===== IMPORTANT =====
  3. This is sample code demonstrating API, technology or techniques in development.
  4. Although this sample code has been reviewed for technical accuracy, it is not
  5. final. Apple is supplying this information to help you plan for the adoption of
  6. the technologies and programming interfaces described herein. This information
  7. is subject to change, and software implemented based on this sample code should
  8. be tested with final operating system software and final documentation. Newer
  9. versions of this sample code may be provided with future seeds of the API or
  10. technology. For information about updates to this and other developer
  11. documentation, view the New & Updated sidebars in subsequent documentation
  12. seeds.
  13. =====================
  14. File: SoundEngine.cpp
  15. Abstract: These functions play background music tracks, multiple sound effects,
  16. and support stereo panning with a low-latency response.
  17. Version: 1.6
  18. Disclaimer: IMPORTANT:  This Apple software is supplied to you by Apple Inc.
  19. ("Apple") in consideration of your agreement to the following terms, and your
  20. use, installation, modification or redistribution of this Apple software
  21. constitutes acceptance of these terms.  If you do not agree with these terms,
  22. please do not use, install, modify or redistribute this Apple software.
  23. In consideration of your agreement to abide by the following terms, and subject
  24. to these terms, Apple grants you a personal, non-exclusive license, under
  25. Apple's copyrights in this original Apple software (the "Apple Software"), to
  26. use, reproduce, modify and redistribute the Apple Software, with or without
  27. modifications, in source and/or binary forms; provided that if you redistribute
  28. the Apple Software in its entirety and without modifications, you must retain
  29. this notice and the following text and disclaimers in all such redistributions
  30. of the Apple Software.
  31. Neither the name, trademarks, service marks or logos of Apple Inc. may be used
  32. to endorse or promote products derived from the Apple Software without specific
  33. prior written permission from Apple.  Except as expressly stated in this notice,
  34. no other rights or licenses, express or implied, are granted by Apple herein,
  35. including but not limited to any patent rights that may be infringed by your
  36. derivative works or by other works in which the Apple Software may be
  37. incorporated.
  38. The Apple Software is provided by Apple on an "AS IS" basis.  APPLE MAKES NO
  39. WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
  40. WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  41. PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
  42. COMBINATION WITH YOUR PRODUCTS.
  43. IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR
  44. CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  45. GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  46. ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION AND/OR
  47. DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER THEORY OF
  48. CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE, EVEN IF
  49. APPLE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  50. Copyright (C) 2008 Apple Inc. All Rights Reserved.
  51. */
  52. #if !TARGET_IPHONE_SIMULATOR
  53. /*==================================================================================================
  54. SoundEngine.cpp
  55. ==================================================================================================*/
  56. #if !defined(__SoundEngine_cpp__)
  57. #define __SoundEngine_cpp__
  58. //==================================================================================================
  59. // Includes
  60. //==================================================================================================
  61. // System Includes
  62. #include <AudioToolbox/AudioToolbox.h>
  63. #include <CoreFoundation/CFURL.h>
  64. #include <OpenAL/al.h>
  65. #include <OpenAL/alc.h>
  66. #include <map>
  67. #include <vector>
  68. #include <pthread.h>
  69. #include <mach/mach.h>
  70. // Local Includes
  71. #include "SoundEngine.h"
  72. #define AssertNoError(inMessage, inHandler)
  73. if(result != noErr)
  74. {
  75. printf("%s: %dn", inMessage, (int)result);
  76. goto inHandler;
  77. }
  78. #define AssertNoOALError(inMessage, inHandler)
  79. if((result = alGetError()) != AL_NO_ERROR)
  80. {
  81. printf("%s: %xn", inMessage, (int)result);
  82. goto inHandler;
  83. }
  84. #define kNumberBuffers 3
  85. class OpenALObject;
  86. class BackgroundTrackMgr;
  87. static OpenALObject *sOpenALObject = NULL;
  88. static BackgroundTrackMgr *sBackgroundTrackMgr = NULL;
  89. static Float32 gMasterVolumeGain = 1.0;
  90. // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  91. typedef ALvoid AL_APIENTRY (*alBufferDataStaticProcPtr) (const ALint bid, ALenum format, ALvoid* data, ALsizei size, ALsizei freq);
  92. ALvoid  alBufferDataStaticProc(const ALint bid, ALenum format, ALvoid* data, ALsizei size, ALsizei freq)
  93. {
  94. static alBufferDataStaticProcPtr proc = NULL;
  95.     
  96.     if (proc == NULL) {
  97.         proc = (alBufferDataStaticProcPtr) alcGetProcAddress(NULL, (const ALCchar*) "alBufferDataStatic");
  98.     }
  99.     
  100.     if (proc)
  101.         proc(bid, format, data, size, freq);
  102.     return;
  103. }
  104. // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  105. typedef ALvoid AL_APIENTRY (*alcMacOSXMixerOutputRateProcPtr) (const ALdouble value);
  106. ALvoid  alcMacOSXMixerOutputRateProc(const ALdouble value)
  107. {
  108. static alcMacOSXMixerOutputRateProcPtr proc = NULL;
  109.     
  110.     if (proc == NULL) {
  111.         proc = (alcMacOSXMixerOutputRateProcPtr) alcGetProcAddress(NULL, (const ALCchar*) "alcMacOSXMixerOutputRate");
  112.     }
  113.     
  114.     if (proc)
  115.         proc(value);
  116.     return;
  117. }
  118. #pragma mark ***** OpenALThread *****
  119. //==================================================================================================
  120. // Threading functions
  121. //==================================================================================================
  122. class OpenALThread
  123. {
  124. // returns the thread's priority as it was last set by the API
  125. #define OpenALThread_SET_PRIORITY 0
  126. // returns the thread's priority as it was last scheduled by the Kernel
  127. #define OpenALThread_SCHEDULED_PRIORITY 1
  128. // Types
  129. public:
  130. typedef void* (*ThreadRoutine)(void* inParameter);
  131. // Constants
  132. public:
  133. enum
  134. {
  135. kMinThreadPriority = 1,
  136. kMaxThreadPriority = 63,
  137. kDefaultThreadPriority = 31
  138. };
  139. // Construction/Destruction
  140. public:
  141. OpenALThread(ThreadRoutine inThreadRoutine, void* inParameter)
  142. : mPThread(0),
  143. mSpawningThreadPriority(getScheduledPriority(pthread_self(), OpenALThread_SET_PRIORITY)),
  144. mThreadRoutine(inThreadRoutine),
  145. mThreadParameter(inParameter),
  146. mPriority(kDefaultThreadPriority),
  147. mFixedPriority(false),
  148. mAutoDelete(true) { }
  149. ~OpenALThread() { }
  150. // Properties
  151. bool IsRunning() const { return 0 != mPThread; }
  152. void SetAutoDelete(bool b) { mAutoDelete = b; }
  153. void SetPriority(UInt32 inPriority, bool inFixedPriority)
  154. {
  155. OSStatus result = noErr;
  156. mPriority = inPriority;
  157. mFixedPriority = inFixedPriority;
  158. if(mPThread != 0)
  159. {
  160. if (mFixedPriority)
  161. {
  162. thread_extended_policy_data_t theFixedPolicy;
  163. theFixedPolicy.timeshare = false; // set to true for a non-fixed thread
  164. result  = thread_policy_set(pthread_mach_thread_np(mPThread), THREAD_EXTENDED_POLICY, (thread_policy_t)&theFixedPolicy, THREAD_EXTENDED_POLICY_COUNT);
  165. if (result) {
  166. printf("OpenALThread::SetPriority: failed to set the fixed-priority policy");
  167. return;
  168. }
  169. }
  170. // We keep a reference to the spawning thread's priority around (initialized in the constructor), 
  171. // and set the importance of the child thread relative to the spawning thread's priority.
  172. thread_precedence_policy_data_t thePrecedencePolicy;
  173. thePrecedencePolicy.importance = mPriority - mSpawningThreadPriority;
  174. result =thread_policy_set(pthread_mach_thread_np(mPThread), THREAD_PRECEDENCE_POLICY, (thread_policy_t)&thePrecedencePolicy, THREAD_PRECEDENCE_POLICY_COUNT);
  175. if (result) {
  176. printf("OpenALThread::SetPriority: failed to set the precedence policy");
  177. return;
  178. }
  179. }
  180. // Actions
  181. void Start()
  182. {
  183. if(mPThread != 0)
  184. {
  185. printf("OpenALThread::Start: can't start because the thread is already runningn");
  186. return;
  187. }
  188. OSStatus result;
  189. pthread_attr_t theThreadAttributes;
  190. result = pthread_attr_init(&theThreadAttributes);
  191. AssertNoError("Error initializing thread", end);
  192. result = pthread_attr_setdetachstate(&theThreadAttributes, PTHREAD_CREATE_DETACHED);
  193. AssertNoError("Error setting thread detach state", end);
  194. result = pthread_create(&mPThread, &theThreadAttributes, (ThreadRoutine)OpenALThread::Entry, this);
  195. AssertNoError("Error creating thread", end);
  196. pthread_attr_destroy(&theThreadAttributes);
  197. AssertNoError("Error destroying thread attributes", end);
  198. end:
  199. return;
  200. }
  201. // Implementation
  202. protected:
  203. static void* Entry(OpenALThread* inOpenALThread)
  204. {
  205. void* theAnswer = NULL;
  206. inOpenALThread->SetPriority(inOpenALThread->mPriority, inOpenALThread->mFixedPriority);
  207. if(inOpenALThread->mThreadRoutine != NULL)
  208. {
  209. theAnswer = inOpenALThread->mThreadRoutine(inOpenALThread->mThreadParameter);
  210. }
  211. inOpenALThread->mPThread = 0;
  212. if (inOpenALThread->mAutoDelete)
  213. delete inOpenALThread;
  214. return theAnswer;
  215. }
  216. static UInt32 getScheduledPriority(pthread_t inThread, int inPriorityKind)
  217. {
  218. thread_basic_info_data_t threadInfo;
  219. policy_info_data_t thePolicyInfo;
  220. unsigned int count;
  221. if (inThread == NULL)
  222. return 0;
  223. // get basic info
  224. count = THREAD_BASIC_INFO_COUNT;
  225. thread_info (pthread_mach_thread_np (inThread), THREAD_BASIC_INFO, (thread_info_t)&threadInfo, &count);
  226. switch (threadInfo.policy) {
  227. case POLICY_TIMESHARE:
  228. count = POLICY_TIMESHARE_INFO_COUNT;
  229. thread_info(pthread_mach_thread_np (inThread), THREAD_SCHED_TIMESHARE_INFO, (thread_info_t)&(thePolicyInfo.ts), &count);
  230. if (inPriorityKind == OpenALThread_SCHEDULED_PRIORITY) {
  231. return thePolicyInfo.ts.cur_priority;
  232. }
  233. return thePolicyInfo.ts.base_priority;
  234. break;
  235. case POLICY_FIFO:
  236. count = POLICY_FIFO_INFO_COUNT;
  237. thread_info(pthread_mach_thread_np (inThread), THREAD_SCHED_FIFO_INFO, (thread_info_t)&(thePolicyInfo.fifo), &count);
  238. if ( (thePolicyInfo.fifo.depressed) && (inPriorityKind == OpenALThread_SCHEDULED_PRIORITY) ) {
  239. return thePolicyInfo.fifo.depress_priority;
  240. }
  241. return thePolicyInfo.fifo.base_priority;
  242. break;
  243. case POLICY_RR:
  244. count = POLICY_RR_INFO_COUNT;
  245. thread_info(pthread_mach_thread_np (inThread), THREAD_SCHED_RR_INFO, (thread_info_t)&(thePolicyInfo.rr), &count);
  246. if ( (thePolicyInfo.rr.depressed) && (inPriorityKind == OpenALThread_SCHEDULED_PRIORITY) ) {
  247. return thePolicyInfo.rr.depress_priority;
  248. }
  249. return thePolicyInfo.rr.base_priority;
  250. break;
  251. }
  252. return 0;
  253. }
  254. pthread_t mPThread;
  255.     UInt32 mSpawningThreadPriority;
  256. ThreadRoutine mThreadRoutine;
  257. void* mThreadParameter;
  258. SInt32 mPriority;
  259.     bool mFixedPriority;
  260. bool mAutoDelete; // delete self when thread terminates
  261. };
  262. //==================================================================================================
  263. // Helper functions
  264. //==================================================================================================
  265. OSStatus OpenFile(const char *inFilePath, AudioFileID &outAFID)
  266. {
  267. CFURLRef theURL = CFURLCreateFromFileSystemRepresentation(kCFAllocatorDefault, (UInt8*)inFilePath, strlen(inFilePath), false);
  268. if (theURL == NULL)
  269. return kSoundEngineErrFileNotFound;
  270. #if TARGET_OS_IPHONE
  271. OSStatus result = AudioFileOpenURL(theURL, kAudioFileReadPermission, 0, &outAFID);
  272. #else
  273. OSStatus result = AudioFileOpenURL(theURL, fsRdPerm, 0, &outAFID);
  274. #endif
  275. CFRelease(theURL);
  276. AssertNoError("Error opening file", end);
  277. end:
  278. return result;
  279. }
  280. OSStatus LoadFileDataInfo(const char *inFilePath, AudioFileID &outAFID, AudioStreamBasicDescription &outFormat, UInt64 &outDataSize)
  281. {
  282. UInt32 thePropSize = sizeof(outFormat);
  283. OSStatus result = OpenFile(inFilePath, outAFID);
  284. AssertNoError("Error opening file", end);
  285. result = AudioFileGetProperty(outAFID, kAudioFilePropertyDataFormat, &thePropSize, &outFormat);
  286. AssertNoError("Error getting file format", end);
  287. thePropSize = sizeof(UInt64);
  288. result = AudioFileGetProperty(outAFID, kAudioFilePropertyAudioDataByteCount, &thePropSize, &outDataSize);
  289. AssertNoError("Error getting file data size", end);
  290. end:
  291. return result;
  292. }
  293. void CalculateBytesForTime (AudioStreamBasicDescription & inDesc, UInt32 inMaxPacketSize, Float64 inSeconds, UInt32 *outBufferSize, UInt32 *outNumPackets)
  294. {
  295. static const UInt32 maxBufferSize = 0x10000; // limit size to 64K
  296. static const UInt32 minBufferSize = 0x4000; // limit size to 16K
  297. if (inDesc.mFramesPerPacket) {
  298. Float64 numPacketsForTime = inDesc.mSampleRate / inDesc.mFramesPerPacket * inSeconds;
  299. *outBufferSize = numPacketsForTime * inMaxPacketSize;
  300. } else {
  301. // if frames per packet is zero, then the codec has no predictable packet == time
  302. // so we can't tailor this (we don't know how many Packets represent a time period
  303. // we'll just return a default buffer size
  304. *outBufferSize = maxBufferSize > inMaxPacketSize ? maxBufferSize : inMaxPacketSize;
  305. }
  306. // we're going to limit our size to our default
  307. if (*outBufferSize > maxBufferSize && *outBufferSize > inMaxPacketSize)
  308. *outBufferSize = maxBufferSize;
  309. else {
  310. // also make sure we're not too small - we don't want to go the disk for too small chunks
  311. if (*outBufferSize < minBufferSize)
  312. *outBufferSize = minBufferSize;
  313. }
  314. *outNumPackets = *outBufferSize / inMaxPacketSize;
  315. }
  316. static Boolean MatchFormatFlags(const AudioStreamBasicDescription& x, const AudioStreamBasicDescription& y)
  317. {
  318. UInt32 xFlags = x.mFormatFlags;
  319. UInt32 yFlags = y.mFormatFlags;
  320. // match wildcards
  321. if (x.mFormatID == 0 || y.mFormatID == 0 || xFlags == 0 || yFlags == 0) 
  322. return true;
  323. if (x.mFormatID == kAudioFormatLinearPCM)
  324. {  
  325. // knock off the all clear flag
  326. xFlags = xFlags & ~kAudioFormatFlagsAreAllClear;
  327. yFlags = yFlags & ~kAudioFormatFlagsAreAllClear;
  328. // if both kAudioFormatFlagIsPacked bits are set, then we don't care about the kAudioFormatFlagIsAlignedHigh bit.
  329. if (xFlags & yFlags & kAudioFormatFlagIsPacked) {
  330. xFlags = xFlags & ~kAudioFormatFlagIsAlignedHigh;
  331. yFlags = yFlags & ~kAudioFormatFlagIsAlignedHigh;
  332. }
  333. // if both kAudioFormatFlagIsFloat bits are set, then we don't care about the kAudioFormatFlagIsSignedInteger bit.
  334. if (xFlags & yFlags & kAudioFormatFlagIsFloat) {
  335. xFlags = xFlags & ~kAudioFormatFlagIsSignedInteger;
  336. yFlags = yFlags & ~kAudioFormatFlagIsSignedInteger;
  337. }
  338. // if the bit depth is 8 bits or less and the format is packed, we don't care about endianness
  339. if((x.mBitsPerChannel <= 8) && ((xFlags & kAudioFormatFlagIsPacked) == kAudioFormatFlagIsPacked))
  340. {
  341. xFlags = xFlags & ~kAudioFormatFlagIsBigEndian;
  342. }
  343. if((y.mBitsPerChannel <= 8) && ((yFlags & kAudioFormatFlagIsPacked) == kAudioFormatFlagIsPacked))
  344. {
  345. yFlags = yFlags & ~kAudioFormatFlagIsBigEndian;
  346. }
  347. // if the number of channels is 0 or 1, we don't care about non-interleavedness
  348. if (x.mChannelsPerFrame <= 1 && y.mChannelsPerFrame <= 1) {
  349. xFlags &= ~kLinearPCMFormatFlagIsNonInterleaved;
  350. yFlags &= ~kLinearPCMFormatFlagIsNonInterleaved;
  351. }
  352. }
  353. return xFlags == yFlags;
  354. }
  355. Boolean FormatIsEqual(AudioStreamBasicDescription x, AudioStreamBasicDescription y)
  356. {
  357. // the semantics for equality are:
  358. // 1) Values must match exactly
  359. // 2) wildcard's are ignored in the comparison
  360. #define MATCH(name) ((x.name) == 0 || (y.name) == 0 || (x.name) == (y.name))
  361. return 
  362. ((x.mSampleRate==0.) || (y.mSampleRate==0.) || (x.mSampleRate==y.mSampleRate)) 
  363. && MATCH(mFormatID)
  364. && MatchFormatFlags(x, y)  
  365. && MATCH(mBytesPerPacket) 
  366. && MATCH(mFramesPerPacket) 
  367. && MATCH(mBytesPerFrame) 
  368. && MATCH(mChannelsPerFrame) 
  369. && MATCH(mBitsPerChannel) ;
  370. }
  371. #pragma mark ***** BackgroundTrackMgr *****
  372. //==================================================================================================
  373. // BackgroundTrackMgr class
  374. //==================================================================================================
  375. class BackgroundTrackMgr
  376. {
  377. #define CurFileInfo THIS->mBGFileInfo[THIS->mCurrentFileIndex]
  378. public:
  379. typedef struct BG_FileInfo {
  380. const char* mFilePath;
  381. AudioFileID mAFID;
  382. AudioStreamBasicDescription mFileFormat;
  383. UInt64 mFileDataSize;
  384. //UInt64 mFileNumPackets; // this is only used if loading file to memory
  385. Boolean mLoadAtOnce;
  386. Boolean mFileDataInQueue;
  387. } BackgroundMusicFileInfo;
  388. BackgroundTrackMgr() 
  389. : mQueue(0),
  390. mBufferByteSize(0),
  391. mCurrentPacket(0),
  392. mNumPacketsToRead(0),
  393. mVolume(1.0),
  394. mPacketDescs(NULL),
  395. mCurrentFileIndex(0),
  396. mMakeNewQueueWhenStopped(false),
  397. mStopAtEnd(false) { }
  398. ~BackgroundTrackMgr() { Teardown(); }
  399. void Teardown()
  400. {
  401. if (mQueue)
  402. AudioQueueDispose(mQueue, true);
  403. for (UInt32 i=0; i < mBGFileInfo.size(); i++)
  404. if (mBGFileInfo[i]->mAFID)
  405. AudioFileClose(mBGFileInfo[i]->mAFID);
  406. if (mPacketDescs)
  407. delete mPacketDescs;
  408. }
  409. AudioStreamPacketDescription *GetPacketDescsPtr() { return mPacketDescs; }
  410. UInt32 GetNumPacketsToRead(BackgroundTrackMgr::BG_FileInfo *inFileInfo) 
  411. return mNumPacketsToRead; 
  412. }
  413. static OSStatus AttachNewCookie(AudioQueueRef inQueue, BackgroundTrackMgr::BG_FileInfo *inFileInfo)
  414. {
  415. OSStatus result = noErr;
  416. UInt32 size = sizeof(UInt32);
  417. result = AudioFileGetPropertyInfo (inFileInfo->mAFID, kAudioFilePropertyMagicCookieData, &size, NULL);
  418. if (!result && size) 
  419. {
  420. char* cookie = new char [size];
  421. result = AudioFileGetProperty (inFileInfo->mAFID, kAudioFilePropertyMagicCookieData, &size, cookie);
  422. AssertNoError("Error getting cookie data", end);
  423. result = AudioQueueSetProperty(inQueue, kAudioQueueProperty_MagicCookie, cookie, size);
  424. delete [] cookie;
  425. AssertNoError("Error setting cookie data for queue", end);
  426. }
  427. return noErr;
  428. end:
  429. return noErr;
  430. }
  431. static void QueueStoppedProc( void *                  inUserData,
  432. AudioQueueRef           inAQ,
  433. AudioQueuePropertyID    inID)
  434. {
  435. UInt32 isRunning;
  436. UInt32 propSize = sizeof(isRunning);
  437. BackgroundTrackMgr *THIS = (BackgroundTrackMgr*)inUserData;
  438. OSStatus result = AudioQueueGetProperty(inAQ, kAudioQueueProperty_IsRunning, &isRunning, &propSize);
  439. if ((!isRunning) && (THIS->mMakeNewQueueWhenStopped))
  440. {
  441. result = AudioQueueDispose(inAQ, true);
  442. AssertNoError("Error disposing queue", end);
  443. result = THIS->SetupQueue(CurFileInfo);
  444. AssertNoError("Error setting up new queue", end);
  445. result = THIS->SetupBuffers(CurFileInfo);
  446. AssertNoError("Error setting up new queue buffers", end);
  447. result = THIS->Start();
  448. AssertNoError("Error starting queue", end);
  449. }
  450. end:
  451. return;
  452. }
  453. static Boolean DisposeBuffer(AudioQueueRef inAQ, std::vector<AudioQueueBufferRef> inDisposeBufferList, AudioQueueBufferRef inBufferToDispose)
  454. {
  455. for (unsigned int i=0; i < inDisposeBufferList.size(); i++)
  456. {
  457. if (inBufferToDispose == inDisposeBufferList[i])
  458. {
  459. OSStatus result = AudioQueueFreeBuffer(inAQ, inBufferToDispose);
  460. if (result == noErr)
  461. inDisposeBufferList.pop_back();
  462. return true;
  463. }
  464. }
  465. return false;
  466. }
  467. enum {
  468. kQueueState_DoNothing = 0,
  469. kQueueState_ResizeBuffer = 1,
  470. kQueueState_NeedNewCookie = 2,
  471. kQueueState_NeedNewBuffers = 3,
  472. kQueueState_NeedNewQueue = 4,
  473. };
  474. static SInt8 GetQueueStateForNextBuffer(BackgroundTrackMgr::BG_FileInfo *inFileInfo, BackgroundTrackMgr::BG_FileInfo *inNextFileInfo)
  475. {
  476. inFileInfo->mFileDataInQueue = false;
  477. // unless the data formats are the same, we need a new queue
  478. if (!FormatIsEqual(inFileInfo->mFileFormat, inNextFileInfo->mFileFormat))
  479. return kQueueState_NeedNewQueue;
  480. // if going from a load-at-once file to streaming or vice versa, we need new buffers
  481. if (inFileInfo->mLoadAtOnce != inNextFileInfo->mLoadAtOnce)
  482. return kQueueState_NeedNewBuffers;
  483. // if the next file is smaller than the current, we just need to resize
  484. if (inNextFileInfo->mLoadAtOnce)
  485. return (inFileInfo->mFileDataSize >= inNextFileInfo->mFileDataSize) ? kQueueState_ResizeBuffer : kQueueState_NeedNewBuffers;
  486. return kQueueState_NeedNewCookie;
  487. }
  488. static void QueueCallback( void * inUserData,
  489. AudioQueueRef inAQ,
  490. AudioQueueBufferRef inCompleteAQBuffer) 
  491. {
  492. // dispose of the buffer if no longer in use
  493. OSStatus result = noErr;
  494. BackgroundTrackMgr *THIS = (BackgroundTrackMgr*)inUserData;
  495. if (DisposeBuffer(inAQ, THIS->mBuffersToDispose, inCompleteAQBuffer))
  496. return;
  497. UInt32 nPackets = 0;
  498. // loop the current buffer if the following:
  499. // 1. file was loaded into the buffer previously
  500. // 2. only one file in the queue
  501. // 3. we have not been told to stop at playlist completion
  502. if ((CurFileInfo->mFileDataInQueue) && (THIS->mBGFileInfo.size() == 1) && (!THIS->mStopAtEnd))
  503. nPackets = THIS->GetNumPacketsToRead(CurFileInfo);
  504. else
  505. {
  506. UInt32 numBytes;
  507. while (nPackets == 0)
  508. {
  509. // if loadAtOnce, get all packets in the file, otherwise ~.5 seconds of data
  510. nPackets = THIS->GetNumPacketsToRead(CurFileInfo);
  511. result = AudioFileReadPackets(CurFileInfo->mAFID, false, &numBytes, THIS->mPacketDescs, THIS->mCurrentPacket, &nPackets, 
  512. inCompleteAQBuffer->mAudioData);
  513. AssertNoError("Error reading file data", end);
  514. inCompleteAQBuffer->mAudioDataByteSize = numBytes;
  515. if (nPackets == 0) // no packets were read, this file has ended.
  516. {
  517. if (CurFileInfo->mLoadAtOnce)
  518. CurFileInfo->mFileDataInQueue = true;
  519. THIS->mCurrentPacket = 0;
  520. UInt32 theNextFileIndex = (THIS->mCurrentFileIndex < THIS->mBGFileInfo.size()-1) ? THIS->mCurrentFileIndex+1 : 0;
  521. // we have gone through the playlist. if mStopAtEnd, stop the queue here
  522. if (theNextFileIndex == 0 && THIS->mStopAtEnd)
  523. {
  524. result = AudioQueueStop(inAQ, false);
  525. AssertNoError("Error stopping queue", end);
  526. return;
  527. }
  528. SInt8 theQueueState = GetQueueStateForNextBuffer(CurFileInfo, THIS->mBGFileInfo[theNextFileIndex]);
  529. if (theNextFileIndex != THIS->mCurrentFileIndex)
  530. {
  531. // if were are not looping the same file. Close the old one and open the new
  532. result = AudioFileClose(CurFileInfo->mAFID);
  533. AssertNoError("Error closing file", end);
  534. THIS->mCurrentFileIndex = theNextFileIndex;
  535. result = LoadFileDataInfo(CurFileInfo->mFilePath, CurFileInfo->mAFID, CurFileInfo->mFileFormat, CurFileInfo->mFileDataSize);
  536. AssertNoError("Error opening file", end);
  537. }
  538. switch (theQueueState) 
  539. {
  540. // if we need to resize the buffer, set the buffer's audio data size to the new file's size
  541. // we will also need to get the new file cookie
  542. case kQueueState_ResizeBuffer:
  543. inCompleteAQBuffer->mAudioDataByteSize = CurFileInfo->mFileDataSize;
  544. // if the data format is the same but we just need a new cookie, attach a new cookie
  545. case kQueueState_NeedNewCookie:
  546. result = AttachNewCookie(inAQ, CurFileInfo);
  547. AssertNoError("Error attaching new file cookie data to queue", end);
  548. break;
  549. // we can keep the same queue, but not the same buffer(s)
  550. case kQueueState_NeedNewBuffers:
  551. THIS->mBuffersToDispose.push_back(inCompleteAQBuffer);
  552. THIS->SetupBuffers(CurFileInfo);
  553. break;
  554. // if the data formats are not the same, we need to dispose the current queue and create a new one
  555. case kQueueState_NeedNewQueue:
  556. THIS->mMakeNewQueueWhenStopped = true;
  557. result = AudioQueueStop(inAQ, false);
  558. AssertNoError("Error stopping queue", end);
  559. return;
  560. default:
  561. break;
  562. }
  563. }
  564. }
  565. }
  566. result = AudioQueueEnqueueBuffer(inAQ, inCompleteAQBuffer, (THIS->mPacketDescs ? nPackets : 0), THIS->mPacketDescs);
  567. AssertNoError("Error enqueuing new buffer", end);
  568. if (CurFileInfo->mLoadAtOnce)
  569. CurFileInfo->mFileDataInQueue = true;
  570. THIS->mCurrentPacket += nPackets;
  571. end:
  572. return;
  573. }
  574. OSStatus SetupQueue(BG_FileInfo *inFileInfo)
  575. {
  576. UInt32 size = 0;
  577. OSStatus result = AudioQueueNewOutput(&inFileInfo->mFileFormat, QueueCallback, this, CFRunLoopGetCurrent(), kCFRunLoopCommonModes, 0, &mQueue);
  578. AssertNoError("Error creating queue", end);
  579. // (2) If the file has a cookie, we should get it and set it on the AQ
  580. size = sizeof(UInt32);
  581. result = AudioFileGetPropertyInfo (inFileInfo->mAFID, kAudioFilePropertyMagicCookieData, &size, NULL);
  582. if (!result && size) {
  583. char* cookie = new char [size];
  584. result = AudioFileGetProperty (inFileInfo->mAFID, kAudioFilePropertyMagicCookieData, &size, cookie);
  585. AssertNoError("Error getting magic cookie", end);
  586. result = AudioQueueSetProperty(mQueue, kAudioQueueProperty_MagicCookie, cookie, size);
  587. delete [] cookie;
  588. AssertNoError("Error setting magic cookie", end);
  589. }
  590. // channel layout
  591. OSStatus err = AudioFileGetPropertyInfo(inFileInfo->mAFID, kAudioFilePropertyChannelLayout, &size, NULL);
  592. if (err == noErr && size > 0) {
  593. AudioChannelLayout *acl = (AudioChannelLayout *)malloc(size);
  594. result = AudioFileGetProperty(inFileInfo->mAFID, kAudioFilePropertyChannelLayout, &size, acl);
  595. AssertNoError("Error getting channel layout from file", end);
  596. result = AudioQueueSetProperty(mQueue, kAudioQueueProperty_ChannelLayout, acl, size);
  597. free(acl);
  598. AssertNoError("Error setting channel layout on queue", end);
  599. }
  600. // add a notification proc for when the queue stops
  601. result = AudioQueueAddPropertyListener(mQueue, kAudioQueueProperty_IsRunning, QueueStoppedProc, this);
  602. AssertNoError("Error adding isRunning property listener to queue", end);
  603. // we need to reset this variable so that if the queue is stopped mid buffer we don't dispose it 
  604. mMakeNewQueueWhenStopped = false;
  605. // volume
  606. result = SetVolume(mVolume);
  607. end:
  608. return result;
  609. }
  610. OSStatus SetupBuffers(BG_FileInfo *inFileInfo)
  611. {
  612. int numBuffersToQueue = kNumberBuffers;
  613. UInt32 maxPacketSize;
  614. UInt32 size = sizeof(maxPacketSize);
  615. // we need to calculate how many packets we read at a time, and how big a buffer we need
  616. // we base this on the size of the packets in the file and an approximate duration for each buffer
  617. // first check to see what the max size of a packet is - if it is bigger
  618. // than our allocation default size, that needs to become larger
  619. OSStatus result = AudioFileGetProperty(inFileInfo->mAFID, kAudioFilePropertyPacketSizeUpperBound, &size, &maxPacketSize);
  620. AssertNoError("Error getting packet upper bound size", end);
  621. bool isFormatVBR = (inFileInfo->mFileFormat.mBytesPerPacket == 0 || inFileInfo->mFileFormat.mFramesPerPacket == 0);
  622. CalculateBytesForTime(inFileInfo->mFileFormat, maxPacketSize, 0.5/*seconds*/, &mBufferByteSize, &mNumPacketsToRead);
  623. // if the file is smaller than the capacity of all the buffer queues, always load it at once
  624. if ((mBufferByteSize * numBuffersToQueue) > inFileInfo->mFileDataSize)
  625. inFileInfo->mLoadAtOnce = true;
  626. if (inFileInfo->mLoadAtOnce)
  627. {
  628. UInt64 theFileNumPackets;
  629. size = sizeof(UInt64);
  630. result = AudioFileGetProperty(inFileInfo->mAFID, kAudioFilePropertyAudioDataPacketCount, &size, &theFileNumPackets);
  631. AssertNoError("Error getting packet count for file", end);
  632. mNumPacketsToRead = (UInt32)theFileNumPackets;
  633. mBufferByteSize = inFileInfo->mFileDataSize;
  634. numBuffersToQueue = 1;
  635. }
  636. else
  637. {
  638. mNumPacketsToRead = mBufferByteSize / maxPacketSize;
  639. }
  640. if (isFormatVBR)
  641. mPacketDescs = new AudioStreamPacketDescription [mNumPacketsToRead];
  642. else
  643. mPacketDescs = NULL; // we don't provide packet descriptions for constant bit rate formats (like linear PCM)
  644. // allocate the queue's buffers
  645. for (int i = 0; i < numBuffersToQueue; ++i) 
  646. {
  647. result = AudioQueueAllocateBuffer(mQueue, mBufferByteSize, &mBuffers[i]);
  648. AssertNoError("Error allocating buffer for queue", end);
  649. QueueCallback (this, mQueue, mBuffers[i]);
  650. if (inFileInfo->mLoadAtOnce)
  651. inFileInfo->mFileDataInQueue = true;
  652. }
  653. end:
  654. return result;
  655. }
  656. OSStatus LoadTrack(const char* inFilePath, Boolean inAddToQueue, Boolean inLoadAtOnce)
  657. {
  658. BG_FileInfo *fileInfo = new BG_FileInfo;
  659. fileInfo->mFilePath = inFilePath;
  660. OSStatus result = LoadFileDataInfo(fileInfo->mFilePath, fileInfo->mAFID, fileInfo->mFileFormat, fileInfo->mFileDataSize);
  661. AssertNoError("Error getting file data info", fail);
  662. fileInfo->mLoadAtOnce = inLoadAtOnce;
  663. fileInfo->mFileDataInQueue = false;
  664. // if not adding to the queue, clear the current file vector
  665. if (!inAddToQueue)
  666. mBGFileInfo.clear();
  667. mBGFileInfo.push_back(fileInfo);
  668. // setup the queue if this is the first (or only) file
  669. if (mBGFileInfo.size() == 1)
  670. {
  671. result = SetupQueue(fileInfo);
  672. AssertNoError("Error setting up queue", fail);
  673. result = SetupBuffers(fileInfo);
  674. AssertNoError("Error setting up queue buffers", fail);
  675. }
  676. // if this is just part of the playlist, close the file for now
  677. else
  678. {
  679. result = AudioFileClose(fileInfo->mAFID);
  680. AssertNoError("Error closing file", fail);
  681. }
  682. return result;
  683. fail:
  684. if (fileInfo)
  685. delete fileInfo;
  686. return result;
  687. }
  688. OSStatus UpdateGain()
  689. {
  690. return SetVolume(mVolume);
  691. }
  692. OSStatus SetVolume(Float32 inVolume)
  693. {
  694. mVolume = inVolume;
  695. return AudioQueueSetParameter(mQueue, kAudioQueueParam_Volume, mVolume * gMasterVolumeGain);
  696. }
  697. OSStatus Start()
  698. {
  699. OSStatus result = AudioQueuePrime(mQueue, 1, NULL);
  700. if (result)
  701. {
  702. printf("Error priming queue");
  703. return result;
  704. }
  705. return AudioQueueStart(mQueue, NULL);
  706. }
  707. OSStatus Stop(Boolean inStopAtEnd)
  708. {
  709. if (inStopAtEnd)
  710. {
  711. mStopAtEnd = true;
  712. return noErr;
  713. }
  714. else
  715. return AudioQueueStop(mQueue, true);
  716. }
  717. private:
  718. AudioQueueRef mQueue;
  719. AudioQueueBufferRef mBuffers[kNumberBuffers];
  720. UInt32 mBufferByteSize;
  721. SInt64 mCurrentPacket;
  722. UInt32 mNumPacketsToRead;
  723. Float32 mVolume;
  724. AudioStreamPacketDescription * mPacketDescs;
  725. std::vector<BG_FileInfo*> mBGFileInfo;
  726. UInt32 mCurrentFileIndex;
  727. Boolean mMakeNewQueueWhenStopped;
  728. Boolean mStopAtEnd;
  729. std::vector<AudioQueueBufferRef> mBuffersToDispose;
  730. };
  731. #pragma mark ***** SoundEngineEffect *****
  732. //==================================================================================================
  733. // SoundEngineEffect class
  734. //==================================================================================================
  735. class SoundEngineEffect
  736. {
  737. public:
  738. // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  739. SoundEngineEffect(const char* inLoopPath, const char* inAttackPath, const char* inDecayPath, Boolean inDoLoop) 
  740. : mSourceID(0),
  741. mAttackBufferID(0),
  742. mLoopBufferID(0),
  743. mDecayBufferID(0),
  744. mLoopPath(inLoopPath),
  745. mAttackPath(inAttackPath),
  746. mDecayPath(inDecayPath),
  747. mLoopData(NULL),
  748. mAttackData(NULL),
  749. mDecayData(NULL),
  750. mLoopDataSize(0),
  751. mAttackDataSize(0),
  752. mDecayDataSize(0),
  753. mIsLoopingEffect(inDoLoop),
  754. mPlayThread(NULL),
  755. mPlayThreadState(kPlayThreadState_Loop) { alGenSources(1, &mSourceID); }
  756. ~SoundEngineEffect()
  757. {
  758. alDeleteSources(1, &mSourceID);
  759. if (mLoopData)
  760. free(mLoopData);
  761. if (mAttackData)
  762. free(mAttackData);
  763. if (mDecayData)
  764. free(mDecayData);
  765. }
  766. // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  767. // Accessors
  768. // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  769. UInt32 GetEffectID() { return mSourceID; }
  770. UInt32 GetPlayThreadState() { return mPlayThreadState; }
  771. Boolean HasAttackBuffer() { return mAttackBufferID != 0; }
  772. // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  773. // Helper Functions
  774. // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  775. ALenum GetALFormat(AudioStreamBasicDescription inFileFormat)
  776. {
  777. if (inFileFormat.mFormatID != kAudioFormatLinearPCM)
  778. return kSoundEngineErrInvalidFileFormat;
  779. if ((inFileFormat.mChannelsPerFrame > 2) || (inFileFormat.mChannelsPerFrame < 1))
  780. return kSoundEngineErrInvalidFileFormat;
  781. if(inFileFormat.mBitsPerChannel == 8)
  782. return (inFileFormat.mChannelsPerFrame == 1) ? AL_FORMAT_MONO8 : AL_FORMAT_STEREO8;
  783. else if(inFileFormat.mBitsPerChannel == 16)
  784. return (inFileFormat.mChannelsPerFrame == 1) ? AL_FORMAT_MONO16 : AL_FORMAT_STEREO16;
  785. return kSoundEngineErrInvalidFileFormat;
  786. }
  787. OSStatus LoadFileData(const char *inFilePath, void* &outData, UInt32 &outDataSize, ALuint &outBufferID)
  788. {
  789. AudioFileID theAFID = 0;
  790. OSStatus result = noErr;
  791. UInt64 theFileSize = 0;
  792. AudioStreamBasicDescription theFileFormat;
  793. result = LoadFileDataInfo(inFilePath, theAFID, theFileFormat, theFileSize);
  794. outDataSize = (UInt32)theFileSize;
  795. AssertNoError("Error loading file info", fail)
  796. outData = malloc(outDataSize);
  797. result = AudioFileReadBytes(theAFID, false, 0, &outDataSize, outData);
  798. AssertNoError("Error reading file data", fail)
  799. if (!TestAudioFormatNativeEndian(theFileFormat) && (theFileFormat.mBitsPerChannel > 8)) 
  800. return kSoundEngineErrInvalidFileFormat;
  801. alGenBuffers(1, &outBufferID);
  802. AssertNoOALError("Error generating buffern", fail);
  803. alBufferDataStaticProc(outBufferID, GetALFormat(theFileFormat), outData, outDataSize, theFileFormat.mSampleRate);
  804. AssertNoOALError("Error attaching data to buffern", fail);
  805. AudioFileClose(theAFID);
  806. return result;
  807. fail:
  808. if (theAFID)
  809. AudioFileClose(theAFID);
  810. if (outData)
  811. {
  812. free(outData);
  813. outData = NULL;
  814. }
  815. return result;
  816. }
  817. OSStatus AttachFilesToSource()
  818. {
  819. OSStatus result = AL_NO_ERROR;
  820. // first check for the attack file. That will be first in the queue if present
  821. if (mAttackPath)
  822. {
  823. result = LoadFileData(mAttackPath, mAttackData, mAttackDataSize, mAttackBufferID);
  824. AssertNoError("Error loading attack file info", end)
  825. }
  826. result = LoadFileData(mLoopPath, mLoopData, mLoopDataSize, mLoopBufferID);
  827. AssertNoError("Error loading looping file info", end)
  828. // if one-shot effect, attach the buffer to the source now
  829. if (!mIsLoopingEffect)
  830. {
  831. alSourcei(mSourceID, AL_BUFFER, mLoopBufferID);
  832. AssertNoOALError("Error attaching file data to effect", end)
  833. }
  834. if (mDecayPath)
  835. {
  836. result = LoadFileData(mDecayPath, mDecayData, mDecayDataSize, mDecayBufferID);
  837. AssertNoError("Error loading decay file info", end)
  838. }
  839. end:
  840. return result;
  841. }
  842. OSStatus ClearSourceBuffers()
  843. {
  844. OSStatus result = AL_NO_ERROR;
  845. ALint numQueuedBuffers = 0;
  846. ALuint *bufferIDs = (ALuint*)malloc(numQueuedBuffers * sizeof(ALint));
  847. alGetSourcei(mSourceID, AL_BUFFERS_QUEUED, &numQueuedBuffers);
  848. AssertNoOALError("Error getting OpenAL queued buffer size", end)
  849. alSourceUnqueueBuffers(mSourceID, numQueuedBuffers, bufferIDs);
  850. AssertNoOALError("Error unqueueing buffers from source", end)
  851. end:
  852. free(bufferIDs);
  853. return result;
  854. }
  855. static void* PlaybackProc(void *args)
  856. {
  857. OSStatus result = AL_NO_ERROR;
  858. SoundEngineEffect *THIS = (SoundEngineEffect*)args;
  859. alSourcePlay(THIS->GetEffectID());
  860. AssertNoOALError("Error starting effect playback", end)
  861. // if attack buffer is present, wait until it has completed, then turn looping on
  862. if (THIS->HasAttackBuffer())
  863. {
  864. ALint numBuffersProcessed = 0;
  865. while (numBuffersProcessed < 1)
  866. {
  867. alGetSourcei(THIS->GetEffectID(), AL_BUFFERS_PROCESSED, &numBuffersProcessed);
  868. AssertNoOALError("Error getting processed buffer number", end)
  869. }
  870. ALuint tmpBuffer = 0;
  871. alSourceUnqueueBuffers(THIS->GetEffectID(), 1, &tmpBuffer);
  872. AssertNoOALError("Error unqueueing buffers from source", end)
  873. }
  874. // now that we have processed the attack buffer, loop the main one
  875. THIS->SetLooping(true);
  876. end:
  877. return NULL;
  878. }
  879. // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  880. // Effect management
  881. // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  882. OSStatus Start()
  883. {
  884. OSStatus result = AL_NO_ERROR;
  885. alSourceStop(mSourceID);
  886. AssertNoOALError("Error stopping source", end)
  887. if (!mIsLoopingEffect)
  888. {
  889. // if we are just playing one-short effects, start playback here
  890. alSourcePlay(mSourceID);
  891. return alGetError();
  892. }
  893. // for loops we need to spawn a new thread
  894. mPlayThread = new OpenALThread(PlaybackProc, (void*)this);
  895. // we want this to delete upon thread completion
  896. mPlayThreadState = kPlayThreadState_Loop;
  897. // clean up remnants from any previous playback of the source
  898. result = ClearSourceBuffers();
  899. AssertNoError("Error clearing buffers", end)
  900. // if the effect has an attack sample, queue this first
  901. if (HasAttackBuffer())
  902. {
  903. alSourceQueueBuffers(mSourceID, 1, &mAttackBufferID);
  904. AssertNoOALError("Error queueing buffers for attack", end)
  905. // turn on looping after the attack buffer has been processed
  906. SetLooping(false);
  907. }
  908. alSourceQueueBuffers(mSourceID, 1, &mLoopBufferID);
  909. AssertNoOALError("Error queueing looping buffer", end)
  910. mPlayThread->Start();
  911. end:
  912. return result;
  913. }
  914. OSStatus StartDecay()
  915. {
  916. // turn off looping, and queue the decay buffer
  917. OSStatus result = AL_NO_ERROR;
  918. alSourcei(mSourceID, AL_LOOPING, 0);
  919. AssertNoOALError("Error turning off looping", end)
  920. alSourceQueueBuffers(mSourceID, 1, &mDecayBufferID);
  921. AssertNoOALError("Error queueing decay file", end)
  922. end:
  923. return result;
  924. }
  925. OSStatus Stop(Boolean inDoDecay)
  926. {
  927. OSStatus result = AL_NO_ERROR;
  928. // for non looped effects and loops with no decay sample
  929. if ((mDecayBufferID == 0) || !inDoDecay)
  930. {
  931. // if no decay to play, just stop the source
  932. alSourceStop(mSourceID);
  933. AssertNoOALError("Error stopping source", end)
  934. }
  935. else
  936. return StartDecay();
  937. end:
  938. return result;
  939. }
  940. OSStatus SetPitch(Float32 inValue)
  941. {
  942. alSourcef(mSourceID, AL_PITCH, inValue);
  943. return alGetError();
  944. }
  945. OSStatus SetLooping(Boolean inDoLoop)
  946. {
  947. ALint doLoop = inDoLoop ? 1 : 0;
  948. alSourcei(mSourceID, AL_LOOPING, doLoop);
  949. return alGetError();
  950. }
  951. OSStatus SetPosition(Float32 inX, Float32 inY, Float32 inZ)
  952. {
  953. alSource3f(mSourceID, AL_POSITION, inX, inY, inZ);
  954. return alGetError();
  955. }
  956. OSStatus SetMaxDistance(Float32 inValue)
  957. {
  958. alSourcef(mSourceID, AL_MAX_DISTANCE, inValue);
  959. return alGetError();
  960. }
  961. OSStatus SetReferenceDistance(Float32 inValue)
  962. {
  963. alSourcef(mSourceID, AL_REFERENCE_DISTANCE, inValue);
  964. return alGetError();
  965. }
  966. OSStatus SetLevel(Float32 inValue)
  967. {
  968. alSourcef(mSourceID, AL_GAIN, inValue * gMasterVolumeGain);
  969. return alGetError();
  970. }
  971. enum {
  972. kPlayThreadState_Loop = 0,
  973. kPlayThreadState_Decay = 1,
  974. kPlayThreadState_End = 2
  975. };
  976. private:
  977. ALuint mSourceID;
  978. ALuint mAttackBufferID;
  979. ALuint mLoopBufferID;
  980. ALuint mDecayBufferID;
  981. UInt32 mNumberBuffers;
  982. const char* mLoopPath;
  983. const char* mAttackPath;
  984. const char* mDecayPath;
  985. void* mLoopData;
  986. void* mAttackData;
  987. void* mDecayData;
  988. UInt32 mLoopDataSize;
  989. UInt32 mAttackDataSize;
  990. UInt32 mDecayDataSize;
  991. Boolean mIsLoopingEffect;
  992. OpenALThread* mPlayThread;
  993. UInt32 mPlayThreadState;
  994. };
  995. #pragma mark ***** SoundEngineEffectMap *****
  996. //==================================================================================================
  997. // SoundEngineEffectMap class
  998. //==================================================================================================
  999. class SoundEngineEffectMap 
  1000. : std::multimap<UInt32, SoundEngineEffect*, std::less<ALuint> > 
  1001. {
  1002. public:
  1003.     // add a new context to the map
  1004.     void Add (const ALuint inEffectToken, SoundEngineEffect **inEffect)
  1005. {
  1006. iterator it = upper_bound(inEffectToken);
  1007. insert(it, value_type (inEffectToken, *inEffect));
  1008. }
  1009.     SoundEngineEffect* Get(ALuint inEffectToken) 
  1010. {
  1011.         iterator it = find(inEffectToken);
  1012.         if (it != end())
  1013.             return ((*it).second);
  1014. return (NULL);
  1015.     }
  1016.     void Remove (const ALuint inSourceToken) {
  1017.         iterator  it = find(inSourceToken);
  1018.         if (it != end())
  1019.             erase(it);
  1020.     }
  1021.     SoundEngineEffect* GetEffectByIndex(UInt32 inIndex) {
  1022.         iterator it = begin();
  1023. for (UInt32 i = 0; i < inIndex; i++) {
  1024.             if (it != end())
  1025.                 ++it;
  1026.             else
  1027.                 i = inIndex;
  1028.         }
  1029.         
  1030.         if (it != end())
  1031.             return ((*it).second);
  1032. return (NULL);
  1033.     }
  1034. iterator GetIterator() { return begin(); }
  1035.     UInt32 Size () const { return size(); }
  1036.     bool Empty () const { return empty(); }
  1037. };
  1038. #pragma mark ***** OpenALObject *****
  1039. //==================================================================================================
  1040. // OpenALObject class
  1041. //==================================================================================================
  1042. class OpenALObject
  1043. {
  1044. public:
  1045. OpenALObject(Float32 inMixerOutputRate)
  1046. : mOutputRate(inMixerOutputRate),
  1047. mGain(1.0),
  1048. mContext(NULL),
  1049. mDevice(NULL),
  1050. mEffectsMap(NULL) 
  1051. {
  1052. mEffectsMap = new SoundEngineEffectMap();
  1053. }
  1054. ~OpenALObject() { Teardown(); }
  1055. OSStatus Initialize()
  1056. {
  1057. OSStatus result = noErr;
  1058. mDevice = alcOpenDevice(NULL);
  1059. AssertNoOALError("Error opening output device", end)
  1060. if(mDevice == NULL) { return kSoundEngineErrDeviceNotFound; }
  1061. // if a mixer output rate was specified, set it here
  1062. // must be done before the alcCreateContext() call
  1063. if (mOutputRate)
  1064. alcMacOSXMixerOutputRateProc(mOutputRate);
  1065. // Create an OpenAL Context
  1066. mContext = alcCreateContext(mDevice, NULL);
  1067. AssertNoOALError("Error creating OpenAL context", end)
  1068. alcMakeContextCurrent(mContext);
  1069. AssertNoOALError("Error setting current OpenAL context", end)
  1070.  
  1071. end:
  1072. return result;
  1073. }
  1074. void Teardown()
  1075. {
  1076. if (mEffectsMap) 
  1077. {
  1078. for (UInt32  i = 0; i < mEffectsMap->Size(); i++)
  1079. {
  1080. SoundEngineEffect *theEffect = mEffectsMap->GetEffectByIndex(0);
  1081. if (theEffect)
  1082. {
  1083. mEffectsMap->Remove(theEffect->GetEffectID());
  1084. delete theEffect;
  1085. }
  1086. }
  1087. delete mEffectsMap;
  1088. }
  1089. if (mContext) alcDestroyContext(mContext);
  1090. if (mDevice) alcCloseDevice(mDevice);
  1091. }
  1092. OSStatus SetListenerPosition(Float32 inX, Float32 inY, Float32 inZ)
  1093. {
  1094. alListener3f(AL_POSITION, inX, inY, inZ);
  1095. return alGetError();
  1096. }
  1097. OSStatus SetListenerGain(Float32 inValue)
  1098. {
  1099. alListenerf(AL_GAIN, inValue);
  1100. return alGetError();
  1101. }
  1102. OSStatus SetMaxDistance(Float32 inValue)
  1103. {
  1104. OSStatus result = 0;
  1105. for (UInt32 i=0; i < mEffectsMap->Size(); i++)
  1106. {
  1107. SoundEngineEffect *theEffect = mEffectsMap->GetEffectByIndex(i);
  1108. if ((result = theEffect->SetMaxDistance(inValue)) != AL_NO_ERROR)
  1109. return result;
  1110. }
  1111. return result;
  1112. }
  1113. OSStatus SetReferenceDistance(Float32 inValue)
  1114. {
  1115. OSStatus result = 0;
  1116. for (UInt32 i=0; i < mEffectsMap->Size(); i++)
  1117. {
  1118. SoundEngineEffect *theEffect = mEffectsMap->GetEffectByIndex(i);
  1119. if ((result = theEffect->SetReferenceDistance(inValue)) != AL_NO_ERROR)
  1120. return result;
  1121. }
  1122. return result;
  1123. }
  1124. OSStatus SetEffectsVolume(Float32 inValue)
  1125. {
  1126. OSStatus result = 0;
  1127. for (UInt32 i=0; i < mEffectsMap->Size(); i++)
  1128. {
  1129. SoundEngineEffect *theEffect = mEffectsMap->GetEffectByIndex(i);
  1130. if ((result = theEffect->SetLevel(inValue)) != AL_NO_ERROR)
  1131. return result;
  1132. }
  1133. return result;
  1134. }
  1135. OSStatus UpdateGain()
  1136. {
  1137. return SetEffectsVolume(mGain);
  1138. }
  1139. OSStatus LoadEffect(const char *inFilePath, UInt32 *outEffectID)
  1140. {
  1141. SoundEngineEffect *theEffect = new SoundEngineEffect(inFilePath, NULL, NULL, false);
  1142. OSStatus result = theEffect->AttachFilesToSource();
  1143. if (result == noErr)
  1144. {
  1145. *outEffectID = theEffect->GetEffectID();
  1146. mEffectsMap->Add(*outEffectID, &theEffect);
  1147. }
  1148. return result;
  1149. }
  1150. OSStatus LoadLoopingEffect(const char *inLoopFilePath, const char *inAttackFilePath, const char *inDecayFilePath, UInt32 *outEffectID)
  1151. {
  1152. SoundEngineEffect *theEffect = new SoundEngineEffect(inLoopFilePath, inAttackFilePath, inDecayFilePath, true);
  1153. OSStatus result = theEffect->AttachFilesToSource();
  1154. if (result == noErr)
  1155. {
  1156. *outEffectID = theEffect->GetEffectID();
  1157. mEffectsMap->Add(*outEffectID, &theEffect);
  1158. }
  1159. return result;
  1160. }
  1161. OSStatus UnloadEffect(UInt32 inEffectID)
  1162. {
  1163. mEffectsMap->Remove(inEffectID);
  1164. return 0;
  1165. }
  1166. OSStatus StartEffect(UInt32 inEffectID)
  1167. {
  1168. SoundEngineEffect *theEffect = mEffectsMap->Get(inEffectID);
  1169. return (theEffect) ? theEffect->Start() : kSoundEngineErrInvalidID;
  1170. }
  1171. OSStatus StopEffect(UInt32 inEffectID, Boolean inDoDecay)
  1172. {
  1173. SoundEngineEffect *theEffect = mEffectsMap->Get(inEffectID);
  1174. return (theEffect) ? theEffect->Stop(inDoDecay) : kSoundEngineErrInvalidID;
  1175. }
  1176. OSStatus SetEffectPitch(UInt32 inEffectID, Float32 inValue)
  1177. {
  1178. SoundEngineEffect *theEffect = mEffectsMap->Get(inEffectID);
  1179. return (theEffect) ? theEffect->SetPitch(inValue) : kSoundEngineErrInvalidID;
  1180. }
  1181. OSStatus SetEffectVolume(UInt32 inEffectID, Float32 inValue)
  1182. {
  1183. SoundEngineEffect *theEffect = mEffectsMap->Get(inEffectID);
  1184. return (theEffect) ?  theEffect->SetLevel(inValue) : kSoundEngineErrInvalidID;
  1185. }
  1186. OSStatus SetEffectPosition(UInt32 inEffectID, Float32 inX, Float32 inY, Float32 inZ)
  1187. {
  1188. SoundEngineEffect *theEffect = mEffectsMap->Get(inEffectID);
  1189. return (theEffect) ? theEffect->SetPosition(inX, inY, inZ) : kSoundEngineErrInvalidID;
  1190. }
  1191. private:
  1192. Float32 mOutputRate;
  1193. Float32 mGain;
  1194. ALCcontext* mContext;
  1195. ALCdevice* mDevice;
  1196. SoundEngineEffectMap* mEffectsMap;
  1197. };
  1198. #pragma mark ***** API *****
  1199. //==================================================================================================
  1200. // Sound Engine
  1201. //==================================================================================================
  1202. extern "C"
  1203. OSStatus  SoundEngine_Initialize(Float32 inMixerOutputRate)
  1204. {
  1205. if (sOpenALObject)
  1206. delete sOpenALObject;
  1207. if (sBackgroundTrackMgr)
  1208. delete sBackgroundTrackMgr;
  1209. sOpenALObject = new OpenALObject(inMixerOutputRate);
  1210. sBackgroundTrackMgr = new BackgroundTrackMgr();
  1211. return sOpenALObject->Initialize();
  1212. }
  1213. extern "C"
  1214. OSStatus  SoundEngine_Teardown()
  1215. {
  1216. if (sOpenALObject)
  1217. {
  1218. delete sOpenALObject;
  1219. sOpenALObject = NULL;
  1220. }
  1221. if (sBackgroundTrackMgr)
  1222. {
  1223. delete sBackgroundTrackMgr;
  1224. sBackgroundTrackMgr = NULL;
  1225. }
  1226. return 0; 
  1227. }
  1228. extern "C"
  1229. OSStatus  SoundEngine_SetMasterVolume(Float32 inValue)
  1230. {
  1231. OSStatus result = noErr;
  1232. gMasterVolumeGain = inValue;
  1233. if (sBackgroundTrackMgr)
  1234. result = sBackgroundTrackMgr->UpdateGain();
  1235. if (result) return result;
  1236. if (sOpenALObject) 
  1237. return sOpenALObject->UpdateGain();
  1238. return result;
  1239. }
  1240. extern "C"
  1241. OSStatus  SoundEngine_SetListenerPosition(Float32 inX, Float32 inY, Float32 inZ)
  1242. {
  1243. return (sOpenALObject) ? sOpenALObject->SetListenerPosition(inX, inY, inZ) : kSoundEngineErrUnitialized;
  1244. }
  1245. extern "C"
  1246. OSStatus  SoundEngine_SetListenerGain(Float32 inValue)
  1247. {
  1248. return (sOpenALObject) ? sOpenALObject->SetListenerGain(inValue) : kSoundEngineErrUnitialized;
  1249. }
  1250. extern "C"
  1251. OSStatus  SoundEngine_LoadBackgroundMusicTrack(const char* inPath, Boolean inAddToQueue, Boolean inLoadAtOnce)
  1252. {
  1253. if (sBackgroundTrackMgr == NULL)
  1254. sBackgroundTrackMgr = new BackgroundTrackMgr();
  1255. return sBackgroundTrackMgr->LoadTrack(inPath, inAddToQueue, inLoadAtOnce);
  1256. }
  1257. extern "C"
  1258. OSStatus  SoundEngine_UnloadBackgroundMusicTrack()
  1259. {
  1260. if (sBackgroundTrackMgr)
  1261. {
  1262. delete sBackgroundTrackMgr;
  1263. sBackgroundTrackMgr = NULL;
  1264. }
  1265. return 0;
  1266. }
  1267. extern "C"
  1268. OSStatus  SoundEngine_StartBackgroundMusic()
  1269. {
  1270. return (sBackgroundTrackMgr) ? sBackgroundTrackMgr->Start() : kSoundEngineErrUnitialized;
  1271. }
  1272. extern "C"
  1273. OSStatus  SoundEngine_StopBackgroundMusic(Boolean stopAtEnd)
  1274. {
  1275. return (sBackgroundTrackMgr) ?  sBackgroundTrackMgr->Stop(stopAtEnd) : kSoundEngineErrUnitialized;
  1276. }
  1277. extern "C"
  1278. OSStatus  SoundEngine_SetBackgroundMusicVolume(Float32 inValue)
  1279. {
  1280. return (sBackgroundTrackMgr) ? sBackgroundTrackMgr->SetVolume(inValue) : kSoundEngineErrUnitialized;
  1281. }
  1282. extern "C"
  1283. OSStatus  SoundEngine_LoadEffect(const char* inPath, UInt32* outEffectID)
  1284. {
  1285. OSStatus result = noErr;
  1286. if (sOpenALObject == NULL)
  1287. {
  1288. sOpenALObject = new OpenALObject(0.0);
  1289. result = sOpenALObject->Initialize();
  1290. }
  1291. return (result) ? result : sOpenALObject->LoadEffect(inPath, outEffectID);
  1292. }
  1293. extern "C"
  1294. OSStatus  SoundEngine_LoadLoopingEffect(const char* inLoopFilePath, const char* inAttackFilePath, const char* inDecayFilePath, UInt32* outEffectID)
  1295. {
  1296. OSStatus result = noErr;
  1297. if (sOpenALObject == NULL)
  1298. {
  1299. sOpenALObject = new OpenALObject(0.0);
  1300. result = sOpenALObject->Initialize();
  1301. }
  1302. return (result) ? result : sOpenALObject->LoadLoopingEffect(inLoopFilePath, inAttackFilePath, inDecayFilePath, outEffectID);
  1303. }
  1304. extern "C"
  1305. OSStatus  SoundEngine_UnloadEffect(UInt32 inEffectID)
  1306. {
  1307. return (sOpenALObject) ? sOpenALObject->UnloadEffect(inEffectID) : kSoundEngineErrUnitialized;
  1308. }
  1309. extern "C"
  1310. OSStatus  SoundEngine_StartEffect(UInt32 inEffectID)
  1311. {
  1312. return (sOpenALObject) ? sOpenALObject->StartEffect(inEffectID) : kSoundEngineErrUnitialized;
  1313. }
  1314. extern "C"
  1315. OSStatus  SoundEngine_StopEffect(UInt32 inEffectID, Boolean inDoDecay)
  1316. {
  1317. return (sOpenALObject) ?  sOpenALObject->StopEffect(inEffectID, inDoDecay) : kSoundEngineErrUnitialized;
  1318. }
  1319. extern "C"
  1320. OSStatus  SoundEngine_SetEffectPitch(UInt32 inEffectID, Float32 inValue)
  1321. {
  1322. return (sOpenALObject) ? sOpenALObject->SetEffectPitch(inEffectID, inValue) : kSoundEngineErrUnitialized;
  1323. }
  1324. extern "C"
  1325. OSStatus  SoundEngine_SetEffectLevel(UInt32 inEffectID, Float32 inValue)
  1326. {
  1327. return (sOpenALObject) ? sOpenALObject->SetEffectVolume(inEffectID, inValue) : kSoundEngineErrUnitialized;
  1328. }
  1329. extern "C"
  1330. OSStatus SoundEngine_SetEffectPosition(UInt32 inEffectID, Float32 inX, Float32 inY, Float32 inZ)
  1331. {
  1332. return (sOpenALObject) ? sOpenALObject->SetEffectPosition(inEffectID, inX, inY, inZ) : kSoundEngineErrUnitialized;
  1333. }
  1334. extern "C"
  1335. OSStatus  SoundEngine_SetEffectsVolume(Float32 inValue)
  1336. {
  1337. return (sOpenALObject) ? sOpenALObject->SetEffectsVolume(inValue) : kSoundEngineErrUnitialized;
  1338. }
  1339. extern "C"
  1340. OSStatus  SoundEngine_SetMaxDistance(Float32 inValue)
  1341. {
  1342. return (sOpenALObject) ? sOpenALObject->SetMaxDistance(inValue) : kSoundEngineErrUnitialized;
  1343. }
  1344. extern "C"
  1345. OSStatus  SoundEngine_SetReferenceDistance(Float32 inValue)
  1346. {
  1347. return (sOpenALObject) ? sOpenALObject->SetReferenceDistance(inValue) : kSoundEngineErrUnitialized;
  1348. }
  1349. #endif
  1350. #endif