Safe Haskell	Safe-Inferred

Perform.Lilypond.Types

Contents

Duration
NoteDuration
Time
Event
pitch

Description

Basic types used by both Perform.Lilypond.Lilypond and module that use it. Defined here to avoid circular imports.

Synopsis

class ToLily a where
- to_lily :: a -> Text
data Config = Config {
- config_quarter_duration :: !RealTime.RealTime
- config_quantize :: !Duration
- config_dotted_rests :: !Bool
- config_staves :: ![(ScoreT.Instrument, StaffConfig)]
}
quarter_duration :: Config :-> RealTime.RealTime
quantize :: Config :-> Duration
dotted_rests :: Config :-> Bool
staves :: Config :-> [(ScoreT.Instrument, StaffConfig)]
data StaffConfig = StaffConfig {
- staff_long :: !Instrument
- staff_short :: !Instrument
- staff_code :: ![Text]
- staff_display :: !Bool
- staff_add_bass_staff :: !Bool
}
long :: StaffConfig :-> Instrument
short :: StaffConfig :-> Instrument
code :: StaffConfig :-> [Text]
display :: StaffConfig :-> Bool
add_bass_staff :: StaffConfig :-> Bool
type Instrument = Text
default_config :: Config
empty_staff_config :: StaffConfig
default_staff_config :: ScoreT.Instrument -> StaffConfig
global_staff_code :: [Text]
data Duration
- = D1
- | D2
- | D4
- | D8
- | D16
- | D32
- | D64
- | D128
dur_char :: Duration -> Char
int_dur :: Int -> Maybe Duration
dur_to_time :: Duration -> Time
time_to_dur :: Time -> Duration
time_to_durs :: Time -> [Duration]
data NoteDuration = NoteDuration !Duration !Bool
note_dur_char :: NoteDuration -> Text
note_dur_to_time :: NoteDuration -> Time
time_to_note_dur :: Time -> NoteDuration
dur_to_note_dur :: Duration -> NoteDuration
is_note_dur :: Time -> Maybe NoteDuration
time_to_note_durs :: Time -> [NoteDuration]
newtype Time = Time Int
to_whole :: Time -> Rational
time_per_whole :: Time
real_to_time :: RealTime.RealTime -> RealTime.RealTime -> Time
multiply :: Rational -> Time -> Maybe Time
multiply_int :: Int -> Time -> Time
data Event = Event {
- event_start :: !Time
- event_duration :: !Time
- event_pitch :: !(Maybe Pitch)
- event_instrument :: !ScoreT.Instrument
- event_environ :: !DeriveT.Environ
- event_stack :: !Stack.Stack
- event_clipped :: !Bool
}
event_end :: Event -> Time
event_overlaps :: Event -> Event -> Bool
event_attributes :: Event -> Attrs.Attributes
strip_environ :: DeriveT.Environ -> DeriveT.Environ
data Pitch = Pitch !Int !PitchClass !Accidental
data PitchClass
- = C
- | D
- | E
- | F
- | G
- | A
- | B
data Accidental
- = FlatFlat
- | Flat
- | Natural
- | Sharp
- | SharpSharp
parse_pitch :: Pitch.Pitch -> Either Text Pitch
parse_degree :: Pitch.Degree -> Either Text (PitchClass, Accidental)
to_pitch :: Pitch -> Pitch.Pitch

Documentation

class ToLily a where Source #

Convert a value to its lilypond representation.

Methods

to_lily :: a -> Text Source #

Instances

Instances details

ToLily Meter Source #
Instance details Defined in Perform.Lilypond.Meter Methods to_lily :: Meter -> Text Source #
ToLily Ly Source #
Instance details Defined in Perform.Lilypond.Process Methods to_lily :: Ly -> Text Source #
ToLily Note Source #
Instance details Defined in Perform.Lilypond.Process Methods to_lily :: Note -> Text Source #
ToLily Voice Source #
Instance details Defined in Perform.Lilypond.Process Methods to_lily :: Voice -> Text Source #
ToLily Accidental Source #
Instance details Defined in Perform.Lilypond.Types Methods to_lily :: Accidental -> Text Source #
ToLily Duration Source #
Instance details Defined in Perform.Lilypond.Types Methods to_lily :: Duration -> Text Source #
ToLily NoteDuration Source #
Instance details Defined in Perform.Lilypond.Types Methods to_lily :: NoteDuration -> Text Source #
ToLily Pitch Source #
Instance details Defined in Perform.Lilypond.Types Methods to_lily :: Pitch -> Text Source #
ToLily PitchClass Source #
Instance details Defined in Perform.Lilypond.Types Methods to_lily :: PitchClass -> Text Source #
ToLily Text Source #
Instance details Defined in Perform.Lilypond.Types Methods to_lily :: Text -> Text Source #

