TSDuck v3.46-4965
MPEG Transport Stream Toolkit
Loading...
Searching...
No Matches
ts::DVBCharTableSingleByte Class Reference

#include <tsDVBCharTableSingleByte.h>

Inheritance diagram for ts::DVBCharTableSingleByte:
Collaboration diagram for ts::DVBCharTableSingleByte:

Public Member Functions

virtual bool canEncode (const UString &str, size_t start=0, size_t count=NPOS) const override
virtual bool decode (UString &str, const uint8_t *dvb, size_t dvbSize) const override
UString decoded (const uint8_t *data, size_t size) const
UString decodedWithByteLength (const uint8_t *&data, size_t &size) const
bool decodeWithByteLength (UString &str, const uint8_t *&data, size_t &size) const
virtual size_t encode (uint8_t *&buffer, size_t &size, const UString &str, size_t start=0, size_t count=NPOS) const override
ByteBlock encoded (const UString &str, size_t start=0, size_t count=NPOS) const
ByteBlock encodedWithByteLength (const UString &str, size_t start=0, size_t count=NPOS) const
virtual size_t encodeTableCode (uint8_t *&buffer, size_t &size) const
size_t encodeWithByteLength (uint8_t *&buffer, size_t &size, const UString &str, size_t start=0, size_t count=NPOS) const
UString name () const
uint32_t tableCode () const
virtual void unregister () const override

Static Public Member Functions

static bool DecodeTableCode (uint32_t &code, size_t &code_size, const uint8_t *dvb, size_t dvb_size)
static UStringList GetAllNames ()
static const Charset * GetCharset (const UString &name)
static const DVBCharTable * GetTableFromLeadingCode (uint32_t code)

Static Public Attributes

static constexpr uint16_t DVB_CODEPOINT_CRLF = 0xE08A
static const DVBCharset DVB_ISO_8859_1
 Non-standard DVB encoding using ISO 8859-1 character set as default.
static const DVBCharset DVB_ISO_8859_10
 Non-standard DVB encoding using ISO 8859-10 character set as default.
static const DVBCharset DVB_ISO_8859_11
 Non-standard DVB encoding using ISO 8859-11 character set as default.
static const DVBCharset DVB_ISO_8859_13
 Non-standard DVB encoding using ISO 8859-13 character set as default.
static const DVBCharset DVB_ISO_8859_14
 Non-standard DVB encoding using ISO 8859-14 character set as default.
static const DVBCharset DVB_ISO_8859_15
 Non-standard DVB encoding using ISO 8859-15 character set as default.
static const DVBCharset DVB_ISO_8859_2
 Non-standard DVB encoding using ISO 8859-2 character set as default.
static const DVBCharset DVB_ISO_8859_3
 Non-standard DVB encoding using ISO 8859-3 character set as default.
static const DVBCharset DVB_ISO_8859_4
 Non-standard DVB encoding using ISO 8859-4 character set as default.
static const DVBCharset DVB_ISO_8859_5
 Non-standard DVB encoding using ISO 8859-5 character set as default.
static const DVBCharset DVB_ISO_8859_6
 Non-standard DVB encoding using ISO 8859-6 character set as default.
static const DVBCharset DVB_ISO_8859_7
 Non-standard DVB encoding using ISO 8859-7 character set as default.
static const DVBCharset DVB_ISO_8859_8
 Non-standard DVB encoding using ISO 8859-8 character set as default.
static const DVBCharset DVB_ISO_8859_9
 Non-standard DVB encoding using ISO 8859-9 character set as default.
static constexpr uint8_t DVB_SINGLE_BYTE_CRLF = 0x8A
static const DVBCharTableSingleByte RAW_ISO_6937
 Raw modified ISO 6937, DVB default character table.
static const DVBCharTableSingleByte RAW_ISO_8859_1
 Raw ISO 8859-1 character set.
static const DVBCharTableSingleByte RAW_ISO_8859_10
 Raw ISO 8859-10 character set.
static const DVBCharTableSingleByte RAW_ISO_8859_11
 Raw ISO 8859-11 character set.
static const DVBCharTableSingleByte RAW_ISO_8859_13
 Raw ISO 8859-13 character set.
static const DVBCharTableSingleByte RAW_ISO_8859_14
 Raw ISO 8859-14 character set.
static const DVBCharTableSingleByte RAW_ISO_8859_15
 Raw ISO 8859-15 character set.
static const DVBCharTableSingleByte RAW_ISO_8859_2
 Raw ISO 8859-2 character set.
static const DVBCharTableSingleByte RAW_ISO_8859_3
 Raw ISO 8859-3 character set.
static const DVBCharTableSingleByte RAW_ISO_8859_4
 Raw ISO 8859-4 character set.
static const DVBCharTableSingleByte RAW_ISO_8859_5
 Raw ISO 8859-5 character set.
static const DVBCharTableSingleByte RAW_ISO_8859_6
 Raw ISO 8859-6 character set.
static const DVBCharTableSingleByte RAW_ISO_8859_7
 Raw ISO 8859-7 character set.
static const DVBCharTableSingleByte RAW_ISO_8859_8
 Raw ISO 8859-8 character set.
static const DVBCharTableSingleByte RAW_ISO_8859_9
 Raw ISO 8859-9 character set.

Detailed Description

Definition of a DVB character set using a single byte per character.

All these character sets share the following properties:

  • Codes 0x00-0x1F and 0x7F-9F are not assigned.
  • Codes 0x20-0x7E are identical to ASCII.
  • Only codes 0xA0-0xFF are specific, some of them being unused depending on the character set.
  • The code 0x8A is interpreted as a new line.
See also
ETSI EN 300 468, Annex A.

Member Function Documentation

◆ decode()

virtual bool ts::DVBCharTableSingleByte::decode ( UString & str,
const uint8_t * data,
size_t size ) const
overridevirtual

Decode a string from the specified byte buffer.

Parameters
[out]strReturned decoded string.
[in]dataAddress of an encoded string.
[in]sizeSize in bytes of the encoded string.
Returns
True on success, false on error (truncated, unsupported format, etc.)

Implements ts::Charset.

◆ canEncode()

virtual bool ts::DVBCharTableSingleByte::canEncode ( const UString & str,
size_t start = 0,
size_t count = NPOS ) const
overridevirtual

Check if a string can be encoded using the charset (ie all characters can be represented).

Parameters
[in]strThe string to encode.
[in]startStarting offset in str.
[in]countMaximum number of characters to encode.
Returns
True if all characters can be encoded.

Implements ts::Charset.

◆ encode()

virtual size_t ts::DVBCharTableSingleByte::encode ( uint8_t *& buffer,
size_t & size,
const UString & str,
size_t start = 0,
size_t count = NPOS ) const
overridevirtual

Encode a C++ Unicode string.

Unrepresentable characters are skipped. Stop either when the specified number of characters are serialized or when the buffer is full, whichever comes first.

Parameters
[in,out]bufferAddress of the buffer. The address is updated to point after the encoded value.
[in,out]sizeSize of the buffer. Updated to remaining size.
[in]strThe string to encode.
[in]startStarting offset in str.
[in]countMaximum number of characters to encode.
Returns
The number of serialized characters (which is usually not the same as the number of written bytes).

Implements ts::Charset.

◆ DecodeTableCode()

bool ts::DVBCharTable::DecodeTableCode ( uint32_t & code,
size_t & code_size,
const uint8_t * dvb,
size_t dvb_size )
staticinherited

This static function gets the character coding table at the beginning of a DVB string.

The character coding table is encoded on up to 3 bytes at the beginning of a DVB string. The following encodings are recognized, based on the first byte of the DVB string:

  • First byte >= 0x20: The first byte is a character. The default encoding is ISO-6937. We return zero as code.
  • First byte == 0x10: The next two bytes indicate an ISO-8859 encoding. We return 0x10xxyy as code.
  • First byte == 0x1F: The second byte is an encoding_type_id. This encoding is not supported here.
  • Other value: One byte encoding.
Parameters
[out]codeReturned character coding table value. Zero when no code is present (use the default character table). 0xFFFFFFFF in case of invalid data.
[out]code_sizeSize in bytes of character coding table in dvb.
[in]dvbAddress of a DVB string.
[in]dvb_sizeSize in bytes of the DVB string.
Returns
True on success, false on error (truncated, unsupported format, etc.)

◆ tableCode()

uint32_t ts::DVBCharTable::tableCode ( ) const
inlineinherited

Get the DVB table code for the character set.

Returns
DVB table code.

◆ GetTableFromLeadingCode()

const DVBCharTable * ts::DVBCharTable::GetTableFromLeadingCode ( uint32_t code)
staticinherited

Get a DVB character set by table code.

Parameters
[in]codeTable code of the requested character set.
Returns
Address of the character or zero if not found.

◆ encodeTableCode()

virtual size_t ts::DVBCharTable::encodeTableCode ( uint8_t *& buffer,
size_t & size ) const
virtualinherited

Encode the character set table code.

