WPILibC++ 2025.0.0-alpha-1-24-g6478ba6
Classes | Typedefs | Enumerations | Functions
cscore_c.h File Reference
#include <stdint.h>
#include <wpi/RawFrame.h>
#include <wpi/string.h>
#include <cstddef>

Go to the source code of this file.

Classes

struct  CS_VideoMode
 Video mode. More...
 
struct  CS_Event
 Listener event. More...
 
struct  CS_UsbCameraInfo
 USB camera information. More...
 

Typedefs

typedef int CS_Bool
 
typedef int CS_Status
 
typedef int CS_Handle
 
typedef CS_Handle CS_Property
 
typedef CS_Handle CS_Listener
 
typedef CS_Handle CS_ListenerPoller
 
typedef CS_Handle CS_Sink
 
typedef CS_Handle CS_Source
 
typedef struct CS_VideoMode CS_VideoMode
 Video mode. More...
 
typedef struct CS_UsbCameraInfo CS_UsbCameraInfo
 USB camera information. More...
 
typedef void(* CS_LogFunc) (void *data, unsigned int level, const struct WPI_String *file, unsigned int line, const struct WPI_String *msg)
 

Enumerations

enum  CS_StatusValue {
  CS_PROPERTY_WRITE_FAILED = 2000 , CS_OK = 0 , CS_INVALID_HANDLE = -2000 , CS_WRONG_HANDLE_SUBTYPE = -2001 ,
  CS_INVALID_PROPERTY = -2002 , CS_WRONG_PROPERTY_TYPE = -2003 , CS_READ_FAILED = -2004 , CS_SOURCE_IS_DISCONNECTED = -2005 ,
  CS_EMPTY_VALUE = -2006 , CS_BAD_URL = -2007 , CS_TELEMETRY_NOT_ENABLED = -2008 , CS_UNSUPPORTED_MODE = -2009
}
 Status values. More...
 
enum  CS_LogLevel {
  CS_LOG_CRITICAL = 50 , CS_LOG_ERROR = 40 , CS_LOG_WARNING = 30 , CS_LOG_INFO = 20 ,
  CS_LOG_DEBUG = 10 , CS_LOG_DEBUG1 = 9 , CS_LOG_DEBUG2 = 8 , CS_LOG_DEBUG3 = 7 ,
  CS_LOG_DEBUG4 = 6
}
 Logging levels. More...
 
enum  CS_PropertyKind {
  CS_PROP_NONE = 0 , CS_PROP_BOOLEAN = 1 , CS_PROP_INTEGER = 2 , CS_PROP_STRING = 4 ,
  CS_PROP_ENUM = 8
}
 Property kinds. More...
 
enum  CS_SourceKind {
  CS_SOURCE_UNKNOWN = 0 , CS_SOURCE_USB = 1 , CS_SOURCE_HTTP = 2 , CS_SOURCE_CV = 4 ,
  CS_SOURCE_RAW = 8
}
 Source kinds. More...
 
enum  CS_HttpCameraKind { CS_HTTP_UNKNOWN = 0 , CS_HTTP_MJPGSTREAMER = 1 , CS_HTTP_CSCORE = 2 , CS_HTTP_AXIS = 3 }
 HTTP Camera kinds. More...
 
enum  CS_SinkKind { CS_SINK_UNKNOWN = 0 , CS_SINK_MJPEG = 2 , CS_SINK_CV = 4 , CS_SINK_RAW = 8 }
 Sink kinds. More...
 
