#include <libmythtv/recorders/ExternalStreamHandler.h>

Inheritance diagram for ExternalStreamHandler:

Collaboration diagram for ExternalStreamHandler:

Public Member Functions
	ExternalStreamHandler (const QString &path, int inputid, int majorid)

	~ExternalStreamHandler (void) override

void	run (void) override
	Runs the Qt event loop unless we have a QRunnable, in which case we run the runnable run instead. More...

void	PriorityEvent (int fd) override

QString	GetDescription (void)

QString	UpdateDescription (void)

bool	IsDamaged (void) const

void	ClearDamaged (void)

bool	IsAppOpen (void)

bool	IsTSOpen (void)

bool	HasTuner (void) const

bool	HasPictureAttributes (void) const

bool	RestartStream (void)

void	LockReplay (void)

void	UnlockReplay (bool enable_replay=false)

void	ReplayStream (void)

bool	StartStreaming (void)

bool	StopStreaming (void)

bool	CheckForError (void)

void	PurgeBuffer (void)

bool	ProcessCommand (const QString &cmd, QString &result, std::chrono::milliseconds timeout=4s, uint retry_cnt=3)

bool	ProcessVer1 (const QString &cmd, QString &result, std::chrono::milliseconds timeout, uint retry_cnt)

bool	ProcessVer2 (const QString &command, QString &result, std::chrono::milliseconds timeout, uint retry_cnt)

bool	ProcessJson (const QVariantMap &vmsg, QVariantMap &elements, QByteArray &response, std::chrono::milliseconds timeout=4s, uint retry_cnt=3)

int	APIVersion (void) const

Public Member Functions inherited from StreamHandler
virtual void	AddListener (MPEGStreamData *data, bool allow_section_reader=false, bool needs_buffering=false, const QString &output_file=QString())

virtual void	RemoveListener (MPEGStreamData *data)

bool	IsRunning (void) const

bool	HasError (void) const

virtual bool	AddNamedOutputFile (const QString &filename)
	Called with _listener_lock locked just after adding new output file. More...

virtual void	RemoveNamedOutputFile (const QString &filename)
	Called with _listener_lock locked just before removing old output file. More...

virtual void	ReaderPaused (int fd)=0

virtual void	PriorityEvent (int fd)=0

Static Public Member Functions
static ExternalStreamHandler *	Get (const QString &devname, int inputid, int majorid)

static void	Return (ExternalStreamHandler *&ref, int inputid)

Private Types
enum	constants { MAX_API_VERSION = 3 , TS_PACKET_SIZE = 188 , PACKET_SIZE = TS_PACKET_SIZE * 8192 , TOO_FAST_SIZE = TS_PACKET_SIZE * 32768 }

Private Member Functions
int	StreamingCount (void) const

bool	SetAPIVersion (void)

bool	OpenApp (void)

void	CloseApp (void)

Private Attributes
QString	m_loc

int	m_majorId

QMutex	m_ioLock

ExternIO *	m_io {nullptr}

QStringList	m_args

QString	m_app

bool	m_tsOpen {false}

int	m_ioErrCnt {0}

bool	m_pollMode {false}

int	m_apiVersion {1}

uint	m_serialNo {0}

bool	m_hasTuner {false}

bool	m_hasPictureAttributes {false}

QByteArray	m_replayBuffer

bool	m_replay {false}

bool	m_xon {false}

bool	m_damaged {false}

QAtomicInt	m_streamingCnt

QMutex	m_streamLock

QMutex	m_replayLock

QMutex	m_processLock

Static Private Attributes
static QMutex	s_handlersLock

static QMap< int, ExternalStreamHandler * >	s_handlers

static QMap< int, uint >	s_handlersRefCnt

Additional Inherited Members
Protected Types inherited from StreamHandler
using	StreamDataList = QHash< MPEGStreamData *, QString >

Protected Member Functions inherited from StreamHandler
	StreamHandler (QString device, int inputid)

	~StreamHandler () override

void	Start (void)

void	Stop (void)

void	SetRunning (bool running, bool using_buffering, bool using_section_reader)

bool	AddPIDFilter (PIDInfo *info)

bool	RemovePIDFilter (uint pid)

bool	RemoveAllPIDFilters (void)

void	UpdateListeningForEIT (void)

bool	UpdateFiltersFromStreamData (void)

virtual bool	UpdateFilters (void)

virtual void	CycleFiltersByPriority ()

PIDPriority	GetPIDPriority (uint pid) const

void	ReaderPaused (int fd) override

void	PriorityEvent (int fd) override

virtual PIDInfo *	CreatePIDInfo (uint pid, uint stream_type, int pes_type)

void	WriteMPTS (const unsigned char *buffer, uint len)
	Write out a copy of the raw MPTS. More...

virtual void	SetRunningDesired (bool desired)
	At minimum this sets _running_desired, this may also send signals to anything that might be blocking the run() loop. More...

Protected Member Functions inherited from MThread
virtual void	run (void)
	Runs the Qt event loop unless we have a QRunnable, in which case we run the runnable run instead. More...

int	exec (void)
	Enters the qt event loop. call exit or quit to exit thread. More...

	MThread (const QString &objectName)
	Standard constructor. More...

	MThread (const QString &objectName, QRunnable *runnable)
	Use this constructor if you want the default run() method to run the QRunnable's run() method instead of entering the Qt event loop. More...

virtual	~MThread ()

	MThread (const MThread &)=delete

MThread &	operator= (const MThread &)=delete

void	RunProlog (void)
	Sets up a thread, call this if you reimplement run(). More...

void	RunEpilog (void)
	Cleans up a thread's resources, call this if you reimplement run(). More...

QThread *	qthread (void)
	Returns the thread, this will always return the same pointer no matter how often you restart the thread. More...

void	setObjectName (const QString &name)

QString	objectName (void) const

void	setPriority (QThread::Priority priority)

QThread::Priority	priority (void) const

bool	isFinished (void) const

bool	isRunning (void) const

void	setStackSize (uint stackSize)

uint	stackSize (void) const

void	exit (int retcode=0)
	Use this to exit from the thread if you are using a Qt event loop. More...

void	start (QThread::Priority p=QThread::InheritPriority)
	Tell MThread to start running the thread in the near future. More...

void	terminate (void)
	Kill a thread unsafely. More...

void	quit (void)
	calls exit(0) More...

bool	wait (std::chrono::milliseconds time=std::chrono::milliseconds::max())
	Wait for the MThread to exit, with a maximum timeout. More...

Protected Member Functions inherited from DeviceReaderCB
virtual	~DeviceReaderCB ()=default

virtual void	ReaderPaused (int fd)=0

virtual void	PriorityEvent (int fd)=0

Static Protected Member Functions inherited from MThread
static void	setTerminationEnabled (bool enabled=true)

static void	usleep (std::chrono::microseconds time)

template<typename R , typename P >
static std::enable_if_t< std::chrono::treat_as_floating_point< R >::value, void >	usleep (std::chrono::duration< R, P > time)

static void	ThreadSetup (const QString &name)
	This is to be called on startup in those few threads that haven't been ported to MThread. More...

static void	ThreadCleanup (void)
	This is to be called on exit in those few threads that haven't been ported to MThread. More...

static void	Cleanup (void)
	This will print out all the running threads, call exit(1) on each and then wait up to 5 seconds total for all the threads to exit. More...

static void	GetAllThreadNames (QStringList &list)

static void	GetAllRunningThreadNames (QStringList &list)

Protected Attributes inherited from StreamHandler
QString	m_device

int	m_inputId

bool	m_needsBuffering {false}

bool	m_allowSectionReader {false}

QMutex	m_addRmLock

QMutex	m_startStopLock

volatile bool	m_runningDesired {false}

volatile bool	m_bError {false}

bool	m_running {false}

bool	m_restarting {false}

bool	m_usingBuffering {false}

bool	m_usingSectionReader {false}

QWaitCondition	m_runningStateChanged

QRecursiveMutex	m_pidLock

std::vector< uint >	m_eitPids

