![]() |
|
#include <oggpageheader.h>
Public Member Functions | |
PageHeader (File *file=0, long pageOffset=-1) | |
virtual | ~PageHeader () |
bool | isValid () const |
List< int > | packetSizes () const |
void | setPacketSizes (const List< int > &sizes) |
bool | firstPacketContinued () const |
void | setFirstPacketContinued (bool continued) |
bool | lastPacketCompleted () const |
void | setLastPacketCompleted (bool completed) |
bool | firstPageOfStream () const |
void | setFirstPageOfStream (bool first) |
bool | lastPageOfStream () const |
void | setLastPageOfStream (bool last) |
long long | absoluteGranularPosition () const |
void | setAbsoluteGranularPosition (long long agp) |
uint | streamSerialNumber () const |
void | setStreamSerialNumber (uint n) |
int | pageSequenceNumber () const |
void | setPageSequenceNumber (int sequenceNumber) |
int | size () const |
int | dataSize () const |
ByteVector | render () const |
This class implements Ogg page headers which contain the information about Ogg pages needed to break them into packets which can be passed on to the codecs.
TagLib::Ogg::PageHeader::PageHeader | ( | File * | file = 0 , |
|
long | pageOffset = -1 | |||
) |
Reads a PageHeader from file starting at pageOffset. The defaults create a page with no (and as such, invalid) data that must be set later.
virtual TagLib::Ogg::PageHeader::~PageHeader | ( | ) | [virtual] |
Deletes this instance of the PageHeader.
bool TagLib::Ogg::PageHeader::isValid | ( | ) | const |
Returns true if the header parsed properly and is valid.
List<int> TagLib::Ogg::PageHeader::packetSizes | ( | ) | const |
Ogg pages contain a list of packets (which are used by the contained codecs). The sizes of these pages is encoded in the page header. This returns a list of the packet sizes in bytes.
void TagLib::Ogg::PageHeader::setPacketSizes | ( | const List< int > & | sizes | ) |
Sets the sizes of the packets in this page to sizes. Internally this updates the lacing values in the header.
bool TagLib::Ogg::PageHeader::firstPacketContinued | ( | ) | const |
Some packets can be continued across multiple pages. If the first packet in the current page is a continuation this will return true. If this is page starts with a new packet this will return false.
void TagLib::Ogg::PageHeader::setFirstPacketContinued | ( | bool | continued | ) |
Sets the internal flag indicating if the first packet in this page is continued to continued.
bool TagLib::Ogg::PageHeader::lastPacketCompleted | ( | ) | const |
Returns true if the last packet of this page is completely contained in this page.
void TagLib::Ogg::PageHeader::setLastPacketCompleted | ( | bool | completed | ) |
Sets the internal flag indicating if the last packet in this page is complete to completed.
bool TagLib::Ogg::PageHeader::firstPageOfStream | ( | ) | const |
This returns true if this is the first page of the Ogg (logical) stream.
void TagLib::Ogg::PageHeader::setFirstPageOfStream | ( | bool | first | ) |
bool TagLib::Ogg::PageHeader::lastPageOfStream | ( | ) | const |
This returns true if this is the last page of the Ogg (logical) stream.
void TagLib::Ogg::PageHeader::setLastPageOfStream | ( | bool | last | ) |
long long TagLib::Ogg::PageHeader::absoluteGranularPosition | ( | ) | const |
A special value of containing the position of the packet to be interpreted by the codec. In the case of Vorbis this contains the PCM value and is used to calculate the length of the stream.
void TagLib::Ogg::PageHeader::setAbsoluteGranularPosition | ( | long long | agp | ) |
A special value of containing the position of the packet to be interpreted by the codec. It is only supported here so that it may be coppied from one page to another.
uint TagLib::Ogg::PageHeader::streamSerialNumber | ( | ) | const |
Every Ogg logical stream is given a random serial number which is common to every page in that logical stream. This returns the serial number of the stream associated with this packet.
void TagLib::Ogg::PageHeader::setStreamSerialNumber | ( | uint | n | ) |
Every Ogg logical stream is given a random serial number which is common to every page in that logical stream. This sets this pages serial number. This method should be used when adding new pages to a logical stream.
int TagLib::Ogg::PageHeader::pageSequenceNumber | ( | ) | const |
Returns the index of the page within the Ogg stream. This helps make it possible to determine if pages have been lost.
void TagLib::Ogg::PageHeader::setPageSequenceNumber | ( | int | sequenceNumber | ) |
int TagLib::Ogg::PageHeader::size | ( | ) | const |
Returns the complete header size.
int TagLib::Ogg::PageHeader::dataSize | ( | ) | const |
Returns the size of the data portion of the page -- i.e. the size of the page less the header size.
ByteVector TagLib::Ogg::PageHeader::render | ( | ) | const |
Render the page header to binary data.