fpsdk::common::cam Namespace Reference

Camera types and utilities. More...

Classes
struct	CamData
	Camera data from CamStream (or from FPL, see fpl::CamData). More...
struct	CamStreamParams
	Camera stream parameters. More...
class	CamStream
	Camera streaming from from PBx-A1 sensor. More...

Typedefs
using	CamStreamPtr = std::unique_ptr<CamStream>
	Pointer to a CamStream instance, see CreateCamStream().

Enumerations
enum class	CamId : uint8_t {   UNSPECIFIED = 0 , CAM1 = 1 , CAM2 = 2 , CAM3 = 3 ,   CAM4 = 4 }
	Camera ID. More...
enum class	CamDataType : uint8_t {   UNSPECIFIED = 0 , HIRES_IMG = 1 , LORES_IMG = 2 , HIRES_VID = 3 ,   LORES_VID = 4 }
	Camera data type (type of data). More...
enum class	CamDataFmt : uint8_t {   UNSPECIFIED = 0 , H264_NAL = 1 , H265_NAL = 2 , MJPEG = 3 ,   JPEG = 4 , Y8 = 5 , NV12 = 6 , RGB24 = 7 }
	Camera data format. More...
enum class	CamDataFrm : uint8_t {   UNSPECIFIED = 0 , I_FRAME = 1 , P_FRAME = 2 , FULL = 3 ,   OTHER = 4 }
	Camera frame type. More...

Functions
const char *	CamIdToStr (const CamId camid)
	Stringify camera ID enum.
CamId	CamIdFromStrOr (const char *str, const CamId def)
	Convert camera ID string to enum.
CamId	CamIdFromValOr (const uint8_t val, const CamId def)
	Convert camera ID value to enum.
const char *	CamDataTypeToStr (const CamDataType type)
	Stringify camera data type enum.
CamDataType	CamDataTypeFromStrOr (const char *str, const CamDataType def)
	Convert camera data type string to enum.
CamDataType	CamDataTypeFromValOr (const uint8_t val, const CamDataType def)
	Convert camera data type value to enum.
const char *	CamDataFmtToStr (const CamDataFmt fmt)
	Stringify camera data format enum.
CamDataFmt	CamDataFmtFromStrOr (const char *str, const CamDataFmt def)
	Convert camera data format string to enum.
CamDataFmt	CamDataFmtFromValOr (const uint8_t val, const CamDataFmt def)
	Convert camera data format value to enum.
const char *	CamDataFrmToStr (const CamDataFrm frm)
	Stringify camera data frame type enum.
CamDataFrm	CamDataFrmFromStrOr (const char *str, const CamDataFrm def)
	Convert camera data frame type string to enum.
CamDataFrm	CamDataFrmFromValOr (const uint8_t val, const CamDataFrm def)
	Convert camera data frame type value to enum.
CamStreamPtr	CreateCamStream (const CamStreamParams &params)
	Create a camera stream instance.

Detailed Description

Camera types and utilities.

Typedef Documentation

CamStreamPtr

using fpsdk::common::cam::CamStreamPtr = std::unique_ptr<CamStream>

Pointer to a CamStream instance, see CreateCamStream().

Definition at line 304 of file cam.hpp.

Enumeration Type Documentation

CamId

enum class fpsdk::common::cam::CamId : uint8_t

strong

Camera ID.

Enumerator
UNSPECIFIED	Unspecified.
CAM1	Camera 1.
CAM2	Camera 2.
CAM3	Camera 3.
CAM4	Camera 4.

Definition at line 42 of file cam.hpp.

CamDataType

enum class fpsdk::common::cam::CamDataType : uint8_t

strong

Camera data type (type of data).

Enumerator
UNSPECIFIED	Unspecified.
HIRES_IMG	High-res image.
LORES_IMG	Low-res image.
HIRES_VID	High-res video.
LORES_VID	Low-res video.

Definition at line 85 of file cam.hpp.

CamDataFmt

enum class fpsdk::common::cam::CamDataFmt : uint8_t

strong

Camera data format.

Enumerator
UNSPECIFIED	Invalid.
H264_NAL	H.264 NAL (AVC) (video/avc).
H265_NAL	H.265 NAL (HEVC) (video/hevc).
MJPEG	Motion JPEG (image/jpeg).
JPEG	JPEG (image/jpeg).
Y8	Planar Y (greyscale), 8bpp.
NV12	Planar YUV 4:2:0, 12bpp.
RGB24	Packed RGB 8:8:8, 24bpp.

Definition at line 128 of file cam.hpp.

CamDataFrm

