OOMusicController Class Reference

#include <OOMusicController.h>

Inheritance diagram for OOMusicController:

Collaboration diagram for OOMusicController:

Instance Methods
(void)	- playMusicNamed:loop:
(void)	- playMusicNamed:loop:gain:
(void)	- playThemeMusic
(void)	- playDockingMusic
(void)	- playDockedMusic
(void)	- setMissionMusic:
(void)	- playMissionMusic
(void)	- justStop
(void)	- stop
(void)	- stopMusicNamed:
(void)	- stopThemeMusic
(void)	- stopDockingMusic
(void)	- stopMissionMusic
(void)	- toggleDockingMusic
(OOSoundSource *)	- soundSource
(NSString *)	- playingMusic
(BOOL)	- isPlaying
(OOMusicMode)	- mode
(void)	- setMode:
(id)	- init [implementation]
(void)	- playiTunesPlaylist: [implementation]
(void)	- pauseiTunes [implementation]
(id)	- copyWithZone: [implementation]
(id)	- retain [implementation]
(NSUInteger)	- retainCount [implementation]
(void)	- release [implementation]
(id)	- autorelease [implementation]

Class Methods
(OOMusicController *)	+ sharedController
(id)	+ allocWithZone: [implementation]

Private Attributes
OOMusicMode	_mode
NSString *	_missionMusic
OOMusic *	_current
uint8_t	_special

Detailed Description

Definition at line 51 of file OOMusicController.h.

Method Documentation

allocWithZone:

+ (id) allocWithZone: (NSZone *) inZone

implementation

Provided by category OOMusicController(Singleton).

Definition at line 306 of file OOMusicController.m.

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

autorelease

- (id) autorelease

implementation

Provided by category OOMusicController(Singleton).

Definition at line 339 of file OOMusicController.m.

{
    return self;
}

copyWithZone:

- (id) copyWithZone: (NSZone *) inZone

implementation

Provided by category OOMusicController(Singleton).

Definition at line 317 of file OOMusicController.m.

                   :(NSZone *)inZone
{
    return self;
}

init

- (id) init

implementation

Definition at line 68 of file OOMusicController.m.

{
    self = [super init];
    if (self != nil)
    {
        NSString *modeString = [[NSUserDefaults standardUserDefaults] stringForKey:@"music mode"];
        if ([modeString isEqualToString:@"off"])  _mode = kOOMusicOff;
        else if ([modeString isEqualToString:@"iTunes"])  _mode = kOOMusicITunes;
        else  _mode = kOOMusicOn;
        
        // Handle unlikely case of taking prefs from iTunes-enabled system to other.
        if (_mode > kOOMusicModeMax)  _mode = kOOMusicModeMax;
        
        [self setMissionMusic:@"OoliteTheme.ogg"];
    }
    
    return self;
}

References _mode, init, kOOMusicITunes, kOOMusicModeMax, kOOMusicOff, kOOMusicOn, nil, and setMissionMusic:.

Referenced by init.

Here is the call graph for this function:

Here is the caller graph for this function:

isPlaying

- (BOOL) isPlaying

Definition at line 239 of file OOMusicController.m.

{
    return [_current isPlaying];
}

References OOMusic::isPlaying, and isPlaying.

Referenced by isPlaying, playMusicNamed:loop:gain:, PlayerEntity(OOControlsPrivate)::pollAutopilotControls:, and toggleDockingMusic.

Here is the call graph for this function:

Here is the caller graph for this function:

justStop

- (void) justStop

Definition at line 170 of file OOMusicController.m.

{
    [_current stop];
    [_current release];
    _current = nil;
    _special = kSpecialNone;
}

References _current, _special, justStop, kSpecialNone, nil, and OOMusic::stop.

Referenced by justStop, PlayerEntity::setUpAndConfirmOK:saveGame:, stop, and stopThemeMusic.

Here is the call graph for this function:

Here is the caller graph for this function:

mode

- (OOMusicMode) mode

Definition at line 245 of file OOMusicController.m.

{
    return _mode;
}

References _mode, and mode.

Referenced by PlayerEntity(OOControlsPrivate)::handleGameOptionsScreenKeys, mode, PlayerEntity::setGuiToGameOptionsScreen, and setMode:.

Here is the call graph for this function:

Here is the caller graph for this function:

pauseiTunes

- (void) pauseiTunes

implementation

Provided by category OOMusicController(Private).

Definition at line 373 of file OOMusicController.m.

