OOSoundChannel Class Reference

#include <OOALSoundChannel.h>

Inheritance diagram for OOSoundChannel:

Collaboration diagram for OOSoundChannel:

Instance Methods
(void)	- update
(void)	- setDelegate:
(OOSoundChannel *)	- next
(void)	- setNext:
(void)	- setPosition:
(void)	- setGain:
(BOOL)	- playSound:looped:
(void)	- stop
(OOSound *)	- sound
(id)	- init [implementation]
(void)	- dealloc [implementation]
(void)	- getNextSoundBuffer [implementation]
(void)	- hasStopped [implementation]
(BOOL)	- enqueueBuffer: [implementation]

Protected Attributes
OOSoundChannel *	_next
id	_delegate
OOSound *	_sound
ALuint	_buffer
ALuint	_lastBuffer
BOOL	_bigSound
ALuint	_source
BOOL	_playing
BOOL	_loop

Detailed Description

Definition at line 40 of file OOALSoundChannel.h.

Method Documentation

dealloc

- (void) dealloc

implementation

Definition at line 1 of file OOALSoundChannel.m.

{
    [self hasStopped]; // make sure buffers are dequeued and deleted
    OOAL(alDeleteSources(1, &_source));
    [super dealloc];
}

enqueueBuffer:

- (BOOL) enqueueBuffer: (OOSound *) sound

implementation

Provided by category OOSoundChannel(Private).

Definition at line 1 of file OOALSoundChannel.m.

                      :(OOSound *)sound
{
    // get sound data
    _buffer = [sound soundBuffer];
    // bind sound data to buffer
    OOAL(alSourceQueueBuffers(_source, 1, &_buffer));
    ALuint error;
    if ((error = alGetError()) != AL_NO_ERROR)
    {
        OOLog(@"ov.debug", @"Error %u queueing buffers (_source: %u (%p), _buffer: %u (%p))",
                            error, _source, &_source, _buffer, &_buffer);
        return NO;
    }
    ALint playing = 0;
    OOAL(alGetSourcei(_source,AL_SOURCE_STATE,&playing));
    if (playing != AL_PLAYING)
    {
        OOAL(alSourcePlay(_source));
        if ((error = alGetError()) != AL_NO_ERROR)
        {
            OOLog(@"ov.debug",@"Error %d playing source",error);
            return NO;
        }
    }
    return YES;
}

getNextSoundBuffer

- (void) getNextSoundBuffer

implementation

Provided by category OOSoundChannel(Private).

Definition at line 1 of file OOALSoundChannel.m.

{
    if (!_bigSound)
    {
        // we've only loaded one buffer so far
        _bigSound = YES;
        _lastBuffer = _buffer;
        [self enqueueBuffer:_sound];
    }
    else
    {
        // _lastBuffer has something in it, so only queue up
        // another one if we've finished with that
        ALint processed = 0;
        OOAL(alGetSourcei(_source, AL_BUFFERS_PROCESSED, &processed));
        if (processed > 0) // slot free
        {
            // dequeue and delete lastBuffer
            ALuint buffer;
            OOAL(alSourceUnqueueBuffers(_source, 1, &buffer));
            assert(buffer == _lastBuffer);
            OOAL(alDeleteBuffers(1,&_lastBuffer));
            // shuffle along, and grab the next bit
            _lastBuffer = _buffer;
            [self enqueueBuffer:_sound];
        }
    }
}

hasStopped

- (void) hasStopped

implementation

Provided by category OOSoundChannel(Private).

Definition at line 1 of file OOALSoundChannel.m.

{
    ALint queued;
    OOAL(alGetSourcei(_source, AL_BUFFERS_QUEUED, &queued));
    
    while (queued--)
    {
        ALuint buffer;
        OOAL(alSourceUnqueueBuffers(_source, 1, &buffer));
    }
 
    OOAL(alDeleteBuffers(1,&_buffer));
    if (_bigSound)
    {
        // then we have two buffers to cleanup
        OOAL(alDeleteBuffers(1,&_lastBuffer));
    }
    _bigSound = NO;
 
 
    OOSound *sound = _sound;
    _sound = nil;
    
    if (nil != _delegate && [_delegate respondsToSelector:@selector(channel:didFinishPlayingSound:)])
    {
        [_delegate channel:self didFinishPlayingSound:sound];
    }
    [sound release];
}

init

- (id) init

implementation

Definition at line 1 of file OOALSoundChannel.m.

