de.quippy.javamod.multimedia.mp3.id3

Class ID3v2Tag

java.lang.Object

de.quippy.javamod.multimedia.mp3.id3.ID3v2Tag

public class ID3v2Tag
extends Object

Description: This class reads and writes id3v2 tags from a file.

Constructor Summary

Constructors

Constructor and Description
ID3v2Tag(RandomAccessInputStream raf) Create an id3v2 tag bound to the file provided as a parameter.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getBytes() Return a binary representation of this object to be written to a file.
byte[]	getFrameData(String id) Returns the data found in the frame specified by the id.
String	getFrameDataString(String id) Returns the textual information contained in the frame specified by the id.
int	getPadding() Returns the current number of padding bytes in this id3v2 tag.
int	getSize() Returns the size of this id3v2 tag.
void	removeFrame(String id) Remove the frame with the specified id from the file.
void	removeTag(RandomAccessFile raf) Remove an existing id3v2 tag from the file passed to the constructor.
void	setCommentFrame(String description, String comment) Set the data contained in the comments frame (COMM).
void	setPadding(int pad) Set the amount of padding to use when writing this tag.
void	setTextFrame(String id, String data) Set the data contained in a text frame.
void	setURLFrame(String id, String data) Set the data contained in a URL frame.
void	setUserDefinedTextFrame(String description, String value) Sets the data contained in the user defined text frame (TXXX).
void	setUserDefinedURLFrame(String description, String value) Sets the data contained in the user defined url frame (WXXX).
boolean	tagExists() Returns true if an id3v2 tag exists in the file that was passed to the constructor and false otherwise
String	toString() Return a string representation of this object.
void	updateFrameData(String id, byte[] data) Updates the data for the frame specified by id.
void	writeTag(RandomAccessFile raf) Saves all the information in the tag to the file passed to the constructor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ID3v2Tag

public ID3v2Tag(RandomAccessInputStream raf)
         throws FileNotFoundException,
                IOException,
                ID3v2FormatException

Create an id3v2 tag bound to the file provided as a parameter. If a tag exists in the file already, then all the information in the tag will be extracted. If a tag doesn't exist, then this is the file that will be written to when the writeTag method is called.

Parameters:

mp3 - the file to write/read the the tag information to/from

Throws:

FileNotFoundException - if an error occurs

IOException - if an error occurs

ID3v2FormatException - if an exisiting id3v2 tag isn't correct

Method Detail

writeTag

public void writeTag(RandomAccessFile raf)
              throws FileNotFoundException,
                     IOException

Saves all the information in the tag to the file passed to the constructor. If a tag doesn't exist, a tag is prepended to the file. If the padding has not changed since the creation of this object and the size is less than the original size + the original padding, then the previous tag and part of the previous padding will be overwritten. Otherwise, a new tag will be prepended to the file.

Throws:

FileNotFoundException - if an error occurs

IOException - if an error occurs

removeTag

public void removeTag(RandomAccessFile raf)
               throws FileNotFoundException,
                      IOException

Remove an existing id3v2 tag from the file passed to the constructor.

Throws:

FileNotFoundException - if an error occurs

IOException - if an error occurs

getBytes

public byte[] getBytes()

Return a binary representation of this object to be written to a file. This is in the format of the id3v2 specifications. This includes the header, extended header (if it exists), the frames, padding (if it exists), and a footer (if it exists).

Returns:

a binary representation of this id3v2 tag

setTextFrame

public void setTextFrame(String id,
                String data)

Set the data contained in a text frame. This includes all frames with an id that starts with 'T' but excludes "TXXX". If an improper id is passed, then nothing will happen.

Parameters:

id - the id of the frame to set the data for

data - the data for the frame

setURLFrame

public void setURLFrame(String id,
               String data)

Set the data contained in a URL frame. This includes all frames with an id that starts with 'W' but excludes "WXXX". If an improper id is passed, then nothing will happen.

Parameters:

id - the id of the frame to set the data for

data - the data for the frame

setUserDefinedTextFrame

public void setUserDefinedTextFrame(String description,
                           String value)

Sets the data contained in the user defined text frame (TXXX).

Parameters:

description - a description of the data

value - the data for the frame

setUserDefinedURLFrame

public void setUserDefinedURLFrame(String description,
                          String value)

Sets the data contained in the user defined url frame (WXXX).

Parameters:

description - a description of the url

value - the url for the frame

setCommentFrame

public void setCommentFrame(String description,
                   String comment)

Set the data contained in the comments frame (COMM).

Parameters:

description - a description of the comment

comment - the comment

removeFrame

public void removeFrame(String id)

Remove the frame with the specified id from the file. If there is no frame with that id nothing will happen.

Parameters:

id - the id of the frame to remove

updateFrameData

public void updateFrameData(String id,
                   byte[] data)

Updates the data for the frame specified by id. If no frame exists for the id specified, a new frame with that id is created.

Parameters:

id - the id of the frame to update

data - the data for the frame

getFrameDataString

public String getFrameDataString(String id)

Returns the textual information contained in the frame specified by the id. Not every type of frame has textual information. If an id is specified that will not work, the empty string is returned.

Parameters:

id - the id of the frame to get text from

Returns:

the text information contained in the frame

Throws:

ID3v2FormatException - if an error is encountered parsing data

getFrameData

public byte[] getFrameData(String id)

Returns the data found in the frame specified by the id. If the frame doesn't exist, then a zero length array is returned.

Parameters:

id - the id of the frame to get the data from

Returns:

the data found in the frame

tagExists

public boolean tagExists()

Returns true if an id3v2 tag exists in the file that was passed to the constructor and false otherwise

Returns:

true if an id3v2 tag exists in the file passed to the ctor

getSize

public int getSize()

Returns the size of this id3v2 tag. This includes the header, extended header, frames, padding, and footer.

Returns:

the size (in bytes) of the entire id3v2 tag

getPadding

public int getPadding()

Returns the current number of padding bytes in this id3v2 tag.

Returns:

the current number of padding bytes in this id3v2 tag

setPadding

public void setPadding(int pad)

Set the amount of padding to use when writing this tag. There cannot be any padding if a footer exists. Nothing will happen if this function is called and a footer exists or if the number is negative.

Parameters:

pad - the amount of padding to use when writing this tag

toString

public String toString()

Return a string representation of this object. This includes all data contained in all parts of this tag.

Overrides:

toString in class Object

Returns:

a string representation of this object