PIDInfoMap	m_pidInfo

uint	m_openPidFilters {0}

bool	m_filtersChanged {false}

MythTimer	m_cycleTimer

ThreadedFileWriter *	m_mptsTfw {nullptr}

QSet< QString >	m_mptsFiles

QString	m_mptsBaseFile

QMutex	m_mptsLock

QRecursiveMutex	m_listenerLock

StreamDataList	m_streamDataList

Protected Attributes inherited from MThread
MThreadInternal *	m_thread {nullptr}

QRunnable *	m_runnable {nullptr}

bool	m_prologExecuted {true}

bool	m_epilogExecuted {true}

Detailed Description

Definition at line 69 of file ExternalStreamHandler.h.

Member Enumeration Documentation

◆ constants

enum ExternalStreamHandler::constants

private

Enumerator
MAX_API_VERSION
TS_PACKET_SIZE
PACKET_SIZE
TOO_FAST_SIZE

Definition at line 71 of file ExternalStreamHandler.h.

Constructor & Destructor Documentation

◆ ExternalStreamHandler()

ExternalStreamHandler::ExternalStreamHandler	(	const QString &	path,
		int	inputid,
		int	majorid
	)

explicit

Definition at line 544 of file ExternalStreamHandler.cpp.

Referenced by Get().

◆ ~ExternalStreamHandler()

ExternalStreamHandler::~ExternalStreamHandler ( void )

inlineoverride

Definition at line 84 of file ExternalStreamHandler.h.

Member Function Documentation

◆ APIVersion()

int ExternalStreamHandler::APIVersion ( void ) const

inline

Definition at line 123 of file ExternalStreamHandler.h.

Referenced by ExternalChannel::Tune().

◆ CheckForError()

bool ExternalStreamHandler::CheckForError ( void )

Definition at line 1675 of file ExternalStreamHandler.cpp.

Referenced by run().

◆ ClearDamaged()

void ExternalStreamHandler::ClearDamaged ( void )

inline

Definition at line 92 of file ExternalStreamHandler.h.

Referenced by ExternalRecorder::run().

◆ CloseApp()

void ExternalStreamHandler::CloseApp ( void )

private

Definition at line 1034 of file ExternalStreamHandler.cpp.

Referenced by run(), and ~ExternalStreamHandler().

◆ Get()

ExternalStreamHandler * ExternalStreamHandler::Get	(	const QString &	devname,
		int	inputid,
		int	majorid
	)

static

Definition at line 464 of file ExternalStreamHandler.cpp.

Referenced by ExternalSignalMonitor::ExternalSignalMonitor(), ExternalRecorder::Open(), and ExternalChannel::Open().

◆ GetDescription()

QString ExternalStreamHandler::GetDescription ( void )

inline

Definition at line 89 of file ExternalStreamHandler.h.

Referenced by ExternalChannel::GetDescription().

◆ HasPictureAttributes()

bool ExternalStreamHandler::HasPictureAttributes ( void ) const

inline

Definition at line 96 of file ExternalStreamHandler.h.

◆ HasTuner()

bool ExternalStreamHandler::HasTuner ( void ) const

inline

Definition at line 95 of file ExternalStreamHandler.h.

Referenced by ExternalChannel::Tune(), and ExternalRecChannelFetcher::Valid().

◆ IsAppOpen()

bool ExternalStreamHandler::IsAppOpen ( void )

Definition at line 1007 of file ExternalStreamHandler.cpp.

Referenced by ExternalRecorder::Open(), ExternalChannel::Open(), OpenApp(), StartStreaming(), and StopStreaming().

◆ IsDamaged()

bool ExternalStreamHandler::IsDamaged ( void ) const

inline

Definition at line 91 of file ExternalStreamHandler.h.

Referenced by ExternalRecorder::run().

◆ IsTSOpen()

bool ExternalStreamHandler::IsTSOpen ( void )

Definition at line 1020 of file ExternalStreamHandler.cpp.

Referenced by run().

◆ LockReplay()

void ExternalStreamHandler::LockReplay ( void )

inline

Definition at line 100 of file ExternalStreamHandler.h.

◆ OpenApp()

bool ExternalStreamHandler::OpenApp ( void )

private

Definition at line 914 of file ExternalStreamHandler.cpp.

Referenced by ExternalStreamHandler().

◆ PriorityEvent()

void ExternalStreamHandler::PriorityEvent ( int fd )

overridevirtual

Implements DeviceReaderCB.

Definition at line 1785 of file ExternalStreamHandler.cpp.

◆ ProcessCommand()

bool ExternalStreamHandler::ProcessCommand	(	const QString &	cmd,
		QString &	result,
		std::chrono::milliseconds	timeout = `4s`,
		uint	retry_cnt = `3`
	)

Definition at line 1242 of file ExternalStreamHandler.cpp.

Referenced by CloseApp(), ExternalRecChannelFetcher::FetchChannel(), ExternalSignalMonitor::GetLockTimeout(), ExternalSignalMonitor::GetSignalStrengthPercent(), ExternalChannel::GetTuneStatus(), ExternalSignalMonitor::HasLock(), IsAppOpen(), IsTSOpen(), ExternalRecChannelFetcher::LoadChannels(), OpenApp(), ReplayStream(), run(), SetAPIVersion(), StartStreaming(), StopStreaming(), ExternalChannel::Tune(), and UpdateDescription().

◆ ProcessJson()

bool ExternalStreamHandler::ProcessJson	(	const QVariantMap &	vmsg,
		QVariantMap &	elements,
		QByteArray &	response,
		std::chrono::milliseconds	timeout = `4s`,
		uint	retry_cnt = `3`
	)

Definition at line 1525 of file ExternalStreamHandler.cpp.

Referenced by ProcessCommand(), and ExternalChannel::Tune().

◆ ProcessVer1()

bool ExternalStreamHandler::ProcessVer1	(	const QString &	cmd,
		QString &	result,
		std::chrono::milliseconds	timeout,
		uint	retry_cnt
	)

Definition at line 1277 of file ExternalStreamHandler.cpp.

Referenced by ProcessCommand().

◆ ProcessVer2()

bool ExternalStreamHandler::ProcessVer2	(	const QString &	command,
		QString &	result,
		std::chrono::milliseconds	timeout,
		uint	retry_cnt
	)

Definition at line 1383 of file ExternalStreamHandler.cpp.

Referenced by ProcessCommand().

◆ PurgeBuffer()

void ExternalStreamHandler::PurgeBuffer ( void )

Definition at line 1775 of file ExternalStreamHandler.cpp.

Referenced by StopStreaming().

◆ ReplayStream()

void ExternalStreamHandler::ReplayStream ( void )

Definition at line 1090 of file ExternalStreamHandler.cpp.

◆ RestartStream()

bool ExternalStreamHandler::RestartStream ( void )

Definition at line 1072 of file ExternalStreamHandler.cpp.

Referenced by run().

◆ Return()

void ExternalStreamHandler::Return	(	ExternalStreamHandler *&	ref,
		int	inputid
	)

static

Definition at line 495 of file ExternalStreamHandler.cpp.

Referenced by ExternalRecChannelFetcher::Close(), ExternalRecorder::Close(), ExternalChannel::Close(), ExternalSignalMonitor::ExternalSignalMonitor(), ExternalRecorder::Open(), and ExternalSignalMonitor::~ExternalSignalMonitor().

◆ run()

void ExternalStreamHandler::run ( void )

overridevirtual

Runs the Qt event loop unless we have a QRunnable, in which case we run the runnable run instead.

Note: If you override this method you must call RunProlog before you do any work and RunEpilog before you exit the run method.

Reimplemented from MThread.

Definition at line 579 of file ExternalStreamHandler.cpp.

◆ SetAPIVersion()

bool ExternalStreamHandler::SetAPIVersion ( void )

private

Definition at line 874 of file ExternalStreamHandler.cpp.

Referenced by OpenApp().

◆ StartStreaming()

bool ExternalStreamHandler::StartStreaming ( void )

Definition at line 1133 of file ExternalStreamHandler.cpp.

