package org.farng.mp3.lyrics3;
import org.farng.mp3.InvalidTagException;
import org.farng.mp3.TagConstant;
import org.farng.mp3.TagOptionSingleton;
import org.farng.mp3.id3.FrameBodySYLT;
import org.farng.mp3.id3.FrameBodyUSLT;
import org.farng.mp3.object.AbstractMP3Object;
import org.farng.mp3.object.ObjectID3v2LyricLine;
import org.farng.mp3.object.ObjectLyrics3Line;
import org.farng.mp3.object.ObjectLyrics3TimeStamp;
import java.io.RandomAccessFile;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
/**
* Lyrics multi line text. Timestamps can be used anywhere in the text in any order. Timestamp format is [mm:ss] (no
* spaces allowed in the timestamps).
*
* @author Eric Farng
* @version $Revision: 1.6 $
*/
public class FieldBodyLYR extends AbstractLyrics3v2FieldBody {
private ArrayList<AbstractMP3Object> lines = new ArrayList<AbstractMP3Object>();
/**
* Creates a new FieldBodyLYR object.
*/
public FieldBodyLYR() {
super();
}
/**
* Creates a new FieldBodyLYR object.
*/
public FieldBodyLYR(final FieldBodyLYR copyObject) {
super(copyObject);
ObjectLyrics3Line oldObject;
for (int i = 0; i < copyObject.lines.size(); i++) {
oldObject = (ObjectLyrics3Line) copyObject.lines.get(i);
AbstractMP3Object newObject = new ObjectLyrics3Line(oldObject);
this.lines.add(newObject);
// appendToObjectList(newObject);
}
}
/**
* Creates a new FieldBodyLYR object.
*/
public FieldBodyLYR(final String line) {
readString(line);
}
/**
* Creates a new FieldBodyLYR object.
*/
public FieldBodyLYR(final FrameBodySYLT sync) {
addLyric(sync);
}
/**
* Creates a new FieldBodyLYR object.
*/
public FieldBodyLYR(final FrameBodyUSLT unsync) {
addLyric(unsync);
}
/**
* Creates a new FieldBodyLYR object.
*/
public FieldBodyLYR(final RandomAccessFile file) throws InvalidTagException, java.io.IOException {
this.read(file);
}
public String getIdentifier() {
return "LYR";
}
public void setLyric(final String str) {
readString(str);
}
public String getLyric() {
return writeString();
}
public int getSize() {
int size = 0;
ObjectLyrics3Line line;
for (int i = 0; i < this.lines.size(); i++) {
line = (ObjectLyrics3Line) this.lines.get(i);
size += (line.getSize() + 2);
}
return size;
}
public boolean isSubsetOf(final Object object) {
if ((object instanceof FieldBodyLYR) == false) {
return false;
}
final ArrayList<AbstractMP3Object> superset = ((FieldBodyLYR) object).lines;
for (int i = 0; i < this.lines.size(); i++) {
if (superset.contains(this.lines.get(i)) == false) {
return false;
}
}
return super.isSubsetOf(object);
}
public void addLyric(final FrameBodySYLT sync) {
// SYLT frames are made of individual lines
final Iterator<?> iterator = sync.iterator();
ObjectLyrics3Line newLine;
ObjectID3v2LyricLine currentLine;
ObjectLyrics3TimeStamp timeStamp;
final HashMap<String, ObjectLyrics3Line> lineMap = new HashMap<String, ObjectLyrics3Line>();
while (iterator.hasNext()) {
currentLine = (ObjectID3v2LyricLine) iterator.next();
// create copy to use in new tag
currentLine = new ObjectID3v2LyricLine(currentLine);
timeStamp = new ObjectLyrics3TimeStamp("Time Stamp");
timeStamp.setTimeStamp(currentLine.getTimeStamp(), sync.getTimeStampFormat());
if (lineMap.containsKey(currentLine.getText())) {
newLine = (ObjectLyrics3Line) lineMap.get(currentLine.getText());
newLine.addTimeStamp(timeStamp);
} else {
newLine = new ObjectLyrics3Line("Lyric Line");
newLine.setLyric(currentLine);
newLine.setTimeStamp(timeStamp);
lineMap.put(currentLine.getText(), newLine);
this.lines.add(newLine);
// appendToObjectList(newLine);
}
}
}
public void addLyric(final FrameBodyUSLT unsync) {
// USLT frames are just long text string;
final ObjectLyrics3Line line = new ObjectLyrics3Line("Lyric Line");
line.setLyric(new String(unsync.getLyric()));
this.lines.add(line);
appendToObjectList(line);
}
public boolean equals(final Object obj) {
if ((obj instanceof FieldBodyLYR) == false) {
return false;
}
final FieldBodyLYR fieldBodyLYR = (FieldBodyLYR) obj;
if (this.lines.equals(fieldBodyLYR.lines) == false) {
return false;
}
// return true;
// we dont' want to call super here. super looks for equal object list
// we don't care about object lists for LYR field
return super.equals(obj);
}
public boolean hasTimeStamp() {
boolean present = false;
for (int i = 0; i < this.lines.size(); i++) {
if (((ObjectLyrics3Line) this.lines.get(i)).hasTimeStamp()) {
present = true;
}
}
return present;
}
public Iterator<AbstractMP3Object> iterator() {
return this.lines.iterator();
}
protected void setupObjectList() {
// throw new UnsupportedOperationException();
}
public void read(final RandomAccessFile file) throws InvalidTagException, java.io.IOException {
final String lineString;
byte[] buffer = new byte[5];
// read the 5 character size
file.read(buffer, 0, 5);
final int size = Integer.parseInt(new String(buffer, 0, 5));
if ((size == 0) && (TagOptionSingleton.getInstance().isLyrics3KeepEmptyFieldIfRead() == false)) {
throw new InvalidTagException("Lyircs3v2 Field has size of zero.");
}
buffer = new byte[size];
// read the SIZE length description
file.read(buffer);
lineString = new String(buffer);
readString(lineString);
}
public String toString() {
String str = getIdentifier() + " : ";
for (int i = 0; i < this.lines.size(); i++) {
str += this.lines.get(i).toString();
}
return str;
}
public void write(final RandomAccessFile file) throws java.io.IOException {
final int size;
int offset = 0;
byte[] buffer = new byte[5];
String str;
size = getSize();
str = Integer.toString(size);
for (int i = 0; i < (5 - str.length()); i++) {
buffer[i] = (byte) '0';
}
offset += (5 - str.length());
for (int i = 0; i < str.length(); i++) {
buffer[i + offset] = (byte) str.charAt(i);
}
offset += str.length();
file.write(buffer, 0, 5);
if (size > 0) {
str = writeString();
buffer = new byte[str.length()];
for (int i = 0; i < str.length(); i++) {
buffer[i] = (byte) str.charAt(i);
}
file.write(buffer);
}
}
private void readString(final String lineString) {
// now readString each line and put in the vector;
String token;
int offset = 0;
int delim = lineString.indexOf(TagConstant.SEPERATOR_LINE);
this.lines = new ArrayList<AbstractMP3Object>();
ObjectLyrics3Line line;
while (delim >= 0) {
token = lineString.substring(offset, delim);
line = new ObjectLyrics3Line("Lyric Line");
line.setLyric(token);
this.lines.add(line);
appendToObjectList(line);
offset = delim + TagConstant.SEPERATOR_LINE.length();
delim = lineString.indexOf(TagConstant.SEPERATOR_LINE, offset);
}
if (offset < lineString.length()) {
token = lineString.substring(offset);
line = new ObjectLyrics3Line("Lyric Line");
line.setLyric(token);
this.lines.add(line);
appendToObjectList(line);
}
}
private String writeString() {
ObjectLyrics3Line line;
String str = "";
for (int i = 0; i < this.lines.size(); i++) {
line = (ObjectLyrics3Line) this.lines.get(i);
str += (line.writeString() + TagConstant.SEPERATOR_LINE);
}
return str;
}
}