ts::TSFileInputArgs Class Reference

Transport stream file input with command-line arguments. More...

#include <tsTSFileInputArgs.h>

Inheritance diagram for ts::TSFileInputArgs:

Collaboration diagram for ts::TSFileInputArgs:

Public Member Functions
	TSFileInputArgs (Report *report)
	Constructor.
	TSFileInputArgs (ReporterBase *delegate)
	Constructor.
virtual	~TSFileInputArgs () override
	Destructor.
void	abort ()
	Abort the input operation currently in progress.
bool	close (bool silent=false)
	Close the input file or files.
void	defineArgs (Args &args)
	Add command line option definitions in an Args.
bool	loadArgs (DuckContext &duck, Args &args)
	Load arguments from command line.
bool	muteReport (bool mute)
	Temporarily mute the associated report.
bool	open ()
	Open the input file or files.
size_t	read (TSPacket *buffer, TSPacketMetadata *pkt_data, size_t max_packets)
	Read packets.
virtual Report &	report () const override
	Access the Report which is associated with this object.
Report *	setReport (Report *report)
	Associate this object with another Report to log errors.
ReporterBase *	setReport (ReporterBase *delegate)
	Associate this object with another ReporterBase to log errors.

Static Public Member Functions
static int	SilentLevel (bool silent, int default_severity=Severity::Error)
	Compute a log severity level from a "silent" parameter.

Detailed Description

Transport stream file input with command-line arguments.

Constructor & Destructor Documentation

TSFileInputArgs() [1/2]

ts::TSFileInputArgs::TSFileInputArgs ( Report *  report )

explicit

Constructor.

Parameters

[in]

report

Where to report errors. The report object must remain valid as long as this object exists or setReport() is used with another Report object. If report is null, log messages are discarded.

TSFileInputArgs() [2/2]

ts::TSFileInputArgs::TSFileInputArgs ( ReporterBase *  delegate )

explicit

Constructor.

Parameters

[in]

delegate

Use the report of another ReporterBase. If delegate is null, log messages are discarded.

Member Function Documentation

defineArgs()

void ts::TSFileInputArgs::defineArgs

(

Args &

args

)

Add command line option definitions in an Args.

Parameters

[in,out]

args

Command line arguments to update.

loadArgs()

bool ts::TSFileInputArgs::loadArgs	(	DuckContext &	duck,
		Args &	args
	)

Load arguments from command line.

Args error indicator is set in case of incorrect arguments.

Parameters

[in,out]	duck	TSDuck execution context.
[in,out]	args	Command line arguments.

Returns

True on success, false on error in argument line.

open()

bool ts::TSFileInputArgs::open

(

)

Open the input file or files.

All parameters where loaded from the command line by loadArgs().

Returns

True on success, false on error.

close()

bool ts::TSFileInputArgs::close

(

bool

silent = false

)

Close the input file or files.

Parameters

[in]

silent

If true, do not report errors. This is typically useful when the object is in some error condition and closing it is necessary although it may generate additional meaningless errors.

Returns

True on success, false on error.

read()

size_t ts::TSFileInputArgs::read	(	TSPacket *	buffer,
		TSPacketMetadata *	pkt_data,
		size_t	max_packets
	)

Read packets.

Parameters

[out]	buffer	Address of the buffer for incoming packets.
[in,out]	pkt_data	Array of metadata for incoming packets.
[in]	max_packets	Size of buffer in number of packets.

Returns

The number of actually received packets (in the range 1 to max_packets). Returning zero means error or end of input.

abort()

void ts::TSFileInputArgs::abort

(

)

Abort the input operation currently in progress.

This method is typically invoked from another thread. The only acceptable operation after an abort() is a close().

report()

virtual Report & ts::ReporterBase::report ( ) const

overridevirtualinherited

Access the Report which is associated with this object.

Can be called from another thread only if the Report object is thread-safe.

Returns

A reference to the associated report.

Implements ts::ReporterInterface.

setReport() [1/2]

Report * ts::ReporterBase::setReport ( Report *  report )

inherited

Associate this object with another Report to log errors.

Parameters

[in]

report

Where to report errors. The report object must remain valid as long as this object exists or setReport() is used with another Report object. If report is null, log messages are discarded.

Returns

The address of the previous Report object or a null pointer if there was none.

setReport() [2/2]

ReporterBase * ts::ReporterBase::setReport ( ReporterBase *  delegate )

inherited

Associate this object with another ReporterBase to log errors.

Parameters

[in]

delegate

Use the report of another ReporterBase. If delegate is null, the previous explicit Report is used..

Returns

The address of the previous ReporterBase object or a null pointer if there was none.

muteReport()

bool ts::ReporterBase::muteReport ( bool  mute )

inherited

Temporarily mute the associated report.

Parameters

[in]

mute

It true, report() will return a null report (log messages are discarded), until muteReport() is invoked again with mute set to false.

Returns

Previous state of the mute field.

SilentLevel()

static int ts::ReporterBase::SilentLevel ( bool  silent, int  default_severity = Severity::Error  )

inlinestaticinherited

Compute a log severity level from a "silent" parameter.

Some subclass methods have a "silent" parameter to avoid reporting errors which may be insignificant, typically when closing a device after an error, in which case the close operation may produce other errors if the previous error left the device in an inconsistent state. While those errors should not be displayed as errors, we still display them at debug level.

Parameters

[in]	silent	If true, do not report errors, report debug messages instead.
[in]	default_severity	Default severity, in non-silent mode (error by default).

Returns

Error when silent is false, Debug otherwise.

---

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

• tsTSFileInputArgs.h