Referenced by RestartStream(), ExternalRecorder::StartStreaming(), and ExternalSignalMonitor::UpdateValues().

◆ StopStreaming()

bool ExternalStreamHandler::StopStreaming ( void )

Definition at line 1183 of file ExternalStreamHandler.cpp.

Referenced by RestartStream(), ExternalSignalMonitor::Stop(), and ExternalRecorder::StopStreaming().

◆ StreamingCount()

int ExternalStreamHandler::StreamingCount ( void ) const

private

Definition at line 574 of file ExternalStreamHandler.cpp.

Referenced by RestartStream(), run(), StartStreaming(), and StopStreaming().

◆ UnlockReplay()

void ExternalStreamHandler::UnlockReplay ( bool enable_replay = false )

inline

Definition at line 101 of file ExternalStreamHandler.h.

◆ UpdateDescription()

QString ExternalStreamHandler::UpdateDescription ( void )

Definition at line 899 of file ExternalStreamHandler.cpp.

Referenced by OpenApp(), StartStreaming(), and ExternalChannel::UpdateDescription().

Member Data Documentation

◆ m_apiVersion

int ExternalStreamHandler::m_apiVersion {1}

private

Definition at line 141 of file ExternalStreamHandler.h.

Referenced by APIVersion(), CheckForError(), OpenApp(), ProcessCommand(), SetAPIVersion(), and UpdateDescription().

◆ m_app

QString ExternalStreamHandler::m_app

private

Definition at line 136 of file ExternalStreamHandler.h.

Referenced by ExternalStreamHandler(), and OpenApp().

◆ m_args

QStringList ExternalStreamHandler::m_args

private

Definition at line 135 of file ExternalStreamHandler.h.

Referenced by CloseApp(), ExternalStreamHandler(), and OpenApp().

◆ m_damaged

bool ExternalStreamHandler::m_damaged {false}

private

Definition at line 149 of file ExternalStreamHandler.h.

Referenced by CheckForError(), ClearDamaged(), IsDamaged(), and RestartStream().

◆ m_hasPictureAttributes

bool ExternalStreamHandler::m_hasPictureAttributes {false}

private

Definition at line 144 of file ExternalStreamHandler.h.

Referenced by HasPictureAttributes(), and OpenApp().

◆ m_hasTuner

bool ExternalStreamHandler::m_hasTuner {false}

private

Definition at line 143 of file ExternalStreamHandler.h.

Referenced by HasTuner(), and OpenApp().

◆ m_io

ExternIO* ExternalStreamHandler::m_io {nullptr}

private

Definition at line 134 of file ExternalStreamHandler.h.

Referenced by CheckForError(), CloseApp(), IsAppOpen(), OpenApp(), ProcessJson(), ProcessVer1(), ProcessVer2(), PurgeBuffer(), and run().

◆ m_ioErrCnt

int ExternalStreamHandler::m_ioErrCnt {0}

private

Definition at line 138 of file ExternalStreamHandler.h.

Referenced by ProcessJson(), ProcessVer1(), and ProcessVer2().

◆ m_ioLock

QMutex ExternalStreamHandler::m_ioLock

private

Definition at line 133 of file ExternalStreamHandler.h.

Referenced by CheckForError(), CloseApp(), OpenApp(), ProcessVer1(), and ProcessVer2().

◆ m_loc

QString ExternalStreamHandler::m_loc

private

Definition at line 131 of file ExternalStreamHandler.h.

Referenced by GetDescription(), and UpdateDescription().

◆ m_majorId

int ExternalStreamHandler::m_majorId

private

Definition at line 132 of file ExternalStreamHandler.h.

Referenced by Return().

◆ m_pollMode

bool ExternalStreamHandler::m_pollMode {false}

private

Definition at line 139 of file ExternalStreamHandler.h.

Referenced by OpenApp(), ReplayStream(), run(), and StopStreaming().

◆ m_processLock

QMutex ExternalStreamHandler::m_processLock

private

Definition at line 159 of file ExternalStreamHandler.h.

Referenced by ProcessCommand().