{
    NSString *ootunesScriptString = [NSString stringWithFormat:@"try\nignoring application responses\ntell application \"iTunes\" to pause\nend ignoring\nend try"];
    NSAppleScript *ootunesScript = [[NSAppleScript alloc] initWithSource:ootunesScriptString];
    NSDictionary *errDict = nil;
    [ootunesScript executeAndReturnError:&errDict];
    if (errDict)
        OOLog(@"sound.music.iTunesIntegration.failed", @"ootunes returned :%@", errDict);
    [ootunesScript release]; 
}

Referenced by setMode:.

Here is the caller graph for this function:

playDockedMusic

- (void) playDockedMusic

Definition at line 137 of file OOMusicController.m.

{
    _special = kSpecialDocked;
    
    if (_mode == kOOMusicITunes)
    {
        [self playiTunesPlaylist:@"Oolite-Docked"];
    }
    else
    {
        [self playMusicNamed:@"OoliteDocked.ogg" loop:NO];
    }
}

References _mode, _special, kOOMusicITunes, kSpecialDocked, playDockedMusic, playiTunesPlaylist:, and playMusicNamed:loop:.

Referenced by PlayerEntity::docked, playDockedMusic, setMode:, and stopThemeMusic.

Here is the call graph for this function:

Here is the caller graph for this function:

playDockingMusic

- (void) playDockingMusic

Definition at line 122 of file OOMusicController.m.

{
    _special = kSpecialDocking;
    
    if (_mode == kOOMusicITunes)
    {
        [self playiTunesPlaylist:@"Oolite-Docking"];
    }
    else
    {
        [self playMusicNamed:@"BlueDanube.ogg" loop:YES];
    }
}

References _mode, _special, kOOMusicITunes, kSpecialDocking, playDockingMusic, playiTunesPlaylist:, and playMusicNamed:loop:.

Referenced by PlayerEntity::engageAutopilotToStation:, playDockingMusic, setMode:, and toggleDockingMusic.

Here is the call graph for this function:

Here is the caller graph for this function:

playingMusic

- (NSString *) playingMusic

Definition at line 233 of file OOMusicController.m.

{
    return [_current name];
}

References OOMusic::name, and playingMusic.

Referenced by playingMusic, playMusicNamed:loop:gain:, and stopMusicNamed:.

Here is the call graph for this function:

Here is the caller graph for this function:

playiTunesPlaylist:

- (void) playiTunesPlaylist: (NSString *) playlistName

implementation

Provided by category OOMusicController(Private).

Definition at line 350 of file OOMusicController.m.

                           :(NSString *)playlistName
{
    NSString *ootunesScriptString =
        [NSString stringWithFormat:
        @"with timeout of 1 second\n"
         "    tell application \"iTunes\"\n"
         "        copy playlist \"%@\" to thePlaylist\n"
         "        if thePlaylist exists then\n"
         "            play some track of thePlaylist\n"
         "        end if\n"
         "    end tell\n"
         "end timeout",
         playlistName];
    
    NSAppleScript *ootunesScript = [[[NSAppleScript alloc] initWithSource:ootunesScriptString] autorelease];
    NSDictionary *errDict = nil;
    
    [ootunesScript executeAndReturnError:&errDict];
    if (errDict)
        OOLog(@"sound.music.iTunesIntegration.failed", @"ootunes returned :%@", errDict);
}

Referenced by playDockedMusic, playDockingMusic, and stop.

Here is the caller graph for this function:

playMissionMusic

- (void) playMissionMusic

Definition at line 159 of file OOMusicController.m.

{
    if (_missionMusic != nil)
    {
        _special = kSpecialMission;
        [self playMusicNamed:_missionMusic loop:NO];
    }
}

References _missionMusic, _special, kSpecialMission, nil, playMissionMusic, and playMusicNamed:loop:.

Referenced by playMissionMusic, PlayerEntity(Scripting)::setGuiToMissionScreenWithCallback:, and setMode:.

Here is the call graph for this function:

Here is the caller graph for this function:

playMusicNamed:loop:

- (void) playMusicNamed:		(NSString *)	name
loop:		(BOOL)	loop

Definition at line 88 of file OOMusicController.m.

                       :(NSString *)name loop:(BOOL)loop
{
    [self playMusicNamed:name loop:loop gain:OO_DEFAULT_SOUNDSOURCE_GAIN];
}

References playMusicNamed:loop:gain:.

Referenced by playDockedMusic, playDockingMusic, playMissionMusic, and playThemeMusic.

Here is the call graph for this function:

Here is the caller graph for this function:

playMusicNamed:loop:gain:

- (void) playMusicNamed:		(NSString *)	name
loop:		(BOOL)	loop
gain:		(float)	gain

