---
name: "mp3report"
section: "1"
platform: "linux"
package: "mp3report"
version: "1.0.3-2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/mp3report"
---

# mp3report(1)

Neon Goat MP3 Report Generator

## NAME

mp3report - Neon Goat MP3 Report Generator

## DESCRIPTION

```
 A customizable program to scan a list of (sub)directories, creating a report
 from an HTML template. Also calculates various statistics and each song's
 playing time. Supports ID3 and ID3v2 tags. Should work on any perl-ized OS;
 see homepage for demo - http://mp3report.sourceforge.net
```

## CONFIGURING

```
 All options can be configured through the command line, see mp3report --help
 for more info. You may also want to modify the hard coded defaults at the
 top of the program file.
 See documentation.html for information on customizing your own template file.
```

## USAGE

```
 Usage: mp3report [options] [directory...]
  --help                 shows this help screen
  --printmode            uses a smaller font for printing
  --title=TITLE          sets the title used in the report
  --outfile=OUTFILE      file to write report to, '-' for STDOUT
  --template=FILE        file to use as report template
  --stdgenres            use standard genres instead of winamp genres
  --id3v2                enable id3v2 support (experimental)
  directory...           dirs to scan (subdirs included)
```

## INSTALLATION

```
 You should be able to run mp3report directly after decompressing it:

 tar xfzv mp3report-1.0.2.tar.gz
 cd mp3report-1.0.2
 ./mp3report.pl --help

 If your perl interpreter isn't in /usr/bin/perl, you'll need to change the first line
 of mp3report.pl

 If you'd like to install the MP3::Info perl module so that other programs can
 use it, it is available at http://search.cpan.org/search?dist=MP3-Info.
```

## CUSTOMIZATION AND TEMPLATES

By creating your own HTML file or modifying one of the provided templates, you can customize the output of MP3 Report Generator. These are the various identifiers that MP3 Report Generator can look for in a report:

### General Information

- $t\_fontsize

  This is either 1 or 2, depending on the `"--printmode"` flag. If printing mode is on, the idea is that the font size should be a little bit smaller so that it looks better on paper. To make sure this field does something, use `"<FONT SIZE="$t_fontsize""`\> in your HTML code.

- $t\_title

  Used for the HTML `"<TITLE"`\> tag as well as the first line of the report, and is set by specifying `"--title=SOMETHING"` on the command line.

- $t\_datetime

  The local date and time when the report was generated.

- $t\_dirs

  The list of parent directories that was scanned in the report. Each directory is separated by `"<BR&gt;&amp;nbsp;&amp;nbsp;"` so that they are on separate lines and indented.

- $t\_numdirs

  The total number of directories and subdirectories scanned in the report.

- $t\_numfiles

  The total number of MP3 files included in the report.

- $t\_size

  The total size of all MP3 files included in the report combined. This is formatted into "x.xx GB (y.yy MB)".

- $t\_playtime

  The total playing time of all songs combined. This is formatted into an English sentence (4 days, 3 hours, 2 minutes, 1 second).

- $t\_exectime

  The total time it took to generate the report. This is formatted into an English sentence (4 days, 3 hours, 2 minutes, 1 second).

- $t\_avgsize

  The average size of the MP3s in this report. This is formatted into "x.xx MB".

- $t\_avgplaytime

  The average playing time of a single song in the report. This is formatted into an English sentence (3 hours, 2 minutes, 1 second).

### Report Settings

- $t\_filename

  The filename that the report is being written to.

- $t\_template\_filename

  The filename of the template that is being used.

- $t\_printmode

  Either "Yes" or "No" depending on whether the `"--printmode"` flag was specified.

- $t\_customdirs

  Either "Yes" or "No" depending on whether user specified custom directories to scan on the command line.

- $t\_genretype

  Either "Standard" or "WinAMP" depending on whether or not the user specified `"--stdgenres"`.

- $t\_id3v2

  Either "Yes" or "No" depending on whether the `"--id3v2"` flag was specified.

### Item Information

- $item\_dir

  The current directory that is being scanned.

- $item\_num

  The current sequential number of the item found.

- $item\_filename

  The filename of the item found. NOTE: This in versions older than 1.0.2, this variable was called `$item_name`.

- $item\_size

  The size of the item found. This is formatted into "x.xx MB".

- $item\_bgcolor

  This will either be `"#FFFFFF"` or `"#EEEEEE"` (white or light gray) depending on whether or not the current item number is even or odd. This is used to make the cell color in tables alternate to make the report easier to read. In order for this to work, your HTML code must look something like `"<TD BGCOLOR="$item_bgcolor">""...</TD>"`.

- $item\_len

  The playing time of the song found, formatted into "XX:YY" (minutes:seconds).

### MP3 Information

- $item\_totalseconds

  The total number of seconds in the current song.

- $item\_mp3version

  The MPEG version number of the current MP3, usually 1.

- $item\_stereo

  Either "Stereo" or "Mono" depending on the number of channels in the MP3.

- $item\_mpeglayer

  The MPEG layer number, usually 3.

- $item\_bitrate

  The bitrate of the current MP3 in kbps.

- $item\_vbr

  If the current MP3 is encoded at a variable bitrate, this will equal "VBR". If not, it will be a blank string.

- $item\_copyrighted

  Either "Copyrighted" or "Not copyrighted" depending on the MP3's copyright flag.

- $item\_frequency

  The frequency of the current MP3 in kHz.

### ID3 Tag Information

- $item\_id3title

  The song's ID3 title, maximum 30 characters.

- $item\_id3artist

  The song's ID3 artist, maximum 30 characters.

- $item\_id3album

  The song's ID3 album, maximum 30 characters.

- $item\_id3year

  The song's ID3 year, maximum 4 characters.

- $item\_id3comment

  The song's ID3 comment, maximum 30 characters (28 if the ID3 tag also contains a track number).

- $item\_id3genre

  The song's ID3 genre. You may disable WinAMP genres by specifying the `"--stdgenres"` flag.

- $item\_id3tracknum

  The song's ID3v1.1 track number (if present), maximum 2 characters.

### ID3v2 Tag Information

ID3v2.3.0 (or later) tags are also supported. To enable ID3v2 support, use the `"--id3v2"` flag on the command line. The following is taken from `"MPEG::MP3Info::v2_tag_names"`

- $item\_id3v2\_wpay

  WPAY: Payment

- $item\_id3v2\_text

  TEXT: Lyricist/Text writer

- $item\_id3v2\_toly

  TOLY: Original lyricist(s)/text writer(s)

- $item\_id3v2\_tmed

  TMED: Media type

- $item\_id3v2\_rvad

  RVAD: Relative volume adjustment

- $item\_id3v2\_time

  TIME: Time

- $item\_id3v2\_rbuf

  RBUF: Recommended buffer size

- $item\_id3v2\_toal

  TOAL: Original album/movie/show title

- $item\_id3v2\_trck

  TRCK: Track number/Position in set

- $item\_id3v2\_ipls

  IPLS: Involved people list

- $item\_id3v2\_mllt

  MLLT: MPEG location lookup table

- $item\_id3v2\_tkey

  TKEY: Initial key

- $item\_id3v2\_apic

  APIC: Attached picture

- $item\_id3v2\_sytc

  SYTC: Synchronized tempo codes

- $item\_id3v2\_tyer

  TYER: Year

- $item\_id3v2\_tpos

  TPOS: Part of a set

- $item\_id3v2\_trsn

  TRSN: Internet radio station name

- $item\_id3v2\_ufid

  UFID: Unique file identifier

- $item\_id3v2\_trso

  TRSO: Internet radio station owner

- $item\_id3v2\_tsiz

  TSIZ: Size

- $item\_id3v2\_tenc

  TENC: Encoded by

- $item\_id3v2\_trda

  TRDA: Recording dates

- $item\_id3v2\_comm

  COMM: Comments

- $item\_id3v2\_sylt

  SYLT: Synchronized lyric/text

- $item\_id3v2\_woaf

  WOAF: Official audio file webpage

- $item\_id3v2\_link

  LINK: Linked information

- $item\_id3v2\_comr

  COMR: Commercial frame

- $item\_id3v2\_tbpm

  TBPM: BPM (beats per minute)

- $item\_id3v2\_pcnt

  PCNT: Play counter

- $item\_id3v2\_tofn

  TOFN: Original filename

