.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Header 3pm"
.TH Header 3pm "2009-08-20" "perl v5.20.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Audio::FLAC::Header \- interface to FLAC header metadata.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&        use Audio::FLAC::Header;
\&        my $flac = Audio::FLAC::Header\->new("song.flac");
\&
\&        my $info = $flac\->info();
\&
\&        foreach (keys %$info) {
\&                print "$_: $info\->{$_}\en";
\&        }
\&
\&        my $tags = $flac\->tags();
\&
\&        foreach (keys %$tags) {
\&                print "$_: $tags\->{$_}\en";
\&        }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module returns a hash containing basic information about a \s-1FLAC\s0 file,
a representation of the embedded cue sheet if one exists,  as well as tag
information contained in the \s-1FLAC\s0 file's Vorbis tags.
There is no complete list of tag keys for Vorbis tags, as they can be
defined by the user; the basic set of tags used for \s-1FLAC\s0 files include:
.PP
.Vb 7
\&        ALBUM
\&        ARTIST
\&        TITLE
\&        DATE
\&        GENRE
\&        TRACKNUMBER
\&        COMMENT
.Ve
.PP
The information returned by Audio::FLAC::info is keyed by:
.PP
.Vb 9
\&        MINIMUMBLOCKSIZE
\&        MAXIMUMBLOCKSIZE
\&        MINIMUMFRAMESIZE
\&        MAXIMUMFRAMESIZE
\&        TOTALSAMPLES
\&        SAMPLERATE
\&        NUMCHANNELS
\&        BITSPERSAMPLE
\&        MD5CHECKSUM
.Ve
.PP
Information stored in the main hash that relates to the file itself or is
calculated from some of the information fields is keyed by:
.PP
.Vb 6
\&        trackLengthMinutes      : minutes field of track length
\&        trackLengthSeconds      : seconds field of track length
\&        trackLengthFrames       : frames field of track length (base 75)
\&        trackTotalLengthSeconds : total length of track in fractional seconds
\&        bitRate                 : average bits per second of file
\&        fileSize                : file size, in bytes
.Ve
.SH "CONSTRUCTORS"
.IX Header "CONSTRUCTORS"
.ie n .SS """new ($filename)"""
.el .SS "\f(CWnew ($filename)\fP"
.IX Subsection "new ($filename)"
Opens a \s-1FLAC\s0 file, ensuring that it exists and is actually an
\&\s-1FLAC\s0 stream, then loads the information and comment fields.
.SH "INSTANCE METHODS"
.IX Header "INSTANCE METHODS"
.IP "\(bu" 4
info( [$key] )
.Sp
Returns a hashref containing information about the \s-1FLAC\s0 file from
the file's information header.
.Sp
The optional parameter, key, allows you to retrieve a single value from
the info hash.  Returns \f(CW\*(C`undef\*(C'\fR if the key is not found.
.IP "\(bu" 4
tags( [$key] )
.Sp
Returns a hashref containing tag keys and values of the \s-1FLAC\s0 file from
the file's Vorbis Comment header.
.Sp
The optional parameter, key, allows you to retrieve a single value from
the tag hash.  Returns \f(CW\*(C`undef\*(C'\fR if the key is not found.
.IP "\(bu" 4
cuesheet( )
.Sp
Returns an arrayref which contains a textual representation of the
cuesheet metada block. Each element in the array corresponds to one
line in a .cue file. If there is no cuesheet block in this \s-1FLAC\s0 file
the array will be empty. The resulting cuesheet should match the
output of metaflac's \-\-export\-cuesheet\-to option, with the exception
of the \s-1FILE\s0 line, which includes the actual file name instead of
\&\*(L"dummy.wav\*(R".
.IP "\(bu" 4
seektable( )
.Sp
Returns the seektable. Currently disabled for performance.
.IP "\(bu" 4
application( \f(CW$appId\fR )
.Sp
Returns the application block for the passed id.
.IP "\(bu" 4
picture( [$type ] )
.Sp
Returns a hash containing data from a \s-1PICTURE\s0 block if found.
.Sp
Defaults to type 3 \- \*(L"Front Cover\*(R"
.Sp
When the passed variable is 'all', an array of hashes containing
picture data from all \s-1PICTURE\s0 blocks is returned. Allows for multiple instances
of the same picture type.
.IP "\(bu" 4
set_separator( )
.Sp
For multi-value \s-1ID3\s0 tags, set the separator string. Defaults to '/'
.IP "\(bu" 4
vendor_string( )
.Sp
Returns the vendor string.
.IP "\(bu" 4
set_vendor_string( \f(CW$string\fR )
.Sp
Set the vendor string. Will be written on \fIwrite()\fR
.IP "\(bu" 4
write( )
.Sp
Writes the current contents of the tag hash to the \s-1FLAC\s0 file, given that
there's enough space in the header to do so. If there's insufficient
space available (using pre-existing padding), the file will remain
unchanged, and the function will return a zero value.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
<http://flac.sourceforge.net/format.html>
.SH "AUTHORS"
.IX Header "AUTHORS"
Dan Sully, <daniel@cpan.org>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Pure perl code Copyright (c) 2003\-2004, Erik Reckase.
.PP
Pure perl code Copyright (c) 2003\-2007, Dan Sully & Slim Devices.
Pure perl code Copyright (c) 2008\-2009, Dan Sully
.PP
\&\s-1XS\s0 code Copyright (c) 2004\-2007, Dan Sully & Slim Devices.
\&\s-1XS\s0 code Copyright (c) 2008\-2009, Dan Sully
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.2 or,
at your option, any later version of Perl 5 you may have available.