Miam-Player  0.8.0
A nice music player
TagLib::S3M::File Class Reference

#include <s3mfile.h>

Inheritance diagram for TagLib::S3M::File:
TagLib::Mod::FileBase TagLib::File

Public Member Functions

 File (FileName file, bool readProperties=true, AudioProperties::ReadStyle propertiesStyle=AudioProperties::Average)
 Constructs a ScreamTracker III from file. More...
 
 File (IOStream *stream, bool readProperties=true, AudioProperties::ReadStyle propertiesStyle=AudioProperties::Average)
 Constructs a ScreamTracker III file from stream. More...
 
virtual ~File ()
 Destroys this instance of the File. More...
 
Mod::Tagtag () const
 Returns a pointer to this file's tag. More...
 
PropertyMap properties () const
 Implements the unified property interface – export function. More...
 
PropertyMap setProperties (const PropertyMap &)
 Implements the unified property interface – import function. More...
 
S3M::PropertiesaudioProperties () const
 Returns the S3M::Properties for this file. More...
 
bool save ()
 Save the file. More...
 
- Public Member Functions inherited from TagLib::File
FileName name () const
 Returns the file name in the local file system encoding. 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...
 
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...
 

Additional Inherited Members

- Public Types inherited from TagLib::File
enum  Position { Beginning, Current, End }
 Position in the file used for seeking. More...
 
- Static Public Member Functions inherited from TagLib::File
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...
 
- Protected Member Functions inherited from TagLib::Mod::FileBase
 FileBase (FileName file)
 
 FileBase (IOStream *stream)
 
void writeString (const String &s, unsigned long size, char padding=0)
 
void writeByte (unsigned char byte)
 
void writeU16L (unsigned short number)
 
void writeU32L (unsigned long number)
 
void writeU16B (unsigned short number)
 
void writeU32B (unsigned long number)
 
bool readString (String &s, unsigned long size)
 
bool readByte (unsigned char &byte)
 
bool readU16L (unsigned short &number)
 
bool readU32L (unsigned long &number)
 
bool readU16B (unsigned short &number)
 
bool readU32B (unsigned long &number)
 
- Protected Member Functions inherited from TagLib::File
 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...
 
- Static Protected Member Functions inherited from TagLib::File
static unsigned int bufferSize ()
 Returns the buffer size that is used for internal buffering. More...
 

Constructor & Destructor Documentation

◆ File() [1/2]

TagLib::S3M::File::File ( FileName  file,
bool  readProperties = true,
AudioProperties::ReadStyle  propertiesStyle = AudioProperties::Average 
)

Constructs a ScreamTracker III from file.

Note
In the current implementation, both readProperties and propertiesStyle are ignored. The audio properties are always read.

◆ File() [2/2]

TagLib::S3M::File::File ( IOStream stream,
bool  readProperties = true,
AudioProperties::ReadStyle  propertiesStyle = AudioProperties::Average 
)

Constructs a ScreamTracker III file from stream.

Note
In the current implementation, both readProperties and propertiesStyle are ignored. The audio properties are always read.
TagLib will not take ownership of the stream, the caller is responsible for deleting it after the File object.

◆ ~File()

virtual TagLib::S3M::File::~File ( )
virtual

Destroys this instance of the File.

Reimplemented from TagLib::File.

Member Function Documentation

◆ audioProperties()

S3M::Properties* TagLib::S3M::File::audioProperties ( ) const
virtual

Returns the S3M::Properties for this file.

If no audio properties were read then this will return a null pointer.

Implements TagLib::File.

◆ properties()

PropertyMap TagLib::S3M::File::properties ( ) const

Implements the unified property interface – export function.

Forwards to Mod::Tag::properties().

◆ save()

bool TagLib::S3M::File::save ( )
virtual

Save the file.

This is the same as calling save(AllTags);

Note
Saving ScreamTracker III tags is not supported.

Implements TagLib::File.

◆ setProperties()

PropertyMap TagLib::S3M::File::setProperties ( const PropertyMap )

Implements the unified property interface – import function.

Forwards to Mod::Tag::setProperties().

◆ tag()

Mod::Tag* TagLib::S3M::File::tag ( ) const
virtual

Returns a pointer to this file's tag.

This should be reimplemented in the concrete subclasses.

Implements TagLib::File.


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