- $item\_id3v2\_woar

  WOAR: Official artist/performer webpage

- $item\_id3v2\_woas

  WOAS: Official audio source webpage

- $item\_id3v2\_tpe1

  TPE1: Lead performer(s)/Soloist(s)

- $item\_id3v2\_tflt

  TFLT: File type

- $item\_id3v2\_tpe2

  TPE2: Band/orchestra/accompaniment

- $item\_id3v2\_tsrc

  TSRC: ISRC (international standard recording code)

- $item\_id3v2\_tpe3

  TPE3: Conductor/performer refinement

- $item\_id3v2\_rvrb

  RVRB: Reverb

- $item\_id3v2\_tpe4

  TPE4: Interpreted, remixed, or otherwise modified by

- $item\_id3v2\_mcdi

  MCDI: Music CD identifier

- $item\_id3v2\_tdly

  TDLY: Playlist delay

- $item\_id3v2\_tdat

  TDAT: Date

- $item\_id3v2\_tory

  TORY: Original release year

- $item\_id3v2\_tlan

  TLAN: Language(s)

- $item\_id3v2\_tcom

  TCOM: Composer

- $item\_id3v2\_tlen

  TLEN: Length

- $item\_id3v2\_tcon

  TCON: Content type

- $item\_id3v2\_tcop

  TCOP: Copyright message

- $item\_id3v2\_owne

  OWNE: Ownership frame

- $item\_id3v2\_tpub

  TPUB: Publisher

- $item\_id3v2\_txxx

  TXXX: User defined text information frame

- $item\_id3v2\_geob

  GEOB: General encapsulated object

- $item\_id3v2\_tsse

  TSSE: Software/Hardware and settings used for encoding

- $item\_id3v2\_priv

  PRIV: Private frame

- $item\_id3v2\_tit1

  TIT1: Content group description

- $item\_id3v2\_talb

  TALB: Album/Movie/Show title

- $item\_id3v2\_tit2

  TIT2: Title/songname/content description

- $item\_id3v2\_tit3

  TIT3: Subtitle/Description refinement

- $item\_id3v2\_poss

  POSS: Position synchronisation frame

- $item\_id3v2\_grid

  GRID: Group identification registration

- $item\_id3v2\_uslt

  USLT: Unsychronized lyric/text transcription

- $item\_id3v2\_encr

  ENCR: Encryption method registration

- $item\_id3v2\_town

  TOWN: File owner/licensee

- $item\_id3v2\_wors

  WORS: Official internet radio station homepage

- $item\_id3v2\_etco

  ETCO: Event timing codes

- $item\_id3v2\_equa

  EQUA: Equalization

- $item\_id3v2\_wcom

  WCOM: Commercial information

- $item\_id3v2\_aenc

  AENC: Audio encryption

- $item\_id3v2\_tope

  TOPE: Original artist(s)/performer(s)

- $item\_id3v2\_wcop

  WCOP: Copyright/Legal information

- $item\_id3v2\_popm

  POPM: Popularimeter

- $item\_id3v2\_wpub

  WPUB: Publishers official webpage

- $item\_id3v2\_wxxx

  WXXX: User defined URL link frame

- $item\_id3v2\_user

  USER: Terms of use

## ACKNOWLEDGEMENTS

```
 Much thanks to Chris Nandor and contributors to MP3::Info...
 it saved me a lot of time :) And to Larry Wall for such a great language.

 Hello to MMT, UCLA LUG, cX, and of course the DJs of Mister Balak's Neighborhood!
```

## SEE ALSO

- MP3::Info

  http://search.cpan.org/search?dist=MP3-Info

- ID3v2

  http://www.id3.org/

- SourceForge

  http://www.sourceforge.net Damn, these guys rock.

- icecast

  http://www.icecast.org

## AUTHOR AND COPYRIGHT

```
 Neon Goat MP3 Report Generator
 v1.0.2 - April 5, 2000
 Copyright (C) 2000, David Parker, Neon Goat Productions.

 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation; either version 2 of the License, or
 (at your option) any later version.

 See COPYING or http://www.gnu.org for more information.

 David Parker
 david@neongoat.com
 http://www.neongoat.com
 http://mp3report.sourceforge.net
```