Mp3File (mp3agic 0.9.1 API)

java.lang.Object
- com.mpatric.mp3agic.FileWrapper
- - com.mpatric.mp3agic.Mp3File

public class Mp3File
extends FileWrapper

Field Summary

Fields
Modifier and Type	Field and Description
`private double`	`bitrate`
`private Map<Integer,MutableInteger>`	`bitrates`
`protected int`	`bufferLength`
`private String`	`channelMode`
`private boolean`	`copyright`
`private byte[]`	`customTag`
`private static int`	`DEFAULT_BUFFER_LENGTH`
`private String`	`emphasis`
`private int`	`endOffset`
`private int`	`frameCount`
`private ID3v1`	`id3v1Tag`
`private ID3v2`	`id3v2Tag`
`private String`	`layer`
`private static int`	`MINIMUM_BUFFER_LENGTH`
`private String`	`modeExtension`
`private boolean`	`original`
`private int`	`sampleRate`
`private boolean`	`scanFile`
`private int`	`startOffset`
`private String`	`version`
`private static int`	`XING_MARKER_OFFSET_1`
`private static int`	`XING_MARKER_OFFSET_2`
`private static int`	`XING_MARKER_OFFSET_3`
`private int`	`xingBitrate`
`private int`	`xingOffset`

Fields inherited from class com.mpatric.mp3agic.FileWrapper
lastModified, length, path

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Mp3File()`
	`Mp3File(File file)`
	`Mp3File(File file, int bufferLength)`
	`Mp3File(File file, int bufferLength, boolean scanFile)`
	`Mp3File(Path path)`
	`Mp3File(Path path, int bufferLength)`
	`Mp3File(Path path, int bufferLength, boolean scanFile)`
	`Mp3File(String filename)`
	`Mp3File(String filename, boolean scanFile)`
	`Mp3File(String filename, int bufferLength)`
	`Mp3File(String filename, int bufferLength, boolean scanFile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`addBitrate(int bitrate)`
`int`	`getBitrate()`
`Map<Integer,MutableInteger>`	`getBitrates()`
`String`	`getChannelMode()`
`byte[]`	`getCustomTag()`
`String`	`getEmphasis()`
`int`	`getEndOffset()`
`int`	`getFrameCount()`
`ID3v1`	`getId3v1Tag()`
`ID3v2`	`getId3v2Tag()`
`String`	`getLayer()`
`long`	`getLengthInMilliseconds()`
`long`	`getLengthInSeconds()`
`String`	`getModeExtension()`
`int`	`getSampleRate()`
`int`	`getStartOffset()`
`String`	`getVersion()`
`int`	`getXingBitrate()`
`int`	`getXingOffset()`
`boolean`	`hasCustomTag()`
`boolean`	`hasId3v1Tag()`
`boolean`	`hasId3v2Tag()`
`boolean`	`hasXingFrame()`
`private void`	`init(int bufferLength, boolean scanFile)`
`private void`	`initCustomTag(SeekableByteChannel seekableByteChannel)`
`private void`	`initId3v1Tag(SeekableByteChannel seekableByteChannel)`
`private void`	`initId3v2Tag(SeekableByteChannel seekableByteChannel)`
`boolean`	`isCopyright()`
`boolean`	`isOriginal()`
`boolean`	`isVbr()`
`private boolean`	`isXingFrame(byte[] bytes, int offset)`
`private int`	`maxEndOffset()`
`protected int`	`preScanFile(SeekableByteChannel seekableByteChannel)`
`void`	`removeCustomTag()`
`void`	`removeId3v1Tag()`
`void`	`removeId3v2Tag()`
`private void`	`sanityCheckFrame(MpegFrame frame, int offset)`
`void`	`save(String newFilename)`
`private void`	`saveMpegFrames(SeekableByteChannel saveFile)`
`private int`	`scanBlock(byte[] bytes, int bytesRead, int absoluteOffset, int offset)`
`private int`	`scanBlockForStart(byte[] bytes, int bytesRead, int absoluteOffset, int offset)`
`private void`	`scanFile(SeekableByteChannel seekableByteChannel)`
`void`	`setCustomTag(byte[] customTag)`
`void`	`setId3v1Tag(ID3v1 id3v1Tag)`
`void`	`setId3v2Tag(ID3v2 id3v2Tag)`

Methods inherited from class com.mpatric.mp3agic.FileWrapper
getFilename, getLastModified, getLength

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_BUFFER_LENGTH
```
private static final int DEFAULT_BUFFER_LENGTH
```
See Also:

Constant Field Values

MINIMUM_BUFFER_LENGTH
```
private static final int MINIMUM_BUFFER_LENGTH
```
See Also:

Constant Field Values

XING_MARKER_OFFSET_1
```
private static final int XING_MARKER_OFFSET_1
```
See Also:

Constant Field Values

XING_MARKER_OFFSET_2
```
private static final int XING_MARKER_OFFSET_2
```
See Also:

Constant Field Values

XING_MARKER_OFFSET_3
```
private static final int XING_MARKER_OFFSET_3
```
See Also:

Constant Field Values

bufferLength
```
protected int bufferLength
```

xingOffset
```
private int xingOffset
```

startOffset
```
private int startOffset
```

endOffset
```
private int endOffset
```

frameCount
```
private int frameCount
```

bitrates

private Map<Integer,MutableInteger> bitrates

xingBitrate
```
private int xingBitrate
```

bitrate
```
private double bitrate
```

channelMode
```
private String channelMode
```

emphasis
```
private String emphasis
```

layer
```
private String layer
```

modeExtension
```
private String modeExtension
```

sampleRate
```
private int sampleRate
```

original
```
private boolean original
```

version
```
private String version
```

id3v1Tag
```
private ID3v1 id3v1Tag
```

id3v2Tag
```
private ID3v2 id3v2Tag
```

customTag
```
private byte[] customTag
```

scanFile
```
private boolean scanFile
```

Constructor Detail

Mp3File
```
protected Mp3File()
```

Mp3File

public Mp3File(String filename)
        throws IOException,
               UnsupportedTagException,
               InvalidDataException

Throws:: IOException; UnsupportedTagException; InvalidDataException

Mp3File

public Mp3File(String filename,
               int bufferLength)
        throws IOException,
               UnsupportedTagException,
               InvalidDataException

Throws:: IOException; UnsupportedTagException; InvalidDataException

Mp3File

public Mp3File(String filename,
               boolean scanFile)
        throws IOException,
               UnsupportedTagException,
               InvalidDataException

Throws:: IOException; UnsupportedTagException; InvalidDataException

Mp3File

public Mp3File(String filename,
               int bufferLength,
               boolean scanFile)
        throws IOException,
               UnsupportedTagException,
               InvalidDataException

Throws:: IOException; UnsupportedTagException; InvalidDataException

Mp3File

public Mp3File(File file)
        throws IOException,
               UnsupportedTagException,
               InvalidDataException

Throws:: IOException; UnsupportedTagException; InvalidDataException

Mp3File

public Mp3File(File file,
               int bufferLength)
        throws IOException,
               UnsupportedTagException,
               InvalidDataException

Throws:: IOException; UnsupportedTagException; InvalidDataException

Mp3File

public Mp3File(File file,
               int bufferLength,
               boolean scanFile)
        throws IOException,
               UnsupportedTagException,
               InvalidDataException

Throws:: IOException; UnsupportedTagException; InvalidDataException

Mp3File

public Mp3File(Path path)
        throws IOException,
               UnsupportedTagException,
               InvalidDataException

Throws:: IOException; UnsupportedTagException; InvalidDataException

Mp3File

public Mp3File(Path path,
               int bufferLength)
        throws IOException,
               UnsupportedTagException,
               InvalidDataException

Throws:: IOException; UnsupportedTagException; InvalidDataException

Mp3File

public Mp3File(Path path,
               int bufferLength,
               boolean scanFile)
        throws IOException,
               UnsupportedTagException,
               InvalidDataException

Throws:: IOException; UnsupportedTagException; InvalidDataException

Method Detail

init

private void init(int bufferLength,
                  boolean scanFile)
           throws IOException,
                  UnsupportedTagException,
                  InvalidDataException

Throws:: IOException; UnsupportedTagException; InvalidDataException

preScanFile

protected int preScanFile(SeekableByteChannel seekableByteChannel)

scanFile

private void scanFile(SeekableByteChannel seekableByteChannel)
               throws IOException,
                      InvalidDataException

Throws:: IOException; InvalidDataException

scanBlockForStart

private int scanBlockForStart(byte[] bytes,
                              int bytesRead,
                              int absoluteOffset,
                              int offset)

scanBlock

private int scanBlock(byte[] bytes,
                      int bytesRead,
                      int absoluteOffset,
                      int offset)
               throws InvalidDataException

Throws:: InvalidDataException

maxEndOffset
```
private int maxEndOffset()
```

isXingFrame

private boolean isXingFrame(byte[] bytes,
                            int offset)

sanityCheckFrame

private void sanityCheckFrame(MpegFrame frame,
                              int offset)
                       throws InvalidDataException

Throws:: InvalidDataException

addBitrate
```
private void addBitrate(int bitrate)
```

initId3v1Tag

private void initId3v1Tag(SeekableByteChannel seekableByteChannel)
                   throws IOException

Throws:: IOException

initId3v2Tag

private void initId3v2Tag(SeekableByteChannel seekableByteChannel)
                   throws IOException,
                          UnsupportedTagException,
                          InvalidDataException

Throws:: IOException; UnsupportedTagException; InvalidDataException

initCustomTag

private void initCustomTag(SeekableByteChannel seekableByteChannel)
                    throws IOException

Throws:: IOException

getFrameCount
```
public int getFrameCount()
```

getStartOffset
```
public int getStartOffset()
```

getEndOffset
```
public int getEndOffset()
```

getLengthInMilliseconds
```
public long getLengthInMilliseconds()
```

getLengthInSeconds
```
public long getLengthInSeconds()
```

isVbr
```
public boolean isVbr()
```

getBitrate
```
public int getBitrate()
```

getBitrates

public Map<Integer,MutableInteger> getBitrates()

getChannelMode
```
public String getChannelMode()
```

isCopyright
```
public boolean isCopyright()
```

getEmphasis
```
public String getEmphasis()
```

getLayer
```
public String getLayer()
```

getModeExtension
```
public String getModeExtension()
```

isOriginal
```
public boolean isOriginal()
```

getSampleRate
```
public int getSampleRate()
```

getVersion
```
public String getVersion()
```

hasXingFrame
```
public boolean hasXingFrame()
```

getXingOffset
```
public int getXingOffset()
```

getXingBitrate
```
public int getXingBitrate()
```

hasId3v1Tag
```
public boolean hasId3v1Tag()
```

getId3v1Tag
```
public ID3v1 getId3v1Tag()
```

setId3v1Tag

public void setId3v1Tag(ID3v1 id3v1Tag)

removeId3v1Tag
```
public void removeId3v1Tag()
```

hasId3v2Tag
```
public boolean hasId3v2Tag()
```

getId3v2Tag
```
public ID3v2 getId3v2Tag()
```

setId3v2Tag

public void setId3v2Tag(ID3v2 id3v2Tag)

removeId3v2Tag
```
public void removeId3v2Tag()
```

hasCustomTag
```
public boolean hasCustomTag()
```

getCustomTag
```
public byte[] getCustomTag()
```

setCustomTag

public void setCustomTag(byte[] customTag)

removeCustomTag
```
public void removeCustomTag()
```

save

public void save(String newFilename)
          throws IOException,
                 NotSupportedException

Throws:: IOException; NotSupportedException

saveMpegFrames

private void saveMpegFrames(SeekableByteChannel saveFile)
                     throws IOException

Throws:: IOException

Class Mp3File

Field Summary

Fields inherited from class com.mpatric.mp3agic.FileWrapper

Constructor Summary

Method Summary

Methods inherited from class com.mpatric.mp3agic.FileWrapper

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_BUFFER_LENGTH

MINIMUM_BUFFER_LENGTH

XING_MARKER_OFFSET_1

XING_MARKER_OFFSET_2

XING_MARKER_OFFSET_3

bufferLength

xingOffset

startOffset

endOffset

frameCount

bitrates

xingBitrate

bitrate

channelMode

emphasis

layer

modeExtension

sampleRate

copyright

original

version

id3v1Tag

id3v2Tag

customTag

scanFile

Constructor Detail

Mp3File

Mp3File

Mp3File

Mp3File

Mp3File

Mp3File

Mp3File

Mp3File

Mp3File

Mp3File

Mp3File

Method Detail

init

preScanFile

scanFile

scanBlockForStart

scanBlock

maxEndOffset

isXingFrame

sanityCheckFrame

addBitrate

initId3v1Tag

initId3v2Tag

initCustomTag

getFrameCount

getStartOffset

getEndOffset

getLengthInMilliseconds

getLengthInSeconds

isVbr

getBitrate

getBitrates

getChannelMode

isCopyright

getEmphasis

getLayer

getModeExtension

isOriginal

getSampleRate

getVersion

hasXingFrame

getXingOffset

getXingBitrate

hasId3v1Tag

getId3v1Tag

setId3v1Tag