Copyright	© 2017 Mark Karpov
License	BSD 3 clause
Maintainer	Mark Karpov <markkarpov92@gmail.com>
Stability	experimental
Portability	portable
Safe Haskell	None
Language	Haskell2010

Codec.Audio.LAME

Description

The module provides an interface to LAME MP3 encoder. All you need to do to encode a WAVE (or RF64) file is to call encodeMp3, which see.

Synopsis

encodeMp3 :: MonadIO m => EncoderSettings -> FilePath -> FilePath -> m ()
data EncoderSettings = EncoderSettings {
- encoderCompression :: !Compression
- encoderQuality :: !(Maybe Word)
- encoderNoGap :: !(Maybe (Word32, Word32))
- encoderErrorProtection :: !Bool
- encoderStrictISO :: !Bool
- encoderSampleRate :: !(Maybe Word32)
- encoderScale :: !Float
- encoderFreeFormat :: !Bool
- encoderCopyright :: !Bool
- encoderOriginal :: !Bool
- encoderWriteVbrTag :: !Bool
- encoderMetadataPlacement :: !MetadataPlacement
- encoderTagTitle :: !(Maybe Text)
- encoderTagArtist :: !(Maybe Text)
- encoderTagAlbum :: !(Maybe Text)
- encoderTagYear :: !(Maybe Text)
- encoderTagComment :: !(Maybe Text)
- encoderTagTrack :: !(Maybe (Word8, Maybe Word8))
- encoderTagGenre :: !(Maybe Text)
- encoderAlbumArt :: !(Maybe ByteString)
- encoderLowpassFilter :: !FilterSetup
- encoderHighpassFilter :: !FilterSetup
}
data Compression
- = CompressionBitrate Word
- | CompressionRatio Float
- | CompressionVBR VbrMode Word
data VbrMode
- = VbrRh
- | VbrAbr (Maybe Word) (Maybe Word) (Maybe Word) Bool
- | VbrMtrh
data MetadataPlacement
- = Id3v1Only
- | Id3v2Only
- | Id3Both
data FilterSetup
- = FilterAuto
- | FilterDisabled
- | FilterManual Word (Maybe Word)
data LameException

Documentation

encodeMp3 #

Arguments

:: MonadIO m
=> EncoderSettings	Encoder settings
-> FilePath	WAVE file to encode
-> FilePath	Where to save the resulting MP3 file
-> m ()

Encode a WAVE file or RF64 file to MP3.

If the input file is not a valid WAVE file, WaveException will be thrown. LameException is thrown when underlying LAME encoder reports a problem.

Not all sample formats and bit depth are currently supported. Supported sample formats include:

PCM with samples represented as signed integers > 8 bit and <= 16 bit per mono-sample.
IEEE floating point (32 bit) samples.
IEEE floating point (64 bit) samples.

If you feed the encoder with something else, expect LameUnsupportedSampleFormat to be thrown.

data EncoderSettings #

LAME encoder settings.

Currently some noise-shaping and psycho-acoustic parameters are omitted, but can be added on request.

Constructors

EncoderSettings

Fields

encoderCompression :: !Compression
How to determine amount of compression to apply, see Compression. Default value: CompressionRatio 11 (corresponds to 128 kbps).
encoderQuality :: !(Maybe Word)
Select algorithm. This variable will effect quality by selecting expensive or cheap algorithms. 0 gives the best quality (very slow). 9 is very fast, but gives worst quality.
- 2—near-best quality, not too slow.
- 5—good quality, fast.
- 7—OK quality, really fast.
Default value: Nothing, meaning that LAME will select the best value itself.
encoderNoGap :: !(Maybe (Word32, Word32))
Enable “no gap” encoding. The first value in the tuple specifies current index and the second value specifies total number of tracks. Default value: Nothing—disabled.
encoderErrorProtection :: !Bool
Whether to enable error protection. Error protection means that 2 bytes from each frame for CRC checksum. Default value: False.
encoderStrictISO :: !Bool
Whether to enforce strict ISO compliance. Default value: False.
encoderSampleRate :: !(Maybe Word32)
Sample rate of output file. Default value: Nothing, which means use sample rate of input file.
encoderScale :: !Float
Scale input stream by multiplying samples by this value. Default value: 1 (no scaling).
encoderFreeFormat :: !Bool
Use free format. Default value: False.
encoderCopyright :: !Bool
Mark as copyright protected. Default value: False.
encoderOriginal :: !Bool
Mark as original. Default value: True.
encoderWriteVbrTag :: !Bool
Whether to write Xing VBR header frame. Default value: True.
encoderMetadataPlacement :: !MetadataPlacement
Which container to use to write metadata. Default value: Id3v2Only.
encoderTagTitle :: !(Maybe Text)
Title tag to write. Default value: Nothing.
encoderTagArtist :: !(Maybe Text)
Artist tag to write. Default value: Nothing.
encoderTagAlbum :: !(Maybe Text)
Album tag to write. Default value: Nothing.
encoderTagYear :: !(Maybe Text)
Year tag to write. Default value: Nothing.
encoderTagComment :: !(Maybe Text)
Comment tag to write. Default value: Nothing.
encoderTagTrack :: !(Maybe (Word8, Maybe Word8))
Track number (first in tuple) and (optionally) total number of tracks (second in tuple). Default value: Nothing.
encoderTagGenre :: !(Maybe Text)
Genre tag to write. Default value: Nothing.
encoderAlbumArt :: !(Maybe ByteString)
Album art (a picture) to write (JPEG/PNG/GIF). Default value: Nothing.
encoderLowpassFilter :: !FilterSetup
Settings for low-pass filter. Default value: FilterAuto.
encoderHighpassFilter :: !FilterSetup
Settings for high-pass filter. Default value: FilterAuto.