enum  CS_EventKind {
  CS_SOURCE_CREATED = 0x0001 , CS_SOURCE_DESTROYED = 0x0002 , CS_SOURCE_CONNECTED = 0x0004 , CS_SOURCE_DISCONNECTED = 0x0008 ,
  CS_SOURCE_VIDEOMODES_UPDATED = 0x0010 , CS_SOURCE_VIDEOMODE_CHANGED = 0x0020 , CS_SOURCE_PROPERTY_CREATED = 0x0040 , CS_SOURCE_PROPERTY_VALUE_UPDATED = 0x0080 ,
  CS_SOURCE_PROPERTY_CHOICES_UPDATED = 0x0100 , CS_SINK_SOURCE_CHANGED = 0x0200 , CS_SINK_CREATED = 0x0400 , CS_SINK_DESTROYED = 0x0800 ,
  CS_SINK_ENABLED = 0x1000 , CS_SINK_DISABLED = 0x2000 , CS_NETWORK_INTERFACES_CHANGED = 0x4000 , CS_TELEMETRY_UPDATED = 0x8000 ,
  CS_SINK_PROPERTY_CREATED = 0x10000 , CS_SINK_PROPERTY_VALUE_UPDATED = 0x20000 , CS_SINK_PROPERTY_CHOICES_UPDATED = 0x40000 , CS_USB_CAMERAS_CHANGED = 0x80000
}
 Listener event kinds. More...
 
enum  CS_TelemetryKind { CS_SOURCE_BYTES_RECEIVED = 1 , CS_SOURCE_FRAMES_RECEIVED = 2 }
 Telemetry kinds. More...
 
enum  CS_ConnectionStrategy { CS_CONNECTION_AUTO_MANAGE = 0 , CS_CONNECTION_KEEP_OPEN , CS_CONNECTION_FORCE_CLOSE }
 Connection strategy. More...
 

Functions

enum CS_PropertyKind CS_GetPropertyKind (CS_Property property, CS_Status *status)
 
void CS_GetPropertyName (CS_Property property, struct WPI_String *name, CS_Status *status)
 
int CS_GetProperty (CS_Property property, CS_Status *status)
 
void CS_SetProperty (CS_Property property, int value, CS_Status *status)
 
int CS_GetPropertyMin (CS_Property property, CS_Status *status)
 
int CS_GetPropertyMax (CS_Property property, CS_Status *status)
 
int CS_GetPropertyStep (CS_Property property, CS_Status *status)
 
int CS_GetPropertyDefault (CS_Property property, CS_Status *status)
 
void CS_GetStringProperty (CS_Property property, struct WPI_String *value, CS_Status *status)
 
void CS_SetStringProperty (CS_Property property, const struct WPI_String *value, CS_Status *status)
 
struct WPI_String * CS_GetEnumPropertyChoices (CS_Property property, int *count, CS_Status *status)
 
CS_Source CS_CreateUsbCameraDev (const struct WPI_String *name, int dev, CS_Status *status)
 
CS_Source CS_CreateUsbCameraPath (const struct WPI_String *name, const struct WPI_String *path, CS_Status *status)
 
CS_Source CS_CreateHttpCamera (const struct WPI_String *name, const struct WPI_String *url, enum CS_HttpCameraKind kind, CS_Status *status)
 
CS_Source CS_CreateHttpCameraMulti (const struct WPI_String *name, const struct WPI_String *urls, int count, enum CS_HttpCameraKind kind, CS_Status *status)
 
CS_Source CS_CreateCvSource (const struct WPI_String *name, const CS_VideoMode *mode, CS_Status *status)
 
enum CS_SourceKind CS_GetSourceKind (CS_Source source, CS_Status *status)
 
void CS_GetSourceName (CS_Source source, struct WPI_String *name, CS_Status *status)
 
void CS_GetSourceDescription (CS_Source source, struct WPI_String *description, CS_Status *status)
 
uint64_t CS_GetSourceLastFrameTime (CS_Source source, CS_Status *status)
 
void CS_SetSourceConnectionStrategy (CS_Source source, enum CS_ConnectionStrategy strategy, CS_Status *status)
 
CS_Bool CS_IsSourceConnected (CS_Source source, CS_Status *status)
 
CS_Bool CS_IsSourceEnabled (CS_Source source, CS_Status *status)
 
CS_Property CS_GetSourceProperty (CS_Source source, const struct WPI_String *name, CS_Status *status)
 
CS_Property * CS_EnumerateSourceProperties (CS_Source source, int *count, CS_Status *status)
 
void CS_GetSourceVideoMode (CS_Source source, CS_VideoMode *mode, CS_Status *status)
 
CS_Bool CS_SetSourceVideoMode (CS_Source source, const CS_VideoMode *mode, CS_Status *status)
 
