#include <OOSoundSourcePool.h>

Inheritance diagram for OOSoundSourcePool:

Collaboration diagram for OOSoundSourcePool:

Instance Methods
(id)	- initWithCount:minRepeatTime:

(void)	- playSoundWithKey:priority:expiryTime:overlap:position:

(void)	- playSoundWithKey:priority:expiryTime:

(void)	- playSoundWithKey:priority:

(void)	- playSoundWithKey:priority:position:

(void)	- playSoundWithKey:position:

(void)	- playSoundWithKey:

(void)	- playSoundWithKey:overlap:

(void)	- playSoundWithKey:overlap:position:

(void)	- dealloc `[implementation]`

(uint8_t)	- selectSlotForPriority: `[implementation]`

Class Methods
(instancetype)	+ poolWithCount:minRepeatTime:

Private Attributes
struct OOSoundSourcePoolElement *	_sources

uint8_t	_count

uint8_t	_latest

uint8_t	_reserved

OOTimeDelta	_minRepeat

OOTimeAbsolute	_nextRepeat

NSString *	_lastKey

Detailed Description

Definition at line 40 of file OOSoundSourcePool.h.

Method Documentation

◆ dealloc

- (void) dealloc

implementation

Definition at line 87 of file OOSoundSourcePool.m.

{
    uint8_t                 i;
    
    for (i = 0; i != _count; i++)
    {
        [_sources[i].source release];
    }
    free(_sources);
 
    [_lastKey release];
    
    [super dealloc];
}

References _count, _sources, and dealloc.

Referenced by dealloc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initWithCount:minRepeatTime:

- (id) initWithCount:		(uint8_t)	count
minRepeatTime:		(OOTimeDelta)	minRepeat

Definition at line 62 of file OOSoundSourcePool.m.

                    :(uint8_t)count minRepeatTime:(OOTimeDelta)minRepeat
{
    if ((self = [super init]))
    {
        // Sanity-check count
        if (count == 0)  count = 1;
        if (count == kNoSlot)  --count;
        _count = count;
        _reserved = kNoSlot;
        
        if (minRepeat < 0.0)  minRepeat = 0.0;
        _minRepeat = minRepeat;
        
        // Create source pool
        _sources = calloc(sizeof(PoolElement), count);
        if (_sources == NULL)
        {
            [self release];
            self = nil;
        }
    }
    return self;
}

References _count, _minRepeat, _reserved, _sources, count, kNoSlot, and nil.

◆ playSoundWithKey:

- (void) playSoundWithKey: (NSString *) key

Definition at line 191 of file OOSoundSourcePool.m.

191 :(NSString *)key

192{

193 [self playSoundWithKey:key priority:1.0];

194}

References playSoundWithKey:priority:.

Referenced by PlayerEntity(Sound)::playBuyCommodity, PlayerEntity(Sound)::playBuyShip, PlayerEntity(Sound)::playCantBuyCommodity, PlayerEntity(Sound)::playCantBuyShip, PlayerEntity(Sound)::playCantSellCommodity, PlayerEntity(Sound)::playGameOver, and PlayerEntity(Sound)::playSellCommodity.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ playSoundWithKey:overlap:

- (void) playSoundWithKey:		(NSString *)	key
overlap:		(BOOL)	overlap

Definition at line 203 of file OOSoundSourcePool.m.

                         :(NSString *)key overlap:(BOOL)overlap
{
    [self playSoundWithKey:key
                  priority:1.0
                expiryTime:0.5
                   overlap:overlap
                  position:kZeroVector];
}

References playSoundWithKey:priority:expiryTime:overlap:position:.

Here is the call graph for this function:

◆ playSoundWithKey:overlap:position:

- (void) playSoundWithKey:	(NSString *)	key
overlap:	(BOOL)	overlap
position:	(Vector)	position

Definition at line 213 of file OOSoundSourcePool.m.

                         :(NSString *)key overlap:(BOOL)overlap position:(Vector)position
{
    [self playSoundWithKey:key
                  priority:1.0
                expiryTime:0.5
                   overlap:overlap
                  position:position];
}

References playSoundWithKey:priority:expiryTime:overlap:position:.

Referenced by PlayerEntity(Sound)::playWeaponOverheated:.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ playSoundWithKey:position:

- (void) playSoundWithKey:		(NSString *)	key
position:		(Vector)	position

Definition at line 197 of file OOSoundSourcePool.m.

197 :(NSString *)key position:(Vector)position

198{

199 [self playSoundWithKey:key priority:1.0 position:position];

200}

References playSoundWithKey:priority:position:.

Referenced by PlayerEntity(Sound)::playAegisCloseToPlanet, PlayerEntity(Sound)::playAegisCloseToStation, PlayerEntity(Sound)::playDirectHit:weaponIdentifier:, PlayerEntity(Sound)::playEscapePodScooped, PlayerEntity(Sound)::playMineLaunched:weaponIdentifier:, PlayerEntity(Sound)::playMissileLaunched:weaponIdentifier:, PlayerEntity(Sound)::playScrapeDamage:, and PlayerEntity(Sound)::playShieldHit:weaponIdentifier:.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ playSoundWithKey:priority:

- (void) playSoundWithKey:		(NSString *)	key
priority:		(float)	priority

Definition at line 182 of file OOSoundSourcePool.m.

                         :(NSString *)key
                 priority:(float)priority
{
    [self playSoundWithKey:key
                  priority:priority
                expiryTime:0.5 + randf() * 0.1];
}

References playSoundWithKey:priority:expiryTime:.

Referenced by PlayerEntity(Sound)::playLegacyScriptSound:, and playSoundWithKey:.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ playSoundWithKey:priority:expiryTime:

- (void) playSoundWithKey:	(NSString *)	key
priority:	(float)	priority
expiryTime:	(OOTimeDelta)	expiryTime

Definition at line 158 of file OOSoundSourcePool.m.

                         :(NSString *)key
                 priority:(float)priority
               expiryTime:(OOTimeDelta)expiryTime
{
    [self playSoundWithKey:key
                  priority:priority
                expiryTime:expiryTime
                   overlap:YES
                  position:kZeroVector];
}

References playSoundWithKey:priority:expiryTime:overlap:position:.

Referenced by playSoundWithKey:priority:.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ playSoundWithKey:priority:expiryTime:overlap:position:

- (void) playSoundWithKey:	(NSString *)	key
priority:	(float)	priority
expiryTime:	(OOTimeDelta)	expiryTime
overlap:	(BOOL)	overlap
position:	(Vector)	position

Definition at line 103 of file OOSoundSourcePool.m.

                         :(NSString *)key
                 priority:(float)priority
               expiryTime:(OOTimeDelta)expiryTime
                 overlap:(BOOL)overlap
                 position:(Vector)position
{
    uint8_t                 slot;
    OOTimeAbsolute            now, absExpiryTime;
    PoolElement              *element = NULL;
    OOSound                 *sound = NULL;
    
    // Convert expiry time to absolute
    now = [UNIVERSE getTime];
    absExpiryTime = expiryTime + now;
    
    // Avoid repeats if required
    if (now < _nextRepeat && [key isEqualToString:_lastKey])  return;
    if (!overlap && _reserved != kNoSlot && [_sources[_reserved].source isPlaying]) return;
    
    // Look for a slot in the source list to use
    slot = [self selectSlotForPriority:priority];
    if (slot == kNoSlot)  return;
    element = &_sources[slot];
    
    // Load sound
    sound = [OOSound soundWithCustomSoundKey:key];
    if (sound == nil)  return;
    
    // Stop playing sound or set up sound source as appropriate
    if (element->source != nil)  [element->source stop];
    else
    {
        element->source = [[OOSoundSource alloc] init];
        if (element->source == nil)  return;
    }
    if (slot == _reserved) _reserved = kNoSlot;    // _reserved has finished playing!
    if (!overlap) _reserved = slot;
    
    // Play and store metadata
    [element->source setPosition:position];
    [element->source playSound:sound];
    element->expiryTime = absExpiryTime;
    element->priority = priority;
    if (_minRepeat > 0.0)
    {
        _nextRepeat = now + _minRepeat;
        [_lastKey release];
        _lastKey = [key copy];
    }
    
    // Set staring search location for next slot lookup
    _latest = slot;
}

References _lastKey, _latest, _minRepeat, _nextRepeat, _reserved, _sources, OOSoundSourcePoolElement::expiryTime, kNoSlot, nil, OOSoundSourcePoolElement::priority, selectSlotForPriority:, OOSound::soundWithCustomSoundKey:, and OOSoundSourcePoolElement::source.

Referenced by PlayerEntity(Sound)::playLaserHit:offset:weaponIdentifier:, playSoundWithKey:overlap:, playSoundWithKey:overlap:position:, playSoundWithKey:priority:expiryTime:, and playSoundWithKey:priority:position:.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ playSoundWithKey:priority:position:

- (void) playSoundWithKey:	(NSString *)	key
priority:	(float)	priority
position:	(Vector)	position

Definition at line 170 of file OOSoundSourcePool.m.

                         :(NSString *)key
                 priority:(float)priority
                 position:(Vector)position
{
    [self playSoundWithKey:key
                  priority:priority
                expiryTime:0.5 + randf() * 0.1
                   overlap:YES
                  position:position];
}

References playSoundWithKey:priority:expiryTime:overlap:position:.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ poolWithCount:minRepeatTime:

+ (instancetype) poolWithCount:		(uint8_t)	count
minRepeatTime:		(OOTimeDelta)	minRepeat

Definition at line 56 of file OOSoundSourcePool.m.

56 :(uint8_t)count minRepeatTime:(OOTimeDelta)minRepeat

57{

58 return [[[self alloc] initWithCount:count minRepeatTime:minRepeat] autorelease];

59}

◆ selectSlotForPriority:

- (uint8_t) selectSlotForPriority: (float) priority

implementation

Provided by category OOSoundSourcePool(Private).

Definition at line 228 of file OOSoundSourcePool.m.

                                 :(float)priority
{
    uint8_t                 curr, count, expiredLower = kNoSlot, unexpiredLower = kNoSlot, expiredEqual = kNoSlot;
    PoolElement              *element = NULL;
    OOTimeAbsolute            now = [UNIVERSE getTime];
    
#define NEXT(x) (((x) + 1) % _count)
    
    curr = _latest;
    count = _count;
    do
    {
        curr = NEXT(curr);
        element = &_sources[curr];
        
        if (element->source == nil || ![element->source isPlaying])  return curr;    // Best type of slot: empty
        else if (element->priority < priority)
        {
            if (element->expiryTime <= now)  expiredLower = curr; // Second-best type: expired lower-priority
            else if (curr != _reserved) unexpiredLower = curr;     // Third-best type: unexpired lower-priority
        }
        else if (element->priority == priority && element->expiryTime <= now)
        {
            expiredEqual = curr;                                    // Fourth-best type: expired equal-priority.
        }
    } while (--count);
    
    if (expiredLower != kNoSlot)  return expiredLower;
    if (unexpiredLower != kNoSlot)  return unexpiredLower;
    return expiredEqual;    // Will be kNoSlot if none found
}