Codec.Audio.FLAC.Metadata

The module provides a complete high-level Haskell API to manipulate FLAC metadata.

How to use this module

Just like the other modules of this library, the API is file-centered—no streaming support is available at this time (in libFLAC as well). Retrieving and editing metadata information is very easy, you only need three functions: runFlacMeta, retrieve, and (=->).

Here is how to get sample rate and artist name and print them:

import Codec.Audio.FLAC.Metadata
import Control.Monad.IO.Class (MonadIO (..))
import Data.Default.Class

main :: IO ()
main = runFlacMeta def "/path/to/my/file.flac" $ do
  retrieve SampleRate             >>= liftIO . print
  retrieve (VorbisComment Artist) >>= liftIO . print

Normally you would just return them packed in a tuple from the monad, of course. We print the values just for a demonstration.

The next example shows how to set a couple of tags:

import Codec.Audio.FLAC.Metadata
import Data.Default.Class

main :: IO ()
main = runFlacMeta def "/path/to/my/file.flac" $ do
  VorbisComment Artist =-> Just "Alexander Scriabin"
  VorbisComment Title  =-> Just "Sonata №9 “Black Mass”, Op. 68"
  VorbisComment Date   =-> Nothing

Here we write two tags using the (=->) operator and delete the VorbisComment Date metadata attribute by setting it to Nothing. Note that not all attributes are writable, so we cannot set things like SampleRate. In fact, the type system mechanics used in the library prevent this.

Low-level details

The implementation uses the reference implementation of FLAC—libFLAC (C library) under the hood. This means you'll need at least version 1.3.0 of libFLAC (released 26 May 2013) installed for the binding to work.

This module in particular uses the level 2 metadata interface and it's not possible to choose other interface (such as level 0 and 1). However, this should not be of any concern to the end-user, as the level 2 supports more functionality than the other levels.

Metadata manipulation API

data FlacMeta a

An opaque monad for reading and writing of FLAC metadata. The monad is the home for retrieve and (=->) functions and can be run with runFlacMeta.

Instances

Monad FlacMeta

Defined in Codec.Audio.FLAC.Metadata

Methods

(>>=) :: FlacMeta a -> (a -> FlacMeta b) -> FlacMeta b

(>>) :: FlacMeta a -> FlacMeta b -> FlacMeta b

return :: a -> FlacMeta a

Functor FlacMeta

Defined in Codec.Audio.FLAC.Metadata

Methods

fmap :: (a -> b) -> FlacMeta a -> FlacMeta b

(<$) :: a -> FlacMeta b -> FlacMeta a

Applicative FlacMeta

Defined in Codec.Audio.FLAC.Metadata

Methods

pure :: a -> FlacMeta a

(<*>) :: FlacMeta (a -> b) -> FlacMeta a -> FlacMeta b

liftA2 :: (a -> b -> c) -> FlacMeta a -> FlacMeta b -> FlacMeta c

(*>) :: FlacMeta a -> FlacMeta b -> FlacMeta b

(<*) :: FlacMeta a -> FlacMeta b -> FlacMeta a

MonadIO FlacMeta

Defined in Codec.Audio.FLAC.Metadata

Methods

liftIO :: IO a -> FlacMeta a

MonadCatch FlacMeta

Defined in Codec.Audio.FLAC.Metadata

Methods

catch :: Exception e => FlacMeta a -> (e -> FlacMeta a) -> FlacMeta a

MonadMask FlacMeta

Defined in Codec.Audio.FLAC.Metadata

Methods

mask :: ((forall a. FlacMeta a -> FlacMeta a) -> FlacMeta b) -> FlacMeta b

uninterruptibleMask :: ((forall a. FlacMeta a -> FlacMeta a) -> FlacMeta b) -> FlacMeta b

generalBracket :: FlacMeta a -> (a -> ExitCase b -> FlacMeta c) -> (a -> FlacMeta b) -> FlacMeta (b, c)

MonadThrow FlacMeta

Defined in Codec.Audio.FLAC.Metadata

Methods

throwM :: Exception e => e -> FlacMeta a

data MetaSettings

Settings that control how metadata is written in FLAC file.

Constructors

MetaSettings

Fields

• metaAutoVacuum :: !Bool

  Whether to traverse all metadata blocks just before padding sorting (if enabled, see metaSortPadding) and writing data to a file, deleting all metadata blocks that appear to be empty, e.g. vorbis comment block without any comments (tags) in it. Default value: True.

• metaSortPadding :: !Bool

  Whether to attempt to sort and consolidate all padding at the end of metadata section. The main purpose of this is that the padding can be truncated if necessary to get more space so we can overwrite metadata blocks in place instead of overwriting the entire FLAC file. Default value: True.

• metaUsePadding :: !Bool

  This setting enables truncation of last padding metadata block if it allows to overwrite metadata in place instead of overwriting the entire file. Default value: True.

• metaPreserveFileStats :: !Bool

  If True, the owner and modification time will be preserved even if a new FLAC file is written (this is for the cases when we need to write entire FLAC file and thus a copy of the file is written). Default value: True.

Instances

Eq MetaSettings

Defined in Codec.Audio.FLAC.Metadata

Methods

(==) :: MetaSettings -> MetaSettings -> Bool

(/=) :: MetaSettings -> MetaSettings -> Bool

Ord MetaSettings

Defined in Codec.Audio.FLAC.Metadata

Methods

compare :: MetaSettings -> MetaSettings -> Ordering

(<) :: MetaSettings -> MetaSettings -> Bool

(<=) :: MetaSettings -> MetaSettings -> Bool

(>) :: MetaSettings -> MetaSettings -> Bool

(>=) :: MetaSettings -> MetaSettings -> Bool

max :: MetaSettings -> MetaSettings -> MetaSettings

