Transport stream file input with a seekable buffer. More...

#include <tsTSFileInputBuffered.h>

Inheritance diagram for ts::TSFileInputBuffered:

[legend]

Collaboration diagram for ts::TSFileInputBuffered:

[legend]

Public Types
enum	OpenFlags { NONE = 0x0000 , READ = 0x0001 , WRITE = 0x0002 , APPEND = 0x0004 , KEEP = 0x0008 , SHARED = 0x0010 , TEMPORARY = 0x0020 , REOPEN = 0x0040 , REOPEN_SPEC = 0x0080 }
	Flags for open(). More...

Public Member Functions
	TSFileInputBuffered (size_t buffer_size)
	Constructor.

virtual	~TSFileInputBuffered () override
	Destructor.

void	abort ()
	Abort any currenly read/write operation in progress.

bool	canSeek (PacketCounter position) const
	Check if we can seek to the specified absolute position.

bool	close (Report &report)
	Close the file.

size_t	getBackwardSeekableCount () const
	Get the backward seekable distance inside the buffer.

size_t	getBufferedCount () const
	Get the number of TS packets in the buffer.

size_t	getBufferFreeSize () const
	Get the size of the free space in the buffer.

size_t	getBufferSize () const
	Get the buffer size.

UString	getDisplayFileName () const
	Get the file name as a display string.

fs::path	getFileName () const
	Get the file name.

size_t	getForwardSeekableCount () const
	Get the forward seekable distance inside the buffer.

bool	isOpen () const
	Check if the file is open.

bool	openRead (const fs::path &filename, size_t repeat_count, uint64_t start_offset, Report &report, TSPacketFormat format=TSPacketFormat::AUTODETECT)
	Open the file.

bool	openRead (const fs::path &filename, uint64_t start_offset, Report &report, TSPacketFormat format=TSPacketFormat::AUTODETECT)
	Open the file for read in rewindable mode.

TSPacketFormat	packetFormat () const
	Get the file format.

UString	packetFormatString () const
	Get the file format as a string.

size_t	packetHeaderSize () const
	Get the packet header size, based on the packet format.

size_t	packetTrailerSize () const
	Get the packet trailer size, based on the packet format.

size_t	read (TSPacket buffer, size_t max_packets, Report &report, TSPacketMetadata metadata=nullptr)
	Read TS packets.

virtual size_t	readPackets (TSPacket buffer, TSPacketMetadata metadata, size_t max_packets, Report &report) override
	Read TS packets from the stream.

PacketCounter	readPacketsCount () const
	Get the number of read packets.

bool	seek (PacketCounter position, Report &report)
	Seek to the specified absolute position, if it is inside the buffer.

bool	seekBackward (size_t packet_count, Report &report)
	Seek the file backward the specified number of packets.

bool	seekForward (size_t packet_count, Report &report)
	Seek the file forward the specified number of packets.

bool	setBufferSize (size_t buffer_size, Report &report)
	Set the buffer size.

void	setStuffing (size_t initial, size_t final)
	Set initial and final artificial stuffing.

virtual bool	writePackets (const TSPacket buffer, const TSPacketMetadata metadata, size_t packet_count, Report &report)
	Write TS packets to the stream.

PacketCounter	writePacketsCount () const
	Get the number of written packets.

Static Public Attributes
static constexpr size_t	MAX_HEADER_SIZE = ts::TSPacketMetadata::SERIALIZATION_SIZE
	Maximum size in bytes of a packet header for non-TS format.

static constexpr size_t	MAX_TRAILER_SIZE = ts::RS_SIZE
	Maximum size in bytes of a packet trailer for non-TS format.

static constexpr size_t	MIN_BUFFER_SIZE = 16
	Minimum buffer size.

Protected Member Functions
void	resetPacketStream (TSPacketFormat format, AbstractReadStreamInterface reader, AbstractWriteStreamInterface writer)
	Reset the stream format and counters.

Protected Attributes
PacketCounter	_total_read = 0
	Total read packets.

PacketCounter	_total_write = 0
	Total written packets.

Detailed Description

Transport stream file input with a seekable buffer.

