151 lines
4.3 KiB
C

/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 GUAC_RDPSND_SERVICE_H
#define GUAC_RDPSND_SERVICE_H
#include "config.h"
#include <freerdp/svc.h>
#include <guacamole/client.h>
#include <winpr/stream.h>
#include <winpr/wtsapi.h>
/**
* The maximum number of PCM formats to accept during the initial RDPSND
* handshake with the RDP server.
*/
#define GUAC_RDP_MAX_FORMATS 16
/**
* Abstract representation of a PCM format, including the sample rate, number
* of channels, and bits per sample.
*/
typedef struct guac_pcm_format {
/**
* The sample rate of this PCM format.
*/
int rate;
/**
* The number off channels used by this PCM format. This will typically
* be 1 or 2.
*/
int channels;
/**
* The number of bits per sample within this PCM format. This should be
* either 8 or 16.
*/
int bps;
} guac_pcm_format;
/**
* Structure representing the current state of the Guacamole RDPSND plugin for
* FreeRDP.
*/
typedef struct guac_rdpsnd {
/**
* The Guacamole client associated with the guac_audio_stream that this
* plugin should use to stream received audio packets.
*/
guac_client* client;
/**
* The definition of this virtual channel (RDPSND).
*/
CHANNEL_DEF channel_def;
/**
* Functions and data specific to the FreeRDP side of the virtual channel
* and plugin.
*/
CHANNEL_ENTRY_POINTS_FREERDP_EX entry_points;
/**
* Handle which identifies the client connection, typically referred to
* within the FreeRDP source as pInitHandle. This handle is provided to the
* channel entry point and the channel init event handler. The handle must
* eventually be used within the channel open event handler to obtain a
* handle to the channel itself.
*/
PVOID init_handle;
/**
* Handle which identifies the channel itself, typically referred to within
* the FreeRDP source as OpenHandle. This handle is obtained through a call
* to entry_points.pVirtualChannelOpenEx() in response to receiving a
* CHANNEL_EVENT_CONNECTED event via the init event handler.
*
* Data is received in CHANNEL_EVENT_DATA_RECEIVED events via the open
* event handler, and data is written through calls to
* entry_points.pVirtualChannelWriteEx().
*/
DWORD open_handle;
/**
* The block number of the last SNDC_WAVE (WaveInfo) PDU received.
*/
int waveinfo_block_number;
/**
* Whether the next PDU coming is a SNDWAVE (Wave) PDU. Wave PDUs do not
* have headers, and are indicated by the receipt of a WaveInfo PDU.
*/
int next_pdu_is_wave;
/**
* The wave data received within the last SNDC_WAVE (WaveInfo) PDU.
*/
unsigned char initial_wave_data[4];
/**
* The size, in bytes, of the wave data in the coming Wave PDU, if any.
* This does not include the initial wave data received within the last
* SNDC_WAVE (WaveInfo) PDU, which is always the first four bytes of the
* actual wave data block.
*/
int incoming_wave_size;
/**
* The last received server timestamp.
*/
int server_timestamp;
/**
* All formats agreed upon by server and client during the initial format
* exchange. All of these formats will be PCM, which is the only format
* guaranteed to be supported (based on the official RDP documentation).
*/
guac_pcm_format formats[GUAC_RDP_MAX_FORMATS];
/**
* The total number of formats.
*/
int format_count;
} guac_rdpsnd;
#endif