min :: MetaSettings -> MetaSettings -> MetaSettings

Read MetaSettings

Defined in Codec.Audio.FLAC.Metadata

Methods

readsPrec :: Int -> ReadS MetaSettings

readList :: ReadS [MetaSettings]

readPrec :: ReadPrec MetaSettings

readListPrec :: ReadPrec [MetaSettings]

Show MetaSettings

Defined in Codec.Audio.FLAC.Metadata

Methods

showsPrec :: Int -> MetaSettings -> ShowS

show :: MetaSettings -> String

showList :: [MetaSettings] -> ShowS

defaultMetaSettings :: MetaSettings

Default MetaSettings.

Since: 0.2.0

data MetaException

The exception that is thrown when manipulation of FLAC metadata fails for some reason.

Constructors

MetaGeneralProblem MetaChainStatus

General failure, see the attached MetaChainStatus.

MetaInvalidSeekTable

Invalid seek table was passed to be written.

MetaInvalidCueSheet Text

Invalid CUE sheet was passed to be written. The reason why the data was invalid is attached.

MetaInvalidPicture Text

Invalid picture data was passed to be written. The reason why the data was invalid is attached.

Instances

Eq MetaException

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

(==) :: MetaException -> MetaException -> Bool

(/=) :: MetaException -> MetaException -> Bool

Read MetaException

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

readsPrec :: Int -> ReadS MetaException

readList :: ReadS [MetaException]

readPrec :: ReadPrec MetaException

readListPrec :: ReadPrec [MetaException]

Show MetaException

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

showsPrec :: Int -> MetaException -> ShowS

show :: MetaException -> String

showList :: [MetaException] -> ShowS

Exception MetaException

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

toException :: MetaException -> SomeException

fromException :: SomeException -> Maybe MetaException

displayException :: MetaException -> String

data MetaChainStatus

Enumeration of meta chain statuses.

Constructors

MetaChainStatusOK

The chain is in the normal OK state.

MetaChainStatusIllegalInput

The data passed into a function violated the function's usage criteria.

MetaChainStatusErrorOpeningFile

The chain could not open the target file.

MetaChainStatusNotFlacFile

The chain could not find the FLAC signature at the start of the file.

MetaChainStatusNotWritable

The chain tried to write to a file that was not writable.

MetaChainStatusBadMetadata

The chain encountered input that does not conform to the FLAC metadata specification.

MetaChainStatusReadError

The chain encountered an error while reading the FLAC file.

MetaChainStatusSeekError

The chain encountered an error while seeking in the FLAC file.

MetaChainStatusWriteError

The chain encountered an error while writing the FLAC file.

MetaChainStatusRenameError

The chain encountered an error renaming the FLAC file.

MetaChainStatusUnlinkError

The chain encountered an error removing the temporary file.

MetaChainStatusMemoryAllocationError

Memory allocation failed.

MetaChainStatusInternalError

The caller violated an assertion or an unexpected error occurred.

MetaChainStatusInvalidCallbacks

One or more of the required callbacks was NULL.

MetaChainStatusReadWriteMismatch

This error occurs when read and write methods do not match (i.e. when if you read with callbacks, you should also use function that writes with callbacks).

MetaChainStatusWrongWriteCall

Should not ever happen when you use this binding.

Instances

Bounded MetaChainStatus

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

minBound :: MetaChainStatus

maxBound :: MetaChainStatus

Enum MetaChainStatus

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

succ :: MetaChainStatus -> MetaChainStatus

pred :: MetaChainStatus -> MetaChainStatus

toEnum :: Int -> MetaChainStatus

fromEnum :: MetaChainStatus -> Int

enumFrom :: MetaChainStatus -> [MetaChainStatus]

enumFromThen :: MetaChainStatus -> MetaChainStatus -> [MetaChainStatus]

enumFromTo :: MetaChainStatus -> MetaChainStatus -> [MetaChainStatus]

enumFromThenTo :: MetaChainStatus -> MetaChainStatus -> MetaChainStatus -> [MetaChainStatus]

Eq MetaChainStatus

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

(==) :: MetaChainStatus -> MetaChainStatus -> Bool

(/=) :: MetaChainStatus -> MetaChainStatus -> Bool

Ord MetaChainStatus

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

compare :: MetaChainStatus -> MetaChainStatus -> Ordering

(<) :: MetaChainStatus -> MetaChainStatus -> Bool

(<=) :: MetaChainStatus -> MetaChainStatus -> Bool

(>) :: MetaChainStatus -> MetaChainStatus -> Bool

(>=) :: MetaChainStatus -> MetaChainStatus -> Bool

max :: MetaChainStatus -> MetaChainStatus -> MetaChainStatus

min :: MetaChainStatus -> MetaChainStatus -> MetaChainStatus

Read MetaChainStatus

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

readsPrec :: Int -> ReadS MetaChainStatus

readList :: ReadS [MetaChainStatus]

readPrec :: ReadPrec MetaChainStatus

readListPrec :: ReadPrec [MetaChainStatus]

Show MetaChainStatus

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

showsPrec :: Int -> MetaChainStatus -> ShowS

show :: MetaChainStatus -> String

showList :: [MetaChainStatus] -> ShowS

runFlacMeta

Arguments

:: MonadIO m

=> MetaSettings

Settings to use

-> FilePath

File to operate on

-> FlacMeta a

Actions to perform

-> m a

The result

Run an action that manipulates FLAC metadata. MetaSettings control subtle and rather low-level details of metadata editing, just pass def unless you know what you are doing. FilePath specifies location of FLAC file to read/edit in the file system. FlacMeta is a monadic action that describes what to do with the metadata. Compose it from retrieve and (=->).

The action will throw UnicodeException if the text data like Vorbis Comment entries cannot be read as a UTF-8-encoded value.

If a problem occurs, MetaException is thrown with attached MetaChainStatus that should help investigating what went wrong.

Meta values

class MetaValue a where

A class for the types that specify which metadata attributes to read/write. It's not expected that users of the library will define new metadata attributes other than via combination of the existing ones, which is also useful. For example, Duration and BitRate are not read from FLAC file metadata directly, but defined in terms of other attributes.

Minimal complete definition

retrieve

Associated Types

type MetaType a :: Type

Type of data that corresponds to this metadata value. For example SampleRate is represented by Word32 value in this library, and so MetaType SampleRate ~ Word32.

type MetaWritable a :: Constraint

Associated type of the kind Constraint that controls whether a particular piece of metadata is writable or not.

Methods

retrieve :: a -> FlacMeta (MetaType a)

Given value that determines what to read, read it and return. Some metadata may be missing, in that case the function typically returns a value wrapped in Maybe.

(=->) :: MetaWritable a => a -> MetaType a -> FlacMeta () infix 1

Given a value that determines what to write and a value to write, add/replace a piece of metadata information. This is how you edit metadata. To delete something, set it to Nothing (well, it should be something that can be missing, for example you cannot delete the SampleRate attribute). If MetaWritable is defined, this method must be defined as well.

Instances

MetaValue Picture

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType Picture

type MetaWritable Picture

Methods

retrieve :: Picture -> FlacMeta (MetaType Picture)

(=->) :: Picture -> MetaType Picture -> FlacMeta ()

MetaValue CueSheet

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType CueSheet

type MetaWritable CueSheet

Methods

retrieve :: CueSheet -> FlacMeta (MetaType CueSheet)

(=->) :: CueSheet -> MetaType CueSheet -> FlacMeta ()

MetaValue VorbisComment

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType VorbisComment

type MetaWritable VorbisComment

Methods

retrieve :: VorbisComment -> FlacMeta (MetaType VorbisComment)

(=->) :: VorbisComment -> MetaType VorbisComment -> FlacMeta ()

MetaValue VorbisVendor

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType VorbisVendor

type MetaWritable VorbisVendor

Methods

retrieve :: VorbisVendor -> FlacMeta (MetaType VorbisVendor)

(=->) :: VorbisVendor -> MetaType VorbisVendor -> FlacMeta ()

MetaValue SeekTable

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType SeekTable

type MetaWritable SeekTable

Methods

retrieve :: SeekTable -> FlacMeta (MetaType SeekTable)

(=->) :: SeekTable -> MetaType SeekTable -> FlacMeta ()

MetaValue Application

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType Application

type MetaWritable Application

Methods

retrieve :: Application -> FlacMeta (MetaType Application)

(=->) :: Application -> MetaType Application -> FlacMeta ()

MetaValue Duration

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType Duration

type MetaWritable Duration

Methods

retrieve :: Duration -> FlacMeta (MetaType Duration)

(=->) :: Duration -> MetaType Duration -> FlacMeta ()

MetaValue MD5Sum

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType MD5Sum

type MetaWritable MD5Sum

Methods

retrieve :: MD5Sum -> FlacMeta (MetaType MD5Sum)

(=->) :: MD5Sum -> MetaType MD5Sum -> FlacMeta ()

MetaValue BitRate

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType BitRate

type MetaWritable BitRate

Methods

retrieve :: BitRate -> FlacMeta (MetaType BitRate)

(=->) :: BitRate -> MetaType BitRate -> FlacMeta ()

MetaValue FileSize

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType FileSize

type MetaWritable FileSize

Methods

retrieve :: FileSize -> FlacMeta (MetaType FileSize)

(=->) :: FileSize -> MetaType FileSize -> FlacMeta ()

MetaValue TotalSamples

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType TotalSamples

type MetaWritable TotalSamples

Methods

retrieve :: TotalSamples -> FlacMeta (MetaType TotalSamples)

(=->) :: TotalSamples -> MetaType TotalSamples -> FlacMeta ()

MetaValue BitsPerSample

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType BitsPerSample

type MetaWritable BitsPerSample

Methods

retrieve :: BitsPerSample -> FlacMeta (MetaType BitsPerSample)

(=->) :: BitsPerSample -> MetaType BitsPerSample -> FlacMeta ()

MetaValue ChannelMask

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType ChannelMask

type MetaWritable ChannelMask

Methods

retrieve :: ChannelMask -> FlacMeta (MetaType ChannelMask)

(=->) :: ChannelMask -> MetaType ChannelMask -> FlacMeta ()

MetaValue Channels

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType Channels

type MetaWritable Channels

Methods

retrieve :: Channels -> FlacMeta (MetaType Channels)

(=->) :: Channels -> MetaType Channels -> FlacMeta ()

MetaValue SampleRate

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType SampleRate

type MetaWritable SampleRate

Methods

retrieve :: SampleRate -> FlacMeta (MetaType SampleRate)

(=->) :: SampleRate -> MetaType SampleRate -> FlacMeta ()

MetaValue MaxFrameSize

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType MaxFrameSize

type MetaWritable MaxFrameSize

Methods

retrieve :: MaxFrameSize -> FlacMeta (MetaType MaxFrameSize)

(=->) :: MaxFrameSize -> MetaType MaxFrameSize -> FlacMeta ()

MetaValue MinFrameSize

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType MinFrameSize

type MetaWritable MinFrameSize

Methods

retrieve :: MinFrameSize -> FlacMeta (MetaType MinFrameSize)

(=->) :: MinFrameSize -> MetaType MinFrameSize -> FlacMeta ()

MetaValue MaxBlockSize

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType MaxBlockSize

type MetaWritable MaxBlockSize

Methods

retrieve :: MaxBlockSize -> FlacMeta (MetaType MaxBlockSize)

(=->) :: MaxBlockSize -> MetaType MaxBlockSize -> FlacMeta ()

MetaValue MinBlockSize

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType MinBlockSize

type MetaWritable MinBlockSize

Methods

retrieve :: MinBlockSize -> FlacMeta (MetaType MinBlockSize)

(=->) :: MinBlockSize -> MetaType MinBlockSize -> FlacMeta ()

data MinBlockSize

Minimal block size in samples used in the stream.

Read-only attribute represented as a Word32.

Constructors

MinBlockSize

Instances

MetaValue MinBlockSize

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType MinBlockSize

type MetaWritable MinBlockSize

Methods

retrieve :: MinBlockSize -> FlacMeta (MetaType MinBlockSize)

(=->) :: MinBlockSize -> MetaType MinBlockSize -> FlacMeta ()

type MetaType MinBlockSize

Defined in Codec.Audio.FLAC.Metadata

type MetaType MinBlockSize = Word32

type MetaWritable MinBlockSize

Defined in Codec.Audio.FLAC.Metadata

type MetaWritable MinBlockSize

data MaxBlockSize

Maximal block size in samples used in the stream. Equality of minimum block size and maximum block size implies a fixed-blocksize stream.

Read-only attribute represented as a Word32.

Constructors

MaxBlockSize

Instances

MetaValue MaxBlockSize

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType MaxBlockSize

type MetaWritable MaxBlockSize

Methods

retrieve :: MaxBlockSize -> FlacMeta (MetaType MaxBlockSize)

(=->) :: MaxBlockSize -> MetaType MaxBlockSize -> FlacMeta ()

type MetaType MaxBlockSize

Defined in Codec.Audio.FLAC.Metadata

type MetaType MaxBlockSize = Word32

type MetaWritable MaxBlockSize

Defined in Codec.Audio.FLAC.Metadata

type MetaWritable MaxBlockSize

data MinFrameSize

Minimal frame size in bytes used in the stream. May be 0 to imply the value is not known.

Read-only attribute represented as a Word32.

Constructors

MinFrameSize

Instances

MetaValue MinFrameSize

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType MinFrameSize

type MetaWritable MinFrameSize

Methods

retrieve :: MinFrameSize -> FlacMeta (MetaType MinFrameSize)

(=->) :: MinFrameSize -> MetaType MinFrameSize -> FlacMeta ()

type MetaType MinFrameSize

Defined in Codec.Audio.FLAC.Metadata

type MetaType MinFrameSize = Word32

type MetaWritable MinFrameSize

Defined in Codec.Audio.FLAC.Metadata

type MetaWritable MinFrameSize

data MaxFrameSize

Maximal frame size in bytes used in the stream. May be 0 to imply the value is not known.

Read-only attribute represented as a Word32.

Constructors

MaxFrameSize

Instances

MetaValue MaxFrameSize

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType MaxFrameSize

type MetaWritable MaxFrameSize

Methods

retrieve :: MaxFrameSize -> FlacMeta (MetaType MaxFrameSize)

(=->) :: MaxFrameSize -> MetaType MaxFrameSize -> FlacMeta ()

type MetaType MaxFrameSize

Defined in Codec.Audio.FLAC.Metadata

type MetaType MaxFrameSize = Word32

type MetaWritable MaxFrameSize

Defined in Codec.Audio.FLAC.Metadata

type MetaWritable MaxFrameSize

data SampleRate

Sample rate in Hz.

Read-only attribute represented as a Word32.

Constructors

SampleRate

Instances

MetaValue SampleRate

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType SampleRate

type MetaWritable SampleRate

Methods

retrieve :: SampleRate -> FlacMeta (MetaType SampleRate)

(=->) :: SampleRate -> MetaType SampleRate -> FlacMeta ()

type MetaType SampleRate

Defined in Codec.Audio.FLAC.Metadata

type MetaType SampleRate = Word32

type MetaWritable SampleRate

Defined in Codec.Audio.FLAC.Metadata

type MetaWritable SampleRate

data Channels

Number of channels. FLAC supports from 1 to 8 channels.

Read-only attribute represented as a Word32.

Constructors

Channels

Instances

MetaValue Channels

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType Channels

type MetaWritable Channels

Methods

retrieve :: Channels -> FlacMeta (MetaType Channels)

(=->) :: Channels -> MetaType Channels -> FlacMeta ()

type MetaType Channels

Defined in Codec.Audio.FLAC.Metadata

type MetaType Channels = Word32

type MetaWritable Channels

Defined in Codec.Audio.FLAC.Metadata

type MetaWritable Channels

data ChannelMask

Channel mask specifying which speaker positions are present. This is inferred from number of channels using channel assignment rules described in the FLAC specification.

Read-only attribute represented as Set SpeakerPosition.

Constructors

ChannelMask

Instances

MetaValue ChannelMask

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType ChannelMask

type MetaWritable ChannelMask

Methods

retrieve :: ChannelMask -> FlacMeta (MetaType ChannelMask)

(=->) :: ChannelMask -> MetaType ChannelMask -> FlacMeta ()

type MetaType ChannelMask

Defined in Codec.Audio.FLAC.Metadata

type MetaType ChannelMask = Set SpeakerPosition

type MetaWritable ChannelMask

Defined in Codec.Audio.FLAC.Metadata

type MetaWritable ChannelMask

data BitsPerSample

Bits per sample (sample depth). FLAC supports from 4 to 32 bits per sample. Currently the reference encoder and decoder only support up to 24 bits per sample.

Read-only attribute represented as a Word32.

Constructors

BitsPerSample

Instances