data Config Source #

Configure how the lilypond score is generated.

Constructors

Config

Fields

config_quarter_duration :: !RealTime.RealTime
Amount of RealTime per quarter note. This is the same value used by Convert.
config_quantize :: !Duration
Round everything to this duration.
config_dotted_rests :: !Bool
Allow dotted rests?
config_staves :: ![(ScoreT.Instrument, StaffConfig)]
Map each instrument to its long name and short name. The order is the order they should appear in the score.

Instances

Instances details

Read Config Source #
Instance details Defined in Perform.Lilypond.Types Methods readsPrec :: Int -> ReadS Config # readList :: ReadS [Config] # readPrec :: ReadPrec Config # readListPrec :: ReadPrec [Config] #
Show Config Source #
Instance details Defined in Perform.Lilypond.Types Methods showsPrec :: Int -> Config -> ShowS # show :: Config -> String # showList :: [Config] -> ShowS #
Eq Config Source #
Instance details Defined in Perform.Lilypond.Types Methods (==) :: Config -> Config -> Bool # (/=) :: Config -> Config -> Bool #
Pretty.Pretty Config Source #
Instance details Defined in Perform.Lilypond.Types Methods pretty :: Config -> Text Source # format :: Config -> Doc Source # formatList :: [Config] -> Doc Source #
Serialize Config Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Config Source # get :: Get Config Source #

quarter_duration :: Config :-> RealTime.RealTime Source #

quantize :: Config :-> Duration Source #

dotted_rests :: Config :-> Bool Source #

staves :: Config :-> [(ScoreT.Instrument, StaffConfig)] Source #

data StaffConfig Source #

Constructors

StaffConfig

Fields

staff_long :: !Instrument
Set Staff.instrumentName or PianoStaff.instrumentName. If an instrument doesn't have a StaffConfig, the long name defaults to the instrument name.
staff_short :: !Instrument
Set Staff.shortInstrumentName or PianoStaff.shortInstrumentName.
staff_code :: ![Text]
Additional code to include verbatim, after the \new Staff line.
staff_display :: !Bool
If false, this staff is omitted from the score.
staff_add_bass_staff :: !Bool
If true, add an additional staff named "down". The new staff has a bass clef and all of the notes replaced with hidden rests, but the key and meter changes remain. It is configured so it will be removed from the score for systems during which it has no notes.
The idea is that you then use xstaff to put notes on this staff. This is for instruments like 揚琴 that have a wide range, but aren't divided into two hands, like the piano.

Instances

Instances details

Read StaffConfig Source #
Instance details Defined in Perform.Lilypond.Types Methods readsPrec :: Int -> ReadS StaffConfig # readList :: ReadS [StaffConfig] # readPrec :: ReadPrec StaffConfig # readListPrec :: ReadPrec [StaffConfig] #
Show StaffConfig Source #
Instance details Defined in Perform.Lilypond.Types Methods showsPrec :: Int -> StaffConfig -> ShowS # show :: StaffConfig -> String # showList :: [StaffConfig] -> ShowS #
Eq StaffConfig Source #
Instance details Defined in Perform.Lilypond.Types Methods (==) :: StaffConfig -> StaffConfig -> Bool # (/=) :: StaffConfig -> StaffConfig -> Bool #
Pretty.Pretty StaffConfig Source #
Instance details Defined in Perform.Lilypond.Types Methods pretty :: StaffConfig -> Text Source # format :: StaffConfig -> Doc Source # formatList :: [StaffConfig] -> Doc Source #
Serialize StaffConfig Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter StaffConfig Source # get :: Get StaffConfig Source #

long :: StaffConfig :-> Instrument Source #

short :: StaffConfig :-> Instrument Source #

code :: StaffConfig :-> [Text] Source #

