8 #ifndef CSCORE_CSCORE_C_H_
9 #define CSCORE_CSCORE_C_H_
49 typedef int CS_Status;
51 typedef int CS_Handle;
52 typedef CS_Handle CS_Property;
53 typedef CS_Handle CS_Listener;
54 typedef CS_Handle CS_Sink;
55 typedef CS_Handle CS_Source;
62 CS_PROPERTY_WRITE_FAILED = 2000,
64 CS_INVALID_HANDLE = -2000,
65 CS_WRONG_HANDLE_SUBTYPE = -2001,
66 CS_INVALID_PROPERTY = -2002,
67 CS_WRONG_PROPERTY_TYPE = -2003,
68 CS_READ_FAILED = -2004,
69 CS_SOURCE_IS_DISCONNECTED = -2005,
70 CS_EMPTY_VALUE = -2006,
72 CS_TELEMETRY_NOT_ENABLED = -2008
94 CS_PIXFMT_UNKNOWN = 0,
127 CS_SOURCE_UNKNOWN = 0,
138 CS_HTTP_MJPGSTREAMER = 1,
146 enum CS_SinkKind { CS_SINK_UNKNOWN = 0, CS_SINK_MJPEG = 2, CS_SINK_CV = 4 };
152 CS_SOURCE_CREATED = 0x0001,
153 CS_SOURCE_DESTROYED = 0x0002,
154 CS_SOURCE_CONNECTED = 0x0004,
155 CS_SOURCE_DISCONNECTED = 0x0008,
156 CS_SOURCE_VIDEOMODES_UPDATED = 0x0010,
157 CS_SOURCE_VIDEOMODE_CHANGED = 0x0020,
158 CS_SOURCE_PROPERTY_CREATED = 0x0040,
159 CS_SOURCE_PROPERTY_VALUE_UPDATED = 0x0080,
160 CS_SOURCE_PROPERTY_CHOICES_UPDATED = 0x0100,
161 CS_SINK_SOURCE_CHANGED = 0x0200,
162 CS_SINK_CREATED = 0x0400,
163 CS_SINK_DESTROYED = 0x0800,
164 CS_SINK_ENABLED = 0x1000,
165 CS_SINK_DISABLED = 0x2000,
166 CS_NETWORK_INTERFACES_CHANGED = 0x4000,
167 CS_TELEMETRY_UPDATED = 0x8000,
168 CS_SINK_PROPERTY_CREATED = 0x10000,
169 CS_SINK_PROPERTY_VALUE_UPDATED = 0x20000,
170 CS_SINK_PROPERTY_CHOICES_UPDATED = 0x40000
177 CS_SOURCE_BYTES_RECEIVED = 1,
178 CS_SOURCE_FRAMES_RECEIVED = 2
219 CS_Property property;
222 const char* valueStr;
231 char* CS_GetPropertyName(CS_Property property, CS_Status* status);
232 int CS_GetProperty(CS_Property property, CS_Status* status);
233 void CS_SetProperty(CS_Property property,
int value, CS_Status* status);
234 int CS_GetPropertyMin(CS_Property property, CS_Status* status);
235 int CS_GetPropertyMax(CS_Property property, CS_Status* status);
236 int CS_GetPropertyStep(CS_Property property, CS_Status* status);
237 int CS_GetPropertyDefault(CS_Property property, CS_Status* status);
238 char* CS_GetStringProperty(CS_Property property, CS_Status* status);
239 void CS_SetStringProperty(CS_Property property,
const char* value,
241 char** CS_GetEnumPropertyChoices(CS_Property property,
int* count,
249 CS_Source CS_CreateUsbCameraDev(
const char* name,
int dev, CS_Status* status);
250 CS_Source CS_CreateUsbCameraPath(
const char* name,
const char* path,
252 CS_Source CS_CreateHttpCamera(
const char* name,
const char* url,
254 CS_Source CS_CreateHttpCameraMulti(
const char* name,
const char** urls,
257 CS_Source CS_CreateCvSource(
const char* name,
const CS_VideoMode* mode,
265 enum CS_SourceKind CS_GetSourceKind(CS_Source source, CS_Status* status);
266 char* CS_GetSourceName(CS_Source source, CS_Status* status);
267 char* CS_GetSourceDescription(CS_Source source, CS_Status* status);
268 uint64_t CS_GetSourceLastFrameTime(CS_Source source, CS_Status* status);
269 void CS_SetSourceConnectionStrategy(CS_Source source,
272 CS_Bool CS_IsSourceConnected(CS_Source source, CS_Status* status);
273 CS_Bool CS_IsSourceEnabled(CS_Source source, CS_Status* status);
274 CS_Property CS_GetSourceProperty(CS_Source source,
const char* name,
276 CS_Property* CS_EnumerateSourceProperties(CS_Source source,
int* count,
278 void CS_GetSourceVideoMode(CS_Source source,
CS_VideoMode* mode,
280 CS_Bool CS_SetSourceVideoMode(CS_Source source,
const CS_VideoMode* mode,
282 CS_Bool CS_SetSourceVideoModeDiscrete(CS_Source source,
284 int width,
int height,
int fps,
286 CS_Bool CS_SetSourcePixelFormat(CS_Source source,
289 CS_Bool CS_SetSourceResolution(CS_Source source,
int width,
int height,
291 CS_Bool CS_SetSourceFPS(CS_Source source,
int fps, CS_Status* status);
292 CS_VideoMode* CS_EnumerateSourceVideoModes(CS_Source source,
int* count,
294 CS_Sink* CS_EnumerateSourceSinks(CS_Source source,
int* count,
296 CS_Source CS_CopySource(CS_Source source, CS_Status* status);
297 void CS_ReleaseSource(CS_Source source, CS_Status* status);
304 void CS_SetCameraBrightness(CS_Source source,
int brightness,
306 int CS_GetCameraBrightness(CS_Source source, CS_Status* status);
307 void CS_SetCameraWhiteBalanceAuto(CS_Source source, CS_Status* status);
308 void CS_SetCameraWhiteBalanceHoldCurrent(CS_Source source, CS_Status* status);
309 void CS_SetCameraWhiteBalanceManual(CS_Source source,
int value,
311 void CS_SetCameraExposureAuto(CS_Source source, CS_Status* status);
312 void CS_SetCameraExposureHoldCurrent(CS_Source source, CS_Status* status);
313 void CS_SetCameraExposureManual(CS_Source source,
int value, CS_Status* status);
320 char* CS_GetUsbCameraPath(CS_Source source, CS_Status* status);
329 void CS_SetHttpCameraUrls(CS_Source source,
const char** urls,
int count,
331 char** CS_GetHttpCameraUrls(CS_Source source,
int* count, CS_Status* status);
338 void CS_PutSourceFrame(CS_Source source,
struct CvMat* image,
340 void CS_NotifySourceError(CS_Source source,
const char* msg, CS_Status* status);
341 void CS_SetSourceConnected(CS_Source source, CS_Bool connected,
343 void CS_SetSourceDescription(CS_Source source,
const char* description,
345 CS_Property CS_CreateSourceProperty(CS_Source source,
const char* name,
347 int maximum,
int step,
int defaultValue,
348 int value, CS_Status* status);
349 void CS_SetSourceEnumPropertyChoices(CS_Source source, CS_Property property,
350 const char** choices,
int count,
358 CS_Sink CS_CreateMjpegServer(
const char* name,
const char* listenAddress,
359 int port, CS_Status* status);
360 CS_Sink CS_CreateCvSink(
const char* name, CS_Status* status);
361 CS_Sink CS_CreateCvSinkCallback(
const char* name,
void* data,
362 void (*processFrame)(
void* data, uint64_t time),
370 enum CS_SinkKind CS_GetSinkKind(CS_Sink sink, CS_Status* status);
371 char* CS_GetSinkName(CS_Sink sink, CS_Status* status);
372 char* CS_GetSinkDescription(CS_Sink sink, CS_Status* status);
373 CS_Property CS_GetSinkProperty(CS_Sink sink,
const char* name,
375 CS_Property* CS_EnumerateSinkProperties(CS_Sink sink,
int* count,
377 void CS_SetSinkSource(CS_Sink sink, CS_Source source, CS_Status* status);
378 CS_Property CS_GetSinkSourceProperty(CS_Sink sink,
const char* name,
380 CS_Source CS_GetSinkSource(CS_Sink sink, CS_Status* status);
381 CS_Sink CS_CopySink(CS_Sink sink, CS_Status* status);
382 void CS_ReleaseSink(CS_Sink sink, CS_Status* status);
389 char* CS_GetMjpegServerListenAddress(CS_Sink sink, CS_Status* status);
390 int CS_GetMjpegServerPort(CS_Sink sink, CS_Status* status);
397 void CS_SetSinkDescription(CS_Sink sink,
const char* description,
399 uint64_t CS_GrabSinkFrame(CS_Sink sink,
struct CvMat* image, CS_Status* status);
400 uint64_t CS_GrabSinkFrameTimeout(CS_Sink sink,
struct CvMat* image,
401 double timeout, CS_Status* status);
402 char* CS_GetSinkError(CS_Sink sink, CS_Status* status);
403 void CS_SetSinkEnabled(CS_Sink sink, CS_Bool enabled, CS_Status* status);
410 void CS_SetListenerOnStart(
void (*onStart)(
void* data),
void* data);
411 void CS_SetListenerOnExit(
void (*onExit)(
void* data),
void* data);
412 CS_Listener CS_AddListener(
413 void* data,
void (*callback)(
void* data,
const struct CS_Event* event),
414 int eventMask,
int immediateNotify, CS_Status* status);
416 void CS_RemoveListener(CS_Listener handle, CS_Status* status);
419 int CS_NotifierDestroyed(
void);
425 void CS_SetTelemetryPeriod(
double seconds);
426 double CS_GetTelemetryElapsedTime(
void);
429 double CS_GetTelemetryAverageValue(CS_Handle handle,
enum CS_TelemetryKind kind,
437 typedef void (*CS_LogFunc)(
unsigned int level,
const char* file,
438 unsigned int line,
const char* msg);
439 void CS_SetLogger(CS_LogFunc func,
unsigned int min_level);
440 void CS_SetDefaultLogger(
unsigned int min_level);
447 void CS_Shutdown(
void);
467 CS_Source* CS_EnumerateSources(
int* count, CS_Status* status);
468 void CS_ReleaseEnumeratedSources(CS_Source* sources,
int count);
470 CS_Sink* CS_EnumerateSinks(
int* count, CS_Status* status);
471 void CS_ReleaseEnumeratedSinks(CS_Sink* sinks,
int count);
473 void CS_FreeString(
char* str);
474 void CS_FreeEnumPropertyChoices(
char** choices,
int count);
475 void CS_FreeHttpCameraUrls(
char** urls,
int count);
477 void CS_FreeEnumeratedProperties(CS_Property* properties,
int count);
478 void CS_FreeEnumeratedVideoModes(
CS_VideoMode* modes,
int count);
480 char* CS_GetHostname();
482 char** CS_GetNetworkInterfaces(
int* count);
483 void CS_FreeNetworkInterfaces(
char** interfaces,
int count);
492 #endif // CSCORE_CSCORE_C_H_
CS_StatusValue
Status values.
Definition: cscore_c.h:61
CS_PixelFormat
Pixel formats.
Definition: cscore_c.h:93
CS_TelemetryKind
Telemetry kinds.
Definition: cscore_c.h:176
Try to keep the connection open regardless of whether any sinks are connected.
Definition: cscore_c.h:193
CS_LogLevel
Logging levels.
Definition: cscore_c.h:78
struct CS_VideoMode CS_VideoMode
Video mode.
CS_HttpCameraKind
HTTP Camera kinds.
Definition: cscore_c.h:136
CS_SinkKind
Sink kinds.
Definition: cscore_c.h:146
USB camera infomation.
Definition: cscore_c.h:458
Never open the connection.
Definition: cscore_c.h:199
Automatically connect or disconnect based on whether any sinks are connected to this source...
Definition: cscore_c.h:187
CS_ConnectionStrategy
Connection strategy.
Definition: cscore_c.h:182
CS_SourceKind
Source kinds.
Definition: cscore_c.h:126
CS_PropertyKind
Property kinds.
Definition: cscore_c.h:115
CS_EventKind
Listener event kinds.
Definition: cscore_c.h:151
struct CS_UsbCameraInfo CS_UsbCameraInfo
USB camera infomation.
Listener event.
Definition: cscore_c.h:205
Video mode.
Definition: cscore_c.h:105