FreeRDP/include/freerdp/server/audin.h

/**
 * FreeRDP: A Remote Desktop Protocol Implementation
 * Server Audio Input Virtual Channel
 *
 * Copyright 2012 Vic Lee
 * Copyright 2015 Thincast Technologies GmbH
 * Copyright 2015 DI (FH) Martin Haimberger <martin.haimberger@thincast.com>
 *
 * 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.
 */

#ifndef FREERDP_CHANNEL_AUDIN_SERVER_H
#define FREERDP_CHANNEL_AUDIN_SERVER_H

#include <freerdp/codec/audio.h>
#include <freerdp/channels/wtsvc.h>
#include <freerdp/channels/rdpsnd.h>
#include <winpr/win32error.h>

typedef struct _audin_server_context audin_server_context;

typedef WIN32ERROR (*psAudinServerSelectFormat)(audin_server_context* context, int client_format_index);
typedef BOOL (*psAudinServerOpen)(audin_server_context* context);
typedef BOOL (*psAudinServerClose)(audin_server_context* context);

typedef WIN32ERROR (*psAudinServerOpening)(audin_server_context* context);
typedef WIN32ERROR (*psAudinServerOpenResult)(audin_server_context* context, UINT32 result);
typedef WIN32ERROR (*psAudinServerReceiveSamples)(audin_server_context* context, const void* buf, int nframes);

struct _audin_server_context
{
	HANDLE vcm;

	/* Server self-defined pointer. */
	void* data;

	/* Server supported formats. Set by server. */
	const AUDIO_FORMAT* server_formats;
	int num_server_formats;

	/* Server destination PCM audio format. Set by server. */
	AUDIO_FORMAT dst_format;

	/* Server preferred frames per packet. */
	int frames_per_packet;

	/* Client supported formats. */
	AUDIO_FORMAT* client_formats;
	int num_client_formats;
	int selected_client_format;

	/*** APIs called by the server. ***/
	/**
	 * Choose the audio format to be received. The index argument is an index into
	 * the client_formats array and must be smaller than num_client_formats.
	 */
	psAudinServerSelectFormat SelectFormat;
	/**
	 * Open the audio input stream.
	 */
	psAudinServerOpen Open;
	/**
	 * Close the audio stream.
	 */
	psAudinServerClose Close;

	/*** Callbacks registered by the server. ***/
	/**
	 * It's ready to open the audio input stream. The server should examine client
	 * formats and call SelectFormat to choose the desired one in this callback.
	 */
	psAudinServerOpening Opening;
	/**
	 * Client replied HRESULT of the open operation.
	 */
	psAudinServerOpenResult OpenResult;
	/**
	 * Receive audio samples. Actual bytes in the buffer is:
	 * nframes * dst_format.nBitsPerSample * dst_format.nChannels / 8
	 * Note that this callback is called from a different thread context so the
	 * server must be careful of thread synchronization.
	 */
	psAudinServerReceiveSamples ReceiveSamples;
};

#ifdef __cplusplus
extern "C" {
#endif

FREERDP_API audin_server_context* audin_server_context_new(HANDLE vcm);
FREERDP_API void audin_server_context_free(audin_server_context* context);

#ifdef __cplusplus
}
#endif

#endif /* FREERDP_CHANNEL_AUDIN_SERVER_H */