Blame channels/rdpsnd/client/mac/rdpsnd_mac.m

Packit Service fa4841
/**
Packit Service fa4841
 * FreeRDP: A Remote Desktop Protocol Implementation
Packit Service fa4841
 * Audio Output Virtual Channel
Packit Service fa4841
 *
Packit Service fa4841
 * Copyright 2012 Laxmikant Rashinkar <LK.Rashinkar@gmail.com>
Packit Service fa4841
 * Copyright 2015 Thincast Technologies GmbH
Packit Service fa4841
 * Copyright 2015 DI (FH) Martin Haimberger <martin.haimberger@thincast.com>
Packit Service fa4841
 * Copyright 2016 Inuvika Inc.
Packit Service fa4841
 * Copyright 2016 David PHAM-VAN <d.phamvan@inuvika.com>
Packit Service fa4841
 *
Packit Service fa4841
 * Licensed under the Apache License, Version 2.0 (the "License");
Packit Service fa4841
 * you may not use this file except in compliance with the License.
Packit Service fa4841
 * You may obtain a copy of the License at
Packit Service fa4841
 *
Packit Service fa4841
 *     http://www.apache.org/licenses/LICENSE-2.0
Packit Service fa4841
 *
Packit Service fa4841
 * Unless required by applicable law or agreed to in writing, software
Packit Service fa4841
 * distributed under the License is distributed on an "AS IS" BASIS,
Packit Service fa4841
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Packit Service fa4841
 * See the License for the specific language governing permissions and
Packit Service fa4841
 * limitations under the License.
Packit Service fa4841
 */
Packit Service fa4841
Packit Service fa4841
#ifdef HAVE_CONFIG_H
Packit Service fa4841
#include "config.h"
Packit Service fa4841
#endif
Packit Service fa4841
Packit Service fa4841
#include <stdio.h>
Packit Service fa4841
#include <stdlib.h>
Packit Service fa4841
#include <string.h>
Packit Service fa4841
Packit Service fa4841
#include <winpr/crt.h>
Packit Service fa4841
#include <winpr/sysinfo.h>
Packit Service fa4841
Packit Service fa4841
#include <freerdp/types.h>
Packit Service fa4841
Packit Service fa4841
#include <AVFoundation/AVAudioBuffer.h>
Packit Service fa4841
#include <AVFoundation/AVFoundation.h>
Packit Service fa4841
Packit Service fa4841
#include "rdpsnd_main.h"
Packit Service fa4841
Packit Service fa4841
struct rdpsnd_mac_plugin
Packit Service fa4841
{
Packit Service fa4841
	rdpsndDevicePlugin device;
Packit Service fa4841
Packit Service fa4841
	BOOL isOpen;
Packit Service fa4841
	BOOL isPlaying;
Packit Service fa4841
Packit Service fa4841
	UINT32 latency;
Packit Service fa4841
	AUDIO_FORMAT format;
Packit Service fa4841
Packit Service fa4841
	AVAudioEngine *engine;
Packit Service fa4841
	AVAudioPlayerNode *player;
Packit Service fa4841
	UINT64 diff;
Packit Service fa4841
};
Packit Service fa4841
typedef struct rdpsnd_mac_plugin rdpsndMacPlugin;
Packit Service fa4841
Packit Service fa4841
static BOOL rdpsnd_mac_set_format(rdpsndDevicePlugin *device, const AUDIO_FORMAT *format,
Packit Service fa4841
                                  UINT32 latency)
