1 | /** @file
|
---|
2 | * VBox Remote Desktop Extension (VRDE) - Video Input interface.
|
---|
3 | */
|
---|
4 |
|
---|
5 | /*
|
---|
6 | * Copyright (C) 2012-2015 Oracle Corporation
|
---|
7 | *
|
---|
8 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
---|
9 | * available from http://www.virtualbox.org. This file is free software;
|
---|
10 | * you can redistribute it and/or modify it under the terms of the GNU
|
---|
11 | * General Public License (GPL) as published by the Free Software
|
---|
12 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
---|
13 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
---|
14 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
---|
15 | *
|
---|
16 | * The contents of this file may alternatively be used under the terms
|
---|
17 | * of the Common Development and Distribution License Version 1.0
|
---|
18 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
---|
19 | * VirtualBox OSE distribution, in which case the provisions of the
|
---|
20 | * CDDL are applicable instead of those of the GPL.
|
---|
21 | *
|
---|
22 | * You may elect to license modified versions of this file under the
|
---|
23 | * terms and conditions of either the GPL or the CDDL or both.
|
---|
24 | */
|
---|
25 |
|
---|
26 | #ifndef ___VBox_RemoteDesktop_VRDEVideoIn_h
|
---|
27 | #define ___VBox_RemoteDesktop_VRDEVideoIn_h
|
---|
28 |
|
---|
29 |
|
---|
30 | /* Define VRDE_VIDEOIN_WITH_VRDEINTERFACE to include the server VRDE interface parts. */
|
---|
31 |
|
---|
32 | #ifdef VRDE_VIDEOIN_WITH_VRDEINTERFACE
|
---|
33 | #include <VBox/RemoteDesktop/VRDE.h>
|
---|
34 | #endif /* VRDE_VIDEOIN_WITH_VRDEINTERFACE */
|
---|
35 |
|
---|
36 | #ifdef AssertCompileSize
|
---|
37 | #define ASSERTSIZE(type, size) AssertCompileSize(type, size);
|
---|
38 | #else
|
---|
39 | #define ASSERTSIZE(type, size)
|
---|
40 | #endif /* AssertCompileSize */
|
---|
41 |
|
---|
42 |
|
---|
43 | /*
|
---|
44 | * Interface for accessing a video camera device on the client.
|
---|
45 | *
|
---|
46 | * Async callbacks are used for providing feedback, reporting errors, etc.
|
---|
47 | *
|
---|
48 | * Initial version supports: Camera + Processing Unit + Streaming Control.
|
---|
49 | *
|
---|
50 | * There are 2 modes:
|
---|
51 | * 1) The virtual WebCam is already attached to the guest.
|
---|
52 | * 2) The virtual WebCam will be attached when the client has it.
|
---|
53 | *
|
---|
54 | * Initially the mode 1 is supported.
|
---|
55 | *
|
---|
56 | * Mode 1 details:
|
---|
57 | * The WebCam has some fixed functionality, according to the descriptors,
|
---|
58 | * which has been already read by the guest. So some of functions will
|
---|
59 | * not work if the client does not support them.
|
---|
60 | *
|
---|
61 | * Mode 2 details:
|
---|
62 | * Virtual WebCam descriptors are built from the client capabilities.
|
---|
63 | *
|
---|
64 | * Similarly to the smartcard, the server will inform the ConsoleVRDE that there is a WebCam.
|
---|
65 | * ConsoleVRDE creates a VRDEVIDEOIN handle and forwards virtual WebCam requests to it.
|
---|
66 | *
|
---|
67 | * Interface with VBox.
|
---|
68 | *
|
---|
69 | * Virtual WebCam ConsoleVRDE VRDE
|
---|
70 | *
|
---|
71 | * Negotiate <->
|
---|
72 | * <- VideoInDeviceNotify(Attached, DeviceId)
|
---|
73 | * -> GetDeviceDesc
|
---|
74 | * <- DeviceDesc
|
---|
75 | * 2 <- CreateCamera
|
---|
76 | * 2 CameraCreated ->
|
---|
77 | *
|
---|
78 | * CameraRequest -> Request ->
|
---|
79 | * Response <- <- Response <- Response
|
---|
80 | * Frame <- <- Frame <- Frame
|
---|
81 | * <- VideoInDeviceNotify(Detached, DeviceId)
|
---|
82 | *
|
---|
83 | * Unsupported requests fail.
|
---|
84 | * The Device Description received from the client may be used to validate WebCam requests
|
---|
85 | * in the ConsoleVRDE code, for example filter out unsupported requests.
|
---|
86 | *
|
---|
87 | */
|
---|
88 |
|
---|
89 | /* All structures in this file are packed.
|
---|
90 | * Everything is little-endian.
|
---|
91 | */
|
---|
92 | #pragma pack(1)
|
---|
93 |
|
---|
94 | /*
|
---|
95 | * The interface supports generic video input descriptors, capabilities and controls:
|
---|
96 | * * Descriptors
|
---|
97 | * + Interface
|
---|
98 | * - Input, Camera Terminal
|
---|
99 | * - Processing Unit
|
---|
100 | * + Video Streaming
|
---|
101 | * - Input Header
|
---|
102 | * - Payload Format
|
---|
103 | * - Video Frame
|
---|
104 | * - Still Image Frame
|
---|
105 | * * Video Control requests
|
---|
106 | * + Interface
|
---|
107 | * - Power Mode
|
---|
108 | * + Unit and Terminal
|
---|
109 | * camera
|
---|
110 | * - Scanning Mode (interlaced, progressive)
|
---|
111 | * - Auto-Exposure Mode
|
---|
112 | * - Auto-Exposure Priority
|
---|
113 | * - Exposure Time Absolute, Relative
|
---|
114 | * - Focus Absolute, Relative, Auto
|
---|
115 | * - Iris Absolute, Relative
|
---|
116 | * - Zoom Absolute, Relative
|
---|
117 | * - PanTilt Absolute, Relative
|
---|
118 | * - Roll Absolute, Relative
|
---|
119 | * - Privacy
|
---|
120 | * processing
|
---|
121 | * - Backlight Compensation
|
---|
122 | * - Brightness
|
---|
123 | * - Contrast
|
---|
124 | * - Gain
|
---|
125 | * - Power Line Frequency
|
---|
126 | * - Hue Manual, Auto
|
---|
127 | * - Saturation
|
---|
128 | * - Sharpness
|
---|
129 | * - Gamma
|
---|
130 | * - White Balance Temperature Manual, Auto
|
---|
131 | * - White Balance Component Manual, Auto
|
---|
132 | * - Digital Multiplier
|
---|
133 | * - Digital Multiplier Limit
|
---|
134 | * * Video Streaming requests
|
---|
135 | * + Interface
|
---|
136 | * - Synch Delay
|
---|
137 | * - Still Image Trigger
|
---|
138 | * - Generate Key Frame
|
---|
139 | * - Update Frame Segment
|
---|
140 | * - Stream Error Code
|
---|
141 | *
|
---|
142 | *
|
---|
143 | * Notes:
|
---|
144 | * * still capture uses a method similar to method 2, because the still frame will
|
---|
145 | * be send instead of video over the channel.
|
---|
146 | * Also the method 2 can be in principle emulated by both 1 and 3 on the client.
|
---|
147 | * However the client can initiate a still frame transfer, similar to hardware button trigger.
|
---|
148 | * * all control changes are async.
|
---|
149 | * * probe/commit are not used. The server can select a supported format/frame from the list.
|
---|
150 | * * no color matching. sRGB is the default.
|
---|
151 | * * most of constants are the same as in USB Video Class spec, but they are not the same and
|
---|
152 | * should be always converted.
|
---|
153 | */
|
---|
154 |
|
---|
155 | /*
|
---|
156 | * The DEVICEDEC describes the device and provides a list of supported formats:
|
---|
157 | * VRDEVIDEOINDEVICEDESC
|
---|
158 | * VRDEVIDEOINFORMATDESC[0];
|
---|
159 | * VRDEVIDEOINFRAMEDESC[0..N-1]
|
---|
160 | * VRDEVIDEOINFORMATDESC[1];
|
---|
161 | * VRDEVIDEOINFRAMEDESC[0..M-1]
|
---|
162 | * ...
|
---|
163 | */
|
---|
164 |
|
---|
165 | typedef struct VRDEVIDEOINDEVICEDESC
|
---|
166 | {
|
---|
167 | uint16_t u16ObjectiveFocalLengthMin;
|
---|
168 | uint16_t u16ObjectiveFocalLengthMax;
|
---|
169 | uint16_t u16OcularFocalLength;
|
---|
170 | uint16_t u16MaxMultiplier;
|
---|
171 | uint32_t fu32CameraControls; /* VRDE_VIDEOIN_F_CT_CTRL_* */
|
---|
172 | uint32_t fu32ProcessingControls; /* VRDE_VIDEOIN_F_PU_CTRL_* */
|
---|
173 | uint8_t fu8DeviceCaps; /* VRDE_VIDEOIN_F_DEV_CAP_* */
|
---|
174 | uint8_t u8NumFormats; /* Number of following VRDEVIDEOINFORMATDESC structures. */
|
---|
175 | uint16_t cbExt; /* Size of the optional extended description. */
|
---|
176 | /* An extended description may follow. */
|
---|
177 | /* An array of VRDEVIDEOINFORMATDESC follows. */
|
---|
178 | } VRDEVIDEOINDEVICEDESC;
|
---|
179 |
|
---|
180 | /* VRDEVIDEOINDEVICEDESC::fu32CameraControls */
|
---|
181 | #define VRDE_VIDEOIN_F_CT_CTRL_SCANNING_MODE 0x00000001 /* D0: Scanning Mode */
|
---|
182 | #define VRDE_VIDEOIN_F_CT_CTRL_AE_MODE 0x00000002 /* D1: Auto-Exposure Mode */
|
---|
183 | #define VRDE_VIDEOIN_F_CT_CTRL_AE_PRIORITY 0x00000004 /* D2: Auto-Exposure Priority */
|
---|
184 | #define VRDE_VIDEOIN_F_CT_CTRL_EXPOSURE_TIME_ABSOLUTE 0x00000008 /* D3: Exposure Time (Absolute) */
|
---|
185 | #define VRDE_VIDEOIN_F_CT_CTRL_EXPOSURE_TIME_RELATIVE 0x00000010 /* D4: Exposure Time (Relative) */
|
---|
186 | #define VRDE_VIDEOIN_F_CT_CTRL_FOCUS_ABSOLUTE 0x00000020 /* D5: Focus (Absolute) */
|
---|
187 | #define VRDE_VIDEOIN_F_CT_CTRL_FOCUS_RELATIVE 0x00000040 /* D6: Focus (Relative) */
|
---|
188 | #define VRDE_VIDEOIN_F_CT_CTRL_IRIS_ABSOLUTE 0x00000080 /* D7: Iris (Absolute) */
|
---|
189 | #define VRDE_VIDEOIN_F_CT_CTRL_IRIS_RELATIVE 0x00000100 /* D8: Iris (Relative) */
|
---|
190 | #define VRDE_VIDEOIN_F_CT_CTRL_ZOOM_ABSOLUTE 0x00000200 /* D9: Zoom (Absolute) */
|
---|
191 | #define VRDE_VIDEOIN_F_CT_CTRL_ZOOM_RELATIVE 0x00000400 /* D10: Zoom (Relative) */
|
---|
192 | #define VRDE_VIDEOIN_F_CT_CTRL_PANTILT_ABSOLUTE 0x00000800 /* D11: PanTilt (Absolute) */
|
---|
193 | #define VRDE_VIDEOIN_F_CT_CTRL_PANTILT_RELATIVE 0x00001000 /* D12: PanTilt (Relative) */
|
---|
194 | #define VRDE_VIDEOIN_F_CT_CTRL_ROLL_ABSOLUTE 0x00002000 /* D13: Roll (Absolute) */
|
---|
195 | #define VRDE_VIDEOIN_F_CT_CTRL_ROLL_RELATIVE 0x00004000 /* D14: Roll (Relative) */
|
---|
196 | #define VRDE_VIDEOIN_F_CT_CTRL_RESERVED1 0x00008000 /* D15: Reserved */
|
---|
197 | #define VRDE_VIDEOIN_F_CT_CTRL_RESERVED2 0x00010000 /* D16: Reserved */
|
---|
198 | #define VRDE_VIDEOIN_F_CT_CTRL_FOCUS_AUTO 0x00020000 /* D17: Focus, Auto */
|
---|
199 | #define VRDE_VIDEOIN_F_CT_CTRL_PRIVACY 0x00040000 /* D18: Privacy */
|
---|
200 |
|
---|
201 | /* VRDEVIDEOINDEVICEDESC::fu32ProcessingControls */
|
---|
202 | #define VRDE_VIDEOIN_F_PU_CTRL_BRIGHTNESS 0x00000001 /* D0: Brightness */
|
---|
203 | #define VRDE_VIDEOIN_F_PU_CTRL_CONTRAST 0x00000002 /* D1: Contrast */
|
---|
204 | #define VRDE_VIDEOIN_F_PU_CTRL_HUE 0x00000004 /* D2: Hue */
|
---|
205 | #define VRDE_VIDEOIN_F_PU_CTRL_SATURATION 0x00000008 /* D3: Saturation */
|
---|
206 | #define VRDE_VIDEOIN_F_PU_CTRL_SHARPNESS 0x00000010 /* D4: Sharpness */
|
---|
207 | #define VRDE_VIDEOIN_F_PU_CTRL_GAMMA 0x00000020 /* D5: Gamma */
|
---|
208 | #define VRDE_VIDEOIN_F_PU_CTRL_WHITE_BALANCE_TEMPERATURE 0x00000040 /* D6: White Balance Temperature */
|
---|
209 | #define VRDE_VIDEOIN_F_PU_CTRL_WHITE_BALANCE_COMPONENT 0x00000080 /* D7: White Balance Component */
|
---|
210 | #define VRDE_VIDEOIN_F_PU_CTRL_BACKLIGHT_COMPENSATION 0x00000100 /* D8: Backlight Compensation */
|
---|
211 | #define VRDE_VIDEOIN_F_PU_CTRL_GAIN 0x00000200 /* D9: Gain */
|
---|
212 | #define VRDE_VIDEOIN_F_PU_CTRL_POWER_LINE_FREQUENCY 0x00000400 /* D10: Power Line Frequency */
|
---|
213 | #define VRDE_VIDEOIN_F_PU_CTRL_HUE_AUTO 0x00000800 /* D11: Hue, Auto */
|
---|
214 | #define VRDE_VIDEOIN_F_PU_CTRL_WHITE_BALANCE_TEMPERATURE_AUTO 0x00001000 /* D12: White Balance Temperature, Auto */
|
---|
215 | #define VRDE_VIDEOIN_F_PU_CTRL_WHITE_BALANCE_COMPONENT_AUTO 0x00002000 /* D13: White Balance Component, Auto */
|
---|
216 | #define VRDE_VIDEOIN_F_PU_CTRL_DIGITAL_MULTIPLIER 0x00004000 /* D14: Digital Multiplier */
|
---|
217 | #define VRDE_VIDEOIN_F_PU_CTRL_DIGITAL_MULTIPLIER_LIMIT 0x00008000 /* D15: Digital Multiplier Limit */
|
---|
218 |
|
---|
219 | /* VRDEVIDEOINDEVICEDESC::fu8DeviceCaps */
|
---|
220 | #define VRDE_VIDEOIN_F_DEV_CAP_DYNAMICCHANGE 0x01 /* Whether dynamic format change is supported. */
|
---|
221 | #define VRDE_VIDEOIN_F_DEV_CAP_TRIGGER 0x02 /* Whether hardware triggering is supported. */
|
---|
222 | #define VRDE_VIDEOIN_F_DEV_CAP_TRIGGER_USAGE 0x04 /* 0 - still image, 1 - generic button event.*/
|
---|
223 |
|
---|
224 | /* VRDEVIDEOINDEVICEDESC extended description. */
|
---|
225 | typedef struct VRDEVIDEOINDEVICEEXT
|
---|
226 | {
|
---|
227 | uint32_t fu32Fields;
|
---|
228 | /* One or more VRDEVIDEOINDEVICEFIELD follow. */
|
---|
229 | } VRDEVIDEOINDEVICEEXT;
|
---|
230 |
|
---|
231 | typedef struct VRDEVIDEOINDEVICEFIELDHDR
|
---|
232 | {
|
---|
233 | uint16_t cbField; /* Number of bytes reserved for this field. */
|
---|
234 | } VRDEVIDEOINDEVICEFIELDHDR;
|
---|
235 |
|
---|
236 | /* VRDEVIDEOINDEVICEDESC::fu32Fields */
|
---|
237 | #define VRDE_VIDEOIN_F_DEV_EXT_NAME 0x00000001 /* Utf8 device name. */
|
---|
238 | #define VRDE_VIDEOIN_F_DEV_EXT_SERIAL 0x00000002 /* Utf8 device serial number. */
|
---|
239 |
|
---|
240 | /* The video format descriptor. */
|
---|
241 | typedef struct VRDEVIDEOINFORMATDESC
|
---|
242 | {
|
---|
243 | uint16_t cbFormat; /* Size of the structure including cbFormat and format specific data. */
|
---|
244 | uint8_t u8FormatId; /* The unique identifier of the format on the client. */
|
---|
245 | uint8_t u8FormatType; /* MJPEG etc. VRDE_VIDEOIN_FORMAT_* */
|
---|
246 | uint8_t u8FormatFlags; /* VRDE_VIDEOIN_F_FMT_* */
|
---|
247 | uint8_t u8NumFrames; /* Number of following VRDEVIDEOINFRAMEDESC structures. */
|
---|
248 | uint16_t u16Reserved; /* Must be set to 0. */
|
---|
249 | /* Other format specific data may follow. */
|
---|
250 | /* An array of VRDEVIDEOINFRAMEDESC follows. */
|
---|
251 | } VRDEVIDEOINFORMATDESC;
|
---|
252 |
|
---|
253 | /* VRDEVIDEOINFORMATDESC::u8FormatType */
|
---|
254 | #define VRDE_VIDEOIN_FORMAT_UNCOMPRESSED 0x04
|
---|
255 | #define VRDE_VIDEOIN_FORMAT_MJPEG 0x06
|
---|
256 | #define VRDE_VIDEOIN_FORMAT_MPEG2TS 0x0A
|
---|
257 | #define VRDE_VIDEOIN_FORMAT_DV 0x0C
|
---|
258 | #define VRDE_VIDEOIN_FORMAT_FRAME_BASED 0x10
|
---|
259 | #define VRDE_VIDEOIN_FORMAT_STREAM_BASED 0x12
|
---|
260 |
|
---|
261 | /* VRDEVIDEOINFORMATDESC::u8FormatFlags. */
|
---|
262 | #define VRDE_VIDEOIN_F_FMT_GENERATEKEYFRAME 0x01 /* Supports Generate Key Frame */
|
---|
263 | #define VRDE_VIDEOIN_F_FMT_UPDATEFRAMESEGMENT 0x02 /* Supports Update Frame Segment */
|
---|
264 | #define VRDE_VIDEOIN_F_FMT_COPYPROTECT 0x04 /* If duplication should be restricted. */
|
---|
265 | #define VRDE_VIDEOIN_F_FMT_COMPQUALITY 0x08 /* If the format supports an adjustable compression quality. */
|
---|
266 |
|
---|
267 | typedef struct VRDEVIDEOINFRAMEDESC
|
---|
268 | {
|
---|
269 | uint16_t cbFrame; /* Size of the structure including cbFrame and frame specific data. */
|
---|
270 | uint8_t u8FrameId; /* The unique identifier of the frame for the corresponding format on the client. */
|
---|
271 | uint8_t u8FrameFlags;
|
---|
272 | uint16_t u16Width;
|
---|
273 | uint16_t u16Height;
|
---|
274 | uint32_t u32NumFrameIntervals; /* The number of supported frame intervals. */
|
---|
275 | uint32_t u32MinFrameInterval; /* Shortest frame interval supported (at highest frame rate), in 100ns units. */
|
---|
276 | uint32_t u32MaxFrameInterval; /* Longest frame interval supported (at lowest frame rate), in 100ns units. */
|
---|
277 | /* Supported frame intervals (in 100ns units) follow if VRDE_VIDEOIN_F_FRM_DISCRETE_INTERVALS is set.
|
---|
278 | * uint32_t au32FrameIntervals[u32NumFrameIntervals];
|
---|
279 | */
|
---|
280 | /* Supported min and max bitrate in bits per second follow if VRDE_VIDEOIN_F_FRM_BITRATE is set.
|
---|
281 | * uint32_t u32MinBitRate;
|
---|
282 | * uint32_t u32MaxBitRate;
|
---|
283 | */
|
---|
284 | /* Other frame specific data may follow. */
|
---|
285 | } VRDEVIDEOINFRAMEDESC;
|
---|
286 |
|
---|
287 | /* VRDEVIDEOINFRAMEDESC::u8FrameFlags. */
|
---|
288 | #define VRDE_VIDEOIN_F_FRM_STILL 0x01 /* If still images are supported for this frame. */
|
---|
289 | #define VRDE_VIDEOIN_F_FRM_DISCRETE_INTERVALS 0x02 /* If the discrete intervals list is included. */
|
---|
290 | #define VRDE_VIDEOIN_F_FRM_BITRATE 0x04 /* If the bitrate fields are included. */
|
---|
291 | #define VRDE_VIDEOIN_F_FRM_SIZE_OF_FIELDS 0x08 /* If the all optional fields start with 16 bit field size. */
|
---|
292 |
|
---|
293 | /*
|
---|
294 | * Controls.
|
---|
295 | *
|
---|
296 | * The same structures are used for both SET and GET requests.
|
---|
297 | * Requests are async. A callback is invoked, when the client returns a reply.
|
---|
298 | * A control change notification also uses these structures.
|
---|
299 | *
|
---|
300 | * If a control request can not be fulfilled, then VRDE_VIDEOIN_CTRLHDR_F_FAIL
|
---|
301 | * will be set and u8Status contains the error code. This replaces the VC_REQUEST_ERROR_CODE_CONTROL.
|
---|
302 | *
|
---|
303 | * If the client receives an unsupported control, then the client must ignore it.
|
---|
304 | * That is the control request must not affect the client in any way.
|
---|
305 | * The client may send a VRDEVIDEOINCTRLHDR response for the unsupported control with:
|
---|
306 | * u16ControlSelector = the received value;
|
---|
307 | * u16RequestType = the received value;
|
---|
308 | * u16ParmSize = 0;
|
---|
309 | * u8Flags = VRDE_VIDEOIN_CTRLHDR_F_FAIL;
|
---|
310 | * u8Status = VRDE_VIDEOIN_CTRLHDR_STATUS_INVALIDCONTROL;
|
---|
311 | */
|
---|
312 |
|
---|
313 | typedef struct VRDEVIDEOINCTRLHDR
|
---|
314 | {
|
---|
315 | uint16_t u16ControlSelector; /* VRDE_VIDEOIN_CTRLSEL_* */
|
---|
316 | uint16_t u16RequestType; /* VRDE_VIDEOIN_CTRLREQ_* */
|
---|
317 | uint16_t u16ParmSize; /* The size of the control specific parameters. */
|
---|
318 | uint8_t u8Flags; /* VRDE_VIDEOIN_CTRLHDR_F_* */
|
---|
319 | uint8_t u8Status; /* VRDE_VIDEOIN_CTRLHDR_STATUS_* */
|
---|
320 | /* Control specific data follows. */
|
---|
321 | } VRDEVIDEOINCTRLHDR;
|
---|
322 |
|
---|
323 | /* Control request types: VRDEVIDEOINCTRLHDR::u16RequestType. */
|
---|
324 | #define VRDE_VIDEOIN_CTRLREQ_UNDEFINED 0x00
|
---|
325 | #define VRDE_VIDEOIN_CTRLREQ_SET_CUR 0x01
|
---|
326 | #define VRDE_VIDEOIN_CTRLREQ_GET_CUR 0x81
|
---|
327 | #define VRDE_VIDEOIN_CTRLREQ_GET_MIN 0x82
|
---|
328 | #define VRDE_VIDEOIN_CTRLREQ_GET_MAX 0x83
|
---|
329 | #define VRDE_VIDEOIN_CTRLREQ_GET_RES 0x84
|
---|
330 | #define VRDE_VIDEOIN_CTRLREQ_GET_LEN 0x85
|
---|
331 | #define VRDE_VIDEOIN_CTRLREQ_GET_INFO 0x86
|
---|
332 | #define VRDE_VIDEOIN_CTRLREQ_GET_DEF 0x87
|
---|
333 |
|
---|
334 | /* VRDEVIDEOINCTRLHDR::u8Flags */
|
---|
335 | #define VRDE_VIDEOIN_CTRLHDR_F_NOTIFY 0x01 /* Control change notification, the attribute is derived from u16RequestType and F_FAIL. */
|
---|
336 | #define VRDE_VIDEOIN_CTRLHDR_F_FAIL 0x02 /* The operation failed. Error code is in u8Status. */
|
---|
337 |
|
---|
338 | /* VRDEVIDEOINCTRLHDR::u8Status if the VRDE_VIDEOIN_CTRLHDR_F_FAIL is set. */
|
---|
339 | #define VRDE_VIDEOIN_CTRLHDR_STATUS_SUCCESS 0x00 /**/
|
---|
340 | #define VRDE_VIDEOIN_CTRLHDR_STATUS_NOTREADY 0x01 /* Not ready */
|
---|
341 | #define VRDE_VIDEOIN_CTRLHDR_STATUS_WRONGSTATE 0x02 /* Wrong state */
|
---|
342 | #define VRDE_VIDEOIN_CTRLHDR_STATUS_POWER 0x03 /* Power */
|
---|
343 | #define VRDE_VIDEOIN_CTRLHDR_STATUS_OUTOFRANGE 0x04 /* Out of range */
|
---|
344 | #define VRDE_VIDEOIN_CTRLHDR_STATUS_INVALIDUNIT 0x05 /* Invalid unit */
|
---|
345 | #define VRDE_VIDEOIN_CTRLHDR_STATUS_INVALIDCONTROL 0x06 /* Invalid control */
|
---|
346 | #define VRDE_VIDEOIN_CTRLHDR_STATUS_INVALIDREQUEST 0x07 /* Invalid request */
|
---|
347 | #define VRDE_VIDEOIN_CTRLHDR_STATUS_UNKNOWN 0xFF /* Unknown */
|
---|
348 |
|
---|
349 | /* Control selectors. 16 bit. High byte is the category. Low byte is the identifier.*/
|
---|
350 | #ifdef RT_MAKE_U16
|
---|
351 | #define VRDE_VIDEOIN_CTRLSEL_MAKE(Lo, Hi) RT_MAKE_U16(Lo, Hi)
|
---|
352 | #else
|
---|
353 | #define VRDE_VIDEOIN_CTRLSEL_MAKE(Lo, Hi) ((uint16_t)( (uint16_t)((uint8_t)(Hi)) << 8 | (uint8_t)(Lo) ))
|
---|
354 | #endif
|
---|
355 |
|
---|
356 | #define VRDE_VIDEOIN_CTRLSEL_VC(a) VRDE_VIDEOIN_CTRLSEL_MAKE(a, 0x01)
|
---|
357 | #define VRDE_VIDEOIN_CTRLSEL_CT(a) VRDE_VIDEOIN_CTRLSEL_MAKE(a, 0x02)
|
---|
358 | #define VRDE_VIDEOIN_CTRLSEL_PU(a) VRDE_VIDEOIN_CTRLSEL_MAKE(a, 0x03)
|
---|
359 | #define VRDE_VIDEOIN_CTRLSEL_VS(a) VRDE_VIDEOIN_CTRLSEL_MAKE(a, 0x04)
|
---|
360 | #define VRDE_VIDEOIN_CTRLSEL_HW(a) VRDE_VIDEOIN_CTRLSEL_MAKE(a, 0x05)
|
---|
361 | #define VRDE_VIDEOIN_CTRLSEL_PROT(a) VRDE_VIDEOIN_CTRLSEL_MAKE(a, 0x06)
|
---|
362 |
|
---|
363 | #define VRDE_VIDEOIN_CTRLSEL_VC_VIDEO_POWER_MODE_CONTROL VRDE_VIDEOIN_CTRLSEL_VC(0x01)
|
---|
364 |
|
---|
365 | #define VRDE_VIDEOIN_CTRLSEL_CT_UNDEFINED VRDE_VIDEOIN_CTRLSEL_CT(0x00)
|
---|
366 | #define VRDE_VIDEOIN_CTRLSEL_CT_SCANNING_MODE VRDE_VIDEOIN_CTRLSEL_CT(0x01)
|
---|
367 | #define VRDE_VIDEOIN_CTRLSEL_CT_AE_MODE VRDE_VIDEOIN_CTRLSEL_CT(0x02)
|
---|
368 | #define VRDE_VIDEOIN_CTRLSEL_CT_AE_PRIORITY VRDE_VIDEOIN_CTRLSEL_CT(0x03)
|
---|
369 | #define VRDE_VIDEOIN_CTRLSEL_CT_EXPOSURE_TIME_ABSOLUTE VRDE_VIDEOIN_CTRLSEL_CT(0x04)
|
---|
370 | #define VRDE_VIDEOIN_CTRLSEL_CT_EXPOSURE_TIME_RELATIVE VRDE_VIDEOIN_CTRLSEL_CT(0x05)
|
---|
371 | #define VRDE_VIDEOIN_CTRLSEL_CT_FOCUS_ABSOLUTE VRDE_VIDEOIN_CTRLSEL_CT(0x06)
|
---|
372 | #define VRDE_VIDEOIN_CTRLSEL_CT_FOCUS_RELATIVE VRDE_VIDEOIN_CTRLSEL_CT(0x07)
|
---|
373 | #define VRDE_VIDEOIN_CTRLSEL_CT_FOCUS_AUTO VRDE_VIDEOIN_CTRLSEL_CT(0x08)
|
---|
374 | #define VRDE_VIDEOIN_CTRLSEL_CT_IRIS_ABSOLUTE VRDE_VIDEOIN_CTRLSEL_CT(0x09)
|
---|
375 | #define VRDE_VIDEOIN_CTRLSEL_CT_IRIS_RELATIVE VRDE_VIDEOIN_CTRLSEL_CT(0x0A)
|
---|
376 | #define VRDE_VIDEOIN_CTRLSEL_CT_ZOOM_ABSOLUTE VRDE_VIDEOIN_CTRLSEL_CT(0x0B)
|
---|
377 | #define VRDE_VIDEOIN_CTRLSEL_CT_ZOOM_RELATIVE VRDE_VIDEOIN_CTRLSEL_CT(0x0C)
|
---|
378 | #define VRDE_VIDEOIN_CTRLSEL_CT_PANTILT_ABSOLUTE VRDE_VIDEOIN_CTRLSEL_CT(0x0D)
|
---|
379 | #define VRDE_VIDEOIN_CTRLSEL_CT_PANTILT_RELATIVE VRDE_VIDEOIN_CTRLSEL_CT(0x0E)
|
---|
380 | #define VRDE_VIDEOIN_CTRLSEL_CT_ROLL_ABSOLUTE VRDE_VIDEOIN_CTRLSEL_CT(0x0F)
|
---|
381 | #define VRDE_VIDEOIN_CTRLSEL_CT_ROLL_RELATIVE VRDE_VIDEOIN_CTRLSEL_CT(0x10)
|
---|
382 | #define VRDE_VIDEOIN_CTRLSEL_CT_PRIVACY VRDE_VIDEOIN_CTRLSEL_CT(0x11)
|
---|
383 |
|
---|
384 | #define VRDE_VIDEOIN_CTRLSEL_PU_UNDEFINED VRDE_VIDEOIN_CTRLSEL_PU(0x00)
|
---|
385 | #define VRDE_VIDEOIN_CTRLSEL_PU_BACKLIGHT_COMPENSATION VRDE_VIDEOIN_CTRLSEL_PU(0x01)
|
---|
386 | #define VRDE_VIDEOIN_CTRLSEL_PU_BRIGHTNESS VRDE_VIDEOIN_CTRLSEL_PU(0x02)
|
---|
387 | #define VRDE_VIDEOIN_CTRLSEL_PU_CONTRAST VRDE_VIDEOIN_CTRLSEL_PU(0x03)
|
---|
388 | #define VRDE_VIDEOIN_CTRLSEL_PU_GAIN VRDE_VIDEOIN_CTRLSEL_PU(0x04)
|
---|
389 | #define VRDE_VIDEOIN_CTRLSEL_PU_POWER_LINE_FREQUENCY VRDE_VIDEOIN_CTRLSEL_PU(0x05)
|
---|
390 | #define VRDE_VIDEOIN_CTRLSEL_PU_HUE VRDE_VIDEOIN_CTRLSEL_PU(0x06)
|
---|
391 | #define VRDE_VIDEOIN_CTRLSEL_PU_SATURATION VRDE_VIDEOIN_CTRLSEL_PU(0x07)
|
---|
392 | #define VRDE_VIDEOIN_CTRLSEL_PU_SHARPNESS VRDE_VIDEOIN_CTRLSEL_PU(0x08)
|
---|
393 | #define VRDE_VIDEOIN_CTRLSEL_PU_GAMMA VRDE_VIDEOIN_CTRLSEL_PU(0x09)
|
---|
394 | #define VRDE_VIDEOIN_CTRLSEL_PU_WHITE_BALANCE_TEMPERATURE VRDE_VIDEOIN_CTRLSEL_PU(0x0A)
|
---|
395 | #define VRDE_VIDEOIN_CTRLSEL_PU_WHITE_BALANCE_TEMPERATURE_AUTO VRDE_VIDEOIN_CTRLSEL_PU(0x0B)
|
---|
396 | #define VRDE_VIDEOIN_CTRLSEL_PU_WHITE_BALANCE_COMPONENT VRDE_VIDEOIN_CTRLSEL_PU(0x0C)
|
---|
397 | #define VRDE_VIDEOIN_CTRLSEL_PU_WHITE_BALANCE_COMPONENT_AUTO VRDE_VIDEOIN_CTRLSEL_PU(0x0D)
|
---|
398 | #define VRDE_VIDEOIN_CTRLSEL_PU_DIGITAL_MULTIPLIER VRDE_VIDEOIN_CTRLSEL_PU(0x0E)
|
---|
399 | #define VRDE_VIDEOIN_CTRLSEL_PU_DIGITAL_MULTIPLIER_LIMIT VRDE_VIDEOIN_CTRLSEL_PU(0x0F)
|
---|
400 | #define VRDE_VIDEOIN_CTRLSEL_PU_HUE_AUTO VRDE_VIDEOIN_CTRLSEL_PU(0x10)
|
---|
401 | #define VRDE_VIDEOIN_CTRLSEL_PU_ANALOG_VIDEO_STANDARD VRDE_VIDEOIN_CTRLSEL_PU(0x11)
|
---|
402 | #define VRDE_VIDEOIN_CTRLSEL_PU_ANALOG_LOCK_STATUS VRDE_VIDEOIN_CTRLSEL_PU(0x12)
|
---|
403 |
|
---|
404 | #define VRDE_VIDEOIN_CTRLSEL_VS_UNDEFINED VRDE_VIDEOIN_CTRLSEL_VS(0x00)
|
---|
405 | #define VRDE_VIDEOIN_CTRLSEL_VS_SETUP VRDE_VIDEOIN_CTRLSEL_VS(0x01)
|
---|
406 | #define VRDE_VIDEOIN_CTRLSEL_VS_OFF VRDE_VIDEOIN_CTRLSEL_VS(0x02)
|
---|
407 | #define VRDE_VIDEOIN_CTRLSEL_VS_ON VRDE_VIDEOIN_CTRLSEL_VS(0x03)
|
---|
408 | #define VRDE_VIDEOIN_CTRLSEL_VS_STILL_IMAGE_TRIGGER VRDE_VIDEOIN_CTRLSEL_VS(0x05)
|
---|
409 | #define VRDE_VIDEOIN_CTRLSEL_VS_STREAM_ERROR_CODE VRDE_VIDEOIN_CTRLSEL_VS(0x06)
|
---|
410 | #define VRDE_VIDEOIN_CTRLSEL_VS_GENERATE_KEY_FRAME VRDE_VIDEOIN_CTRLSEL_VS(0x07)
|
---|
411 | #define VRDE_VIDEOIN_CTRLSEL_VS_UPDATE_FRAME_SEGMENT VRDE_VIDEOIN_CTRLSEL_VS(0x08)
|
---|
412 | #define VRDE_VIDEOIN_CTRLSEL_VS_SYNCH_DELAY VRDE_VIDEOIN_CTRLSEL_VS(0x09)
|
---|
413 |
|
---|
414 | #define VRDE_VIDEOIN_CTRLSEL_HW_BUTTON VRDE_VIDEOIN_CTRLSEL_HW(0x01)
|
---|
415 |
|
---|
416 | #define VRDE_VIDEOIN_CTRLSEL_PROT_PING VRDE_VIDEOIN_CTRLSEL_PROT(0x01)
|
---|
417 | #define VRDE_VIDEOIN_CTRLSEL_PROT_SAMPLING VRDE_VIDEOIN_CTRLSEL_PROT(0x02)
|
---|
418 | #define VRDE_VIDEOIN_CTRLSEL_PROT_FRAMES VRDE_VIDEOIN_CTRLSEL_PROT(0x03)
|
---|
419 |
|
---|
420 | typedef struct VRDEVIDEOINCTRL_VIDEO_POWER_MODE
|
---|
421 | {
|
---|
422 | VRDEVIDEOINCTRLHDR hdr;
|
---|
423 | uint8_t u8DevicePowerMode;
|
---|
424 | } VRDEVIDEOINCTRL_VIDEO_POWER_MODE;
|
---|
425 |
|
---|
426 | typedef struct VRDEVIDEOINCTRL_CT_SCANNING_MODE
|
---|
427 | {
|
---|
428 | VRDEVIDEOINCTRLHDR hdr;
|
---|
429 | uint8_t u8ScanningMode;
|
---|
430 | } VRDEVIDEOINCTRL_CT_SCANNING_MODE;
|
---|
431 |
|
---|
432 | typedef struct VRDEVIDEOINCTRL_CT_AE_MODE
|
---|
433 | {
|
---|
434 | VRDEVIDEOINCTRLHDR hdr;
|
---|
435 | uint8_t u8AutoExposureMode;
|
---|
436 | } VRDEVIDEOINCTRL_CT_AE_MODE;
|
---|
437 |
|
---|
438 | typedef struct VRDEVIDEOINCTRL_CT_AE_PRIORITY
|
---|
439 | {
|
---|
440 | VRDEVIDEOINCTRLHDR hdr;
|
---|
441 | uint8_t u8AutoExposurePriority;
|
---|
442 | } VRDEVIDEOINCTRL_CT_AE_PRIORITY;
|
---|
443 |
|
---|
444 | typedef struct VRDEVIDEOINCTRL_CT_EXPOSURE_TIME_ABSOLUTE
|
---|
445 | {
|
---|
446 | VRDEVIDEOINCTRLHDR hdr;
|
---|
447 | uint32_t u32ExposureTimeAbsolute;
|
---|
448 | } VRDEVIDEOINCTRL_CT_EXPOSURE_TIME_ABSOLUTE;
|
---|
449 |
|
---|
450 | typedef struct VRDEVIDEOINCTRL_CT_EXPOSURE_TIME_RELATIVE
|
---|
451 | {
|
---|
452 | VRDEVIDEOINCTRLHDR hdr;
|
---|
453 | uint8_t u8ExposureTimeRelative;
|
---|
454 | } VRDEVIDEOINCTRL_CT_EXPOSURE_TIME_RELATIVE;
|
---|
455 |
|
---|
456 | typedef struct VRDEVIDEOINCTRL_CT_FOCUS_ABSOLUTE
|
---|
457 | {
|
---|
458 | VRDEVIDEOINCTRLHDR hdr;
|
---|
459 | uint16_t u16FocusAbsolute;
|
---|
460 | } VRDEVIDEOINCTRL_CT_FOCUS_ABSOLUTE;
|
---|
461 |
|
---|
462 | typedef struct VRDEVIDEOINCTRL_CT_FOCUS_RELATIVE
|
---|
463 | {
|
---|
464 | VRDEVIDEOINCTRLHDR hdr;
|
---|
465 | uint8_t u8FocusRelative;
|
---|
466 | uint8_t u8Speed;
|
---|
467 | } VRDEVIDEOINCTRL_CT_FOCUS_RELATIVE;
|
---|
468 |
|
---|
469 | typedef struct VRDEVIDEOINCTRL_CT_FOCUS_AUTO
|
---|
470 | {
|
---|
471 | VRDEVIDEOINCTRLHDR hdr;
|
---|
472 | uint8_t u8FocusAuto;
|
---|
473 | } VRDEVIDEOINCTRL_CT_FOCUS_AUTO;
|
---|
474 |
|
---|
475 | typedef struct VRDEVIDEOINCTRL_CT_IRIS_ABSOLUTE
|
---|
476 | {
|
---|
477 | VRDEVIDEOINCTRLHDR hdr;
|
---|
478 | uint16_t u16IrisAbsolute;
|
---|
479 | } VRDEVIDEOINCTRL_CT_IRIS_ABSOLUTE;
|
---|
480 |
|
---|
481 | typedef struct VRDEVIDEOINCTRL_CT_IRIS_RELATIVE
|
---|
482 | {
|
---|
483 | VRDEVIDEOINCTRLHDR hdr;
|
---|
484 | uint8_t u8IrisRelative;
|
---|
485 | } VRDEVIDEOINCTRL_CT_IRIS_RELATIVE;
|
---|
486 |
|
---|
487 | typedef struct VRDEVIDEOINCTRL_CT_ZOOM_ABSOLUTE
|
---|
488 | {
|
---|
489 | VRDEVIDEOINCTRLHDR hdr;
|
---|
490 | uint16_t u16ZoomAbsolute;
|
---|
491 | } VRDEVIDEOINCTRL_CT_ZOOM_ABSOLUTE;
|
---|
492 |
|
---|
493 | typedef struct VRDEVIDEOINCTRL_CT_ZOOM_RELATIVE
|
---|
494 | {
|
---|
495 | VRDEVIDEOINCTRLHDR hdr;
|
---|
496 | uint8_t u8Zoom;
|
---|
497 | uint8_t u8DigitalZoom;
|
---|
498 | uint8_t u8Speed;
|
---|
499 | } VRDEVIDEOINCTRL_CT_ZOOM_RELATIVE;
|
---|
500 |
|
---|
501 | typedef struct VRDEVIDEOINCTRL_CT_PANTILT_ABSOLUTE
|
---|
502 | {
|
---|
503 | VRDEVIDEOINCTRLHDR hdr;
|
---|
504 | uint32_t u32PanAbsolute;
|
---|
505 | uint32_t u32TiltAbsolute;
|
---|
506 | } VRDEVIDEOINCTRL_CT_PANTILT_ABSOLUTE;
|
---|
507 |
|
---|
508 | typedef struct VRDEVIDEOINCTRL_CT_PANTILT_RELATIVE
|
---|
509 | {
|
---|
510 | VRDEVIDEOINCTRLHDR hdr;
|
---|
511 | uint8_t u8PanRelative;
|
---|
512 | uint8_t u8PanSpeed;
|
---|
513 | uint8_t u8TiltRelative;
|
---|
514 | uint8_t u8TiltSpeed;
|
---|
515 | } VRDEVIDEOINCTRL_CT_PANTILT_RELATIVE;
|
---|
516 |
|
---|
517 | typedef struct VRDEVIDEOINCTRL_CT_ROLL_ABSOLUTE
|
---|
518 | {
|
---|
519 | VRDEVIDEOINCTRLHDR hdr;
|
---|
520 | uint16_t u16RollAbsolute;
|
---|
521 | } VRDEVIDEOINCTRL_CT_ROLL_ABSOLUTE;
|
---|
522 |
|
---|
523 | typedef struct VRDEVIDEOINCTRL_CT_ROLL_RELATIVE
|
---|
524 | {
|
---|
525 | VRDEVIDEOINCTRLHDR hdr;
|
---|
526 | uint8_t u8RollRelative;
|
---|
527 | uint8_t u8Speed;
|
---|
528 | } VRDEVIDEOINCTRL_CT_ROLL_RELATIVE;
|
---|
529 |
|
---|
530 | typedef struct VRDEVIDEOINCTRL_CT_PRIVACY_MODE
|
---|
531 | {
|
---|
532 | VRDEVIDEOINCTRLHDR hdr;
|
---|
533 | uint8_t u8Privacy;
|
---|
534 | } VRDEVIDEOINCTRL_CT_PRIVACY_MODE;
|
---|
535 |
|
---|
536 | typedef struct VRDEVIDEOINCTRL_PU_BACKLIGHT_COMPENSATION
|
---|
537 | {
|
---|
538 | VRDEVIDEOINCTRLHDR hdr;
|
---|
539 | uint16_t u16BacklightCompensation;
|
---|
540 | } VRDEVIDEOINCTRL_PU_BACKLIGHT_COMPENSATION;
|
---|
541 |
|
---|
542 | typedef struct VRDEVIDEOINCTRL_PU_BRIGHTNESS
|
---|
543 | {
|
---|
544 | VRDEVIDEOINCTRLHDR hdr;
|
---|
545 | uint16_t u16Brightness;
|
---|
546 | } VRDEVIDEOINCTRL_PU_BRIGHTNESS;
|
---|
547 |
|
---|
548 | typedef struct VRDEVIDEOINCTRL_PU_CONTRAST
|
---|
549 | {
|
---|
550 | VRDEVIDEOINCTRLHDR hdr;
|
---|
551 | uint16_t u16Contrast;
|
---|
552 | } VRDEVIDEOINCTRL_PU_CONTRAST;
|
---|
553 |
|
---|
554 | typedef struct VRDEVIDEOINCTRL_PU_GAIN
|
---|
555 | {
|
---|
556 | VRDEVIDEOINCTRLHDR hdr;
|
---|
557 | uint16_t u16Gain;
|
---|
558 | } VRDEVIDEOINCTRL_PU_GAIN;
|
---|
559 |
|
---|
560 | typedef struct VRDEVIDEOINCTRL_PU_POWER_LINE_FREQUENCY
|
---|
561 | {
|
---|
562 | VRDEVIDEOINCTRLHDR hdr;
|
---|
563 | uint16_t u16PowerLineFrequency;
|
---|
564 | } VRDEVIDEOINCTRL_PU_POWER_LINE_FREQUENCY;
|
---|
565 |
|
---|
566 | typedef struct VRDEVIDEOINCTRL_PU_HUE
|
---|
567 | {
|
---|
568 | VRDEVIDEOINCTRLHDR hdr;
|
---|
569 | uint16_t u16Hue;
|
---|
570 | } VRDEVIDEOINCTRL_PU_HUE;
|
---|
571 |
|
---|
572 | typedef struct VRDEVIDEOINCTRL_PU_HUE_AUTO
|
---|
573 | {
|
---|
574 | VRDEVIDEOINCTRLHDR hdr;
|
---|
575 | uint8_t u8HueAuto;
|
---|
576 | } VRDEVIDEOINCTRL_PU_HUE_AUTO;
|
---|
577 |
|
---|
578 | typedef struct VRDEVIDEOINCTRL_PU_SATURATION
|
---|
579 | {
|
---|
580 | VRDEVIDEOINCTRLHDR hdr;
|
---|
581 | uint16_t u16Saturation;
|
---|
582 | } VRDEVIDEOINCTRL_PU_SATURATION;
|
---|
583 |
|
---|
584 | typedef struct VRDEVIDEOINCTRL_PU_SHARPNESS
|
---|
585 | {
|
---|
586 | VRDEVIDEOINCTRLHDR hdr;
|
---|
587 | uint16_t u16Sharpness;
|
---|
588 | } VRDEVIDEOINCTRL_PU_SHARPNESS;
|
---|
589 |
|
---|
590 | typedef struct VRDEVIDEOINCTRL_PU_GAMMA
|
---|
591 | {
|
---|
592 | VRDEVIDEOINCTRLHDR hdr;
|
---|
593 | uint16_t u16Gamma;
|
---|
594 | } VRDEVIDEOINCTRL_PU_GAMMA;
|
---|
595 |
|
---|
596 | typedef struct VRDEVIDEOINCTRL_PU_WHITE_BALANCE_TEMPERATURE
|
---|
597 | {
|
---|
598 | VRDEVIDEOINCTRLHDR hdr;
|
---|
599 | uint16_t u16WhiteBalanceTemperature;
|
---|
600 | } VRDEVIDEOINCTRL_PU_WHITE_BALANCE_TEMPERATURE;
|
---|
601 |
|
---|
602 | typedef struct VRDEVIDEOINCTRL_PU_WHITE_BALANCE_TEMPERATURE_AUTO
|
---|
603 | {
|
---|
604 | VRDEVIDEOINCTRLHDR hdr;
|
---|
605 | uint8_t u8WhiteBalanceTemperatureAuto;
|
---|
606 | } VRDEVIDEOINCTRL_PU_WHITE_BALANCE_TEMPERATURE_AUTO;
|
---|
607 |
|
---|
608 | typedef struct VRDEVIDEOINCTRL_PU_WHITE_BALANCE_COMPONENT
|
---|
609 | {
|
---|
610 | VRDEVIDEOINCTRLHDR hdr;
|
---|
611 | uint16_t u16WhiteBalanceBlue;
|
---|
612 | uint16_t u16WhiteBalanceRed;
|
---|
613 | } VRDEVIDEOINCTRL_PU_WHITE_BALANCE_COMPONENT;
|
---|
614 |
|
---|
615 | typedef struct VRDEVIDEOINCTRL_PU_WHITE_BALANCE_COMPONENT_AUTO
|
---|
616 | {
|
---|
617 | VRDEVIDEOINCTRLHDR hdr;
|
---|
618 | uint8_t u8WhiteBalanceComponentAuto;
|
---|
619 | } VRDEVIDEOINCTRL_PU_WHITE_BALANCE_COMPONENT_AUTO;
|
---|
620 |
|
---|
621 | typedef struct VRDEVIDEOINCTRL_PU_DIGITAL_MULTIPLIER
|
---|
622 | {
|
---|
623 | VRDEVIDEOINCTRLHDR hdr;
|
---|
624 | uint16_t u16MultiplierStep;
|
---|
625 | } VRDEVIDEOINCTRL_PU_DIGITAL_MULTIPLIER;
|
---|
626 |
|
---|
627 | typedef struct VRDEVIDEOINCTRL_PU_DIGITAL_MULTIPLIER_LIMIT
|
---|
628 | {
|
---|
629 | VRDEVIDEOINCTRLHDR hdr;
|
---|
630 | uint16_t u16MultiplierLimit;
|
---|
631 | } VRDEVIDEOINCTRL_PU_DIGITAL_MULTIPLIER_LIMIT;
|
---|
632 |
|
---|
633 | typedef struct VRDEVIDEOINCTRL_PU_ANALOG_VIDEO_STANDARD
|
---|
634 | {
|
---|
635 | VRDEVIDEOINCTRLHDR hdr;
|
---|
636 | uint8_t u8VideoStandard;
|
---|
637 | } VRDEVIDEOINCTRL_PU_ANALOG_VIDEO_STANDARD;
|
---|
638 |
|
---|
639 | typedef struct VRDEVIDEOINCTRL_PU_ANALOG_LOCK_STATUS
|
---|
640 | {
|
---|
641 | VRDEVIDEOINCTRLHDR hdr;
|
---|
642 | uint8_t u8Status;
|
---|
643 | } VRDEVIDEOINCTRL_PU_ANALOG_LOCK_STATUS;
|
---|
644 |
|
---|
645 | /* Set streaming parameters. The actual streaming will be enabled by VS_ON. */
|
---|
646 | #define VRDEVIDEOINCTRL_F_VS_SETUP_FID 0x01
|
---|
647 | #define VRDEVIDEOINCTRL_F_VS_SETUP_EOF 0x02
|
---|
648 |
|
---|
649 | typedef struct VRDEVIDEOINCTRL_VS_SETUP
|
---|
650 | {
|
---|
651 | VRDEVIDEOINCTRLHDR hdr;
|
---|
652 | uint8_t u8FormatId; /* The format id on the client: VRDEVIDEOINFORMATDESC::u8FormatId. */
|
---|
653 | uint8_t u8FramingInfo; /* VRDEVIDEOINCTRL_F_VS_SETUP_*. Set by the client. */
|
---|
654 | uint16_t u16Width;
|
---|
655 | uint16_t u16Height;
|
---|
656 | uint32_t u32FrameInterval; /* Frame interval in 100 ns units, 0 means a still image capture.
|
---|
657 | * The client may choose a different interval if this value is
|
---|
658 | * not supported.
|
---|
659 | */
|
---|
660 | uint16_t u16CompQuality; /* 0 .. 10000 = 0 .. 100%.
|
---|
661 | * Applicable if the format has VRDE_VIDEOIN_F_FMT_COMPQUALITY,
|
---|
662 | * otherwise this field is ignored.
|
---|
663 | */
|
---|
664 | uint16_t u16Delay; /* Latency in ms from video data capture to presentation on the channel.
|
---|
665 | * Set by the client, read by the server.
|
---|
666 | */
|
---|
667 | uint32_t u32ClockFrequency; /* @todo just all clocks in 100ns units? */
|
---|
668 | } VRDEVIDEOINCTRL_VS_SETUP;
|
---|
669 |
|
---|
670 | /* Stop sending video frames. */
|
---|
671 | typedef struct VRDEVIDEOINCTRL_VS_OFF
|
---|
672 | {
|
---|
673 | VRDEVIDEOINCTRLHDR hdr;
|
---|
674 | } VRDEVIDEOINCTRL_VS_OFF;
|
---|
675 |
|
---|
676 | /* Start sending video frames with parameters set by VS_SETUP. */
|
---|
677 | typedef struct VRDEVIDEOINCTRL_VS_ON
|
---|
678 | {
|
---|
679 | VRDEVIDEOINCTRLHDR hdr;
|
---|
680 | } VRDEVIDEOINCTRL_VS_ON;
|
---|
681 |
|
---|
682 | typedef struct VRDEVIDEOINCTRL_VS_STILL_IMAGE_TRIGGER
|
---|
683 | {
|
---|
684 | VRDEVIDEOINCTRLHDR hdr;
|
---|
685 | uint8_t u8Trigger;
|
---|
686 | } VRDEVIDEOINCTRL_VS_STILL_IMAGE_TRIGGER;
|
---|
687 |
|
---|
688 | typedef struct VRDEVIDEOINCTRL_VS_STREAM_ERROR_CODE
|
---|
689 | {
|
---|
690 | VRDEVIDEOINCTRLHDR hdr;
|
---|
691 | uint8_t u8StreamErrorCode;
|
---|
692 | } VRDEVIDEOINCTRL_VS_STREAM_ERROR_CODE;
|
---|
693 |
|
---|
694 | typedef struct VRDEVIDEOINCTRL_VS_GENERATE_KEY_FRAME
|
---|
695 | {
|
---|
696 | VRDEVIDEOINCTRLHDR hdr;
|
---|
697 | uint8_t u8GenerateKeyFrame;
|
---|
698 | } VRDEVIDEOINCTRL_VS_GENERATE_KEY_FRAME;
|
---|
699 |
|
---|
700 | typedef struct VRDEVIDEOINCTRL_VS_UPDATE_FRAME_SEGMENT
|
---|
701 | {
|
---|
702 | VRDEVIDEOINCTRLHDR hdr;
|
---|
703 | uint8_t u8StartFrameSegment;
|
---|
704 | uint8_t u8EndFrameSegment;
|
---|
705 | } VRDEVIDEOINCTRL_VS_UPDATE_FRAME_SEGMENT;
|
---|
706 |
|
---|
707 | typedef struct VRDEVIDEOINCTRL_VS_SYNCH_DELAY
|
---|
708 | {
|
---|
709 | VRDEVIDEOINCTRLHDR hdr;
|
---|
710 | uint16_t u16Delay;
|
---|
711 | } VRDEVIDEOINCTRL_VS_SYNCH_DELAY;
|
---|
712 |
|
---|
713 | /* A hardware button was pressed/released on the device. */
|
---|
714 | typedef struct VRDEVIDEOINCTRL_HW_BUTTON
|
---|
715 | {
|
---|
716 | VRDEVIDEOINCTRLHDR hdr;
|
---|
717 | uint8_t u8Pressed;
|
---|
718 | } VRDEVIDEOINCTRL_HW_BUTTON;
|
---|
719 |
|
---|
720 | typedef struct VRDEVIDEOINCTRL_PROT_PING
|
---|
721 | {
|
---|
722 | VRDEVIDEOINCTRLHDR hdr;
|
---|
723 | uint32_t u32Timestamp; /* Set in the request and the same value must be send back in the response. */
|
---|
724 | } VRDEVIDEOINCTRL_PROT_PING;
|
---|
725 |
|
---|
726 | typedef struct VRDEVIDEOINCTRL_PROT_SAMPLING
|
---|
727 | {
|
---|
728 | VRDEVIDEOINCTRLHDR hdr;
|
---|
729 | uint32_t fu32SampleStart; /* Which parameters must be sampled VRDEVIDEOINCTRL_F_PROT_SAMPLING_*. */
|
---|
730 | uint32_t fu32SampleStop; /* Which parameters to disable VRDEVIDEOINCTRL_F_PROT_SAMPLING_*.
|
---|
731 | * If both Start and Stop is set, then restart the sampling.
|
---|
732 | */
|
---|
733 | uint32_t u32PeriodMS; /* Sampling period in milliseconds. Applies to all samples in fu32SampleStart.
|
---|
734 | * Not mandatory, the actual sampling period may be different.
|
---|
735 | */
|
---|
736 | } VRDEVIDEOINCTRL_PROT_SAMPLING;
|
---|
737 |
|
---|
738 | #define VRDEVIDEOINCTRL_F_PROT_SAMPLING_FRAMES_SOURCE 0x00000001 /* Periodic VRDEVIDEOINCTRL_PROT_FRAMES samples */
|
---|
739 | #define VRDEVIDEOINCTRL_F_PROT_SAMPLING_FRAMES_CLIENT_OUT 0x00000002 /* Periodic VRDEVIDEOINCTRL_PROT_FRAMES samples */
|
---|
740 |
|
---|
741 | typedef struct VRDEVIDEOINCTRL_PROT_FRAMES
|
---|
742 | {
|
---|
743 | VRDEVIDEOINCTRLHDR hdr; /* Note: the message should be sent as VRDE_VIDEOIN_FN_CONTROL_NOTIFY. */
|
---|
744 | uint32_t u32Sample; /* Which sample is this, one of VRDEVIDEOINCTRL_F_PROT_SAMPLING_*. */
|
---|
745 | uint32_t u32TimestampMS; /* When the period started, milliseconds since the start of sampling. */
|
---|
746 | uint32_t u32PeriodMS; /* Actual period during which the frames were counted in milliseconds.
|
---|
747 | * This may be different from VRDEVIDEOINCTRL_PROT_SAMPLING::u32PeriodMS.
|
---|
748 | */
|
---|
749 | uint32_t u32FramesCount; /* How many frames per u32PeriodMS milliseconds. */
|
---|
750 | } VRDEVIDEOINCTRL_PROT_FRAMES;
|
---|
751 |
|
---|
752 |
|
---|
753 | /*
|
---|
754 | * Payload transfers. How frames are sent to the server:
|
---|
755 | * the client send a PAYLOAD packet, which has the already set format.
|
---|
756 | * The server enables the transfers by sending VRDEVIDEOINCTRL_VS_ON.
|
---|
757 | */
|
---|
758 |
|
---|
759 | /* Payload header */
|
---|
760 | typedef struct VRDEVIDEOINPAYLOADHDR
|
---|
761 | {
|
---|
762 | uint8_t u8HeaderLength; /* Entire header. */
|
---|
763 | uint8_t u8HeaderInfo; /* VRDE_VIDEOIN_PAYLOAD_F_* */
|
---|
764 | uint32_t u32PresentationTime; /* @todo define this */
|
---|
765 | uint32_t u32SourceTimeClock; /* @todo At the moment when the frame was sent to the channel.
|
---|
766 | * Allows the server to measure clock drift.
|
---|
767 | */
|
---|
768 | uint16_t u16Reserved; /* @todo */
|
---|
769 | } VRDEVIDEOINPAYLOADHDR;
|
---|
770 |
|
---|
771 | /* VRDEVIDEOINPAYLOADHDR::u8HeaderInfo */
|
---|
772 | #define VRDE_VIDEOIN_PAYLOAD_F_FID 0x01 /* Frame ID */
|
---|
773 | #define VRDE_VIDEOIN_PAYLOAD_F_EOF 0x02 /* End of Frame */
|
---|
774 | #define VRDE_VIDEOIN_PAYLOAD_F_PTS 0x04 /* Presentation Time */
|
---|
775 | #define VRDE_VIDEOIN_PAYLOAD_F_SCR 0x08 /* Source Clock Reference */
|
---|
776 | #define VRDE_VIDEOIN_PAYLOAD_F_RES 0x10 /* Reserved */
|
---|
777 | #define VRDE_VIDEOIN_PAYLOAD_F_STI 0x20 /* Still Image */
|
---|
778 | #define VRDE_VIDEOIN_PAYLOAD_F_ERR 0x40 /* Error */
|
---|
779 | #define VRDE_VIDEOIN_PAYLOAD_F_EOH 0x80 /* End of header */
|
---|
780 |
|
---|
781 |
|
---|
782 | /*
|
---|
783 | * The network channel specification.
|
---|
784 | */
|
---|
785 |
|
---|
786 | /*
|
---|
787 | * The protocol uses a dynamic RDP channel.
|
---|
788 | * Everything is little-endian.
|
---|
789 | */
|
---|
790 |
|
---|
791 | /* The dynamic RDP channel name. */
|
---|
792 | #define VRDE_VIDEOIN_CHANNEL "RVIDEOIN"
|
---|
793 |
|
---|
794 | /* Major functions. */
|
---|
795 | #define VRDE_VIDEOIN_FN_NEGOTIATE 0x0000 /* Version and capabilities check. */
|
---|
796 | #define VRDE_VIDEOIN_FN_NOTIFY 0x0001 /* Device attach/detach from the client. */
|
---|
797 | #define VRDE_VIDEOIN_FN_DEVICEDESC 0x0002 /* Query device description. */
|
---|
798 | #define VRDE_VIDEOIN_FN_CONTROL 0x0003 /* Control the device and start/stop video input.
|
---|
799 | * This function is used for sending a request and
|
---|
800 | * the corresponding response.
|
---|
801 | */
|
---|
802 | #define VRDE_VIDEOIN_FN_CONTROL_NOTIFY 0x0004 /* The client reports a control change, etc.
|
---|
803 | * This function indicated that the message is
|
---|
804 | * not a response to a CONTROL request.
|
---|
805 | */
|
---|
806 | #define VRDE_VIDEOIN_FN_FRAME 0x0005 /* Frame from the client. */
|
---|
807 |
|
---|
808 | /* Status codes. */
|
---|
809 | #define VRDE_VIDEOIN_STATUS_SUCCESS 0 /* Function completed successfully. */
|
---|
810 | #define VRDE_VIDEOIN_STATUS_FAILED 1 /* Failed for some reason. */
|
---|
811 |
|
---|
812 | typedef struct VRDEVIDEOINMSGHDR
|
---|
813 | {
|
---|
814 | uint32_t u32Length; /* The length of the message in bytes, including the header. */
|
---|
815 | uint32_t u32DeviceId; /* The client's device id. */
|
---|
816 | uint32_t u32MessageId; /* Unique id assigned by the server. The client must send a reply with the same id.
|
---|
817 | * If the client initiates a request, then this must be set to 0, because there is
|
---|
818 | * currently no client requests, which would require a response from the server.
|
---|
819 | */
|
---|
820 | uint16_t u16FunctionId; /* VRDE_VIDEOIN_FN_* */
|
---|
821 | uint16_t u16Status; /* The result of a request. VRDE_VIDEOIN_STATUS_*. */
|
---|
822 | } VRDEVIDEOINMSGHDR;
|
---|
823 | ASSERTSIZE(VRDEVIDEOINMSGHDR, 16)
|
---|
824 |
|
---|
825 | /*
|
---|
826 | * VRDE_VIDEOIN_FN_NEGOTIATE
|
---|
827 | *
|
---|
828 | * Sent by the server when the channel is established and the client replies with its capabilities.
|
---|
829 | */
|
---|
830 | #define VRDE_VIDEOIN_NEGOTIATE_VERSION 1
|
---|
831 |
|
---|
832 | /* VRDEVIDEOINMSG_NEGOTIATE::fu32Capabilities */
|
---|
833 | #define VRDE_VIDEOIN_NEGOTIATE_CAP_VOID 0x00000000
|
---|
834 | #define VRDE_VIDEOIN_NEGOTIATE_CAP_PROT 0x00000001 /* Supports VRDE_VIDEOIN_CTRLSEL_PROT_* controls. */
|
---|
835 |
|
---|
836 | typedef struct VRDEVIDEOINMSG_NEGOTIATE
|
---|
837 | {
|
---|
838 | VRDEVIDEOINMSGHDR hdr;
|
---|
839 | uint32_t u32Version; /* VRDE_VIDEOIN_NEGOTIATE_VERSION */
|
---|
840 | uint32_t fu32Capabilities; /* VRDE_VIDEOIN_NEGOTIATE_CAP_* */
|
---|
841 | } VRDEVIDEOINMSG_NEGOTIATE;
|
---|
842 |
|
---|
843 | /*
|
---|
844 | * VRDE_VIDEOIN_FN_NOTIFY
|
---|
845 | *
|
---|
846 | * Sent by the client when a webcam is attached or detached.
|
---|
847 | * The client must send the ATTACH notification for each webcam, which is
|
---|
848 | * already connected to the client when the VIDEOIN channel is established.
|
---|
849 | */
|
---|
850 | #define VRDE_VIDEOIN_NOTIFY_EVENT_ATTACH 0
|
---|
851 | #define VRDE_VIDEOIN_NOTIFY_EVENT_DETACH 1
|
---|
852 | #define VRDE_VIDEOIN_NOTIFY_EVENT_NEGOTIATE 2 /* Negotiate again with the client. */
|
---|
853 |
|
---|
854 | typedef struct VRDEVIDEOINMSG_NOTIFY
|
---|
855 | {
|
---|
856 | VRDEVIDEOINMSGHDR hdr;
|
---|
857 | uint32_t u32NotifyEvent; /* VRDE_VIDEOIN_NOTIFY_EVENT_* */
|
---|
858 | /* Event specific data may follow. The underlying protocol provides the length of the message. */
|
---|
859 | } VRDEVIDEOINMSG_NOTIFY;
|
---|
860 |
|
---|
861 | /*
|
---|
862 | * VRDE_VIDEOIN_FN_DEVICEDESC
|
---|
863 | *
|
---|
864 | * The server queries the description of a device.
|
---|
865 | */
|
---|
866 | typedef struct VRDEVIDEOINMSG_DEVICEDESC_REQ
|
---|
867 | {
|
---|
868 | VRDEVIDEOINMSGHDR hdr;
|
---|
869 | } VRDEVIDEOINMSG_DEVICEDESC_REQ;
|
---|
870 |
|
---|
871 | typedef struct VRDEVIDEOINMSG_DEVICEDESC_RSP
|
---|
872 | {
|
---|
873 | VRDEVIDEOINMSGHDR hdr;
|
---|
874 | VRDEVIDEOINDEVICEDESC Device;
|
---|
875 | /*
|
---|
876 | * VRDEVIDEOINFORMATDESC[0]
|
---|
877 | * VRDEVIDEOINFRAMEDESC[0]
|
---|
878 | * ...
|
---|
879 | * VRDEVIDEOINFRAMEDESC[n]
|
---|
880 | * VRDEVIDEOINFORMATDESC[1]
|
---|
881 | * VRDEVIDEOINFRAMEDESC[0]
|
---|
882 | * ...
|
---|
883 | * VRDEVIDEOINFRAMEDESC[m]
|
---|
884 | * ...
|
---|
885 | */
|
---|
886 | } VRDEVIDEOINMSG_DEVICEDESC_RSP;
|
---|
887 |
|
---|
888 | /*
|
---|
889 | * VRDE_VIDEOIN_FN_CONTROL
|
---|
890 | * VRDE_VIDEOIN_FN_CONTROL_NOTIFY
|
---|
891 | *
|
---|
892 | * Either sent by the server or by the client as a notification/response.
|
---|
893 | * If sent by the client as a notification, then hdr.u32MessageId must be 0.
|
---|
894 | */
|
---|
895 | typedef struct VRDEVIDEOINMSG_CONTROL
|
---|
896 | {
|
---|
897 | VRDEVIDEOINMSGHDR hdr;
|
---|
898 | VRDEVIDEOINCTRLHDR Control;
|
---|
899 | /* Control specific data may follow. */
|
---|
900 | } VRDEVIDEOINMSG_CONTROL;
|
---|
901 |
|
---|
902 | /*
|
---|
903 | * VRDE_VIDEOIN_FN_FRAME
|
---|
904 | *
|
---|
905 | * The client sends a video/still frame in the already specified format.
|
---|
906 | * hdr.u32MessageId must be 0.
|
---|
907 | */
|
---|
908 | typedef struct VRDEVIDEOINMSG_FRAME
|
---|
909 | {
|
---|
910 | VRDEVIDEOINMSGHDR hdr;
|
---|
911 | VRDEVIDEOINPAYLOADHDR Payload;
|
---|
912 | /* The frame data follow. */
|
---|
913 | } VRDEVIDEOINMSG_FRAME;
|
---|
914 |
|
---|
915 |
|
---|
916 | #ifdef VRDE_VIDEOIN_WITH_VRDEINTERFACE
|
---|
917 | /*
|
---|
918 | * The application interface between VirtualBox and the VRDE server.
|
---|
919 | */
|
---|
920 |
|
---|
921 | #define VRDE_VIDEOIN_INTERFACE_NAME "VIDEOIN"
|
---|
922 |
|
---|
923 | typedef struct VRDEVIDEOINDEVICEHANDLE
|
---|
924 | {
|
---|
925 | uint32_t u32ClientId;
|
---|
926 | uint32_t u32DeviceId;
|
---|
927 | } VRDEVIDEOINDEVICEHANDLE;
|
---|
928 |
|
---|
929 | /* The VRDE server video input interface entry points. Interface version 1. */
|
---|
930 | typedef struct VRDEVIDEOININTERFACE
|
---|
931 | {
|
---|
932 | /* The header. */
|
---|
933 | VRDEINTERFACEHDR header;
|
---|
934 |
|
---|
935 | /* Tell the server that this device will be used and associate a context with the device.
|
---|
936 | *
|
---|
937 | * @param hServer The VRDE server instance.
|
---|
938 | * @param pDeviceHandle The device reported by ATTACH notification.
|
---|
939 | * @param pvDeviceCtx The caller context associated with the pDeviceHandle.
|
---|
940 | *
|
---|
941 | * @return IPRT status code.
|
---|
942 | */
|
---|
943 | DECLR3CALLBACKMEMBER(int, VRDEVideoInDeviceAttach, (HVRDESERVER hServer,
|
---|
944 | const VRDEVIDEOINDEVICEHANDLE *pDeviceHandle,
|
---|
945 | void *pvDeviceCtx));
|
---|
946 |
|
---|
947 | /* This device will be not be used anymore. The device context must not be used by the server too.
|
---|
948 | *
|
---|
949 | * @param hServer The VRDE server instance.
|
---|
950 | * @param pDeviceHandle The device reported by ATTACH notification.
|
---|
951 | *
|
---|
952 | * @return IPRT status code.
|
---|
953 | */
|
---|
954 | DECLR3CALLBACKMEMBER(int, VRDEVideoInDeviceDetach, (HVRDESERVER hServer,
|
---|
955 | const VRDEVIDEOINDEVICEHANDLE *pDeviceHandle));
|
---|
956 |
|
---|
957 | /* Get a device description.
|
---|
958 | *
|
---|
959 | * @param hServer The VRDE server instance.
|
---|
960 | * @param pvUser The callers context of this request.
|
---|
961 | * @param pDeviceHandle The device reported by ATTACH notification.
|
---|
962 | *
|
---|
963 | * @return IPRT status code.
|
---|
964 | */
|
---|
965 | DECLR3CALLBACKMEMBER(int, VRDEVideoInGetDeviceDesc, (HVRDESERVER hServer,
|
---|
966 | void *pvUser,
|
---|
967 | const VRDEVIDEOINDEVICEHANDLE *pDeviceHandle));
|
---|
968 |
|
---|
969 | /* Submit a set/get control request.
|
---|
970 | *
|
---|
971 | * @param hServer The VRDE server instance.
|
---|
972 | * @param pvUser The callers context of this request.
|
---|
973 | * @param pDeviceHandle The device reported by ATTACH notification.
|
---|
974 | * @param pReq The request.
|
---|
975 | * @param cbReq Size of the request.
|
---|
976 | *
|
---|
977 | * @return IPRT status code.
|
---|
978 | */
|
---|
979 | DECLR3CALLBACKMEMBER(int, VRDEVideoInControl, (HVRDESERVER hServer,
|
---|
980 | void *pvUser,
|
---|
981 | const VRDEVIDEOINDEVICEHANDLE *pDeviceHandle,
|
---|
982 | const VRDEVIDEOINCTRLHDR *pReq,
|
---|
983 | uint32_t cbReq));
|
---|
984 |
|
---|
985 | } VRDEVIDEOININTERFACE;
|
---|
986 |
|
---|
987 |
|
---|
988 | /*
|
---|
989 | * Notifications.
|
---|
990 | * Data structures: pvData of VRDEVIDEOINCALLBACKS::VRDECallbackVideoInNotify.
|
---|
991 | */
|
---|
992 | typedef struct VRDEVIDEOINNOTIFYATTACH
|
---|
993 | {
|
---|
994 | VRDEVIDEOINDEVICEHANDLE deviceHandle;
|
---|
995 | uint32_t u32Version; /* VRDE_VIDEOIN_NEGOTIATE_VERSION */
|
---|
996 | uint32_t fu32Capabilities; /* VRDE_VIDEOIN_NEGOTIATE_CAP_* */
|
---|
997 | } VRDEVIDEOINNOTIFYATTACH;
|
---|
998 |
|
---|
999 | typedef struct VRDEVIDEOINNOTIFYDETACH
|
---|
1000 | {
|
---|
1001 | VRDEVIDEOINDEVICEHANDLE deviceHandle;
|
---|
1002 | } VRDEVIDEOINNOTIFYDETACH;
|
---|
1003 |
|
---|
1004 | /* Notification codes, */
|
---|
1005 | #define VRDE_VIDEOIN_NOTIFY_ID_ATTACH 0
|
---|
1006 | #define VRDE_VIDEOIN_NOTIFY_ID_DETACH 1
|
---|
1007 |
|
---|
1008 |
|
---|
1009 | /* Video input interface callbacks. */
|
---|
1010 | typedef struct VRDEVIDEOINCALLBACKS
|
---|
1011 | {
|
---|
1012 | /* The header. */
|
---|
1013 | VRDEINTERFACEHDR header;
|
---|
1014 |
|
---|
1015 | /* Notifications.
|
---|
1016 | *
|
---|
1017 | * @param pvCallback The callbacks context specified in VRDEGetInterface.
|
---|
1018 | * @param u32EventId The notification identifier: VRDE_VIDEOIN_NOTIFY_*.
|
---|
1019 | * @param pvData The notification specific data.
|
---|
1020 | * @param cbData The size of buffer pointed by pvData.
|
---|
1021 | */
|
---|
1022 | DECLR3CALLBACKMEMBER(void, VRDECallbackVideoInNotify,(void *pvCallback,
|
---|
1023 | uint32_t u32Id,
|
---|
1024 | const void *pvData,
|
---|
1025 | uint32_t cbData));
|
---|
1026 |
|
---|
1027 | /* Device description received from the client.
|
---|
1028 | *
|
---|
1029 | * @param pvCallback The callbacks context specified in VRDEGetInterface.
|
---|
1030 | * @param rcRequest The result code of the request.
|
---|
1031 | * @param pDeviceCtx The device context associated with the device in VRDEVideoInGetDeviceDesc.
|
---|
1032 | * @param pvUser The pvUser parameter of VRDEVideoInGetDeviceDesc.
|
---|
1033 | * @param pDeviceDesc The device description.
|
---|
1034 | * @param cbDeviceDesc The size of buffer pointed by pDevice.
|
---|
1035 | */
|
---|
1036 | DECLR3CALLBACKMEMBER(void, VRDECallbackVideoInDeviceDesc,(void *pvCallback,
|
---|
1037 | int rcRequest,
|
---|
1038 | void *pDeviceCtx,
|
---|
1039 | void *pvUser,
|
---|
1040 | const VRDEVIDEOINDEVICEDESC *pDeviceDesc,
|
---|
1041 | uint32_t cbDeviceDesc));
|
---|
1042 |
|
---|
1043 | /* Control response or notification.
|
---|
1044 | *
|
---|
1045 | * @param pvCallback The callbacks context specified in VRDEGetInterface.
|
---|
1046 | * @param rcRequest The result code of the request.
|
---|
1047 | * @param pDeviceCtx The device context associated with the device in VRDEVideoInGetDeviceDesc.
|
---|
1048 | * @param pvUser The pvUser parameter of VRDEVideoInControl. NULL if this is a notification.
|
---|
1049 | * @param pControl The control information.
|
---|
1050 | * @param cbControl The size of buffer pointed by pControl.
|
---|
1051 | */
|
---|
1052 | DECLR3CALLBACKMEMBER(void, VRDECallbackVideoInControl,(void *pvCallback,
|
---|
1053 | int rcRequest,
|
---|
1054 | void *pDeviceCtx,
|
---|
1055 | void *pvUser,
|
---|
1056 | const VRDEVIDEOINCTRLHDR *pControl,
|
---|
1057 | uint32_t cbControl));
|
---|
1058 |
|
---|
1059 | /* Frame which was received from the client.
|
---|
1060 | *
|
---|
1061 | * @param pvCallback The callbacks context specified in VRDEGetInterface.
|
---|
1062 | * @param rcRequest The result code of the request.
|
---|
1063 | * @param pDeviceCtx The device context associated with the device in VRDEVideoInGetDeviceDesc.
|
---|
1064 | * @param pFrame The frame data.
|
---|
1065 | * @param cbFrame The size of buffer pointed by pFrame.
|
---|
1066 | */
|
---|
1067 | DECLR3CALLBACKMEMBER(void, VRDECallbackVideoInFrame,(void *pvCallback,
|
---|
1068 | int rcRequest,
|
---|
1069 | void *pDeviceCtx,
|
---|
1070 | const VRDEVIDEOINPAYLOADHDR *pFrame,
|
---|
1071 | uint32_t cbFrame));
|
---|
1072 |
|
---|
1073 | } VRDEVIDEOINCALLBACKS;
|
---|
1074 | #endif /* VRDE_VIDEOIN_WITH_VRDEINTERFACE */
|
---|
1075 |
|
---|
1076 | #pragma pack()
|
---|
1077 |
|
---|
1078 | #endif
|
---|