display :: StaffConfig :-> Bool Source #

add_bass_staff :: StaffConfig :-> Bool Source #

type Instrument = Text Source #

default_config :: Config Source #

empty_staff_config :: StaffConfig Source #

default_staff_config :: ScoreT.Instrument -> StaffConfig Source #

global_staff_code :: [Text] Source #

This is emitted for every staff, regardless of its staff_code.

Duration

data Duration Source #

This time duration measured as the fraction of a whole note.

Constructors

D1
D2
D4
D8
D16
D32
D64
D128

Instances

Instances details

Bounded Duration Source #
Instance details Defined in Perform.Lilypond.Types Methods minBound :: Duration # maxBound :: Duration #
Enum Duration Source #
Instance details Defined in Perform.Lilypond.Types Methods succ :: Duration -> Duration # pred :: Duration -> Duration # toEnum :: Int -> Duration # fromEnum :: Duration -> Int # enumFrom :: Duration -> [Duration] # enumFromThen :: Duration -> Duration -> [Duration] # enumFromTo :: Duration -> Duration -> [Duration] # enumFromThenTo :: Duration -> Duration -> Duration -> [Duration] #
Read Duration Source #
Instance details Defined in Perform.Lilypond.Types Methods readsPrec :: Int -> ReadS Duration # readList :: ReadS [Duration] # readPrec :: ReadPrec Duration # readListPrec :: ReadPrec [Duration] #
Show Duration Source #
Instance details Defined in Perform.Lilypond.Types Methods showsPrec :: Int -> Duration -> ShowS # show :: Duration -> String # showList :: [Duration] -> ShowS #
Eq Duration Source #
Instance details Defined in Perform.Lilypond.Types Methods (==) :: Duration -> Duration -> Bool # (/=) :: Duration -> Duration -> Bool #
Ord Duration Source #
Instance details Defined in Perform.Lilypond.Types Methods compare :: Duration -> Duration -> Ordering # (<) :: Duration -> Duration -> Bool # (<=) :: Duration -> Duration -> Bool # (>) :: Duration -> Duration -> Bool # (>=) :: Duration -> Duration -> Bool # max :: Duration -> Duration -> Duration # min :: Duration -> Duration -> Duration #
ToLily Duration Source #
Instance details Defined in Perform.Lilypond.Types Methods to_lily :: Duration -> Text Source #
Pretty.Pretty Duration Source #
Instance details Defined in Perform.Lilypond.Types Methods pretty :: Duration -> Text Source # format :: Duration -> Doc Source # formatList :: [Duration] -> Doc Source #
Serialize Duration Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Duration Source # get :: Get Duration Source #

dur_char :: Duration -> Char Source #

int_dur :: Int -> Maybe Duration Source #

dur_to_time :: Duration -> Time Source #

time_to_dur :: Time -> Duration Source #

Get the longest dur that will fit within the Time, so this rounds down.

time_to_durs :: Time -> [Duration] Source #

NoteDuration

data NoteDuration Source #

A Duration plus a possible dot.

Constructors

NoteDuration !Duration !Bool

Instances

Instances details

Show NoteDuration Source #
Instance details Defined in Perform.Lilypond.Types Methods showsPrec :: Int -> NoteDuration -> ShowS # show :: NoteDuration -> String # showList :: [NoteDuration] -> ShowS #
Eq NoteDuration Source #
Instance details Defined in Perform.Lilypond.Types Methods (==) :: NoteDuration -> NoteDuration -> Bool # (/=) :: NoteDuration -> NoteDuration -> Bool #
ToLily NoteDuration Source #
Instance details Defined in Perform.Lilypond.Types Methods to_lily :: NoteDuration -> Text Source #
Pretty.Pretty NoteDuration Source #
Instance details Defined in Perform.Lilypond.Types Methods pretty :: NoteDuration -> Text Source # format :: NoteDuration -> Doc Source # formatList :: [NoteDuration] -> Doc Source #

note_dur_char :: NoteDuration -> Text Source #

note_dur_to_time :: NoteDuration -> Time Source #

time_to_note_dur :: Time -> NoteDuration Source #

Get the longest NoteDuration that will fit in the Time. 0 becomes D128 since there's no 0 duration. This puts a bottom bound on the duration of a note, which is good since 0 duration notes aren't notateable, but can happen after quantization.