Packit Service fa4841
{
Packit Service fa4841
	rdpsndMacPlugin *mac = (rdpsndMacPlugin *)device;
Packit Service fa4841
	if (!mac || !format)
Packit Service fa4841
		return FALSE;
Packit Service fa4841
Packit Service fa4841
	mac->latency = latency;
Packit Service fa4841
	mac->format = *format;
Packit Service fa4841
Packit Service fa4841
	audio_format_print(WLog_Get(TAG), WLOG_DEBUG, format);
Packit Service fa4841
	return TRUE;
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
static char *FormatError(OSStatus st)
Packit Service fa4841
{
Packit Service fa4841
	switch (st)
Packit Service fa4841
	{
Packit Service fa4841
		case kAudioFileUnspecifiedError:
Packit Service fa4841
			return "kAudioFileUnspecifiedError";
Packit Service fa4841
Packit Service fa4841
		case kAudioFileUnsupportedFileTypeError:
Packit Service fa4841
			return "kAudioFileUnsupportedFileTypeError";
Packit Service fa4841
Packit Service fa4841
		case kAudioFileUnsupportedDataFormatError:
Packit Service fa4841
			return "kAudioFileUnsupportedDataFormatError";
Packit Service fa4841
Packit Service fa4841
		case kAudioFileUnsupportedPropertyError:
Packit Service fa4841
			return "kAudioFileUnsupportedPropertyError";
Packit Service fa4841
Packit Service fa4841
		case kAudioFileBadPropertySizeError:
Packit Service fa4841
			return "kAudioFileBadPropertySizeError";
Packit Service fa4841
Packit Service fa4841
		case kAudioFilePermissionsError:
Packit Service fa4841
			return "kAudioFilePermissionsError";
Packit Service fa4841
Packit Service fa4841
		case kAudioFileNotOptimizedError:
Packit Service fa4841
			return "kAudioFileNotOptimizedError";
Packit Service fa4841
Packit Service fa4841
		case kAudioFileInvalidChunkError:
Packit Service fa4841
			return "kAudioFileInvalidChunkError";
Packit Service fa4841
Packit Service fa4841
		case kAudioFileDoesNotAllow64BitDataSizeError:
Packit Service fa4841
			return "kAudioFileDoesNotAllow64BitDataSizeError";
Packit Service fa4841
Packit Service fa4841
		case kAudioFileInvalidPacketOffsetError:
Packit Service fa4841
			return "kAudioFileInvalidPacketOffsetError";
Packit Service fa4841
Packit Service fa4841
		case kAudioFileInvalidFileError:
Packit Service fa4841
			return "kAudioFileInvalidFileError";
Packit Service fa4841
Packit Service fa4841
		case kAudioFileOperationNotSupportedError:
Packit Service fa4841
			return "kAudioFileOperationNotSupportedError";
Packit Service fa4841
Packit Service fa4841
		case kAudioFileNotOpenError:
Packit Service fa4841
			return "kAudioFileNotOpenError";
Packit Service fa4841
Packit Service fa4841
		case kAudioFileEndOfFileError:
Packit Service fa4841
			return "kAudioFileEndOfFileError";
Packit Service fa4841
Packit Service fa4841
		case kAudioFilePositionError:
Packit Service fa4841
			return "kAudioFilePositionError";
Packit Service fa4841
Packit Service fa4841
		case kAudioFileFileNotFoundError:
Packit Service fa4841
			return "kAudioFileFileNotFoundError";
Packit Service fa4841
Packit Service fa4841
		default:
Packit Service fa4841
			return "unknown error";
Packit Service fa4841
	}
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
static void rdpsnd_mac_release(rdpsndMacPlugin *mac)
Packit Service fa4841
{
Packit Service fa4841
	if (mac->player)
Packit Service fa4841
		[mac->player release];
Packit Service fa4841
	mac->player = NULL;
Packit Service fa4841
Packit Service fa4841
	if (mac->engine)
Packit Service fa4841
		[mac->engine release];
Packit Service fa4841
	mac->engine = NULL;
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
static BOOL rdpsnd_mac_open(rdpsndDevicePlugin *device, const AUDIO_FORMAT *format, UINT32 latency)
Packit Service fa4841
{
Packit Service fa4841
	AudioDeviceID outputDeviceID;
Packit Service fa4841
	UInt32 propertySize;
Packit Service fa4841
	OSStatus err;
Packit Service fa4841
	NSError *error;
Packit Service fa4841
	rdpsndMacPlugin *mac = (rdpsndMacPlugin *)device;
Packit Service fa4841
	AudioObjectPropertyAddress propertyAddress = { kAudioHardwarePropertyDefaultSystemOutputDevice,
Packit Service fa4841
		                                           kAudioObjectPropertyScopeGlobal,
Packit Service fa4841
		                                           kAudioObjectPropertyElementMaster };
Packit Service fa4841
Packit Service fa4841
	if (mac->isOpen)
Packit Service fa4841
		return TRUE;
Packit Service fa4841
Packit Service fa4841
	if (!rdpsnd_mac_set_format(device, format, latency))
Packit Service fa4841
		return FALSE;
Packit Service fa4841
Packit Service fa4841
	propertySize = sizeof(outputDeviceID);
Packit Service fa4841
	err = AudioObjectGetPropertyData(kAudioObjectSystemObject, &propertyAddress, 0, NULL,
Packit Service fa4841
	                                 &propertySize, &outputDeviceID);
Packit Service fa4841
	if (err)
Packit Service fa4841
	{
Packit Service fa4841
		WLog_ERR(TAG, "AudioHardwareGetProperty: %s", FormatError(err));
Packit Service fa4841
		return FALSE;
Packit Service fa4841
	}
Packit Service fa4841
Packit Service fa4841
	mac->engine = [[AVAudioEngine alloc] init];
Packit Service fa4841
	if (!mac->engine)
Packit Service fa4841
		return FALSE;
Packit Service fa4841
Packit Service fa4841
	if (@available(macOS 10.15, *))
Packit Service fa4841
	{
Packit Service fa4841
		/* Setting the output audio device on 10.15 or later breaks sound playback. Do not set for
Packit Service fa4841
		 * now until we find a proper fix for #5747 */
Packit Service fa4841
	}
Packit Service fa4841
	else
Packit Service fa4841
	{
Packit Service fa4841
		err = AudioUnitSetProperty(mac->engine.outputNode.audioUnit,
Packit Service fa4841
		                           kAudioOutputUnitProperty_CurrentDevice, kAudioUnitScope_Global,
Packit Service fa4841
		                           0, &outputDeviceID, sizeof(outputDeviceID));
Packit Service fa4841
		if (err)
Packit Service fa4841
		{
Packit Service fa4841
			rdpsnd_mac_release(mac);
Packit Service fa4841
			WLog_ERR(TAG, "AudioUnitSetProperty: %s", FormatError(err));
Packit Service fa4841
			return FALSE;
Packit Service fa4841
		}
Packit Service fa4841
	}
Packit Service fa4841
Packit Service fa4841
	mac->player = [[AVAudioPlayerNode alloc] init];
Packit Service fa4841
	if (!mac->player)
Packit Service fa4841
	{
Packit Service fa4841
		rdpsnd_mac_release(mac);
Packit Service fa4841
		WLog_ERR(TAG, "AVAudioPlayerNode::init() failed");
Packit Service fa4841
		return FALSE;
Packit Service fa4841
	}
Packit Service fa4841
Packit Service fa4841
	[mac->engine attachNode:mac->player];
Packit Service fa4841
Packit Service fa4841
	[mac->engine connect:mac->player to:mac->engine.mainMixerNode format:nil];
Packit Service fa4841
Packit Service fa4841
	if (![mac->engine startAndReturnError:&error])
Packit Service fa4841
	{
Packit Service fa4841
		device->Close(device);
Packit Service fa4841
		WLog_ERR(TAG, "Failed to start audio player %s", [error.localizedDescription UTF8String]);
Packit Service fa4841
		return FALSE;
Packit Service fa4841
	}
Packit Service fa4841
Packit Service fa4841
	mac->isOpen = TRUE;
Packit Service fa4841
	return TRUE;
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
static void rdpsnd_mac_close(rdpsndDevicePlugin *device)
Packit Service fa4841
{
Packit Service fa4841
	rdpsndMacPlugin *mac = (rdpsndMacPlugin *)device;
Packit Service fa4841
Packit Service fa4841
	if (mac->isPlaying)
Packit Service fa4841
	{
Packit Service fa4841
		[mac->player stop];
Packit Service fa4841
		mac->isPlaying = FALSE;
Packit Service fa4841
	}
Packit Service fa4841
Packit Service fa4841
	if (mac->isOpen)
Packit Service fa4841
	{
Packit Service fa4841
		[mac->engine stop];
Packit Service fa4841
		mac->isOpen = FALSE;
Packit Service fa4841
	}
Packit Service fa4841
Packit Service fa4841
	rdpsnd_mac_release(mac);
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
static void rdpsnd_mac_free(rdpsndDevicePlugin *device)
Packit Service fa4841
{
Packit Service fa4841
	rdpsndMacPlugin *mac = (rdpsndMacPlugin *)device;
Packit Service fa4841
	device->Close(device);
Packit Service fa4841
	free(mac);
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
static BOOL rdpsnd_mac_format_supported(rdpsndDevicePlugin *device, const AUDIO_FORMAT *format)
Packit Service fa4841
{
Packit Service fa4841
	WINPR_UNUSED(device);
Packit Service fa4841
Packit Service fa4841
	switch (format->wFormatTag)
Packit Service fa4841
	{
Packit Service fa4841
		case WAVE_FORMAT_PCM:
Packit Service fa4841
			if (format->wBitsPerSample != 16)
Packit Service fa4841
				return FALSE;
Packit Service fa4841
			return TRUE;
Packit Service fa4841
Packit Service fa4841
		default:
Packit Service fa4841
			return FALSE;
Packit Service fa4841
	}
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
static BOOL rdpsnd_mac_set_volume(rdpsndDevicePlugin *device, UINT32 value)
Packit Service fa4841
{
Packit Service fa4841
	Float32 fVolume;
Packit Service fa4841
	UINT16 volumeLeft;
Packit Service fa4841
	UINT16 volumeRight;
Packit Service fa4841
	rdpsndMacPlugin *mac = (rdpsndMacPlugin *)device;
Packit Service fa4841
Packit Service fa4841
	if (!mac->player)
Packit Service fa4841
		return FALSE;
Packit Service fa4841
Packit Service fa4841
	volumeLeft = (value & 0xFFFF);
Packit Service fa4841
	volumeRight = ((value >> 16) & 0xFFFF);
Packit Service fa4841
	fVolume = ((float)volumeLeft) / 65535.0f;
Packit Service fa4841
Packit Service fa4841
	mac->player.volume = fVolume;
Packit Service fa4841
Packit Service fa4841
	return TRUE;
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
static void rdpsnd_mac_start(rdpsndDevicePlugin *device)
Packit Service fa4841
{
Packit Service fa4841
	rdpsndMacPlugin *mac = (rdpsndMacPlugin *)device;
Packit Service fa4841
Packit Service fa4841
	if (!mac->isPlaying)
Packit Service fa4841
	{
Packit Service fa4841
		[mac->player play];
Packit Service fa4841
Packit Service fa4841
		mac->isPlaying = TRUE;
Packit Service fa4841
		mac->diff = 100; /* Initial latency, corrected after first sample is played. */
Packit Service fa4841
	}
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
static UINT rdpsnd_mac_play(rdpsndDevicePlugin *device, const BYTE *data, size_t size)
Packit Service fa4841
{
Packit Service fa4841
	rdpsndMacPlugin *mac = (rdpsndMacPlugin *)device;
Packit Service fa4841
	AVAudioPCMBuffer *buffer;
Packit Service fa4841
	AVAudioFormat *format;
Packit Service fa4841
	float *const *db;
Packit Service fa4841
	size_t pos, step, x;
Packit Service fa4841
	AVAudioFrameCount count;
Packit Service fa4841
	UINT64 start = GetTickCount64();
Packit Service fa4841
Packit Service fa4841
	if (!mac->isOpen)
Packit Service fa4841
		return 0;
Packit Service fa4841
Packit Service fa4841
	step = 2 * mac->format.nChannels;
Packit Service fa4841
Packit Service fa4841
	count = size / step;
Packit Service fa4841
	format = [[AVAudioFormat alloc] initWithCommonFormat:AVAudioPCMFormatFloat32
Packit Service fa4841
	                                          sampleRate:mac->format.nSamplesPerSec
Packit Service fa4841
	                                            channels:mac->format.nChannels
Packit Service fa4841
	                                         interleaved:NO];
Packit Service fa4841
	if (!format)
Packit Service fa4841
	{
Packit Service fa4841
		WLog_WARN(TAG, "AVAudioFormat::init() failed");
Packit Service fa4841
		return 0;
Packit Service fa4841
	}
Packit Service fa4841
	buffer = [[AVAudioPCMBuffer alloc] initWithPCMFormat:format frameCapacity:count];
Packit Service fa4841
	if (!buffer)
Packit Service fa4841
	{
Packit Service fa4841
		[format release];
Packit Service fa4841
		WLog_WARN(TAG, "AVAudioPCMBuffer::init() failed");
Packit Service fa4841
		return 0;
Packit Service fa4841
	}
Packit Service fa4841
Packit Service fa4841
	buffer.frameLength = buffer.frameCapacity;
Packit Service fa4841
	db = buffer.floatChannelData;
Packit Service fa4841
Packit Service fa4841
	for (pos = 0; pos < count; pos++)
Packit Service fa4841
	{
Packit Service fa4841
		const BYTE *d = &data[pos * step];
Packit Service fa4841
		for (x = 0; x < mac->format.nChannels; x++)
Packit Service fa4841
		{
Packit Service fa4841
			const float val = (int16_t)((uint16_t)d[0] | ((uint16_t)d[1] << 8)) / 32768.0f;
Packit Service fa4841
			db[x][pos] = val;
Packit Service fa4841
			d += sizeof(int16_t);
Packit Service fa4841
		}
Packit Service fa4841
	}
Packit Service fa4841
Packit Service fa4841
	rdpsnd_mac_start(device);
Packit Service fa4841
Packit Service fa4841
	[mac->player scheduleBuffer:buffer
Packit Service fa4841
	          completionHandler:^{
Packit Service fa4841
		          UINT64 stop = GetTickCount64();
Packit Service fa4841
		          if (start > stop)
Packit Service fa4841
			          mac->diff = 0;
Packit Service fa4841
		          else
Packit Service fa4841
			          mac->diff = stop - start;
Packit Service fa4841
	          }];
Packit Service fa4841
Packit Service fa4841
	return mac->diff > UINT_MAX ? UINT_MAX : mac->diff;
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
#ifdef BUILTIN_CHANNELS
Packit Service fa4841
#define freerdp_rdpsnd_client_subsystem_entry mac_freerdp_rdpsnd_client_subsystem_entry
Packit Service fa4841
#else
Packit Service fa4841
#define freerdp_rdpsnd_client_subsystem_entry FREERDP_API freerdp_rdpsnd_client_subsystem_entry
Packit Service fa4841
#endif
Packit Service fa4841
Packit Service fa4841
/**
Packit Service fa4841
 * Function description
Packit Service fa4841
 *
Packit Service fa4841
 * @return 0 on success, otherwise a Win32 error code
Packit Service fa4841
 */
Packit Service fa4841
UINT freerdp_rdpsnd_client_subsystem_entry(PFREERDP_RDPSND_DEVICE_ENTRY_POINTS pEntryPoints)
Packit Service fa4841
{
Packit Service fa4841
	rdpsndMacPlugin *mac;
Packit Service fa4841
	mac = (rdpsndMacPlugin *)calloc(1, sizeof(rdpsndMacPlugin));
Packit Service fa4841
Packit Service fa4841
	if (!mac)
Packit Service fa4841
		return CHANNEL_RC_NO_MEMORY;
Packit Service fa4841
Packit Service fa4841
	mac->device.Open = rdpsnd_mac_open;
Packit Service fa4841
	mac->device.FormatSupported = rdpsnd_mac_format_supported;
Packit Service fa4841
	mac->device.SetVolume = rdpsnd_mac_set_volume;
Packit Service fa4841
	mac->device.Play = rdpsnd_mac_play;
Packit Service fa4841
	mac->device.Close = rdpsnd_mac_close;
Packit Service fa4841
	mac->device.Free = rdpsnd_mac_free;
Packit Service fa4841
	pEntryPoints->pRegisterRdpsndDevice(pEntryPoints->rdpsnd, (rdpsndDevicePlugin *)mac);
Packit Service fa4841
	return CHANNEL_RC_OK;
Packit Service fa4841
}