.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" 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" '' '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. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" 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 "MP3::Tag::File 3pm" .TH MP3::Tag::File 3pm "2009-11-28" "perl v5.14.2" "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" MP3::Tag::File \- Module for reading / writing files .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& my $mp3 = MP3::Tag\->new($filename); \& \& ($title, $artist, $no, $album, $year) = $mp3\->parse_filename(); .Ve .PP see MP3::Tag .SH "DESCRIPTION" .IX Header "DESCRIPTION" MP3::Tag::File is designed to be called from the MP3::Tag module. .PP It offers possibilities to read/write data from files via \fIread()\fR, \fIwrite()\fR, \&\fItruncate()\fR, \fIseek()\fR, \fItell()\fR, \fIopen()\fR, \fIclose()\fR; one can find the filename via the \fIfilename()\fR method. .IP "\fIparse_filename()\fR" 4 .IX Item "parse_filename()" .Vb 1 \& ($title, $artist, $no, $album, $year) = $mp3\->parse_filename($what, $filename); .Ve .Sp \&\fIparse_filename()\fR tries to extract information about artist, title, track number, album and year from the filename. (For backward compatibility it may be also called by deprecated name \&\fIread_filename()\fR.) .Sp This is likely to fail for a lot of filenames, especially the album will be often wrongly guessed, as the name of the parent directory is taken as album name. .Sp \&\f(CW$what\fR and \f(CW$filename\fR are optional. \f(CW$what\fR maybe title, track, artist, album or year. If \f(CW$what\fR is defined \fIparse_filename()\fR will return only this element. .Sp If \f(CW$filename\fR is defined this filename will be used and not the real filename which was set by MP3::Tag with \&\f(CW\*(C`MP3::Tag\->new($filename)\*(C'\fR. Otherwise the actual filename is used (subject to configuration variable \f(CW\*(C`decode_encoding_filename\*(C'\fR). .Sp Following formats will be hopefully recognized: .Sp \&\- album name/artist name \- song name.mp3 .Sp \&\- album_name/artist_name\-song_name.mp3 .Sp \&\- album.name/artist.name_song.name.mp3 .Sp \&\- album name/(artist name) song name.mp3 .Sp \&\- album name/01. artist name \- song name.mp3 .Sp \&\- album name/artist name \- 01 \- song.name.mp3 .Sp If artist or title end in \f(CW\*(C`(NUMBER)\*(C'\fR with 4\-digit \s-1NUMBER\s0, it is considered the year. .IP "\fItitle()\fR" 4 .IX Item "title()" .Vb 1 \& $title = $mp3\->title($filename); .Ve .Sp Returns the title, guessed from the filename. See also \fIparse_filename()\fR. (For backward compatibility, can be called by deprecated name \fIsong()\fR.) .Sp \&\f(CW$filename\fR is optional and will be used instead of the real filename if defined. .IP "\fIartist()\fR" 4 .IX Item "artist()" .Vb 1 \& $artist = $mp3\->artist($filename); .Ve .Sp Returns the artist name, guessed from the filename. See also \fIparse_filename()\fR .Sp \&\f(CW$filename\fR is optional and will be used instead of the real filename if defined. .IP "\fItrack()\fR" 4 .IX Item "track()" .Vb 1 \& $track = $mp3\->track($filename); .Ve .Sp Returns the track number, guessed from the filename. See also \fIparse_filename()\fR .Sp \&\f(CW$filename\fR is optional and will be used instead of the real filename if defined. .IP "\fIyear()\fR" 4 .IX Item "year()" .Vb 1 \& $year = $mp3\->year($filename); .Ve .Sp Returns the year, guessed from the filename. See also \fIparse_filename()\fR .Sp \&\f(CW$filename\fR is optional and will be used instead of the real filename if defined. .IP "\fIalbum()\fR" 4 .IX Item "album()" .Vb 1 \& $album = $mp3\->album($filename); .Ve .Sp Returns the album name, guessed from the filename. See also \fIparse_filename()\fR The album name is guessed from the parent directory, so it is very likely to fail. .Sp \&\f(CW$filename\fR is optional and will be used instead of the real filename if defined. .IP "\fIcomment()\fR" 4 .IX Item "comment()" .Vb 1 \& $comment = $mp3\->comment($filename); # Always undef .Ve .IP "\fIgenre()\fR" 4 .IX Item "genre()" .Vb 1 \& $genre = $mp3\->genre($filename); # Always undef .Ve