/**
* @author : Paul Taylor
* @author : Eric Farng
*
* Version @version:$Id: FrameBodyTIPL.java 1005 2011-09-26 11:47:39Z paultaylor $
*
* MusicTag Copyright (C)2003,2004
*
* This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser
* General Public License as published by the Free Software Foundation; either version 2.1 of the License,
* or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
* the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License along with this library; if not,
* you can get a copy from http://www.opensource.org/licenses/lgpl-license.php or write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Description:
* People List
*
*/
package org.jaudiotagger.tag.id3.framebody;
import org.jaudiotagger.tag.InvalidTagException;
import org.jaudiotagger.tag.datatype.DataTypes;
import org.jaudiotagger.tag.datatype.NumberHashMap;
import org.jaudiotagger.tag.datatype.Pair;
import org.jaudiotagger.tag.datatype.PairedTextEncodedStringNullTerminated;
import org.jaudiotagger.tag.id3.ID3v24Frames;
import org.jaudiotagger.tag.id3.valuepair.TextEncoding;
import java.io.ByteArrayOutputStream;
import java.nio.ByteBuffer;
import java.util.Map;
import java.util.StringTokenizer;
/**
* The 'Involved people list' is intended as a mapping between functions like producer and names. Every odd field is a
* function and every even is an name or a comma delimited list of names.
* <p/>
*/
public class FrameBodyTIPL extends AbstractID3v2FrameBody implements ID3v24FrameBody
{
//Standard function names, taken from Picard Mapping
public static final String ENGINEER = "engineer";
public static final String MIXER = "mix";
public static final String DJMIXER = "DJ-mix";
public static final String PRODUCER = "producer";
public static final String ARRANGER = "arranger";
/**
* Creates a new FrameBodyTIPL datatype.
*/
public FrameBodyTIPL()
{
setObjectValue(DataTypes.OBJ_TEXT_ENCODING, TextEncoding.ISO_8859_1);
}
/**
* Creates a new FrameBodyTIPL data type.
*
* @param textEncoding
* @param text
*/
public FrameBodyTIPL(byte textEncoding, String text)
{
setObjectValue(DataTypes.OBJ_TEXT_ENCODING, textEncoding);
setText(text);
}
/**
* Creates a new FrameBodyTIPL data type.
*
* @param byteBuffer
* @param frameSize
* @throws InvalidTagException
*/
public FrameBodyTIPL(ByteBuffer byteBuffer, int frameSize) throws InvalidTagException
{
super(byteBuffer, frameSize);
}
/**
* Convert from V3 to V4 Frame
*
* @param body
*/
public FrameBodyTIPL(FrameBodyIPLS body)
{
setObjectValue(DataTypes.OBJ_TEXT_ENCODING, body.getTextEncoding());
setObjectValue(DataTypes.OBJ_TEXT, body.getPairing());
}
/**
* The ID3v2 frame identifier
*
* @return the ID3v2 frame identifier for this frame type
*/
public String getIdentifier()
{
return ID3v24Frames.FRAME_ID_INVOLVED_PEOPLE;
}
/**
* Set the text, decoded as pairs of involvee - involvement
*
* @param text
*/
public void setText(String text)
{
PairedTextEncodedStringNullTerminated.ValuePairs value = new PairedTextEncodedStringNullTerminated.ValuePairs();
StringTokenizer stz = new StringTokenizer(text, "\0");
while (stz.hasMoreTokens())
{
String key =stz.nextToken();
if(stz.hasMoreTokens())
{
value.add(key, stz.nextToken());
}
}
setObjectValue(DataTypes.OBJ_TEXT, value);
}
/**
* Parse text as a null separated pairing of name and function
*
* @param text
*/
public void addPair(String text)
{
StringTokenizer stz = new StringTokenizer(text, "\0");
if (stz.countTokens()==2)
{
addPair(stz.nextToken(),stz.nextToken());
}
}
/**
* Add pair
*
* @param function
* @param name
*/
public void addPair(String function,String name)
{
PairedTextEncodedStringNullTerminated.ValuePairs value = ((PairedTextEncodedStringNullTerminated) getObject(DataTypes.OBJ_TEXT)).getValue();
value.add(function, name);
}
/**
* Remove all Pairs
*/
public void resetPairs()
{
PairedTextEncodedStringNullTerminated.ValuePairs value = ((PairedTextEncodedStringNullTerminated) getObject(DataTypes.OBJ_TEXT)).getValue();
value.getMapping().clear();
}
/**
* Because have a text encoding we need to check the data values do not contain characters that cannot be encoded in
* current encoding before we write data. If they do change the encoding.
*/
public void write(ByteArrayOutputStream tagBuffer)
{
if (!((PairedTextEncodedStringNullTerminated) getObject(DataTypes.OBJ_TEXT)).canBeEncoded())
{
this.setTextEncoding(TextEncoding.UTF_16);
}
super.write(tagBuffer);
}
/**
* Consists of a text encoding , and then a series of null terminated Strings, there should be an even number
* of Strings as they are paired as involvement/involvee
*/
protected void setupObjectList()
{
objectList.add(new NumberHashMap(DataTypes.OBJ_TEXT_ENCODING, this, TextEncoding.TEXT_ENCODING_FIELD_SIZE));
objectList.add(new PairedTextEncodedStringNullTerminated(DataTypes.OBJ_TEXT, this));
}
public PairedTextEncodedStringNullTerminated.ValuePairs getPairing()
{
return (PairedTextEncodedStringNullTerminated.ValuePairs) getObject(DataTypes.OBJ_TEXT).getValue();
}
/**
* Get key at index
*
* @param index
* @return value at index
*/
public String getKeyAtIndex(int index)
{
PairedTextEncodedStringNullTerminated text = (PairedTextEncodedStringNullTerminated) getObject(DataTypes.OBJ_TEXT);
return (String) text.getValue().getMapping().get(index).getKey();
}
/**
* Get value at index
*
* @param index
* @return value at index
*/
public String getValueAtIndex(int index)
{
PairedTextEncodedStringNullTerminated text = (PairedTextEncodedStringNullTerminated) getObject(DataTypes.OBJ_TEXT);
return (String) text.getValue().getMapping().get(index).getValue();
}
/**
* @return number of text pairs
*/
public int getNumberOfPairs()
{
PairedTextEncodedStringNullTerminated text = (PairedTextEncodedStringNullTerminated) getObject(DataTypes.OBJ_TEXT);
return text.getValue().getNumberOfPairs();
}
public String getText()
{
PairedTextEncodedStringNullTerminated text = (PairedTextEncodedStringNullTerminated) getObject(DataTypes.OBJ_TEXT);
StringBuilder sb = new StringBuilder();
int count = 1;
for (Pair entry : text.getValue().getMapping())
{
sb.append(entry.getKey() + '\0' + entry.getValue());
if (count != getNumberOfPairs())
{
sb.append('\0');
}
count++;
}
return sb.toString();
}
public String getUserFriendlyValue()
{
return getText();
}
}
|
