Miscellaneous

Miscellaneous Helper Functions. More...

Classes
struct	PlayEvent
struct	PauseEvent
struct	StopEvent
struct	TrickSpeedEvent
struct	StillPictureEvent
struct	DetachEvent
struct	AttachEvent
struct	BufferUnderrunEvent
struct	BufferingThresholdReachedEvent
struct	PipEvent
struct	ScheduleResyncAtPtsMsEvent
struct	ResyncEvent
class	IEventReceiver
	Event Receiver. More...
class	cBufferFillLevelLowPassFilter
	Fill Level Low Pass Filter. More...
class	cGrabBuffer
	Grabbing Buffer. More...
class	cSoftHdGrab
	Grabbing Processor. More...
class	cH264Parser
	H.264 Parser. More...
class	cHardwareDevice
	Hardware device. More...
class	cJitterTracker
	Jitter Tracker. More...
class	cSoftHdLogger
	Logger. More...
struct	CodecInfo
	Codec Information Structure. More...
class	cPes
	PES Packet Parser. More...
class	cPesVideo
	Video PES Packet Parser. More...
class	cPesAudio
	Audio PES Packet Parser. More...
class	cPtsTrackingBuffer
	PTS Tracking Buffer. More...
class	cReassemblyBuffer
	Base Class for Stream Reassembly Buffers. More...
class	cReassemblyBufferVideo
	Video Stream Reassembly Buffer. More...
struct	SyncWordInfo
	Information about a detected audio sync word. More...
class	cReassemblyBufferAudio
	Audio Stream Reassembly Buffer. More...
class	cPool< T >
	Pool Implementation Template Class. More...
class	cQueue< T >
	Thread-safe Queue. More...

Macros
#define	OPAQUE   0xff
#define	TRANSPARENT   0x00
#define	UNMULTIPLY(color, alpha)   ((0xff * color) / alpha)
#define	BLEND(back, front, alpha)   ((front * alpha) + (back * (255 - alpha))) / 255
#define	AV_LOGLEVEL   AV_LOG_INFO
	FFmpeg log level.
#define	LOGFATAL   cSoftHdLogger::GetLogger()->LogFatal
	log to LOG_ERR and abort
#define	LOGERROR   cSoftHdLogger::GetLogger()->LogError
	log to LOG_ERR
#define	LOGWARNING   cSoftHdLogger::GetLogger()->LogWarning
	log to LOG_WARN
#define	LOGINFO   cSoftHdLogger::GetLogger()->LogInfo
	log to LOG_INFO
#define	LOGDEBUG   cSoftHdLogger::GetLogger()->LogDebug
	log to LOG_DEBUG
#define	LOGDEBUG2   cSoftHdLogger::GetLogger()->LogDebug2
	log to LOG_DEBUG and add a prefix
#define	GL_CHECK(stmt)
	glCheckError macro
#define	EGL_CHECK(stmt)
	eglCheckError macro
#define	AV_NOPTS_VALUE   INT64_C(0x8000000000000000)
#define	VIDEO_SURFACES_MAX   3
	maximum video surfaces kept by the filter and render queues
#define	av_err2str(err)   av_err2string(err)

Typedefs
using	Event = std::variant< PlayEvent, PauseEvent, StopEvent, TrickSpeedEvent, StillPictureEvent, DetachEvent, AttachEvent, BufferUnderrunEvent, BufferingThresholdReachedEvent, PipEvent, ScheduleResyncAtPtsMsEvent, ResyncEvent >

Enumerations
enum	BufferUnderrunType { VIDEO , AUDIO }
enum	PipState {   PIPSTART , PIPSTOP , PIPTOGGLE , PIPCHANUP ,   PIPCHANDOWN , PIPCHANSWAP , PIPSIZECHANGE , PIPSWAPPOSITION }
enum	Grabtype { GRABVIDEO , GRABPIP , GRABOSD }
enum	NalUnitTypes {   NALU_TYPE_NON_IDR = (1 << 0) , NALU_TYPE_PART_A = (1 << 1) , NALU_TYPE_PART_B = (1 << 2) , NALU_TYPE_PART_C = (1 << 3) ,   NALU_TYPE_IDR = (1 << 4) , NALU_TYPE_SEI = (1 << 5) , NALU_TYPE_SPS = (1 << 6) , NALU_TYPE_PPS = (1 << 7) ,   NALU_TYPE_AUD = (1 << 8) }
	H.264 Nal unit types. More...