MetaValue BitsPerSample

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType BitsPerSample

type MetaWritable BitsPerSample

Methods

retrieve :: BitsPerSample -> FlacMeta (MetaType BitsPerSample)

(=->) :: BitsPerSample -> MetaType BitsPerSample -> FlacMeta ()

type MetaType BitsPerSample

Defined in Codec.Audio.FLAC.Metadata

type MetaType BitsPerSample = Word32

type MetaWritable BitsPerSample

Defined in Codec.Audio.FLAC.Metadata

type MetaWritable BitsPerSample

data TotalSamples

Total number of samples in audio stream. “Samples” means inter-channel sample, i.e. one second of 44.1 KHz audio will have 44100 samples regardless of the number of channels. A value of zero here means the number of total samples is unknown.

Read-only attribute represented as a Word64.

Constructors

TotalSamples

Instances

MetaValue TotalSamples

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType TotalSamples

type MetaWritable TotalSamples

Methods

retrieve :: TotalSamples -> FlacMeta (MetaType TotalSamples)

(=->) :: TotalSamples -> MetaType TotalSamples -> FlacMeta ()

type MetaType TotalSamples

Defined in Codec.Audio.FLAC.Metadata

type MetaType TotalSamples = Word64

type MetaWritable TotalSamples

Defined in Codec.Audio.FLAC.Metadata

type MetaWritable TotalSamples

data FileSize

File size in bytes.

Read-only attribute represented as a Natural.

Constructors

FileSize

Instances

MetaValue FileSize

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType FileSize

type MetaWritable FileSize

Methods

retrieve :: FileSize -> FlacMeta (MetaType FileSize)

(=->) :: FileSize -> MetaType FileSize -> FlacMeta ()

type MetaType FileSize

Defined in Codec.Audio.FLAC.Metadata

type MetaType FileSize = Natural

type MetaWritable FileSize

Defined in Codec.Audio.FLAC.Metadata

type MetaWritable FileSize

data BitRate

Bit rate in kilo-bits per second (kbps).

Read-only attribute represented as a Word32.

Constructors

BitRate

Instances

MetaValue BitRate

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType BitRate

type MetaWritable BitRate

Methods

retrieve :: BitRate -> FlacMeta (MetaType BitRate)

(=->) :: BitRate -> MetaType BitRate -> FlacMeta ()

type MetaType BitRate

Defined in Codec.Audio.FLAC.Metadata

type MetaType BitRate = Word32

type MetaWritable BitRate

Defined in Codec.Audio.FLAC.Metadata

type MetaWritable BitRate

data MD5Sum

MD5 signature of the unencoded audio data. This allows the decoder to determine if an error exists in the audio data even when the error does not result in an invalid bitstream.

Read-only attribute represented as a ByteString of length 16.

Constructors

MD5Sum

Instances

MetaValue MD5Sum

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType MD5Sum

type MetaWritable MD5Sum

Methods

retrieve :: MD5Sum -> FlacMeta (MetaType MD5Sum)

(=->) :: MD5Sum -> MetaType MD5Sum -> FlacMeta ()

type MetaType MD5Sum

Defined in Codec.Audio.FLAC.Metadata

type MetaType MD5Sum = ByteString

type MetaWritable MD5Sum

Defined in Codec.Audio.FLAC.Metadata

type MetaWritable MD5Sum

data Duration

Duration in seconds.

Read-only attribute represented as a Double.

Constructors

Duration

Instances

MetaValue Duration

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType Duration

type MetaWritable Duration

Methods

retrieve :: Duration -> FlacMeta (MetaType Duration)

(=->) :: Duration -> MetaType Duration -> FlacMeta ()

type MetaType Duration

Defined in Codec.Audio.FLAC.Metadata

type MetaType Duration = Double

type MetaWritable Duration

Defined in Codec.Audio.FLAC.Metadata

type MetaWritable Duration

data Application

Application metadata. The ApplicationId argument to Application data constructor can be written using usual Haskell syntax for String literals, just make sure to enable the OverloadedStrings extension.

For the list of defined application IDs, see:

https://xiph.org/flac/id.html.

Writable optional attribute represented as a Maybe ByteString.

Constructors

Application ApplicationId

Instances

MetaValue Application

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType Application

type MetaWritable Application

Methods

retrieve :: Application -> FlacMeta (MetaType Application)

(=->) :: Application -> MetaType Application -> FlacMeta ()

type MetaType Application

Defined in Codec.Audio.FLAC.Metadata

type MetaType Application = Maybe ByteString

type MetaWritable Application

Defined in Codec.Audio.FLAC.Metadata

type MetaWritable Application = ()

data ApplicationId

A normalizing wrapper around ByteString that makes sure that the ByteString inside is a valid FLAC application name. You can create values of this type using Haskell string literals with OverloadedStrings or with the mkApplicationId smart constructor. Extract the inner ByteString with unApplicationId.

Instances

Eq ApplicationId

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

(==) :: ApplicationId -> ApplicationId -> Bool

(/=) :: ApplicationId -> ApplicationId -> Bool

Ord ApplicationId

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

compare :: ApplicationId -> ApplicationId -> Ordering

(<) :: ApplicationId -> ApplicationId -> Bool

(<=) :: ApplicationId -> ApplicationId -> Bool

(>) :: ApplicationId -> ApplicationId -> Bool

(>=) :: ApplicationId -> ApplicationId -> Bool

max :: ApplicationId -> ApplicationId -> ApplicationId

min :: ApplicationId -> ApplicationId -> ApplicationId

Show ApplicationId

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

showsPrec :: Int -> ApplicationId -> ShowS

show :: ApplicationId -> String

showList :: [ApplicationId] -> ShowS

IsString ApplicationId

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