Instances

Eq EncoderSettings #
Instance details Defined in Codec.Audio.LAME Methods (==) :: EncoderSettings -> EncoderSettings -> Bool # (/=) :: EncoderSettings -> EncoderSettings -> Bool #
Ord EncoderSettings #
Instance details Defined in Codec.Audio.LAME Methods compare :: EncoderSettings -> EncoderSettings -> Ordering # (<) :: EncoderSettings -> EncoderSettings -> Bool # (<=) :: EncoderSettings -> EncoderSettings -> Bool # (>) :: EncoderSettings -> EncoderSettings -> Bool # (>=) :: EncoderSettings -> EncoderSettings -> Bool # max :: EncoderSettings -> EncoderSettings -> EncoderSettings # min :: EncoderSettings -> EncoderSettings -> EncoderSettings #
Read EncoderSettings #
Instance details Defined in Codec.Audio.LAME Methods readsPrec :: Int -> ReadS EncoderSettings # readList :: ReadS [EncoderSettings] # readPrec :: ReadPrec EncoderSettings # readListPrec :: ReadPrec [EncoderSettings] #
Show EncoderSettings #
Instance details Defined in Codec.Audio.LAME Methods showsPrec :: Int -> EncoderSettings -> ShowS # show :: EncoderSettings -> String # showList :: [EncoderSettings] -> ShowS #
Default EncoderSettings #
Instance details Defined in Codec.Audio.LAME Methods def :: EncoderSettings #

data Compression #

The data type represents supported options for compression. You can specify either fixed bitrate, compression ratio, or use the VBR mode.

Constructors

CompressionBitrate Word	Specify compression by setting a fixed bitrate, e.g. `CompressionBitrate 320`.
CompressionRatio Float	Specify compression ratio.
CompressionVBR VbrMode Word	VBR. Here you can specify which mode to use and the second argument is VBR quality from 0 (highest), to 9 (lowest). Good default is 4.

Instances

Eq Compression #
Instance details Defined in Codec.Audio.LAME Methods (==) :: Compression -> Compression -> Bool # (/=) :: Compression -> Compression -> Bool #
Ord Compression #
Instance details Defined in Codec.Audio.LAME Methods compare :: Compression -> Compression -> Ordering # (<) :: Compression -> Compression -> Bool # (<=) :: Compression -> Compression -> Bool # (>) :: Compression -> Compression -> Bool # (>=) :: Compression -> Compression -> Bool # max :: Compression -> Compression -> Compression # min :: Compression -> Compression -> Compression #
Read Compression #
Instance details Defined in Codec.Audio.LAME Methods readsPrec :: Int -> ReadS Compression # readList :: ReadS [Compression] # readPrec :: ReadPrec Compression # readListPrec :: ReadPrec [Compression] #
Show Compression #
Instance details Defined in Codec.Audio.LAME Methods showsPrec :: Int -> Compression -> ShowS # show :: Compression -> String # showList :: [Compression] -> ShowS #

data VbrMode #

Variable bitrate (VBR) modes with their associated parameters.

Constructors

VbrRh

VBR RH.

VbrAbr (Maybe Word) (Maybe Word) (Maybe Word) Bool

VBR ABR. Parameters of the data constructor in order:

Minimal bitrate
Mean bitrate
Maximal bitrate
“Hard minimal bitrate”, if True, then the specified minimal bitrate will be enforced in all cases (normally it's violated for silence).

VbrMtrh

VBR MTRH

Instances

Eq VbrMode #
Instance details Defined in Codec.Audio.LAME Methods (==) :: VbrMode -> VbrMode -> Bool # (/=) :: VbrMode -> VbrMode -> Bool #
Ord VbrMode #
Instance details Defined in Codec.Audio.LAME Methods compare :: VbrMode -> VbrMode -> Ordering # (<) :: VbrMode -> VbrMode -> Bool # (<=) :: VbrMode -> VbrMode -> Bool # (>) :: VbrMode -> VbrMode -> Bool # (>=) :: VbrMode -> VbrMode -> Bool # max :: VbrMode -> VbrMode -> VbrMode # min :: VbrMode -> VbrMode -> VbrMode #
Read VbrMode #
Instance details Defined in Codec.Audio.LAME Methods readsPrec :: Int -> ReadS VbrMode # readList :: ReadS [VbrMode] # readPrec :: ReadPrec VbrMode # readListPrec :: ReadPrec [VbrMode] #
Show VbrMode #
Instance details Defined in Codec.Audio.LAME Methods showsPrec :: Int -> VbrMode -> ShowS # show :: VbrMode -> String # showList :: [VbrMode] -> ShowS #

data MetadataPlacement #

Which container to use to write tags/metadata.

Constructors

Id3v1Only	Only write ID3v1 metadata
Id3v2Only	Only write ID3v2 metadata
Id3Both	Write ID3v1 and ID3v2

Instances

Eq MetadataPlacement #
Instance details Defined in Codec.Audio.LAME Methods (==) :: MetadataPlacement -> MetadataPlacement -> Bool # (/=) :: MetadataPlacement -> MetadataPlacement -> Bool #
Ord MetadataPlacement #
Instance details Defined in Codec.Audio.LAME Methods compare :: MetadataPlacement -> MetadataPlacement -> Ordering # (<) :: MetadataPlacement -> MetadataPlacement -> Bool # (<=) :: MetadataPlacement -> MetadataPlacement -> Bool # (>) :: MetadataPlacement -> MetadataPlacement -> Bool # (>=) :: MetadataPlacement -> MetadataPlacement -> Bool # max :: MetadataPlacement -> MetadataPlacement -> MetadataPlacement # min :: MetadataPlacement -> MetadataPlacement -> MetadataPlacement #
Read MetadataPlacement #
Instance details Defined in Codec.Audio.LAME Methods readsPrec :: Int -> ReadS MetadataPlacement # readList :: ReadS [MetadataPlacement] # readPrec :: ReadPrec MetadataPlacement # readListPrec :: ReadPrec [MetadataPlacement] #
Show MetadataPlacement #
Instance details Defined in Codec.Audio.LAME Methods showsPrec :: Int -> MetadataPlacement -> ShowS # show :: MetadataPlacement -> String # showList :: [MetadataPlacement] -> ShowS #

data FilterSetup #

Settings for a filter.

Constructors

FilterAuto	Filter settings are chosen automatically
FilterDisabled	Filter is disabled
FilterManual Word (Maybe Word)	The first parameter is the filter's frequency (cut-off frequency) in Hz and the second parameter is width of transition band in Hz (if `Nothing`, it's chosen automatically).

Instances

Eq FilterSetup #
Instance details Defined in Codec.Audio.LAME Methods (==) :: FilterSetup -> FilterSetup -> Bool # (/=) :: FilterSetup -> FilterSetup -> Bool #
Ord FilterSetup #
Instance details Defined in Codec.Audio.LAME Methods compare :: FilterSetup -> FilterSetup -> Ordering # (<) :: FilterSetup -> FilterSetup -> Bool # (<=) :: FilterSetup -> FilterSetup -> Bool # (>) :: FilterSetup -> FilterSetup -> Bool # (>=) :: FilterSetup -> FilterSetup -> Bool # max :: FilterSetup -> FilterSetup -> FilterSetup # min :: FilterSetup -> FilterSetup -> FilterSetup #
Read FilterSetup #
Instance details Defined in Codec.Audio.LAME Methods readsPrec :: Int -> ReadS FilterSetup # readList :: ReadS [FilterSetup] # readPrec :: ReadPrec FilterSetup # readListPrec :: ReadPrec [FilterSetup] #
Show FilterSetup #
Instance details Defined in Codec.Audio.LAME Methods showsPrec :: Int -> FilterSetup -> ShowS # show :: FilterSetup -> String # showList :: [FilterSetup] -> ShowS #

data LameException #

Enumeration of problems you can have with LAME.

Constructors

LameGenericError	A “generic error” happened
LameNoMemory	Memory allocation issue
LameBadBitrate	Unsupported bitrate
LameBadSampleFreq	Unsupported sample rate
LameInternalError	An “Internal error” happened
LameInvalidTrackNumber Word8 (Maybe Word8)	Invalid track number (first argument) or total number of tracks (second argument) was supplied
LameUnsupportedSampleFormat SampleFormat	This sample format is not supported at this time

Instances

Eq LameException #
Instance details Defined in Codec.Audio.LAME.Internal Methods (==) :: LameException -> LameException -> Bool # (/=) :: LameException -> LameException -> Bool #
Read LameException #
Instance details Defined in Codec.Audio.LAME.Internal Methods readsPrec :: Int -> ReadS LameException # readList :: ReadS [LameException] # readPrec :: ReadPrec LameException # readListPrec :: ReadPrec [LameException] #
Show LameException #
Instance details Defined in Codec.Audio.LAME.Internal Methods showsPrec :: Int -> LameException -> ShowS # show :: LameException -> String # showList :: [LameException] -> ShowS #
Exception LameException #
Instance details Defined in Codec.Audio.LAME.Internal Methods toException :: LameException -> SomeException # fromException :: SomeException -> Maybe LameException # displayException :: LameException -> String #