5#ifndef CSCORE_CSCORE_OO_H_
6#define CSCORE_CSCORE_OO_H_
9#include <initializer_list>
60 explicit operator bool()
const {
return m_kind !=
kNone; }
136 explicit operator
bool()
const {
return m_handle != 0; }
527 template <
typename T>
542 void SetUrls(std::span<const std::string> urls);
547 template <
typename T>
548 void SetUrls(std::initializer_list<T> urls);
553 std::vector<std::string>
GetUrls()
const;
561 static std::vector<std::string> HostToUrl(std::span<const std::string> hosts);
562 template <
typename T>
563 static std::vector<std::string> HostToUrl(std::initializer_list<T> hosts);
604 template <
typename T>
651 int minimum,
int maximum,
int step,
652 int defaultValue,
int value);
666 int maximum,
int step,
int defaultValue,
697 std::span<const std::string> choices);
705 template <
typename T>
707 std::initializer_list<T> choices);
730 explicit operator
bool()
const {
return m_handle != 0; }
1007 int eventMask,
bool immediateNotify);
and restrictions which apply to each piece of software is included later in this file and or inside of the individual applicable source files The disclaimer of warranty in the WPILib license above applies to all code in and nothing in any of the other licenses gives permission to use the names of FIRST nor the names of the WPILib contributors to endorse or promote products derived from this software The following pieces of software have additional or alternate and or Google Inc All rights reserved Redistribution and use in source and binary with or without are permitted provided that the following conditions are this list of conditions and the following disclaimer *Redistributions in binary form must reproduce the above copyright this list of conditions and the following disclaimer in the documentation and or other materials provided with the distribution *Neither the name of Google Inc nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS AS IS AND ANY EXPRESS OR IMPLIED BUT NOT LIMITED THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY OR CONSEQUENTIAL WHETHER IN STRICT OR EVEN IF ADVISED OF THE POSSIBILITY OF SUCH January AND DISTRIBUTION Definitions License shall mean the terms and conditions for and distribution as defined by Sections through of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control direct or to cause the direction or management of such whether by contract or including but not limited to software source documentation source
Definition: ThirdPartyNotices.txt:111
A source that represents an Axis IP camera.
Definition: cscore_oo.h:559
AxisCamera(std::string_view name, std::string_view host)
Create a source for an Axis IP camera.
Definition: cscore_oo.inc:375
A source that represents a MJPEG-over-HTTP (IP) camera.
Definition: cscore_oo.h:471
HttpCamera(std::string_view name, std::string_view url, HttpCameraKind kind=kUnknown)
Create a source for a MJPEG-over-HTTP (IP) camera.
Definition: cscore_oo.inc:287
std::vector< std::string > GetUrls() const
Get the URLs used to connect to the camera.
Definition: cscore_oo.inc:349
void SetUrls(std::span< const std::string > urls)
Change the URLs used to connect to the camera.
Definition: cscore_oo.inc:333
HttpCameraKind
Definition: cscore_oo.h:473
@ kMJPGStreamer
Definition: cscore_oo.h:475
@ kCSCore
Definition: cscore_oo.h:476
@ kAxis
Definition: cscore_oo.h:477
@ kUnknown
Definition: cscore_oo.h:474
HttpCameraKind GetHttpCameraKind() const
Get the kind of HTTP camera.
Definition: cscore_oo.inc:327
A base class for single image reading sinks.
Definition: cscore_oo.h:941
void SetEnabled(bool enabled)
Enable or disable getting new frames.
Definition: cscore_oo.inc:596
std::string GetError() const
Get error string.
Definition: cscore_oo.inc:591
void SetDescription(std::string_view description)
Set sink description.
Definition: cscore_oo.inc:586
A base class for single image providing sources.
Definition: cscore_oo.h:611
VideoProperty CreateBooleanProperty(std::string_view name, bool defaultValue, bool value)
Create a boolean property.
Definition: cscore_oo.inc:432
void SetDescription(std::string_view description)
Set source description.
Definition: cscore_oo.inc:403
VideoProperty CreateIntegerProperty(std::string_view name, int minimum, int maximum, int step, int defaultValue, int value)
Create an integer property.
Definition: cscore_oo.inc:419
VideoProperty CreateProperty(std::string_view name, VideoProperty::Kind kind, int minimum, int maximum, int step, int defaultValue, int value)
Create a property.
Definition: cscore_oo.inc:408
void SetConnected(bool connected)
Set source connection status.
Definition: cscore_oo.inc:398
VideoProperty CreateStringProperty(std::string_view name, std::string_view value)
Create a string property.
Definition: cscore_oo.inc:443
void NotifyError(std::string_view msg)
Signal sinks that an error has occurred.
Definition: cscore_oo.inc:393
void SetEnumPropertyChoices(const VideoProperty &property, std::span< const std::string > choices)
Configure enum property choices.
Definition: cscore_oo.inc:455
A sink that acts as a MJPEG-over-HTTP network server.
Definition: cscore_oo.h:861
void SetFPS(int fps)
Set the stream frames per second (FPS) for clients that don't specify it.
Definition: cscore_oo.inc:569
void SetResolution(int width, int height)
Set the stream resolution for clients that don't specify it.
Definition: cscore_oo.inc:562
std::string GetListenAddress() const
Get the listen address of the server.
Definition: cscore_oo.inc:552
MjpegServer(std::string_view name, int port)
Create a MJPEG-over-HTTP server sink.
Definition: cscore_oo.h:880
void SetDefaultCompression(int quality)
Set the default compression used for non-MJPEG sources.
Definition: cscore_oo.inc:580
void SetCompression(int quality)
Set the compression for clients that don't specify it.
Definition: cscore_oo.inc:574
int GetPort() const
Get the port number of the server.
Definition: cscore_oo.inc:557
A source that represents a USB camera.
Definition: cscore_oo.h:418
UsbCameraInfo GetInfo() const
Get the full camera information for the device.
Definition: cscore_oo.inc:276
static std::vector< UsbCameraInfo > EnumerateUsbCameras()
Enumerate USB cameras on the local system.
Definition: cscore_oo.inc:261
std::string GetPath() const
Get the path to the device.
Definition: cscore_oo.inc:271
void SetConnectVerbose(int level)
Set how verbose the camera connection messages are.
Definition: cscore_oo.inc:281
void SetPath(std::string_view path)
Change the path to the device.
Definition: cscore_oo.inc:266
A source that represents a video camera.
Definition: cscore_oo.h:359
VideoCamera(CS_Source handle)
Definition: cscore_oo.h:412
void SetExposureAuto()
Set the exposure to auto aperature.
Definition: cscore_oo.inc:238
void SetWhiteBalanceManual(int value)
Set the white balance to manual, with specified color temperature.
Definition: cscore_oo.inc:233
void SetWhiteBalanceAuto()
Set the white balance to auto.
Definition: cscore_oo.inc:223
int GetBrightness()
Get the brightness, as a percentage (0-100).
Definition: cscore_oo.inc:218
void SetBrightness(int brightness)
Set the brightness, as a percentage (0-100).
Definition: cscore_oo.inc:213
void SetWhiteBalanceHoldCurrent()
Set the white balance to hold current.
Definition: cscore_oo.inc:228
void SetExposureManual(int value)
Set the exposure to manual, as a percentage (0-100).
Definition: cscore_oo.inc:248
WhiteBalance
Definition: cscore_oo.h:361
@ kFixedOutdoor1
Definition: cscore_oo.h:363
@ kFixedFlourescent2
Definition: cscore_oo.h:366
@ kFixedIndoor
Definition: cscore_oo.h:362
@ kFixedFluorescent1
Definition: cscore_oo.h:365
@ kFixedOutdoor2
Definition: cscore_oo.h:364
void SetExposureHoldCurrent()
Set the exposure to hold current.
Definition: cscore_oo.inc:243
An event generated by the library and provided to event listeners.
Definition: cscore_oo.h:972
VideoSink GetSink() const
Get the sink associated with the event (if any).
Definition: cscore_oo.inc:606
VideoProperty GetProperty() const
Get the property associated with the event (if any).
Definition: cscore_oo.inc:611
VideoSource GetSource() const
Get the source associated with the event (if any).
Definition: cscore_oo.inc:601
An event listener.
Definition: cscore_oo.h:994
friend void swap(VideoListener &first, VideoListener &second) noexcept
Definition: cscore_oo.h:1015
~VideoListener()
Definition: cscore_oo.inc:637
VideoListener & operator=(const VideoListener &)=delete
VideoListener(const VideoListener &)=delete
A source or sink property.
Definition: cscore_oo.h:39
int GetMin() const
Definition: cscore_oo.inc:33
int Get() const
Definition: cscore_oo.inc:23
bool IsInteger() const
Definition: cscore_oo.h:64
void SetString(std::string_view value)
Definition: cscore_oo.inc:64
bool IsEnum() const
Definition: cscore_oo.h:66
std::string GetName() const
Definition: cscore_oo.inc:18
int GetDefault() const
Definition: cscore_oo.inc:48
Kind
Definition: cscore_oo.h:46
@ kString
Definition: cscore_oo.h:50
@ kInteger
Definition: cscore_oo.h:49
@ kEnum
Definition: cscore_oo.h:51
@ kBoolean
Definition: cscore_oo.h:48
@ kNone
Definition: cscore_oo.h:47
CS_Status GetLastStatus() const
Definition: cscore_oo.h:83
void Set(int value)
Definition: cscore_oo.inc:28
bool IsBoolean() const
Definition: cscore_oo.h:63
std::vector< std::string > GetChoices() const
Definition: cscore_oo.inc:69
int GetStep() const
Definition: cscore_oo.inc:43
Kind GetKind() const
Definition: cscore_oo.h:58
bool IsString() const
Definition: cscore_oo.h:65
std::string GetString() const
Definition: cscore_oo.inc:53
int GetMax() const
Definition: cscore_oo.inc:38
A sink for video that accepts a sequence of frames.
Definition: cscore_oo.h:713
void SetSource(VideoSource source)
Configure which source should provide frames to this sink.
Definition: cscore_oo.inc:512
Kind
Definition: cscore_oo.h:718
@ kCv
Definition: cscore_oo.h:721
@ kUnknown
Definition: cscore_oo.h:719
@ kMjpeg
Definition: cscore_oo.h:720
VideoProperty GetProperty(std::string_view name)
Get a property of the sink.
Definition: cscore_oo.inc:507
friend void swap(VideoSink &first, VideoSink &second) noexcept
Definition: cscore_oo.h:845
std::string GetDescription() const
Get the sink description.
Definition: cscore_oo.inc:502
std::vector< VideoProperty > EnumerateProperties() const
Enumerate all properties of this sink.
Kind GetKind() const
Get the kind of the sink.
Definition: cscore_oo.inc:492
VideoProperty GetSourceProperty(std::string_view name)
Get a property of the associated source.
Definition: cscore_oo.inc:527
bool SetConfigJson(std::string_view config)
Set properties from a JSON configuration string.
Definition: cscore_oo.inc:532
int GetHandle() const
Definition: cscore_oo.h:732
VideoSource GetSource() const
Get the connected source.
Definition: cscore_oo.inc:521
CS_Status m_status
Definition: cscore_oo.h:854
VideoSink() noexcept=default
std::string GetConfigJson() const
Get a JSON configuration string.
Definition: cscore_oo.inc:542
bool operator==(const VideoSink &other) const
Definition: cscore_oo.h:734
CS_Sink m_handle
Definition: cscore_oo.h:855
VideoSink(CS_Sink handle)
Definition: cscore_oo.h:852
static std::vector< VideoSink > EnumerateSinks()
Enumerate all existing sinks.
std::string GetName() const
Get the name of the sink.
Definition: cscore_oo.inc:497
CS_Status GetLastStatus() const
Definition: cscore_oo.h:836
wpi::json GetConfigJsonObject() const
Get a JSON configuration object.
A source for video that provides a sequence of frames.
Definition: cscore_oo.h:97
std::vector< VideoSink > EnumerateSinks()
Enumerate all sinks connected to this source.
bool SetPixelFormat(VideoMode::PixelFormat pixelFormat)
Set the pixel format.
Definition: cscore_oo.inc:166
double GetActualDataRate() const
Get the data rate (in bytes per second).
Definition: cscore_oo.inc:202
CS_Source m_handle
Definition: cscore_oo.h:353
VideoSource() noexcept=default
VideoProperty GetProperty(std::string_view name)
Get a property.
Definition: cscore_oo.inc:144
VideoMode GetVideoMode() const
Get the current video mode.
Definition: cscore_oo.inc:149
CS_Status m_status
Definition: cscore_oo.h:352
int GetHandle() const
Definition: cscore_oo.h:138
friend void swap(VideoSource &first, VideoSource &second) noexcept
Definition: cscore_oo.h:343
VideoSource(CS_Source handle)
Definition: cscore_oo.h:350
std::vector< VideoProperty > EnumerateProperties() const
Enumerate all properties of this source.
bool IsConnected() const
Is the source currently connected to whatever is providing the images?
Definition: cscore_oo.inc:134
std::string GetDescription() const
Get the source description.
Definition: cscore_oo.inc:117
wpi::json GetConfigJsonObject() const
Get a JSON configuration object.
bool IsEnabled() const
Gets source enable status.
Definition: cscore_oo.inc:139
ConnectionStrategy
Connection strategy.
Definition: cscore_oo.h:110
@ kConnectionKeepOpen
Try to keep the connection open regardless of whether any sinks are connected.
Definition: cscore_oo.h:121
@ kConnectionAutoManage
Automatically connect or disconnect based on whether any sinks are connected to this source.
Definition: cscore_oo.h:115
@ kConnectionForceClose
Never open the connection.
Definition: cscore_oo.h:127
std::vector< VideoMode > EnumerateVideoModes() const
Enumerate all known video modes for this source.
Definition: cscore_oo.inc:208
uint64_t GetLastFrameTime() const
Get the last time a frame was captured.
Definition: cscore_oo.inc:122
double GetActualFPS() const
Get the actual FPS.
Definition: cscore_oo.inc:196
bool operator==(const VideoSource &other) const
Definition: cscore_oo.h:140
Kind
Definition: cscore_oo.h:102
@ kCv
Definition: cscore_oo.h:106
@ kHttp
Definition: cscore_oo.h:105
@ kUnknown
Definition: cscore_oo.h:103
@ kUsb
Definition: cscore_oo.h:104
bool SetConfigJson(std::string_view config)
Set video mode and properties from a JSON configuration string.
Definition: cscore_oo.inc:181
bool SetFPS(int fps)
Set the frames per second (FPS).
Definition: cscore_oo.inc:176
static std::vector< VideoSource > EnumerateSources()
Enumerate all existing sources.
void SetConnectionStrategy(ConnectionStrategy strategy)
Sets the connection strategy.
Definition: cscore_oo.inc:127
CS_Status GetLastStatus() const
Definition: cscore_oo.h:327
Kind GetKind() const
Get the kind of the source.
Definition: cscore_oo.inc:107
std::string GetConfigJson() const
Get a JSON configuration string.
Definition: cscore_oo.inc:191
bool SetResolution(int width, int height)
Set the resolution.
Definition: cscore_oo.inc:171
bool SetVideoMode(const VideoMode &mode)
Set the video mode.
Definition: cscore_oo.inc:154
std::string GetName() const
Get the name of the source.
Definition: cscore_oo.inc:112
basic_string_view< char > string_view
Definition: core.h:501
@ CS_CONNECTION_AUTO_MANAGE
Automatically connect or disconnect based on whether any sinks are connected to this source.
Definition: cscore_c.h:181
@ CS_CONNECTION_KEEP_OPEN
Try to keep the connection open regardless of whether any sinks are connected.
Definition: cscore_c.h:187
@ CS_CONNECTION_FORCE_CLOSE
Never open the connection.
Definition: cscore_c.h:193
@ CS_HTTP_MJPGSTREAMER
Definition: cscore_c.h:126
@ CS_HTTP_CSCORE
Definition: cscore_c.h:127
@ CS_HTTP_UNKNOWN
Definition: cscore_c.h:125
@ CS_HTTP_AXIS
Definition: cscore_c.h:128
@ CS_PROP_ENUM
Definition: cscore_c.h:107
@ CS_PROP_NONE
Definition: cscore_c.h:103
@ CS_PROP_INTEGER
Definition: cscore_c.h:105
@ CS_PROP_BOOLEAN
Definition: cscore_c.h:104
@ CS_PROP_STRING
Definition: cscore_c.h:106
@ CS_SINK_MJPEG
Definition: cscore_c.h:136
@ CS_SINK_CV
Definition: cscore_c.h:137
@ CS_SINK_UNKNOWN
Definition: cscore_c.h:135
@ CS_SOURCE_USB
Definition: cscore_c.h:115
@ CS_SOURCE_HTTP
Definition: cscore_c.h:116
@ CS_SOURCE_UNKNOWN
Definition: cscore_c.h:114
@ CS_SOURCE_CV
Definition: cscore_c.h:117
CS_Handle CS_Source
Definition: cscore_c.h:53
int CS_Status
Definition: cscore_c.h:46
CS_Handle CS_Property
Definition: cscore_c.h:49
CS_Handle CS_Sink
Definition: cscore_c.h:52
CS_Handle CS_Listener
Definition: cscore_c.h:50
CameraServer (cscore) namespace.
Definition: cscore_oo.inc:16
const T & first(const T &value, const Tail &...)
Definition: compile.h:60
WPI_BASIC_JSON_TPL_DECLARATION void swap(wpi::WPI_BASIC_JSON_TPL &j1, wpi::WPI_BASIC_JSON_TPL &j2) noexcept(//NOLINT(readability-inconsistent-declaration-parameter-name) is_nothrow_move_constructible< wpi::WPI_BASIC_JSON_TPL >::value &&//NOLINT(misc-redundant-expression) is_nothrow_move_assignable< wpi::WPI_BASIC_JSON_TPL >::value)
exchanges the values of two JSON objects
Definition: json.h:5219
fps
Definition: velocity.h:46
constexpr const char * name(const T &)
Listener event.
Definition: cscore_cpp.h:101
USB camera information.
Definition: cscore_cpp.h:44
Video mode.
Definition: cscore_cpp.h:62
PixelFormat
Definition: cscore_cpp.h:63