SoundbankParser (Midica 1.5.6

java.lang.Object
- org.midica.file.read.SoundbankParser

All Implemented Interfaces:

IParser
```
public class SoundbankParser
extends java.lang.Object
implements IParser
```
This class is used in order to load a user-defined soundbank or DLS file or a URL.

It’s also used for retrieving information from the currently loaded (or standard) soundbank.

Author:

Jan Trukenmüller

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`FROM_FILE`
`static int`	`FROM_UNKNOWN`
`static int`	`FROM_URL`
`private static java.util.HashMap<java.lang.String,java.lang.String>`	`generalInfo` Data structure for general information of the currently loaded soundbank.
`static java.lang.String`	`SOUND_FORMAT_DLS`
`static java.lang.String`	`SOUND_FORMAT_SF2`
`private static javax.sound.midi.Soundbank`	`soundbank` The currently loaded user-defined soundbank.
`private static java.util.ArrayList<java.util.HashMap<java.lang.String,java.lang.String>>`	`soundbankInstruments` Data structure for instruments and drum kits of the currently loaded soundbank.
`private static java.util.ArrayList<java.util.HashMap<java.lang.String,java.lang.Object>>`	`soundbankResources` Data structure for resources of the currently loaded soundbank.
`private static java.io.File`	`soundFile` The successfully loaded soundbank file.
`private static java.lang.String`	`soundFormat` The format of the successfully loaded sound file or URL (SF2 or DLS).
`private static java.net.URL`	`soundUrl` The successfully loaded sound URL.

Constructor Summary

Constructors
Constructor and Description

SoundbankParser()

Constructors
Constructor and Description
`SoundbankParser()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private java.io.File`	`getCachedFile(java.net.URL url)` Download and cache the url, if not yet done, and/or returns the cached file.
`static java.lang.String`	`getFullPath()` Returns the long version of the successfully loaded custom sound file or URL.
`static java.lang.String`	`getShortName()` Returns a short name of the successfully loaded sound file or url for displaying in the main window.
`static java.util.HashMap<java.lang.String,java.lang.String>`	`getSoundbankInfo()` Returns general information from the currently loaded soundbank.
`static java.util.ArrayList<java.util.HashMap<java.lang.String,java.lang.String>>`	`getSoundbankInstruments()` Returns instruments and drum kits from the currently loaded soundbank.
`static java.util.ArrayList<java.util.HashMap<java.lang.String,java.lang.Object>>`	`getSoundbankResources()` Returns resources from the currently loaded soundbank.
`static java.lang.String`	`getSoundFormat()` Returns the format of the successfully selected soundbank.
`static int`	`getSource()` Indicates where the currently loaded soundbank has come from.
`static java.lang.String`	`getUrlCacheDir()` Returns the path of the URL cache directory.
`static java.lang.String`	`getUrlHash(java.lang.String url)` Returns the hash of the given url.
`private static java.lang.String`	`makeNumberRangeString(java.util.ArrayList<java.lang.Integer> list)` Transforms a list of numbers into a String describing these numbers in ranges.
`void`	`parse(java.lang.Object fileOrUrl)` Parses a soundbank file or URL.
`private static void`	`parseSoundbankInfo()` Retrieves general information from the currently loaded soundbank.
`private static void`	`parseSoundbankInstruments()` Retrieves instruments and drum kits from the currently loaded soundbank.
`static void`	`parseSoundbankResources()` Retrieves resources from the soundbank.

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

- Field Detail
  - FROM_UNKNOWN
```
public static final int FROM_UNKNOWN
```
    See Also:
    
    Constant Field Values
  - FROM_FILE
```
public static final int FROM_FILE
```
    See Also:
    
    Constant Field Values
  - FROM_URL
```
public static final int FROM_URL
```
    See Also:
    
    Constant Field Values
  - SOUND_FORMAT_SF2
```
public static final java.lang.String SOUND_FORMAT_SF2
```
    See Also:
    
    Constant Field Values
  - SOUND_FORMAT_DLS
```
public static final java.lang.String SOUND_FORMAT_DLS
```
    See Also:
    
    Constant Field Values
  - soundbank
```
private static javax.sound.midi.Soundbank soundbank
```
    The currently loaded user-defined soundbank.
  - soundFile
```
private static java.io.File soundFile
```
    The successfully loaded soundbank file.
  - soundUrl
```
private static java.net.URL soundUrl
```
    The successfully loaded sound URL.
  - soundFormat
```
private static java.lang.String soundFormat
```
    The format of the successfully loaded sound file or URL (SF2 or DLS).
  - generalInfo
```
private static java.util.HashMap<java.lang.String,java.lang.String> generalInfo
```
    Data structure for general information of the currently loaded soundbank.
  - soundbankInstruments
```
private static java.util.ArrayList<java.util.HashMap<java.lang.String,java.lang.String>> soundbankInstruments
```
    Data structure for instruments and drum kits of the currently loaded soundbank.
  - soundbankResources
```
private static java.util.ArrayList<java.util.HashMap<java.lang.String,java.lang.Object>> soundbankResources
```
    Data structure for resources of the currently loaded soundbank.
- Constructor Detail
  - SoundbankParser
```
public SoundbankParser()
```
- Method Detail
  - parse
```
public void parse(java.lang.Object fileOrUrl)
           throws ParseException
```
    Parses a soundbank file or URL.
    
    Specified by:
    
    parse in interface IParser
    
    Parameters:
    
    fileOrUrl - file or url (as string) chosen by the user
    
    Throws:
    
    ParseException - if the file can not be loaded correctly.
  - getSoundFormat
```
public static java.lang.String getSoundFormat()
```
    Returns the format of the successfully selected soundbank.
    
    Returns:
    
    sf2, dls or null.
  - getSource
```
public static int getSource()
```
    Indicates where the currently loaded soundbank has come from.
    
    Returns:
    
    FROM_FILE, FROM_URL or FROM_UNKNOWN.
  - getShortName
```
public static java.lang.String getShortName()
```
    Returns a short name of the successfully loaded sound file or url for displaying in the main window.
    
    In case of a file the base name of the file is used.
    
    In case of a URL it’s a possibly shortened form of the url.
    
    If no custom file or URL is loaded successfully, null is returned.
    
    Returns:
    
    the soundbank file name or shortened URL or null.
  - getFullPath
```
public static java.lang.String getFullPath()
```
    Returns the long version of the successfully loaded custom sound file or URL.
    
    In case of a file, the absolute path is returned.
    
    In case of a URL, the full URL is returned.
    
    If no custom sound is loaded successfully, null is returned.
    
    Returns:
    
    the sound file path or URL or null.
  - getSoundbankInfo
```
public static java.util.HashMap<java.lang.String,java.lang.String> getSoundbankInfo()
```
    Returns general information from the currently loaded soundbank.
    
    Returns:
    
    general soundbank information.
  - getSoundbankInstruments
```
public static java.util.ArrayList<java.util.HashMap<java.lang.String,java.lang.String>> getSoundbankInstruments()
```
    Returns instruments and drum kits from the currently loaded soundbank.
    
    Returns:
    
    Instruments from the soundbank.
  - getSoundbankResources
```
public static java.util.ArrayList<java.util.HashMap<java.lang.String,java.lang.Object>> getSoundbankResources()
```
    Returns resources from the currently loaded soundbank.
    
    Returns:
    
    Resources from the soundbank.
  - getUrlHash
```
public static java.lang.String getUrlHash(java.lang.String url)
                                   throws java.security.NoSuchAlgorithmException
```
    Returns the hash of the given url.
    
    Parameters:
    
    url - the url to be hashed.
    
    Returns:
    
    the hash value of the given url
    
    Throws:
    
    java.security.NoSuchAlgorithmException - if SHA-256 is not supported by the JVM.
  - getUrlCacheDir
```
public static java.lang.String getUrlCacheDir()
```
    Returns the path of the URL cache directory.
    
    Returns:
    
    cache directory
    
    Throws:
    
    java.io.IOException
  - getCachedFile
```
private java.io.File getCachedFile(java.net.URL url)
                            throws ParseException
```
    Download and cache the url, if not yet done, and/or returns the cached file.
    
    Parameters:
    
    url - the url to be downloaded.
    
    Returns:
    
    the cached file.
    
    Throws:
    
    ParseException - if something goes wrong
  - parseSoundbankInfo
```
private static void parseSoundbankInfo()
```
    Retrieves general information from the currently loaded soundbank.
  - parseSoundbankInstruments
```
private static void parseSoundbankInstruments()
```
    Retrieves instruments and drum kits from the currently loaded soundbank.
  - parseSoundbankResources
```
public static void parseSoundbankResources()
```
    Retrieves resources from the soundbank.
  - makeNumberRangeString
```
private static java.lang.String makeNumberRangeString(java.util.ArrayList<java.lang.Integer> list)
```
    Transforms a list of numbers into a String describing these numbers in ranges.
    
    E.g. the list (2, 5, 6, 7, 8, 9, 11, 15, 16, 17, 20) would result in the string 2, 5-9, 11, 15-17, 20
    
    Parameters:
    
    list - Sorted list of numbers.
    
    Returns:
    
    Compressed but still human-readable range string.

Class SoundbankParser

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FROM_UNKNOWN

FROM_FILE

FROM_URL

SOUND_FORMAT_SF2

SOUND_FORMAT_DLS

soundbank

soundFile

soundUrl

soundFormat

generalInfo

soundbankInstruments

soundbankResources

Constructor Detail

SoundbankParser

Method Detail

parse

getSoundFormat

getSource

getShortName

getFullPath

getSoundbankInfo

getSoundbankInstruments

getSoundbankResources

getUrlHash

getUrlCacheDir

getCachedFile

parseSoundbankInfo

parseSoundbankInstruments

parseSoundbankResources

makeNumberRangeString