cue-sheet-1.0.0: Support for construction, rendering, and parsing of CUE sheets

Copyright© 2016–2017 Mark Karpov
LicenseBSD 3 clause
MaintainerMark Karpov <markkarpov92@gmail.com>
Stabilityexperimental
Portabilityportable
Safe HaskellSafe
LanguageHaskell2010

Text.CueSheet.Types

Description

Types describing structure of a CUE sheet. You probably want to import Text.CueSheet instead.

Synopsis

Documentation

data CueSheet Source #

Entire CUE sheet, contains one or more files (see CueFile).

Constructors

CueSheet 

Fields

Instances

Eq CueSheet Source # 
Ord CueSheet Source # 
Show CueSheet Source # 
Generic CueSheet Source # 

Associated Types

type Rep CueSheet :: * -> * #

Methods

from :: CueSheet -> Rep CueSheet x #

to :: Rep CueSheet x -> CueSheet #

Arbitrary CueSheet Source # 
type Rep CueSheet Source # 

data CueFile Source #

A file to be written. Single file can be divided into one or more tracks (see CueTrack).

Constructors

CueFile 

Fields

data CueFileType Source #

Enumeration of audio or file's data types.

Constructors

Binary

Intel binary file (least significant byte first). Use for data files.

Motorola

Motorola binary file (most significant file first). Use for data files.

Aiff

Audio AIFF file (44.1 kHz, 16 bit stereo).

Wave

Audio WAVE file (44.1 kHz, 16 bit stereo).

MP3

Audio MP3 file (44.1 kHz 16 bit stereo).

Instances

Bounded CueFileType Source # 
Enum CueFileType Source # 
Eq CueFileType Source # 
Ord CueFileType Source # 
Read CueFileType Source # 
Show CueFileType Source # 
Generic CueFileType Source # 

Associated Types

type Rep CueFileType :: * -> * #

Arbitrary CueFileType Source # 
type Rep CueFileType Source # 
type Rep CueFileType = D1 (MetaData "CueFileType" "Text.CueSheet.Types" "cue-sheet-1.0.0-3gRQ2pw7hDv5pV0wEYBXU4" False) ((:+:) ((:+:) (C1 (MetaCons "Binary" PrefixI False) U1) (C1 (MetaCons "Motorola" PrefixI False) U1)) ((:+:) (C1 (MetaCons "Aiff" PrefixI False) U1) ((:+:) (C1 (MetaCons "Wave" PrefixI False) U1) (C1 (MetaCons "MP3" PrefixI False) U1))))

data CueTrack Source #

A track. Single track can have one or more indices.

Constructors

CueTrack 

Fields

Instances

Eq CueTrack Source # 
Ord CueTrack Source # 
Show CueTrack Source # 
Generic CueTrack Source # 

Associated Types

type Rep CueTrack :: * -> * #

Methods

from :: CueTrack -> Rep CueTrack x #

to :: Rep CueTrack x -> CueTrack #