dur_to_note_dur :: Duration -> NoteDuration Source #

is_note_dur :: Time -> Maybe NoteDuration Source #

Only Just if the Time fits into a single NoteDuration.

time_to_note_durs :: Time -> [NoteDuration] Source #

Time

newtype Time Source #

Time in score units. The maximum resolution is a 128th note, so one unit is 128th of a whole note.

Constructors

Time Int

Instances

Instances details

Enum Time Source #
Instance details Defined in Perform.Lilypond.Types Methods succ :: Time -> Time # pred :: Time -> Time # toEnum :: Int -> Time # fromEnum :: Time -> Int # enumFrom :: Time -> [Time] # enumFromThen :: Time -> Time -> [Time] # enumFromTo :: Time -> Time -> [Time] # enumFromThenTo :: Time -> Time -> Time -> [Time] #
Num Time Source #
Instance details Defined in Perform.Lilypond.Types Methods (+) :: Time -> Time -> Time # (-) :: Time -> Time -> Time # (*) :: Time -> Time -> Time # negate :: Time -> Time # abs :: Time -> Time # signum :: Time -> Time # fromInteger :: Integer -> Time #
Integral Time Source #
Instance details Defined in Perform.Lilypond.Types Methods quot :: Time -> Time -> Time # rem :: Time -> Time -> Time # div :: Time -> Time -> Time # mod :: Time -> Time -> Time # quotRem :: Time -> Time -> (Time, Time) # divMod :: Time -> Time -> (Time, Time) # toInteger :: Time -> Integer #
Real Time Source #
Instance details Defined in Perform.Lilypond.Types Methods toRational :: Time -> Rational #
Show Time Source #
Instance details Defined in Perform.Lilypond.Types Methods showsPrec :: Int -> Time -> ShowS # show :: Time -> String # showList :: [Time] -> ShowS #
Eq Time Source #
Instance details Defined in Perform.Lilypond.Types Methods (==) :: Time -> Time -> Bool # (/=) :: Time -> Time -> Bool #
Ord Time Source #
Instance details Defined in Perform.Lilypond.Types Methods compare :: Time -> Time -> Ordering # (<) :: Time -> Time -> Bool # (<=) :: Time -> Time -> Bool # (>) :: Time -> Time -> Bool # (>=) :: Time -> Time -> Bool # max :: Time -> Time -> Time # min :: Time -> Time -> Time #
Pretty.Pretty Time Source #
Instance details Defined in Perform.Lilypond.Types Methods pretty :: Time -> Text Source # format :: Time -> Doc Source # formatList :: [Time] -> Doc Source #

to_whole :: Time -> Rational Source #

time_per_whole :: Time Source #

real_to_time :: RealTime.RealTime -> RealTime.RealTime -> Time Source #

multiply :: Rational -> Time -> Maybe Time Source #

multiply_int :: Int -> Time -> Time Source #

Event

data Event Source #

Constructors

Event

Fields

event_start :: !Time
event_duration :: !Time
event_pitch :: !(Maybe Pitch)
event_instrument :: !ScoreT.Instrument
event_environ :: !DeriveT.Environ
event_stack :: !Stack.Stack
event_clipped :: !Bool
True if this event is the tied continuation of a previous note. In other words, if it was generated by the tie-splitting code. This is a hack so v_append_first and v_append_last can differentiate.

Instances

Instances details

Show Event Source #
Instance details Defined in Perform.Lilypond.Types Methods showsPrec :: Int -> Event -> ShowS # show :: Event -> String # showList :: [Event] -> ShowS #
Pretty.Pretty Event Source #
Instance details Defined in Perform.Lilypond.Types Methods pretty :: Event -> Text Source # format :: Event -> Doc Source # formatList :: [Event] -> Doc Source #

event_end :: Event -> Time Source #

event_overlaps :: Event -> Event -> Bool Source #

event_attributes :: Event -> Attrs.Attributes Source #

strip_environ :: DeriveT.Environ -> DeriveT.Environ Source #

Strip out non-ly environ keys so error messages are less cluttered.

pitch

data Pitch Source #

Constructors

Pitch !Int !PitchClass !Accidental

Instances

Instances details