This variant of TSFile allows to seek back and forth to some extent without doing I/O's and can work on non-seekable files (pipes for instance).

Member Enumeration Documentation

◆ OpenFlags

enum ts::TSFile::OpenFlags

inherited

Flags for open().

Enumerator
NONE	No option, do not open the file.
READ	Read the file.
WRITE	Write the file.
APPEND	Append packets to an existing file.
KEEP	Keep previous file with same name. Fail if it already exists.
SHARED	Write open with shared read for other processes. Windows only. Always shared on Unix.
TEMPORARY	Temporary file, deleted on close, not always visible in the file system.
REOPEN	Close and reopen the file instead of rewind to start of file when looping on input file.
REOPEN_SPEC	Force REOPEN when the file is not a regular file.

Constructor & Destructor Documentation

◆ TSFileInputBuffered()

ts::TSFileInputBuffered::TSFileInputBuffered ( size_t buffer_size )

Constructor.

Parameters

[in] buffer_size Size of the seekable buffer in number of TS packets.

Member Function Documentation

◆ setBufferSize()

bool ts::TSFileInputBuffered::setBufferSize	(	size_t	buffer_size,
		Report &	report
	)

Set the buffer size.

Can be done only when the file is closed.

Parameters

[in]	buffer_size	Size of the seekable buffer in number of TS packets.
[in,out]	report	Where to report errors.

Returns: True on success, false on error.

◆ getBufferSize()

size_t ts::TSFileInputBuffered::getBufferSize ( ) const

inline

Get the buffer size.

Returns: The buffer size in number of TS packets.

◆ getBufferFreeSize()

size_t ts::TSFileInputBuffered::getBufferFreeSize ( ) const

inline

Get the size of the free space in the buffer.

Returns: The number of free TS packets in the buffer.

◆ getBufferedCount()

size_t ts::TSFileInputBuffered::getBufferedCount ( ) const

inline

Get the number of TS packets in the buffer.

Returns: The number of TS packets in the buffer.

◆ openRead() [1/2]

bool ts::TSFileInputBuffered::openRead	(	const fs::path &	filename,
		size_t	repeat_count,
		uint64_t	start_offset,
		Report &	report,
		TSPacketFormat	format = `TSPacketFormat::AUTODETECT`
	)

Open the file.

Override TSFile::openRead(). There is no rewindable version.

Parameters

[in]	filename	File name. If empty, use standard input. Must be a regular file is repeat_count is not 1 or if start_offset is not zero.
[in]	repeat_count	Reading packets loops back after end of file until all repeat are done. If zero, infinitely repeat.
[in]	start_offset	Offset in bytes from the beginning of the file where to start reading packets at each iteration.
[in,out]	report	Where to report errors.
[in]	format	Expected format of the TS file.

Returns: True on success, false on error.

◆ read()

size_t ts::TSFileInputBuffered::read	(	TSPacket *	buffer,
		size_t	max_packets,
		Report &	report,
		TSPacketMetadata *	metadata = `nullptr`
	)

Read TS packets.

Override TSFile::read(). If the file file was opened with a repeat_count different from 1, reading packets transparently loops back at end if file.

Parameters

[out]	buffer	Address of reception packet buffer.
[in]	max_packets	Size of buffer in packets.
[in,out]	report	Where to report errors.
[in,out]	metadata	Optional packet metadata. If the file format provides time stamps, they are set in the metadata. Ignored if null pointer.

Returns: The actual number of read packets. Returning zero means error or end of file repetition.

◆ getBackwardSeekableCount()

size_t ts::TSFileInputBuffered::getBackwardSeekableCount ( ) const

inline

Get the backward seekable distance inside the buffer.

This is the minimum guaranteed seekable distance.

Returns: The buffer size from the highest previously read packet or the beginning of file, whichever comes first.

◆ getForwardSeekableCount()

size_t ts::TSFileInputBuffered::getForwardSeekableCount ( ) const

inline

Get the forward seekable distance inside the buffer.

This is the minimum guaranteed seekable distance.

Returns: The highest previously read packet index, before backward seek.

◆ seekBackward()

bool ts::TSFileInputBuffered::seekBackward	(	size_t	packet_count,
		Report &	report
	)