Arbitrary CueTrack Source # 
type Rep CueTrack Source # 
type Rep CueTrack = D1 (MetaData "CueTrack" "Text.CueSheet.Types" "cue-sheet-1.0.0-3gRQ2pw7hDv5pV0wEYBXU4" False) (C1 (MetaCons "CueTrack" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "cueTrackDigitalCopyPermitted") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) ((:*:) (S1 (MetaSel (Just Symbol "cueTrackFourChannelAudio") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) (S1 (MetaSel (Just Symbol "cueTrackPreemphasisEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "cueTrackSerialCopyManagement") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) ((:*:) (S1 (MetaSel (Just Symbol "cueTrackType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 CueTrackType)) (S1 (MetaSel (Just Symbol "cueTrackIsrc") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Isrc)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "cueTrackTitle") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CueText))) ((:*:) (S1 (MetaSel (Just Symbol "cueTrackPerformer") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CueText))) (S1 (MetaSel (Just Symbol "cueTrackSongwriter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CueText))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "cueTrackPregap") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CueTime))) (S1 (MetaSel (Just Symbol "cueTrackPregapIndex") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CueTime)))) ((:*:) (S1 (MetaSel (Just Symbol "cueTrackIndices") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (NonEmpty CueTime))) (S1 (MetaSel (Just Symbol "cueTrackPostgap") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CueTime))))))))

data CueTrackType Source #

Track datatype.

Constructors

CueTrackAudio

Audio/Music (2352).

CueTrackCdg

Karaoke CD+G (2448).

CueTrackMode1_2048

CD-ROM Mode1 data (cooked).

CueTrackMode1_2352

CD-ROM Mode1 data (raw).

CueTrackMode2_2336

CD-ROM XA Mode2 data.

CueTrackMode2_2352

CD-ROM XA Mode2 data.

CueTrackCdi2336

CD-I Mode2 data.

CueTrackCdi2352

CD-I Mode2 data.

Instances

Bounded CueTrackType Source # 
Enum CueTrackType Source # 
Eq CueTrackType Source # 
Ord CueTrackType Source # 
Read CueTrackType Source # 
Show CueTrackType Source # 
Generic CueTrackType Source # 

Associated Types

type Rep CueTrackType :: * -> * #

Arbitrary CueTrackType Source # 
type Rep CueTrackType Source # 
type Rep CueTrackType = D1 (MetaData "CueTrackType" "Text.CueSheet.Types" "cue-sheet-1.0.0-3gRQ2pw7hDv5pV0wEYBXU4" False) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "CueTrackAudio" PrefixI False) U1) (C1 (MetaCons "CueTrackCdg" PrefixI False) U1)) ((:+:) (C1 (MetaCons "CueTrackMode1_2048" PrefixI False) U1) (C1 (MetaCons "CueTrackMode1_2352" PrefixI False) U1))) ((:+:) ((:+:) (C1 (MetaCons "CueTrackMode2_2336" PrefixI False) U1) (C1 (MetaCons "CueTrackMode2_2352" PrefixI False) U1)) ((:+:) (C1 (MetaCons "CueTrackCdi2336" PrefixI False) U1) (C1 (MetaCons "CueTrackCdi2352" PrefixI False) U1))))

newtype CueTime Source #

This datatype is used to indicate duration and position in time. It contains number of frames. There are 75 frames in one second.

Constructors

CueTime Natural 

fromMmSsFf Source #

Arguments

:: MonadThrow m 
=> Natural

Number of minutes, no limit here

-> Natural

Number of seconds, 0–59 inclusive

-> Natural

Number of frames, 0–74 inclusive

-> m CueTime

The result

Construct CueTime from minutes, seconds, and frames. There are 75 frames per second. If number of seconds or frames is invalid, InvalidSeconds or InvalidFrames will be thrown.

toMmSsFf :: CueTime -> (Natural, Natural, Natural) Source #

Get minutes, seconds, and frames from a CueTime value.

showMmSsFf :: CueTime -> Text Source #

Render representation of CueTime in mm:ss:ff format.

data Mcn Source #

Disc's Media Catalog Number (MCN), must be 13 characters long, all the characters must be numeric.

Instances

Eq Mcn Source # 

Methods

(==) :: Mcn -> Mcn -> Bool #

(/=) :: Mcn -> Mcn -> Bool #

Ord Mcn Source # 

Methods

compare :: Mcn -> Mcn -> Ordering #

(<) :: Mcn -> Mcn -> Bool #

(<=) :: Mcn -> Mcn -> Bool #

(>) :: Mcn -> Mcn -> Bool #

(>=) :: Mcn -> Mcn -> Bool #

max :: Mcn -> Mcn -> Mcn #

min :: Mcn -> Mcn -> Mcn #

Show Mcn Source # 

Methods

showsPrec :: Int -> Mcn -> ShowS #

show :: Mcn -> String #

showList :: [Mcn] -> ShowS #

Generic Mcn Source # 

Associated Types

type Rep Mcn :: * -> * #

Methods

from :: Mcn -> Rep Mcn x #

to :: Rep Mcn x -> Mcn #

Arbitrary Mcn Source # 

Methods

arbitrary :: Gen Mcn #

shrink :: Mcn -> [Mcn] #

type Rep Mcn Source # 
type Rep Mcn = D1 (MetaData "Mcn" "Text.CueSheet.Types" "cue-sheet-1.0.0-3gRQ2pw7hDv5pV0wEYBXU4" True) (C1 (MetaCons "Mcn" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

mkMcn :: MonadThrow m => Text -> m Mcn Source #

Make a Mcn. If the provided Text value is not a valid MCN, throw the InvalidMcnException.

unMcn :: Mcn -> Text Source #

Get Text from Mcn.

data CueText Source #

A type for things like title or performer that should have length between 1 and 80 characters as per spec. We also demand that it does not contain " and newline characters, as it's not clear from the spec how to escape them properly.

Instances

Eq CueText Source # 

Methods

(==) :: CueText -> CueText -> Bool #

(/=) :: CueText -> CueText -> Bool #

Ord CueText Source # 
Show CueText Source # 
Generic CueText Source # 

Associated Types

type Rep CueText :: * -> * #

Methods

from :: CueText -> Rep CueText x #

to :: Rep CueText x -> CueText #

Arbitrary CueText Source # 
type Rep CueText Source # 
type Rep CueText = D1 (MetaData "CueText" "Text.CueSheet.Types" "cue-sheet-1.0.0-3gRQ2pw7hDv5pV0wEYBXU4" True) (C1 (MetaCons "CueText" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

mkCueText :: MonadThrow m => Text -> m CueText Source #

Make a CueText. If the provided Text value is not a valid CUE text, throw the InvalidCueText exception.

data Isrc Source #

The track's International Standard Recording Code (ISRC). It must be 12 characters in length. The first five characters are alphanumeric, the last seven are numeric only.

Instances

Eq Isrc Source # 

Methods

(==) :: Isrc -> Isrc -> Bool #

(/=) :: Isrc -> Isrc -> Bool #

Ord Isrc Source # 

Methods

compare :: Isrc -> Isrc -> Ordering #

(<) :: Isrc -> Isrc -> Bool #

(<=) :: Isrc -> Isrc -> Bool #

(>) :: Isrc -> Isrc -> Bool #

(>=) :: Isrc -> Isrc -> Bool #

max :: Isrc -> Isrc -> Isrc #

min :: Isrc -> Isrc -> Isrc #

Show Isrc Source # 

Methods

showsPrec :: Int -> Isrc -> ShowS #

show :: Isrc -> String #

showList :: [Isrc] -> ShowS #

Generic Isrc Source # 

Associated Types

type Rep Isrc :: * -> * #

Methods

from :: Isrc -> Rep Isrc x #

to :: Rep Isrc x -> Isrc #

Arbitrary Isrc Source # 

Methods

arbitrary :: Gen Isrc #

shrink :: Isrc -> [Isrc] #

type Rep Isrc Source # 
type Rep Isrc = D1 (MetaData "Isrc" "Text.CueSheet.Types" "cue-sheet-1.0.0-3gRQ2pw7hDv5pV0wEYBXU4" True) (C1 (MetaCons "Isrc" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

mkIsrc :: MonadThrow m => Text -> m Isrc Source #

Make an Isrc, if the provided Text value is not a valid ISRC, throw the InvalidIsrc exception.

unIsrc :: Isrc -> Text Source #

Get Text from Isrc.

data CueSheetException Source #

Exception type for the bad things that may happen while you use the library.

Constructors

InvalidSeconds Natural

The value is greater than 59 and thus is invalid for fromMmSsFf.

InvalidFrames Natural

The value is greater than 74 and thus is invalid for fromMmSsFf.

InvalidMcn Text

Provided text wasn't a correct media catalog number (MCN).

InvalidCueText Text

Provided text wasn't a valid CUE text.

InvalidIsrc Text

Provided text wasn't a valid ISRC.

Instances

Eq CueSheetException Source # 
Ord CueSheetException Source # 
Read CueSheetException Source # 
Show CueSheetException Source # 
Generic CueSheetException Source # 
Exception CueSheetException Source # 
type Rep CueSheetException Source #