enum	HardwareQuirks {   QUIRK_NO_HW_DEINT = 1 << 0 , QUIRK_CODEC_FLUSH_WORKAROUND = 1 << 1 , QUIRK_CODEC_NEEDS_DIMENSION_PARSE = 1 << 2 , QUIRK_CODEC_SKIP_FIRST_FRAMES = 1 << 3 ,   QUIRK_CODEC_SKIP_NUM_FRAMES = 2 }
	Hardware dependent quirks. More...
enum	LogFlags {   L_DEBUG = (1 << 0) , L_AV_SYNC = (1 << 1) , L_SOUND = (1 << 2) , L_OSD = (1 << 3) ,   L_DRM = (1 << 4) , L_CODEC = (1 << 5) , L_STILL = (1 << 6) , L_TRICK = (1 << 7) ,   L_MEDIA = (1 << 8) , L_OPENGL = (1 << 9) , L_OPENGL_TIME = (1 << 10) , L_OPENGL_TIME_ALL = (1 << 11) ,   L_PACKET = (1 << 12) , L_GRAB = (1 << 13) , L_FFMPEG = (1 << 14) }
	Logger Flags. More...

Functions
enum AVPixelFormat	DrmFormatToAVFormat (cDrmBuffer *buf)
	Convert a DRM format to a ffmpeg AV format.
static uint8_t *	BufToRgb (cDrmBuffer *buf, int *size, int dstW, int dstH, enum AVPixelFormat dstPixFmt)
	Convert a DRM buffer to rgb format image.
static uint8_t *	ScaleRgb24 (uint8_t *src, int *size, int srcW, int srcH, int dstW, int dstH)
	Scale an image.
static void	AlphaBlend (uint8_t *result, uint8_t *front, uint8_t *back, const unsigned int width, const unsigned int height)
	Blend two images.
static int	BlitVideo (uint8_t *dst, uint8_t *src, int dstW, int dstH, int dstX, int dstY, int srcW, int srcH)
	Blit the video on black background.
uint8_t *	CreateJpeg (uint8_t *image, int *size, int quality, int width, int height)
	Call rgb to jpeg for C Plugin.
const char *	GrabtypeToString (Grabtype t)
bool	isValidStartCode (const uint8_t *data, int offset, int size, int &startCodeLength)
	H.264 Parser Helper to check for a 0x000001 or 0x00000001 start code.
static int	NalUnitType (const uint8_t *data, int offset, int startCodeLength)
	H.264 Parser Helper to get the nal unit type.
static size_t	ReadLineFromFile (char *buf, size_t size, const char *file)
	Helper function to read a line from a given file.
static void	glCheckError (const char *stmt, const char *fname, int line)
	Check for OpenGL errors and log them.
static void	eglCheckError (const char *stmt, const char *fname, int line)
	Check for EGL errors and log them.
static bool	isInterlacedFrame (AVFrame *frame)
	Check, if this is an interlaced frame.
static const char *	av_err2string (int errnum)
	Workaround for av_err2str() not working with C++.
static const char *	Timestamp2String (int64_t ts, uint8_t divisor)
	Nice time-stamp string.
static uint32_t	ReadBytes (const uint8_t *data, int count)
	Return count amount of bytes from data

Variables
static const std::map< AVCodecID, CodecInfo >	AudioCodecMap
	Map of Audio Codec Information.

Detailed Description

Miscellaneous Helper Functions.

Macro Definition Documentation

av_err2str

#define av_err2str

(

err

)

av_err2string(err)

Definition at line 112 of file misc.h.

AV_LOGLEVEL

#define AV_LOGLEVEL   AV_LOG_INFO

FFmpeg log level.

Definition at line 30 of file logger.h.

AV_NOPTS_VALUE

#define AV_NOPTS_VALUE   INT64_C(0x8000000000000000)

Definition at line 74 of file misc.h.

BLEND

#define BLEND	(		back,
			front,
			alpha
	)		((front * alpha) + (back * (255 - alpha))) / 255

Definition at line 40 of file grab.cpp.

EGL_CHECK

#define EGL_CHECK

(

stmt

)

Value:

        do { \
        stmt; \
		eglCheckError(#stmt, __FILE__, __LINE__); \
    } while (0)

eglCheckError macro

Definition at line 62 of file misc.h.

GL_CHECK

#define GL_CHECK

(

stmt

)

Value:

        do { \
        stmt; \
		glCheckError(#stmt, __FILE__, __LINE__); \
    } while (0)

glCheckError macro

Definition at line 56 of file misc.h.

LOGDEBUG

#define LOGDEBUG   cSoftHdLogger::GetLogger()->LogDebug

log to LOG_DEBUG

Definition at line 45 of file logger.h.

LOGDEBUG2

#define LOGDEBUG2   cSoftHdLogger::GetLogger()->LogDebug2

log to LOG_DEBUG and add a prefix

Definition at line 47 of file logger.h.

LOGERROR

#define LOGERROR   cSoftHdLogger::GetLogger()->LogError

log to LOG_ERR

Definition at line 39 of file logger.h.

LOGFATAL

#define LOGFATAL   cSoftHdLogger::GetLogger()->LogFatal

log to LOG_ERR and abort

Definition at line 37 of file logger.h.

LOGINFO

#define LOGINFO   cSoftHdLogger::GetLogger()->LogInfo

log to LOG_INFO

Definition at line 43 of file logger.h.

LOGWARNING

#define LOGWARNING   cSoftHdLogger::GetLogger()->LogWarning

log to LOG_WARN

Definition at line 41 of file logger.h.

OPAQUE

#define OPAQUE   0xff

Definition at line 37 of file grab.cpp.

TRANSPARENT

#define TRANSPARENT   0x00

Definition at line 38 of file grab.cpp.

UNMULTIPLY

#define UNMULTIPLY	(		color,
			alpha
	)		((0xff * color) / alpha)

Definition at line 39 of file grab.cpp.

VIDEO_SURFACES_MAX

#define VIDEO_SURFACES_MAX   3

maximum video surfaces kept by the filter and render queues

Definition at line 77 of file misc.h.

Typedef Documentation

Event

using Event = std::variant< PlayEvent, PauseEvent, StopEvent, TrickSpeedEvent, StillPictureEvent, DetachEvent, AttachEvent, BufferUnderrunEvent, BufferingThresholdReachedEvent, PipEvent, ScheduleResyncAtPtsMsEvent, ResyncEvent >

Definition at line 69 of file event.h.

Enumeration Type Documentation

BufferUnderrunType

enum BufferUnderrunType

Enumerator
VIDEO
AUDIO

Definition at line 27 of file event.h.

Grabtype

enum Grabtype

Enumerator
GRABVIDEO
GRABPIP
GRABOSD

Definition at line 27 of file grab.h.

HardwareQuirks

enum HardwareQuirks

Hardware dependent quirks.

Enumerator
QUIRK_NO_HW_DEINT	set, if no hw deinterlacer available
QUIRK_CODEC_FLUSH_WORKAROUND	set, if we have to close and reopen the codec instead of avcodec_flush_buffers (rpi)
QUIRK_CODEC_NEEDS_DIMENSION_PARSE	set, if codec needs some infos for init (coded_width and coded_height)
QUIRK_CODEC_SKIP_FIRST_FRAMES	set, if codec should skip first I-Frames
QUIRK_CODEC_SKIP_NUM_FRAMES	skip QUIRK_CODEC_SKIP_NUM_FRAMES, in case QUIRK_CODEC_SKIP_FIRST_FRAMES is set

Definition at line 27 of file hardwaredevice.h.

LogFlags

enum LogFlags

Logger Flags.

depending on the flag used in the macro, logging is enabled and gets a nice prefix in the syslog.

Enumerator
L_DEBUG	common debug logs
L_AV_SYNC	audio/video sync logs
L_SOUND	sound logs
L_OSD	osd logs
L_DRM	drm logs
L_CODEC	codec logs
L_STILL	stillpicture logs
L_TRICK	trickspeed logs
L_MEDIA	mediaplayer logs
L_OPENGL	opengl osd logs
L_OPENGL_TIME	opengl osd flush time measurement
L_OPENGL_TIME_ALL	opengl osd all commands time measurement
L_PACKET	decoder packet/frame tracking logs
L_GRAB	grabbing logs
L_FFMPEG	ffmpeg logs

Definition at line 55 of file logger.h.

NalUnitTypes

enum NalUnitTypes

H.264 Nal unit types.

Enumerator
NALU_TYPE_NON_IDR
NALU_TYPE_PART_A
NALU_TYPE_PART_B
NALU_TYPE_PART_C
NALU_TYPE_IDR
NALU_TYPE_SEI
NALU_TYPE_SPS
NALU_TYPE_PPS
NALU_TYPE_AUD

Definition at line 28 of file h264parser.h.

PipState

enum PipState

Enumerator
PIPSTART
PIPSTOP
PIPTOGGLE
PIPCHANUP
PIPCHANDOWN
PIPCHANSWAP
PIPSIZECHANGE
PIPSWAPPOSITION

Definition at line 32 of file event.h.

Function Documentation

AlphaBlend()

static void AlphaBlend ( uint8_t *  result, uint8_t *  front, uint8_t *  back, const unsigned int  width, const unsigned int  height  )

static

Blend two images.

Both, front and back image data have to be same size front is the OSD (ARGB) back is the video (RGB) result is RGB

Parameters

[out]	result	pointer to the resulting image data
[in]	front	pointer to the upper image data
[in]	back	pointer to the lower image data
[in]	width	image width
[in]	height	image height

Definition at line 204 of file grab.cpp.

References BLEND, OPAQUE, TRANSPARENT, and UNMULTIPLY.

Referenced by cSoftHdGrab::ProcessGrab().

av_err2string()

static const char * av_err2string ( int  errnum )

inlinestatic

Workaround for av_err2str() not working with C++.

Definition at line 100 of file misc.h.

BlitVideo()

static int BlitVideo ( uint8_t *  dst, uint8_t *  src, int  dstW, int  dstH, int  dstX, int  dstY, int  srcW, int  srcH  )

static

Blit the video on black background.

Parameters

[in]	dst	pointer to the destination video
[in]	src	pointer to the source video
[in]	dstW	destination width of the image
[in]	dstH	destination height of the image
[in]	dstX	x offset of the (already scaled) video on the image
[in]	dstY	y offset of the (already scaled) video on the image
[in]	srcW	source video width
[in]	srcH	source video height

Returns

0 on success, -1 on error

Definition at line 265 of file grab.cpp.

References L_GRAB, and LOGDEBUG2.

Referenced by cSoftHdGrab::ProcessGrab().

BufToRgb()

static uint8_t * BufToRgb ( cDrmBuffer *  buf, int *  size, int  dstW, int  dstH, enum AVPixelFormat  dstPixFmt  )

static

Convert a DRM buffer to rgb format image.

Conversion is done with ffmpegs swscale

Parameters

[in]	buf	pointer to the source drm buffer struct
[out]	size	size of the return data
[in]	dstW	width of the returned image
[in]	dstH	height of the returned image
[in]	dstPixFmt	pixel format of the returned image

Returns

a pointer to the image data

Definition at line 75 of file grab.cpp.

References DrmFormatToAVFormat(), L_GRAB, LOGDEBUG2, and LOGERROR.

Referenced by cSoftHdGrab::GetGrab().

CreateJpeg()

uint8_t * CreateJpeg	(	uint8_t *	image,
		int *	size,
		int	quality,
		int	width,
		int	height
	)

Call rgb to jpeg for C Plugin.

Definition at line 286 of file grab.cpp.

Referenced by cSoftHdGrab::ProcessGrab().

DrmFormatToAVFormat()

enum AVPixelFormat DrmFormatToAVFormat

(

cDrmBuffer *

buf

)

Convert a DRM format to a ffmpeg AV format.

Definition at line 45 of file grab.cpp.

Referenced by BufToRgb().

eglCheckError()

static void eglCheckError ( const char *  stmt, const char *  fname, int  line  )

inlinestatic

Check for EGL errors and log them.

Definition at line 49 of file misc.h.

References LOGERROR.

glCheckError()

static void glCheckError ( const char *  stmt, const char *  fname, int  line  )

inlinestatic

Check for OpenGL errors and log them.

Definition at line 40 of file misc.h.

References LOGERROR.

GrabtypeToString()

const char * GrabtypeToString ( Grabtype  t )

inline

Definition at line 33 of file grab.h.

References GRABOSD, GRABPIP, and GRABVIDEO.

Referenced by cSoftHdGrab::GetGrab().

isInterlacedFrame()

static bool isInterlacedFrame ( AVFrame *  frame )

inlinestatic

Check, if this is an interlaced frame.

Parameters

frame

AVFrame

Returns

true, if this frame is an interlaced frame

Definition at line 86 of file misc.h.

Referenced by cVideoFilter::Action(), cVideoDecoder::ReceiveFrame(), and cVideoStream::RenderFrame().

isValidStartCode()

bool isValidStartCode	(	const uint8_t *	data,
		int	offset,
		int	size,
		int &	startCodeLength
	)

H.264 Parser Helper to check for a 0x000001 or 0x00000001 start code.

Parameters

[in]	data	pointer to the data stream
[in]	offset	start parsing at offset
[in]	size	size of data
[out]	startCodeLength	start code length (3 or 4)

Return values

true	if a valid start code was detected
false	no valid startcode was detected

Definition at line 42 of file h264parser.cpp.

References ReadBytes().

Referenced by cH264Parser::cH264Parser(), cH264Parser::GetPPSOffset(), cH264Parser::GetSliceOffset(), and cH264Parser::GetSPSOffset().

NalUnitType()

static int NalUnitType ( const uint8_t *  data, int  offset, int  startCodeLength  )

static

H.264 Parser Helper to get the nal unit type.

Parameters

data	pointer to the data stream
offset	start parsing at offset
startCodeLength	start code length (3 or 4)

Returns

the nal unit type

Definition at line 68 of file h264parser.cpp.

Referenced by cH264Parser::cH264Parser(), cH264Parser::GetPPSOffset(), cH264Parser::GetSliceOffset(), and cH264Parser::GetSPSOffset().

ReadBytes()

static uint32_t ReadBytes ( const uint8_t *  data, int  count  )

inlinestatic

Return count amount of bytes from data

Definition at line 149 of file misc.h.

Referenced by cReassemblyBufferVideo::HasLeadingZero(), cPes::IsHeaderValid(), isValidStartCode(), and cReassemblyBufferVideo::ParseCodecHeader().

ReadLineFromFile()

static size_t ReadLineFromFile ( char *  buf, size_t  size, const char *  file  )

inlinestatic

Helper function to read a line from a given file.

Parameters

[out]	buf	pointer to the data
[out]	size	size of the data at buf
[in]	file	the filepointer to be read on

Returns

the number of characters read

Definition at line 46 of file hardwaredevice.h.

References LOGERROR.

Referenced by cHardwareDevice::cHardwareDevice().

ScaleRgb24()

static uint8_t * ScaleRgb24 ( uint8_t *  src, int *  size, int  srcW, int  srcH, int  dstW, int  dstH  )

static

Scale an image.

Conversion is done with ffmpegs swscale

Parameters

[in]	src	pointer to the source data
[out]	size	size of the return data
[in]	srcW	source width
[in]	srcH	source height
[in]	dstW	width of the returned image
[in]	dstH	height of the returned image

Returns

a pointer to the converted image data

Definition at line 153 of file grab.cpp.

References L_GRAB, LOGDEBUG2, and LOGERROR.

Referenced by cSoftHdGrab::ProcessGrab().

Timestamp2String()

static const char * Timestamp2String ( int64_t  ts, uint8_t  divisor  )

inlinestatic

Nice time-stamp string.

Parameters

ts	time stamp
divisor	optional divisor for the given timestamp int (must be > 0)

Returns

nice formatted timestamp string

Definition at line 127 of file misc.h.

References AV_NOPTS_VALUE.

Referenced by cVideoRender::DisplayFrame(), cSoftHdAudio::DropSamplesOlderThanPtsMs(), cSoftHdAudio::Enqueue(), cSoftHdDevice::IsBufferingThresholdReached(), cVideoRender::LogDroppedDuped(), cVideoRender::PageFlip(), cVideoDecoder::ReceiveFrame(), and cVideoDecoder::SendPacket().

Variable Documentation

AudioCodecMap

const std::map<AVCodecID, CodecInfo> AudioCodecMap

static

Map of Audio Codec Information.

Key: AVCodecID Value: CodecInfo with sync word detection and frame size calculation lambdas

Definition at line 47 of file pes.cpp.

Referenced by cReassemblyBufferAudio::DetectCodecFromSyncWord(), cReassemblyBufferAudio::FindTwoConsecutiveFramesWithSameSyncWord(), cReassemblyBufferAudio::GetFrameSizeForCodec(), and cReassemblyBufferAudio::PopAvPacket().