CS_Bool CS_SetSourceVideoModeDiscrete (CS_Source source, enum WPI_PixelFormat pixelFormat, int width, int height, int fps, CS_Status *status)
 
CS_Bool CS_SetSourcePixelFormat (CS_Source source, enum WPI_PixelFormat pixelFormat, CS_Status *status)
 
CS_Bool CS_SetSourceResolution (CS_Source source, int width, int height, CS_Status *status)
 
CS_Bool CS_SetSourceFPS (CS_Source source, int fps, CS_Status *status)
 
CS_Bool CS_SetSourceConfigJson (CS_Source source, const struct WPI_String *config, CS_Status *status)
 
void CS_GetSourceConfigJson (CS_Source source, struct WPI_String *config, CS_Status *status)
 
CS_VideoMode * CS_EnumerateSourceVideoModes (CS_Source source, int *count, CS_Status *status)
 
CS_Sink * CS_EnumerateSourceSinks (CS_Source source, int *count, CS_Status *status)
 
CS_Source CS_CopySource (CS_Source source, CS_Status *status)
 
void CS_ReleaseSource (CS_Source source, CS_Status *status)
 
void CS_SetCameraBrightness (CS_Source source, int brightness, CS_Status *status)
 
int CS_GetCameraBrightness (CS_Source source, CS_Status *status)
 
void CS_SetCameraWhiteBalanceAuto (CS_Source source, CS_Status *status)
 
void CS_SetCameraWhiteBalanceHoldCurrent (CS_Source source, CS_Status *status)
 
void CS_SetCameraWhiteBalanceManual (CS_Source source, int value, CS_Status *status)
 
void CS_SetCameraExposureAuto (CS_Source source, CS_Status *status)
 
void CS_SetCameraExposureHoldCurrent (CS_Source source, CS_Status *status)
 
void CS_SetCameraExposureManual (CS_Source source, int value, CS_Status *status)
 
void CS_SetUsbCameraPath (CS_Source source, const struct WPI_String *path, CS_Status *status)
 
void CS_GetUsbCameraPath (CS_Source source, struct WPI_String *path, CS_Status *status)
 
void CS_GetUsbCameraInfo (CS_Source source, CS_UsbCameraInfo *info, CS_Status *status)
 
enum CS_HttpCameraKind CS_GetHttpCameraKind (CS_Source source, CS_Status *status)
 
void CS_SetHttpCameraUrls (CS_Source source, const struct WPI_String *urls, int count, CS_Status *status)
 
struct WPI_String * CS_GetHttpCameraUrls (CS_Source source, int *count, CS_Status *status)
 
void CS_NotifySourceError (CS_Source source, const struct WPI_String *msg, CS_Status *status)
 
void CS_SetSourceConnected (CS_Source source, CS_Bool connected, CS_Status *status)
 
void CS_SetSourceDescription (CS_Source source, const struct WPI_String *description, CS_Status *status)
 
CS_Property CS_CreateSourceProperty (CS_Source source, const struct WPI_String *name, enum CS_PropertyKind kind, int minimum, int maximum, int step, int defaultValue, int value, CS_Status *status)
 
void CS_SetSourceEnumPropertyChoices (CS_Source source, CS_Property property, const struct WPI_String *choices, int count, CS_Status *status)
 
CS_Sink CS_CreateMjpegServer (const struct WPI_String *name, const struct WPI_String *listenAddress, int port, CS_Status *status)
 
CS_Sink CS_CreateCvSink (const struct WPI_String *name, enum WPI_PixelFormat pixelFormat, CS_Status *status)
 
CS_Sink CS_CreateCvSinkCallback (const struct WPI_String *name, enum WPI_PixelFormat pixelFormat, void *data, void(*processFrame)(void *data, uint64_t time), CS_Status *status)
 
enum CS_SinkKind CS_GetSinkKind (CS_Sink sink, CS_Status *status)
 
void CS_GetSinkName (CS_Sink sink, struct WPI_String *name, CS_Status *status)
 
void CS_GetSinkDescription (CS_Sink sink, struct WPI_String *description, CS_Status *status)
 