{
    if ((self = [super init]))
    {
        ALuint error;
        OOAL(alGenSources(1,&_source));
        if ((error = alGetError()) != AL_NO_ERROR)
        {
            OOLog(kOOLogSoundInitError, @"%@", @"Could not create OpenAL source");
            [self release];
            self = nil;
        }
        else
        {
            // sources are all relative to listener, defaulting to zero vector
            OOAL(alSourcei(_source, AL_SOURCE_RELATIVE, AL_TRUE));
            OOAL(alSource3f(_source, AL_POSITION, 0.0f, 0.0f, 0.0f));
        }
    }
    return self;
}

next

- (OOSoundChannel *) next

Definition at line 1 of file OOALSoundChannel.m.

{
    return _next;
}

playSound:looped:

- (BOOL) playSound:		(OOSound *)	sound
looped:		(BOOL)	loop

Definition at line 1 of file OOALSoundChannel.m.

                  :(OOSound *)sound looped:(BOOL)loop
{
    if (sound == nil)  return NO;
    
    if (_sound != nil)  [self stop];
 
    _loop = loop;
    _bigSound = NO;
    [sound rewind];
    if ([self enqueueBuffer:sound])
    {
        _sound = [sound retain];
        return YES;
    }
    else
    {
        return NO;
    }
}

setDelegate:

- (void) setDelegate:

(id)

delegate

Definition at line 1 of file OOALSoundChannel.m.

                    :(id)delegate
{
    _delegate = delegate;
}

setGain:

- (void) setGain:

(float)

gain

Definition at line 1 of file OOALSoundChannel.m.

                :(float) gain
{
    OOAL(alSourcef(_source, AL_GAIN, gain));
}

setNext:

- (void) setNext:

(OOSoundChannel *)

next

Definition at line 1 of file OOALSoundChannel.m.

                :(OOSoundChannel *)next
{
    _next = next;
}

setPosition:

- (void) setPosition:

(Vector)

vector

Definition at line 1 of file OOALSoundChannel.m.

                    :(Vector) vector
{
    OOAL(alSource3f(_source, AL_POSITION, vector.x, vector.y, vector.z));
}

sound

- (OOSound *) sound

Definition at line 1 of file OOALSoundChannel.m.

{
    return _sound;
}

stop

- (void) stop

Definition at line 1 of file OOALSoundChannel.m.

{
    if (_sound != nil)
    {
        OOAL(alSourceStop(_source));
        OOAL(alSourcei(_source, AL_BUFFER, AL_NONE));
        [self hasStopped];
    }
}

update

- (void) update

Definition at line 1 of file OOALSoundChannel.m.

{
    // Check if we've reached the end of a sound.
    if (_sound != nil)
    {
        ALint check;
        OOAL(alGetSourcei(_source,AL_SOURCE_STATE,&check));
        if (check == AL_STOPPED)
        {
            [self hasStopped];
        }
        else if ([_sound soundIncomplete]) // streaming and not finished loading
        {
            OOLog(@"sound.buffer", @"Incomplete, trying next for %@", [_sound name]);
            [self getNextSoundBuffer];
        }
        else if (_loop)
        {
            OOLog(@"sound.buffer", @"Looping, trying restart for %@", [_sound name]);
            // sound is complete, but needs to be looped, so start it again
            [_sound rewind];
            [self getNextSoundBuffer];
        }
    }
}

Member Data Documentation

_bigSound

- (BOOL) _bigSound

protected

Definition at line 47 of file OOALSoundChannel.h.

_buffer

- (ALuint) _buffer

protected

Definition at line 45 of file OOALSoundChannel.h.

_delegate

- (id) _delegate

protected

Definition at line 43 of file OOALSoundChannel.h.

_lastBuffer

- (ALuint) _lastBuffer

protected

Definition at line 46 of file OOALSoundChannel.h.

_loop

- (BOOL) _loop

protected

Definition at line 50 of file OOALSoundChannel.h.

_next

- (OOSoundChannel*) _next

protected

Definition at line 42 of file OOALSoundChannel.h.

_playing

- (BOOL) _playing

protected

Definition at line 49 of file OOALSoundChannel.h.

_sound

- (OOSound*) _sound

protected

Definition at line 44 of file OOALSoundChannel.h.

_source

- (ALuint) _source

protected

Definition at line 48 of file OOALSoundChannel.h.

---

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

• src/Core/OOALSoundChannel.h
• src/Core/OOALSoundChannel.m