Free taglib software for linux

Audio::TagLib is a library for reading and editing audio meta data, commonly known as tags.

SYNOPSIS

use Audio::TagLib;
use warnings;
use strict;

my $f = Audio::TagLib::FileRef->new("Latex Solar Beef.mp3");
my $artist = $f->tag()->artist();
print $artist->toCString(), "n"; # got "Frank Zappa"

$f->tag()->setAlbum(Audio::TagLib::String->new("Fillmore East"));
$f->save();

my $g = Audio::TagLib::FileRef->new("Free City Rhymes.ogg");
my $album = $g->tag()->album();
print $album->toCString(), "n"; # got "NYC Ghosts & Flowers"

$g->tag()->setTrack(1);
$g->save();

Note that these high level functions work for Ogg, FLAC, MPC and MP3 (or any other formats supported in the future). For this high level API, which is suitable for most applications, the differences between tag and file formats can all be ignored.

Some goals of TagLib: - A clean, high level, C++ API to handling audio meta data. - Support for at least ID3v1, ID3v2 and Ogg Vorbis comments. - A generic, simple API for the most common tagging related functions. - Binary compatibility between minor releases using the standard KDE/Qt techniques for C++ binary compatibility. - Make the tagging framework extensible by library users; i.e. it will be possible for libarary users to implement additional ID3v2 frames, without modifying the TagLib source (through the use of Abstract Factories and such.

Because TagLib desires to be toolkit agnostic, in hope of being widely adopted and the most flexible in licensing TagLib provides many of its own toolkit classes; in fact the only external dependancy that TagLib has, it a semi-sane STL implementation.

Audio::TagLib::Tag is a simple, generic interface to common audio meta data fields.

This is an attempt to abstract away the difference in the meta data formats of various audio codecs and tagging schemes. As such it is generally a subset of what is available in the specific formats but should be suitable for most applications. This is meant to complient the generic APIs found in Audio::TagLib::AudioProperties, Audio::TagLib::File and Audio::TagLib::FileRef.

DESTROY()

Detroys this Tag instance.

String title() [pure virtual]

Returns the track name; if no track name is present in the tag String::null will be returned.

String artist() [pure virtual]

Returns the artist name; if no artist name is present in the tag String::null will be returned.

String album() [pure virtual]

Returns the album name; if no album name is present in the tag String::null will be returned.

String comment() [pure virtual]

Returns the track comment; if no comment is present in the tag String::null will be returned.

String genre() [pure virtual]

Returns the genre name; if no genre is present in the tag String::null will be returned.

UV year() [pure virtual]

Returns the year; if there is no year set, this will return 0.

UV track() [pure virtual]

Returns the track number; if there is no track number set, this will return 0.

void setTitle(String $s) [pure virtual]

Sets the title to $s. If $s is String::null() then this value will be cleared.

void setArtist(String $s) [pure virtual]

Sets the artist to $s. If $s is String::null() then this value will be cleared.

void setAlbum(String $s) [pure virtual]

Sets the album to $s. If $s is String::null() then this value will be cleared.

void setComment(String $s) [pure virtual]

Sets the comment to $s. If $s is String::null() then this value will be cleared.

void setGenre(String $s) [pure virtual]

Sets the genre to $s. If $s is String::null() then this value will be cleared. For tag formats that use a fixed set of genres, the appropriate value will be selected based on a string comparison. A list of available genres for those formats should be available in that types implementation.

void setYear(UV $i) [pure virtual]

Sets the year to $i. If $i is 0 then this value will be cleared.

void setTrack(UV $i) [pure virtual]

Sets the track to $i. If $i is 0 then this value will be cleared.

void duplicate(Tag $source, Tag $target, BOOL $overwrite = TRUE) [static]

Copies the generic data from one tag to another.

NOTE This will no affect any of the lower level details of the tag. For instance if any of the tag type specific data (maybe a URL for a band) is set, this will not modify or copy that. This just copies using the API in this class.

If $overwrite is true then the values will be unconditionally copied. If false only empty values will be overwritten.

Audio::TagLib::File is a file class with some useful methods for tag manipulation.

This class is a basic file class with some methods that are particularly useful for tag editors. It has methods to take advantage of ByteVector and a binary search method for finding patterns in a file.

DESTROY()

Destroys this File instance.

PV name()

Returns the file name in the local file system encoding.

Tag tag() [pure virtual]

Returns this files tag. This should be reimplemented in the concrete subclasses.

AudioProperties audioProperties() [pure virtual]

Returns this files audio properties. This should be reimplemented in the concrete subclasses. If no audio properties were read then this will return undef.

BOOL save() [pure virtual]

Save the file and its associated tags. This should be reimplemented in the concrete subclasses. Returns true if the save succeeds.

ByteVector readBlock(UV $length)

Reads a block of size $length at the current get pointer.

void writeBlock(ByteVector $data)

Attempts to write the block $data at the current get pointer. If the file is currently only opened read only -- i.e. readOnly() returns true -- this attempts to reopen the file in read/write mode.

IV find(ByteVector $pattern, IV $fromOffset = 0, ByteVector $before = ByteVector::null)

Returns the offset in the file that $pattern occurs at or -1 if it can not be found. If $before is set, the search will only continue until the pattern $before is found. This is useful for tagging purposes to search for a tag before the synch frame.

Searching starts at $fromOffset, which defaults to the beginning of the file.

This has the practial limitation that $pattern can not be longer than the buffer size used by readBlock(). Currently this is 1024 bytes.

IV rfind(ByteVector $pattern, IV $fromOffset = 0, ByteVector $before = ByteVector::null)

Returns the offset in the file that $pattern at or -1 if it can not be found. If $before is set, the search will only continue until the pattern $before is found. This is useful for tagging purposes to search for a tag before the synch frame.

Searching starts at $fromOffset and proceeds from the that point to the beginning of the file and defaults to the end of the file.

This has the practial limitation that $pattern can not be longer than the buffer size used by readBlock(). Currently this is 1024 bytes.

void insert(ByteVector $data, UV $start = 0, UV $replace = 0)

Insert $data at position $start in the file overwriting $replace bytes of the original content.

This method is slow since it requires rewriting all of the file after the insertion point.

void removeBlock(UV $start = 0, UV $length = 0)

Removes a block of the file starting a $start and continuing for $length bytes.
This method is slow since it involves rewriting all of the file after the removed portion.

BOOL readOnly()

Returns true if the file is read only (or if the file can not be opened).

BOOL isOpen()

Since the file can currently only be opened as an argument to the constructor (sort-of by design), this returns if that open succeeded.

BOOL isValid()

Returns true if the file is open and readble and valid information for the Tag and / or AudioProperties was found.

void seek(IV $offset, PV $p = "Beginning")

Move the I/O pointer to $offset in the file from position $p. This defaults to seeking from the beginning of the file.

void clear()

Reset the end-of-file and error flags on the file.

IV tell()

Returns the current offset withing the file.

IV length()

Returns the length of the file.

BOOL isReadable(PV $file) [static]

Returns true if $file can be opened for reading. If the file does not exist, this will return false.

BOOL isWritable(PV $file) [static]

Returns true if $file can be opened for writing.

%_Position

Position in the file used for seeking. C<<less