fromString :: String -> ApplicationId

mkApplicationId :: ByteString -> ApplicationId

Application id must be four bytes long. If it's too short, null bytes will be appended to it to make it four bytes long. If it's too long, it will be truncated.

unApplicationId :: ApplicationId -> ByteString

Get ByteString from ApplicationId.

data SeekTable

Seek table as a Vector of SeekPoints. Seek points within a table must be sorted in ascending order by sample number. If you try to write an invalid seek table, MetaException will be raised using the MetaInvalidSeekTable constructor.

Writable optional attribute represented as a Maybe (Vector SeekPoint).

Constructors

SeekTable

Instances

MetaValue SeekTable

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType SeekTable

type MetaWritable SeekTable

Methods

retrieve :: SeekTable -> FlacMeta (MetaType SeekTable)

(=->) :: SeekTable -> MetaType SeekTable -> FlacMeta ()

type MetaType SeekTable

Defined in Codec.Audio.FLAC.Metadata

type MetaType SeekTable = Maybe (Vector SeekPoint)

type MetaWritable SeekTable

Defined in Codec.Audio.FLAC.Metadata

type MetaWritable SeekTable = ()

data SeekPoint

Single point in a seek table metadata block.

Constructors

SeekPoint

Fields

• seekPointSampleNumber :: !Word64

  The sample number of the target frame

• seekPointStreamOffset :: !Word64

  The offset in bytes of the target frame with respect to beginning of the first frame

• seekPointFrameSamples :: !Word32

  The number of samples in the target frame

Instances

Eq SeekPoint

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

(==) :: SeekPoint -> SeekPoint -> Bool

(/=) :: SeekPoint -> SeekPoint -> Bool

Ord SeekPoint

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

compare :: SeekPoint -> SeekPoint -> Ordering

(<) :: SeekPoint -> SeekPoint -> Bool

(<=) :: SeekPoint -> SeekPoint -> Bool

(>) :: SeekPoint -> SeekPoint -> Bool

(>=) :: SeekPoint -> SeekPoint -> Bool

max :: SeekPoint -> SeekPoint -> SeekPoint

min :: SeekPoint -> SeekPoint -> SeekPoint

Read SeekPoint

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

readsPrec :: Int -> ReadS SeekPoint

readList :: ReadS [SeekPoint]

readPrec :: ReadPrec SeekPoint

readListPrec :: ReadPrec [SeekPoint]

Show SeekPoint

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

showsPrec :: Int -> SeekPoint -> ShowS

show :: SeekPoint -> String

showList :: [SeekPoint] -> ShowS

data VorbisVendor

Vorbis “vendor” comment. When “Vorbis Comment” metadata block is present, the “vendor” entry is always in there, so when you delete it (by VorbisVendor =-> Nothing), you really set it to an empty string (which is enough to trigger auto vacuum feature if no other entries are detected, see metaAutoVacuum).

Writable optional attribute represented as a Maybe Text.

Constructors

VorbisVendor

Instances

MetaValue VorbisVendor

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType VorbisVendor

type MetaWritable VorbisVendor

Methods

retrieve :: VorbisVendor -> FlacMeta (MetaType VorbisVendor)

(=->) :: VorbisVendor -> MetaType VorbisVendor -> FlacMeta ()

type MetaType VorbisVendor

Defined in Codec.Audio.FLAC.Metadata

type MetaType VorbisVendor = Maybe Text

type MetaWritable VorbisVendor

Defined in Codec.Audio.FLAC.Metadata

type MetaWritable VorbisVendor = ()

data VorbisComment

Various Vorbis comments, see VorbisField for available field names. The field names are mostly taken from here:

https://www.xiph.org/vorbis/doc/v-comment.html.

TrackTotal, DiscNumber, and Rating are popular de-facto standard fields. The library also supports the standard ReplayGain comments.

Writable optional attribute represented as a Maybe Text.

Constructors

VorbisComment VorbisField

Instances

MetaValue VorbisComment

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType VorbisComment

type MetaWritable VorbisComment

Methods

retrieve :: VorbisComment -> FlacMeta (MetaType VorbisComment)

(=->) :: VorbisComment -> MetaType VorbisComment -> FlacMeta ()

type MetaType VorbisComment

Defined in Codec.Audio.FLAC.Metadata

type MetaType VorbisComment = Maybe Text

type MetaWritable VorbisComment

Defined in Codec.Audio.FLAC.Metadata

type MetaWritable VorbisComment = ()

data VorbisField

Enumeration of all supported filed names to index vorbis comment entries.

Constructors

Title

Track/work name.

Version

The version field may be used to differentiate multiple versions of the same track title in a single collection (e.g. remix info).

Album

The collection name to which this track belongs.

TrackNumber

The track number of this piece if part of a specific larger collection or album.

TrackTotal

Total number of tracks in the collection this track belongs to.

DiscNumber

Disc number in a multi-disc release.

DiscTotal

Total number of discs in a multi-disc release.

Artist

The artist generally considered responsible for the work. In popular music this is usually the performing band or singer. For classical music it would be the composer. For an audio book it would be the author of the original text.

Performer

The artist(s) who performed the work. In classical music this would be the conductor, orchestra, soloists. In an audio book it would be the actor who did the reading. In popular music this is typically the same as the Artist and is omitted.

Copyright

Copyright attribution, e.g., “2001 Nobody's Band” or “1999 Jack Moffitt”.

License

License information, e.g., “All Rights Reserved”, “Any Use Permitted”, a URL to a license such as a Creative Commons license or the EFF Open Audio License, etc.

Organization

Name of the organization producing the track (i.e. the “record label”).

Description

A short text description of the contents.

Genre

A short text indication of music genre.

Date

Date the track was recorded, usually year.

Location

Location where track was recorded.

Contact

Contact information for the creators or distributors of the track. This could be a URL, an email address, the physical address of the producing label.

ISRC

ISRC number for the track, see http://isrc.ifpi.org/en.

Rating

Rating, usually mapped as 1–5 stars with actual values “20”, “40”, “60”, “80”, “100” stored.

RGTrackPeak

Replay gain track peak, e.g. “0.99996948”.

RGTrackGain

Replay gain track gain, e.g. “-7.89 dB”.

RGAlbumPeak

Replay gain album peak, e.g. “0.99996948”.

RGAlbumGain

Replay gain album gain, e.g. “-7.89 dB”.

Instances

Bounded VorbisField

Defined in Codec.Audio.FLAC.Metadata

Methods

minBound :: VorbisField

maxBound :: VorbisField

Enum VorbisField

Defined in Codec.Audio.FLAC.Metadata

Methods

succ :: VorbisField -> VorbisField

pred :: VorbisField -> VorbisField

toEnum :: Int -> VorbisField

fromEnum :: VorbisField -> Int

enumFrom :: VorbisField -> [VorbisField]

enumFromThen :: VorbisField -> VorbisField -> [VorbisField]

enumFromTo :: VorbisField -> VorbisField -> [VorbisField]

enumFromThenTo :: VorbisField -> VorbisField -> VorbisField -> [VorbisField]

Eq VorbisField

Defined in Codec.Audio.FLAC.Metadata

Methods

(==) :: VorbisField -> VorbisField -> Bool

(/=) :: VorbisField -> VorbisField -> Bool

Ord VorbisField

Defined in Codec.Audio.FLAC.Metadata

Methods

compare :: VorbisField -> VorbisField -> Ordering

(<) :: VorbisField -> VorbisField -> Bool

(<=) :: VorbisField -> VorbisField -> Bool

(>) :: VorbisField -> VorbisField -> Bool

(>=) :: VorbisField -> VorbisField -> Bool

max :: VorbisField -> VorbisField -> VorbisField

min :: VorbisField -> VorbisField -> VorbisField

Read VorbisField

Defined in Codec.Audio.FLAC.Metadata

Methods

readsPrec :: Int -> ReadS VorbisField

readList :: ReadS [VorbisField]

readPrec :: ReadPrec VorbisField

readListPrec :: ReadPrec [VorbisField]

Show VorbisField

Defined in Codec.Audio.FLAC.Metadata

Methods

showsPrec :: Int -> VorbisField -> ShowS

show :: VorbisField -> String

showList :: [VorbisField] -> ShowS

data CueSheet

A CUE sheet stored in FLAC metadata. If you try to write an invalid CUE sheet MetaException will be raised with the MetaInvalidCueSheet constructor which includes a Text value with explanation why the CUE sheet was considered invalid. Import Codec.Audio.FLAC.Metadata.CueSheet to manipulate CueSheetData and CueTracks.

Writable optional attribute represented as a Maybe CueSheetData.

Constructors

CueSheet

Instances

MetaValue CueSheet

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType CueSheet

type MetaWritable CueSheet

Methods

retrieve :: CueSheet -> FlacMeta (MetaType CueSheet)

(=->) :: CueSheet -> MetaType CueSheet -> FlacMeta ()

type MetaType CueSheet

Defined in Codec.Audio.FLAC.Metadata

type MetaType CueSheet = Maybe CueSheetData

type MetaWritable CueSheet

Defined in Codec.Audio.FLAC.Metadata

type MetaWritable CueSheet = ()

data Picture

Picture embedded in FLAC file. A FLAC file can have several pictures attached to it, you choose which one you want by specifying PictureType. If you try to write an invalid picture MetaException will be raised with MetaInvalidPicture constructor which includes a Text value with explanation why the picture was considered invalid.

Note that the flac-picture https://hackage.haskell.org/package/flac-picture package allows to work with PictureData easier using the Juicy-Pixels library.

Writable optional attribute represented as a Maybe PictureData.

Constructors

Picture PictureType

Instances

MetaValue Picture

Defined in Codec.Audio.FLAC.Metadata

Associated Types

type MetaType Picture

type MetaWritable Picture

Methods

retrieve :: Picture -> FlacMeta (MetaType Picture)

(=->) :: Picture -> MetaType Picture -> FlacMeta ()

type MetaType Picture

Defined in Codec.Audio.FLAC.Metadata

type MetaType Picture = Maybe PictureData

type MetaWritable Picture

Defined in Codec.Audio.FLAC.Metadata

type MetaWritable Picture = ()

data PictureType

Type of picture FLAC metadata can contain. There may be several metadata blocks containing pictures of different types.

Constructors

PictureOther

Other

PictureFileIconStandard

32×32 pixels file icon (PNG only)

PictureFileIcon

Other file icon

PictureFrontCover

Cover (front)

PictureBackCover

Cover (back)

PictureLeafletPage

Leaflet page

PictureMedia

Media (e.g. label side of CD)

PictureLeadArtist

Lead artist/lead performer/soloist

PictureArtist

Artist/performer

PictureConductor

Conductor

PictureBand

Band/orchestra

PictureComposer

Composer

PictureLyricist

Lyricist/text writer

PictureRecordingLocation

Recording location

PictureDuringRecording

During recording

PictureDuringPerformance

During performance

PictureVideoScreenCapture

Movie/video screen capture

PictureFish

A bright coloured fish

PictureIllustration

Illustration

PictureBandLogotype

Band/artist logotype

PicturePublisherLogotype

Publisher/studio logotype

Instances

Bounded PictureType

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

minBound :: PictureType

maxBound :: PictureType

Enum PictureType

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

succ :: PictureType -> PictureType

pred :: PictureType -> PictureType

