![]() |
Miam-Player
0.8.0
A nice music player
|
An implementation of TagLib::File with some helpers for Ogg based formats. More...
#include <oggfile.h>
Public Member Functions | |
virtual | ~File () |
Destroys this File instance. More... | |
ByteVector | packet (unsigned int i) |
Returns the packet contents for the i-th packet (starting from zero) in the Ogg bitstream. More... | |
void | setPacket (unsigned int i, const ByteVector &p) |
Sets the packet with index i to the value p. More... | |
const PageHeader * | firstPageHeader () |
Returns a pointer to the PageHeader for the first page in the stream or null if the page could not be found. More... | |
const PageHeader * | lastPageHeader () |
Returns a pointer to the PageHeader for the last page in the stream or null if the page could not be found. More... | |
virtual bool | save () |
Save the file and its associated tags. More... | |
![]() | |
FileName | name () const |
Returns the file name in the local file system encoding. More... | |
virtual Tag * | tag () const =0 |
Returns a pointer to this file's tag. More... | |
PropertyMap | properties () const |
Exports the tags of the file as dictionary mapping (human readable) tag names (uppercase Strings) to StringLists of tag values. More... | |
void | removeUnsupportedProperties (const StringList &properties) |
Removes unsupported properties, or a subset of them, from the file's metadata. More... | |
PropertyMap | setProperties (const PropertyMap &properties) |
Sets the tags of this File to those specified in properties. More... | |
virtual AudioProperties * | audioProperties () const =0 |
Returns a pointer to this file's audio properties. More... | |
ByteVector | readBlock (unsigned long length) |
Reads a block of size length at the current get pointer. More... | |
void | writeBlock (const ByteVector &data) |
Attempts to write the block data at the current get pointer. More... | |
long | find (const ByteVector &pattern, long fromOffset=0, const ByteVector &before=ByteVector()) |
Returns the offset in the file that pattern occurs at or -1 if it can not be found. More... | |
long | rfind (const ByteVector &pattern, long fromOffset=0, const ByteVector &before=ByteVector()) |
Returns the offset in the file that pattern occurs at or -1 if it can not be found. More... | |
void | insert (const ByteVector &data, unsigned long start=0, unsigned long replace=0) |
Insert data at position start in the file overwriting replace bytes of the original content. More... | |
void | removeBlock (unsigned long start=0, unsigned long length=0) |
Removes a block of the file starting a start and continuing for length bytes. More... | |
bool | readOnly () const |
Returns true if the file is read only (or if the file can not be opened). More... | |
bool | isOpen () const |
Since the file can currently only be opened as an argument to the constructor (sort-of by design), this returns if that open succeeded. More... | |
bool | isValid () const |
Returns true if the file is open and readable. More... | |
void | seek (long offset, Position p=Beginning) |
Move the I/O pointer to offset in the file from position p. More... | |
void | clear () |
Reset the end-of-file and error flags on the file. More... | |
long | tell () const |
Returns the current offset within the file. More... | |
long | length () |
Returns the length of the file. More... | |
Protected Member Functions | |
File (FileName file) | |
Constructs an Ogg file from file. More... | |
File (IOStream *stream) | |
Constructs an Ogg file from stream. More... | |
![]() | |
File (FileName file) | |
Construct a File object and opens the file. More... | |
File (IOStream *stream) | |
Construct a File object and use the stream instance. More... | |
void | setValid (bool valid) |
Marks the file as valid or invalid. More... | |
void | truncate (long length) |
Truncates the file to a length. More... | |
Additional Inherited Members | |
![]() | |
enum | Position { Beginning, Current, End } |
Position in the file used for seeking. More... | |
![]() | |
static bool | isReadable (const char *file) |
Returns true if file can be opened for reading. More... | |
static bool | isWritable (const char *name) |
Returns true if file can be opened for writing. More... | |
![]() | |
static unsigned int | bufferSize () |
Returns the buffer size that is used for internal buffering. More... | |
An implementation of TagLib::File with some helpers for Ogg based formats.
This is an implementation of Ogg file page and packet rendering and is of use to Ogg based formats. While the API is small this handles the non-trivial details of breaking up an Ogg stream into packets and makes these available (via subclassing) to the codec meta data implementations.
|
virtual |
Destroys this File instance.
Reimplemented from TagLib::File.
Reimplemented in TagLib::Ogg::FLAC::File, TagLib::Vorbis::File, TagLib::Ogg::Opus::File, and TagLib::Ogg::Speex::File.
|
protected |
|
protected |
const PageHeader* TagLib::Ogg::File::firstPageHeader | ( | ) |
Returns a pointer to the PageHeader for the first page in the stream or null if the page could not be found.
const PageHeader* TagLib::Ogg::File::lastPageHeader | ( | ) |
Returns a pointer to the PageHeader for the last page in the stream or null if the page could not be found.
ByteVector TagLib::Ogg::File::packet | ( | unsigned int | i | ) |
Returns the packet contents for the i-th packet (starting from zero) in the Ogg bitstream.
|
virtual |
Save the file and its associated tags.
This should be reimplemented in the concrete subclasses. Returns true if the save succeeds.
Implements TagLib::File.
Reimplemented in TagLib::Ogg::FLAC::File, TagLib::Vorbis::File, TagLib::Ogg::Opus::File, and TagLib::Ogg::Speex::File.
void TagLib::Ogg::File::setPacket | ( | unsigned int | i, |
const ByteVector & | p | ||
) |
Sets the packet with index i to the value p.