Geoffrey Leach > Audio-TagLib > Audio::TagLib

Download:
Audio-TagLib-1.64.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  2
View/Report Bugs
Module Version: 1.64   Source  

NAME ^

Audio::TagLib - A library for reading and editing audio meta data, commonly known as "tags".

SYNOPSIS ^

  use Audio::TagLib;

  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.

VERSION ^

1.64

DESCRIPTION ^

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 library 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 dependency that TagLib has, it a semi-sane STL implementation.

Why TagLib ?
 TagLib was written to fill a gap in the Open Source/Free Software
 community. Currently there is a lack in the OSS/FS for a homogenous
 API to the most common music types.

As TagLib will be initially injected into the KDE community, while it has not been linked to any of the KDE or Qt libraries Scott has tried to follow the coding style of those libraries. Again, this is in sharp contrast to id3lib, which basically provides a hybrid C/C++ API and uses a dubious object model.

Scott gets asked rather frequently why he is replacing id3lib (mostly by people that have never worked with id3lib), if you are concerned about this please email him; He can provide his lengthy standard rant.

EXPORT

None by default.

ENUM TYPE MAPPING ^

All over TagLib in Perl, ALL the enum value is mapped to a specific string. For instance, Audio::TagLib::String::UTF8 => "UTF8". Usually there will be a hash you can query all the available values.

NAMESPACE ISSUE ^

Audio::TagLib::Ogg::Vorbis and Audio::TagLib::Vorbis are normally the same.

In C/C++, namespace Ogg is controlled by the macro DOXYGEN. When defined, there will be Audio::TagLib::Ogg::Vorbis existing. Otherwise, they just import all the symbols from Audio::TagLib::Vorbis to Audio::TagLib::Ogg::Vorbis.

In Perl, nearly the same. It will make one stash be the alias of another. Refer to Audio::TagLib::Ogg::Vorbis::File.pm, for instance.

FUNCTION PROTOTYPE ^

Currently all XS stubs will be imported into Perl namespace with specific prototype, just the same as internal functions. Prototype triggers a type map sometimes silently since it introduces context to each param.

A very simple way to get rid of prototype surrounding:

eval { use __PACKAGE__; 1; } or croak("package import failed: $@");

Normally, just require __PACKAGE__; since no symbol exported from TagLib ;P

THREAD SAFETY ^

Currently NOT implemented.

OTHER STUFF YOU SHOULD KNOW ^

Some methods will often return certain internal structure of an instance, for example, tag() & audioProperties() in all subclasses of AudioProperties. In such case, a READONLY flag is set on for the returned structure to bypass DESTROY().

SEE ALSO ^

The TagLib documentation page. http://taglib.github.io/

KNOWN BUGS ^

Refer to Bugs in the top level of the package

CREDITS ^

The following have provided invaluable assistance in the debugging of TagLib.pm. Responsiblity for errors, omissions and stupid goofs lies solely with the maintainer.

Scott Wheeler wheeler@kde.org

Festus Hagen festushagen2002@yahoo.com

Sisyphus sisyphus@cpan.org

CHOCOLATE choclate@cpan.org

Philip Lyons vorzox@gmail.com

AUTHOR ^

Dongxu Ma dongxu@cpan.org

MAINTAINER ^

Geoffrey Leach GLEACH@cpan.org

COPYRIGHT AND LICENSE ^

Copyright (C) 2005 - 2010 by Dongxu Ma

Copyright (C) 2011 - 2013 Geoffrey Leach

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: