FreeRDP
Loading...
Searching...
No Matches
camera.h
1
20#ifndef FREERDP_CLIENT_CAMERA_H
21#define FREERDP_CLIENT_CAMERA_H
22
23#include <errno.h>
24#include <stdio.h>
25#include <stdlib.h>
26#include <string.h>
27
28#include <winpr/wlog.h>
29#include <winpr/wtypes.h>
30
31#include <freerdp/api.h>
32#include <freerdp/types.h>
33
34#include <freerdp/client/channels.h>
35#include <freerdp/channels/log.h>
36#include <freerdp/channels/rdpecam.h>
37#include <freerdp/codecs.h>
38#include <freerdp/codec/video.h>
39#include <freerdp/primitives.h>
40
41#define ECAM_PROTO_VERSION 0x02
42/* currently supporting 1 stream per device */
43#define ECAM_DEVICE_MAX_STREAMS 1
44#define ECAM_MAX_MEDIA_TYPE_DESCRIPTORS 256
45
46/* Allow to send up to that many unsolicited samples.
47 * For example, to support 30 fps with 250 ms round trip
48 * ECAM_MAX_SAMPLE_CREDITS has to be at least 8.
49 */
50#define ECAM_MAX_SAMPLE_CREDITS 8
51
52/* Having this hardcoded allows to preallocate and reuse buffer
53 * for sample responses. Excessive size is to make sure any sample
54 * will fit in, even with highest resolution.
55 */
56#define ECAM_SAMPLE_RESPONSE_BUFFER_SIZE (1024ULL * 4050ULL)
57
58typedef struct s_ICamHal ICamHal;
59
60typedef struct
61{
62 IWTSPlugin iface;
63 IWTSListener* listener;
65
66 /* HAL interface */
67 ICamHal* ihal;
68 char* subsystem;
69
70 BOOL initialized;
71 BOOL attached;
72
73 UINT32 version;
74 wHashTable* devices;
75
77
78typedef struct
79{
80 CAM_MEDIA_FORMAT inputFormat; /* camera side */
81 CAM_MEDIA_FORMAT outputFormat; /* network side */
82
84
85typedef struct
86{
87 BOOL streaming;
88 /* The protocol stream can remain active while the capture device is released. */
89 BOOL captureRunning;
91 CAM_MEDIA_TYPE_DESCRIPTION currMediaType;
92
93 GENERIC_CHANNEL_CALLBACK* hSampleReqChannel;
95 volatile LONG samplesRequested;
96 wStream* pendingSample;
97 volatile BOOL haveSample;
98 wStream* sampleRespBuffer;
99
100 FREERDP_VIDEO_CONTEXT* video;
102
103/* Internal callback result asking a request-driven HAL to release the capture device. */
104#define ECAM_SAMPLE_CAPTURE_DRAINED 0x00010000u
105
106WINPR_ATTR_NODISCARD
107static inline CAM_MEDIA_FORMAT streamInputFormat(CameraDeviceStream* stream)
108{
109 return stream->formats.inputFormat;
110}
111
112WINPR_ATTR_NODISCARD
113static inline CAM_MEDIA_FORMAT streamOutputFormat(CameraDeviceStream* stream)
114{
115 return stream->formats.outputFormat;
116}
117
118typedef struct
119{
120 IWTSListener* listener;
121 GENERIC_LISTENER_CALLBACK* hlistener;
122 CameraPlugin* ecam;
123 ICamHal* ihal; /* HAL interface, same as used by CameraPlugin */
124 char deviceId[32];
125 CameraDeviceStream streams[ECAM_DEVICE_MAX_STREAMS];
126
128
133typedef UINT (*ICamHalEnumCallback)(CameraPlugin* ecam, GENERIC_CHANNEL_CALLBACK* hchannel,
134 const char* deviceId, const char* deviceName);
135
136/* may run in context of different thread */
137typedef UINT (*ICamHalSampleCapturedCallback)(CameraDevice* dev, size_t streamIndex,
138 const BYTE* sample, size_t size);
139
142{
143 /* The HAL can release capture when there are no sample requests and restart it later. */
144 BOOL RequestDrivenCapture;
145
154 WINPR_ATTR_NODISCARD UINT (*Enumerate)(ICamHal* ihal, ICamHalEnumCallback callback,
155 CameraPlugin* ecam, GENERIC_CHANNEL_CALLBACK* hchannel);
156
165 WINPR_ATTR_NODISCARD BOOL (*Activate)(ICamHal* ihal, const char* deviceId,
166 CAM_ERROR_CODE* errorCode);
167
176 WINPR_ATTR_NODISCARD BOOL (*Deactivate)(ICamHal* ihal, const char* deviceId,
177 CAM_ERROR_CODE* errorCode);
178
190 WINPR_ATTR_NODISCARD INT16 (*GetMediaTypeDescriptions)(
191 ICamHal* ihal, const char* deviceId, size_t streamIndex,
192 const CAM_MEDIA_FORMAT_INFO* supportedFormats, size_t nSupportedFormats,
193 CAM_MEDIA_TYPE_DESCRIPTION* mediaTypes, size_t* nMediaTypes);
194
204 WINPR_ATTR_NODISCARD CAM_ERROR_CODE (*StartStream)(ICamHal* ihal, CameraDevice* dev,
205 size_t streamIndex,
206 const CAM_MEDIA_TYPE_DESCRIPTION* mediaType,
207 ICamHalSampleCapturedCallback callback);
208
216 CAM_ERROR_CODE (*StopStream)(ICamHal* ihal, const char* deviceId, size_t streamIndex);
217
223 CAM_ERROR_CODE (*Free)(ICamHal* ihal);
224};
225
226typedef UINT (*PREGISTERCAMERAHAL)(IWTSPlugin* plugin, ICamHal* hal);
227
228typedef struct
229{
230 IWTSPlugin* plugin;
231 WINPR_ATTR_NODISCARD PREGISTERCAMERAHAL pRegisterCameraHal;
232 CameraPlugin* ecam;
233 const ADDIN_ARGV* args;
234
236
238
239/* entry point called by addin manager */
240typedef UINT(VCAPITYPE* PFREERDP_CAMERA_HAL_ENTRY)(PFREERDP_CAMERA_HAL_ENTRY_POINTS pEntryPoints);
241
242/* common functions */
243WINPR_ATTR_NODISCARD FREERDP_LOCAL UINT ecam_channel_send_generic_msg(
244 CameraPlugin* ecam, GENERIC_CHANNEL_CALLBACK* hchannel, CAM_MSG_ID msg);
245
246FREERDP_LOCAL UINT ecam_channel_send_error_response(CameraPlugin* ecam,
247 GENERIC_CHANNEL_CALLBACK* hchannel,
248 CAM_ERROR_CODE code);
249
250WINPR_ATTR_NODISCARD FREERDP_LOCAL UINT ecam_channel_write(CameraPlugin* ecam,
251 GENERIC_CHANNEL_CALLBACK* hchannel,
252 CAM_MSG_ID msg, wStream* out,
253 BOOL freeStream);
254
255/* ecam device interface */
256FREERDP_LOCAL void ecam_dev_destroy(CameraDevice* dev);
257
258WINPR_ATTR_MALLOC(ecam_dev_destroy, 1)
259WINPR_ATTR_NODISCARD
260FREERDP_LOCAL CameraDevice* ecam_dev_create(CameraPlugin* ecam, const char* deviceId,
261 const char* deviceName);
262
263/* video encoding interface */
264WINPR_ATTR_NODISCARD FREERDP_LOCAL BOOL ecam_encoder_context_init(CameraDeviceStream* stream);
265
266FREERDP_LOCAL BOOL ecam_encoder_context_free(CameraDeviceStream* stream);
267
268WINPR_ATTR_NODISCARD FREERDP_LOCAL BOOL ecam_encoder_compress(CameraDeviceStream* stream,
269 const BYTE* srcData, size_t srcSize,
270 wStream* output);
271
272WINPR_ATTR_NODISCARD FREERDP_LOCAL UINT32 h264_get_max_bitrate(UINT32 height);
273
274WINPR_ATTR_NODISCARD
275FREERDP_LOCAL FREERDP_VIDEO_FORMAT ecamToVideoFormat(CAM_MEDIA_FORMAT ecamFormat);
276
277#endif /* FREERDP_CLIENT_CAMERA_H */
Definition camera.h:229
interface to implement for the camera HAL
Definition camera.h:142
WINPR_ATTR_NODISCARD BOOL(* Deactivate)(ICamHal *ihal, const char *deviceId, CAM_ERROR_CODE *errorCode)
Definition camera.h:176
WINPR_ATTR_NODISCARD INT16(* GetMediaTypeDescriptions)(ICamHal *ihal, const char *deviceId, size_t streamIndex, const CAM_MEDIA_FORMAT_INFO *supportedFormats, size_t nSupportedFormats, CAM_MEDIA_TYPE_DESCRIPTION *mediaTypes, size_t *nMediaTypes)
Definition camera.h:190
WINPR_ATTR_NODISCARD UINT(* Enumerate)(ICamHal *ihal, ICamHalEnumCallback callback, CameraPlugin *ecam, GENERIC_CHANNEL_CALLBACK *hchannel)
Definition camera.h:154
WINPR_ATTR_NODISCARD BOOL(* Activate)(ICamHal *ihal, const char *deviceId, CAM_ERROR_CODE *errorCode)
Definition camera.h:165
CAM_ERROR_CODE(* StopStream)(ICamHal *ihal, const char *deviceId, size_t streamIndex)
Definition camera.h:216
WINPR_ATTR_NODISCARD CAM_ERROR_CODE(* StartStream)(ICamHal *ihal, CameraDevice *dev, size_t streamIndex, const CAM_MEDIA_TYPE_DESCRIPTION *mediaType, ICamHalSampleCapturedCallback callback)
Definition camera.h:204
CAM_ERROR_CODE(* Free)(ICamHal *ihal)
Definition camera.h:223