enum class fpsdk::common::cam::CamDataFrm : uint8_t

strong

Camera frame type.

Enumerator
UNSPECIFIED	Unspecified, invalid data.
I_FRAME	I-frame (= Horizon camsys MC_H26[45]_NALU_TYPE_I).
P_FRAME	P-frame (= Horizon camsys MC_H26[45]_NALU_TYPE_P).
FULL	Full frame (non-encoded, e.g. NV12 or JPEG).
OTHER	Other frame type (unexpected).

Definition at line 176 of file cam.hpp.

Function Documentation

CamIdToStr()

const char * fpsdk::common::cam::CamIdToStr

(

const CamId

camid

)

Stringify camera ID enum.

Parameters

[in]

camid

Camera ID

Returns

the stringification of the CameraId, or "?" for bad enum values

CamIdFromStrOr()

CamId fpsdk::common::cam::CamIdFromStrOr	(	const char *	str,
		const CamId	def )

Convert camera ID string to enum.

Parameters

[in]	str	Camera ID string
[in]	def	Default camera ID, for bad str

Returns

the camera ID, or def if str was invalid

CamIdFromValOr()

CamId fpsdk::common::cam::CamIdFromValOr	(	const uint8_t	val,
		const CamId	def )

Convert camera ID value to enum.

Parameters

[in]	val	Camera ID value
[in]	def	Default camera data type, for bad str

Returns

the camera data type, or def if str was invalid

CamDataTypeToStr()

const char * fpsdk::common::cam::CamDataTypeToStr

(

const CamDataType

type

)

Stringify camera data type enum.

Parameters

[in]

type

Camera data type

Returns

the stringification of the camera data type, or "?" for bad enum values

CamDataTypeFromStrOr()

CamDataType fpsdk::common::cam::CamDataTypeFromStrOr	(	const char *	str,
		const CamDataType	def )

Convert camera data type string to enum.

Parameters

[in]	str	Camera data type string
[in]	def	Default camera data type, for bad str

Returns

the camera data type, or def if str was invalid

CamDataTypeFromValOr()

CamDataType fpsdk::common::cam::CamDataTypeFromValOr	(	const uint8_t	val,
		const CamDataType	def )

Convert camera data type value to enum.

Parameters

[in]	val	Camera data type value
[in]	def	Default camera data type, for bad str

Returns

the camera data type, or def if str was invalid

CamDataFmtToStr()

const char * fpsdk::common::cam::CamDataFmtToStr

(

const CamDataFmt

fmt

)

Stringify camera data format enum.

Parameters

[in]

fmt

Camera data format

Returns

the stringification of the camera data format, or "?" for bad enum values

CamDataFmtFromStrOr()

CamDataFmt fpsdk::common::cam::CamDataFmtFromStrOr	(	const char *	str,
		const CamDataFmt	def )

Convert camera data format string to enum.

Parameters

[in]	str	Camera data format string
[in]	def	Default camera data format, for bad str

Returns

the camera data format, or def if str was invalid

CamDataFmtFromValOr()

CamDataFmt fpsdk::common::cam::CamDataFmtFromValOr	(	const uint8_t	val,
		const CamDataFmt	def )

Convert camera data format value to enum.

Parameters

[in]	val	Camera data format value
[in]	def	Default camera data format, for bad str

Returns

the camera data format, or def if str was invalid

CamDataFrmToStr()

const char * fpsdk::common::cam::CamDataFrmToStr

(

const CamDataFrm

frm

)

Stringify camera data frame type enum.

Parameters

[in]

frm

Camera data frame type

Returns

the stringification of the camera data frame type, or "?" for bad enum values

CamDataFrmFromStrOr()

CamDataFrm fpsdk::common::cam::CamDataFrmFromStrOr	(	const char *	str,
		const CamDataFrm	def )

Convert camera data frame type string to enum.

Parameters

[in]	str	Camera data frame type string
[in]	def	Default camera data frame type, for bad str

Returns

the camera data frame type, or def if str was invalid

CamDataFrmFromValOr()

CamDataFrm fpsdk::common::cam::CamDataFrmFromValOr	(	const uint8_t	val,
		const CamDataFrm	def )

Convert camera data frame type value to enum.

Parameters

[in]	val	Camera data frame type value
[in]	def	Default camera data frame type, for bad str

Returns

the camera data frame type, or def if str was invalid

CreateCamStream()

CamStreamPtr fpsdk::common::cam::CreateCamStream

(

const CamStreamParams &

params

)

Create a camera stream instance.

Parameters

[in]

params

The parameters

Returns

the video frame decoder instances, or nullptr if it failed (bad params)