Definition at line 94 of file OOMusicController.m.

                       :(NSString *)name loop:(BOOL)loop gain:(float)gain
{
    if ([self isPlaying] && [name isEqual:[self playingMusic]])  return;
    
    if (_mode == kOOMusicOn || (_mode == kOOMusicITunes && [name isEqualToString:@"OoliteTheme.ogg"]))
    {
        OOMusic *music = [ResourceManager ooMusicNamed:name inFolder:@"Music"];
        if (music != nil)
        {
            [_current stop];
            
            [music setMusicGain:OOClamp_0_1_f(gain)];
            [music playLooped:loop];
            
            [_current release];
            _current = [music retain];
        }
    }
}

References _current, _mode, isPlaying, kOOMusicITunes, kOOMusicOn, nil, ResourceManager::ooMusicNamed:inFolder:, playingMusic, OOMusic::playLooped:, OOMusic::setMusicGain:, and OOMusic::stop.

Referenced by playMusicNamed:loop:, and SoundStaticPlayMusic().

Here is the call graph for this function:

Here is the caller graph for this function:

playThemeMusic

- (void) playThemeMusic

Definition at line 115 of file OOMusicController.m.

{
    _special = kSpecialTheme;
    [self playMusicNamed:@"OoliteTheme.ogg" loop:YES];
}

References _special, kSpecialTheme, playMusicNamed:loop:, and playThemeMusic.

Referenced by playThemeMusic, PlayerEntity::setGuiToIntroFirstGo:, PlayerEntity::setGuiToOXZManager, and setMode:.

Here is the call graph for this function:

Here is the caller graph for this function:

release

- (void) release

implementation

Provided by category OOMusicController(Singleton).

Definition at line 335 of file OOMusicController.m.

{}

retain

- (id) retain

implementation

Provided by category OOMusicController(Singleton).

Definition at line 323 of file OOMusicController.m.

{
    return self;
}

retainCount

- (NSUInteger) retainCount

implementation

Provided by category OOMusicController(Singleton).

Definition at line 329 of file OOMusicController.m.

{
    return UINT_MAX;
}

setMissionMusic:

- (void) setMissionMusic:

(NSString *)

missionMusicName

Definition at line 152 of file OOMusicController.m.

                        :(NSString *)missionMusicName
{
    [_missionMusic autorelease];
    _missionMusic = [missionMusicName copy];
}

References _missionMusic.

Referenced by init, MissionRunScreen(), and PlayerEntity(Scripting)::setMissionMusic:.

Here is the caller graph for this function:

setMode:

- (void) setMode:

(OOMusicMode)

mode

Definition at line 251 of file OOMusicController.m.

                :(OOMusicMode)mode
{
    if (mode <= kOOMusicModeMax && _mode != mode)
    {
        if (_mode == kOOMusicITunes) [self pauseiTunes];
        _mode = mode;
        
        if (_mode == kOOMusicOff)  [self stop];
        else switch (_special)
        {
            case kSpecialNone:
                [self stop];
                break;
                
            case kSpecialTheme:
                [self playThemeMusic];
                break;
                
            case kSpecialDocked:
                [self playDockedMusic];
                break;
                
            case kSpecialDocking:
                [self playDockingMusic];
                break;
                
            case kSpecialMission:
                [self playMissionMusic];
                break;
        }
        
        NSString *modeString = nil;
        switch (_mode)
        {
            case kOOMusicOff:        modeString = @"off"; break;
            case kOOMusicOn:      modeString = @"on"; break;
            case kOOMusicITunes:  modeString = @"iTunes"; break;
        }
        [[NSUserDefaults standardUserDefaults] setObject:modeString forKey:@"music mode"];
    }
}

References _mode, _special, kOOMusicITunes, kOOMusicModeMax, kOOMusicOff, kOOMusicOn, kSpecialDocked, kSpecialDocking, kSpecialMission, kSpecialNone, kSpecialTheme, mode, nil, pauseiTunes, playDockedMusic, playDockingMusic, playMissionMusic, playThemeMusic, and stop.

Referenced by PlayerEntity(OOControlsPrivate)::handleGameOptionsScreenKeys.

Here is the call graph for this function:

Here is the caller graph for this function:

sharedController

+ (OOMusicController *) sharedController

Definition at line 57 of file OOMusicController.m.

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

References nil, sharedController, and sSingleton.

