summaryrefslogtreecommitdiffstats
path: root/include/freerdp/server/rdpecam.h
blob: dd18494784fdee129168f0d554ddcd980df9dea7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
/**
 * FreeRDP: A Remote Desktop Protocol Implementation
 * Video Capture Virtual Channel Extension
 *
 * Copyright 2022 Pascal Nowack <Pascal.Nowack@gmx.de>
 *
 * 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_CAMERA_DEVICE_SERVER_CAMERA_DEVICE_H
#define FREERDP_CHANNEL_CAMERA_DEVICE_SERVER_CAMERA_DEVICE_H

#include <freerdp/channels/rdpecam.h>
#include <freerdp/channels/wtsvc.h>

#ifdef __cplusplus
extern "C"
{
#endif

	typedef struct camera_device_server_context CameraDeviceServerContext;

	typedef UINT (*psCameraDeviceServerOpen)(CameraDeviceServerContext* context);
	typedef UINT (*psCameraDeviceServerClose)(CameraDeviceServerContext* context);

	typedef BOOL (*psCameraDeviceServerChannelIdAssigned)(CameraDeviceServerContext* context,
	                                                      UINT32 channelId);

	typedef UINT (*psCameraDeviceServerInitialize)(CameraDeviceServerContext* context,
	                                               BOOL externalThread);
	typedef UINT (*psCameraDeviceServerPoll)(CameraDeviceServerContext* context);
	typedef BOOL (*psCameraDeviceServerChannelHandle)(CameraDeviceServerContext* context,
	                                                  HANDLE* handle);

	typedef UINT (*psCameraDeviceServerSuccessResponse)(
	    CameraDeviceServerContext* context, const CAM_SUCCESS_RESPONSE* successResponse);
	typedef UINT (*psCameraDeviceServerErrorResponse)(CameraDeviceServerContext* context,
	                                                  const CAM_ERROR_RESPONSE* errorResponse);

	typedef UINT (*psCameraDeviceServerActivateDeviceRequest)(
	    CameraDeviceServerContext* context,
	    const CAM_ACTIVATE_DEVICE_REQUEST* activateDeviceRequest);
	typedef UINT (*psCameraDeviceServerDeactivateDeviceRequest)(
	    CameraDeviceServerContext* context,
	    const CAM_DEACTIVATE_DEVICE_REQUEST* deactivateDeviceRequest);

	typedef UINT (*psCameraDeviceServerStreamListRequest)(
	    CameraDeviceServerContext* context, const CAM_STREAM_LIST_REQUEST* streamListRequest);
	typedef UINT (*psCameraDeviceServerStreamListResponse)(
	    CameraDeviceServerContext* context, const CAM_STREAM_LIST_RESPONSE* streamListResponse);

	typedef UINT (*psCameraDeviceServerMediaTypeListRequest)(
	    CameraDeviceServerContext* context,
	    const CAM_MEDIA_TYPE_LIST_REQUEST* mediaTypeListRequest);
	typedef UINT (*psCameraDeviceServerMediaTypeListResponse)(
	    CameraDeviceServerContext* context,
	    const CAM_MEDIA_TYPE_LIST_RESPONSE* mediaTypeListResponse);

	typedef UINT (*psCameraDeviceServerCurrentMediaTypeRequest)(
	    CameraDeviceServerContext* context,
	    const CAM_CURRENT_MEDIA_TYPE_REQUEST* currentMediaTypeRequest);
	typedef UINT (*psCameraDeviceServerCurrentMediaTypeResponse)(
	    CameraDeviceServerContext* context,
	    const CAM_CURRENT_MEDIA_TYPE_RESPONSE* currentMediaTypeResponse);

	typedef UINT (*psCameraDeviceServerStartStreamsRequest)(
	    CameraDeviceServerContext* context, const CAM_START_STREAMS_REQUEST* startStreamsRequest);
	typedef UINT (*psCameraDeviceServerStopStreamsRequest)(
	    CameraDeviceServerContext* context, const CAM_STOP_STREAMS_REQUEST* stopStreamsRequest);

	typedef UINT (*psCameraDeviceServerSampleRequest)(CameraDeviceServerContext* context,
	                                                  const CAM_SAMPLE_REQUEST* sampleRequest);
	typedef UINT (*psCameraDeviceServerSampleResponse)(CameraDeviceServerContext* context,
	                                                   const CAM_SAMPLE_RESPONSE* sampleResponse);
	typedef UINT (*psCameraDeviceServerSampleErrorResponse)(
	    CameraDeviceServerContext* context, const CAM_SAMPLE_ERROR_RESPONSE* sampleErrorResponse);

	typedef UINT (*psCameraDeviceServerPropertyListRequest)(
	    CameraDeviceServerContext* context, const CAM_PROPERTY_LIST_REQUEST* propertyListRequest);
	typedef UINT (*psCameraDeviceServerPropertyListResponse)(
	    CameraDeviceServerContext* context, const CAM_PROPERTY_LIST_RESPONSE* propertyListResponse);

	typedef UINT (*psCameraDeviceServerPropertyValueRequest)(
	    CameraDeviceServerContext* context, const CAM_PROPERTY_VALUE_REQUEST* propertyValueRequest);
	typedef UINT (*psCameraDeviceServerPropertyValueResponse)(
	    CameraDeviceServerContext* context,
	    const CAM_PROPERTY_VALUE_RESPONSE* propertyValueResponse);

	typedef UINT (*psCameraDeviceServerSetPropertyValueRequest)(
	    CameraDeviceServerContext* context,
	    const CAM_SET_PROPERTY_VALUE_REQUEST* setPropertyValueRequest);

	struct camera_device_server_context
	{
		HANDLE vcm;

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

		/**
		 * Name of the virtual channel. Pointer owned by the CameraDeviceServerContext,
		 * meaning camera_device_server_context_free() takes care of freeing the pointer.
		 *
		 * Server implementations should sanitize the virtual channel name for invalid
		 * names, like names for other known channels
		 * ("ECHO", "AUDIO_PLAYBACK_DVC", etc.)
		 */
		char* virtualChannelName;

		/**
		 * Protocol version to be used. Every sent server to client PDU has the
		 * version value in the Header set to the following value.
		 */
		BYTE protocolVersion;

		/*** APIs called by the server. ***/

		/**
		 * Optional: Set thread handling.
		 * When externalThread=TRUE, the application is responsible to call
		 * Poll() periodically to process channel events.
		 *
		 * Defaults to externalThread=FALSE
		 */
		psCameraDeviceServerInitialize Initialize;

		/**
		 * Open the camera device channel.
		 */
		psCameraDeviceServerOpen Open;

		/**
		 * Close the camera device channel.
		 */
		psCameraDeviceServerClose Close;

		/**
		 * Poll
		 * When externalThread=TRUE, call Poll() periodically from your main loop.
		 * If externalThread=FALSE do not call.
		 */
		psCameraDeviceServerPoll Poll;

		/**
		 * Retrieve the channel handle for use in conjunction with Poll().
		 * If externalThread=FALSE do not call.
		 */
		psCameraDeviceServerChannelHandle ChannelHandle;

		/**
		 * For the following server to client PDUs,
		 * the message header does not have to be set.
		 */

		/**
		 * Send a Activate Device Request PDU.
		 */
		psCameraDeviceServerActivateDeviceRequest ActivateDeviceRequest;

		/**
		 * Send a Deactivate Device Request PDU.
		 */
		psCameraDeviceServerDeactivateDeviceRequest DeactivateDeviceRequest;

		/**
		 * Send a Stream List Request PDU.
		 */
		psCameraDeviceServerStreamListRequest StreamListRequest;

		/**
		 * Send a Media Type List Request PDU.
		 */
		psCameraDeviceServerMediaTypeListRequest MediaTypeListRequest;

		/**
		 * Send a Current Media Type Request PDU.
		 */
		psCameraDeviceServerCurrentMediaTypeRequest CurrentMediaTypeRequest;

		/**
		 * Send a Start Streams Request PDU.
		 */
		psCameraDeviceServerStartStreamsRequest StartStreamsRequest;

		/**
		 * Send a Stop Streams Request PDU.
		 */
		psCameraDeviceServerStopStreamsRequest StopStreamsRequest;

		/**
		 * Send a Sample Request PDU.
		 */
		psCameraDeviceServerSampleRequest SampleRequest;

		/**
		 * Send a Property List Request PDU.
		 */
		psCameraDeviceServerPropertyListRequest PropertyListRequest;

		/**
		 * Send a Property Value Request PDU.
		 */
		psCameraDeviceServerPropertyValueRequest PropertyValueRequest;

		/**
		 * Send a Set Property Value Request PDU.
		 */
		psCameraDeviceServerSetPropertyValueRequest SetPropertyValueRequest;

		/*** Callbacks registered by the server. ***/

		/**
		 * Callback, when the channel got its id assigned.
		 */
		psCameraDeviceServerChannelIdAssigned ChannelIdAssigned;

		/**
		 * Callback for the Success Response PDU.
		 */
		psCameraDeviceServerSuccessResponse SuccessResponse;

		/**
		 * Callback for the Error Response PDU.
		 */
		psCameraDeviceServerErrorResponse ErrorResponse;

		/**
		 * Callback for the Stream List Response PDU.
		 */
		psCameraDeviceServerStreamListResponse StreamListResponse;

		/**
		 * Callback for the Media Type List Response PDU.
		 */
		psCameraDeviceServerMediaTypeListResponse MediaTypeListResponse;

		/**
		 * Callback for the Current Media Type Response PDU.
		 */
		psCameraDeviceServerCurrentMediaTypeResponse CurrentMediaTypeResponse;

		/**
		 * Callback for the Sample Response PDU.
		 */
		psCameraDeviceServerSampleResponse SampleResponse;

		/**
		 * Callback for the Sample Error Response PDU.
		 */
		psCameraDeviceServerSampleErrorResponse SampleErrorResponse;

		/**
		 * Callback for the Property List Response PDU.
		 */
		psCameraDeviceServerPropertyListResponse PropertyListResponse;

		/**
		 * Callback for the Property Value Response PDU.
		 */
		psCameraDeviceServerPropertyValueResponse PropertyValueResponse;

		rdpContext* rdpcontext;
	};

	FREERDP_API void camera_device_server_context_free(CameraDeviceServerContext* context);

	WINPR_ATTR_MALLOC(camera_device_server_context_free, 1)
	FREERDP_API CameraDeviceServerContext* camera_device_server_context_new(HANDLE vcm);

#ifdef __cplusplus
}
#endif

#endif /* FREERDP_CHANNEL_CAMERA_DEVICE_SERVER_CAMERA_DEVICE_H */