Seek the file backward the specified number of packets.

Parameters

[in]	packet_count	The number of packets to seek backward from the current position.
[in,out]	report	Where to report errors.

Returns: True on success, false on error.

◆ seekForward()

bool ts::TSFileInputBuffered::seekForward	(	size_t	packet_count,
		Report &	report
	)

Seek the file forward the specified number of packets.

Parameters

[in]	packet_count	The number of packets to seek forward from the current position.
[in,out]	report	Where to report errors.

Returns: True on success, false on error.

◆ readPacketsCount()

PacketCounter ts::TSFileInputBuffered::readPacketsCount ( ) const

Get the number of read packets.

Override TSFile::readPacketsCount().

Returns: The number of read packets.

◆ canSeek()

bool ts::TSFileInputBuffered::canSeek ( PacketCounter position ) const

Check if we can seek to the specified absolute position.

Parameters

[in] position Absolute packet index in the file.

Returns: True if the specified position is inside the buffer.

◆ seek()

bool ts::TSFileInputBuffered::seek	(	PacketCounter	position,
		Report &	report
	)

Seek to the specified absolute position, if it is inside the buffer.

Parameters

[in]	position	Absolute packet index in the file.
[in,out]	report	Where to report errors.

Returns: True on success, false on error.

◆ openRead() [2/2]

bool ts::TSFile::openRead	(	const fs::path &	filename,
		uint64_t	start_offset,
		Report &	report,
		TSPacketFormat	format = `TSPacketFormat::AUTODETECT`
	)

inherited

Open the file for read in rewindable mode.

The file must be a rewindable file, eg. not a pipe. There is no repeat count, rewind must be done explicitly.

Parameters

[in]	filename	File name. If empty or "-", use standard input.
[in]	start_offset	Offset in bytes from the beginning of the file where to start reading packets.
[in,out]	report	Where to report errors.
[in]	format	Expected format of the TS file.

Returns: True on success, false on error.

See also: rewind(); seek()

◆ isOpen()

bool ts::TSFile::isOpen ( ) const

inlineinherited

Check if the file is open.

Returns: True if the file is open.

◆ getFileName()

fs::path ts::TSFile::getFileName ( ) const

inlineinherited

Get the file name.

Returns: The file name.

◆ getDisplayFileName()

UString ts::TSFile::getDisplayFileName ( ) const

inherited

Get the file name as a display string.

Returns: The file name as a display string. Not always a valid file name. Use in error messages only.

◆ close()

bool ts::TSFile::close ( Report & report )

inherited

Close the file.

Parameters

[in,out] report Where to report errors.

Returns: True on success, false on error.

◆ setStuffing()

void ts::TSFile::setStuffing	(	size_t	initial,
		size_t	final
	)

inherited

Set initial and final artificial stuffing.

This method shall be called before opening the file. It specifies a number of artificial null packets which are read or written before and after the actual content of the file.

Parameters

[in]	initial	Number of artificial initial null packets. On read, the first initial read packets are null packets. The actual content of the physical file will be read afterward. On write, opening the file will immediately write initial null packets, before the application has a chance to explicitly write packets.
[in]	final	Number of artificial final null packets. On read, when the file is completed, after all specified repetitions, reading will successfully continue for the next final packets and returns null packets. On write, closing the file with automatically write final null packets before closing the physical file.

◆ abort()

void ts::TSFile::abort ( )

inherited

Abort any currenly read/write operation in progress.

The file is left in a broken state and can be only closed.

◆ readPackets()

virtual size_t ts::TSFile::readPackets	(	TSPacket *	buffer,
		TSPacketMetadata *	metadata,
		size_t	max_packets,
		Report &	report
	)

overridevirtualinherited

Read TS packets from the stream.

Parameters

[out]	buffer	Address of reception packet buffer.
[out]	metadata	Optional packet metadata. If the file format provides time stamps, they are set in the metadata. Ignored if null pointer.
[in]	max_packets	Size of buffer in packets. Also size of metadata in number of objects (when specified).
[in,out]	report	Where to report errors.

Returns: The actual number of read packets. Returning zero means error or end of stream.

Reimplemented from ts::TSPacketStream.

