VirtualBox

source: vbox/trunk/include/VBox/RemoteDesktop/VRDEVideoIn.h@ 48466

最後變更 在這個檔案從48466是 48466,由 vboxsync 提交於 12 年 前

include,Extpacks/Puel/UsbWebcam: Windows host webcam backend: report framerates, simpler frame description format.
  • 屬性 svn:eol-style 設為 native
  • 屬性 svn:keywords 設為 Author Date Id Revision
檔案大小: 43.0 KB
行 
1/** @file
2 * VBox Remote Desktop Extension (VRDE) - Video Input interface.
3 */
4
5/*
6 * Copyright (C) 2012-2013 Oracle Corporation
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.alldomusa.eu.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
165typedef 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/* The video format descriptor. */
225typedef struct VRDEVIDEOINFORMATDESC
226{
227 uint16_t cbFormat; /* Size of the structure including cbFormat and format specific data. */
228 uint8_t u8FormatId; /* The unique identifier of the format on the client. */
229 uint8_t u8FormatType; /* MJPEG etc. VRDE_VIDEOIN_FORMAT_* */
230 uint8_t u8FormatFlags; /* VRDE_VIDEOIN_F_FMT_* */
231 uint8_t u8NumFrames; /* Number of following VRDEVIDEOINFRAMEDESC structures. */
232 uint16_t u16Reserved; /* Must be set to 0. */
233 /* Other format specific data may follow. */
234 /* An array of VRDEVIDEOINFRAMEDESC follows. */
235} VRDEVIDEOINFORMATDESC;
236
237/* VRDEVIDEOINFORMATDESC::u8FormatType */
238#define VRDE_VIDEOIN_FORMAT_UNCOMPRESSED 0x04
239#define VRDE_VIDEOIN_FORMAT_MJPEG 0x06
240#define VRDE_VIDEOIN_FORMAT_MPEG2TS 0x0A
241#define VRDE_VIDEOIN_FORMAT_DV 0x0C
242#define VRDE_VIDEOIN_FORMAT_FRAME_BASED 0x10
243#define VRDE_VIDEOIN_FORMAT_STREAM_BASED 0x12
244
245/* VRDEVIDEOINFORMATDESC::u8FormatFlags. */
246#define VRDE_VIDEOIN_F_FMT_GENERATEKEYFRAME 0x01 /* Supports Generate Key Frame */
247#define VRDE_VIDEOIN_F_FMT_UPDATEFRAMESEGMENT 0x02 /* Supports Update Frame Segment */
248#define VRDE_VIDEOIN_F_FMT_COPYPROTECT 0x04 /* If duplication should be restricted. */
249#define VRDE_VIDEOIN_F_FMT_COMPQUALITY 0x08 /* If the format supports an adjustable compression quality. */
250
251typedef struct VRDEVIDEOINFRAMEDESC
252{
253 uint16_t cbFrame; /* Size of the structure including cbFrame and frame specific data. */
254 uint8_t u8FrameId; /* The unique identifier of the frame for the corresponding format on the client. */
255 uint8_t u8FrameFlags;
256 uint16_t u16Width;
257 uint16_t u16Height;
258 uint32_t u32NumFrameIntervals; /* The number of supported frame intervals. */
259 uint32_t u32MinFrameInterval; /* Shortest frame interval supported (at highest frame rate), in 100ns units. */
260 uint32_t u32MaxFrameInterval; /* Longest frame interval supported (at lowest frame rate), in 100ns units. */
261 /* Supported frame intervals (in 100ns units) follow if VRDE_VIDEOIN_F_FRM_DISCRETE_INTERVALS is set.
262 * uint32_t au32FrameIntervals[u32NumFrameIntervals];
263 */
264 /* Supported min and max bitrate in bits per second follow if VRDE_VIDEOIN_F_FRM_BITRATE is set.
265 * uint32_t u32MinBitRate;
266 * uint32_t u32MaxBitRate;
267 */
268 /* Other frame specific data may follow. */
269} VRDEVIDEOINFRAMEDESC;
270
271/* VRDEVIDEOINFRAMEDESC::u8FrameFlags. */
272#define VRDE_VIDEOIN_F_FRM_STILL 0x01 /* If still images are supported for this frame. */
273#define VRDE_VIDEOIN_F_FRM_DISCRETE_INTERVALS 0x02 /* If the discrete intervals list is included. */
274#define VRDE_VIDEOIN_F_FRM_BITRATE 0x04 /* If the bitrate fields are included. */
275#define VRDE_VIDEOIN_F_FRM_SIZE_OF_FIELDS 0x08 /* If the all optional fields start with 16 bit field size. */
276
277/*
278 * Controls.
279 *
280 * The same structures are used for both SET and GET requests.
281 * Requests are async. A callback is invoked, when the client returns a reply.
282 * A control change notification also uses these structures.
283 *
284 * If a control request can not be fulfilled, then VRDE_VIDEOIN_CTRLHDR_F_FAIL
285 * will be set and u8Status contains the error code. This replaces the VC_REQUEST_ERROR_CODE_CONTROL.
286 *
287 * If the client receives an unsupported control, then the client must ignore it.
288 * That is the control request must not affect the client in any way.
289 * The client may send a VRDEVIDEOINCTRLHDR response for the unsupported control with:
290 * u16ControlSelector = the received value;
291 * u16RequestType = the received value;
292 * u16ParmSize = 0;
293 * u8Flags = VRDE_VIDEOIN_CTRLHDR_F_FAIL;
294 * u8Status = VRDE_VIDEOIN_CTRLHDR_STATUS_INVALIDCONTROL;
295 */
296
297typedef struct VRDEVIDEOINCTRLHDR
298{
299 uint16_t u16ControlSelector; /* VRDE_VIDEOIN_CTRLSEL_* */
300 uint16_t u16RequestType; /* VRDE_VIDEOIN_CTRLREQ_* */
301 uint16_t u16ParmSize; /* The size of the control specific parameters. */
302 uint8_t u8Flags; /* VRDE_VIDEOIN_CTRLHDR_F_* */
303 uint8_t u8Status; /* VRDE_VIDEOIN_CTRLHDR_STATUS_* */
304 /* Control specific data follows. */
305} VRDEVIDEOINCTRLHDR;
306
307/* Control request types: VRDEVIDEOINCTRLHDR::u16RequestType. */
308#define VRDE_VIDEOIN_CTRLREQ_UNDEFINED 0x00
309#define VRDE_VIDEOIN_CTRLREQ_SET_CUR 0x01
310#define VRDE_VIDEOIN_CTRLREQ_GET_CUR 0x81
311#define VRDE_VIDEOIN_CTRLREQ_GET_MIN 0x82
312#define VRDE_VIDEOIN_CTRLREQ_GET_MAX 0x83
313#define VRDE_VIDEOIN_CTRLREQ_GET_RES 0x84
314#define VRDE_VIDEOIN_CTRLREQ_GET_LEN 0x85
315#define VRDE_VIDEOIN_CTRLREQ_GET_INFO 0x86
316#define VRDE_VIDEOIN_CTRLREQ_GET_DEF 0x87
317
318/* VRDEVIDEOINCTRLHDR::u8Flags */
319#define VRDE_VIDEOIN_CTRLHDR_F_NOTIFY 0x01 /* Control change notification, the attribute is derived from u16RequestType and F_FAIL. */
320#define VRDE_VIDEOIN_CTRLHDR_F_FAIL 0x02 /* The operation failed. Error code is in u8Status. */
321
322/* VRDEVIDEOINCTRLHDR::u8Status if the VRDE_VIDEOIN_CTRLHDR_F_FAIL is set. */
323#define VRDE_VIDEOIN_CTRLHDR_STATUS_SUCCESS 0x00 /**/
324#define VRDE_VIDEOIN_CTRLHDR_STATUS_NOTREADY 0x01 /* Not ready */
325#define VRDE_VIDEOIN_CTRLHDR_STATUS_WRONGSTATE 0x02 /* Wrong state */
326#define VRDE_VIDEOIN_CTRLHDR_STATUS_POWER 0x03 /* Power */
327#define VRDE_VIDEOIN_CTRLHDR_STATUS_OUTOFRANGE 0x04 /* Out of range */
328#define VRDE_VIDEOIN_CTRLHDR_STATUS_INVALIDUNIT 0x05 /* Invalid unit */
329#define VRDE_VIDEOIN_CTRLHDR_STATUS_INVALIDCONTROL 0x06 /* Invalid control */
330#define VRDE_VIDEOIN_CTRLHDR_STATUS_INVALIDREQUEST 0x07 /* Invalid request */
331#define VRDE_VIDEOIN_CTRLHDR_STATUS_UNKNOWN 0xFF /* Unknown */
332
333/* Control selectors. 16 bit. High byte is the category. Low byte is the identifier.*/
334#ifdef RT_MAKE_U16
335#define VRDE_VIDEOIN_CTRLSEL_MAKE(Lo, Hi) RT_MAKE_U16(Lo, Hi)
336#else
337#define VRDE_VIDEOIN_CTRLSEL_MAKE(Lo, Hi) ((uint16_t)( (uint16_t)((uint8_t)(Hi)) << 8 | (uint8_t)(Lo) ))
338#endif
339
340#define VRDE_VIDEOIN_CTRLSEL_VC(a) VRDE_VIDEOIN_CTRLSEL_MAKE(a, 0x01)
341#define VRDE_VIDEOIN_CTRLSEL_CT(a) VRDE_VIDEOIN_CTRLSEL_MAKE(a, 0x02)
342#define VRDE_VIDEOIN_CTRLSEL_PU(a) VRDE_VIDEOIN_CTRLSEL_MAKE(a, 0x03)
343#define VRDE_VIDEOIN_CTRLSEL_VS(a) VRDE_VIDEOIN_CTRLSEL_MAKE(a, 0x04)
344#define VRDE_VIDEOIN_CTRLSEL_HW(a) VRDE_VIDEOIN_CTRLSEL_MAKE(a, 0x05)
345#define VRDE_VIDEOIN_CTRLSEL_PROT(a) VRDE_VIDEOIN_CTRLSEL_MAKE(a, 0x06)
346
347#define VRDE_VIDEOIN_CTRLSEL_VC_VIDEO_POWER_MODE_CONTROL VRDE_VIDEOIN_CTRLSEL_VC(0x01)
348
349#define VRDE_VIDEOIN_CTRLSEL_CT_UNDEFINED VRDE_VIDEOIN_CTRLSEL_CT(0x00)
350#define VRDE_VIDEOIN_CTRLSEL_CT_SCANNING_MODE VRDE_VIDEOIN_CTRLSEL_CT(0x01)
351#define VRDE_VIDEOIN_CTRLSEL_CT_AE_MODE VRDE_VIDEOIN_CTRLSEL_CT(0x02)
352#define VRDE_VIDEOIN_CTRLSEL_CT_AE_PRIORITY VRDE_VIDEOIN_CTRLSEL_CT(0x03)
353#define VRDE_VIDEOIN_CTRLSEL_CT_EXPOSURE_TIME_ABSOLUTE VRDE_VIDEOIN_CTRLSEL_CT(0x04)
354#define VRDE_VIDEOIN_CTRLSEL_CT_EXPOSURE_TIME_RELATIVE VRDE_VIDEOIN_CTRLSEL_CT(0x05)
355#define VRDE_VIDEOIN_CTRLSEL_CT_FOCUS_ABSOLUTE VRDE_VIDEOIN_CTRLSEL_CT(0x06)
356#define VRDE_VIDEOIN_CTRLSEL_CT_FOCUS_RELATIVE VRDE_VIDEOIN_CTRLSEL_CT(0x07)
357#define VRDE_VIDEOIN_CTRLSEL_CT_FOCUS_AUTO VRDE_VIDEOIN_CTRLSEL_CT(0x08)
358#define VRDE_VIDEOIN_CTRLSEL_CT_IRIS_ABSOLUTE VRDE_VIDEOIN_CTRLSEL_CT(0x09)
359#define VRDE_VIDEOIN_CTRLSEL_CT_IRIS_RELATIVE VRDE_VIDEOIN_CTRLSEL_CT(0x0A)
360#define VRDE_VIDEOIN_CTRLSEL_CT_ZOOM_ABSOLUTE VRDE_VIDEOIN_CTRLSEL_CT(0x0B)
361#define VRDE_VIDEOIN_CTRLSEL_CT_ZOOM_RELATIVE VRDE_VIDEOIN_CTRLSEL_CT(0x0C)
362#define VRDE_VIDEOIN_CTRLSEL_CT_PANTILT_ABSOLUTE VRDE_VIDEOIN_CTRLSEL_CT(0x0D)
363#define VRDE_VIDEOIN_CTRLSEL_CT_PANTILT_RELATIVE VRDE_VIDEOIN_CTRLSEL_CT(0x0E)
364#define VRDE_VIDEOIN_CTRLSEL_CT_ROLL_ABSOLUTE VRDE_VIDEOIN_CTRLSEL_CT(0x0F)
365#define VRDE_VIDEOIN_CTRLSEL_CT_ROLL_RELATIVE VRDE_VIDEOIN_CTRLSEL_CT(0x10)
366#define VRDE_VIDEOIN_CTRLSEL_CT_PRIVACY VRDE_VIDEOIN_CTRLSEL_CT(0x11)
367
368#define VRDE_VIDEOIN_CTRLSEL_PU_UNDEFINED VRDE_VIDEOIN_CTRLSEL_PU(0x00)
369#define VRDE_VIDEOIN_CTRLSEL_PU_BACKLIGHT_COMPENSATION VRDE_VIDEOIN_CTRLSEL_PU(0x01)
370#define VRDE_VIDEOIN_CTRLSEL_PU_BRIGHTNESS VRDE_VIDEOIN_CTRLSEL_PU(0x02)
371#define VRDE_VIDEOIN_CTRLSEL_PU_CONTRAST VRDE_VIDEOIN_CTRLSEL_PU(0x03)
372#define VRDE_VIDEOIN_CTRLSEL_PU_GAIN VRDE_VIDEOIN_CTRLSEL_PU(0x04)
373#define VRDE_VIDEOIN_CTRLSEL_PU_POWER_LINE_FREQUENCY VRDE_VIDEOIN_CTRLSEL_PU(0x05)
374#define VRDE_VIDEOIN_CTRLSEL_PU_HUE VRDE_VIDEOIN_CTRLSEL_PU(0x06)
375#define VRDE_VIDEOIN_CTRLSEL_PU_SATURATION VRDE_VIDEOIN_CTRLSEL_PU(0x07)
376#define VRDE_VIDEOIN_CTRLSEL_PU_SHARPNESS VRDE_VIDEOIN_CTRLSEL_PU(0x08)
377#define VRDE_VIDEOIN_CTRLSEL_PU_GAMMA VRDE_VIDEOIN_CTRLSEL_PU(0x09)
378#define VRDE_VIDEOIN_CTRLSEL_PU_WHITE_BALANCE_TEMPERATURE VRDE_VIDEOIN_CTRLSEL_PU(0x0A)
379#define VRDE_VIDEOIN_CTRLSEL_PU_WHITE_BALANCE_TEMPERATURE_AUTO VRDE_VIDEOIN_CTRLSEL_PU(0x0B)
380#define VRDE_VIDEOIN_CTRLSEL_PU_WHITE_BALANCE_COMPONENT VRDE_VIDEOIN_CTRLSEL_PU(0x0C)
381#define VRDE_VIDEOIN_CTRLSEL_PU_WHITE_BALANCE_COMPONENT_AUTO VRDE_VIDEOIN_CTRLSEL_PU(0x0D)
382#define VRDE_VIDEOIN_CTRLSEL_PU_DIGITAL_MULTIPLIER VRDE_VIDEOIN_CTRLSEL_PU(0x0E)
383#define VRDE_VIDEOIN_CTRLSEL_PU_DIGITAL_MULTIPLIER_LIMIT VRDE_VIDEOIN_CTRLSEL_PU(0x0F)
384#define VRDE_VIDEOIN_CTRLSEL_PU_HUE_AUTO VRDE_VIDEOIN_CTRLSEL_PU(0x10)
385#define VRDE_VIDEOIN_CTRLSEL_PU_ANALOG_VIDEO_STANDARD VRDE_VIDEOIN_CTRLSEL_PU(0x11)
386#define VRDE_VIDEOIN_CTRLSEL_PU_ANALOG_LOCK_STATUS VRDE_VIDEOIN_CTRLSEL_PU(0x12)
387
388#define VRDE_VIDEOIN_CTRLSEL_VS_UNDEFINED VRDE_VIDEOIN_CTRLSEL_VS(0x00)
389#define VRDE_VIDEOIN_CTRLSEL_VS_SETUP VRDE_VIDEOIN_CTRLSEL_VS(0x01)
390#define VRDE_VIDEOIN_CTRLSEL_VS_OFF VRDE_VIDEOIN_CTRLSEL_VS(0x02)
391#define VRDE_VIDEOIN_CTRLSEL_VS_ON VRDE_VIDEOIN_CTRLSEL_VS(0x03)
392#define VRDE_VIDEOIN_CTRLSEL_VS_STILL_IMAGE_TRIGGER VRDE_VIDEOIN_CTRLSEL_VS(0x05)
393#define VRDE_VIDEOIN_CTRLSEL_VS_STREAM_ERROR_CODE VRDE_VIDEOIN_CTRLSEL_VS(0x06)
394#define VRDE_VIDEOIN_CTRLSEL_VS_GENERATE_KEY_FRAME VRDE_VIDEOIN_CTRLSEL_VS(0x07)
395#define VRDE_VIDEOIN_CTRLSEL_VS_UPDATE_FRAME_SEGMENT VRDE_VIDEOIN_CTRLSEL_VS(0x08)
396#define VRDE_VIDEOIN_CTRLSEL_VS_SYNCH_DELAY VRDE_VIDEOIN_CTRLSEL_VS(0x09)
397
398#define VRDE_VIDEOIN_CTRLSEL_HW_BUTTON VRDE_VIDEOIN_CTRLSEL_HW(0x01)
399
400#define VRDE_VIDEOIN_CTRLSEL_PROT_PING VRDE_VIDEOIN_CTRLSEL_PROT(0x01)
401#define VRDE_VIDEOIN_CTRLSEL_PROT_SAMPLING VRDE_VIDEOIN_CTRLSEL_PROT(0x02)
402#define VRDE_VIDEOIN_CTRLSEL_PROT_FRAMES VRDE_VIDEOIN_CTRLSEL_PROT(0x03)
403
404typedef struct VRDEVIDEOINCTRL_VIDEO_POWER_MODE
405{
406 VRDEVIDEOINCTRLHDR hdr;
407 uint8_t u8DevicePowerMode;
408} VRDEVIDEOINCTRL_VIDEO_POWER_MODE;
409
410typedef struct VRDEVIDEOINCTRL_CT_SCANNING_MODE
411{
412 VRDEVIDEOINCTRLHDR hdr;
413 uint8_t u8ScanningMode;
414} VRDEVIDEOINCTRL_CT_SCANNING_MODE;
415
416typedef struct VRDEVIDEOINCTRL_CT_AE_MODE
417{
418 VRDEVIDEOINCTRLHDR hdr;
419 uint8_t u8AutoExposureMode;
420} VRDEVIDEOINCTRL_CT_AE_MODE;
421
422typedef struct VRDEVIDEOINCTRL_CT_AE_PRIORITY
423{
424 VRDEVIDEOINCTRLHDR hdr;
425 uint8_t u8AutoExposurePriority;
426} VRDEVIDEOINCTRL_CT_AE_PRIORITY;
427
428typedef struct VRDEVIDEOINCTRL_CT_EXPOSURE_TIME_ABSOLUTE
429{
430 VRDEVIDEOINCTRLHDR hdr;
431 uint32_t u32ExposureTimeAbsolute;
432} VRDEVIDEOINCTRL_CT_EXPOSURE_TIME_ABSOLUTE;
433
434typedef struct VRDEVIDEOINCTRL_CT_EXPOSURE_TIME_RELATIVE
435{
436 VRDEVIDEOINCTRLHDR hdr;
437 uint8_t u8ExposureTimeRelative;
438} VRDEVIDEOINCTRL_CT_EXPOSURE_TIME_RELATIVE;
439
440typedef struct VRDEVIDEOINCTRL_CT_FOCUS_ABSOLUTE
441{
442 VRDEVIDEOINCTRLHDR hdr;
443 uint16_t u16FocusAbsolute;
444} VRDEVIDEOINCTRL_CT_FOCUS_ABSOLUTE;
445
446typedef struct VRDEVIDEOINCTRL_CT_FOCUS_RELATIVE
447{
448 VRDEVIDEOINCTRLHDR hdr;
449 uint8_t u8FocusRelative;
450 uint8_t u8Speed;
451} VRDEVIDEOINCTRL_CT_FOCUS_RELATIVE;
452
453typedef struct VRDEVIDEOINCTRL_CT_FOCUS_AUTO
454{
455 VRDEVIDEOINCTRLHDR hdr;
456 uint8_t u8FocusAuto;
457} VRDEVIDEOINCTRL_CT_FOCUS_AUTO;
458
459typedef struct VRDEVIDEOINCTRL_CT_IRIS_ABSOLUTE
460{
461 VRDEVIDEOINCTRLHDR hdr;
462 uint16_t u16IrisAbsolute;
463} VRDEVIDEOINCTRL_CT_IRIS_ABSOLUTE;
464
465typedef struct VRDEVIDEOINCTRL_CT_IRIS_RELATIVE
466{
467 VRDEVIDEOINCTRLHDR hdr;
468 uint8_t u8IrisRelative;
469} VRDEVIDEOINCTRL_CT_IRIS_RELATIVE;
470
471typedef struct VRDEVIDEOINCTRL_CT_ZOOM_ABSOLUTE
472{
473 VRDEVIDEOINCTRLHDR hdr;
474 uint16_t u16ZoomAbsolute;
475} VRDEVIDEOINCTRL_CT_ZOOM_ABSOLUTE;
476
477typedef struct VRDEVIDEOINCTRL_CT_ZOOM_RELATIVE
478{
479 VRDEVIDEOINCTRLHDR hdr;
480 uint8_t u8Zoom;
481 uint8_t u8DigitalZoom;
482 uint8_t u8Speed;
483} VRDEVIDEOINCTRL_CT_ZOOM_RELATIVE;
484
485typedef struct VRDEVIDEOINCTRL_CT_PANTILT_ABSOLUTE
486{
487 VRDEVIDEOINCTRLHDR hdr;
488 uint32_t u32PanAbsolute;
489 uint32_t u32TiltAbsolute;
490} VRDEVIDEOINCTRL_CT_PANTILT_ABSOLUTE;
491
492typedef struct VRDEVIDEOINCTRL_CT_PANTILT_RELATIVE
493{
494 VRDEVIDEOINCTRLHDR hdr;
495 uint8_t u8PanRelative;
496 uint8_t u8PanSpeed;
497 uint8_t u8TiltRelative;
498 uint8_t u8TiltSpeed;
499} VRDEVIDEOINCTRL_CT_PANTILT_RELATIVE;
500
501typedef struct VRDEVIDEOINCTRL_CT_ROLL_ABSOLUTE
502{
503 VRDEVIDEOINCTRLHDR hdr;
504 uint16_t u16RollAbsolute;
505} VRDEVIDEOINCTRL_CT_ROLL_ABSOLUTE;
506
507typedef struct VRDEVIDEOINCTRL_CT_ROLL_RELATIVE
508{
509 VRDEVIDEOINCTRLHDR hdr;
510 uint8_t u8RollRelative;
511 uint8_t u8Speed;
512} VRDEVIDEOINCTRL_CT_ROLL_RELATIVE;
513
514typedef struct VRDEVIDEOINCTRL_CT_PRIVACY_MODE
515{
516 VRDEVIDEOINCTRLHDR hdr;
517 uint8_t u8Privacy;
518} VRDEVIDEOINCTRL_CT_PRIVACY_MODE;
519
520typedef struct VRDEVIDEOINCTRL_PU_BACKLIGHT_COMPENSATION
521{
522 VRDEVIDEOINCTRLHDR hdr;
523 uint16_t u16BacklightCompensation;
524} VRDEVIDEOINCTRL_PU_BACKLIGHT_COMPENSATION;
525
526typedef struct VRDEVIDEOINCTRL_PU_BRIGHTNESS
527{
528 VRDEVIDEOINCTRLHDR hdr;
529 uint16_t u16Brightness;
530} VRDEVIDEOINCTRL_PU_BRIGHTNESS;
531
532typedef struct VRDEVIDEOINCTRL_PU_CONTRAST
533{
534 VRDEVIDEOINCTRLHDR hdr;
535 uint16_t u16Contrast;
536} VRDEVIDEOINCTRL_PU_CONTRAST;
537
538typedef struct VRDEVIDEOINCTRL_PU_GAIN
539{
540 VRDEVIDEOINCTRLHDR hdr;
541 uint16_t u16Gain;
542} VRDEVIDEOINCTRL_PU_GAIN;
543
544typedef struct VRDEVIDEOINCTRL_PU_POWER_LINE_FREQUENCY
545{
546 VRDEVIDEOINCTRLHDR hdr;
547 uint16_t u16PowerLineFrequency;
548} VRDEVIDEOINCTRL_PU_POWER_LINE_FREQUENCY;
549
550typedef struct VRDEVIDEOINCTRL_PU_HUE
551{
552 VRDEVIDEOINCTRLHDR hdr;
553 uint16_t u16Hue;
554} VRDEVIDEOINCTRL_PU_HUE;
555
556typedef struct VRDEVIDEOINCTRL_PU_HUE_AUTO
557{
558 VRDEVIDEOINCTRLHDR hdr;
559 uint8_t u8HueAuto;
560} VRDEVIDEOINCTRL_PU_HUE_AUTO;
561
562typedef struct VRDEVIDEOINCTRL_PU_SATURATION
563{
564 VRDEVIDEOINCTRLHDR hdr;
565 uint16_t u16Saturation;
566} VRDEVIDEOINCTRL_PU_SATURATION;
567
568typedef struct VRDEVIDEOINCTRL_PU_SHARPNESS
569{
570 VRDEVIDEOINCTRLHDR hdr;
571 uint16_t u16Sharpness;
572} VRDEVIDEOINCTRL_PU_SHARPNESS;
573
574typedef struct VRDEVIDEOINCTRL_PU_GAMMA
575{
576 VRDEVIDEOINCTRLHDR hdr;
577 uint16_t u16Gamma;
578} VRDEVIDEOINCTRL_PU_GAMMA;
579
580typedef struct VRDEVIDEOINCTRL_PU_WHITE_BALANCE_TEMPERATURE
581{
582 VRDEVIDEOINCTRLHDR hdr;
583 uint16_t u16WhiteBalanceTemperature;
584} VRDEVIDEOINCTRL_PU_WHITE_BALANCE_TEMPERATURE;
585
586typedef struct VRDEVIDEOINCTRL_PU_WHITE_BALANCE_TEMPERATURE_AUTO
587{
588 VRDEVIDEOINCTRLHDR hdr;
589 uint8_t u8WhiteBalanceTemperatureAuto;
590} VRDEVIDEOINCTRL_PU_WHITE_BALANCE_TEMPERATURE_AUTO;
591
592typedef struct VRDEVIDEOINCTRL_PU_WHITE_BALANCE_COMPONENT
593{
594 VRDEVIDEOINCTRLHDR hdr;
595 uint16_t u16WhiteBalanceBlue;
596 uint16_t u16WhiteBalanceRed;
597} VRDEVIDEOINCTRL_PU_WHITE_BALANCE_COMPONENT;
598
599typedef struct VRDEVIDEOINCTRL_PU_WHITE_BALANCE_COMPONENT_AUTO
600{
601 VRDEVIDEOINCTRLHDR hdr;
602 uint8_t u8WhiteBalanceComponentAuto;
603} VRDEVIDEOINCTRL_PU_WHITE_BALANCE_COMPONENT_AUTO;
604
605typedef struct VRDEVIDEOINCTRL_PU_DIGITAL_MULTIPLIER
606{
607 VRDEVIDEOINCTRLHDR hdr;
608 uint16_t u16MultiplierStep;
609} VRDEVIDEOINCTRL_PU_DIGITAL_MULTIPLIER;
610
611typedef struct VRDEVIDEOINCTRL_PU_DIGITAL_MULTIPLIER_LIMIT
612{
613 VRDEVIDEOINCTRLHDR hdr;
614 uint16_t u16MultiplierLimit;
615} VRDEVIDEOINCTRL_PU_DIGITAL_MULTIPLIER_LIMIT;
616
617typedef struct VRDEVIDEOINCTRL_PU_ANALOG_VIDEO_STANDARD
618{
619 VRDEVIDEOINCTRLHDR hdr;
620 uint8_t u8VideoStandard;
621} VRDEVIDEOINCTRL_PU_ANALOG_VIDEO_STANDARD;
622
623typedef struct VRDEVIDEOINCTRL_PU_ANALOG_LOCK_STATUS
624{
625 VRDEVIDEOINCTRLHDR hdr;
626 uint8_t u8Status;
627} VRDEVIDEOINCTRL_PU_ANALOG_LOCK_STATUS;
628
629/* Set streaming parameters. The actual streaming will be enabled by VS_ON. */
630#define VRDEVIDEOINCTRL_F_VS_SETUP_FID 0x01
631#define VRDEVIDEOINCTRL_F_VS_SETUP_EOF 0x02
632
633typedef struct VRDEVIDEOINCTRL_VS_SETUP
634{
635 VRDEVIDEOINCTRLHDR hdr;
636 uint8_t u8FormatId; /* The format id on the client: VRDEVIDEOINFORMATDESC::u8FormatId. */
637 uint8_t u8FramingInfo; /* VRDEVIDEOINCTRL_F_VS_SETUP_*. Set by the client. */
638 uint16_t u16Width;
639 uint16_t u16Height;
640 uint32_t u32FrameInterval; /* Frame interval in 100 ns units, 0 means a still image capture.
641 * The client may choose a different interval if this value is
642 * not supported.
643 */
644 uint16_t u16CompQuality; /* 0 .. 10000 = 0 .. 100%.
645 * Applicable if the format has VRDE_VIDEOIN_F_FMT_COMPQUALITY,
646 * otherwise this field is ignored.
647 */
648 uint16_t u16Delay; /* Latency in ms from video data capture to presentation on the channel.
649 * Set by the client, read by the server.
650 */
651 uint32_t u32ClockFrequency; /* @todo just all clocks in 100ns units? */
652} VRDEVIDEOINCTRL_VS_SETUP;
653
654/* Stop sending video frames. */
655typedef struct VRDEVIDEOINCTRL_VS_OFF
656{
657 VRDEVIDEOINCTRLHDR hdr;
658} VRDEVIDEOINCTRL_VS_OFF;
659
660/* Start sending video frames with parameters set by VS_SETUP. */
661typedef struct VRDEVIDEOINCTRL_VS_ON
662{
663 VRDEVIDEOINCTRLHDR hdr;
664} VRDEVIDEOINCTRL_VS_ON;
665
666typedef struct VRDEVIDEOINCTRL_VS_STILL_IMAGE_TRIGGER
667{
668 VRDEVIDEOINCTRLHDR hdr;
669 uint8_t u8Trigger;
670} VRDEVIDEOINCTRL_VS_STILL_IMAGE_TRIGGER;
671
672typedef struct VRDEVIDEOINCTRL_VS_STREAM_ERROR_CODE
673{
674 VRDEVIDEOINCTRLHDR hdr;
675 uint8_t u8StreamErrorCode;
676} VRDEVIDEOINCTRL_VS_STREAM_ERROR_CODE;
677
678typedef struct VRDEVIDEOINCTRL_VS_GENERATE_KEY_FRAME
679{
680 VRDEVIDEOINCTRLHDR hdr;
681 uint8_t u8GenerateKeyFrame;
682} VRDEVIDEOINCTRL_VS_GENERATE_KEY_FRAME;
683
684typedef struct VRDEVIDEOINCTRL_VS_UPDATE_FRAME_SEGMENT
685{
686 VRDEVIDEOINCTRLHDR hdr;
687 uint8_t u8StartFrameSegment;
688 uint8_t u8EndFrameSegment;
689} VRDEVIDEOINCTRL_VS_UPDATE_FRAME_SEGMENT;
690
691typedef struct VRDEVIDEOINCTRL_VS_SYNCH_DELAY
692{
693 VRDEVIDEOINCTRLHDR hdr;
694 uint16_t u16Delay;
695} VRDEVIDEOINCTRL_VS_SYNCH_DELAY;
696
697/* A hardware button was pressed/released on the device. */
698typedef struct VRDEVIDEOINCTRL_HW_BUTTON
699{
700 VRDEVIDEOINCTRLHDR hdr;
701 uint8_t u8Pressed;
702} VRDEVIDEOINCTRL_HW_BUTTON;
703
704typedef struct VRDEVIDEOINCTRL_PROT_PING
705{
706 VRDEVIDEOINCTRLHDR hdr;
707 uint32_t u32Timestamp; /* Set in the request and the same value must be send back in the response. */
708} VRDEVIDEOINCTRL_PROT_PING;
709
710typedef struct VRDEVIDEOINCTRL_PROT_SAMPLING
711{
712 VRDEVIDEOINCTRLHDR hdr;
713 uint32_t fu32SampleStart; /* Which parameters must be sampled VRDEVIDEOINCTRL_F_PROT_SAMPLING_*. */
714 uint32_t fu32SampleStop; /* Which parameters to disable VRDEVIDEOINCTRL_F_PROT_SAMPLING_*.
715 * If both Start and Stop is set, then restart the sampling.
716 */
717 uint32_t u32PeriodMS; /* Sampling period in milliseconds. Applies to all samples in fu32SampleStart.
718 * Not mandatory, the actual sampling period may be different.
719 */
720} VRDEVIDEOINCTRL_PROT_SAMPLING;
721
722#define VRDEVIDEOINCTRL_F_PROT_SAMPLING_FRAMES_SOURCE 0x00000001 /* Periodic VRDEVIDEOINCTRL_PROT_FRAMES samples */
723#define VRDEVIDEOINCTRL_F_PROT_SAMPLING_FRAMES_CLIENT_OUT 0x00000002 /* Periodic VRDEVIDEOINCTRL_PROT_FRAMES samples */
724
725typedef struct VRDEVIDEOINCTRL_PROT_FRAMES
726{
727 VRDEVIDEOINCTRLHDR hdr; /* Note: the message should be sent as VRDE_VIDEOIN_FN_CONTROL_NOTIFY. */
728 uint32_t u32Sample; /* Which sample is this, one of VRDEVIDEOINCTRL_F_PROT_SAMPLING_*. */
729 uint32_t u32TimestampMS; /* When the period started, milliseconds since the start of sampling. */
730 uint32_t u32PeriodMS; /* Actual period during which the frames were counted in milliseconds.
731 * This may be different from VRDEVIDEOINCTRL_PROT_SAMPLING::u32PeriodMS.
732 */
733 uint32_t u32FramesCount; /* How many frames per u32PeriodMS milliseconds. */
734} VRDEVIDEOINCTRL_PROT_FRAMES;
735
736
737/*
738 * Payload transfers. How frames are sent to the server:
739 * the client send a PAYLOAD packet, which has the already set format.
740 * The server enables the transfers by sending VRDEVIDEOINCTRL_VS_ON.
741 */
742
743/* Payload header */
744typedef struct VRDEVIDEOINPAYLOADHDR
745{
746 uint8_t u8HeaderLength; /* Entire header. */
747 uint8_t u8HeaderInfo; /* VRDE_VIDEOIN_PAYLOAD_F_* */
748 uint32_t u32PresentationTime; /* @todo define this */
749 uint32_t u32SourceTimeClock; /* @todo At the moment when the frame was sent to the channel.
750 * Allows the server to measure clock drift.
751 */
752 uint16_t u16Reserved; /* @todo */
753} VRDEVIDEOINPAYLOADHDR;
754
755/* VRDEVIDEOINPAYLOADHDR::u8HeaderInfo */
756#define VRDE_VIDEOIN_PAYLOAD_F_FID 0x01 /* Frame ID */
757#define VRDE_VIDEOIN_PAYLOAD_F_EOF 0x02 /* End of Frame */
758#define VRDE_VIDEOIN_PAYLOAD_F_PTS 0x04 /* Presentation Time */
759#define VRDE_VIDEOIN_PAYLOAD_F_SCR 0x08 /* Source Clock Reference */
760#define VRDE_VIDEOIN_PAYLOAD_F_RES 0x10 /* Reserved */
761#define VRDE_VIDEOIN_PAYLOAD_F_STI 0x20 /* Still Image */
762#define VRDE_VIDEOIN_PAYLOAD_F_ERR 0x40 /* Error */
763#define VRDE_VIDEOIN_PAYLOAD_F_EOH 0x80 /* End of header */
764
765
766/*
767 * The network channel specification.
768 */
769
770/*
771 * The protocol uses a dynamic RDP channel.
772 * Everything is little-endian.
773 */
774
775/* The dynamic RDP channel name. */
776#define VRDE_VIDEOIN_CHANNEL "RVIDEOIN"
777
778/* Major functions. */
779#define VRDE_VIDEOIN_FN_NEGOTIATE 0x0000 /* Version and capabilities check. */
780#define VRDE_VIDEOIN_FN_NOTIFY 0x0001 /* Device attach/detach from the client. */
781#define VRDE_VIDEOIN_FN_DEVICEDESC 0x0002 /* Query device description. */
782#define VRDE_VIDEOIN_FN_CONTROL 0x0003 /* Control the device and start/stop video input.
783 * This function is used for sending a request and
784 * the corresponding response.
785 */
786#define VRDE_VIDEOIN_FN_CONTROL_NOTIFY 0x0004 /* The client reports a control change, etc.
787 * This function indicated that the message is
788 * not a response to a CONTROL request.
789 */
790#define VRDE_VIDEOIN_FN_FRAME 0x0005 /* Frame from the client. */
791
792/* Status codes. */
793#define VRDE_VIDEOIN_STATUS_SUCCESS 0 /* Function completed successfully. */
794#define VRDE_VIDEOIN_STATUS_FAILED 1 /* Failed for some reason. */
795
796typedef struct VRDEVIDEOINMSGHDR
797{
798 uint32_t u32Length; /* The length of the message in bytes, including the header. */
799 uint32_t u32DeviceId; /* The client's device id. */
800 uint32_t u32MessageId; /* Unique id assigned by the server. The client must send a reply with the same id.
801 * If the client initiates a request, then this must be set to 0, because there is
802 * currently no client requests, which would require a response from the server.
803 */
804 uint16_t u16FunctionId; /* VRDE_VIDEOIN_FN_* */
805 uint16_t u16Status; /* The result of a request. VRDE_VIDEOIN_STATUS_*. */
806} VRDEVIDEOINMSGHDR;
807ASSERTSIZE(VRDEVIDEOINMSGHDR, 16)
808
809/*
810 * VRDE_VIDEOIN_FN_NEGOTIATE
811 *
812 * Sent by the server when the channel is established and the client replies with its capabilities.
813 */
814#define VRDE_VIDEOIN_NEGOTIATE_VERSION 1
815
816/* VRDEVIDEOINMSG_NEGOTIATE::fu32Capabilities */
817#define VRDE_VIDEOIN_NEGOTIATE_CAP_VOID 0x00000000
818#define VRDE_VIDEOIN_NEGOTIATE_CAP_PROT 0x00000001 /* Supports VRDE_VIDEOIN_CTRLSEL_PROT_* controls. */
819
820typedef struct VRDEVIDEOINMSG_NEGOTIATE
821{
822 VRDEVIDEOINMSGHDR hdr;
823 uint32_t u32Version; /* VRDE_VIDEOIN_NEGOTIATE_VERSION */
824 uint32_t fu32Capabilities; /* VRDE_VIDEOIN_NEGOTIATE_CAP_* */
825} VRDEVIDEOINMSG_NEGOTIATE;
826
827/*
828 * VRDE_VIDEOIN_FN_NOTIFY
829 *
830 * Sent by the client when a webcam is attached or detached.
831 * The client must send the ATTACH notification for each webcam, which is
832 * already connected to the client when the VIDEOIN channel is established.
833 */
834#define VRDE_VIDEOIN_NOTIFY_EVENT_ATTACH 0
835#define VRDE_VIDEOIN_NOTIFY_EVENT_DETACH 1
836#define VRDE_VIDEOIN_NOTIFY_EVENT_NEGOTIATE 2 /* Negotiate again with the client. */
837
838typedef struct VRDEVIDEOINMSG_NOTIFY
839{
840 VRDEVIDEOINMSGHDR hdr;
841 uint32_t u32NotifyEvent; /* VRDE_VIDEOIN_NOTIFY_EVENT_* */
842 /* Event specific data may follow. The underlying protocol provides the length of the message. */
843} VRDEVIDEOINMSG_NOTIFY;
844
845/*
846 * VRDE_VIDEOIN_FN_DEVICEDESC
847 *
848 * The server queries the description of a device.
849 */
850typedef struct VRDEVIDEOINMSG_DEVICEDESC_REQ
851{
852 VRDEVIDEOINMSGHDR hdr;
853} VRDEVIDEOINMSG_DEVICEDESC_REQ;
854
855typedef struct VRDEVIDEOINMSG_DEVICEDESC_RSP
856{
857 VRDEVIDEOINMSGHDR hdr;
858 VRDEVIDEOINDEVICEDESC Device;
859 /*
860 * VRDEVIDEOINFORMATDESC[0]
861 * VRDEVIDEOINFRAMEDESC[0]
862 * ...
863 * VRDEVIDEOINFRAMEDESC[n]
864 * VRDEVIDEOINFORMATDESC[1]
865 * VRDEVIDEOINFRAMEDESC[0]
866 * ...
867 * VRDEVIDEOINFRAMEDESC[m]
868 * ...
869 */
870} VRDEVIDEOINMSG_DEVICEDESC_RSP;
871
872/*
873 * VRDE_VIDEOIN_FN_CONTROL
874 * VRDE_VIDEOIN_FN_CONTROL_NOTIFY
875 *
876 * Either sent by the server or by the client as a notification/response.
877 * If sent by the client as a notification, then hdr.u32MessageId must be 0.
878 */
879typedef struct VRDEVIDEOINMSG_CONTROL
880{
881 VRDEVIDEOINMSGHDR hdr;
882 VRDEVIDEOINCTRLHDR Control;
883 /* Control specific data may follow. */
884} VRDEVIDEOINMSG_CONTROL;
885
886/*
887 * VRDE_VIDEOIN_FN_FRAME
888 *
889 * The client sends a video/still frame in the already specified format.
890 * hdr.u32MessageId must be 0.
891 */
892typedef struct VRDEVIDEOINMSG_FRAME
893{
894 VRDEVIDEOINMSGHDR hdr;
895 VRDEVIDEOINPAYLOADHDR Payload;
896 /* The frame data follow. */
897} VRDEVIDEOINMSG_FRAME;
898
899
900#ifdef VRDE_VIDEOIN_WITH_VRDEINTERFACE
901/*
902 * The application interface between VirtualBox and the VRDE server.
903 */
904
905#define VRDE_VIDEOIN_INTERFACE_NAME "VIDEOIN"
906
907typedef struct VRDEVIDEOINDEVICEHANDLE
908{
909 uint32_t u32ClientId;
910 uint32_t u32DeviceId;
911} VRDEVIDEOINDEVICEHANDLE;
912
913/* The VRDE server video input interface entry points. Interface version 1. */
914typedef struct VRDEVIDEOININTERFACE
915{
916 /* The header. */
917 VRDEINTERFACEHDR header;
918
919 /* Tell the server that this device will be used and associate a context with the device.
920 *
921 * @param hServer The VRDE server instance.
922 * @param pDeviceHandle The device reported by ATTACH notification.
923 * @param pvDeviceCtx The caller context associated with the pDeviceHandle.
924 *
925 * @return IPRT status code.
926 */
927 DECLR3CALLBACKMEMBER(int, VRDEVideoInDeviceAttach, (HVRDESERVER hServer,
928 const VRDEVIDEOINDEVICEHANDLE *pDeviceHandle,
929 void *pvDeviceCtx));
930
931 /* This device will be not be used anymore. The device context must not be used by the server too.
932 *
933 * @param hServer The VRDE server instance.
934 * @param pDeviceHandle The device reported by ATTACH notification.
935 *
936 * @return IPRT status code.
937 */
938 DECLR3CALLBACKMEMBER(int, VRDEVideoInDeviceDetach, (HVRDESERVER hServer,
939 const VRDEVIDEOINDEVICEHANDLE *pDeviceHandle));
940
941 /* Get a device description.
942 *
943 * @param hServer The VRDE server instance.
944 * @param pvUser The callers context of this request.
945 * @param pDeviceHandle The device reported by ATTACH notification.
946 *
947 * @return IPRT status code.
948 */
949 DECLR3CALLBACKMEMBER(int, VRDEVideoInGetDeviceDesc, (HVRDESERVER hServer,
950 void *pvUser,
951 const VRDEVIDEOINDEVICEHANDLE *pDeviceHandle));
952
953 /* Submit a set/get control request.
954 *
955 * @param hServer The VRDE server instance.
956 * @param pvUser The callers context of this request.
957 * @param pDeviceHandle The device reported by ATTACH notification.
958 * @param pReq The request.
959 * @param cbReq Size of the request.
960 *
961 * @return IPRT status code.
962 */
963 DECLR3CALLBACKMEMBER(int, VRDEVideoInControl, (HVRDESERVER hServer,
964 void *pvUser,
965 const VRDEVIDEOINDEVICEHANDLE *pDeviceHandle,
966 const VRDEVIDEOINCTRLHDR *pReq,
967 uint32_t cbReq));
968
969} VRDEVIDEOININTERFACE;
970
971
972/*
973 * Notifications.
974 * Data structures: pvData of VRDEVIDEOINCALLBACKS::VRDECallbackVideoInNotify.
975 */
976typedef struct VRDEVIDEOINNOTIFYATTACH
977{
978 VRDEVIDEOINDEVICEHANDLE deviceHandle;
979 uint32_t u32Version; /* VRDE_VIDEOIN_NEGOTIATE_VERSION */
980 uint32_t fu32Capabilities; /* VRDE_VIDEOIN_NEGOTIATE_CAP_* */
981} VRDEVIDEOINNOTIFYATTACH;
982
983typedef struct VRDEVIDEOINNOTIFYDETACH
984{
985 VRDEVIDEOINDEVICEHANDLE deviceHandle;
986} VRDEVIDEOINNOTIFYDETACH;
987
988/* Notification codes, */
989#define VRDE_VIDEOIN_NOTIFY_ID_ATTACH 0
990#define VRDE_VIDEOIN_NOTIFY_ID_DETACH 1
991
992
993/* Video input interface callbacks. */
994typedef struct VRDEVIDEOINCALLBACKS
995{
996 /* The header. */
997 VRDEINTERFACEHDR header;
998
999 /* Notifications.
1000 *
1001 * @param pvCallback The callbacks context specified in VRDEGetInterface.
1002 * @param u32EventId The notification identifier: VRDE_VIDEOIN_NOTIFY_*.
1003 * @param pvData The notification specific data.
1004 * @param cbData The size of buffer pointed by pvData.
1005 */
1006 DECLR3CALLBACKMEMBER(void, VRDECallbackVideoInNotify,(void *pvCallback,
1007 uint32_t u32Id,
1008 const void *pvData,
1009 uint32_t cbData));
1010
1011 /* Device description received from the client.
1012 *
1013 * @param pvCallback The callbacks context specified in VRDEGetInterface.
1014 * @param rcRequest The result code of the request.
1015 * @param pDeviceCtx The device context associated with the device in VRDEVideoInGetDeviceDesc.
1016 * @param pvUser The pvUser parameter of VRDEVideoInGetDeviceDesc.
1017 * @param pDeviceDesc The device description.
1018 * @param cbDeviceDesc The size of buffer pointed by pDevice.
1019 */
1020 DECLR3CALLBACKMEMBER(void, VRDECallbackVideoInDeviceDesc,(void *pvCallback,
1021 int rcRequest,
1022 void *pDeviceCtx,
1023 void *pvUser,
1024 const VRDEVIDEOINDEVICEDESC *pDeviceDesc,
1025 uint32_t cbDeviceDesc));
1026
1027 /* Control response or notification.
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 VRDEVideoInControl. NULL if this is a notification.
1033 * @param pControl The control information.
1034 * @param cbControl The size of buffer pointed by pControl.
1035 */
1036 DECLR3CALLBACKMEMBER(void, VRDECallbackVideoInControl,(void *pvCallback,
1037 int rcRequest,
1038 void *pDeviceCtx,
1039 void *pvUser,
1040 const VRDEVIDEOINCTRLHDR *pControl,
1041 uint32_t cbControl));
1042
1043 /* Frame which was received from the client.
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 pFrame The frame data.
1049 * @param cbFrame The size of buffer pointed by pFrame.
1050 */
1051 DECLR3CALLBACKMEMBER(void, VRDECallbackVideoInFrame,(void *pvCallback,
1052 int rcRequest,
1053 void *pDeviceCtx,
1054 const VRDEVIDEOINPAYLOADHDR *pFrame,
1055 uint32_t cbFrame));
1056
1057} VRDEVIDEOINCALLBACKS;
1058#endif /* VRDE_VIDEOIN_WITH_VRDEINTERFACE */
1059
1060#pragma pack()
1061
1062#endif
注意: 瀏覽 TracBrowser 來幫助您使用儲存庫瀏覽器

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette