 |
TagLib API Documentation
|
|
TagLib API Documentation
|
A byte vector. More...
#include <tbytevector.h>
Public Member Functions | |
| ByteVector () | |
| ByteVector (unsigned int size, char value=0) | |
| ByteVector (const ByteVector &v) | |
| ByteVector (const ByteVector &v, unsigned int offset, unsigned int length) | |
| ByteVector (char c) | |
| ByteVector (const char *data, unsigned int length) | |
| ByteVector (const char *data) | |
| ~ByteVector () | |
| ByteVector & | setData (const char *s, unsigned int length) |
| ByteVector & | setData (const char *data) |
| char * | data () |
| const char * | data () const |
| ByteVector | mid (unsigned int index, unsigned int length=0xffffffff) const |
| char | at (unsigned int index) const |
| int | find (const ByteVector &pattern, unsigned int offset=0, int byteAlign=1) const |
| int | find (char c, unsigned int offset=0, int byteAlign=1) const |
| int | rfind (const ByteVector &pattern, unsigned int offset=0, int byteAlign=1) const |
| bool | containsAt (const ByteVector &pattern, unsigned int offset, unsigned int patternOffset=0, unsigned int patternLength=0xffffffff) const |
| bool | startsWith (const ByteVector &pattern) const |
| bool | endsWith (const ByteVector &pattern) const |
| ByteVector & | replace (char oldByte, char newByte) |
| ByteVector & | replace (const ByteVector &pattern, const ByteVector &with) |
| int | endsWithPartialMatch (const ByteVector &pattern) const |
| ByteVector & | append (const ByteVector &v) |
| ByteVector & | append (char c) |
| ByteVector & | clear () |
| unsigned int | size () const |
| ByteVector & | resize (unsigned int size, char padding=0) |
| Iterator | begin () |
| ConstIterator | begin () const |
| ConstIterator | cbegin () const |
| Iterator | end () |
| ConstIterator | end () const |
| ConstIterator | cend () const |
| ReverseIterator | rbegin () |
| ConstReverseIterator | rbegin () const |
| ReverseIterator | rend () |
| ConstReverseIterator | rend () const |
| bool | isEmpty () const |
| unsigned int | toUInt (bool mostSignificantByteFirst=true) const |
| unsigned int | toUInt (unsigned int offset, bool mostSignificantByteFirst=true) const |
| unsigned int | toUInt (unsigned int offset, unsigned int length, bool mostSignificantByteFirst=true) const |
| short | toShort (bool mostSignificantByteFirst=true) const |
| short | toShort (unsigned int offset, bool mostSignificantByteFirst=true) const |
| unsigned short | toUShort (bool mostSignificantByteFirst=true) const |
| unsigned short | toUShort (unsigned int offset, bool mostSignificantByteFirst=true) const |
| long long | toLongLong (bool mostSignificantByteFirst=true) const |
| long long | toLongLong (unsigned int offset, bool mostSignificantByteFirst=true) const |
| unsigned long long | toULongLong (bool mostSignificantByteFirst=true) const |
| unsigned long long | toULongLong (unsigned int offset, bool mostSignificantByteFirst=true) const |
| float | toFloat32LE (size_t offset) const |
| float | toFloat32BE (size_t offset) const |
| double | toFloat64LE (size_t offset) const |
| double | toFloat64BE (size_t offset) const |
| long double | toFloat80LE (size_t offset) const |
| long double | toFloat80BE (size_t offset) const |
| const char & | operator[] (int index) const |
| char & | operator[] (int index) |
| bool | operator== (const ByteVector &v) const |
| bool | operator!= (const ByteVector &v) const |
| bool | operator== (const char *s) const |
| bool | operator!= (const char *s) const |
| bool | operator< (const ByteVector &v) const |
| bool | operator> (const ByteVector &v) const |
| ByteVector | operator+ (const ByteVector &v) const |
| ByteVector & | operator= (const ByteVector &v) |
| ByteVector & | operator= (char c) |
| ByteVector & | operator= (const char *data) |
| void | swap (ByteVector &v) noexcept |
| ByteVector | toHex () const |
| ByteVector | toBase64 () const |
Static Public Member Functions | |
| static ByteVector | fromUInt (unsigned int value, bool mostSignificantByteFirst=true) |
| static ByteVector | fromShort (short value, bool mostSignificantByteFirst=true) |
| static ByteVector | fromUShort (unsigned short value, bool mostSignificantByteFirst=true) |
| static ByteVector | fromLongLong (long long value, bool mostSignificantByteFirst=true) |
| static ByteVector | fromULongLong (unsigned long long value, bool mostSignificantByteFirst=true) |
| static ByteVector | fromFloat32LE (float value) |
| static ByteVector | fromFloat32BE (float value) |
| static ByteVector | fromFloat64LE (double value) |
| static ByteVector | fromFloat64BE (double value) |
| static ByteVector | fromCString (const char *s, unsigned int length=0xffffffff) |
| static ByteVector | fromBase64 (const ByteVector &) |
Protected Member Functions | |
| void | detach () |
Related Functions | |
(Note that these are not member functions.) | |
| TAGLIB_EXPORT std::ostream & | operator<< (std::ostream &s, const TagLib::ByteVector &v) |
A byte vector.
This class provides an implicitly shared byte vector with some methods that are useful for tagging purposes. Many of the search functions are tailored to what is useful for finding tag related patterns in a data array.
| TagLib::ByteVector::ByteVector | ( | ) |
Constructs an empty byte vector.
| TagLib::ByteVector::ByteVector | ( | unsigned int | size, |
| char | value = 0 |
||
| ) |
Construct a vector of size size with all values set to value by default.
| TagLib::ByteVector::ByteVector | ( | const ByteVector & | v | ) |
Constructs a byte vector that is a copy of v.
| TagLib::ByteVector::ByteVector | ( | const ByteVector & | v, |
| unsigned int | offset, | ||
| unsigned int | length | ||
| ) |
Constructs a byte vector that is a copy of v.
| TagLib::ByteVector::ByteVector | ( | char | c | ) |
Constructs a byte vector that contains c.
| TagLib::ByteVector::ByteVector | ( | const char * | data, |
| unsigned int | length | ||
| ) |
Constructs a byte vector that copies data for up to length bytes.
| TagLib::ByteVector::ByteVector | ( | const char * | data | ) |
Constructs a byte vector that copies data up to the first null byte. This is particularly useful for constructing byte arrays from string constants.
| TagLib::ByteVector::~ByteVector | ( | ) |
Destroys this ByteVector instance.
| ByteVector & TagLib::ByteVector::append | ( | char | c | ) |
Appends c to the end of the ByteVector.
| ByteVector & TagLib::ByteVector::append | ( | const ByteVector & | v | ) |
Appends v to the end of the ByteVector.
| char TagLib::ByteVector::at | ( | unsigned int | index | ) | const |
This essentially performs the same as operator[](), but instead of causing a runtime error if the index is out of bounds, it will return a null byte.
| Iterator TagLib::ByteVector::begin | ( | ) |
Returns an Iterator that points to the front of the vector.
| ConstIterator TagLib::ByteVector::begin | ( | ) | const |
Returns a ConstIterator that points to the front of the vector.
| ConstIterator TagLib::ByteVector::cbegin | ( | ) | const |
Returns a ConstIterator that points to the front of the vector.
| ConstIterator TagLib::ByteVector::cend | ( | ) | const |
Returns a ConstIterator that points to the back of the vector.
| ByteVector & TagLib::ByteVector::clear | ( | ) |
Clears the data.
| bool TagLib::ByteVector::containsAt | ( | const ByteVector & | pattern, |
| unsigned int | offset, | ||
| unsigned int | patternOffset = 0, |
||
| unsigned int | patternLength = 0xffffffff |
||
| ) | const |
Checks to see if the vector contains the pattern starting at position offset. Optionally, if you only want to search for part of the pattern you can specify an offset within the pattern to start from. Also, you can specify to only check for the first patternLength bytes of pattern with the patternLength argument.
| char * TagLib::ByteVector::data | ( | ) |
Returns a pointer to the internal data structure.
| const char * TagLib::ByteVector::data | ( | ) | const |
Returns a pointer to the internal data structure which may not be modified.
|
protected |
If this ByteVector is being shared via implicit sharing, do a deep copy of the data and separate from the shared members. This should be called by all non-const subclass members.
| Iterator TagLib::ByteVector::end | ( | ) |
Returns an Iterator that points to the back of the vector.
| ConstIterator TagLib::ByteVector::end | ( | ) | const |
Returns a ConstIterator that points to the back of the vector.
| bool TagLib::ByteVector::endsWith | ( | const ByteVector & | pattern | ) | const |
Returns true if the vector ends with pattern.
| int TagLib::ByteVector::endsWithPartialMatch | ( | const ByteVector & | pattern | ) | const |
Checks for a partial match of pattern at the end of the vector. It returns the offset of the partial match within the vector, or -1 if the pattern is not found. This method is particularly useful when searching for patterns that start in one vector and end in another. When combined with startsWith() it can be used to find a pattern that overlaps two buffers.
| int TagLib::ByteVector::find | ( | char | c, |
| unsigned int | offset = 0, |
||
| int | byteAlign = 1 |
||
| ) | const |
Searches the char for c starting at offset and returns the offset. Returns -1 if the pattern was not found. If byteAlign is specified the pattern will only be matched if it starts on a byte divisible by byteAlign (starting from offset).
| int TagLib::ByteVector::find | ( | const ByteVector & | pattern, |
| unsigned int | offset = 0, |
||
| int | byteAlign = 1 |
||
| ) | const |
Searches the ByteVector for pattern starting at offset and returns the offset. Returns -1 if the pattern was not found. If byteAlign is specified the pattern will only be matched if it starts on a byte divisible by byteAlign (starting from offset).
|
static |
Decodes the base64 encoded byte vector.
|
static |
Returns a ByteVector based on the CString s.
|
static |
Creates a 4 byte ByteVector based on value as an IEEE754 32-bit big-endian floating point number.
|
static |
Creates a 4 byte ByteVector based on value as an IEEE754 32-bit little-endian floating point number.
|
static |
Creates an 8 byte ByteVector based on value as an IEEE754 64-bit big-endian floating point number.
|
static |
Creates an 8 byte ByteVector based on value as an IEEE754 64-bit little-endian floating point number.
|
static |
Creates an 8 byte ByteVector based on value. If mostSignificantByteFirst is true, then this will operate left to right in building the ByteVector. For example if mostSignificantByteFirst is true then $00 00 00 01 == 0x0000000000000001 == 1, if false, $01 00 00 00 00 00 00 00 == 0x0100000000000000 == 1.
|
static |
Creates a 2 byte ByteVector based on value. If mostSignificantByteFirst is true, then this will operate left to right in building the ByteVector. For example if mostSignificantByteFirst is true then $00 01 == 0x0001 == 1, if false, $01 00 == 0x0100 == 1.
|
static |
Creates a 4 byte ByteVector based on value. If mostSignificantByteFirst is true, then this will operate left to right in building the ByteVector. For example if mostSignificantByteFirst is true then $00 00 00 01 == 0x00000001 == 1, if false, $01 00 00 00 == 0x01000000 == 1.
|
static |
Creates an 8 byte ByteVector based on value. If mostSignificantByteFirst is true, then this will operate left to right in building the ByteVector. For example if mostSignificantByteFirst is true then $00 00 00 01 == 0x0000000000000001 == 1, if false, $01 00 00 00 00 00 00 00 == 0x0100000000000000 == 1.
|
static |
Creates a 2 byte ByteVector based on value. If mostSignificantByteFirst is true, then this will operate left to right in building the ByteVector. For example if mostSignificantByteFirst is true then $00 01 == 0x0001 == 1, if false, $01 00 == 0x0100 == 1.
| bool TagLib::ByteVector::isEmpty | ( | ) | const |
Returns true if the ByteVector is empty.
| ByteVector TagLib::ByteVector::mid | ( | unsigned int | index, |
| unsigned int | length = 0xffffffff |
||
| ) | const |
Returns a byte vector made up of the bytes starting at index and for length bytes. If length is not specified it will return the bytes from index to the end of the vector.
| bool TagLib::ByteVector::operator!= | ( | const ByteVector & | v | ) | const |
Returns true if this ByteVector and v are not equal.
| bool TagLib::ByteVector::operator!= | ( | const char * | s | ) | const |
Returns true if this ByteVector and the null terminated C string s do not contain the same data.
| ByteVector TagLib::ByteVector::operator+ | ( | const ByteVector & | v | ) | const |
Returns a vector that is v appended to this vector.
| bool TagLib::ByteVector::operator< | ( | const ByteVector & | v | ) | const |
Returns true if this ByteVector is less than v. The value of the vectors is determined by evaluating the character from left to right, and in the event one vector is a superset of the other, the size is used.
| ByteVector & TagLib::ByteVector::operator= | ( | char | c | ) |
Copies a byte c.
| ByteVector & TagLib::ByteVector::operator= | ( | const ByteVector & | v | ) |
Copies ByteVector v.
| ByteVector & TagLib::ByteVector::operator= | ( | const char * | data | ) |
Copies data up to the first null byte.
| bool TagLib::ByteVector::operator== | ( | const ByteVector & | v | ) | const |
Returns true if this ByteVector and v are equal.
| bool TagLib::ByteVector::operator== | ( | const char * | s | ) | const |
Returns true if this ByteVector and the null terminated C string s contain the same data.
| bool TagLib::ByteVector::operator> | ( | const ByteVector & | v | ) | const |
Returns true if this ByteVector is greater than v.
| char & TagLib::ByteVector::operator[] | ( | int | index | ) |
Returns a reference to the byte at index.
| const char & TagLib::ByteVector::operator[] | ( | int | index | ) | const |
Returns a const reference to the byte at index.
| ReverseIterator TagLib::ByteVector::rbegin | ( | ) |
Returns a ReverseIterator that points to the front of the vector.
| ConstReverseIterator TagLib::ByteVector::rbegin | ( | ) | const |
Returns a ConstReverseIterator that points to the front of the vector.
| ReverseIterator TagLib::ByteVector::rend | ( | ) |
Returns a ReverseIterator that points to the back of the vector.
| ConstReverseIterator TagLib::ByteVector::rend | ( | ) | const |
Returns a ConstReverseIterator that points to the back of the vector.
| ByteVector & TagLib::ByteVector::replace | ( | char | oldByte, |
| char | newByte | ||
| ) |
Replaces oldByte with newByte and returns a reference to the ByteVector after the operation. This does modify the vector.
| ByteVector & TagLib::ByteVector::replace | ( | const ByteVector & | pattern, |
| const ByteVector & | with | ||
| ) |
Replaces pattern with with and returns a reference to the ByteVector after the operation. This does modify the vector.
| ByteVector & TagLib::ByteVector::resize | ( | unsigned int | size, |
| char | padding = 0 |
||
| ) |
Resize the vector to size. If the vector is currently less than size, pad the remaining spaces with padding. Returns a reference to the resized vector.
| int TagLib::ByteVector::rfind | ( | const ByteVector & | pattern, |
| unsigned int | offset = 0, |
||
| int | byteAlign = 1 |
||
| ) | const |
Searches the ByteVector for pattern starting from either the end of the vector or offset and returns the offset. Returns -1 if the pattern was not found. If byteAlign is specified the pattern will only be matched if it starts on a byte divisible by byteAlign (starting from offset).
| ByteVector & TagLib::ByteVector::setData | ( | const char * | data | ) |
Sets the data for the byte array copies data up to the first null byte. The behavior is undefined if data is not null terminated.
| ByteVector & TagLib::ByteVector::setData | ( | const char * | s, |
| unsigned int | length | ||
| ) |
Sets the data for the byte array using the first length bytes of s
| unsigned int TagLib::ByteVector::size | ( | ) | const |
Returns the size of the array.
| bool TagLib::ByteVector::startsWith | ( | const ByteVector & | pattern | ) | const |
Returns true if the vector starts with pattern.
|
noexcept |
Exchanges the content of the ByteVector with the content of v.
| ByteVector TagLib::ByteVector::toBase64 | ( | ) | const |
Returns a base64 encoded copy of the byte vector
| float TagLib::ByteVector::toFloat32BE | ( | size_t | offset | ) | const |
Converts the 4 bytes at offset of the vector to a float as an IEEE754 32-bit big-endian floating point number.
| float TagLib::ByteVector::toFloat32LE | ( | size_t | offset | ) | const |
Converts the 4 bytes at offset of the vector to a float as an IEEE754 32-bit little-endian floating point number.
| double TagLib::ByteVector::toFloat64BE | ( | size_t | offset | ) | const |
Converts the 8 bytes at offset of the vector to a double as an IEEE754 64-bit big-endian floating point number.
| double TagLib::ByteVector::toFloat64LE | ( | size_t | offset | ) | const |
Converts the 8 bytes at offset of the vector to a double as an IEEE754 64-bit little-endian floating point number.
| long double TagLib::ByteVector::toFloat80BE | ( | size_t | offset | ) | const |
Converts the 10 bytes at offset of the vector to a long double as an IEEE754 80-bit big-endian floating point number.
| long double TagLib::ByteVector::toFloat80LE | ( | size_t | offset | ) | const |
Converts the 10 bytes at offset of the vector to a long double as an IEEE754 80-bit little-endian floating point number.
| ByteVector TagLib::ByteVector::toHex | ( | ) | const |
Returns a hex-encoded copy of the byte vector.
| long long TagLib::ByteVector::toLongLong | ( | bool | mostSignificantByteFirst = true | ) | const |
Converts the first 8 bytes of the vector to a (signed) long long.
If mostSignificantByteFirst is true this will operate left to right evaluating the integer. For example if mostSignificantByteFirst is true then $00 00 00 00 00 00 00 01 == 0x0000000000000001 == 1, if false, $01 00 00 00 00 00 00 00 == 0x0100000000000000 == 1.
| long long TagLib::ByteVector::toLongLong | ( | unsigned int | offset, |
| bool | mostSignificantByteFirst = true |
||
| ) | const |
Converts the 8 bytes at offset of the vector to a (signed) long long.
If mostSignificantByteFirst is true this will operate left to right evaluating the integer. For example if mostSignificantByteFirst is true then $00 00 00 00 00 00 00 01 == 0x0000000000000001 == 1, if false, $01 00 00 00 00 00 00 00 == 0x0100000000000000 == 1.
| short TagLib::ByteVector::toShort | ( | bool | mostSignificantByteFirst = true | ) | const |
Converts the first 2 bytes of the vector to a (signed) short.
If mostSignificantByteFirst is true this will operate left to right evaluating the integer. For example if mostSignificantByteFirst is true then $00 $01 == 0x0001 == 1, if false, $01 00 == 0x01000000 == 1.
| short TagLib::ByteVector::toShort | ( | unsigned int | offset, |
| bool | mostSignificantByteFirst = true |
||
| ) | const |
Converts the 2 bytes at offset of the vector to a (signed) short.
If mostSignificantByteFirst is true this will operate left to right evaluating the integer. For example if mostSignificantByteFirst is true then $00 $01 == 0x0001 == 1, if false, $01 00 == 0x01000000 == 1.
| unsigned int TagLib::ByteVector::toUInt | ( | bool | mostSignificantByteFirst = true | ) | const |
Converts the first 4 bytes of the vector to an unsigned integer.
If mostSignificantByteFirst is true this will operate left to right evaluating the integer. For example if mostSignificantByteFirst is true then $00 $00 $00 $01 == 0x00000001 == 1, if false, $01 00 00 00 == 0x01000000 == 1.
| unsigned int TagLib::ByteVector::toUInt | ( | unsigned int | offset, |
| bool | mostSignificantByteFirst = true |
||
| ) | const |
Converts the 4 bytes at offset of the vector to an unsigned integer.
If mostSignificantByteFirst is true this will operate left to right evaluating the integer. For example if mostSignificantByteFirst is true then $00 $00 $00 $01 == 0x00000001 == 1, if false, $01 00 00 00 == 0x01000000 == 1.
| unsigned int TagLib::ByteVector::toUInt | ( | unsigned int | offset, |
| unsigned int | length, | ||
| bool | mostSignificantByteFirst = true |
||
| ) | const |
Converts the length bytes at offset of the vector to an unsigned integer. If length is larger than 4, the excess is ignored.
If mostSignificantByteFirst is true this will operate left to right evaluating the integer. For example if mostSignificantByteFirst is true then $00 $00 $00 $01 == 0x00000001 == 1, if false, $01 00 00 00 == 0x01000000 == 1.
| unsigned long long TagLib::ByteVector::toULongLong | ( | bool | mostSignificantByteFirst = true | ) | const |
Converts the first 8 bytes of the vector to an unsigned long long.
If mostSignificantByteFirst is true this will operate left to right evaluating the integer. For example if mostSignificantByteFirst is true then $00 00 00 00 00 00 00 01 == 0x0000000000000001 == 1, if false, $01 00 00 00 00 00 00 00 == 0x0100000000000000 == 1.
| unsigned long long TagLib::ByteVector::toULongLong | ( | unsigned int | offset, |
| bool | mostSignificantByteFirst = true |
||
| ) | const |
Converts the 8 bytes at offset of the vector to an unsigned long long.
If mostSignificantByteFirst is true this will operate left to right evaluating the integer. For example if mostSignificantByteFirst is true then $00 00 00 00 00 00 00 01 == 0x0000000000000001 == 1, if false, $01 00 00 00 00 00 00 00 == 0x0100000000000000 == 1.
| unsigned short TagLib::ByteVector::toUShort | ( | bool | mostSignificantByteFirst = true | ) | const |
Converts the first 2 bytes of the vector to an unsigned short.
If mostSignificantByteFirst is true this will operate left to right evaluating the integer. For example if mostSignificantByteFirst is true then $00 $01 == 0x0001 == 1, if false, $01 00 == 0x01000000 == 1.
| unsigned short TagLib::ByteVector::toUShort | ( | unsigned int | offset, |
| bool | mostSignificantByteFirst = true |
||
| ) | const |
Converts the 2 bytes at offset of the vector to an unsigned short.
If mostSignificantByteFirst is true this will operate left to right evaluating the integer. For example if mostSignificantByteFirst is true then $00 $01 == 0x0001 == 1, if false, $01 00 == 0x01000000 == 1.
|
related |
Streams the ByteVector v to the output stream s.