◆ writePackets()

virtual bool ts::TSPacketStream::writePackets	(	const TSPacket *	buffer,
		const TSPacketMetadata *	metadata,
		size_t	packet_count,
		Report &	report
	)

virtualinherited

Write TS packets to the stream.

Parameters

[in]	buffer	Address of first packet to write.
[in]	metadata	Optional packet metadata containing time stamps. If the file format requires time stamps, metadata must not be a null pointer and all packets must have a time stamp. Otherwise, the last written timestamp is repeated.
[in]	packet_count	Number of packets to write. Also size of metadata in number of objects (when specified).
[in,out]	report	Where to report errors.

Returns: True on success, false on error.

◆ writePacketsCount()

PacketCounter ts::TSPacketStream::writePacketsCount ( ) const

inlineinherited

Get the number of written packets.

Returns: The number of written packets.

◆ packetHeaderSize()

size_t ts::TSPacketStream::packetHeaderSize ( ) const

inherited

Get the packet header size, based on the packet format.

This "header" comes before the classical 188-byte TS packet.

Returns: The packet header size in bytes (before the TS packet).

◆ packetTrailerSize()

size_t ts::TSPacketStream::packetTrailerSize ( ) const

inherited

Get the packet trailer size, based on the packet format.

This "trailer" comes after the classical 188-byte TS packet.

Returns: The packet trailer size in bytes (before the TS packet).

◆ packetFormat()

TSPacketFormat ts::TSPacketStream::packetFormat ( ) const

inlineinherited

Get the file format.

Returns: The file format.

◆ packetFormatString()

UString ts::TSPacketStream::packetFormatString ( ) const

inlineinherited

Get the file format as a string.

Returns: The file format as a string.

◆ resetPacketStream()

void ts::TSPacketStream::resetPacketStream	(	TSPacketFormat	format,
		AbstractReadStreamInterface *	reader,
		AbstractWriteStreamInterface *	writer
	)

protectedinherited

Reset the stream format and counters.

Parameters

[in]	format	Initial packet format.
[in]	reader	Reader interface. If null, all read operations will fail.
[in]	writer	Writer interface. If null, all write operations will fail.

Member Data Documentation

◆ MIN_BUFFER_SIZE

constexpr size_t ts::TSFileInputBuffered::MIN_BUFFER_SIZE = 16

staticconstexpr

Minimum buffer size.

Used to minimize buffer_size in constructor and setBufferSize().

◆ MAX_HEADER_SIZE

constexpr size_t ts::TSPacketStream::MAX_HEADER_SIZE = ts::TSPacketMetadata::SERIALIZATION_SIZE

staticconstexprinherited

Maximum size in bytes of a packet header for non-TS format.

Must be lower than the TS packet size to allow auto-detection on read.

◆ MAX_TRAILER_SIZE

constexpr size_t ts::TSPacketStream::MAX_TRAILER_SIZE = ts::RS_SIZE

staticconstexprinherited

Maximum size in bytes of a packet trailer for non-TS format.

Must be lower than the TS packet size to allow auto-detection on read.

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

tsTSFileInputBuffered.h

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ OpenFlags

Constructor & Destructor Documentation

◆ TSFileInputBuffered()

Member Function Documentation

◆ setBufferSize()

◆ getBufferSize()

◆ getBufferFreeSize()

◆ getBufferedCount()

◆ openRead() [1/2]

◆ read()

◆ getBackwardSeekableCount()

◆ getForwardSeekableCount()

◆ seekBackward()

◆ seekForward()

◆ readPacketsCount()

◆ canSeek()

◆ seek()

◆ openRead() [2/2]

◆ isOpen()

◆ getFileName()

◆ getDisplayFileName()

◆ close()

◆ setStuffing()

◆ abort()

◆ readPackets()

◆ writePackets()

◆ writePacketsCount()

◆ packetHeaderSize()

◆ packetTrailerSize()

◆ packetFormat()

◆ packetFormatString()

◆ resetPacketStream()

Member Data Documentation

◆ MIN_BUFFER_SIZE

◆ MAX_HEADER_SIZE

◆ MAX_TRAILER_SIZE