OOSoundSource Class Reference

#include <OOSoundSource.h>

Inheritance diagram for OOSoundSource:

Collaboration diagram for OOSoundSource:

Instance Methods
(id)	- initWithSound:
(OOSound *)	- sound
(void)	- setSound:
(BOOL)	- loop
(void)	- setLoop:
(uint8_t)	- repeatCount
(void)	- setRepeatCount:
(BOOL)	- isPlaying
(void)	- play
(void)	- playOrRepeat
(void)	- stop
(void)	- playSound:
(void)	- playSound:repeatCount:
(void)	- playOrRepeatSound:
(void)	- setPositional:
(BOOL)	- positional
(void)	- setPosition:
(Vector)	- position
(void)	- setGain:
(float)	- gain
(void)	- setVelocity:
(void)	- setOrientation:
(void)	- setConeAngle:
(void)	- setGainInsideCone:outsideCone:
(void)	- positionRelativeTo:
(id)	- init [implementation]
(void)	- dealloc [implementation]
(NSString *)	- descriptionComponents [implementation]
(void)	- channel:didFinishPlayingSound: [implementation]
(id)	- initWithCustomSoundKey:
(void)	- playCustomSoundWithKey:
(jsval)	- oo_jsValueInContext: [implementation]
(NSString *)	- oo_jsClassName [implementation]

Class Methods
(instancetype)	+ sourceWithSound:
(void)	+ stopAll
(id)	+ sourceWithCustomSoundKey:

Private Attributes
OOSound *	_sound
OOSoundChannel *	_channel
BOOL	_loop
uint8_t	_repeatCount
uint8_t	_remainingCount
Vector	_position
BOOL	_positional
float	_gain

Detailed Description

Definition at line 43 of file OOSoundSource.h.

Method Documentation

channel:didFinishPlayingSound:

- (void) channel: (OOSoundChannel *) channel didFinishPlayingSound: (OOSound *) sound

implementation

Definition at line 317 of file OOSoundSource.m.

               :(OOSoundChannel *)channel didFinishPlayingSound:(OOSound *)sound
{
    assert(_channel == channel);
    
    OOSoundAcquireLock();
    
    if (--_remainingCount)
    {
        [_channel playSound:[self sound] looped:NO];
    }
    else
    {
        [_channel setDelegate:nil];
        [[OOSoundMixer sharedMixer] pushChannel:_channel];
        _channel = nil;
        [self release];
    }
    OOSoundReleaseLock();
}

References _channel, _remainingCount, nil, OOSoundAcquireLock, OOSoundReleaseLock, OOSoundChannel::playSound:looped:, OOSoundMixer::pushChannel:, OOSoundChannel::setDelegate:, OOSoundMixer::sharedMixer, and sound.

Here is the call graph for this function:

dealloc

- (void) dealloc

implementation

Definition at line 66 of file OOSoundSource.m.

{
    [self stop];
    [_sound autorelease];
    
    [super dealloc];
}

References dealloc, and stop.

Referenced by dealloc.

Here is the call graph for this function:

Here is the caller graph for this function:

descriptionComponents

- (NSString *) descriptionComponents

implementation

Definition at line 75 of file OOSoundSource.m.

{
    if ([self isPlaying])
    {
        return [NSString stringWithFormat:@"sound=%@, loop=%s, repeatCount=%u, playing on channel %@", _sound, [self loop] ? "YES" : "NO", [self repeatCount], _channel];
    }
    else
    {
        return [NSString stringWithFormat:@"sound=%@, loop=%s, repeatCount=%u, not playing", _sound, [self loop] ? "YES" : "NO", [self repeatCount]];
    }
}

References descriptionComponents, isPlaying, loop, and repeatCount.

Referenced by descriptionComponents.

Here is the call graph for this function:

Here is the caller graph for this function:

gain

- (float) gain

Definition at line 279 of file OOSoundSource.m.

{
    return _gain;
}

