OOALStreamedSound Class Reference

#include <OOALStreamedSound.h>

Inheritance diagram for OOALStreamedSound:

Collaboration diagram for OOALStreamedSound:

Instance Methods
(id)	- initWithDecoder:
(void)	- dealloc [implementation]
(NSString *)	- name [implementation]
(void)	- rewind [implementation]
(BOOL)	- soundIncomplete [implementation]
(ALuint)	- soundBuffer [implementation]
Instance Methods inherited from OOSound
(id)	- initWithContentsOfFile:
(id)	- init [implementation]
(id)	- initWithCustomSoundKey:
(jsval)	- oo_jsValueInContext: [implementation]
(NSString *)	- oo_jsDescription [implementation]
(NSString *)	- oo_jsClassName [implementation]

Private Attributes
char *	_buffer
size_t	_size
double	_sampleRate
NSString *	_name
BOOL	_stereo
OOALSoundDecoder *	decoder
BOOL	_reachedEnd

Additional Inherited Members
Class Methods inherited from OOSound
(BOOL)	+ setUp
(void)	+ update
(void)	+ setMasterVolume:
(float)	+ masterVolume
(BOOL)	+ isSoundOK
(id)	+ soundWithCustomSoundKey:

Detailed Description

Definition at line 30 of file OOALStreamedSound.h.

Method Documentation

dealloc

- (void) dealloc

implementation

Definition at line 34 of file OOALStreamedSound.m.

{
    free(_buffer);
    _buffer = NULL;
    [decoder release];
 
    [super dealloc];
}

References _buffer, and dealloc.

Referenced by dealloc.

Here is the call graph for this function:

Here is the caller graph for this function:

initWithDecoder:

- (id) initWithDecoder:

(OOALSoundDecoder *)

inDecoder

Reimplemented from OOSound.

Definition at line 50 of file OOALStreamedSound.m.

                     :(OOALSoundDecoder *)inDecoder
{
    BOOL                    OK = YES;
    
    [OOSound setUp];
    if (![OOSound isSoundOK] || nil == inDecoder) OK = NO;
    
    if (OK)
    {
        self = [super init];
        if (nil == self) OK = NO;
    }
    
    if (OK)
    {
        _name = [[inDecoder name] copy];
        _sampleRate = [inDecoder sampleRate];
        _stereo = [inDecoder isStereo];
        _reachedEnd = NO;
        _buffer = malloc(OOAL_STREAM_CHUNK_SIZE);
        decoder = [inDecoder retain];
        [self rewind];
    }
    
    if (!OK)
    {
        [self release];
        self = nil;
    }
    return self;
}

References _buffer, _name, _reachedEnd, _sampleRate, _stereo, decoder, OOSound::init, OOSound::isSoundOK, OOALSoundDecoder::isStereo, OOALSoundDecoder::name, nil, OOAL_STREAM_CHUNK_SIZE, rewind, OOALSoundDecoder::sampleRate, and OOSound::setUp.

Here is the call graph for this function:

name

- (NSString *) name

implementation

Reimplemented from OOSound.

Definition at line 43 of file OOALStreamedSound.m.

{
    return _name;
}

References _name, and name.

Referenced by name.

Here is the call graph for this function:

Here is the caller graph for this function:

rewind

- (void) rewind

implementation

Reimplemented from OOSound.

Definition at line 83 of file OOALStreamedSound.m.

{
    [decoder reset];
    _reachedEnd = NO;
}

References _reachedEnd, OOALSoundDecoder::reset, and rewind.

Referenced by initWithDecoder:, and rewind.

Here is the call graph for this function:

Here is the caller graph for this function:

soundBuffer

- (ALuint) soundBuffer

implementation

Reimplemented from OOSound.

Definition at line 96 of file OOALStreamedSound.m.

{
    size_t transferred = [decoder streamToBuffer:_buffer];
    if (transferred < OOAL_STREAM_CHUNK_SIZE)
    {
        // otherwise keep going
        _reachedEnd = YES;
    }
 
    ALuint buffer;
    ALint error;
    OOAL(alGenBuffers(1,&buffer));
    if ((error = alGetError()) != AL_NO_ERROR)
    {
        OOLog(kOOLogSoundLoadingError, @"%@", @"Could not create OpenAL buffer");
        return 0;
    }
    else
    {
        if (!_stereo)
        {
            alBufferData(buffer, AL_FORMAT_MONO16, _buffer, (ALsizei)transferred, _sampleRate);
        }
        else
        {
            alBufferData(buffer, AL_FORMAT_STEREO16, _buffer, (ALsizei)transferred, _sampleRate);
        }
        return buffer;
    }
}

References _buffer, _reachedEnd, _sampleRate, _stereo, kOOLogSoundLoadingError, OOAL, OOAL_STREAM_CHUNK_SIZE, OOLog, soundBuffer, and OOALSoundDecoder::streamToBuffer:.

Referenced by soundBuffer.

Here is the call graph for this function:

Here is the caller graph for this function:

soundIncomplete

- (BOOL) soundIncomplete

implementation

Reimplemented from OOSound.

Definition at line 90 of file OOALStreamedSound.m.

{
    return !_reachedEnd;
}

References _reachedEnd, and soundIncomplete.

Referenced by soundIncomplete.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

_buffer

- (char*) _buffer

private

Definition at line 33 of file OOALStreamedSound.h.

Referenced by dealloc, initWithDecoder:, and soundBuffer.

_name

- (NSString*) _name

private

Definition at line 36 of file OOALStreamedSound.h.

Referenced by initWithDecoder:, and name.

_reachedEnd

- (BOOL) _reachedEnd

private

Definition at line 39 of file OOALStreamedSound.h.

Referenced by initWithDecoder:, rewind, soundBuffer, and soundIncomplete.

_sampleRate

- (double) _sampleRate

private

Definition at line 35 of file OOALStreamedSound.h.

Referenced by initWithDecoder:, and soundBuffer.

_size

- (size_t) _size

private

Definition at line 34 of file OOALStreamedSound.h.

_stereo

- (BOOL) _stereo

private

Definition at line 37 of file OOALStreamedSound.h.

Referenced by initWithDecoder:, and soundBuffer.

decoder

- (OOALSoundDecoder*) decoder

private

Definition at line 38 of file OOALStreamedSound.h.

Referenced by initWithDecoder:.

---

The documentation for this class was generated from the following files:

• src/Core/OOALStreamedSound.h
• src/Core/OOALStreamedSound.m