Show Pitch Source #
Instance details Defined in Perform.Lilypond.Types Methods showsPrec :: Int -> Pitch -> ShowS # show :: Pitch -> String # showList :: [Pitch] -> ShowS #
Eq Pitch Source #
Instance details Defined in Perform.Lilypond.Types Methods (==) :: Pitch -> Pitch -> Bool # (/=) :: Pitch -> Pitch -> Bool #
Ord Pitch Source #
Instance details Defined in Perform.Lilypond.Types Methods compare :: Pitch -> Pitch -> Ordering # (<) :: Pitch -> Pitch -> Bool # (<=) :: Pitch -> Pitch -> Bool # (>) :: Pitch -> Pitch -> Bool # (>=) :: Pitch -> Pitch -> Bool # max :: Pitch -> Pitch -> Pitch # min :: Pitch -> Pitch -> Pitch #
ToLily Pitch Source #
Instance details Defined in Perform.Lilypond.Types Methods to_lily :: Pitch -> Text Source #
Pretty.Pretty Pitch Source #
Instance details Defined in Perform.Lilypond.Types Methods pretty :: Pitch -> Text Source # format :: Pitch -> Doc Source # formatList :: [Pitch] -> Doc Source #

data PitchClass Source #

Constructors

C
D
E
F
G
A
B

Instances

Instances details

Enum PitchClass Source #
Instance details Defined in Perform.Lilypond.Types Methods succ :: PitchClass -> PitchClass # pred :: PitchClass -> PitchClass # toEnum :: Int -> PitchClass # fromEnum :: PitchClass -> Int # enumFrom :: PitchClass -> [PitchClass] # enumFromThen :: PitchClass -> PitchClass -> [PitchClass] # enumFromTo :: PitchClass -> PitchClass -> [PitchClass] # enumFromThenTo :: PitchClass -> PitchClass -> PitchClass -> [PitchClass] #
Show PitchClass Source #
Instance details Defined in Perform.Lilypond.Types Methods showsPrec :: Int -> PitchClass -> ShowS # show :: PitchClass -> String # showList :: [PitchClass] -> ShowS #
Eq PitchClass Source #
Instance details Defined in Perform.Lilypond.Types Methods (==) :: PitchClass -> PitchClass -> Bool # (/=) :: PitchClass -> PitchClass -> Bool #
Ord PitchClass Source #
Instance details Defined in Perform.Lilypond.Types Methods compare :: PitchClass -> PitchClass -> Ordering # (<) :: PitchClass -> PitchClass -> Bool # (<=) :: PitchClass -> PitchClass -> Bool # (>) :: PitchClass -> PitchClass -> Bool # (>=) :: PitchClass -> PitchClass -> Bool # max :: PitchClass -> PitchClass -> PitchClass # min :: PitchClass -> PitchClass -> PitchClass #
ToLily PitchClass Source #
Instance details Defined in Perform.Lilypond.Types Methods to_lily :: PitchClass -> Text Source #

data Accidental Source #

Constructors

FlatFlat
Flat
Natural
Sharp
SharpSharp

Instances

Instances details

Show Accidental Source #
Instance details Defined in Perform.Lilypond.Types Methods showsPrec :: Int -> Accidental -> ShowS # show :: Accidental -> String # showList :: [Accidental] -> ShowS #
Eq Accidental Source #
Instance details Defined in Perform.Lilypond.Types Methods (==) :: Accidental -> Accidental -> Bool # (/=) :: Accidental -> Accidental -> Bool #
Ord Accidental Source #
Instance details Defined in Perform.Lilypond.Types Methods compare :: Accidental -> Accidental -> Ordering # (<) :: Accidental -> Accidental -> Bool # (<=) :: Accidental -> Accidental -> Bool # (>) :: Accidental -> Accidental -> Bool # (>=) :: Accidental -> Accidental -> Bool # max :: Accidental -> Accidental -> Accidental # min :: Accidental -> Accidental -> Accidental #
ToLily Accidental Source #
Instance details Defined in Perform.Lilypond.Types Methods to_lily :: Accidental -> Text Source #

parse_pitch :: Pitch.Pitch -> Either Text Pitch Source #

parse_degree :: Pitch.Degree -> Either Text (PitchClass, Accidental) Source #

to_pitch :: Pitch -> Pitch.Pitch Source #