Referenced by PlayerEntity::disengageAutopilot, PlayerEntity::docked, PlayerEntity::engageAutopilotToStation:, PlayerEntity(OOControlsPrivate)::handleGameOptionsScreenKeys, PlayerEntity::interpretAIMessage:, PlayerEntity::leaveDock:, MissionRunScreen(), PlayerEntity(OOControlsPrivate)::pollAutopilotControls:, PlayerEntity(OOControlsPrivate)::pollDemoControls:, PlayerEntity::setGuiToGameOptionsScreen, PlayerEntity::setGuiToIntroFirstGo:, PlayerEntity(Scripting)::setGuiToMissionScreenWithCallback:, PlayerEntity::setGuiToOXZManager, PlayerEntity(Scripting)::setMissionMusic:, PlayerEntity::setUpAndConfirmOK:saveGame:, sharedController, SoundStaticMusicSoundSource(), SoundStaticPlayMusic(), and SoundStaticStopMusic().

Here is the call graph for this function:

Here is the caller graph for this function:

soundSource

- (OOSoundSource *) soundSource

Definition at line 227 of file OOMusicController.m.

{
    return [_current musicSoundSource];
}

References OOMusic::musicSoundSource, and soundSource.

Referenced by soundSource, and SoundStaticMusicSoundSource().

Here is the call graph for this function:

Here is the caller graph for this function:

stop

- (void) stop

Definition at line 179 of file OOMusicController.m.

{
    [self justStop];
    
    if (_mode == kOOMusicITunes)
    {
        [self playiTunesPlaylist:@"Oolite-Inflight"];
    }
}

References _mode, justStop, kOOMusicITunes, playiTunesPlaylist:, and stop.

Referenced by PlayerEntity::leaveDock:, setMode:, SoundStaticStopMusic(), stop, stopDockingMusic, stopMissionMusic, stopMusicNamed:, and toggleDockingMusic.

Here is the call graph for this function:

Here is the caller graph for this function:

stopDockingMusic

- (void) stopDockingMusic

Definition at line 206 of file OOMusicController.m.

{
    if (_special == kSpecialDocking)  [self stop];
}

References _special, kSpecialDocking, stop, and stopDockingMusic.

Referenced by PlayerEntity::disengageAutopilot, PlayerEntity::docked, PlayerEntity::interpretAIMessage:, and stopDockingMusic.

Here is the call graph for this function:

Here is the caller graph for this function:

stopMissionMusic

- (void) stopMissionMusic

Definition at line 212 of file OOMusicController.m.

{
    if (_special == kSpecialMission)  [self stop];
}

References _special, kSpecialMission, stop, and stopMissionMusic.

Referenced by PlayerEntity(OOControlsPrivate)::pollDemoControls:, and stopMissionMusic.

Here is the call graph for this function:

Here is the caller graph for this function:

stopMusicNamed:

- (void) stopMusicNamed:

(NSString *)

name

Definition at line 190 of file OOMusicController.m.

                       :(NSString *)name
{
    if ([name isEqual:[self playingMusic]])  [self stop];
}

References playingMusic, and stop.

Here is the call graph for this function:

stopThemeMusic

- (void) stopThemeMusic

Definition at line 196 of file OOMusicController.m.

{
    if (_special == kSpecialTheme)
    {
        [self justStop];
        [self playDockedMusic];
    }
}

References _special, justStop, kSpecialTheme, playDockedMusic, and stopThemeMusic.

Referenced by PlayerEntity(OOControlsPrivate)::pollDemoControls:, and stopThemeMusic.

Here is the call graph for this function:

Here is the caller graph for this function:

toggleDockingMusic

- (void) toggleDockingMusic

Definition at line 218 of file OOMusicController.m.

{
    if (_mode != kOOMusicOn)  return;
    
    if (![self isPlaying])  [self playDockingMusic];
    else if (_special == kSpecialDocking)  [self stop];
}

References _mode, _special, isPlaying, kOOMusicOn, kSpecialDocking, playDockingMusic, stop, and toggleDockingMusic.

Referenced by PlayerEntity(OOControlsPrivate)::pollAutopilotControls:, and toggleDockingMusic.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

_current

- (OOMusic*) _current

private

Definition at line 56 of file OOMusicController.h.

Referenced by justStop, and playMusicNamed:loop:gain:.

_missionMusic

- (NSString*) _missionMusic

private

Definition at line 55 of file OOMusicController.h.

Referenced by playMissionMusic, and setMissionMusic:.

_mode

- (OOMusicMode) _mode

private

Definition at line 54 of file OOMusicController.h.

Referenced by init, mode, playDockedMusic, playDockingMusic, playMusicNamed:loop:gain:, setMode:, stop, and toggleDockingMusic.

_special

- (uint8_t) _special

private

Definition at line 57 of file OOMusicController.h.

Referenced by justStop, playDockedMusic, playDockingMusic, playMissionMusic, playThemeMusic, setMode:, stopDockingMusic, stopMissionMusic, stopThemeMusic, and toggleDockingMusic.

---

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

• src/Core/OOMusicController.h
• src/Core/OOMusicController.m