References _gain, and gain.

Referenced by gain, OOMusic::musicGain, and setGain:.

Here is the call graph for this function:

Here is the caller graph for this function:

init

- (id) init

implementation

Definition at line 43 of file OOSoundSource.m.

{
    self = [super init];
    if (!self) return nil;
    
    _positional = NO;
    _position = kZeroVector;
    _gain = OO_DEFAULT_SOUNDSOURCE_GAIN;
    return self;
}

References _gain, _position, _positional, init, kZeroVector, and nil.

Referenced by init, and initWithSound:.

Here is the call graph for this function:

Here is the caller graph for this function:

initWithCustomSoundKey:

- (id) initWithCustomSoundKey:

(NSString *)

key

Provided by category OOSoundSource(OOCustomSounds).

Definition at line 11080 of file Universe.m.

                             :(NSString *)key
{
    OOSound *theSound = [OOSound soundWithCustomSoundKey:key];
    if (theSound != nil)
    {
        self = [self initWithSound:theSound];
    }
    else
    {
        [self release];
        self = nil;
    }
    return self;
}

initWithSound:

- (id) initWithSound:

(OOSound *)

inSound

Definition at line 55 of file OOSoundSource.m.

                    :(OOSound *)inSound
{
    self = [self init];
    if (!self) return nil;
    
    [self setSound:inSound];
    
    return self;
}

References init, nil, and setSound:.

Referenced by OOSoundSource(OOCustomSounds)::initWithCustomSoundKey:.

Here is the call graph for this function:

Here is the caller graph for this function:

isPlaying

- (BOOL) isPlaying

Definition at line 129 of file OOSoundSource.m.

{
    return _channel != nil;
}

References _channel, isPlaying, and nil.

Referenced by descriptionComponents, PlayerEntity(Sound)::isBeeping, OOMusic::isPlaying, isPlaying, and playOrRepeat.

Here is the call graph for this function:

Here is the caller graph for this function:

loop

- (BOOL) loop

Definition at line 105 of file OOSoundSource.m.

{
    return _loop;
}

References _loop, and loop.

Referenced by descriptionComponents, loop, play, and setLoop:.

Here is the call graph for this function:

Here is the caller graph for this function:

oo_jsClassName

- (NSString *) oo_jsClassName

implementation

Provided by category OOSoundSource(OOJavaScriptExtentions).

Definition at line 345 of file OOJSSoundSource.m.

{
    return @"SoundSource";
}

oo_jsValueInContext:

- (jsval) oo_jsValueInContext: (JSContext *) context

implementation

Provided by category OOSoundSource(OOJavaScriptExtentions).

Definition at line 329 of file OOJSSoundSource.m.

                             :(JSContext *)context
{
    JSObject                    *jsSelf = NULL;
    jsval                       result = JSVAL_NULL;
    
    jsSelf = JS_NewObject(context, &sSoundSourceClass, sSoundSourcePrototype, NULL);
    if (jsSelf != NULL)
    {
        if (!JS_SetPrivate(context, jsSelf, [self retain]))  jsSelf = NULL;
    }
    if (jsSelf != NULL)  result = OBJECT_TO_JSVAL(jsSelf);
    
    return result;
}

play

- (void) play

Definition at line 135 of file OOSoundSource.m.

{
    if ([self sound] == nil) return;
    
    OOSoundAcquireLock();
    
    if (_channel)  [self stop];
    
    _channel = [[OOSoundMixer sharedMixer] popChannel];
    if (nil != _channel)
    {
        _remainingCount = [self repeatCount];
        [_channel setDelegate:self];
        [_channel setPosition:_position];
        [_channel setGain:_gain];
        [_channel playSound:[self sound] looped:[self loop]];
        [self retain];
    }
    
    if (EXPECT_NOT(sPlayingSoundSources == nil))
    {
        sPlayingSoundSources = [[NSMutableSet alloc] init];
    }
    [sPlayingSoundSources addObject:self];
    
    OOSoundReleaseLock();
}

