OOSoundMixer Class Reference

#include <OOALSoundMixer.h>

Inheritance diagram for OOSoundMixer:

Collaboration diagram for OOSoundMixer:

Instance Methods
(void)	- update
(OOSoundChannel *)	- popChannel
(void)	- pushChannel:
(id)	- init [implementation]
(void)	- shutdown [implementation]
(id)	- copyWithZone: [implementation]
(id)	- retain [implementation]
(NSUInteger)	- retainCount [implementation]
(void)	- release [implementation]
(id)	- autorelease [implementation]

Class Methods
(id)	+ sharedMixer
(id)	+ allocWithZone: [implementation]

Protected Attributes
OOSoundChannel *	_channels [kMixerGeneralChannels]
OOSoundChannel *	_freeList
uint32_t	_maxChannels
uint32_t	_playMask

Detailed Description

Definition at line 43 of file OOALSoundMixer.h.

Method Documentation

allocWithZone:

+ (id) allocWithZone: (NSZone *) inZone

implementation

Provided by category OOSoundMixer(Singleton).

Definition at line 139 of file OOALSoundMixer.m.

                   :(NSZone *)inZone
{
    if (sSingleton == nil)
    {
        sSingleton = [super allocWithZone:inZone];
        return sSingleton;
    }
    return nil;
}

autorelease

- (id) autorelease

implementation

Provided by category OOSoundMixer(Singleton).

Definition at line 172 of file OOALSoundMixer.m.

{
    return self;
}

copyWithZone:

- (id) copyWithZone: (NSZone *) inZone

implementation

Provided by category OOSoundMixer(Singleton).

Definition at line 150 of file OOALSoundMixer.m.

                  :(NSZone *)inZone
{
    return self;
}

init

- (id) init

implementation

Definition at line 50 of file OOALSoundMixer.m.

{
    BOOL                        OK = YES;
    uint32_t                    idx = 0, count = kMixerGeneralChannels;
    OOSoundChannel              *channel;
    
    if (!(self = [super init]))  return nil;
    if (![OOSound setUp])  OK = NO;
    
    if (OK)
    {
        // Allocate channels
        do
        {
            channel = [[OOSoundChannel alloc] init];
            if (nil != channel)
            {
                _channels[idx++] = channel;
                [self pushChannel:channel];
            }
        }  while (--count);
    }
    
    if (!OK)
    {
        [super release];
// static analyser complains about this next line; probably nothing - CIM
        self = nil;
    }
    else
    {
        sSingleton = self;
    }
    
    return sSingleton;
}

References _channels, count, init, kMixerGeneralChannels, nil, pushChannel:, and sSingleton.

Referenced by init.

Here is the call graph for this function:

Here is the caller graph for this function:

popChannel

- (OOSoundChannel *) popChannel

Definition at line 109 of file OOALSoundMixer.m.

{
    OOSoundChannel *channel = _freeList;
    _freeList = [channel next];
    [channel setNext:nil];
    
    return channel;
}

References _freeList, OOSoundChannel::next, popChannel, and OOSoundChannel::setNext:.

Referenced by OOSoundSource::play, and popChannel.

Here is the call graph for this function:

Here is the caller graph for this function:

pushChannel:

- (void) pushChannel:

(OOSoundChannel *)

channel

Definition at line 119 of file OOALSoundMixer.m.

                    :(OOSoundChannel *)channel
{
    assert(channel != nil);
    
    [channel setNext:_freeList];
    _freeList = channel;
}

References _freeList, nil, and OOSoundChannel::setNext:.

Referenced by OOSoundSource::channel:didFinishPlayingSound:, and init.

Here is the call graph for this function:

Here is the caller graph for this function:

release

- (void) release

implementation

Provided by category OOSoundMixer(Singleton).

Definition at line 168 of file OOALSoundMixer.m.

{}

retain

- (id) retain

implementation

Provided by category OOSoundMixer(Singleton).

Definition at line 156 of file OOALSoundMixer.m.

{
    return self;
}

retainCount

- (NSUInteger) retainCount

implementation

Provided by category OOSoundMixer(Singleton).

Definition at line 162 of file OOALSoundMixer.m.

{
    return UINT_MAX;
}

sharedMixer

+ (id) sharedMixer

Definition at line 40 of file OOALSoundMixer.m.

{
    if (nil == sSingleton)
    {
        [[self alloc] init];
    }
    return sSingleton;
}

References nil, sharedMixer, and sSingleton.

Referenced by OOSoundSource::channel:didFinishPlayingSound:, OOSoundSource::play, sharedMixer, OOOpenALController::shutdown, and OOSound::update.

Here is the call graph for this function:

Here is the caller graph for this function:

shutdown

- (void) shutdown

implementation

Definition at line 89 of file OOALSoundMixer.m.

{
    uint32_t i;
    for (i = 0; i < kMixerGeneralChannels; ++i)
    {
        DESTROY(_channels[i]);
    }
}

References _channels, DESTROY, kMixerGeneralChannels, and shutdown.

Referenced by shutdown.

Here is the call graph for this function:

Here is the caller graph for this function:

update

- (void) update

Definition at line 99 of file OOALSoundMixer.m.

{
    uint32_t i;
    for (i = 0; i < kMixerGeneralChannels; ++i)
    {
        [_channels[i] update];
    }
}

References kMixerGeneralChannels, OOSoundChannel::update, and update.

Referenced by OOSound::update, and update.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

_channels

- (OOSoundChannel* _channels[kMixerGeneralChannels])

protected

Definition at line 45 of file OOALSoundMixer.h.

Referenced by init, and shutdown.

_freeList

- (OOSoundChannel*) _freeList

protected

Definition at line 46 of file OOALSoundMixer.h.

Referenced by popChannel, and pushChannel:.

_maxChannels

- (uint32_t) _maxChannels

protected

Definition at line 48 of file OOALSoundMixer.h.

_playMask

- (uint32_t) _playMask

protected

Definition at line 49 of file OOALSoundMixer.h.

---

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

• src/Core/OOALSoundMixer.h
• src/Core/OOALSoundMixer.m