CS_Property CS_GetSinkProperty (CS_Sink sink, const struct WPI_String *name, CS_Status *status)
 
CS_Property * CS_EnumerateSinkProperties (CS_Sink sink, int *count, CS_Status *status)
 
void CS_SetSinkSource (CS_Sink sink, CS_Source source, CS_Status *status)
 
CS_Property CS_GetSinkSourceProperty (CS_Sink sink, const struct WPI_String *name, CS_Status *status)
 
CS_Bool CS_SetSinkConfigJson (CS_Sink sink, const struct WPI_String *config, CS_Status *status)
 
void CS_GetSinkConfigJson (CS_Sink sink, struct WPI_String *config, CS_Status *status)
 
CS_Source CS_GetSinkSource (CS_Sink sink, CS_Status *status)
 
CS_Sink CS_CopySink (CS_Sink sink, CS_Status *status)
 
void CS_ReleaseSink (CS_Sink sink, CS_Status *status)
 
void CS_GetMjpegServerListenAddress (CS_Sink sink, struct WPI_String *listenAddress, CS_Status *status)
 
int CS_GetMjpegServerPort (CS_Sink sink, CS_Status *status)
 
void CS_SetSinkDescription (CS_Sink sink, const struct WPI_String *description, CS_Status *status)
 
void CS_GetSinkError (CS_Sink sink, struct WPI_String *error, CS_Status *status)
 
void CS_SetSinkEnabled (CS_Sink sink, CS_Bool enabled, CS_Status *status)
 
void CS_SetListenerOnStart (void(*onStart)(void *data), void *data)
 
void CS_SetListenerOnExit (void(*onExit)(void *data), void *data)
 
CS_Listener CS_AddListener (void *data, void(*callback)(void *data, const struct CS_Event *event), int eventMask, CS_Bool immediateNotify, CS_Status *status)
 
void CS_RemoveListener (CS_Listener handle, CS_Status *status)
 
CS_ListenerPoller CS_CreateListenerPoller (void)
 
void CS_DestroyListenerPoller (CS_ListenerPoller poller)
 
CS_Listener CS_AddPolledListener (CS_ListenerPoller poller, int eventMask, CS_Bool immediateNotify, CS_Status *status)
 
struct CS_Event * CS_PollListener (CS_ListenerPoller poller, int *count)
 
struct CS_Event * CS_PollListenerTimeout (CS_ListenerPoller poller, int *count, double timeout, CS_Bool *timedOut)
 
void CS_FreeEvents (struct CS_Event *arr, int count)
 
void CS_CancelPollListener (CS_ListenerPoller poller)
 
int CS_NotifierDestroyed (void)
 
void CS_SetTelemetryPeriod (double seconds)
 
double CS_GetTelemetryElapsedTime (void)
 
int64_t CS_GetTelemetryValue (CS_Handle handle, enum CS_TelemetryKind kind, CS_Status *status)
 
double CS_GetTelemetryAverageValue (CS_Handle handle, enum CS_TelemetryKind kind, CS_Status *status)
 
void CS_SetLogger (CS_LogFunc func, void *data, unsigned int min_level)
 
void CS_SetDefaultLogger (unsigned int min_level)
 
void CS_Shutdown (void)
 
CS_UsbCameraInfo * CS_EnumerateUsbCameras (int *count, CS_Status *status)
 
void CS_FreeEnumeratedUsbCameras (CS_UsbCameraInfo *cameras, int count)
 
CS_Source * CS_EnumerateSources (int *count, CS_Status *status)
 
void CS_ReleaseEnumeratedSources (CS_Source *sources, int count)
 
CS_Sink * CS_EnumerateSinks (int *count, CS_Status *status)
 
void CS_ReleaseEnumeratedSinks (CS_Sink *sinks, int count)
 
void CS_FreeUsbCameraInfo (CS_UsbCameraInfo *info)
 
void CS_FreeEnumeratedProperties (CS_Property *properties, int count)
 
void CS_FreeEnumeratedVideoModes (CS_VideoMode *modes, int count)
 
void CS_GetHostname (struct WPI_String *hostName)
 
struct WPI_String * CS_GetNetworkInterfaces (int *count)