code
stringlengths 11
173k
| docstring
stringlengths 2
593k
| func_name
stringlengths 2
189
| language
stringclasses 1
value | repo
stringclasses 844
values | path
stringlengths 11
294
| url
stringlengths 60
339
| license
stringclasses 4
values |
|---|---|---|---|---|---|---|---|
protected String readIdentifier(ByteBuffer byteBuffer) throws PaddingException,InvalidFrameException
{
byte[] buffer = new byte[getFrameIdSize()];
//Read the Frame Identifier
if(getFrameIdSize()<=byteBuffer.remaining())
{
byteBuffer.get(buffer, 0, getFrameIdSize());
}
if(isPadding(buffer))
{
throw new PaddingException(getLoggingFilename() + ":only padding found");
}
if ((getFrameHeaderSize() - getFrameIdSize()) > byteBuffer.remaining())
{
logger.warning(getLoggingFilename() + ":" + "No space to find another frame:");
throw new InvalidFrameException(getLoggingFilename() + ":" + "No space to find another frame");
}
identifier = new String(buffer);
logger.fine(getLoggingFilename() + ":" + "Identifier is" + identifier);
return identifier;
} |
Get the next frame id, throwing an exception if unable to do this and check against just having padded data
@param byteBuffer
@return
@throws PaddingException
@throws InvalidFrameException
| AbstractID3v2Frame::readIdentifier | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Frame.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Frame.java | Apache-2.0 |
public void isBinary(boolean b)
{
//do nothing because whether or not a field is binary is defined by its id and is immutable
} |
@param b
| AbstractID3v2Frame::isBinary | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Frame.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Frame.java | Apache-2.0 |
public byte getOriginalFlags()
{
return originalFlags;
} |
This returns the flags as they were originally read or created
@return
| StatusFlags::getOriginalFlags | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Frame.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Frame.java | Apache-2.0 |
public byte getWriteFlags()
{
return writeFlags;
} |
This returns the flags amended to meet specification
@return
| StatusFlags::getWriteFlags | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Frame.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Frame.java | Apache-2.0 |
public void createStructure()
{
MP3File.getStructureFormatter().openHeadingElement(TYPE_FRAME, getIdentifier());
MP3File.getStructureFormatter().closeHeadingElement(TYPE_FRAME);
} |
Return String Representation of frame
| EncodingFlags::createStructure | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Frame.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Frame.java | Apache-2.0 |
public String getContent()
{
return getBody().getUserFriendlyValue();
} |
Returns the content of the field.
For frames consisting of different fields, this will return the value deemed to be most
likely to be required
@return Content
| EncodingFlags::getContent | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Frame.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Frame.java | Apache-2.0 |
public Charset getEncoding()
{
final byte textEncoding = this.getBody().getTextEncoding();
return TextEncoding.getInstanceOf().getCharsetForId(textEncoding);
} |
Returns the current used charset encoding.
@return Charset encoding.
| EncodingFlags::getEncoding | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Frame.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Frame.java | Apache-2.0 |
public void setContent(String content)
{
throw new UnsupportedOperationException("Not implemented please use the generic tag methods for setting content");
} |
Sets the content of the field.
@param content fields content.
| EncodingFlags::setContent | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Frame.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Frame.java | Apache-2.0 |
public String getContent()
{
StringBuilder sb = new StringBuilder();
for(AbstractID3v2Frame next:frames)
{
sb.append(next.getContent());
}
return sb.toString();
} |
Returns the content of the underlying frames in order.
@return Content
| AggregatedFrame::getContent | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AggregatedFrame.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AggregatedFrame.java | Apache-2.0 |
public Charset getEncoding()
{
final byte textEncoding = frames.iterator().next().getBody().getTextEncoding();
return TextEncoding.getInstanceOf().getCharsetForId(textEncoding);
} |
Returns the current used charset encoding.
@return Charset encoding.
| AggregatedFrame::getEncoding | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AggregatedFrame.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AggregatedFrame.java | Apache-2.0 |
public void setContent(String content)
{
} |
Sets the content of the field.
@param content fields content.
| AggregatedFrame::setContent | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AggregatedFrame.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AggregatedFrame.java | Apache-2.0 |
public void setEncoding(Charset encoding)
{
} |
Sets the charset encoding used by the field.
@param encoding charset.
| AggregatedFrame::setEncoding | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AggregatedFrame.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AggregatedFrame.java | Apache-2.0 |
public int getSize()
{
return TAG_LENGTH;
} |
Return the size of this tag, the size is fixed for tags of this type
@return size of this tag in bytes
| AbstractID3v1Tag::getSize | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v1Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v1Tag.java | Apache-2.0 |
public static boolean seekForV1OrV11Tag(ByteBuffer byteBuffer)
{
byte[] buffer = new byte[FIELD_TAGID_LENGTH];
// read the TAG value
byteBuffer.get(buffer, 0, FIELD_TAGID_LENGTH);
return (Arrays.equals(buffer, TAG_ID));
} |
Does a v1tag or a v11tag exist
@return whether tag exists within the byteBuffer
| AbstractID3v1Tag::seekForV1OrV11Tag | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v1Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v1Tag.java | Apache-2.0 |
public void delete(RandomAccessFile file) throws IOException
{
//Read into Byte Buffer
logger.config("Deleting ID3v1 from file if exists");
FileChannel fc;
ByteBuffer byteBuffer;
fc = file.getChannel();
if(file.length() < TAG_LENGTH)
{
throw new IOException("File not not appear large enough to contain a tag");
}
fc.position(file.length() - TAG_LENGTH);
byteBuffer = ByteBuffer.allocate(TAG_LENGTH);
fc.read(byteBuffer);
byteBuffer.rewind();
if (AbstractID3v1Tag.seekForV1OrV11Tag(byteBuffer))
{
try
{
logger.config("Deleted ID3v1 tag");
file.setLength(file.length() - TAG_LENGTH);
}
catch(IOException ex)
{
logger.severe("Unable to delete existing ID3v1 Tag:"+ex.getMessage());
}
}
else
{
logger.config("Unable to find ID3v1 tag to deleteField");
}
} |
Delete tag from file
Looks for tag and if found lops it off the file.
@param file to delete the tag from
@throws IOException if there was a problem accessing the file
| AbstractID3v1Tag::delete | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v1Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v1Tag.java | Apache-2.0 |
ID3v22FieldKey(String frameId, Id3FieldType fieldType)
{
this.frameId = frameId;
this.fieldType = fieldType;
this.fieldName = frameId;
} |
For usual metadata fields that use a data field
@param frameId the frame that will be used
@param fieldType of data atom
| ID3v22FieldKey::ID3v22FieldKey | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/ID3v22FieldKey.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/ID3v22FieldKey.java | Apache-2.0 |
ID3v22FieldKey(String frameId, String subId, Id3FieldType fieldType)
{
this.frameId = frameId;
this.subId = subId;
this.fieldType = fieldType;
this.fieldName = frameId + ":" + subId;
} |
@param frameId the frame that will be used
@param subId the additioanl key required within the frame to uniquely identify this key
@param fieldType
| ID3v22FieldKey::ID3v22FieldKey | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/ID3v22FieldKey.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/ID3v22FieldKey.java | Apache-2.0 |
public Id3FieldType getFieldType()
{
return fieldType;
} |
@return fieldtype
| ID3v22FieldKey::getFieldType | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/ID3v22FieldKey.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/ID3v22FieldKey.java | Apache-2.0 |
public String getFrameId()
{
return frameId;
} |
This is the frame identifier used to write the field
@return
| ID3v22FieldKey::getFrameId | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/ID3v22FieldKey.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/ID3v22FieldKey.java | Apache-2.0 |
public String getSubId()
{
return subId;
} |
This is the subfield used within the frame for this type of field
@return subId
| ID3v22FieldKey::getSubId | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/ID3v22FieldKey.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/ID3v22FieldKey.java | Apache-2.0 |
public String getFieldName()
{
return fieldName;
} |
This is the value of the key that can uniquely identifer a key type
@return
| ID3v22FieldKey::getFieldName | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/ID3v22FieldKey.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/ID3v22FieldKey.java | Apache-2.0 |
private static boolean isID3V2Header(RandomAccessFile raf) throws IOException
{
long start = raf.getFilePointer();
byte[] tagIdentifier = new byte[FIELD_TAGID_LENGTH];
raf.read(tagIdentifier);
raf.seek(start);
return Arrays.equals(tagIdentifier, TAG_ID);
} |
True if files has a ID3v2 header
@param raf
@return
@throws IOException
| AbstractID3v2Tag::isID3V2Header | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public static boolean isId3Tag(RandomAccessFile raf) throws IOException
{
if (!isID3V2Header(raf))
{
return false;
}
//So we have a tag
byte[] tagHeader = new byte[FIELD_TAG_SIZE_LENGTH];
raf.seek(raf.getFilePointer() + FIELD_TAGID_LENGTH + FIELD_TAG_MAJOR_VERSION_LENGTH + FIELD_TAG_MINOR_VERSION_LENGTH + FIELD_TAG_FLAG_LENGTH);
raf.read(tagHeader);
ByteBuffer bb = ByteBuffer.wrap(tagHeader);
int size = ID3SyncSafeInteger.bufferToValue(bb);
raf.seek(size + TAG_HEADER_LENGTH);
return true;
} |
Determines if file contain an id3 tag and if so positions the file pointer just after the end
of the tag.
<p/>
This method is used by non mp3s (such as .ogg and .flac) to determine if they contain an id3 tag
@param raf
@return
@throws IOException
| AbstractID3v2Tag::isId3Tag | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public static boolean isId3Tag(FileChannel fc) throws IOException
{
if (!isID3V2Header(fc))
{
return false;
}
//So we have a tag
ByteBuffer bb = ByteBuffer.allocateDirect(FIELD_TAG_SIZE_LENGTH);
fc.position(fc.position() + FIELD_TAGID_LENGTH + FIELD_TAG_MAJOR_VERSION_LENGTH + FIELD_TAG_MINOR_VERSION_LENGTH + FIELD_TAG_FLAG_LENGTH);
fc.read(bb);
bb.flip();
int size = ID3SyncSafeInteger.bufferToValue(bb);
fc.position(size + TAG_HEADER_LENGTH);
return true;
} |
Is ID3 tag
@param fc
@return
@throws IOException
| AbstractID3v2Tag::isId3Tag | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public AbstractID3v2Tag()
{
} |
Empty Constructor
| AbstractID3v2Tag::AbstractID3v2Tag | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
protected AbstractID3v2Tag(AbstractID3v2Tag copyObject)
{
} |
This constructor is used when a tag is created as a duplicate of another
tag of the same type and version.
@param copyObject
| AbstractID3v2Tag::AbstractID3v2Tag | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
protected void copyPrimitives(AbstractID3v2Tag copyObject)
{
logger.config("Copying Primitives");
//Primitives type variables common to all IDv2 Tags
this.duplicateFrameId = copyObject.duplicateFrameId;
this.duplicateBytes = copyObject.duplicateBytes;
this.emptyFrameBytes = copyObject.emptyFrameBytes;
this.fileReadSize = copyObject.fileReadSize;
this.invalidFrames = copyObject.invalidFrames;
} |
Copy primitives apply to all tags
@param copyObject
| AbstractID3v2Tag::copyPrimitives | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public int getDuplicateBytes()
{
return duplicateBytes;
} |
Returns the number of bytes which come from duplicate frames
@return the number of bytes which come from duplicate frames
| AbstractID3v2Tag::getDuplicateBytes | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public String getDuplicateFrameId()
{
return duplicateFrameId;
} |
Return the string which holds the ids of all
duplicate frames.
@return the string which holds the ids of all duplicate frames.
| AbstractID3v2Tag::getDuplicateFrameId | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public int getEmptyFrameBytes()
{
return emptyFrameBytes;
} |
Returns the number of bytes which come from empty frames
@return the number of bytes which come from empty frames
| AbstractID3v2Tag::getEmptyFrameBytes | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public int getInvalidFrames()
{
return invalidFrames;
} |
Return byte count of invalid frames
@return byte count of invalid frames
| AbstractID3v2Tag::getInvalidFrames | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public int getFileReadBytes()
{
return fileReadSize;
} |
Returns the tag size as reported by the tag header
@return the tag size as reported by the tag header
| AbstractID3v2Tag::getFileReadBytes | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public boolean hasFrame(String identifier)
{
return frameMap.containsKey(identifier);
} |
Return whether tag has frame with this identifier
<p/>
Warning the match is only done against the identifier so if a tag contains a frame with an unsupported body
but happens to have an identifier that is valid for another version of the tag it will return true
@param identifier frameId to lookup
@return true if tag has frame with this identifier
| AbstractID3v2Tag::hasFrame | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public boolean hasFrameAndBody(String identifier)
{
if (hasFrame(identifier))
{
Object o = getFrame(identifier);
if (o instanceof AbstractID3v2Frame)
{
return !(((AbstractID3v2Frame) o).getBody() instanceof FrameBodyUnsupported);
}
return true;
}
return false;
} |
Return whether tag has frame with this identifier and a related body. This is required to protect
against circumstances whereby a tag contains a frame with an unsupported body
but happens to have an identifier that is valid for another version of the tag which it has been converted to
<p/>
e.g TDRC is an invalid frame in a v23 tag but if somehow a v23tag has been created by another application
with a TDRC frame we construct an UnsupportedFrameBody to hold it, then this library constructs a
v24 tag, it will contain a frame with id TDRC but it will not have the expected frame body it is not really a
TDRC frame.
@param identifier frameId to lookup
@return true if tag has frame with this identifier
| AbstractID3v2Tag::hasFrameAndBody | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public boolean hasFrameOfType(String identifier)
{
Iterator<String> iterator = frameMap.keySet().iterator();
String key;
boolean found = false;
while (iterator.hasNext() && !found)
{
key = iterator.next();
if (key.startsWith(identifier))
{
found = true;
}
}
return found;
} |
Return whether tag has frame starting with this identifier
<p/>
Warning the match is only done against the identifier so if a tag contains a frame with an unsupported body
but happens to have an identifier that is valid for another version of the tag it will return true
@param identifier start of frameId to lookup
@return tag has frame starting with this identifier
| AbstractID3v2Tag::hasFrameOfType | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public Object getEncryptedFrame(String identifier)
{
return encryptedFrameMap.get(identifier);
} |
Return any encrypted frames with this identifier
<p/>
<p>For single frames return the frame in this tag with given identifier if it exists, if multiple frames
exist with the same identifier it will return a list containing all the frames with this identifier
@param identifier
@return
| AbstractID3v2Tag::getEncryptedFrame | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public String getFirst(String identifier)
{
AbstractID3v2Frame frame = getFirstField(identifier);
if (frame == null)
{
return "";
}
return getTextValueForFrame(frame);
} |
Retrieve the first value that exists for this identifier
<p/>
If the value is a String it returns that, otherwise returns a summary of the fields information
@param identifier
@return
| AbstractID3v2Tag::getFirst | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
private String getTextValueForFrame(AbstractID3v2Frame frame)
{
return frame.getBody().getUserFriendlyValue();
} |
@param frame
@return
| AbstractID3v2Tag::getTextValueForFrame | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public AbstractID3v2Frame getFirstField(String identifier)
{
Object object = getFrame(identifier);
if (object == null)
{
return null;
}
if (object instanceof List)
{
return ((List<AbstractID3v2Frame>) object).get(0);
}
else
{
return (AbstractID3v2Frame) object;
}
} |
Retrieve the first tag field that exists for this identifier
@param identifier
@return tag field or null if doesn't exist
| AbstractID3v2Tag::getFirstField | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public void mergeNumberTotalFrames(AbstractID3v2Frame newFrame, AbstractID3v2Frame nextFrame)
{
AbstractFrameBodyNumberTotal newBody = (AbstractFrameBodyNumberTotal) newFrame.getBody();
AbstractFrameBodyNumberTotal oldBody = (AbstractFrameBodyNumberTotal) nextFrame.getBody();
if (newBody.getNumber() != null && newBody.getNumber() > 0)
{
oldBody.setNumber(newBody.getNumberAsText());
}
if (newBody.getTotal() != null && newBody.getTotal() > 0)
{
oldBody.setTotal(newBody.getTotalAsText());
}
} |
All Number/Count frames are treated the same (TCK, TPOS, MVNM)
@param newFrame
@param nextFrame
| AbstractID3v2Tag::mergeNumberTotalFrames | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public void mergeDuplicateFrames(AbstractID3v2Frame newFrame, List<AbstractID3v2Frame> frames)
{
for (ListIterator<AbstractID3v2Frame> li = frames.listIterator(); li.hasNext(); )
{
AbstractID3v2Frame nextFrame = li.next();
if (newFrame.getBody() instanceof FrameBodyTXXX)
{
//Value with matching key exists so replace
if (((FrameBodyTXXX) newFrame.getBody()).getDescription().equals(((FrameBodyTXXX) nextFrame.getBody()).getDescription()))
{
li.set(newFrame);
frameMap.put(newFrame.getId(), frames);
return;
}
}
else if (newFrame.getBody() instanceof FrameBodyWXXX)
{
//Value with matching key exists so replace
if (((FrameBodyWXXX) newFrame.getBody()).getDescription().equals(((FrameBodyWXXX) nextFrame.getBody()).getDescription()))
{
li.set(newFrame);
frameMap.put(newFrame.getId(), frames);
return;
}
}
else if (newFrame.getBody() instanceof FrameBodyCOMM)
{
if (((FrameBodyCOMM) newFrame.getBody()).getDescription().equals(((FrameBodyCOMM) nextFrame.getBody()).getDescription()))
{
li.set(newFrame);
frameMap.put(newFrame.getId(), frames);
return;
}
}
else if (newFrame.getBody() instanceof FrameBodyUFID)
{
if (((FrameBodyUFID) newFrame.getBody()).getOwner().equals(((FrameBodyUFID) nextFrame.getBody()).getOwner()))
{
li.set(newFrame);
frameMap.put(newFrame.getId(), frames);
return;
}
}
else if (newFrame.getBody() instanceof FrameBodyUSLT)
{
if (((FrameBodyUSLT) newFrame.getBody()).getDescription().equals(((FrameBodyUSLT) nextFrame.getBody()).getDescription()))
{
li.set(newFrame);
frameMap.put(newFrame.getId(), frames);
return;
}
}
else if (newFrame.getBody() instanceof FrameBodyPOPM)
{
if (((FrameBodyPOPM) newFrame.getBody()).getEmailToUser().equals(((FrameBodyPOPM) nextFrame.getBody()).getEmailToUser()))
{
li.set(newFrame);
frameMap.put(newFrame.getId(), frames);
return;
}
}
//e.g TRCK, TPOS, MVNM
else if (newFrame.getBody() instanceof AbstractFrameBodyNumberTotal)
{
mergeNumberTotalFrames(newFrame,nextFrame);
return;
}
//e.g TIPL IPLS, TMCL
else if (newFrame.getBody() instanceof AbstractFrameBodyPairs frameBody)
{
AbstractFrameBodyPairs existingFrameBody = (AbstractFrameBodyPairs) nextFrame.getBody();
existingFrameBody.addPair(frameBody.getText());
return;
}
}
if (!getID3Frames().isMultipleAllowed(newFrame.getId()))
{
frameMap.put(newFrame.getId(), newFrame);
}
else
{
//No match found so addField new one
frames.add(newFrame);
frameMap.put(newFrame.getId(), frames);
}
} |
Add frame taking into account existing frames of the same type
@param newFrame
@param frames
| AbstractID3v2Tag::mergeDuplicateFrames | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
private void addNewFrameToMap(List<TagField> list, HashMap frameMap, AbstractID3v2Frame existingFrame, AbstractID3v2Frame frame)
{
if (list.size() == 0)
{
list.add(existingFrame);
list.add(frame);
frameMap.put(frame.getId(), list);
}
else
{
list.add(frame);
}
} |
Add another frame to the map
@param list
@param frameMap
@param existingFrame
@param frame
| AbstractID3v2Tag::addNewFrameToMap | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
private void addNewFrameOrAddField(List<TagField> list, HashMap frameMap, AbstractID3v2Frame existingFrame, AbstractID3v2Frame frame)
{
ArrayList<TagField> mergedList = new ArrayList<TagField>();
if (existingFrame != null)
{
mergedList.add(existingFrame);
}
else
{
mergedList.addAll(list);
}
/**
* If the frame is a TXXX frame then we add an extra string to the existing frame
* if same description otherwise we create a new frame
*/
if (frame.getBody() instanceof FrameBodyTXXX frameBody)
{
boolean match = false;
Iterator<TagField> i = mergedList.listIterator();
while (i.hasNext())
{
FrameBodyTXXX existingFrameBody = (FrameBodyTXXX) ((AbstractID3v2Frame) i.next()).getBody();
if (frameBody.getDescription().equals(existingFrameBody.getDescription()))
{
existingFrameBody.addTextValue(frameBody.getText());
match = true;
break;
}
}
if (!match)
{
addNewFrameToMap(list, frameMap, existingFrame, frame);
}
}
else if (frame.getBody() instanceof FrameBodyWXXX frameBody)
{
boolean match = false;
Iterator<TagField> i = mergedList.listIterator();
while (i.hasNext())
{
FrameBodyWXXX existingFrameBody = (FrameBodyWXXX) ((AbstractID3v2Frame) i.next()).getBody();
if (frameBody.getDescription().equals(existingFrameBody.getDescription()))
{
existingFrameBody.addUrlLink(frameBody.getUrlLink());
match = true;
break;
}
}
if (!match)
{
addNewFrameToMap(list, frameMap, existingFrame, frame);
}
}
else if (frame.getBody() instanceof AbstractFrameBodyTextInfo frameBody)
{
AbstractFrameBodyTextInfo existingFrameBody = (AbstractFrameBodyTextInfo) existingFrame.getBody();
existingFrameBody.addTextValue(frameBody.getText());
}
else if (frame.getBody() instanceof AbstractFrameBodyPairs frameBody)
{
AbstractFrameBodyPairs existingFrameBody = (AbstractFrameBodyPairs) existingFrame.getBody();
existingFrameBody.addPair(frameBody.getText());
}
else if (frame.getBody() instanceof AbstractFrameBodyNumberTotal frameBody)
{
AbstractFrameBodyNumberTotal existingFrameBody = (AbstractFrameBodyNumberTotal) existingFrame.getBody();
if (frameBody.getNumber() != null && frameBody.getNumber() > 0)
{
existingFrameBody.setNumber(frameBody.getNumberAsText());
}
if (frameBody.getTotal() != null && frameBody.getTotal() > 0)
{
existingFrameBody.setTotal(frameBody.getTotalAsText());
}
}
else
{
addNewFrameToMap(list, frameMap, existingFrame, frame);
}
} |
Handles adding of a new field that's shares a frame with other fields, so modifies the existing frame rather
than creating a new frame for these special cases
@param list
@param frameMap
@param existingFrame
@param frame
| AbstractID3v2Tag::addNewFrameOrAddField | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public void setField(TagField field) throws FieldDataInvalidException
{
if ((!(field instanceof AbstractID3v2Frame)) && (!(field instanceof AggregatedFrame)))
{
throw new FieldDataInvalidException("Field " + field + " is not of type AbstractID3v2Frame nor AggregatedFrame");
}
if (field instanceof AbstractID3v2Frame newFrame)
{
Object obj = frameMap.get(field.getId());
//If no frame of this type exist or if multiples are not allowed
if (obj == null)
{
frameMap.put(field.getId(), field);
}
//frame of this type already exists
else if (obj instanceof AbstractID3v2Frame)
{
List<AbstractID3v2Frame> frames = new ArrayList<AbstractID3v2Frame>();
frames.add((AbstractID3v2Frame) obj);
mergeDuplicateFrames(newFrame, frames);
}
//Multiple frames of this type already exist
else if (obj instanceof List)
{
mergeDuplicateFrames(newFrame, (List<AbstractID3v2Frame>) obj);
}
}
else
//TODO not handling multiple aggregated frames of same type
{
frameMap.put(field.getId(), field);
}
} |
Set Field
@param field
@throws FieldDataInvalidException
| AbstractID3v2Tag::setField | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public void addField(TagField field) throws FieldDataInvalidException
{
if (field == null)
{
return;
}
if ((!(field instanceof AbstractID3v2Frame)) && (!(field instanceof AggregatedFrame)))
{
throw new FieldDataInvalidException("Field " + field + " is not of type AbstractID3v2Frame or AggregatedFrame");
}
if (field instanceof AbstractID3v2Frame frame)
{
Object o = frameMap.get(field.getId());
//No frame of this type
if (o == null)
{
frameMap.put(field.getId(), field);
}
//There are already frames of this type, adding another may need to merge
else if (o instanceof List)
{
List<TagField> list = (List<TagField>) o;
addNewFrameOrAddField(list, frameMap, null, frame);
}
//One frame exists, we are adding another so may need to convert to list
else
{
AbstractID3v2Frame existingFrame = (AbstractID3v2Frame) o;
List<TagField> list = new ArrayList<TagField>();
addNewFrameOrAddField(list, frameMap, existingFrame, frame);
}
}
else
{
frameMap.put(field.getId(), field);
}
} |
Add new field
<p/>
There is a special handling if adding another text field of the same type, in this case the value will
be appended to the existing field, separated by the null character.
@param field
@throws FieldDataInvalidException
| AbstractID3v2Tag::addField | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public void setFrame(String identifier, List<AbstractID3v2Frame> multiFrame)
{
logger.finest("Adding " + multiFrame.size() + " frames for " + identifier);
frameMap.put(identifier, multiFrame);
} |
Used for setting multiple frames for a single frame Identifier
<p/>
Warning if frame(s) already exists for this identifier they are overwritten
TODO needs to ensure do not add an invalid frame for this tag
@param identifier
@param multiFrame
| AbstractID3v2Tag::setFrame | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public Iterator getFrameOfType(String identifier)
{
Iterator<String> iterator = frameMap.keySet().iterator();
HashSet<Object> result = new HashSet<Object>();
String key;
while (iterator.hasNext())
{
key = iterator.next();
if (key.startsWith(identifier))
{
Object o = frameMap.get(key);
if (o instanceof List)
{
for (Object next : (List) o)
{
result.add(next);
}
}
else
{
result.add(o);
}
}
}
return result.iterator();
} |
Return all frames which start with the identifier, this
can be more than one which is useful if trying to retrieve
similar frames e.g TIT1,TIT2,TIT3 ... and don't know exactly
which ones there are.
<p/>
Warning the match is only done against the identifier so if a tag contains a frame with an unsupported body
but happens to have an identifier that is valid for another version of the tag it will be returned.
@param identifier
@return an iterator of all the frames starting with a particular identifier
| AbstractID3v2Tag::getFrameOfType | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public boolean equals(Object obj)
{
if (!(obj instanceof AbstractID3v2Tag object))
{
return false;
}
return this.frameMap.equals(object.frameMap) && super.equals(obj);
} |
Is this tag equivalent to another
@param obj to test for equivalence
@return true if they are equivalent
| AbstractID3v2Tag::equals | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public Iterator iterator()
{
return frameMap.values().iterator();
} |
Return the frames in the order they were added
@return and iterator of the frmaes/list of multi value frames
| AbstractID3v2Tag::iterator | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public void removeFrame(String identifier)
{
logger.finest("Removing frame with identifier:" + identifier);
frameMap.remove(identifier);
} |
Remove frame(s) with this identifier from tag
@param identifier frameId to look for
| AbstractID3v2Tag::removeFrame | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public void removeUnsupportedFrames()
{
for (Iterator i = iterator(); i.hasNext(); )
{
Object o = i.next();
if (o instanceof AbstractID3v2Frame)
{
if (((AbstractID3v2Frame) o).getBody() instanceof FrameBodyUnsupported)
{
logger.finest("Removing frame" + ((AbstractID3v2Frame) o).getIdentifier());
i.remove();
}
}
}
} |
Remove all frame(s) which have an unsupported body, in other words
remove all frames that are not part of the standard frameSet for
this tag
| AbstractID3v2Tag::removeUnsupportedFrames | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public void removeFrameOfType(String identifier)
{
//First fine matching keys
HashSet<String> result = new HashSet<String>();
for (Object match : frameMap.keySet())
{
String key = (String) match;
if (key.startsWith(identifier))
{
result.add(key);
}
}
//Then deleteField outside of loop to prevent concurrent modificatioon eception if there are two keys
//with the same id
for (String match : result)
{
logger.finest("Removing frame with identifier:" + match + "because starts with:" + identifier);
frameMap.remove(match);
}
} |
Remove any frames starting with this identifier from tag
@param identifier start of frameId to look for
| AbstractID3v2Tag::removeFrameOfType | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
protected FileLock getFileLockForWriting(FileChannel fileChannel, String filePath) throws IOException
{
logger.finest("locking fileChannel for " + filePath);
FileLock fileLock;
try
{
fileLock = fileChannel.tryLock();
}
//Assumes locking is not supported on this platform so just returns null
catch (IOException exception)
{
return null;
}
//#129 Workaround for https://bugs.openjdk.java.net/browse/JDK-8025619
catch (Error error)
{
return null;
}
//Couldnt getFields lock because file is already locked by another application
if (fileLock == null)
{
throw new IOException(ErrorMessage.GENERAL_WRITE_FAILED_FILE_LOCKED.getMsg(filePath));
}
return fileLock;
} |
Get file lock for writing too file
<p/>
TODO:this appears to have little effect on Windows Vista
@param fileChannel
@param filePath
@return lock or null if locking is not supported
@throws IOException if unable to get lock because already locked by another program
@throws java.nio.channels.OverlappingFileLockException if already locked by another thread in the same VM, we dont catch this
because indicates a programming error
| AbstractID3v2Tag::getFileLockForWriting | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public void write(RandomAccessFile file) throws IOException
{
} |
Write tag to file.
@param file
@throws IOException TODO should be abstract
| AbstractID3v2Tag::write | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public void write(WritableByteChannel channel, int currentTagSize) throws IOException
{
} |
Write tag to channel.
@param channel
@throws IOException TODO should be abstract
| AbstractID3v2Tag::write | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public void write(OutputStream outputStream) throws IOException
{
write(Channels.newChannel(outputStream), 0);
} |
Write tag to output stream
@param outputStream
@throws IOException
| AbstractID3v2Tag::write | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public void write(OutputStream outputStream, int currentTagSize) throws IOException
{
write(Channels.newChannel(outputStream), currentTagSize);
} |
Write tag to output stream
@param outputStream
@throws IOException
| AbstractID3v2Tag::write | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
protected void writePadding(WritableByteChannel channel, int padding) throws IOException
{
if (padding > 0)
{
channel.write(ByteBuffer.wrap(new byte[padding]));
}
} |
Write paddings byte to the channel
@param channel
@param padding
@throws IOException
| AbstractID3v2Tag::writePadding | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public static long getV2TagSizeIfExists(File file) throws IOException
{
FileInputStream fis = null;
FileChannel fc = null;
ByteBuffer bb = null;
try
{
//Files
fis = new FileInputStream(file);
fc = fis.getChannel();
//Read possible Tag header Byte Buffer
bb = ByteBuffer.allocate(TAG_HEADER_LENGTH);
fc.read(bb);
bb.flip();
if (bb.limit() < (TAG_HEADER_LENGTH))
{
return 0;
}
}
finally
{
if (fc != null)
{
fc.close();
}
if (fis != null)
{
fis.close();
}
}
//ID3 identifier
byte[] tagIdentifier = new byte[FIELD_TAGID_LENGTH];
bb.get(tagIdentifier, 0, FIELD_TAGID_LENGTH);
if (!(Arrays.equals(tagIdentifier, TAG_ID)))
{
return 0;
}
//Is it valid Major Version
byte majorVersion = bb.get();
if ((majorVersion != ID3v22Tag.MAJOR_VERSION) && (majorVersion != ID3v23Tag.MAJOR_VERSION) && (majorVersion != ID3v24Tag.MAJOR_VERSION))
{
return 0;
}
//Skip Minor Version
bb.get();
//Skip Flags
bb.get();
//Get size as recorded in frame header
int frameSize = ID3SyncSafeInteger.bufferToValue(bb);
//addField header size to frame size
frameSize += TAG_HEADER_LENGTH;
return frameSize;
} |
Checks to see if the file contains an ID3tag and if so return its size as reported in
the tag header and return the size of the tag (including header), if no such tag exists return
zero.
@param file
@return the end of the tag in the file or zero if no tag exists.
@throws java.io.IOException
| AbstractID3v2Tag::getV2TagSizeIfExists | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public boolean seek(ByteBuffer byteBuffer)
{
byteBuffer.rewind();
logger.config("ByteBuffer pos:" + byteBuffer.position() + ":limit" + byteBuffer.limit() + ":cap" + byteBuffer.capacity());
byte[] tagIdentifier = new byte[FIELD_TAGID_LENGTH];
byteBuffer.get(tagIdentifier, 0, FIELD_TAGID_LENGTH);
if (!(Arrays.equals(tagIdentifier, TAG_ID)))
{
return false;
}
//Major Version
if (byteBuffer.get() != getMajorVersion())
{
return false;
}
//Minor Version
return byteBuffer.get() == getRevision();
} |
Does a tag of the correct version exist in this file.
@param byteBuffer to search through
@return true if tag exists.
| AbstractID3v2Tag::seek | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
protected int calculateTagSize(int tagSize, int preferredSize)
{
/** We can fit in the tag so no adjustments required */
if (tagSize <= preferredSize)
{
return preferredSize;
}
/** There is not enough room as we need to move the audio file we might
* as well increase it more than neccessary for future changes
*/
return tagSize + TAG_SIZE_INCREMENT;
} |
This method determines the total tag size taking into account
the preferredSize and the min size required for new tag. For mp3
preferred size is the location of the audio, for other formats
preferred size is the size of the existing tag
@param tagSize
@param preferredSize
@return
| AbstractID3v2Tag::calculateTagSize | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public void adjustPadding(File file, int paddingSize, long audioStart) throws FileNotFoundException, IOException
{
logger.finer("Need to move audio file to accommodate tag");
FileChannel fcIn = null;
FileChannel fcOut;
//Create buffer holds the necessary padding
ByteBuffer paddingBuffer = ByteBuffer.wrap(new byte[paddingSize]);
//Create Temporary File and write channel, make sure it is locked
File paddedFile;
try
{
paddedFile = File.createTempFile(Utils.getBaseFilenameForTempFile(file), ".new", file.getParentFile());
logger.finest("Created temp file:" + paddedFile.getName() + " for " + file.getName());
}
//Vista:Can occur if have Write permission on folder this file would be created in Denied
catch (IOException ioe)
{
logger.log(Level.SEVERE, ioe.getMessage(), ioe);
if (ioe.getMessage().equals(FileSystemMessage.ACCESS_IS_DENIED.getMsg()))
{
logger.severe(ErrorMessage.GENERAL_WRITE_FAILED_TO_CREATE_TEMPORARY_FILE_IN_FOLDER.getMsg(file.getName(), file.getParentFile().getPath()));
throw new UnableToCreateFileException(ErrorMessage.GENERAL_WRITE_FAILED_TO_CREATE_TEMPORARY_FILE_IN_FOLDER.getMsg(file.getName(), file.getParentFile().getPath()));
}
else
{
logger.severe(ErrorMessage.GENERAL_WRITE_FAILED_TO_CREATE_TEMPORARY_FILE_IN_FOLDER.getMsg(file.getName(), file.getParentFile().getPath()));
throw new UnableToCreateFileException(ErrorMessage.GENERAL_WRITE_FAILED_TO_CREATE_TEMPORARY_FILE_IN_FOLDER.getMsg(file.getName(), file.getParentFile().getPath()));
}
}
try
{
fcOut = new FileOutputStream(paddedFile).getChannel();
}
//Vista:Can occur if have special permission Create Folder/Append Data denied
catch (FileNotFoundException ioe)
{
logger.log(Level.SEVERE, ioe.getMessage(), ioe);
logger.severe(ErrorMessage.GENERAL_WRITE_FAILED_TO_MODIFY_TEMPORARY_FILE_IN_FOLDER.getMsg(file.getName(), file.getParentFile().getPath()));
throw new UnableToModifyFileException(ErrorMessage.GENERAL_WRITE_FAILED_TO_MODIFY_TEMPORARY_FILE_IN_FOLDER.getMsg(file.getName(), file.getParentFile().getPath()));
}
try
{
//Create read channel from original file
//TODO lock so cant be modified by anything else whilst reading from it ?
fcIn = new FileInputStream(file).getChannel();
//Write padding to new file (this is where the tag will be written to later)
long written = fcOut.write(paddingBuffer);
//Write rest of file starting from audio
logger.finer("Copying:" + (file.length() - audioStart) + "bytes");
//If the amount to be copied is very large we split into 10MB lumps to try and avoid
//out of memory errors
long audiolength = file.length() - audioStart;
if (audiolength <= MAXIMUM_WRITABLE_CHUNK_SIZE)
{
fcIn.position(audioStart);
long written2 = fcOut.transferFrom(fcIn, paddingSize, audiolength);
logger.finer("Written padding:" + written + " Data:" + written2);
if (written2 != audiolength)
{
throw new RuntimeException(ErrorMessage.MP3_UNABLE_TO_ADJUST_PADDING.getMsg(audiolength, written2));
}
}
else
{
long noOfChunks = audiolength / MAXIMUM_WRITABLE_CHUNK_SIZE;
long lastChunkSize = audiolength % MAXIMUM_WRITABLE_CHUNK_SIZE;
long written2 = 0;
for (int i = 0; i < noOfChunks; i++)
{
written2 += fcIn.transferTo(audioStart + (i * MAXIMUM_WRITABLE_CHUNK_SIZE), MAXIMUM_WRITABLE_CHUNK_SIZE, fcOut);
}
written2 += fcIn.transferTo(audioStart + (noOfChunks * MAXIMUM_WRITABLE_CHUNK_SIZE), lastChunkSize, fcOut);
logger.finer("Written padding:" + written + " Data:" + written2);
if (written2 != audiolength)
{
throw new RuntimeException(ErrorMessage.MP3_UNABLE_TO_ADJUST_PADDING.getMsg(audiolength, written2));
}
}
//Store original modification time
long lastModified = file.lastModified();
//Close Channels and locks
if (fcIn != null)
{
if (fcIn.isOpen())
{
fcIn.close();
}
}
if (fcOut != null)
{
if (fcOut.isOpen())
{
fcOut.close();
}
}
//Replace file with paddedFile
replaceFile(file, paddedFile);
//Update modification time
//TODO is this the right file ?
paddedFile.setLastModified(lastModified);
}
catch (UnableToRenameFileException ure)
{
paddedFile.delete();
throw ure;
}
finally
{
try
{
//Whatever happens ensure all locks and channels are closed/released
if (fcIn != null)
{
if (fcIn.isOpen())
{
fcIn.close();
}
}
if (fcOut != null)
{
if (fcOut.isOpen())
{
fcOut.close();
}
}
}
catch (Exception e)
{
logger.log(Level.WARNING, "Problem closing channels and locks:" + e.getMessage(), e);
}
}
} |
Adjust the length of the padding at the beginning of the MP3 file, this is only called when there is currently
not enough space before the start of the audio to write the tag.
<p/>
A new file will be created with enough size to fit the <code>ID3v2</code> tag.
The old file will be deleted, and the new file renamed.
@param paddingSize This is total size required to store tag before audio
@param audioStart
@param file The file to adjust the padding length of
@throws FileNotFoundException if the file exists but is a directory
rather than a regular file or cannot be opened for any other
reason
@throws IOException on any I/O error
| AbstractID3v2Tag::adjustPadding | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
protected void writeBufferToFile(File file, ByteBuffer headerBuffer, byte[] bodyByteBuffer, int padding, int sizeIncPadding, long audioStartLocation) throws IOException
{
FileChannel fc = null;
FileLock fileLock = null;
//We need to adjust location of audio file if true
if (sizeIncPadding > audioStartLocation)
{
logger.finest("Adjusting Padding");
adjustPadding(file, sizeIncPadding, audioStartLocation);
}
try
{
fc = new RandomAccessFile(file, "rw").getChannel();
fileLock = getFileLockForWriting(fc, file.getPath());
fc.write(headerBuffer);
fc.write(ByteBuffer.wrap(bodyByteBuffer));
fc.write(ByteBuffer.wrap(new byte[padding]));
}
catch (FileNotFoundException fe)
{
logger.log(Level.SEVERE, getLoggingFilename() + fe.getMessage(), fe);
if (fe.getMessage().contains(FileSystemMessage.ACCESS_IS_DENIED.getMsg()) || fe.getMessage().contains(FileSystemMessage.PERMISSION_DENIED.getMsg()))
{
logger.severe(ErrorMessage.GENERAL_WRITE_FAILED_TO_OPEN_FILE_FOR_EDITING.getMsg(file.getPath()));
throw new UnableToModifyFileException(ErrorMessage.GENERAL_WRITE_FAILED_TO_OPEN_FILE_FOR_EDITING.getMsg(file.getPath()));
}
else
{
logger.severe(ErrorMessage.GENERAL_WRITE_FAILED_TO_OPEN_FILE_FOR_EDITING.getMsg(file.getPath()));
throw new UnableToCreateFileException(ErrorMessage.GENERAL_WRITE_FAILED_TO_OPEN_FILE_FOR_EDITING.getMsg(file.getPath()));
}
}
catch (IOException ioe)
{
logger.log(Level.SEVERE, getLoggingFilename() + ioe.getMessage(), ioe);
if (ioe.getMessage().equals(FileSystemMessage.ACCESS_IS_DENIED.getMsg()))
{
logger.severe(ErrorMessage.GENERAL_WRITE_FAILED_TO_OPEN_FILE_FOR_EDITING.getMsg(file.getParentFile().getPath()));
throw new UnableToModifyFileException(ErrorMessage.GENERAL_WRITE_FAILED_TO_OPEN_FILE_FOR_EDITING.getMsg(file.getParentFile().getPath()));
}
else
{
logger.severe(ErrorMessage.GENERAL_WRITE_FAILED_TO_OPEN_FILE_FOR_EDITING.getMsg(file.getParentFile().getPath()));
throw new UnableToCreateFileException(ErrorMessage.GENERAL_WRITE_FAILED_TO_OPEN_FILE_FOR_EDITING.getMsg(file.getParentFile().getPath()));
}
}
finally
{
if (fc != null)
{
if (fileLock != null)
{
fileLock.release();
}
fc.close();
}
}
} |
Write the data from the buffer to the file
@param file
@param headerBuffer
@param bodyByteBuffer
@param padding
@param sizeIncPadding
@param audioStartLocation
@throws IOException
| AbstractID3v2Tag::writeBufferToFile | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
private void replaceFile(File originalFile, File newFile) throws IOException
{
boolean renameOriginalResult;
//Rename Original File to make a backup in case problem with new file
File originalFileBackup = new File(originalFile.getAbsoluteFile().getParentFile().getPath(), AudioFile.getBaseFilename(originalFile) + ".old");
//If already exists modify the suffix
int count = 1;
while (originalFileBackup.exists())
{
originalFileBackup = new File(originalFile.getAbsoluteFile().getParentFile().getPath(), AudioFile.getBaseFilename(originalFile) + ".old" + count);
count++;
}
renameOriginalResult = originalFile.renameTo(originalFileBackup);
if (!renameOriginalResult)
{
logger.warning(ErrorMessage.GENERAL_WRITE_FAILED_TO_RENAME_ORIGINAL_FILE_TO_BACKUP.getMsg(originalFile.getAbsolutePath(), originalFileBackup.getName()));
newFile.delete();
throw new UnableToRenameFileException(ErrorMessage.GENERAL_WRITE_FAILED_TO_RENAME_ORIGINAL_FILE_TO_BACKUP.getMsg(originalFile.getAbsolutePath(), originalFileBackup.getName()));
}
//Rename new Temporary file to the final file
boolean renameResult = newFile.renameTo(originalFile);
if (!renameResult)
{
//Renamed failed so lets do some checks rename the backup back to the original file
//New File doesnt exist
if (!newFile.exists())
{
logger.warning(ErrorMessage.GENERAL_WRITE_FAILED_NEW_FILE_DOESNT_EXIST.getMsg(newFile.getAbsolutePath()));
}
//Rename the backup back to the original
renameOriginalResult = originalFileBackup.renameTo(originalFile);
if (!renameOriginalResult)
{
//TODO now if this happens we are left with testfile.old instead of testfile.mp3
logger.warning(ErrorMessage.GENERAL_WRITE_FAILED_TO_RENAME_ORIGINAL_BACKUP_TO_ORIGINAL.getMsg(originalFileBackup.getAbsolutePath(), originalFile.getName()));
}
logger.warning(ErrorMessage.GENERAL_WRITE_FAILED_TO_RENAME_TO_ORIGINAL_FILE.getMsg(originalFile.getAbsolutePath(), newFile.getName()));
newFile.delete();
throw new UnableToRenameFileException(ErrorMessage.GENERAL_WRITE_FAILED_TO_RENAME_TO_ORIGINAL_FILE.getMsg(originalFile.getAbsolutePath(), newFile.getName()));
}
else
{
//Rename was okay so we can now deleteField the backup of the original
boolean deleteResult = originalFileBackup.delete();
if (!deleteResult)
{
//Not a disaster but can't deleteField the backup so make a warning
logger.warning(ErrorMessage.GENERAL_WRITE_WARNING_UNABLE_TO_DELETE_BACKUP_FILE.getMsg(originalFileBackup.getAbsolutePath()));
}
}
} |
Replace originalFile with the contents of newFile
<p/>
Both files must exist in the same folder so that there are no problems with filesystem mount points
@param newFile
@param originalFile
@throws IOException
| AbstractID3v2Tag::replaceFile | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
protected void processDuplicateFrame(AbstractID3v2Frame newFrame, AbstractID3v2Frame existingFrame)
{
List<AbstractID3v2Frame> list = new ArrayList<AbstractID3v2Frame>();
list.add(existingFrame);
list.add(newFrame);
frameMap.put(newFrame.getIdentifier(), list);
} |
If frame already exists default behaviour is to just add another one, but can be overrridden if
special handling required
@param newFrame
@param existingFrame
| AbstractID3v2Tag::processDuplicateFrame | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
protected final void copyFrameIntoMap(String id, AbstractID3v2Frame newFrame)
{
if (frameMap.containsKey(newFrame.getIdentifier()))
{
Object o = frameMap.get(newFrame.getIdentifier());
if (o instanceof AbstractID3v2Frame)
{
processDuplicateFrame(newFrame, (AbstractID3v2Frame)o);
}
else if (o instanceof AggregatedFrame)
{
logger.severe("Duplicated Aggregate Frame, ignoring:" + id);
}
else if (o instanceof List)
{
List<AbstractID3v2Frame> list = (List) o;
list.add(newFrame);
}
else
{
logger.severe("Unknown frame class:discarding:" + o.getClass());
}
}
else
{
frameMap.put(newFrame.getIdentifier(), newFrame);
}
} |
Copy frame into map, whilst accounting for multiple frame of same type which can occur even if there were
not frames of the same type in the original tag
@param id
@param newFrame
| AbstractID3v2Tag::copyFrameIntoMap | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
protected void loadFrameIntoMap(String frameId, AbstractID3v2Frame next)
{
if (next.getBody() instanceof FrameBodyEncrypted)
{
loadFrameIntoSpecifiedMap(encryptedFrameMap, frameId, next);
}
else
{
loadFrameIntoSpecifiedMap(frameMap, frameId, next);
}
} |
Add frame to the frame map
@param frameId
@param next
| AbstractID3v2Tag::loadFrameIntoMap | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
protected void loadFrameIntoSpecifiedMap(HashMap map, String frameId, AbstractID3v2Frame next)
{
if ((ID3v24Frames.getInstanceOf().isMultipleAllowed(frameId)) ||
(ID3v23Frames.getInstanceOf().isMultipleAllowed(frameId)) ||
(ID3v22Frames.getInstanceOf().isMultipleAllowed(frameId)))
{
//If a frame already exists of this type
if (map.containsKey(frameId))
{
Object o = map.get(frameId);
if (o instanceof ArrayList)
{
ArrayList<AbstractID3v2Frame> multiValues = (ArrayList<AbstractID3v2Frame>) o;
multiValues.add(next);
logger.finer("Adding Multi Frame(1)" + frameId);
}
else
{
ArrayList<AbstractID3v2Frame> multiValues = new ArrayList<AbstractID3v2Frame>();
multiValues.add((AbstractID3v2Frame) o);
multiValues.add(next);
map.put(frameId, multiValues);
logger.finer("Adding Multi Frame(2)" + frameId);
}
}
else
{
logger.finer("Adding Multi FrameList(3)" + frameId);
map.put(frameId, next);
}
}
//If duplicate frame just stores the name of the frame and the number of bytes the frame contains
else if (map.containsKey(frameId))
{
logger.warning("Ignoring Duplicate Frame:" + frameId);
//If we have multiple duplicate frames in a tag separate them with semicolons
if (this.duplicateFrameId.length() > 0)
{
this.duplicateFrameId += ";";
}
this.duplicateFrameId += frameId;
this.duplicateBytes += ((AbstractID3v2Frame) frameMap.get(frameId)).getSize();
}
else
{
logger.finer("Adding Frame" + frameId);
map.put(frameId, next);
}
} |
Decides what to with the frame that has just been read from file.
If the frame is an allowable duplicate frame and is a duplicate we add all
frames into an ArrayList and add the ArrayList to the HashMap. if not allowed
to be duplicate we store the number of bytes in the duplicateBytes variable and discard
the frame itself.
@param frameId
@param next
| AbstractID3v2Tag::loadFrameIntoSpecifiedMap | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public int getSize()
{
int size = 0;
Iterator iterator = frameMap.values().iterator();
AbstractID3v2Frame frame;
while (iterator.hasNext())
{
Object o = iterator.next();
if (o instanceof AbstractID3v2Frame)
{
frame = (AbstractID3v2Frame) o;
size += frame.getSize();
}
else if (o instanceof AggregatedFrame af)
{
for (AbstractID3v2Frame next : af.frames)
{
size += next.getSize();
}
}
else if (o instanceof List)
{
ArrayList<AbstractID3v2Frame> multiFrames = (ArrayList<AbstractID3v2Frame>) o;
for (ListIterator<AbstractID3v2Frame> li = multiFrames.listIterator(); li.hasNext(); )
{
frame = li.next();
size += frame.getSize();
}
}
}
return size;
} |
Return tag size based upon the sizes of the tags rather than the physical
no of bytes between start of ID3Tag and start of Audio Data.Should be extended
by subclasses to include header.
@return size of the tag
| AbstractID3v2Tag::getSize | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
protected ByteArrayOutputStream writeFramesToBuffer() throws IOException
{
ByteArrayOutputStream bodyBuffer = new ByteArrayOutputStream();
writeFramesToBufferStream(frameMap, bodyBuffer);
writeFramesToBufferStream(encryptedFrameMap, bodyBuffer);
return bodyBuffer;
} |
Write all the frames to the byteArrayOutputStream
<p/>
<p>Currently Write all frames, defaults to the order in which they were loaded, newly
created frames will be at end of tag.
@return ByteBuffer Contains all the frames written within the tag ready for writing to file
@throws IOException
| AbstractID3v2Tag::writeFramesToBuffer | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
private void writeFramesToBufferStream(Map map, ByteArrayOutputStream bodyBuffer) throws IOException
{
//Sort keys into Preferred Order
TreeSet<String> sortedWriteOrder = new TreeSet<String>(getPreferredFrameOrderComparator());
sortedWriteOrder.addAll(map.keySet());
AbstractID3v2Frame frame;
for (String id : sortedWriteOrder)
{
Object o = map.get(id);
if (o instanceof AbstractID3v2Frame)
{
frame = (AbstractID3v2Frame) o;
frame.setLoggingFilename(getLoggingFilename());
frame.write(bodyBuffer);
}
else if (o instanceof AggregatedFrame ag)
{
for (AbstractID3v2Frame next : ag.getFrames())
{
next.setLoggingFilename(getLoggingFilename());
next.write(bodyBuffer);
}
}
else
{
List<AbstractID3v2Frame> multiFrames = (List<AbstractID3v2Frame>) o;
for (AbstractID3v2Frame nextFrame : multiFrames)
{
nextFrame.setLoggingFilename(getLoggingFilename());
nextFrame.write(bodyBuffer);
}
}
}
} |
Write frames in map to bodyBuffer
@param map
@param bodyBuffer
@throws IOException
| AbstractID3v2Tag::writeFramesToBufferStream | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public List<String> getAll(FieldKey genericKey) throws KeyNotFoundException
{
//Special case here because the generic key to frameid/subid mapping is identical for trackno versus tracktotal
//and discno versus disctotal so we have to handle here, also want to ignore index parameter.
List<String> values = new ArrayList<String>();
List<TagField> fields = getFields(genericKey);
if (ID3NumberTotalFields.isNumber(genericKey))
{
if (fields != null && fields.size() > 0)
{
AbstractID3v2Frame frame = (AbstractID3v2Frame) fields.get(0);
values.add(((AbstractFrameBodyNumberTotal) frame.getBody()).getNumberAsText());
}
return values;
}
else if (ID3NumberTotalFields.isTotal(genericKey))
{
if (fields != null && fields.size() > 0)
{
AbstractID3v2Frame frame = (AbstractID3v2Frame) fields.get(0);
values.add(((AbstractFrameBodyNumberTotal) frame.getBody()).getTotalAsText());
}
return values;
}
else if(genericKey == FieldKey.RATING)
{
if (fields != null && fields.size() > 0)
{
AbstractID3v2Frame frame = (AbstractID3v2Frame) fields.get(0);
values.add(String.valueOf(((FrameBodyPOPM) frame.getBody()).getRating()));
}
return values;
}
else
{
return this.doGetValues(getFrameAndSubIdFromGenericKey(genericKey));
}
} |
Maps the generic key to the id3 key and return the list of values for this field as strings
@param genericKey
@return
@throws KeyNotFoundException
| AbstractID3v2Tag::getAll | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public List<TagField> getFields(String id) throws KeyNotFoundException
{
Object o = getFrame(id);
if (o == null)
{
return new ArrayList<TagField>();
}
else if (o instanceof List)
{
//TODO should return copy
return (List<TagField>) o;
}
else if (o instanceof AbstractID3v2Frame)
{
List<TagField> list = new ArrayList<TagField>();
list.add((TagField) o);
return list;
}
else
{
throw new RuntimeException("Found entry in frameMap that was not a frame or a list:" + o);
}
} |
Retrieve the values that exists for this id3 frame id
| AbstractID3v2Tag::getFields | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public boolean hasField(FieldKey key)
{
if (key == null)
{
throw new IllegalArgumentException(ErrorMessage.GENERAL_INVALID_NULL_ARGUMENT.getMsg());
}
try
{
return getFirstField(key) != null;
}
catch (KeyNotFoundException knfe)
{
logger.log(Level.SEVERE, knfe.getMessage(), knfe);
return false;
}
} |
Does this tag contain a field with the specified key
@param key The field id to look for.
@return true if has field , false if does not or if no mapping for key exists
| AbstractID3v2Tag::hasField | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public boolean hasField(String id)
{
return hasFrame(id);
} |
Does this tag contain a field with the specified id
@see org.jaudiotagger.tag.Tag#hasField(java.lang.String)
| AbstractID3v2Tag::hasField | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public boolean isEmpty()
{
return frameMap.size() == 0;
} |
Is this tag empty
@see org.jaudiotagger.tag.Tag#isEmpty()
| AbstractID3v2Tag::isEmpty | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public Iterator<TagField> getFields()
{
//Iterator of each different frameId in this tag
final Iterator<Map.Entry<String, Object>> it = this.frameMap.entrySet().iterator();
//Iterator used by hasNext() so doesn't effect next()
final Iterator<Map.Entry<String, Object>> itHasNext = this.frameMap.entrySet().iterator();
return new Iterator<TagField>()
{
Map.Entry<String, Object> latestEntry = null;
//this iterates through frames through for a particular frameId
private Iterator<TagField> fieldsIt;
private void changeIt()
{
if (!it.hasNext())
{
return;
}
while (it.hasNext())
{
Map.Entry<String, Object> e = it.next();
latestEntry = itHasNext.next();
if (e.getValue() instanceof List)
{
List<TagField> l = (List<TagField>) e.getValue();
//If list is empty (which it shouldn't be) we skip over this entry
if (l.size() == 0)
{
continue;
}
else
{
fieldsIt = l.iterator();
break;
}
}
else
{
//TODO must be a better way
List<TagField> l = new ArrayList<TagField>();
l.add((TagField) e.getValue());
fieldsIt = l.iterator();
break;
}
}
}
//TODO assumes if have entry its valid, but what if empty list but very different to check this
//without causing a side effect on next() so leaving for now
public boolean hasNext()
{
//Check Current frameId, does it contain more values
if (fieldsIt != null)
{
if (fieldsIt.hasNext())
{
return true;
}
}
//No remaining entries return false
if (!itHasNext.hasNext())
{
return false;
}
//Issue #236
//TODO assumes if have entry its valid, but what if empty list but very different to check this
//without causing a side effect on next() so leaving for now
return itHasNext.hasNext();
}
public TagField next()
{
//Hasn't been initialized yet
if (fieldsIt == null)
{
changeIt();
}
if (fieldsIt != null)
{
//Go to the end of the run
if (!fieldsIt.hasNext())
{
changeIt();
}
}
if (fieldsIt == null)
{
throw new NoSuchElementException();
}
return fieldsIt.next();
}
public void remove()
{
fieldsIt.remove();
}
};
} |
@return iterator of all fields, multiple values for the same Id (e.g multiple TXXX frames) count as separate
fields
| AbstractID3v2Tag::getFields | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public int getFieldCount()
{
Iterator<TagField> it = getFields();
int count = 0;
//Done this way because it.hasNext() incorrectly counts empty list
//whereas it.next() works correctly
try
{
while (true)
{
TagField next = it.next();
count++;
}
}
catch (NoSuchElementException nse)
{
//this is thrown when no more elements
}
return count;
} |
Count number of frames/fields in this tag
@return
| AbstractID3v2Tag::getFieldCount | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public int getFieldCountIncludingSubValues()
{
Iterator<TagField> it = getFields();
int count = 0;
//Done this way because it.hasNext() incorrectly counts empty list
//whereas it.next() works correctly
try
{
while (true)
{
TagField next = it.next();
if (next instanceof AbstractID3v2Frame frame)
{
if ((frame.getBody() instanceof AbstractFrameBodyTextInfo frameBody) && !(frame.getBody() instanceof FrameBodyTXXX))
{
count += frameBody.getNumberOfValues();
continue;
}
}
count++;
}
}
catch (NoSuchElementException nse)
{
//this is thrown when no more elements
}
return count;
} |
Return count of fields, this considers a text frame with two null separated values as two fields, if you want
a count of frames @see getFrameCount
@return count of fields
| AbstractID3v2Tag::getFieldCountIncludingSubValues | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public String getFirst(FieldKey genericKey) throws KeyNotFoundException
{
return getValue(genericKey, 0);
} |
Retrieve the first value that exists for this generic key
@param genericKey
@return
| AbstractID3v2Tag::getFirst | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public String getValue(FieldKey genericKey, int index) throws KeyNotFoundException
{
if (genericKey == null)
{
throw new KeyNotFoundException();
}
//Special case here because the generic key to frameid/subid mapping is identical for trackno versus tracktotal
//and discno versus disctotal so we have to handle here, also want to ignore index parameter.
if (ID3NumberTotalFields.isNumber(genericKey)||ID3NumberTotalFields.isTotal(genericKey))
{
List<TagField> fields = getFields(genericKey);
if (fields != null && fields.size() > 0)
{
//Should only be one frame so ignore index value, and we ignore multiple values within the frame
//it would make no sense if it existed.
AbstractID3v2Frame frame = (AbstractID3v2Frame) fields.get(0);
if (ID3NumberTotalFields.isNumber(genericKey))
{
return ((AbstractFrameBodyNumberTotal) frame.getBody()).getNumberAsText();
}
else if (ID3NumberTotalFields.isTotal(genericKey))
{
return ((AbstractFrameBodyNumberTotal) frame.getBody()).getTotalAsText();
}
}
else
{
return "";
}
}
//Special Case, TODO may be possible to put into doGetValueAtIndex but getUserFriendlyValue in POPMGFrameBody
//is implemented different to what we would need.
else if (genericKey == FieldKey.RATING)
{
List<TagField> fields = getFields(genericKey);
if (fields != null && fields.size() > index)
{
AbstractID3v2Frame frame = (AbstractID3v2Frame) fields.get(index);
return String.valueOf(((FrameBodyPOPM) frame.getBody()).getRating());
}
else
{
return "";
}
}
FrameAndSubId frameAndSubId = getFrameAndSubIdFromGenericKey(genericKey);
return doGetValueAtIndex(frameAndSubId, index);
} |
Retrieve the value that exists for this generic key and this index
<p/>
Have to do some special mapping for certain generic keys because they share frame
with another generic key.
@param genericKey
@return
| AbstractID3v2Tag::getValue | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public TagField createField(FieldKey genericKey, String... values) throws KeyNotFoundException, FieldDataInvalidException
{
if (genericKey == null)
{
throw new KeyNotFoundException();
}
if (values == null || values[0] == null)
{
throw new IllegalArgumentException(ErrorMessage.GENERAL_INVALID_NULL_ARGUMENT.getMsg());
}
String value = values[0];
FrameAndSubId formatKey = getFrameAndSubIdFromGenericKey(genericKey);
//FrameAndSubId does not contain enough info for these fields to be able to work out what to update
//that is why we need the extra processing here instead of doCreateTagField()
if (ID3NumberTotalFields.isNumber(genericKey))
{
AbstractID3v2Frame frame = createFrame(formatKey.getFrameId());
AbstractFrameBodyNumberTotal framebody = (AbstractFrameBodyNumberTotal) frame.getBody();
framebody.setNumber(value);
return frame;
}
else if (ID3NumberTotalFields.isTotal(genericKey))
{
AbstractID3v2Frame frame = createFrame(formatKey.getFrameId());
AbstractFrameBodyNumberTotal framebody = (AbstractFrameBodyNumberTotal) frame.getBody();
framebody.setTotal(value);
return frame;
}
else
{
return doCreateTagField(formatKey, values);
}
} |
Create a new field
Only MUSICIAN field make use of Varargs values field
@param genericKey is the generic key
@param values
@return
@throws KeyNotFoundException
@throws FieldDataInvalidException
| AbstractID3v2Tag::createField | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
protected TagField doCreateTagField(FrameAndSubId formatKey, String... values) throws KeyNotFoundException, FieldDataInvalidException
{
String value = values[0];
AbstractID3v2Frame frame = createFrame(formatKey.getFrameId());
if (frame.getBody() instanceof FrameBodyUFID)
{
((FrameBodyUFID) frame.getBody()).setOwner(formatKey.getSubId());
((FrameBodyUFID) frame.getBody()).setUniqueIdentifier(value.getBytes(StandardCharsets.ISO_8859_1));
}
else if (frame.getBody() instanceof FrameBodyTXXX)
{
((FrameBodyTXXX) frame.getBody()).setDescription(formatKey.getSubId());
((FrameBodyTXXX) frame.getBody()).setText(value);
}
else if (frame.getBody() instanceof FrameBodyWXXX)
{
((FrameBodyWXXX) frame.getBody()).setDescription(formatKey.getSubId());
((FrameBodyWXXX) frame.getBody()).setUrlLink(value);
}
else if (frame.getBody() instanceof FrameBodyCOMM)
{
//Set description if set
if (formatKey.getSubId() != null)
{
((FrameBodyCOMM) frame.getBody()).setDescription(formatKey.getSubId());
//Special Handling for Media Monkey Compatability
if (((FrameBodyCOMM) frame.getBody()).isMediaMonkeyFrame())
{
((FrameBodyCOMM) frame.getBody()).setLanguage(Languages.MEDIA_MONKEY_ID);
}
}
((FrameBodyCOMM) frame.getBody()).setText(value);
}
else if (frame.getBody() instanceof FrameBodyUSLT)
{
((FrameBodyUSLT) frame.getBody()).setDescription("");
((FrameBodyUSLT) frame.getBody()).setLyric(value);
}
else if (frame.getBody() instanceof FrameBodyWOAR)
{
((FrameBodyWOAR) frame.getBody()).setUrlLink(value);
}
else if (frame.getBody() instanceof AbstractFrameBodyTextInfo)
{
((AbstractFrameBodyTextInfo) frame.getBody()).setText(value);
}
else if (frame.getBody() instanceof FrameBodyPOPM)
{
((FrameBodyPOPM) frame.getBody()).parseString(value);
}
else if (frame.getBody() instanceof FrameBodyIPLS)
{
if (formatKey.getSubId() != null)
{
((FrameBodyIPLS) (frame.getBody())).addPair(formatKey.getSubId(), value);
}
else
{
if(values.length>=2)
{
((FrameBodyIPLS) (frame.getBody())).addPair(values[0], values[1]);
}
else
{
((FrameBodyIPLS) (frame.getBody())).addPair(values[0]);
}
}
}
else if (frame.getBody() instanceof FrameBodyTIPL)
{
((FrameBodyTIPL) (frame.getBody())).addPair(formatKey.getSubId(), value);
}
else if (frame.getBody() instanceof FrameBodyTMCL)
{
if(values.length>=2)
{
((FrameBodyTMCL) (frame.getBody())).addPair(values[0], values[1]);
}
else
{
((FrameBodyTMCL) (frame.getBody())).addPair(values[0]);
}
}
else if ((frame.getBody() instanceof FrameBodyAPIC) || (frame.getBody() instanceof FrameBodyPIC))
{
throw new UnsupportedOperationException(ErrorMessage.ARTWORK_CANNOT_BE_CREATED_WITH_THIS_METHOD.getMsg());
}
else
{
throw new FieldDataInvalidException("Field with key of:" + formatKey.getFrameId() + ":does not accept cannot parse data:" + value);
}
return frame;
} |
Create Frame for Id3 Key
<p/>
Only textual data supported at the moment, should only be used with frames that
support a simple string argument.
@param formatKey
@param values
@return
@throws KeyNotFoundException
@throws FieldDataInvalidException
| AbstractID3v2Tag::doCreateTagField | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
protected List<String> doGetValues(FrameAndSubId formatKey) throws KeyNotFoundException
{
List<String> values = new ArrayList<String>();
if (formatKey.getSubId() != null)
{
//Get list of frames that this uses
List<TagField> list = getFields(formatKey.getFrameId());
ListIterator<TagField> li = list.listIterator();
while (li.hasNext())
{
AbstractTagFrameBody next = ((AbstractID3v2Frame) li.next()).getBody();
if (next instanceof FrameBodyTXXX)
{
if (((FrameBodyTXXX) next).getDescription().equals(formatKey.getSubId()))
{
values.addAll((((FrameBodyTXXX) next).getValues()));
}
}
else if (next instanceof FrameBodyWXXX)
{
if (((FrameBodyWXXX) next).getDescription().equals(formatKey.getSubId()))
{
values.addAll((((FrameBodyWXXX) next).getUrlLinks()));
}
}
else if (next instanceof FrameBodyCOMM)
{
if (((FrameBodyCOMM) next).getDescription().equals(formatKey.getSubId()))
{
values.addAll((((FrameBodyCOMM) next).getValues()));
}
}
else if (next instanceof FrameBodyUFID)
{
if (((FrameBodyUFID) next).getOwner().equals(formatKey.getSubId()))
{
if (((FrameBodyUFID) next).getUniqueIdentifier() != null)
{
values.add(new String(((FrameBodyUFID) next).getUniqueIdentifier()));
}
}
}
else if (next instanceof AbstractFrameBodyPairs)
{
for (Pair entry : ((AbstractFrameBodyPairs) next).getPairing().getMapping())
{
if (entry.getKey().equals(formatKey.getSubId()))
{
if (entry.getValue() != null)
{
values.add(entry.getValue());
}
}
}
}
else
{
throw new RuntimeException("Need to implement getFields(FieldKey genericKey) for:" + next.getClass());
}
}
}
//Special handling for paired fields with no defined key
else if ((formatKey.getGenericKey()!=null)&&
((formatKey.getGenericKey() == FieldKey.PERFORMER)||(formatKey.getGenericKey() == FieldKey.INVOLVED_PERSON))
)
{
List<TagField> list = getFields(formatKey.getFrameId());
ListIterator<TagField> li = list.listIterator();
while (li.hasNext())
{
AbstractTagFrameBody next = ((AbstractID3v2Frame) li.next()).getBody();
if (next instanceof AbstractFrameBodyPairs)
{
for (Pair entry : ((AbstractFrameBodyPairs) next).getPairing().getMapping())
{
if(!StandardIPLSKey.isKey(entry.getKey()))
{
if (!entry.getValue().isEmpty())
{
if (!entry.getKey().isEmpty())
{
values.add(entry.getPairValue());
}
else
{
values.add(entry.getValue());
}
}
}
}
}
}
}
//Simple 1 to 1 mapping
else
{
List<TagField> list = getFields(formatKey.getFrameId());
for (TagField next : list)
{
AbstractID3v2Frame frame = (AbstractID3v2Frame) next;
if (frame != null)
{
if (frame.getBody() instanceof AbstractFrameBodyTextInfo fb)
{
values.addAll(fb.getValues());
}
else
{
values.add(getTextValueForFrame(frame));
}
}
}
}
return values;
} |
Create a list of values for this (sub)frame
<p/>
This method does all the complex stuff of splitting multiple values in one frame into separate values.
@param formatKey
@return
@throws KeyNotFoundException
| AbstractID3v2Tag::doGetValues | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
protected String doGetValueAtIndex(FrameAndSubId formatKey, int index) throws KeyNotFoundException
{
List<String> values = doGetValues(formatKey);
if (values.size() > index)
{
return values.get(index);
}
return "";
} |
Get the value at the index, we massage the values so that the index as used in the generic interface rather
than simply taking the frame index. For example if two composers have been added then then they can be retrieved
individually using index=0, index=1 despite the fact that both internally will be stored in a single TCOM frame.
@param formatKey
@param index the index specified by the user
@return
@throws KeyNotFoundException
| AbstractID3v2Tag::doGetValueAtIndex | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public TagField createLinkedArtworkField(String url)
{
AbstractID3v2Frame frame = createFrame(getFrameAndSubIdFromGenericKey(FieldKey.COVER_ART).getFrameId());
if (frame.getBody() instanceof FrameBodyAPIC body)
{
body.setObjectValue(DataTypes.OBJ_PICTURE_DATA, url.getBytes(StandardCharsets.ISO_8859_1));
body.setObjectValue(DataTypes.OBJ_PICTURE_TYPE, PictureTypes.DEFAULT_ID);
body.setObjectValue(DataTypes.OBJ_MIME_TYPE, FrameBodyAPIC.IMAGE_IS_URL);
body.setObjectValue(DataTypes.OBJ_DESCRIPTION, "");
}
else if (frame.getBody() instanceof FrameBodyPIC body)
{
body.setObjectValue(DataTypes.OBJ_PICTURE_DATA, url.getBytes(StandardCharsets.ISO_8859_1));
body.setObjectValue(DataTypes.OBJ_PICTURE_TYPE, PictureTypes.DEFAULT_ID);
body.setObjectValue(DataTypes.OBJ_IMAGE_FORMAT, FrameBodyAPIC.IMAGE_IS_URL);
body.setObjectValue(DataTypes.OBJ_DESCRIPTION, "");
}
return frame;
} |
Create a link to artwork, this is not recommended because the link may be broken if the mp3 or image
file is moved
@param url specifies the link, it could be a local file or could be a full url
@return
| AbstractID3v2Tag::createLinkedArtworkField | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
private void deleteNumberTotalFrame(FrameAndSubId formatKey, FieldKey numberFieldKey, FieldKey totalFieldKey, boolean deleteNumberFieldKey)
{
if (deleteNumberFieldKey)
{
String total = this.getFirst(totalFieldKey);
if (total.length() == 0)
{
doDeleteTagField(formatKey);
}
else
{
AbstractID3v2Frame frame = (AbstractID3v2Frame) this.getFrame(formatKey.getFrameId());
AbstractFrameBodyNumberTotal frameBody = (AbstractFrameBodyNumberTotal) frame.getBody();
frameBody.setNumber(0);
}
}
else
{
String number = this.getFirst(numberFieldKey);
if (number.length() == 0)
{
doDeleteTagField(formatKey);
}
else
{
AbstractID3v2Frame frame = (AbstractID3v2Frame) this.getFrame(formatKey.getFrameId());
AbstractFrameBodyNumberTotal frameBody = (AbstractFrameBodyNumberTotal) frame.getBody();
frameBody.setTotal(0);
}
}
} |
Some frames are used to store a number/total value, we have to consider both values when requested to delete a
key relating to one of them
@param formatKey
@param numberFieldKey
@param totalFieldKey
@param deleteNumberFieldKey
| AbstractID3v2Tag::deleteNumberTotalFrame | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public void deleteField(FieldKey fieldKey) throws KeyNotFoundException
{
FrameAndSubId formatKey = getFrameAndSubIdFromGenericKey(fieldKey);
if (fieldKey == null)
{
throw new KeyNotFoundException();
}
switch(fieldKey)
{
case TRACK:
deleteNumberTotalFrame(formatKey, FieldKey.TRACK, FieldKey.TRACK_TOTAL, true);
break;
case TRACK_TOTAL:
deleteNumberTotalFrame(formatKey, FieldKey.TRACK, FieldKey.TRACK_TOTAL, false);
break;
case DISC_NO:
deleteNumberTotalFrame(formatKey, FieldKey.DISC_NO, FieldKey.DISC_TOTAL, true);
break;
case DISC_TOTAL:
deleteNumberTotalFrame(formatKey, FieldKey.DISC_NO, FieldKey.DISC_TOTAL, false);
break;
case MOVEMENT_NO:
deleteNumberTotalFrame(formatKey, FieldKey.MOVEMENT_NO, FieldKey.MOVEMENT_TOTAL, true);
break;
case MOVEMENT_TOTAL:
deleteNumberTotalFrame(formatKey, FieldKey.MOVEMENT_NO, FieldKey.MOVEMENT_TOTAL, false);
break;
default:
doDeleteTagField(formatKey);
}
} |
Delete fields with this generic key
If generic key maps to multiple frames then do special processing here rather doDeleteField()
@param fieldKey
| AbstractID3v2Tag::deleteField | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
protected void doDeleteTagField(FrameAndSubId formatKey) throws KeyNotFoundException
{
if (formatKey.getSubId() != null)
{
//Get list of frames that this uses
List<TagField> list = getFields(formatKey.getFrameId());
ListIterator<TagField> li = list.listIterator();
while (li.hasNext())
{
AbstractTagFrameBody next = ((AbstractID3v2Frame) li.next()).getBody();
if (next instanceof FrameBodyTXXX)
{
if (((FrameBodyTXXX) next).getDescription().equals(formatKey.getSubId()))
{
if (list.size() == 1)
{
removeFrame(formatKey.getFrameId());
}
else
{
li.remove();
}
}
}
else if (next instanceof FrameBodyCOMM)
{
if (((FrameBodyCOMM) next).getDescription().equals(formatKey.getSubId()))
{
if (list.size() == 1)
{
removeFrame(formatKey.getFrameId());
}
else
{
li.remove();
}
}
}
else if (next instanceof FrameBodyWXXX)
{
if (((FrameBodyWXXX) next).getDescription().equals(formatKey.getSubId()))
{
if (list.size() == 1)
{
removeFrame(formatKey.getFrameId());
}
else
{
li.remove();
}
}
}
else if (next instanceof FrameBodyUFID)
{
if (((FrameBodyUFID) next).getOwner().equals(formatKey.getSubId()))
{
if (list.size() == 1)
{
removeFrame(formatKey.getFrameId());
}
else
{
li.remove();
}
}
}
//A single TIPL frame is used for multiple fields, so we just delete the matching pairs rather than
//deleting the frame itself unless now empty
else if (next instanceof FrameBodyTIPL)
{
PairedTextEncodedStringNullTerminated.ValuePairs pairs = ((FrameBodyTIPL) next).getPairing();
ListIterator<Pair> pairIterator = pairs.getMapping().listIterator();
while (pairIterator.hasNext())
{
Pair nextPair = pairIterator.next();
if (nextPair.getKey().equals(formatKey.getSubId()))
{
pairIterator.remove();
}
}
if (pairs.getMapping().size() == 0)
{
removeFrame(formatKey.getFrameId());
}
}
//A single IPLS frame is used for multiple fields, so we just delete the matching pairs rather than
//deleting the frame itself unless now empty
else if (next instanceof FrameBodyIPLS)
{
PairedTextEncodedStringNullTerminated.ValuePairs pairs = ((FrameBodyIPLS) next).getPairing();
ListIterator<Pair> pairIterator = pairs.getMapping().listIterator();
while (pairIterator.hasNext())
{
Pair nextPair = pairIterator.next();
if (nextPair.getKey().equals(formatKey.getSubId()))
{
pairIterator.remove();
}
}
if (pairs.getMapping().size() == 0)
{
removeFrame(formatKey.getFrameId());
}
}
else
{
throw new RuntimeException("Need to implement getFields(FieldKey genericKey) for:" + next.getClass());
}
}
}
else if ((formatKey.getGenericKey()!=null) &&
((formatKey.getGenericKey() == FieldKey.PERFORMER) || (formatKey.getGenericKey() == FieldKey.INVOLVED_PERSON))
)
{
List<TagField> list = getFields(formatKey.getFrameId());
ListIterator<TagField> li = list.listIterator();
while (li.hasNext())
{
AbstractTagFrameBody next = ((AbstractID3v2Frame) li.next()).getBody();
if (next instanceof AbstractFrameBodyPairs)
{
PairedTextEncodedStringNullTerminated.ValuePairs pairs = ((AbstractFrameBodyPairs) next).getPairing();
ListIterator<Pair> pairIterator = pairs.getMapping().listIterator();
while (pairIterator.hasNext())
{
Pair nextPair = pairIterator.next();
if(!StandardIPLSKey.isKey(nextPair.getKey()))
{
pairIterator.remove();
}
}
if (pairs.getMapping().size() == 0)
{
removeFrame(formatKey.getFrameId());
}
}
}
}
//Simple 1 to 1 mapping
else if (formatKey.getSubId() == null)
{
removeFrame(formatKey.getFrameId());
}
} |
Internal delete method, for deleting/modifying an individual ID3 frame
@param formatKey
@throws KeyNotFoundException
| AbstractID3v2Tag::doDeleteTagField | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public List<TagField> getFields(FieldKey genericKey) throws KeyNotFoundException
{
if (genericKey == null)
{
throw new IllegalArgumentException(ErrorMessage.GENERAL_INVALID_NULL_ARGUMENT.getMsg());
}
FrameAndSubId formatKey = getFrameAndSubIdFromGenericKey(genericKey);
//Get list of frames that this uses, as we are going to remove entries we don't want take a copy
List<TagField> list = getFields(formatKey.getFrameId());
List<TagField> filteredList = new ArrayList<TagField>();
String subFieldId = formatKey.getSubId();
if (subFieldId != null)
{
for (TagField tagfield : list)
{
AbstractTagFrameBody next = ((AbstractID3v2Frame) tagfield).getBody();
if (next instanceof FrameBodyTXXX)
{
if (((FrameBodyTXXX) next).getDescription().equals(formatKey.getSubId()))
{
filteredList.add(tagfield);
}
}
else if (next instanceof FrameBodyWXXX)
{
if (((FrameBodyWXXX) next).getDescription().equals(formatKey.getSubId()))
{
filteredList.add(tagfield);
}
}
else if (next instanceof FrameBodyCOMM)
{
if (((FrameBodyCOMM) next).getDescription().equals(formatKey.getSubId()))
{
filteredList.add(tagfield);
}
}
else if (next instanceof FrameBodyUFID)
{
if (((FrameBodyUFID) next).getOwner().equals(formatKey.getSubId()))
{
filteredList.add(tagfield);
}
}
else if (next instanceof FrameBodyIPLS)
{
for (Pair entry : ((FrameBodyIPLS) next).getPairing().getMapping())
{
if (entry.getKey().equals(formatKey.getSubId()))
{
filteredList.add(tagfield);
}
}
}
else if (next instanceof FrameBodyTIPL)
{
for (Pair entry : ((FrameBodyTIPL) next).getPairing().getMapping())
{
if (entry.getKey().equals(formatKey.getSubId()))
{
filteredList.add(tagfield);
}
}
}
else if (next instanceof FrameBodyUnsupported)
{
return list;
}
else
{
throw new RuntimeException("Need to implement getFields(FieldKey genericKey) for:" + next.getClass());
}
}
return filteredList;
}
else if(ID3NumberTotalFields.isNumber(genericKey))
{
for (TagField tagfield : list)
{
AbstractTagFrameBody next = ((AbstractID3v2Frame) tagfield).getBody();
if (next instanceof AbstractFrameBodyNumberTotal)
{
if (((AbstractFrameBodyNumberTotal) next).getNumber() != null)
{
filteredList.add(tagfield);
}
}
}
return filteredList;
}
else if(ID3NumberTotalFields.isTotal(genericKey))
{
for (TagField tagfield : list)
{
AbstractTagFrameBody next = ((AbstractID3v2Frame) tagfield).getBody();
if (next instanceof AbstractFrameBodyNumberTotal)
{
if (((AbstractFrameBodyNumberTotal) next).getTotal() != null)
{
filteredList.add(tagfield);
}
}
}
return filteredList;
}
else
{
return list;
}
} |
Get field(s) for this generic key
<p/>
This will return the number of underlying frames of this type, for example if you have added two TCOM field
values these will be stored within a single frame so only one field will be returned not two. This can be
confusing because getValues() would return two values.
@param genericKey
@return
@throws KeyNotFoundException
| AbstractID3v2Tag::getFields | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public void setField(Artwork artwork) throws FieldDataInvalidException
{
this.setField(createField(artwork));
} |
Create field and then set within tag itself
@param artwork
@throws FieldDataInvalidException
| FrameAndSubId::setField | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public void addField(Artwork artwork) throws FieldDataInvalidException
{
this.addField(createField(artwork));
} |
Create field and then set within tag itself
@param artwork
@throws FieldDataInvalidException
| FrameAndSubId::addField | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public void deleteArtworkField() throws KeyNotFoundException
{
this.deleteField(FieldKey.COVER_ART);
} |
Delete all instance of artwork Field
@throws KeyNotFoundException
| FrameAndSubId::deleteArtworkField | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3v2Tag.java | Apache-2.0 |
public boolean isSubsetOf(Object obj)
{
return obj instanceof AbstractTagItem;
} |
Returns true if this datatype is a subset of the argument. This instance
is a subset if it is the same class as the argument.
@param obj datatype to determine subset of
@return true if this instance and its entire datatype array list is a
subset of the argument.
| AbstractTagItem::isSubsetOf | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractTagItem.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractTagItem.java | Apache-2.0 |
public boolean equals(Object obj)
{
if ( this == obj ) return true;
return obj instanceof AbstractTagItem;
} |
Returns true if this datatype and its body equals the argument and its
body. this datatype is equal if and only if they are the same class
@param obj datatype to determine equality of
@return true if this datatype and its body are equal
| AbstractTagItem::equals | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractTagItem.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractTagItem.java | Apache-2.0 |
public String getIdentifier()
{
return TAG_RELEASE + getRelease() + "." + getMajorVersion() + "." + getRevision();
} |
Get full version
| AbstractID3Tag::getIdentifier | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3Tag.java | Apache-2.0 |
protected String getLoggingFilename()
{
return loggingFilename;
} |
Retrieve the logging filename to be used in debugging
@return logging filename to be used in debugging
| AbstractID3Tag::getLoggingFilename | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3Tag.java | Apache-2.0 |
protected void setLoggingFilename(String loggingFilename)
{
this.loggingFilename = loggingFilename;
} |
Set logging filename when construct tag for read from file
@param loggingFilename
| AbstractID3Tag::setLoggingFilename | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/AbstractID3Tag.java | Apache-2.0 |
public byte getRelease()
{
return RELEASE;
} |
Retrieve the Release
| ID3v11Tag::getRelease | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/ID3v11Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/ID3v11Tag.java | Apache-2.0 |
public byte getMajorVersion()
{
return MAJOR_VERSION;
} |
Retrieve the Major Version
| ID3v11Tag::getMajorVersion | java | ZTFtrue/MonsterMusic | app/src/main/java/org/jaudiotagger/tag/id3/ID3v11Tag.java | https://github.com/ZTFtrue/MonsterMusic/blob/master/app/src/main/java/org/jaudiotagger/tag/id3/ID3v11Tag.java | Apache-2.0 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.