◆ m_replay

bool ExternalStreamHandler::m_replay {false}

private

Definition at line 147 of file ExternalStreamHandler.h.

Referenced by ReplayStream(), run(), and UnlockReplay().

◆ m_replayBuffer

QByteArray ExternalStreamHandler::m_replayBuffer

private

Definition at line 146 of file ExternalStreamHandler.h.

Referenced by ReplayStream(), and run().

◆ m_replayLock

QMutex ExternalStreamHandler::m_replayLock

private

Definition at line 158 of file ExternalStreamHandler.h.

Referenced by LockReplay(), and UnlockReplay().

◆ m_serialNo

uint ExternalStreamHandler::m_serialNo {0}

private

Definition at line 142 of file ExternalStreamHandler.h.

Referenced by ProcessJson(), and ProcessVer2().

◆ m_streamingCnt

QAtomicInt ExternalStreamHandler::m_streamingCnt

private

Definition at line 156 of file ExternalStreamHandler.h.

Referenced by StartStreaming(), StopStreaming(), and StreamingCount().

◆ m_streamLock

QMutex ExternalStreamHandler::m_streamLock

private

Definition at line 157 of file ExternalStreamHandler.h.

Referenced by run(), StartStreaming(), and StopStreaming().

◆ m_tsOpen

bool ExternalStreamHandler::m_tsOpen {false}

private

Definition at line 137 of file ExternalStreamHandler.h.

Referenced by IsTSOpen().

◆ m_xon

bool ExternalStreamHandler::m_xon {false}

private

Definition at line 148 of file ExternalStreamHandler.h.

Referenced by ReplayStream(), run(), and StopStreaming().

◆ s_handlers

QMap< int, ExternalStreamHandler * > ExternalStreamHandler::s_handlers

staticprivate

Definition at line 153 of file ExternalStreamHandler.h.

Referenced by Get(), and Return().

◆ s_handlersLock

QMutex ExternalStreamHandler::s_handlersLock

staticprivate

Definition at line 152 of file ExternalStreamHandler.h.

Referenced by Get(), and Return().

◆ s_handlersRefCnt

QMap< int, uint > ExternalStreamHandler::s_handlersRefCnt

staticprivate

Definition at line 154 of file ExternalStreamHandler.h.

Referenced by Get(), and Return().

The documentation for this class was generated from the following files:

mythtv/libs/libmythtv/recorders/ExternalStreamHandler.h
mythtv/libs/libmythtv/recorders/ExternalStreamHandler.cpp

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ constants

Constructor & Destructor Documentation

◆ ExternalStreamHandler()

◆ ~ExternalStreamHandler()

Member Function Documentation

◆ APIVersion()

◆ CheckForError()

◆ ClearDamaged()

◆ CloseApp()

◆ Get()

◆ GetDescription()

◆ HasPictureAttributes()

◆ HasTuner()

◆ IsAppOpen()

◆ IsDamaged()

◆ IsTSOpen()

◆ LockReplay()

◆ OpenApp()

◆ PriorityEvent()

◆ ProcessCommand()

◆ ProcessJson()

◆ ProcessVer1()

◆ ProcessVer2()

◆ PurgeBuffer()

◆ ReplayStream()

◆ RestartStream()

◆ Return()

◆ run()

◆ SetAPIVersion()

◆ StartStreaming()

◆ StopStreaming()

◆ StreamingCount()

◆ UnlockReplay()

◆ UpdateDescription()

Member Data Documentation

◆ m_apiVersion

◆ m_app

◆ m_args

◆ m_damaged

◆ m_hasPictureAttributes

◆ m_hasTuner

◆ m_io

◆ m_ioErrCnt

◆ m_ioLock

◆ m_loc

◆ m_majorId

◆ m_pollMode

◆ m_processLock

◆ m_replay

◆ m_replayBuffer

◆ m_replayLock

◆ m_serialNo

◆ m_streamingCnt

◆ m_streamLock

◆ m_tsOpen

◆ m_xon

◆ s_handlers

◆ s_handlersLock

◆ s_handlersRefCnt