References _channel, _remainingCount, EXPECT_NOT, loop, nil, OOSoundAcquireLock, OOSoundReleaseLock, play, OOSoundChannel::playSound:looped:, OOSoundMixer::popChannel, repeatCount, OOSoundChannel::setDelegate:, OOSoundChannel::setGain:, OOSoundChannel::setPosition:, OOSoundMixer::sharedMixer, sound, sPlayingSoundSources, and stop.

Referenced by play, OOMusic::playLooped:, playOrRepeat, playSound:repeatCount:, SoundSourcePlay(), and PlayerEntity(Sound)::updateAfterburnerSound.

Here is the call graph for this function:

Here is the caller graph for this function:

playCustomSoundWithKey:

- (void) playCustomSoundWithKey:

(NSString *)

key

Provided by category OOSoundSource(OOCustomSounds).

Definition at line 11096 of file Universe.m.

                               :(NSString *)key
{
    OOSound *theSound = [OOSound soundWithCustomSoundKey:key];
    if (theSound != nil)  [self playSound:theSound];
}

Referenced by PlayerEntity(Sound)::playDockWithStation, PlayerEntity(Sound)::playExitWitchspace, PlayerEntity(Sound)::playFiredECMSound, PlayerEntity(Sound)::playGalacticHyperspace, PlayerEntity(Sound)::playHitByECMSound, PlayerEntity(Sound)::playHyperspaceAborted, PlayerEntity(Sound)::playLaunchFromStation, and PlayerEntity(Sound)::playStandardHyperspace.

Here is the caller graph for this function:

playOrRepeat

- (void) playOrRepeat

Definition at line 164 of file OOSoundSource.m.

{
    if (![self isPlaying])  [self play];
    else ++_remainingCount;
}

References _remainingCount, isPlaying, play, and playOrRepeat.

Referenced by playOrRepeat, playOrRepeatSound:, and SoundSourcePlayOrRepeat().

Here is the call graph for this function:

Here is the caller graph for this function:

playOrRepeatSound:

- (void) playOrRepeatSound:

(OOSound *)

inSound

Definition at line 219 of file OOSoundSource.m.

                          :(OOSound *)sound
{
    if (_sound != sound) [self playSound:sound];
    else [self playOrRepeat];
}

References _sound, playOrRepeat, playSound:, and sound.

Here is the call graph for this function:

playSound:

- (void) playSound:

(OOSound *)

inSound

Definition at line 204 of file OOSoundSource.m.

                  :(OOSound *)sound
{
    [self playSound:sound repeatCount:_repeatCount];
}

References playSound:repeatCount:.

Referenced by OOSoundSource(OOCustomSounds)::playCustomSoundWithKey:, PlayerEntity(Sound)::playInterfaceBeep:, playOrRepeatSound:, PlayTrumbleIdle(), and PlayTrumbleSqueal().

Here is the call graph for this function:

Here is the caller graph for this function:

playSound:repeatCount:

- (void) playSound:		(OOSound *)	inSound
repeatCount:		(uint8_t)	inCount

Definition at line 210 of file OOSoundSource.m.

                  :(OOSound *)sound repeatCount:(uint8_t)count
{
    [self stop];
    [self setSound:sound];
    [self setRepeatCount:count];
    [self play];
}

References play, setRepeatCount:, setSound:, and stop.

Referenced by playSound:.

Here is the call graph for this function:

Here is the caller graph for this function:

position

- (Vector) position

Definition at line 263 of file OOSoundSource.m.

{
    return _position;
}

References _position, and position.

Referenced by position.

Here is the call graph for this function:

Here is the caller graph for this function:

positional

- (BOOL) positional

Definition at line 243 of file OOSoundSource.m.

{
    return _positional;
}

References _positional, and positional.

Referenced by positional.

Here is the call graph for this function:

Here is the caller graph for this function:

positionRelativeTo:

- (void) positionRelativeTo:

(OOSoundReferencePoint *)

inPoint

Definition at line 310 of file OOSoundSource.m.

                           :(OOSoundReferencePoint *)inPoint
{
    
}

repeatCount

- (uint8_t) repeatCount

Definition at line 117 of file OOSoundSource.m.

{
    return _repeatCount ? _repeatCount : 1;
}

References _repeatCount, and repeatCount.

Referenced by descriptionComponents, play, and repeatCount.

Here is the call graph for this function:

Here is the caller graph for this function:

setConeAngle:

- (void) setConeAngle:

(float)

inAngle

Definition at line 298 of file OOSoundSource.m.

                     :(float)inAngle
{
    
}

setGain:

- (void) setGain:

(float)

gain

Definition at line 269 of file OOSoundSource.m.

                :(float)gain
{
    _gain = gain;
    if (_channel)
    {
        [_channel setGain:_gain];
    }
}

References _channel, _gain, gain, and OOSoundChannel::setGain:.

Referenced by OOMusic::setMusicGain:, and SoundSourceSetProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

setGainInsideCone:outsideCone:

- (void) setGainInsideCone:		(float)	inInside
outsideCone:		(float)	inOutside

Definition at line 304 of file OOSoundSource.m.

                          :(float)inInside outsideCone:(float)inOutside
{
    
}

setLoop:

- (void) setLoop:

(BOOL)

inLoop

Definition at line 111 of file OOSoundSource.m.

                :(BOOL)loop
{
    _loop = !!loop;
}

References _loop, and loop.

Referenced by OOMusic::playLooped:, and SoundSourceSetProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

setOrientation:

- (void) setOrientation:

(Vector)

inOrientation

Definition at line 292 of file OOSoundSource.m.

                       :(Vector)inOrientation
{
    
}

setPosition:

- (void) setPosition:

(Vector)

inPosition

Definition at line 249 of file OOSoundSource.m.

                    :(Vector)inPosition
{
    _position = inPosition;
    if (inPosition.x != 0.0 || inPosition.y != 0.0 || inPosition.z != 0.0)
    {
        _positional = YES;
    }
    if (_channel)
    {
        [_channel setPosition:_position]; 
    }
}

References _channel, _position, _positional, and OOSoundChannel::setPosition:.

Referenced by PlayTrumbleIdle(), PlayTrumbleSqueal(), setPositional:, PlayerEntity(Sound)::setUpSound, and SoundSourceSetProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

setPositional:

- (void) setPositional:

(BOOL)

inPositional

Definition at line 226 of file OOSoundSource.m.

                      :(BOOL)inPositional
{
    if (inPositional)
    {
        _positional = YES;
    }
    else
    {
        /* OpenAL doesn't easily do non-positional sounds beyond the
         * stereo/mono distinction, but setting the position to the
         * zero vector is probably close enough */
        _positional = NO;
        [self setPosition:kZeroVector];
    }
}

References _positional, and setPosition:.

Referenced by SoundSourceSetProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

setRepeatCount:

- (void) setRepeatCount:

(uint8_t)

inCount

Definition at line 123 of file OOSoundSource.m.

                       :(uint8_t)count
{
    _repeatCount = count;
}

References _repeatCount, and count.

Referenced by playSound:repeatCount:, SoundSourcePlay(), and SoundSourceSetProperty().

Here is the caller graph for this function:

setSound:

- (void) setSound:

(OOSound *)

inSound

Definition at line 94 of file OOSoundSource.m.

                 :(OOSound *)sound
{
    if (_sound != sound)
    {
        [self stop];
        [_sound autorelease];
        _sound = [sound retain];
    }
}

References _sound, sound, and stop.

Referenced by initWithSound:, OOMusic::playLooped:, playSound:repeatCount:, SoundSourceSetProperty(), and OOMusic::stop.

Here is the call graph for this function:

Here is the caller graph for this function:

setVelocity:

- (void) setVelocity:

(Vector)

inVelocity

Definition at line 286 of file OOSoundSource.m.

                    :(Vector)inVelocity
{
    
}

sound

- (OOSound *) sound

Definition at line 88 of file OOSoundSource.m.

{
    return _sound;
}

References _sound, and sound.

Referenced by channel:didFinishPlayingSound:, play, playOrRepeatSound:, setSound:, and sound.

Here is the call graph for this function:

Here is the caller graph for this function:

sourceWithCustomSoundKey:

+ (id) sourceWithCustomSoundKey:

(NSString *)

key

Provided by category OOSoundSource(OOCustomSounds).

Definition at line 11074 of file Universe.m.

                               :(NSString *)key
{
    return [[[self alloc] initWithCustomSoundKey:key] autorelease];
}

sourceWithSound:

+ (instancetype) sourceWithSound:

(OOSound *)

inSound

Definition at line 37 of file OOSoundSource.m.

                                :(OOSound *)inSound
{
    return [[[self alloc] initWithSound:inSound] autorelease];
}

stop

- (void) stop

Definition at line 171 of file OOSoundSource.m.

{
    OOSoundAcquireLock();
    
    if (nil != _channel)
    {
        [_channel setDelegate:[self class]];
        [_channel stop];
        _channel = nil;
        
        [sPlayingSoundSources removeObject:self];
        [self release];
    }
    
    OOSoundReleaseLock();
}

References _channel, nil, OOSoundAcquireLock, OOSoundReleaseLock, OOSoundChannel::setDelegate:, OOSoundChannel::stop, and stop.

Referenced by dealloc, play, OOMusic::playLooped:, playSound:repeatCount:, setSound:, SoundSourceStop(), OOMusic::stop, and stop.

Here is the call graph for this function:

Here is the caller graph for this function:

stopAll

+ (void) stopAll

Definition at line 189 of file OOSoundSource.m.

{
    /*  We're not allowed to mutate sPlayingSoundSources during iteration. The
        normal solution would be to copy the set, but since we know it will
        end up empty we may as well use the original set and let a new one be
        set up lazily.
    */
    NSMutableSet *playing = sPlayingSoundSources;
    sPlayingSoundSources = nil;
    
    [playing makeObjectsPerformSelector:@selector(stop)];
    [playing release];
}

References nil, sPlayingSoundSources, and stopAll.

Referenced by PlayerEntity::completeSetUpAndSetTarget:, and stopAll.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

_channel

- (OOSoundChannel*) _channel

private

Definition at line 47 of file OOSoundSource.h.

Referenced by channel:didFinishPlayingSound:, isPlaying, play, setGain:, setPosition:, and stop.

_gain

- (float) _gain

private

Definition at line 53 of file OOSoundSource.h.

Referenced by gain, init, and setGain:.

_loop

- (BOOL) _loop

private

Definition at line 48 of file OOSoundSource.h.

Referenced by loop, and setLoop:.

_position

- (Vector) _position

private

Definition at line 51 of file OOSoundSource.h.

Referenced by init, position, and setPosition:.

_positional

- (BOOL) _positional

private

Definition at line 52 of file OOSoundSource.h.

Referenced by init, positional, setPosition:, and setPositional:.

_remainingCount

- (uint8_t) _remainingCount

private

Definition at line 50 of file OOSoundSource.h.

Referenced by channel:didFinishPlayingSound:, play, and playOrRepeat.

_repeatCount

- (uint8_t) _repeatCount

private

Definition at line 49 of file OOSoundSource.h.

Referenced by repeatCount, and setRepeatCount:.

_sound

- (OOSound*) _sound

private

Definition at line 46 of file OOSoundSource.h.

Referenced by playOrRepeatSound:, setSound:, and sound.

---

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

• src/Core/OOSoundSource.h
• src/Core/OOSoundSource.m