mirror of
https://github.com/kyleneideck/BackgroundMusic
synced 2024-11-23 04:33:03 +00:00
59e70fb9d1
This is mostly so BGMApp won't leave BGMDevice as the default if BGMApp crashes, which would stop audio from playing until the user changed the default device themselves. Also handles SIGINT, SIGTERM and SIGQUIT. For crashes where the BGMApp process may be in an unknown state, e.g. segfaults, BGMXPCHelper handles changing the default device. Should fix the Travis Xcode 9 build, which is currently failing because the AppleScript we use to quit BGMApp in .travis.yml gets "user cancelled" for some reason. Also makes some minor improvements to the reports generated by CrashReporter. The way CrashReporter works with Background Music should otherwise be unchanged.
69 lines
2.8 KiB
Objective-C
69 lines
2.8 KiB
Objective-C
// This file is part of Background Music.
|
|
//
|
|
// Background Music is free software: you can redistribute it and/or
|
|
// modify it under the terms of the GNU General Public License as
|
|
// published by the Free Software Foundation, either version 2 of the
|
|
// License, or (at your option) any later version.
|
|
//
|
|
// Background Music is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Background Music. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
//
|
|
// BGMXPCProtocols.h
|
|
// SharedSource
|
|
//
|
|
// Copyright © 2016, 2017 Kyle Neideck
|
|
//
|
|
|
|
// Local Includes
|
|
#include "BGM_Types.h"
|
|
|
|
// System Includes
|
|
#import <Foundation/Foundation.h>
|
|
|
|
|
|
#pragma clang assume_nonnull begin
|
|
|
|
static NSString* kBGMXPCHelperMachServiceName = @kBGMXPCHelperBundleID;
|
|
|
|
// The protocol that BGMXPCHelper will vend as its XPC API.
|
|
@protocol BGMXPCHelperXPCProtocol
|
|
|
|
// Tells BGMXPCHelper that the caller is BGMApp and passes a listener endpoint that BGMXPCHelper can use to create connections to BGMApp.
|
|
// BGMXPCHelper may also pass the endpoint on to BGMDriver so it can do the same.
|
|
- (void) registerAsBGMAppWithListenerEndpoint:(NSXPCListenerEndpoint*)endpoint reply:(void (^)(void))reply;
|
|
- (void) unregisterAsBGMApp;
|
|
|
|
// BGMDriver calls this remote method when it wants BGMApp to start IO. BGMXPCHelper passes the message along and then passes the response
|
|
// back. This allows BGMDriver to wait for the audio hardware to start up, which means it can let the HAL know when it's safe to start
|
|
// sending us audio data from the client.
|
|
//
|
|
// If BGMApp can be reached, the error it returns will be passed the reply block. Otherwise, the reply block will be passed an error with
|
|
// one of the kBGMXPC_* error codes. It may have an underlying error using one of the NSXPCConnection* error codes from FoundationErrors.h.
|
|
- (void) startBGMAppPlayThroughSyncWithReply:(void (^)(NSError*))reply forUISoundsDevice:(BOOL)isUI;
|
|
|
|
// BGMXPCHelper will set the system's default output device to deviceID if it loses its connection
|
|
// to BGMApp and BGMApp has left BGMDevice as the default device. It waits for a short time first to
|
|
// give BGMApp a chance to fix the connection.
|
|
//
|
|
// This is so BGMDevice isn't left as the default device if BGMApp crashes or otherwise terminates
|
|
// abnormally. If audio is played to BGMDevice and BGMApp isn't running, the user won't hear it.
|
|
- (void) setOutputDeviceToMakeDefaultOnAbnormalTermination:(AudioObjectID)deviceID;
|
|
|
|
@end
|
|
|
|
|
|
// The protocol that BGMApp will vend as its XPC API.
|
|
@protocol BGMAppXPCProtocol
|
|
|
|
- (void) startPlayThroughSyncWithReply:(void (^)(NSError*))reply forUISoundsDevice:(BOOL)isUI;
|
|
|
|
@end
|
|
|
|
#pragma clang assume_nonnull end
|
|
|