Sound.HTagLib

This module includes complete high-level interface to TagLib. This is the module you should import to use in your projects.

Data types

data Title

Title tag.

Instances

Eq Title

Ord Title

Show Title

IsString Title

mkTitle :: String -> Title

Construction of Title type, null bytes are converted to spaces.

getTitle :: Title -> String

Convert Title to String.

data Artist

Artist tag.

Instances

Eq Artist

Ord Artist

Show Artist

IsString Artist

mkArtist :: String -> Artist

Construction of Artist type, null bytes are converted to spaces.

getArtist :: Artist -> String

Convert Artist to String.

data Album

Album tag.

Instances

Eq Album

Ord Album

Show Album

IsString Album

mkAlbum :: String -> Album

Construction of Album type, null bytes are converted to spaces.

getAlbum :: Album -> String

Convert Album to String.

data Comment

Comment tag.

Instances

Eq Comment

Ord Comment

Show Comment

IsString Comment

mkComment :: String -> Comment

Construction of Comment type, null bytes are converted to spaces.

getComment :: Comment -> String

Convert Comment to String.

data Genre

Genre tag.

Instances

Eq Genre

Ord Genre

Show Genre

IsString Genre

mkGenre :: String -> Genre

Construction of Genre type, null bytes are converted to spaces.

getGenre :: Genre -> String

Convert Genre to String.

data Year

Year tag.

Instances

Eq Year

Ord Year

Show Year

mkYear :: Int -> Maybe Year

Construction of Year type, non-positive values result in Nothing.

getYear :: Year -> Int

Convert Year to Int.

data TrackNumber

Track number tag.

Instances

Eq TrackNumber

Ord TrackNumber

Show TrackNumber

mkTrackNumber :: Int -> Maybe TrackNumber

Construction of TrackNumber type, non-positive values result in Nothing.

getTrackNumber :: TrackNumber -> Int

Convert TrackNumber to Int.

data Duration

Duration in seconds.

Instances

Eq Duration

Ord Duration

Show Duration

mkDuration :: Int -> Maybe Duration

Construction of Duration values, negative values result in Nothing.

getDuration :: Duration -> Int

Convert Duration to Int.

data BitRate

Bit rate in kb/s.

Instances

Eq BitRate

Ord BitRate

Show BitRate

mkBitRate :: Int -> Maybe BitRate

Construction of BitRate values, negative values result in Nothing.

getBitRate :: BitRate -> Int

Convert BitRate to Int.

data SampleRate

Sample rate in Hz.

Instances

Eq SampleRate

Ord SampleRate

Show SampleRate

mkSampleRate :: Int -> Maybe SampleRate

Construction of SampleRate values, non-positive values result in Nothing.

getSampleRate :: SampleRate -> Int

Convert SampleRate to Int.

data Channels

Number of channels in the audio stream.

Instances

Eq Channels

Ord Channels

Show Channels

mkChannels :: Int -> Maybe Channels

Construction of Channels values, non-positive values result in Nothing.

getChannels :: Channels -> Int

Convert Channels to Int.

data FileType

Types of files TagLib can work with. This may be used to explicitly specify type of file rather than relying on TagLib ability to guess type of file from its extension.

Constructors

MPEG

OggVorbis

FLAC

MPC

OggFlac

WavPack

Speex

TrueAudio

MP4

ASF

Instances

Enum FileType

Eq FileType

Show FileType

data ID3v2Encoding

Encoding for ID3v2 frames that are written to tags.

Constructors

ID3v2Latin1

ID3v2UTF16

ID3v2UTF16BE

ID3v2UTF8

Instances

Enum ID3v2Encoding

Eq ID3v2Encoding

Show ID3v2Encoding

data HTagLibException

The data type represents exceptions specific to the library. The following constructors are defined:

• OpeningFailed means that attempt to open audio file to read its tags failed.
• InvalidFile means that file can be opened, but it doesn't contain any information that can be interpreted by the library.
• SavingFailed is thrown when well… saving failed.

Constructors

OpeningFailed FilePath

InvalidFile FilePath

SavingFailed FilePath

Instances

Eq HTagLibException

Show HTagLibException

Exception HTagLibException

Getters

data TagGetter a

This type represents composable entity that can be used with getTags or getTags' functions to read batch of meta parameters.

Instances

Functor TagGetter

Applicative TagGetter

getTags

Arguments

:: FilePath

Path to audio file

-> TagGetter a

Getter

-> IO a

Extracted data

getTags path g will try to read file located at path and read meta data of the file using getter g. Type of file will be guessed from its extension. If this is not satisfactory and you want to explicitly specify file type, see getTags' variation of this function.

In case of trouble HTagLibException will be thrown.

getTags'

Arguments

:: FilePath

Path to audio file

-> FileType

Type of audio file

-> TagGetter a

Getter

-> IO a

Extracted data

This is essentially the same as getTags, but allows to explicitly choose file type (see FileType).

titleGetter :: TagGetter Title

Getter to retrieve track title.

artistGetter :: TagGetter Artist

Getter to retrieve track artist.

albumGetter :: TagGetter Album

Getter to retrieve track album.

commentGetter :: TagGetter Comment

Getter to retrieve track comment.

genreGetter :: TagGetter Genre

Getter to retrieve genre of the track.

yearGetter :: TagGetter (Maybe Year)

Getter to retrieve year to the track (returns Nothing if the data is missing).

trackNumberGetter :: TagGetter (Maybe TrackNumber)

Getter to retrieve track number (returns Nothing if the data is missing).

durationGetter :: TagGetter Duration

Getter to retrieve duration in seconds.

bitRateGetter :: TagGetter BitRate

Getter to retrieve bit rate.

sampleRateGetter :: TagGetter SampleRate

Getter to retrieve sample rate.

channelsGetter :: TagGetter Channels

Getter to retrieve number of channels in audio data.

Setters

data TagSetter

Composable entity that can be used together with setTags or setTags' to write meta data to audio file.

Instances

Monoid TagSetter

setTags

Arguments

:: FilePath

Path to audio file

-> Maybe ID3v2Encoding

Encoding for ID3v2 frames

-> TagSetter

Setter

-> IO ()

Set tags in specified file using given setter.

In case of trouble HTagLibException will be thrown.

setTags'

Arguments

:: FilePath

Path to audio file

-> Maybe ID3v2Encoding

Encoding for ID3v2 frames

-> FileType

Type of audio file

-> TagSetter

Setter

-> IO ()

Similar to setTags, but you can also specify type of audio file explicitly (otherwise it's guessed from file extension).

titleSetter :: Title -> TagSetter

Setter for track title.

artistSetter :: Artist -> TagSetter

Setter for track artist.

albumSetter :: Album -> TagSetter

Setter for track album.

commentSetter :: Comment -> TagSetter

Setter for track comment.

genreSetter :: Genre -> TagSetter

Setter for track genre.

yearSetter :: Maybe Year -> TagSetter

Setter for year tag, use Nothing to clear the field.

trackNumberSetter :: Maybe TrackNumber -> TagSetter

Setter for track number, use Nothing to clear the field.