Package com.tagtraum.beatunes.onlinedb
Class ReferenceSong
- java.lang.Object
-
- com.tagtraum.audiokern.ReadOnlyAudioSong
-
- com.tagtraum.beatunes.onlinedb.ReferenceSong
-
- All Implemented Interfaces:
AudioSong
public class ReferenceSong extends ReadOnlyAudioSong
Reference Song.- Author:
- Hendrik Schreiber
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.tagtraum.audiokern.AudioSong
AudioSong.CloudStatus, AudioSong.Instrumentation, AudioSong.Liking, AudioSong.MediaKind, AudioSong.TrackType
-
-
Field Summary
-
Fields inherited from interface com.tagtraum.audiokern.AudioSong
ACOUSTIC_NAMES, ELECTRONIC_NAMES
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
ReferenceSong()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
canWrite()
Checks whether the file corresponding to this song can in principal be written to.static ReferenceSong
createWithNumericPersistentID(Map<String,Object> clientSongMap)
static ReferenceSong
createWithReferenceSongMap(Map<String,Object> referenceSongMap)
void
download()
Allows downloading of shared (e.g.String
getAlbum()
Get Album.String
getAlbumArtist()
Get album artist.Set<AudioId>
getAlbumIds()
Get album ids.AudioSong.Liking
getAlbumLiking()
Is album liked.int
getAlbumRating()
Get album rating.ReplayGain
getAlbumReplayGain()
Replay gain for this album.String
getArtist()
Get artist.Set<AudioId>
getArtistIds()
Get artists ids.int
getArtworkCount()
Get artwork count.AudioArtwork[]
getArtworks()
Artwork belonging to this song.List<String>
getBackCoverArtworkURLs()
Image
getBackCoverImage()
Returns the first front cover image.com.tagtraum.audiokern.timbre.BarkSpectrum
getBarkSpectrumProperty(String key)
Beats
getBeats()
The song's beats.String
getBeatsAlgorithm()
Method the beats were computed with.float
getBeatsPerMinute()
Beats per minute (BPM).String
getBeatsPerMinuteAlgorithm()
Returns the name of the algorithm used to determine the beats per minute (BPM).Beats
getBeatsProperty(String beats)
int
getBitRate()
Bit rate.Boolean
getBooleanObjectProperty(String key)
boolean
getBooleanProperty(String key)
AudioSong.CloudStatus
getCloudStatus()
Returns the cloud status, if available.Color
getColor()
Returns the color.String
getComments()
Get comments.String
getComposer()
Get composer(s).String
getContentRating()
Returns the content rating.String
getCustom1()
Custom field.String
getCustom2()
Custom field.String
getCustom3()
Custom field.String
getCustom4()
Custom field.String
getCustom5()
Custom field.Float
getDanceability()
Danceability.String
getDanceabilityAlgorithm()
Returns the name of the danceability algorithm.Date
getDateAdded()
Get date the song was added to the library.Date
getDateAnalyzed()
Date the song was last analyzed.Date
getDateModified()
Get date of last modification.Date
getDateProperty(String key)
String
getDescription()
Description/subtitle of this song.int
getDiscCount()
Assuming that this song is on a disc that is part of a disc collection, return the number of discs in this collection.int
getDiscNumber()
Get the disc number.double
getDoubleProperty(String key)
String
getEpisode()
Get episode name.int
getEpisodeOrder()
Episode order.Path
getFile(boolean refresh)
File of this track.byte[]
getFingerprint()
Acoustic fingerprint.float
getFinish()
Stop time of the song in seconds.Float
getFloatObjectProperty(String key)
float
getFloatProperty(String key)
List<String>
getFrontCoverArtworkURLs()
Image
getFrontCoverImage()
Returns the first front cover image.String
getGenre()
Get genre.String
getGrouping()
Get grouping.Long
getId()
Persistent id.Image
getImage()
First artwork image.Image[]
getImages()
All images.AudioSong.Instrumentation
getInstrumentation()
Indicates whether this song qualifies as "electronic" or "acoustic".String
getInstrumentationAlgorithm()
Returns the name of the instrumentation algorithm.AudioSong.Instrumentation
getInstrumentationProperty(String name)
Integer
getIntegerProperty(String key)
int
getIntProperty(String key)
int
getIntProperty(String key, int defaultValue)
Key
getKey()
Return the tonal key of this song.String
getKeyAlgorithm()
Returns the name of the key algorithm.Key
getKeyProperty(String key)
String
getKind()
Kind of audio, e.g.String
getLanguage()
The language of the lyrics as ISO 639 three letter codes.AudioSong.Liking
getLiking()
Liking.AudioSong.Liking
getLikingProperty(String name)
String
getLocation(boolean refresh)
Location of this track.long
getLongProperty(String key)
Loudness
getLoudness()
The song's loudness curve.Loudness
getLoudnessProperty(String loudness)
String
getLyrics()
Returns the lyrics.List<TermFrequency>
getLyricsTermFrequencies()
Terms in this song's lyrics along with their frequency.float
getMeasuresPerMinute()
Measures (bars) per minute.AudioSong.MediaKind
getMediaKind()
Media kind of this object.Mood
getMood()
The song's mood.String
getMoodAlgorithm()
The method the associated mood value was created with.Set<String>
getMoodKeywords()
Get raw mood keywords.Mood
getMoodProperty(String mood)
String
getMovement()
Classical movement.int
getMovementCount()
Classical movement count.int
getMovementNumber()
Classical movement number.String
getName()
Name of this song.String
getPath()
Path.int
getPlayCount()
Get the number of times the song was played.long
getPlayDate()
Get time the song was last played.Date
getPlayDateUTC()
Get play date.double
getPlayFrequency()
Number of times played per 100 days.double
getPlaySkipRatio()
Play/Skip ratio.float
getPopularity()
Popularity as a value between 0 and 1.Object
getProperty(String key)
int
getRating()
Value ranging from 0-100, 100 being best.Float
getRelativeSpectralEntropyMean()
Average of relative entropy values computed for windows of length 1.486s with a hopsize of half a window.Date
getReleaseDate()
Release year (corresponds to id3 TDRL).float
getRemoteDisliked()
Indicates, what percentage of people "dislike" this song.long
getRemoteId()
float
getRemoteLoved()
Indicates, what percentage of people "love" this song.float
getRemotePlayFrequency()
Average of play frequencies as reported by users.float
getRemotePlaySkipRatio()
Play/skip ratio by all users with this song.int
getRemoteRating()
Average of other people's ratings.Long
getRemoteRecordingId()
ReplayGain
getReplayGainProperty(String replayGain)
Float
getRMSMean()
Root mean square (RMS) of the signal's energy, averaged over windows of length ~23ms (actually 1024/44100 frames for a signal with sample rate 44.1kHz, i.e.Float
getRMSStandardDeviation()
Standard deviation of the root mean square energy values for windows of length ~23ms (actually 1024/44100 frames for a signal with sample rate 44.1kHz) with a hopsize of half a window.int
getSampleRate()
Get sample rate in Hz.int
getSeason()
Get season number.Segments
getSegments()
The song's segments.String
getSegmentsAlgorithm()
Method the segments were computed with.Segments
getSegmentsProperty(String segments)
String
getShow()
Name of a show, suitable for TV shows.Similarities
getSimilarities()
The song's similarities.String
getSimilaritiesAlgorithm()
Method the similarities were computed with.Similarities
getSimilaritiesProperty(String similarities)
long
getSize()
File size.int
getSkipCount()
Get skip count.Date
getSkipDate()
Get skip date.String
getSortAlbum()
Returns the "sort album".String
getSortAlbumArtist()
Returns the "sort album artist".String
getSortArtist()
Returns the "sort artist".String
getSortComposer()
Returns the sort composer.String
getSortName()
Returns the "sort name".String
getSortShow()
Returns the sort show.Float
getSpectralCentroidMean()
Average of the spectral centroids computed for individual windows of length ~23.22ms with a hopsize of half a window length.Float
getSpectralFluctuationPeak()
Peak of the averaged spectral fluctuation values computed for windows of length 23.22ms, with a hopsize of half a window.Float
getSpectralFluxMean()
Average of the spectral flux values computed for windows of length 23.22ms, with a hopsize of half a window.Float
getSpectralNoveltyMean()
Average of the spectral novelty values computed for windows of length 23.22ms, with a hopsize of half a window.Float
getSpectralSpreadMean()
Average of the spectral spread values computed for windows of length 23.22ms, with a hopsize of half a window.Float
getSpectralVariabilityMean()
Average of the spectral variability values computed for windows of length 23.22ms, with a hopsize of half a window.com.tagtraum.audiokern.timbre.BarkSpectrum
getSpectrum()
Returns the bark spectrum.float
getStart()
Start time of the song in seconds.int
getStartTime()
Start time of the song in ms.int
getStopTime()
Stop time of the song in ms.String
getStringProperty(String key)
Set<String>
getTags()
Returns a set of tags associated with this song.com.tagtraum.audiokern.bpm.Tempo
getTempo()
Returns tempo.Color
getTempoColor()
Projection ofAudioSong.getTempoSpectrum()
to a color.com.tagtraum.audiokern.bpm.TempoSpectrum
getTempoSpectrum()
Returns the tempo spectrum.com.tagtraum.audiokern.bpm.TempoSpectrum
getTempoSpectrumProperty(String key)
Color
getTempoTimbreColor()
Projection ofAudioSong.getTempoSpectrum()
andAudioSong.getSpectrum()
to a color.TimeSignature
getTimeSignature()
The song's time signature.String
getTimeSignatureAlgorithm()
Method the time signature was computed with.TimeSignature
getTimeSignatureProperty(String timeSignature)
int
getTotalTime()
Total length of the song in ms.int
getTrackCount()
Number of tracks on album/release/recording.Set<AudioId>
getTrackIds()
Returns track ids.int
getTrackNumber()
Get the number of the track on the release/album/recording.ReplayGain
getTrackReplayGain()
Replay gain for this track (not taking other tracks in an album into account).AudioSong.TrackType
getTrackType()
Track type.Integer
getTuning()
Tuning in cents.String
getTuningAlgorithm()
The method the current tuning was created with.int
getUserSongCount()
Indicates by how many user songs this reference song is backed.int
getVolumeAdjustment()
Value between -255 and 255.String
getWork()
Classical work.int
getYear()
Release year - (corresponds to id3 TDRC, recording time).boolean
hasProtectedFileExtension()
Checks file endings instead of the protected flag in the iTunes Music Library.xml, since iTunes marks non-protected versions of files that used to be protected still as protected.boolean
isAlbumRatingComputed()
Indicates whether the value returned byAudioSong.getAlbumRating()
was computed or set manually.boolean
isClean()
Indicates whether this song is "clean" - whatever that means.boolean
isCompilation()
Indicates whether this track is part of a compilation.boolean
isDisabled()
Indicates whether this song is disabled or unchecked.boolean
isEnabled()
Indicates whether this song is enabled or checked.boolean
isExplicit()
Indicates whether this tracks is explicit or not.boolean
isHasVideo()
Indicates whether this track has a video.boolean
isHD()
Indicates whether this video content is in high definition (HD).boolean
isPartOfGaplessAlbum()
Indicates whether this songs is part of a gapless album.boolean
isProtected()
boolean
isPurchased()
Indicates whether this song was purchased (via the iTunes store).boolean
isRatingComputed()
Indicates whether the value returned byAudioSong.getRating()
was computed or set manually.boolean
isShared()
Indicates whether this track is a shared track, i.e.boolean
isUnplayed()
Indicates whether this songs has been played at some point.static boolean
isValidMap(Map<String,Object> clientSongMap)
String
toString()
-
Methods inherited from class com.tagtraum.audiokern.ReadOnlyAudioSong
addArtwork, addPropertyChangeListener, addPropertyChangeListener, getImplementation, getImplementations, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener, setAlbum, setAlbumArtist, setAlbumLiking, setAlbumRating, setAlbumReplayGain, setArtist, setArtworks, setBackCoverArtwork, setBeats, setBeatsAlgorithm, setBeatsPerMinute, setBeatsPerMinuteAlgorithm, setClean, setColor, setComments, setCompilation, setComposer, setContentRating, setCustom1, setCustom2, setCustom3, setCustom4, setCustom5, setDanceability, setDanceabilityAlgorithm, setDateAnalyzed, setDescription, setDisabled, setDiscCount, setDiscNumber, setEnabled, setEpisode, setEpisodeOrder, setExplicit, setFingerprint, setFinish, setFrontCoverArtwork, setGenre, setGrouping, setHasVideo, setHD, setInstrumentation, setInstrumentationAlgorithm, setKey, setKeyAlgorithm, setKind, setLanguage, setLiking, setLocation, setLoudness, setLyrics, setMediaKind, setMood, setMoodAlgorithm, setMoodKeywords, setMovement, setMovementCount, setMovementNumber, setName, setPartOfGaplessAlbum, setPlayCount, setPlayDate, setPlayDateUTC, setPopularity, setRating, setRelativeSpectralEntropyMean, setReleaseDate, setRemoteDisliked, setRemoteLoved, setRemotePlayFrequency, setRemotePlaySkipRatio, setRemoteRating, setRemoteUpdateDate, setRMSMean, setRMSStandardDeviation, setSeason, setSegments, setSegmentsAlgorithm, setShow, setSimilarities, setSimilaritiesAlgorithm, setSkipCount, setSkipDate, setSortAlbum, setSortAlbumArtist, setSortArtist, setSortComposer, setSortName, setSortShow, setSpectralCentroidMean, setSpectralFluctuationPeak, setSpectralFluxMean, setSpectralNoveltyMean, setSpectralSpreadMean, setSpectralVariabilityMean, setSpectrum, setStart, setStartTime, setStopTime, setTags, setTempo, setTempoColor, setTempoSpectrum, setTempoTimbreColor, setTimeSignature, setTimeSignatureAlgorithm, setTrackCount, setTrackNumber, setTrackReplayGain, setTrackType, setTuning, setTuningAlgorithm, setUnplayed, setVolumeAdjustment, setWork, setYear
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.tagtraum.audiokern.AudioSong
addBackCoverArtwork, addFrontCoverArtwork, getFile, getInstrumentationBasedOnGenreAndTags, getLocation, getPurchaseURL, getRemoteUpdateDate, getSyncTempoKey, getSyncTempoTuning, isAcousticBasedOnGenreTitleAndTags, isElectronicBasedOnGenreAndTags, refreshFromFile
-
-
-
-
Method Detail
-
createWithNumericPersistentID
public static ReferenceSong createWithNumericPersistentID(Map<String,Object> clientSongMap)
-
createWithReferenceSongMap
public static ReferenceSong createWithReferenceSongMap(Map<String,Object> referenceSongMap)
-
isShared
public boolean isShared()
Description copied from interface:AudioSong
Indicates whether this track is a shared track, i.e. either from another iTunes library or an iTunes Match song that hasn't been downloaded yet.- Returns:
- true or false
-
getCloudStatus
public AudioSong.CloudStatus getCloudStatus()
Description copied from interface:AudioSong
Returns the cloud status, if available. Note that this call may be expensive, as it requires calling the iTunes API.- Returns:
- the status if available,
null
, if the feature is not supported (Windows, non-iTunes libraries, ...)
-
download
public void download()
Description copied from interface:AudioSong
Allows downloading of shared (e.g. podcasts) or iCloud tracks. May not be available on Windows.
You may be notified of a change in download status of a track by registering a
PropertyChangeListener
for one of the propertiesshared
,trackType
orlocation
.
-
getMediaKind
public AudioSong.MediaKind getMediaKind()
Description copied from interface:AudioSong
Media kind of this object.- Returns:
- kind of media
-
getRemoteId
public long getRemoteId()
-
getRemoteRecordingId
public Long getRemoteRecordingId()
-
getId
public Long getId()
Description copied from interface:AudioSong
Persistent id. Survives application shutdown.- Returns:
- persistent id
-
getIntProperty
public int getIntProperty(String key)
-
getIntProperty
public int getIntProperty(String key, int defaultValue)
-
getLongProperty
public long getLongProperty(String key)
-
getFloatProperty
public float getFloatProperty(String key)
-
getDoubleProperty
public double getDoubleProperty(String key)
-
getBooleanProperty
public boolean getBooleanProperty(String key)
-
getSimilaritiesProperty
public Similarities getSimilaritiesProperty(String similarities)
-
getReplayGainProperty
public ReplayGain getReplayGainProperty(String replayGain)
-
getTimeSignatureProperty
public TimeSignature getTimeSignatureProperty(String timeSignature)
-
getBarkSpectrumProperty
public com.tagtraum.audiokern.timbre.BarkSpectrum getBarkSpectrumProperty(String key)
-
getTempoSpectrumProperty
public com.tagtraum.audiokern.bpm.TempoSpectrum getTempoSpectrumProperty(String key)
-
getLikingProperty
public AudioSong.Liking getLikingProperty(String name)
-
getInstrumentationProperty
public AudioSong.Instrumentation getInstrumentationProperty(String name)
-
getUserSongCount
public int getUserSongCount()
Indicates by how many user songs this reference song is backed.- Returns:
- 0, if unknown; greater than 0 when known
-
getImage
public Image getImage()
Description copied from interface:AudioSong
First artwork image.- Returns:
- first artwork image of this track.
- See Also:
AudioSong.getFrontCoverImage()
,AudioSong.getBackCoverImage()
-
getImages
public Image[] getImages()
Description copied from interface:AudioSong
All images.- Returns:
- images or empty array, never returns
null
-
canWrite
public boolean canWrite()
Description copied from interface:AudioSong
Checks whether the file corresponding to this song can in principal be written to.- Returns:
- true or false
-
getAlbumArtist
public String getAlbumArtist()
Description copied from interface:AudioSong
Get album artist.- Returns:
- album artist
-
getAlbumIds
public Set<AudioId> getAlbumIds()
Description copied from interface:AudioSong
Get album ids.- Returns:
- album ids
-
getAlbumRating
public int getAlbumRating()
Description copied from interface:AudioSong
Get album rating.- Returns:
- album rating
- See Also:
AudioSong.isAlbumRatingComputed()
-
getArtist
public String getArtist()
Description copied from interface:AudioSong
Get artist.- Returns:
- artist.
-
getArtistIds
public Set<AudioId> getArtistIds()
Description copied from interface:AudioSong
Get artists ids.- Returns:
- artist ids
-
getArtworkCount
public int getArtworkCount()
Description copied from interface:AudioSong
Get artwork count.- Returns:
- artwork count
-
getBeatsPerMinute
public float getBeatsPerMinute()
Description copied from interface:AudioSong
Beats per minute (BPM).- Returns:
- beats per minute
- See Also:
AudioSong.getTempo()
-
getTempo
public com.tagtraum.audiokern.bpm.Tempo getTempo()
Description copied from interface:AudioSong
Returns tempo.- Returns:
- tempo
-
getBitRate
public int getBitRate()
Description copied from interface:AudioSong
Bit rate.- Returns:
- bit rate
-
getBeatsPerMinuteAlgorithm
public String getBeatsPerMinuteAlgorithm()
Description copied from interface:AudioSong
Returns the name of the algorithm used to determine the beats per minute (BPM).- Returns:
- algorithm name
-
getTuningAlgorithm
public String getTuningAlgorithm()
Description copied from interface:AudioSong
The method the current tuning was created with.- Returns:
- tuning algorithm
-
getMoodAlgorithm
public String getMoodAlgorithm()
Description copied from interface:AudioSong
The method the associated mood value was created with.- Returns:
- mood algorithm
-
getBeatsAlgorithm
public String getBeatsAlgorithm()
Description copied from interface:AudioSong
Method the beats were computed with.- Returns:
- algorithm the beats were computed with
-
getSegmentsAlgorithm
public String getSegmentsAlgorithm()
Description copied from interface:AudioSong
Method the segments were computed with.- Returns:
- algorithm the segments were computed with
-
getSimilaritiesAlgorithm
public String getSimilaritiesAlgorithm()
Description copied from interface:AudioSong
Method the similarities were computed with.- Returns:
- algorithm the similarities were computed with
-
getTimeSignatureAlgorithm
public String getTimeSignatureAlgorithm()
Description copied from interface:AudioSong
Method the time signature was computed with.- Returns:
- algorithm the time signature was computed with
-
getColor
public Color getColor()
Description copied from interface:AudioSong
Returns the color.- Returns:
- color
-
getTempoColor
public Color getTempoColor()
Description copied from interface:AudioSong
Projection ofAudioSong.getTempoSpectrum()
to a color.- Returns:
- color or null
-
getTempoTimbreColor
public Color getTempoTimbreColor()
Description copied from interface:AudioSong
Projection ofAudioSong.getTempoSpectrum()
andAudioSong.getSpectrum()
to a color.- Returns:
- color or null
-
getComments
public String getComments()
Description copied from interface:AudioSong
Get comments.- Returns:
- comments
-
getComposer
public String getComposer()
Description copied from interface:AudioSong
Get composer(s).- Returns:
- composer(s)
-
getContentRating
public String getContentRating()
Description copied from interface:AudioSong
Returns the content rating. E.g., "us-tv|TV-PG|400|" or "us-tv|TV-MA|600|dialogue and sexual content"- Returns:
- content rating
-
getDateAdded
public Date getDateAdded()
Description copied from interface:AudioSong
Get date the song was added to the library.- Returns:
- date added
-
getDateModified
public Date getDateModified()
Description copied from interface:AudioSong
Get date of last modification.- Returns:
- date
-
getDateAnalyzed
public Date getDateAnalyzed()
Description copied from interface:AudioSong
Date the song was last analyzed.- Returns:
- date analyzed
-
getDiscCount
public int getDiscCount()
Description copied from interface:AudioSong
Assuming that this song is on a disc that is part of a disc collection, return the number of discs in this collection.- Returns:
- disc count
-
getDiscNumber
public int getDiscNumber()
Description copied from interface:AudioSong
Get the disc number.- Returns:
- disc number
-
getEpisode
public String getEpisode()
Description copied from interface:AudioSong
Get episode name.- Returns:
- episode name
-
getEpisodeOrder
public int getEpisodeOrder()
Description copied from interface:AudioSong
Episode order.- Returns:
- episode order
-
getLyrics
public String getLyrics()
Description copied from interface:AudioSong
Returns the lyrics.- Returns:
- lyrics
-
getLyricsTermFrequencies
public List<TermFrequency> getLyricsTermFrequencies()
Description copied from interface:AudioSong
Terms in this song's lyrics along with their frequency. All terms are lowercase, regular ASCII punctuation has been removed.- Returns:
- term frequencies
-
getFile
public Path getFile(boolean refresh)
Description copied from interface:AudioSong
File of this track. Ifrefresh
is true and the file does not exist anymore, ask the backend app (iTunes, Music.app, ...) for the correct file name. Because of the backend call, this method may block and therefore should be called from the EDT.- Parameters:
refresh
- refresh from backend- Returns:
- file object for
AudioSong.getLocation()
or null, if a proper file object cannot be formed - See Also:
AudioSong.getLocation()
,AudioSong.getLocation(boolean)
-
getFinish
public float getFinish()
Description copied from interface:AudioSong
Stop time of the song in seconds.- Returns:
- stop time in seconds.
- See Also:
AudioSong.getStopTime()
-
getGenre
public String getGenre()
Description copied from interface:AudioSong
Get genre.- Returns:
- genre
-
getGrouping
public String getGrouping()
Description copied from interface:AudioSong
Get grouping.- Returns:
- grouping
-
getWork
public String getWork()
Description copied from interface:AudioSong
Classical work.- Returns:
- work
-
getMovement
public String getMovement()
Description copied from interface:AudioSong
Classical movement.- Returns:
- movement
-
getMovementNumber
public int getMovementNumber()
Description copied from interface:AudioSong
Classical movement number.- Returns:
- movement number
-
getMovementCount
public int getMovementCount()
Description copied from interface:AudioSong
Classical movement count.- Returns:
- count
-
getKey
public Key getKey()
Description copied from interface:AudioSong
Return the tonal key of this song. E.g.,MajorKey.C_MAJOR
.- Returns:
- tonal key
-
getKeyAlgorithm
public String getKeyAlgorithm()
Description copied from interface:AudioSong
Returns the name of the key algorithm. May beEntered
, if the key value was entered.- Returns:
- key algorithm
-
getKind
public String getKind()
Description copied from interface:AudioSong
Kind of audio, e.g. "WAV audio file", "AAC audio file" or "MPEG audio file" (or localized versions thereof). This value is typically extracted fromiTunes Music Library.xml
and may simply benull
for non-iTunes libraries.- Returns:
- String describing this audio object or null if unavailable.
-
getLanguage
public String getLanguage()
Description copied from interface:AudioSong
The language of the lyrics as ISO 639 three letter codes.- Returns:
- ISO 639 three letter language code
-
getLocation
public String getLocation(boolean refresh)
Description copied from interface:AudioSong
Location of this track. Ifrefresh
is true and no location is available or the resource does not exist anymore, ask the backend app (iTunes, Music.app, ...) for the correct path. Because of the backend call, this method may block and therefore should be called from the EDT.- Parameters:
refresh
- refresh from backend- Returns:
- location
- See Also:
AudioSong.getLocation()
,AudioSong.getFile(boolean)
-
getName
public String getName()
Description copied from interface:AudioSong
Name of this song.- Returns:
- name
-
getDescription
public String getDescription()
Description copied from interface:AudioSong
Description/subtitle of this song.- Returns:
- description
-
getPath
public String getPath()
Description copied from interface:AudioSong
Path.- Returns:
- path object for
AudioSong.getLocation()
or null, if a proper file object cannot be formed
-
getPlayCount
public int getPlayCount()
Description copied from interface:AudioSong
Get the number of times the song was played.- Returns:
- play count
-
getPlayDate
public long getPlayDate()
Description copied from interface:AudioSong
Get time the song was last played. Returns0
, if it has never been played.- Returns:
- play date, milliseconds since January 1, 1970, 00:00:00 GMT (NOT related to the iTunes value!)
-
getPlayDateUTC
public Date getPlayDateUTC()
Description copied from interface:AudioSong
Get play date.- Returns:
- play date
-
getPlayFrequency
public double getPlayFrequency()
Description copied from interface:AudioSong
Number of times played per 100 days.- Returns:
- played per 100 days
- See Also:
AudioSong.getRemotePlayFrequency()
-
getPlaySkipRatio
public double getPlaySkipRatio()
Description copied from interface:AudioSong
Play/Skip ratio. Defined asplayCount/(skipCount+1)
.- Returns:
- playSkip ratio as defined above
- See Also:
AudioSong.getRemotePlaySkipRatio()
,AudioSong.getPopularity()
-
getRating
public int getRating()
Description copied from interface:AudioSong
Value ranging from 0-100, 100 being best.- Returns:
- rating
- See Also:
AudioSong.isRatingComputed()
,AudioSong.getAlbumRating()
-
getReleaseDate
public Date getReleaseDate()
Description copied from interface:AudioSong
Release year (corresponds to id3 TDRL).- Returns:
- release time
-
getSampleRate
public int getSampleRate()
Description copied from interface:AudioSong
Get sample rate in Hz.- Returns:
- sample rate in Hz
-
getSeason
public int getSeason()
Description copied from interface:AudioSong
Get season number. Suitable for TV-shows.- Returns:
- season.
-
getShow
public String getShow()
Description copied from interface:AudioSong
Name of a show, suitable for TV shows.- Returns:
- show name
-
getSize
public long getSize()
Description copied from interface:AudioSong
File size.- Returns:
- size
-
getSkipCount
public int getSkipCount()
Description copied from interface:AudioSong
Get skip count.- Returns:
- skip count
-
getSkipDate
public Date getSkipDate()
Description copied from interface:AudioSong
Get skip date.- Returns:
- skip date
-
getSortAlbum
public String getSortAlbum()
Description copied from interface:AudioSong
Returns the "sort album". E.g., for "A Hard Day's Night" the sort album is "Hard Day's Night".- Returns:
- sort album
-
getSortAlbumArtist
public String getSortAlbumArtist()
Description copied from interface:AudioSong
Returns the "sort album artist". E.g., for "The Beatles" the sort album artist is "Beatles".- Returns:
- sort album artist
-
getSortArtist
public String getSortArtist()
Description copied from interface:AudioSong
Returns the "sort artist". E.g., for "The Beatles" the sort artist is "Beatles".- Returns:
- sort artist
-
getSortComposer
public String getSortComposer()
Description copied from interface:AudioSong
Returns the sort composer.- Returns:
- sort composer
-
getSortName
public String getSortName()
Description copied from interface:AudioSong
Returns the "sort name". E.g., for "A Taste of Honey" the sort name is "Taste of Honey".- Returns:
- sort name
-
getSortShow
public String getSortShow()
Description copied from interface:AudioSong
Returns the sort show.- Returns:
- sort show
-
getSpectrum
public com.tagtraum.audiokern.timbre.BarkSpectrum getSpectrum()
Description copied from interface:AudioSong
Returns the bark spectrum.- Returns:
- bark spectrum
- See Also:
AudioSong.getTempoTimbreColor()
-
getTempoSpectrum
public com.tagtraum.audiokern.bpm.TempoSpectrum getTempoSpectrum()
Description copied from interface:AudioSong
Returns the tempo spectrum.- Returns:
- tempo spectrum
- See Also:
AudioSong.getTempoColor()
,AudioSong.getTempoTimbreColor()
-
getStart
public float getStart()
Description copied from interface:AudioSong
Start time of the song in seconds.- Returns:
- start time in seconds.
- See Also:
AudioSong.getStartTime()
-
getStartTime
public int getStartTime()
Description copied from interface:AudioSong
Start time of the song in ms.- Returns:
- start time in ms.
-
getStopTime
public int getStopTime()
Description copied from interface:AudioSong
Stop time of the song in ms.- Returns:
- stop time in ms.
-
getTags
public Set<String> getTags()
Description copied from interface:AudioSong
Returns a set of tags associated with this song. To manipulate this song's tag, please useAudioSong.setTags(java.util.Set)
and don't manipulate the returned set.- Returns:
- set of tags
-
getTotalTime
public int getTotalTime()
Description copied from interface:AudioSong
Total length of the song in ms.- Returns:
- length in ms.
-
getTrackCount
public int getTrackCount()
Description copied from interface:AudioSong
Number of tracks on album/release/recording.- Returns:
- track count
- See Also:
AudioSong.getTrackNumber()
-
getTrackIds
public Set<AudioId> getTrackIds()
Description copied from interface:AudioSong
Returns track ids.- Returns:
- track ids
-
getTrackNumber
public int getTrackNumber()
Description copied from interface:AudioSong
Get the number of the track on the release/album/recording.- Returns:
- track number
-
getTrackType
public AudioSong.TrackType getTrackType()
Description copied from interface:AudioSong
Track type. E.g.AudioSong.TrackType.FILE
.- Returns:
- track type
- See Also:
AudioSong.setTrackType(TrackType)
-
getVolumeAdjustment
public int getVolumeAdjustment()
Description copied from interface:AudioSong
Value between -255 and 255.- Returns:
- volume adjustment
-
getYear
public int getYear()
Description copied from interface:AudioSong
Release year - (corresponds to id3 TDRC, recording time).- Returns:
- four digit recording year, if available
- See Also:
AudioSong.getReleaseDate()
-
hasProtectedFileExtension
public boolean hasProtectedFileExtension()
Description copied from interface:AudioSong
Checks file endings instead of the protected flag in the iTunes Music Library.xml, since iTunes marks non-protected versions of files that used to be protected still as protected.- Returns:
- true, if we know that the file-format is usually protected.
-
isAlbumRatingComputed
public boolean isAlbumRatingComputed()
Description copied from interface:AudioSong
Indicates whether the value returned byAudioSong.getAlbumRating()
was computed or set manually.- Returns:
true
orfalse
-
isClean
public boolean isClean()
Description copied from interface:AudioSong
Indicates whether this song is "clean" - whatever that means. "Clean" and "explicit" are mutually exclusive.- Returns:
true
orfalse
- See Also:
AudioSong.isExplicit()
-
isCompilation
public boolean isCompilation()
Description copied from interface:AudioSong
Indicates whether this track is part of a compilation.
"A compilation album is an album (music or spoken-word) featuring tracks from one or more performers, often culled from a variety of sources (such as studio albums, live albums, singles, demos and outtakes.)"
-- Wikipedia Album Compliation- Returns:
true
orfalse
-
isDisabled
public boolean isDisabled()
Description copied from interface:AudioSong
Indicates whether this song is disabled or unchecked.- Returns:
- !
AudioSong.isEnabled()
-
isEnabled
public boolean isEnabled()
Description copied from interface:AudioSong
Indicates whether this song is enabled or checked.- Returns:
true
orfalse
-
isExplicit
public boolean isExplicit()
Description copied from interface:AudioSong
Indicates whether this tracks is explicit or not. "Clean" and "explicit" are mutually exclusive.- Returns:
true
orfalse
- See Also:
AudioSong.isClean()
-
isHasVideo
public boolean isHasVideo()
Description copied from interface:AudioSong
Indicates whether this track has a video.- Returns:
true
orfalse
-
isHD
public boolean isHD()
Description copied from interface:AudioSong
Indicates whether this video content is in high definition (HD).- Returns:
true
orfalse
-
isPartOfGaplessAlbum
public boolean isPartOfGaplessAlbum()
Description copied from interface:AudioSong
Indicates whether this songs is part of a gapless album.- Returns:
true
orfalse
-
isProtected
public boolean isProtected()
Description copied from interface:AudioSong
- Returns:
true
orfalse
-
isPurchased
public boolean isPurchased()
Description copied from interface:AudioSong
Indicates whether this song was purchased (via the iTunes store).- Returns:
true
orfalse
-
isRatingComputed
public boolean isRatingComputed()
Description copied from interface:AudioSong
Indicates whether the value returned byAudioSong.getRating()
was computed or set manually.- Returns:
true
orfalse
-
isUnplayed
public boolean isUnplayed()
Description copied from interface:AudioSong
Indicates whether this songs has been played at some point.- Returns:
true
orfalse
-
getFingerprint
public byte[] getFingerprint()
Description copied from interface:AudioSong
Acoustic fingerprint.- Returns:
- acoustic fingerprint
-
getTuning
public Integer getTuning()
Description copied from interface:AudioSong
Tuning in cents.- Returns:
- cents
-
getMeasuresPerMinute
public float getMeasuresPerMinute()
Description copied from interface:AudioSong
Measures (bars) per minute. This value is computed fromAudioSong.getBeatsPerMinute()
andAudioSong.getTimeSignature()
. In essence BPM is divided by meter (time signature) numerator.- Returns:
- measures/bars per minute or zero, if either the time signature or the BPM is not known
-
getMood
public Mood getMood()
Description copied from interface:AudioSong
The song's mood.- Returns:
- mood
-
getMoodKeywords
public Set<String> getMoodKeywords()
Description copied from interface:AudioSong
Get raw mood keywords.- Returns:
- mood keywords
-
getBeats
public Beats getBeats()
Description copied from interface:AudioSong
The song's beats.- Returns:
- beats
-
getLoudness
public Loudness getLoudness()
Description copied from interface:AudioSong
The song's loudness curve.- Returns:
- loudness
-
getSegments
public Segments getSegments()
Description copied from interface:AudioSong
The song's segments.- Returns:
- segments
-
getSimilarities
public Similarities getSimilarities()
Description copied from interface:AudioSong
The song's similarities.- Returns:
- similarities
-
getTimeSignature
public TimeSignature getTimeSignature()
Description copied from interface:AudioSong
The song's time signature.- Returns:
- time signature
-
getRMSMean
public Float getRMSMean()
Description copied from interface:AudioSong
Root mean square (RMS) of the signal's energy, averaged over windows of length ~23ms (actually 1024/44100 frames for a signal with sample rate 44.1kHz, i.e. 23.22ms) with a hopsize of half a window. Only the first 120 seconds of the audio are considered, the rest is discarded.- Returns:
- average RMS for the first 120 seconds
- See Also:
TemporalFeaturePipelines.createAverageRootMeanSquarePipeline(String, int, int)
,Floats.rootMeanSquare(float[])
,AudioSong.getRMSStandardDeviation()
-
getRMSStandardDeviation
public Float getRMSStandardDeviation()
Description copied from interface:AudioSong
Standard deviation of the root mean square energy values for windows of length ~23ms (actually 1024/44100 frames for a signal with sample rate 44.1kHz) with a hopsize of half a window. Only the first 120 seconds of the audio are considered, the rest is discarded.- Returns:
- standard deviation of the RMS for the first 120 seconds
- See Also:
Floats.rootMeanSquare(float[])
,AudioSong.getRMSMean()
-
getSpectralFluxMean
public Float getSpectralFluxMean()
Description copied from interface:AudioSong
Average of the spectral flux values computed for windows of length 23.22ms, with a hopsize of half a window. Only the first 120 seconds of the signal are considered, the rest is discarded.- Returns:
- average spectral flux
- See Also:
SpectralFeaturePipelines.createAverageSpectralFluxPipeline(String, int, int, int)
-
getSpectralVariabilityMean
public Float getSpectralVariabilityMean()
Description copied from interface:AudioSong
Average of the spectral variability values computed for windows of length 23.22ms, with a hopsize of half a window. Only the first 120 seconds of the signal are considered, the rest is discarded.- Returns:
- average spectral variability
- See Also:
SpectralFeaturePipelines.createAverageSpectralVariabilityPipeline(String, int, int, int)
-
getSpectralCentroidMean
public Float getSpectralCentroidMean()
Description copied from interface:AudioSong
Average of the spectral centroids computed for individual windows of length ~23.22ms with a hopsize of half a window length. Only the first 120 seconds of the signal are considered, the rest is discarded.- Returns:
- averaged spectral centroid
- See Also:
SpectralFeaturePipelines.createAverageSpectralCentroidPipeline(String, int, int, int)
-
getSpectralSpreadMean
public Float getSpectralSpreadMean()
Description copied from interface:AudioSong
Average of the spectral spread values computed for windows of length 23.22ms, with a hopsize of half a window. Only the first 120 seconds of the signal are considered, the rest is discarded.- Returns:
- average spectral spread
- See Also:
SpectralFeaturePipelines.createAverageSpectralSpreadPipeline(String, int, int, int)
-
getRelativeSpectralEntropyMean
public Float getRelativeSpectralEntropyMean()
Description copied from interface:AudioSong
Average of relative entropy values computed for windows of length 1.486s with a hopsize of half a window. Only the first 120 seconds of the signal are considered, the rest is discarded.- Returns:
- average relative entropy
- See Also:
AggregateFunctions.RELATIVE_ENTROPY
,SpectralFeaturePipelines.createAverageRelativeSpectralEntropyPipeline(String, int, int, int)
-
getSpectralFluctuationPeak
public Float getSpectralFluctuationPeak()
Description copied from interface:AudioSong
Peak of the averaged spectral fluctuation values computed for windows of length 23.22ms, with a hopsize of half a window. Only the first 120 seconds of the signal are considered, the rest is discarded.- Returns:
- peak of an averaged fluctuation spectrum
- See Also:
SpectralFeaturePipelines.createAverageSpectralFluctuationPipeline(String, int)
-
getArtworks
public AudioArtwork[] getArtworks()
Description copied from interface:AudioSong
Artwork belonging to this song.- Returns:
- array of artworks
-
getFrontCoverImage
public Image getFrontCoverImage()
Description copied from interface:AudioSong
Returns the first front cover image.- Returns:
- image or null
-
getBackCoverImage
public Image getBackCoverImage()
Description copied from interface:AudioSong
Returns the first front cover image.- Returns:
- image or null
-
getSpectralNoveltyMean
public Float getSpectralNoveltyMean()
Description copied from interface:AudioSong
Average of the spectral novelty values computed for windows of length 23.22ms, with a hopsize of half a window. Only the first 120 seconds of the signal are considered, the rest is discarded.- Returns:
- average spectral novelty
-
getTrackReplayGain
public ReplayGain getTrackReplayGain()
Description copied from interface:AudioSong
Replay gain for this track (not taking other tracks in an album into account).- Returns:
- replay gain
- See Also:
- "Radio" replay gain
-
getAlbumReplayGain
public ReplayGain getAlbumReplayGain()
Description copied from interface:AudioSong
Replay gain for this album.- Returns:
- replay gain
- See Also:
- "Audiophile" replay gain,
AudioSong.getTrackReplayGain()
-
getLiking
public AudioSong.Liking getLiking()
Description copied from interface:AudioSong
Liking. This is an expression of iTunes' loved and disliked fields.- Returns:
- a liking value
-
getAlbumLiking
public AudioSong.Liking getAlbumLiking()
Description copied from interface:AudioSong
Is album liked. This is an expression of iTunes' album loved and album disliked fields.- Returns:
- liking
-
getInstrumentation
public AudioSong.Instrumentation getInstrumentation()
Description copied from interface:AudioSong
Indicates whether this song qualifies as "electronic" or "acoustic".- Returns:
- instrumentation
-
getInstrumentationAlgorithm
public String getInstrumentationAlgorithm()
Description copied from interface:AudioSong
Returns the name of the instrumentation algorithm. May beEntered
, if the value was entered.- Returns:
- instrumentation algorithm
-
getDanceability
public Float getDanceability()
Description copied from interface:AudioSong
Danceability.- Returns:
- normalized positive value (0-1)
-
getDanceabilityAlgorithm
public String getDanceabilityAlgorithm()
Description copied from interface:AudioSong
Returns the name of the danceability algorithm. May beEntered
, if the value was entered.- Returns:
- danceability algorithm
-
getCustom1
public String getCustom1()
Description copied from interface:AudioSong
Custom field.- Returns:
- custom field
-
getCustom2
public String getCustom2()
Description copied from interface:AudioSong
Custom field.- Returns:
- custom field
-
getCustom3
public String getCustom3()
Description copied from interface:AudioSong
Custom field.- Returns:
- custom field
-
getCustom4
public String getCustom4()
Description copied from interface:AudioSong
Custom field.- Returns:
- custom field
-
getCustom5
public String getCustom5()
Description copied from interface:AudioSong
Custom field.- Returns:
- custom field
-
getRemoteRating
public int getRemoteRating()
Description copied from interface:AudioSong
Average of other people's ratings.- Returns:
- mean of ratings
-
getPopularity
public float getPopularity()
Description copied from interface:AudioSong
Popularity as a value between 0 and 1.- Returns:
- popularity among all users
-
getRemotePlayFrequency
public float getRemotePlayFrequency()
Description copied from interface:AudioSong
Average of play frequencies as reported by users.- Returns:
- play frequency
- See Also:
AudioSong.getPlayFrequency()
-
getRemotePlaySkipRatio
public float getRemotePlaySkipRatio()
Description copied from interface:AudioSong
Play/skip ratio by all users with this song.- Returns:
- play/skip ratio
- See Also:
AudioSong.getPlaySkipRatio()
-
getRemoteLoved
public float getRemoteLoved()
Description copied from interface:AudioSong
Indicates, what percentage of people "love" this song. May be much lower than expected.- Returns:
- value between 0 and 1.
- See Also:
AudioSong.getRemoteDisliked()
,AudioSong.getLiking()
-
getRemoteDisliked
public float getRemoteDisliked()
Description copied from interface:AudioSong
Indicates, what percentage of people "dislike" this song. May be much lower than expected.- Returns:
- value between 0 and 1.
- See Also:
AudioSong.getRemoteLoved()
,AudioSong.getLiking()
-
-