sfxXAudioBuffer.h

Engine/source/sfx/xaudio/sfxXAudioBuffer.h

More...

Classes:

Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _SFXXAUDIOBUFFER_H_
25#define _SFXXAUDIOBUFFER_H_
26
27#include <xaudio2.h>
28
29#ifndef _SFXINTERNAL_H_
30#include "sfx/sfxInternal.h"
31#endif
32
33#ifndef _TVECTOR_H_
34#include "core/util/tVector.h"
35#endif
36
37
38/// Audio data buffer for the XAudio device layer.
39class SFXXAudioBuffer : public SFXBuffer
40{
41   public:
42
43      typedef SFXBuffer Parent;
44      
45      friend class SFXXAudioDevice;
46      friend class SFXXAudioVoice;
47
48   protected:
49
50      struct Buffer
51      {
52         XAUDIO2_BUFFER mData;
53         SFXInternal::SFXStreamPacket* mPacket;
54
55         Buffer()
56            : mPacket( 0 )
57         {
58            dMemset( &mData, 0, sizeof( mData ) );
59         }
60      };
61
62      typedef Vector< Buffer> QueueType;
63
64      QueueType mBufferQueue;
65
66      /// If this is a streaming buffer, return the unique voice associated
67      /// with the buffer.
68      SFXXAudioVoice* _getUniqueVoice() { return ( SFXXAudioVoice* ) mUniqueVoice.getPointer(); }
69
70      ///
71      SFXXAudioBuffer( const ThreadSafeRef< SFXStream>& stream, SFXDescription* description );
72      virtual ~SFXXAudioBuffer();
73
74      // SFXBuffer.
75      virtual void write( SFXInternal::SFXStreamPacket* const* packets, U32 num );
76      void _flush();
77
78   public:
79
80      ///
81      static SFXXAudioBuffer* create( const ThreadSafeRef< SFXStream>& stream, SFXDescription* description );
82};
83
84#endif // _SFXXAUDIOBUFFER_H_
85