Stop either when the specified number of characters are serialized or when the buffer is full, whichever comes first. In case of short buffer, the table code is truncated. It is assumed that the buffer will contain a complete encoded string. So, if the buffer cannot accomodate the table code, there will be no room for the string, which will be invalid anyway.

Parameters
[in,out]bufferAddress of the buffer. The address is updated to point after the encoded value.
[in,out]sizeSize of the buffer. Updated to remaining size.
Returns
The number of serialized byte.

◆ unregister()

virtual void ts::DVBCharTable::unregister ( ) const
overridevirtualinherited

Unregister the character set from the repository of character sets. This is done automatically when the object is destructed. Can be called earlier to make sure a character set is no longer referenced.

Reimplemented from ts::Charset.

◆ name()

UString ts::Charset::name ( ) const
inlineinherited

Get the character set name.

Returns
The name.

◆ GetCharset()

const Charset * ts::Charset::GetCharset ( const UString & name)
staticinherited

Get a character set by name.

Parameters
[in]nameName of the requested character set.
Returns
Address of the character set or zero if not found.

◆ GetAllNames()

UStringList ts::Charset::GetAllNames ( )
staticinherited

Find all registered character set names.

Returns
List of all registered names.

◆ decoded()

UString ts::Charset::decoded ( const uint8_t * data,
size_t size ) const
inherited

Decode a string from the specified byte buffer and return a UString.

Errors (truncation, unsupported format, etc) are ignored.

Parameters
[in]dataAddress of an encoded string.
[in]sizeSize in bytes of the encoded string.
Returns
The decoded string.

◆ decodeWithByteLength()

bool ts::Charset::decodeWithByteLength ( UString & str,
const uint8_t *& data,
size_t & size ) const
inherited

Decode a string (preceded by its one-byte length) from the specified byte buffer.

Parameters
[out]strReturned decoded string.
[in,out]dataAddress of an encoded string. The address is updated to point after the decoded value.
[in,out]sizeSize of the buffer. Updated to remaining size.
Returns
True on success, false on error (truncated, unsupported format, etc.)

◆ decodedWithByteLength()

UString ts::Charset::decodedWithByteLength ( const uint8_t *& data,
size_t & size ) const
inherited

Decode a string (preceded by its one-byte length) from the specified byte buffer.

Errors (truncation, unsupported format, etc) are ignored.

Parameters
[in,out]dataAddress of an encoded string. The address is updated to point after the decoded value.
[in,out]sizeSize of the buffer. Updated to remaining size.
Returns
The decoded string.

◆ encodeWithByteLength()

size_t ts::Charset::encodeWithByteLength ( uint8_t *& buffer,
size_t & size,
const UString & str,
size_t start = 0,
size_t count = NPOS ) const
inherited

Encode a C++ Unicode string preceded by its one-byte length.

Unrepresentable characters are skipped. Stop either when the specified number of characters are serialized or when the buffer is full, whichever comes first.

Parameters
[in,out]bufferAddress of the buffer. The address is updated to point after the encoded value.
[in,out]sizeSize of the buffer. Updated to remaining size.
[in]strThe string to encode.
[in]startStarting offset in str.
[in]countMaximum number of characters to encode.
Returns
The number of serialized characters (which is usually not the same as the number of written bytes).

◆ encoded()

ByteBlock ts::Charset::encoded ( const UString & str,
size_t start = 0,
size_t count = NPOS ) const
inherited

Encode a C++ Unicode string as a ByteBlock.

Unrepresentable characters are skipped.

Parameters
[in]strThe string to encode.
[in]startStarting offset in str.
[in]countMaximum number of characters to encode.
Returns
A ByteBlock containing the encoded string.

◆ encodedWithByteLength()

ByteBlock ts::Charset::encodedWithByteLength ( const UString & str,
size_t start = 0,
size_t count = NPOS ) const
inherited

Encode a C++ Unicode string as a ByteBlock (preceded by its one-byte length).

Unrepresentable characters are skipped.

Parameters
[in]strThe string to encode.
[in]startStarting offset in str.
[in]countMaximum number of characters to encode.
Returns
A ByteBlock containing the encoded string.

Member Data Documentation

◆ DVB_SINGLE_BYTE_CRLF

uint8_t ts::DVBCharTable::DVB_SINGLE_BYTE_CRLF = 0x8A
staticconstexprinherited

DVB-encoded CR/LF in single-byte character sets.

◆ DVB_CODEPOINT_CRLF

uint16_t ts::DVBCharTable::DVB_CODEPOINT_CRLF = 0xE08A
staticconstexprinherited

Code point for DVB-encoded CR/LF in two-byte character sets.


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