#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 32 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();
}

◆ dealloc

- (void) dealloc

implementation

Definition at line 32 of file OOSoundSource.m.

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

◆ descriptionComponents

- (NSString *) descriptionComponents

implementation

Definition at line 32 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]];
    }
}

◆ gain

- (float) gain

Definition at line 32 of file OOSoundSource.m.

{
    return _gain;
}

◆ init

- (id) init

implementation

Definition at line 32 of file OOSoundSource.m.

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

◆ initWithCustomSoundKey:

- (id) initWithCustomSoundKey: (NSString *) key

Provided by category OOSoundSource(OOCustomSounds).

Definition at line 10720 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 32 of file OOSoundSource.m.

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

◆ isPlaying

- (BOOL) isPlaying

Definition at line 32 of file OOSoundSource.m.

{
    return _channel != nil;
}

◆ loop

- (BOOL) loop

Definition at line 32 of file OOSoundSource.m.

{
    return _loop;
}

◆ oo_jsClassName

- (NSString *) oo_jsClassName

implementation

Provided by category OOSoundSource(OOJavaScriptExtentions).

Definition at line 309 of file OOJSSoundSource.m.

{
    return @"SoundSource";
}

◆ oo_jsValueInContext:

- (jsval) oo_jsValueInContext: (JSContext *) context

implementation

Provided by category OOSoundSource(OOJavaScriptExtentions).

Definition at line 309 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 32 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();
}

Referenced by SoundSourcePlay().

Here is the caller graph for this function:

◆ playCustomSoundWithKey:

- (void) playCustomSoundWithKey: (NSString *) key

Provided by category OOSoundSource(OOCustomSounds).

Definition at line 10720 of file Universe.m.

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

◆ playOrRepeat

- (void) playOrRepeat

Definition at line 32 of file OOSoundSource.m.

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

Referenced by OOSoundSource(OOJavaScriptExtentions)::oo_jsClassName.

Here is the caller graph for this function:

◆ playOrRepeatSound:

- (void) playOrRepeatSound: (OOSound *) inSound

Definition at line 32 of file OOSoundSource.m.

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

◆ playSound:

- (void) playSound: (OOSound *) inSound

Definition at line 32 of file OOSoundSource.m.

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

Referenced by OOTrumble::actionBlink, and PlayTrumbleIdle().

Here is the caller graph for this function:

◆ playSound:repeatCount:

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

Definition at line 32 of file OOSoundSource.m.

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

◆ position

- (Vector) position

Definition at line 32 of file OOSoundSource.m.

{
    return _position;
}

◆ positional

- (BOOL) positional

Definition at line 32 of file OOSoundSource.m.

{
    return _positional;
}

◆ positionRelativeTo:

- (void) positionRelativeTo: (OOSoundReferencePoint *) inPoint

Definition at line 32 of file OOSoundSource.m.

                           :(OOSoundReferencePoint *)inPoint
{
    
}

◆ repeatCount

- (uint8_t) repeatCount

Definition at line 32 of file OOSoundSource.m.

{
    return _repeatCount ? _repeatCount : 1;
}

◆ setConeAngle:

- (void) setConeAngle: (float) inAngle

Definition at line 32 of file OOSoundSource.m.

                     :(float)inAngle
{
    
}

◆ setGain:

- (void) setGain: (float) gain

Definition at line 32 of file OOSoundSource.m.

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

Referenced by SoundSourceSetProperty().

Here is the caller graph for this function:

◆ setGainInsideCone:outsideCone:

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

Definition at line 32 of file OOSoundSource.m.

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

◆ setLoop:

- (void) setLoop: (BOOL) inLoop

Definition at line 32 of file OOSoundSource.m.

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

Referenced by SoundSourceSetProperty().

Here is the caller graph for this function:

◆ setOrientation:

- (void) setOrientation: (Vector) inOrientation

Definition at line 32 of file OOSoundSource.m.

                       :(Vector)inOrientation
{
    
}

◆ setPosition:

- (void) setPosition: (Vector) inPosition

Definition at line 32 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]; 
    }
}

Referenced by OOTrumble::actionBlink, PlayTrumbleIdle(), and SoundSourceSetProperty().

Here is the caller graph for this function:

◆ setPositional:

- (void) setPositional: (BOOL) inPositional

Definition at line 32 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];
    }
}

Referenced by SoundSourceSetProperty().

Here is the caller graph for this function:

◆ setRepeatCount:

- (void) setRepeatCount: (uint8_t) inCount

Definition at line 32 of file OOSoundSource.m.

                       :(uint8_t)count
{
    _repeatCount = count;
}

Referenced by SoundSourcePlay(), and SoundSourceSetProperty().

Here is the caller graph for this function:

◆ setSound:

- (void) setSound: (OOSound *) inSound

Definition at line 32 of file OOSoundSource.m.

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

Referenced by SoundSourceSetProperty().

Here is the caller graph for this function:

◆ setVelocity:

- (void) setVelocity: (Vector) inVelocity

Definition at line 32 of file OOSoundSource.m.

                    :(Vector)inVelocity
{
    
}

◆ sound

- (OOSound *) sound

Definition at line 32 of file OOSoundSource.m.

{
    return _sound;
}

◆ sourceWithCustomSoundKey:

+ (id) sourceWithCustomSoundKey: (NSString *) key

Provided by category OOSoundSource(OOCustomSounds).

Definition at line 10720 of file Universe.m.

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

◆ sourceWithSound:

+ (instancetype) sourceWithSound: (OOSound *) inSound

Definition at line 32 of file OOSoundSource.m.

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

◆ stop

- (void) stop

Definition at line 32 of file OOSoundSource.m.

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

Referenced by SoundSourceStop().

Here is the caller graph for this function:

◆ stopAll

+ (void) stopAll

Definition at line 32 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];
}

Member Data Documentation

◆ _channel

- (OOSoundChannel*) _channel

private

Definition at line 47 of file OOSoundSource.h.

◆ _gain

- (float) _gain

private

Definition at line 53 of file OOSoundSource.h.

◆ _loop

- (BOOL) _loop

private

Definition at line 48 of file OOSoundSource.h.

◆ _position

- (Vector) _position

private

Definition at line 51 of file OOSoundSource.h.

◆ _positional

- (BOOL) _positional

private

Definition at line 52 of file OOSoundSource.h.

◆ _remainingCount

- (uint8_t) _remainingCount

private

Definition at line 50 of file OOSoundSource.h.

◆ _repeatCount

- (uint8_t) _repeatCount

private

Definition at line 49 of file OOSoundSource.h.

◆ _sound

- (OOSound*) _sound

private

Definition at line 46 of file OOSoundSource.h.

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

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

Instance Methods

Class Methods

Private Attributes

Detailed Description

Method Documentation

◆ channel:didFinishPlayingSound:

◆ dealloc

◆ descriptionComponents

◆ gain

◆ init

◆ initWithCustomSoundKey:

◆ initWithSound:

◆ isPlaying

◆ loop

◆ oo_jsClassName

◆ oo_jsValueInContext:

◆ play

◆ playCustomSoundWithKey:

◆ playOrRepeat

◆ playOrRepeatSound:

◆ playSound:

◆ playSound:repeatCount:

◆ position

◆ positional

◆ positionRelativeTo:

◆ repeatCount

◆ setConeAngle:

◆ setGain:

◆ setGainInsideCone:outsideCone:

◆ setLoop:

◆ setOrientation:

◆ setPosition:

◆ setPositional:

◆ setRepeatCount:

◆ setSound:

◆ setVelocity:

◆ sound

◆ sourceWithCustomSoundKey:

◆ sourceWithSound:

◆ stop

◆ stopAll

Member Data Documentation

◆ _channel

◆ _gain

◆ _loop

◆ _position

◆ _positional

◆ _remainingCount

◆ _repeatCount

◆ _sound