toEnum :: Int -> PictureType

fromEnum :: PictureType -> Int

enumFrom :: PictureType -> [PictureType]

enumFromThen :: PictureType -> PictureType -> [PictureType]

enumFromTo :: PictureType -> PictureType -> [PictureType]

enumFromThenTo :: PictureType -> PictureType -> PictureType -> [PictureType]

Eq PictureType

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

(==) :: PictureType -> PictureType -> Bool

(/=) :: PictureType -> PictureType -> Bool

Ord PictureType

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

compare :: PictureType -> PictureType -> Ordering

(<) :: PictureType -> PictureType -> Bool

(<=) :: PictureType -> PictureType -> Bool

(>) :: PictureType -> PictureType -> Bool

(>=) :: PictureType -> PictureType -> Bool

max :: PictureType -> PictureType -> PictureType

min :: PictureType -> PictureType -> PictureType

Read PictureType

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

readsPrec :: Int -> ReadS PictureType

readList :: ReadS [PictureType]

readPrec :: ReadPrec PictureType

readListPrec :: ReadPrec [PictureType]

Show PictureType

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

showsPrec :: Int -> PictureType -> ShowS

show :: PictureType -> String

showList :: [PictureType] -> ShowS

data PictureData

Representation of picture contained in a FLAC metadata block.

Constructors

PictureData

Fields

• pictureMimeType :: !Text

  The picture's MIME data. For best compatibility with players, use picture data of MIME type image/jpeg or image/png.

• pictureDescription :: !Text

  Picture's description.

• pictureWidth :: !Word32

  Picture's width in pixels.

• pictureHeight :: !Word32

  Picture's height in pixels.

• pictureDepth :: !Word32

  Picture's color depth in bits-per-pixel.

• pictureColors :: !Word32

  For indexed palettes (like GIF), picture's number of colors (the number of palette entries), or 0 for non-indexed (i.e. 2 ^ depth).

• pictureData :: !ByteString

  Binary picture data.

Instances

Eq PictureData

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

(==) :: PictureData -> PictureData -> Bool

(/=) :: PictureData -> PictureData -> Bool

Ord PictureData

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

compare :: PictureData -> PictureData -> Ordering

(<) :: PictureData -> PictureData -> Bool

(<=) :: PictureData -> PictureData -> Bool

(>) :: PictureData -> PictureData -> Bool

(>=) :: PictureData -> PictureData -> Bool

max :: PictureData -> PictureData -> PictureData

min :: PictureData -> PictureData -> PictureData

Read PictureData

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

readsPrec :: Int -> ReadS PictureData

readList :: ReadS [PictureData]

readPrec :: ReadPrec PictureData

readListPrec :: ReadPrec [PictureData]

Show PictureData

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

showsPrec :: Int -> PictureData -> ShowS

show :: PictureData -> String

showList :: [PictureData] -> ShowS

Extra functionality

wipeVorbisComment :: FlacMeta ()

Delete all “Vorbis comment” metadata blocks.

wipeApplications :: FlacMeta ()

Delete all “Application” metadata blocks.

wipeSeekTable :: FlacMeta ()

Delete all “Seek table” metadata blocks.

wipeCueSheets :: FlacMeta ()

Delete all “CUE sheet” metadata blocks.

wipePictures :: FlacMeta ()

Delete all “Picture” metadata blocks.

Debugging and testing

data MetadataType

Enumeration of all known metadata blocks.

Constructors

StreamInfoBlock

Stream info block (general data like sample rate)

PaddingBlock

Padding block

ApplicationBlock

Application block

SeekTableBlock

Seek table block

VorbisCommentBlock

Vorbis comment block, a.k.a. FLAC tags

CueSheetBlock

Cue sheet block

PictureBlock

Picture block

UndefinedBlock

Undefined block

Instances

Bounded MetadataType

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

minBound :: MetadataType

maxBound :: MetadataType

Enum MetadataType

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

succ :: MetadataType -> MetadataType

pred :: MetadataType -> MetadataType

toEnum :: Int -> MetadataType

fromEnum :: MetadataType -> Int

enumFrom :: MetadataType -> [MetadataType]

enumFromThen :: MetadataType -> MetadataType -> [MetadataType]

enumFromTo :: MetadataType -> MetadataType -> [MetadataType]

enumFromThenTo :: MetadataType -> MetadataType -> MetadataType -> [MetadataType]

Eq MetadataType

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

(==) :: MetadataType -> MetadataType -> Bool

(/=) :: MetadataType -> MetadataType -> Bool

Ord MetadataType

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

compare :: MetadataType -> MetadataType -> Ordering

(<) :: MetadataType -> MetadataType -> Bool

(<=) :: MetadataType -> MetadataType -> Bool

(>) :: MetadataType -> MetadataType -> Bool

(>=) :: MetadataType -> MetadataType -> Bool

max :: MetadataType -> MetadataType -> MetadataType

min :: MetadataType -> MetadataType -> MetadataType

Read MetadataType

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

readsPrec :: Int -> ReadS MetadataType

readList :: ReadS [MetadataType]

readPrec :: ReadPrec MetadataType

readListPrec :: ReadPrec [MetadataType]

Show MetadataType

Defined in Codec.Audio.FLAC.Metadata.Internal.Types

Methods

showsPrec :: Int -> MetadataType -> ShowS

show :: MetadataType -> String

showList :: [MetadataType] -> ShowS

getMetaChain :: FlacMeta (NonEmpty MetadataType)

Return a list of all MetadataTypes of metadata blocks detected in order.

isMetaChainModified :: FlacMeta Bool

Return True if actions in current FlacMeta context have modified FLAC metadata. If so, the FLAC file will be updated to reflect these changes on the way out from the FlacMeta monad.