Safe Haskell	None
Language	Haskell2010

Monatone.Metadata

Description

Main module for audio metadata parsing and representation.

This module provides the core types and functions for working with audio metadata across different formats (FLAC, MP3, OGG/Vorbis, Opus).

Synopsis

data AudioFormat
- = FLAC
- | OGG
- | Opus
- | MP3
- | M4A
data Codec
- = CodecFLAC
- | CodecMP3
- | CodecVorbis
- | CodecOpus
- | CodecAAC
- | CodecALAC
data Metadata = Metadata {
- format :: AudioFormat
- title :: Maybe Text
- artist :: Maybe Text
- album :: Maybe Text
- albumArtist :: Maybe Text
- trackNumber :: Maybe Int
- totalTracks :: Maybe Int
- discNumber :: Maybe Int
- totalDiscs :: Maybe Int
- date :: Maybe Text
- year :: Maybe Int
- genre :: Maybe Text
- publisher :: Maybe Text
- comment :: Maybe Text
- releaseCountry :: Maybe Text
- recordLabel :: Maybe Text
- catalogNumber :: Maybe Text
- barcode :: Maybe Text
- releaseStatus :: Maybe Text
- releaseType :: Maybe Text
- albumArtInfo :: Maybe AlbumArtInfo
- audioProperties :: AudioProperties
- musicBrainzIds :: MusicBrainzIds
- acoustidFingerprint :: Maybe Text
- acoustidId :: Maybe Text
- rawTags :: HashMap Text [Text]
}
data AudioProperties = AudioProperties {
- duration :: Maybe Int
- bitrate :: Maybe Int
- sampleRate :: Maybe Int
- channels :: Maybe Int
- bitsPerSample :: Maybe Int
- codec :: Maybe Codec
}
data MusicBrainzIds = MusicBrainzIds {
- mbRecordingId :: Maybe Text
- mbTrackId :: Maybe Text
- mbReleaseId :: Maybe Text
- mbArtistId :: Maybe Text
- mbAlbumArtistId :: Maybe Text
- mbReleaseGroupId :: Maybe Text
- mbWorkId :: Maybe Text
- mbDiscId :: Maybe Text
}
data AlbumArtInfo = AlbumArtInfo {
- albumArtInfoMimeType :: Text
- albumArtInfoPictureType :: Word8
- albumArtInfoDescription :: Text
- albumArtInfoSizeBytes :: Int
}
data AlbumArt = AlbumArt {
- albumArtMimeType :: Text
- albumArtPictureType :: Word8
- albumArtDescription :: Text
- albumArtData :: ByteString
}
data AlbumArtUpdate
- = KeepExistingArt
- | SetAlbumArt AlbumArt
- | RemoveAlbumArt
emptyMetadata :: AudioFormat -> Metadata
emptyAudioProperties :: AudioProperties
emptyMusicBrainzIds :: MusicBrainzIds

Documentation

data AudioFormat Source #

Supported audio formats

Constructors

FLAC
OGG
Opus
MP3
M4A

Instances

Instances details

FromJSON AudioFormat Source #
Instance details Defined in Monatone.Metadata Methods parseJSON :: Value -> Parser AudioFormat # parseJSONList :: Value -> Parser [AudioFormat] # omittedField :: Maybe AudioFormat #
ToJSON AudioFormat Source #
Instance details Defined in Monatone.Metadata Methods toJSON :: AudioFormat -> Value # toEncoding :: AudioFormat -> Encoding # toJSONList :: [AudioFormat] -> Value # toEncodingList :: [AudioFormat] -> Encoding # omitField :: AudioFormat -> Bool #
Read AudioFormat Source #
Instance details Defined in Monatone.Metadata Methods readsPrec :: Int -> ReadS AudioFormat # readList :: ReadS [AudioFormat] # readPrec :: ReadPrec AudioFormat # readListPrec :: ReadPrec [AudioFormat] #
Show AudioFormat Source #
Instance details Defined in Monatone.Metadata Methods showsPrec :: Int -> AudioFormat -> ShowS # show :: AudioFormat -> String # showList :: [AudioFormat] -> ShowS #
Eq AudioFormat Source #
Instance details Defined in Monatone.Metadata Methods (==) :: AudioFormat -> AudioFormat -> Bool # (/=) :: AudioFormat -> AudioFormat -> Bool #
Ord AudioFormat Source #
Instance details Defined in Monatone.Metadata Methods compare :: AudioFormat -> AudioFormat -> Ordering # (<) :: AudioFormat -> AudioFormat -> Bool # (<=) :: AudioFormat -> AudioFormat -> Bool # (>) :: AudioFormat -> AudioFormat -> Bool # (>=) :: AudioFormat -> AudioFormat -> Bool # max :: AudioFormat -> AudioFormat -> AudioFormat # min :: AudioFormat -> AudioFormat -> AudioFormat #

data Codec Source #

Audio codec — the actual compression scheme, distinct from the container format (AudioFormat). A single container can carry different codecs (e.g. M4A holds either AAC or ALAC).

Constructors

CodecFLAC	FLAC lossless
CodecMP3	MPEG-1/2 Audio Layer III (lossy)
CodecVorbis	Ogg Vorbis (lossy)
CodecOpus	Opus (lossy)
CodecAAC	Advanced Audio Coding (lossy)
CodecALAC	Apple Lossless

Instances

Instances details

FromJSON Codec Source #
Instance details Defined in Monatone.Metadata Methods parseJSON :: Value -> Parser Codec # parseJSONList :: Value -> Parser [Codec] # omittedField :: Maybe Codec #
ToJSON Codec Source #
Instance details Defined in Monatone.Metadata Methods toJSON :: Codec -> Value # toEncoding :: Codec -> Encoding # toJSONList :: [Codec] -> Value # toEncodingList :: [Codec] -> Encoding # omitField :: Codec -> Bool #
Read Codec Source #
Instance details Defined in Monatone.Metadata Methods readsPrec :: Int -> ReadS Codec # readList :: ReadS [Codec] # readPrec :: ReadPrec Codec # readListPrec :: ReadPrec [Codec] #
Show Codec Source #
Instance details Defined in Monatone.Metadata Methods showsPrec :: Int -> Codec -> ShowS # show :: Codec -> String # showList :: [Codec] -> ShowS #
Eq Codec Source #
Instance details Defined in Monatone.Metadata Methods (==) :: Codec -> Codec -> Bool # (/=) :: Codec -> Codec -> Bool #
Ord Codec Source #
Instance details Defined in Monatone.Metadata Methods compare :: Codec -> Codec -> Ordering # (<) :: Codec -> Codec -> Bool # (<=) :: Codec -> Codec -> Bool # (>) :: Codec -> Codec -> Bool # (>=) :: Codec -> Codec -> Bool # max :: Codec -> Codec -> Codec # min :: Codec -> Codec -> Codec #

data Metadata Source #

Complete metadata for an audio file

Constructors

Metadata

Fields

Instances

Instances details

Show Metadata Source #
Instance details Defined in Monatone.Metadata Methods showsPrec :: Int -> Metadata -> ShowS # show :: Metadata -> String # showList :: [Metadata] -> ShowS #
Eq Metadata Source #
Instance details Defined in Monatone.Metadata Methods (==) :: Metadata -> Metadata -> Bool # (/=) :: Metadata -> Metadata -> Bool #

data AudioProperties Source #

Audio file properties

Constructors

AudioProperties
Fields duration :: Maybe Int bitrate :: Maybe Int sampleRate :: Maybe Int channels :: Maybe Int bitsPerSample :: Maybe Int codec :: Maybe Codec

Instances

Instances details

Show AudioProperties Source #
Instance details Defined in Monatone.Metadata Methods showsPrec :: Int -> AudioProperties -> ShowS # show :: AudioProperties -> String # showList :: [AudioProperties] -> ShowS #
Eq AudioProperties Source #
Instance details Defined in Monatone.Metadata Methods (==) :: AudioProperties -> AudioProperties -> Bool # (/=) :: AudioProperties -> AudioProperties -> Bool #

data MusicBrainzIds Source #

MusicBrainz identifiers

Constructors

MusicBrainzIds
Fields mbRecordingId :: Maybe Text mbTrackId :: Maybe Text mbReleaseId :: Maybe Text mbArtistId :: Maybe Text mbAlbumArtistId :: Maybe Text mbReleaseGroupId :: Maybe Text mbWorkId :: Maybe Text mbDiscId :: Maybe Text

Instances

Instances details

Show MusicBrainzIds Source #
Instance details Defined in Monatone.Metadata Methods showsPrec :: Int -> MusicBrainzIds -> ShowS # show :: MusicBrainzIds -> String # showList :: [MusicBrainzIds] -> ShowS #
Eq MusicBrainzIds Source #
Instance details Defined in Monatone.Metadata Methods (==) :: MusicBrainzIds -> MusicBrainzIds -> Bool # (/=) :: MusicBrainzIds -> MusicBrainzIds -> Bool #

data AlbumArtInfo Source #

Album art metadata without binary data (lightweight for scanning)

Constructors

AlbumArtInfo
Fields albumArtInfoMimeType :: Text albumArtInfoPictureType :: Word8 albumArtInfoDescription :: Text albumArtInfoSizeBytes :: Int

Instances

Instances details

Show AlbumArtInfo Source #
Instance details Defined in Monatone.Metadata Methods showsPrec :: Int -> AlbumArtInfo -> ShowS # show :: AlbumArtInfo -> String # showList :: [AlbumArtInfo] -> ShowS #
Eq AlbumArtInfo Source #
Instance details Defined in Monatone.Metadata Methods (==) :: AlbumArtInfo -> AlbumArtInfo -> Bool # (/=) :: AlbumArtInfo -> AlbumArtInfo -> Bool #

data AlbumArt Source #

Album art / attached picture (includes full binary data)

Constructors

AlbumArt
Fields albumArtMimeType :: Text albumArtPictureType :: Word8 albumArtDescription :: Text albumArtData :: ByteString

Instances

Instances details

Show AlbumArt Source #
Instance details Defined in Monatone.Metadata Methods showsPrec :: Int -> AlbumArt -> ShowS # show :: AlbumArt -> String # showList :: [AlbumArt] -> ShowS #
Eq AlbumArt Source #
Instance details Defined in Monatone.Metadata Methods (==) :: AlbumArt -> AlbumArt -> Bool # (/=) :: AlbumArt -> AlbumArt -> Bool #

data AlbumArtUpdate Source #

How a write should treat embedded album art

Constructors

KeepExistingArt	carry any existing art through unchanged (including multiple pictures, verbatim)
SetAlbumArt AlbumArt	replace all existing art with this picture
RemoveAlbumArt	strip all embedded art

Instances

Instances details

Show AlbumArtUpdate Source #
Instance details Defined in Monatone.Metadata Methods showsPrec :: Int -> AlbumArtUpdate -> ShowS # show :: AlbumArtUpdate -> String # showList :: [AlbumArtUpdate] -> ShowS #
Eq AlbumArtUpdate Source #
Instance details Defined in Monatone.Metadata Methods (==) :: AlbumArtUpdate -> AlbumArtUpdate -> Bool # (/=) :: AlbumArtUpdate -> AlbumArtUpdate -> Bool #

emptyMetadata :: AudioFormat -> Metadata Source #

Empty metadata with only format specified

emptyAudioProperties :: AudioProperties Source #

Empty audio properties

emptyMusicBrainzIds :: MusicBrainzIds Source #

Empty MusicBrainz IDs