/** * FreeRDP: A Remote Desktop Protocol Implementation * Audio Input Redirection Virtual Channel * * Copyright 2010-2011 Vic Lee * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #include #include #include #include #include #include #include #include #include "audin_main.h" #define MSG_SNDIN_VERSION 0x01 #define MSG_SNDIN_FORMATS 0x02 #define MSG_SNDIN_OPEN 0x03 #define MSG_SNDIN_OPEN_REPLY 0x04 #define MSG_SNDIN_DATA_INCOMING 0x05 #define MSG_SNDIN_DATA 0x06 #define MSG_SNDIN_FORMATCHANGE 0x07 typedef struct _AUDIN_LISTENER_CALLBACK AUDIN_LISTENER_CALLBACK; struct _AUDIN_LISTENER_CALLBACK { IWTSListenerCallback iface; IWTSPlugin* plugin; IWTSVirtualChannelManager* channel_mgr; }; typedef struct _AUDIN_CHANNEL_CALLBACK AUDIN_CHANNEL_CALLBACK; struct _AUDIN_CHANNEL_CALLBACK { IWTSVirtualChannelCallback iface; IWTSPlugin* plugin; IWTSVirtualChannelManager* channel_mgr; IWTSVirtualChannel* channel; /** * The supported format list sent back to the server, which needs to * be stored as reference when the server sends the format index in * Open PDU and Format Change PDU */ audinFormat* formats; int formats_count; }; typedef struct _AUDIN_PLUGIN AUDIN_PLUGIN; struct _AUDIN_PLUGIN { IWTSPlugin iface; AUDIN_LISTENER_CALLBACK* listener_callback; /* Parsed plugin data */ UINT16 fixed_format; UINT16 fixed_channel; UINT32 fixed_rate; char* subsystem; char* device_name; /* Device interface */ IAudinDevice* device; }; static int audin_process_version(IWTSVirtualChannelCallback* pChannelCallback, wStream* s) { int error; wStream* out; UINT32 Version; AUDIN_CHANNEL_CALLBACK* callback = (AUDIN_CHANNEL_CALLBACK*) pChannelCallback; Stream_Read_UINT32(s, Version); DEBUG_DVC("Version=%d", Version); out = Stream_New(NULL, 5); Stream_Write_UINT8(out, MSG_SNDIN_VERSION); Stream_Write_UINT32(out, Version); error = callback->channel->Write(callback->channel, (UINT32) Stream_GetPosition(s), Stream_Buffer(s), NULL); Stream_Free(out, TRUE); return error; } static int audin_send_incoming_data_pdu(IWTSVirtualChannelCallback* pChannelCallback) { BYTE out_data[1]; AUDIN_CHANNEL_CALLBACK* callback = (AUDIN_CHANNEL_CALLBACK*) pChannelCallback; out_data[0] = MSG_SNDIN_DATA_INCOMING; return callback->channel->Write(callback->channel, 1, out_data, NULL); } static int audin_process_formats(IWTSVirtualChannelCallback* pChannelCallback, wStream* s) { AUDIN_CHANNEL_CALLBACK* callback = (AUDIN_CHANNEL_CALLBACK*) pChannelCallback; AUDIN_PLUGIN* audin = (AUDIN_PLUGIN*) callback->plugin; UINT32 i; BYTE* fm; int error; wStream* out; UINT32 NumFormats; audinFormat format; UINT32 cbSizeFormatsPacket; Stream_Read_UINT32(s, NumFormats); DEBUG_DVC("NumFormats %d", NumFormats); if ((NumFormats < 1) || (NumFormats > 1000)) { DEBUG_WARN("bad NumFormats %d", NumFormats); return 1; } Stream_Seek_UINT32(s); /* cbSizeFormatsPacket */ callback->formats = (audinFormat*) malloc(NumFormats * sizeof(audinFormat)); ZeroMemory(callback->formats, NumFormats * sizeof(audinFormat)); out = Stream_New(NULL, 9); Stream_Seek(out, 9); /* SoundFormats (variable) */ for (i = 0; i < NumFormats; i++) { Stream_GetPointer(s, fm); Stream_Read_UINT16(s, format.wFormatTag); Stream_Read_UINT16(s, format.nChannels); Stream_Read_UINT32(s, format.nSamplesPerSec); Stream_Seek_UINT32(s); /* nAvgBytesPerSec */ Stream_Read_UINT16(s, format.nBlockAlign); Stream_Read_UINT16(s, format.wBitsPerSample); Stream_Read_UINT16(s, format.cbSize); format.data = Stream_Pointer(s); Stream_Seek(s, format.cbSize); DEBUG_DVC("wFormatTag=%d nChannels=%d nSamplesPerSec=%d " "nBlockAlign=%d wBitsPerSample=%d cbSize=%d", format.wFormatTag, format.nChannels, format.nSamplesPerSec, format.nBlockAlign, format.wBitsPerSample, format.cbSize); if (audin->fixed_format > 0 && audin->fixed_format != format.wFormatTag) continue; if (audin->fixed_channel > 0 && audin->fixed_channel != format.nChannels) continue; if (audin->fixed_rate > 0 && audin->fixed_rate != format.nSamplesPerSec) continue; if (audin->device && audin->device->FormatSupported(audin->device, &format)) { DEBUG_DVC("format ok"); /* Store the agreed format in the corresponding index */ callback->formats[callback->formats_count++] = format; /* Put the format to output buffer */ Stream_EnsureRemainingCapacity(out, 18 + format.cbSize); Stream_Write(out, fm, 18 + format.cbSize); } } audin_send_incoming_data_pdu(pChannelCallback); cbSizeFormatsPacket = (UINT32) Stream_GetPosition(out); Stream_SetPosition(out, 0); Stream_Write_UINT8(out, MSG_SNDIN_FORMATS); /* Header (1 byte) */ Stream_Write_UINT32(out, callback->formats_count); /* NumFormats (4 bytes) */ Stream_Write_UINT32(out, cbSizeFormatsPacket); /* cbSizeFormatsPacket (4 bytes) */ error = callback->channel->Write(callback->channel, cbSizeFormatsPacket, Stream_Buffer(out), NULL); Stream_Free(out, TRUE); return error; } static int audin_send_format_change_pdu(IWTSVirtualChannelCallback* pChannelCallback, UINT32 NewFormat) { int error; wStream* out; AUDIN_CHANNEL_CALLBACK* callback = (AUDIN_CHANNEL_CALLBACK*) pChannelCallback; out = Stream_New(NULL, 5); Stream_Write_UINT8(out, MSG_SNDIN_FORMATCHANGE); Stream_Write_UINT32(out, NewFormat); error = callback->channel->Write(callback->channel, 5, Stream_Buffer(out), NULL); Stream_Free(out, TRUE); return error; } static int audin_send_open_reply_pdu(IWTSVirtualChannelCallback* pChannelCallback, UINT32 Result) { int error; wStream* out; AUDIN_CHANNEL_CALLBACK* callback = (AUDIN_CHANNEL_CALLBACK*) pChannelCallback; out = Stream_New(NULL, 5); Stream_Write_UINT8(out, MSG_SNDIN_OPEN_REPLY); Stream_Write_UINT32(out, Result); error = callback->channel->Write(callback->channel, 5, Stream_Buffer(out), NULL); Stream_Free(out, TRUE); return error; } static BOOL audin_receive_wave_data(BYTE* data, int size, void* user_data) { int error; wStream* out; AUDIN_CHANNEL_CALLBACK* callback = (AUDIN_CHANNEL_CALLBACK*) user_data; error = audin_send_incoming_data_pdu((IWTSVirtualChannelCallback*) callback); if (error != 0) return FALSE; out = Stream_New(NULL, size + 1); Stream_Write_UINT8(out, MSG_SNDIN_DATA); Stream_Write(out, data, size); error = callback->channel->Write(callback->channel, (UINT32) Stream_GetPosition(out), Stream_Buffer(out), NULL); Stream_Free(out, TRUE); return (error == 0 ? TRUE : FALSE); } static int audin_process_open(IWTSVirtualChannelCallback* pChannelCallback, wStream* s) { AUDIN_CHANNEL_CALLBACK* callback = (AUDIN_CHANNEL_CALLBACK*) pChannelCallback; AUDIN_PLUGIN* audin = (AUDIN_PLUGIN*) callback->plugin; audinFormat* format; UINT32 initialFormat; UINT32 FramesPerPacket; Stream_Read_UINT32(s, FramesPerPacket); Stream_Read_UINT32(s, initialFormat); DEBUG_DVC("FramesPerPacket=%d initialFormat=%d", FramesPerPacket, initialFormat); if (initialFormat >= (UINT32) callback->formats_count) { DEBUG_WARN("invalid format index %d (total %d)", initialFormat, callback->formats_count); return 1; } format = &callback->formats[initialFormat]; if (audin->device) { IFCALL(audin->device->SetFormat, audin->device, format, FramesPerPacket); IFCALL(audin->device->Open, audin->device, audin_receive_wave_data, callback); } audin_send_format_change_pdu(pChannelCallback, initialFormat); audin_send_open_reply_pdu(pChannelCallback, 0); return 0; } static int audin_process_format_change(IWTSVirtualChannelCallback* pChannelCallback, wStream* s) { AUDIN_CHANNEL_CALLBACK* callback = (AUDIN_CHANNEL_CALLBACK*) pChannelCallback; AUDIN_PLUGIN * audin = (AUDIN_PLUGIN*) callback->plugin; UINT32 NewFormat; audinFormat* format; Stream_Read_UINT32(s, NewFormat); DEBUG_DVC("NewFormat=%d", NewFormat); if (NewFormat >= (UINT32) callback->formats_count) { DEBUG_WARN("invalid format index %d (total %d)", NewFormat, callback->formats_count); return 1; } format = &callback->formats[NewFormat]; if (audin->device) { IFCALL(audin->device->Close, audin->device); IFCALL(audin->device->SetFormat, audin->device, format, 0); IFCALL(audin->device->Open, audin->device, audin_receive_wave_data, callback); } audin_send_format_change_pdu(pChannelCallback, NewFormat); return 0; } static int audin_on_data_received(IWTSVirtualChannelCallback* pChannelCallback, UINT32 cbSize, BYTE* pBuffer) { int error; wStream* s; BYTE MessageId; s = Stream_New(pBuffer, cbSize); Stream_Read_UINT8(s, MessageId); DEBUG_DVC("MessageId=0x%x", MessageId); switch (MessageId) { case MSG_SNDIN_VERSION: error = audin_process_version(pChannelCallback, s); break; case MSG_SNDIN_FORMATS: error = audin_process_formats(pChannelCallback, s); break; case MSG_SNDIN_OPEN: error = audin_process_open(pChannelCallback, s); break; case MSG_SNDIN_FORMATCHANGE: error = audin_process_format_change(pChannelCallback, s); break; default: DEBUG_WARN("unknown MessageId=0x%x", MessageId); error = 1; break; } Stream_Free(s, FALSE); return error; } static int audin_on_close(IWTSVirtualChannelCallback* pChannelCallback) { AUDIN_CHANNEL_CALLBACK* callback = (AUDIN_CHANNEL_CALLBACK*) pChannelCallback; AUDIN_PLUGIN* audin = (AUDIN_PLUGIN*) callback->plugin; DEBUG_DVC(""); if (audin->device) IFCALL(audin->device->Close, audin->device); free(callback->formats); free(callback); return 0; } static int audin_on_new_channel_connection(IWTSListenerCallback* pListenerCallback, IWTSVirtualChannel* pChannel, BYTE* Data, int* pbAccept, IWTSVirtualChannelCallback** ppCallback) { AUDIN_CHANNEL_CALLBACK* callback; AUDIN_LISTENER_CALLBACK* listener_callback = (AUDIN_LISTENER_CALLBACK*) pListenerCallback; DEBUG_DVC(""); callback = (AUDIN_CHANNEL_CALLBACK*) malloc(sizeof(AUDIN_CHANNEL_CALLBACK)); ZeroMemory(callback, sizeof(AUDIN_CHANNEL_CALLBACK)); callback->iface.OnDataReceived = audin_on_data_received; callback->iface.OnClose = audin_on_close; callback->plugin = listener_callback->plugin; callback->channel_mgr = listener_callback->channel_mgr; callback->channel = pChannel; *ppCallback = (IWTSVirtualChannelCallback*) callback; return 0; } static int audin_plugin_initialize(IWTSPlugin* pPlugin, IWTSVirtualChannelManager* pChannelMgr) { AUDIN_PLUGIN* audin = (AUDIN_PLUGIN*) pPlugin; DEBUG_DVC(""); audin->listener_callback = (AUDIN_LISTENER_CALLBACK*) malloc(sizeof(AUDIN_LISTENER_CALLBACK)); ZeroMemory(audin->listener_callback, sizeof(AUDIN_LISTENER_CALLBACK)); audin->listener_callback->iface.OnNewChannelConnection = audin_on_new_channel_connection; audin->listener_callback->plugin = pPlugin; audin->listener_callback->channel_mgr = pChannelMgr; return pChannelMgr->CreateListener(pChannelMgr, "AUDIO_INPUT", 0, (IWTSListenerCallback*) audin->listener_callback, NULL); } static int audin_plugin_terminated(IWTSPlugin* pPlugin) { AUDIN_PLUGIN* audin = (AUDIN_PLUGIN*) pPlugin; DEBUG_DVC(""); if (audin->device) { IFCALL(audin->device->Close, audin->device); IFCALL(audin->device->Free, audin->device); audin->device = NULL; } free(audin->listener_callback); free(audin); return 0; } static void audin_register_device_plugin(IWTSPlugin* pPlugin, IAudinDevice* device) { AUDIN_PLUGIN* audin = (AUDIN_PLUGIN*) pPlugin; if (audin->device) { DEBUG_WARN("existing device, abort."); return; } DEBUG_DVC("device registered."); audin->device = device; } static BOOL audin_load_device_plugin(IWTSPlugin* pPlugin, const char* name, ADDIN_ARGV* args) { PFREERDP_AUDIN_DEVICE_ENTRY entry; FREERDP_AUDIN_DEVICE_ENTRY_POINTS entryPoints; entry = (PFREERDP_AUDIN_DEVICE_ENTRY) freerdp_load_channel_addin_entry("audin", (LPSTR) name, NULL, 0); if (entry == NULL) return FALSE; entryPoints.plugin = pPlugin; entryPoints.pRegisterAudinDevice = audin_register_device_plugin; entryPoints.args = args; if (entry(&entryPoints) != 0) { DEBUG_WARN("%s entry returns error.", name); return FALSE; } return TRUE; } void audin_set_subsystem(AUDIN_PLUGIN* audin, char* subsystem) { if (audin->subsystem) free(audin->subsystem); audin->subsystem = _strdup(subsystem); } void audin_set_device_name(AUDIN_PLUGIN* audin, char* device_name) { if (audin->device_name) free(audin->device_name); audin->device_name = _strdup(device_name); } COMMAND_LINE_ARGUMENT_A audin_args[] = { { "sys", COMMAND_LINE_VALUE_REQUIRED, "", NULL, NULL, -1, NULL, "subsystem" }, { "dev", COMMAND_LINE_VALUE_REQUIRED, "", NULL, NULL, -1, NULL, "device" }, { "format", COMMAND_LINE_VALUE_REQUIRED, "", NULL, NULL, -1, NULL, "format" }, { "rate", COMMAND_LINE_VALUE_REQUIRED, "", NULL, NULL, -1, NULL, "rate" }, { "channel", COMMAND_LINE_VALUE_REQUIRED, "", NULL, NULL, -1, NULL, "channel" }, { NULL, 0, NULL, NULL, NULL, -1, NULL, NULL } }; static BOOL audin_process_addin_args(IWTSPlugin* pPlugin, ADDIN_ARGV* args) { int status; DWORD flags; COMMAND_LINE_ARGUMENT_A* arg; AUDIN_PLUGIN* audin = (AUDIN_PLUGIN*) pPlugin; flags = COMMAND_LINE_SIGIL_NONE | COMMAND_LINE_SEPARATOR_COLON; status = CommandLineParseArgumentsA(args->argc, (const char**) args->argv, audin_args, flags, audin, NULL, NULL); arg = audin_args; do { if (!(arg->Flags & COMMAND_LINE_VALUE_PRESENT)) continue; CommandLineSwitchStart(arg) CommandLineSwitchCase(arg, "sys") { audin_set_subsystem(audin, arg->Value); } CommandLineSwitchCase(arg, "dev") { audin_set_device_name(audin, arg->Value); } CommandLineSwitchCase(arg, "format") { audin->fixed_format = atoi(arg->Value); } CommandLineSwitchCase(arg, "rate") { audin->fixed_rate = atoi(arg->Value); } CommandLineSwitchCase(arg, "channel") { audin->fixed_channel = atoi(arg->Value); } CommandLineSwitchDefault(arg) { } CommandLineSwitchEnd(arg) } while ((arg = CommandLineFindNextArgumentA(arg)) != NULL); return TRUE; } #ifdef STATIC_CHANNELS #define DVCPluginEntry audin_DVCPluginEntry #endif int DVCPluginEntry(IDRDYNVC_ENTRY_POINTS* pEntryPoints) { int error = 0; ADDIN_ARGV* args; AUDIN_PLUGIN* audin; assert(pEntryPoints); assert(pEntryPoints->GetPlugin); audin = (AUDIN_PLUGIN*) pEntryPoints->GetPlugin(pEntryPoints, "audin"); if (audin == NULL) { audin = (AUDIN_PLUGIN*) malloc(sizeof(AUDIN_PLUGIN)); ZeroMemory(audin, sizeof(AUDIN_PLUGIN)); audin->iface.Initialize = audin_plugin_initialize; audin->iface.Connected = NULL; audin->iface.Disconnected = NULL; audin->iface.Terminated = audin_plugin_terminated; error = pEntryPoints->RegisterPlugin(pEntryPoints, "audin", (IWTSPlugin*) audin); } args = pEntryPoints->GetPluginData(pEntryPoints); if (error == 0) audin_process_addin_args((IWTSPlugin*) audin, args); if (audin->subsystem) audin_load_device_plugin((IWTSPlugin*) audin, audin->subsystem, args); #if defined(WITH_PULSE) if (!audin->device) { audin_set_subsystem(audin, "pulse"); audin_set_device_name(audin, ""); audin_load_device_plugin((IWTSPlugin*) audin, audin->subsystem, args); } #endif #if defined(WITH_ALSA) if (!audin->device) { audin_set_subsystem(audin, "alsa"); audin_set_device_name(audin, "default"); audin_load_device_plugin((IWTSPlugin*) audin, audin->subsystem, args); } #endif #if defined(WITH_OPENSLES) if (!audin->device) { audin_set_subsystem(audin, "opensles"); audin_set_device_name(audin, "default"); audin_load_device_plugin((IWTSPlugin*) audin, audin->subsystem, args); } #endif #if defined(WITH_WINMM) if (!audin->device) { audin_set_subsystem(audin, "winmm"); audin_set_device_name(audin, "default"); audin_load_device_plugin((IWTSPlugin*) audin, audin->subsystem, args); } #endif if (audin->device == NULL) { DEBUG_WARN("no sound device."); } return error; }