Safe Haskell	Safe-Inferred

Synth.Shared.Config

Contents

cache files
progress

Description

Shared config to coordinate between the sequencer and im subsystems.

Synopsis

type ChunkNum = Int
data Config = Config {
- imDir :: IO.FilePath
- synths :: Map SynthName Synth
}
getConfig :: IO.IO Config
getLogFilename :: String -> IO.IO IO.FilePath
config :: Path.AppDir -> Config
data Synth = Synth {
- synthName :: !IO.FilePath
- binary :: !IO.FilePath
}
type SynthName = Text
nessName :: SynthName
samplerName :: SynthName
sampler :: Synth
samplerRoot :: Path.Relative
unsafeSamplerRoot :: IO.FilePath
faustName :: SynthName
faust :: Synth
ness :: Synth
notesParentDir :: IO.FilePath
cacheDir :: IO.FilePath
samplingRate :: Int
type SamplingRate = 44100
chunkSize :: AudioT.Frames
blockSize :: AudioT.Frames
chunkSeconds :: Int
startLatency :: AudioT.Frames
thruPort :: Socket.PortNumber
notesFilename :: IO.FilePath -> IO.FilePath -> Id.BlockId -> Synth -> IO.FilePath
notesDirectory :: IO.FilePath -> IO.FilePath -> Id.BlockId -> IO.FilePath
outputDirectory :: IO.FilePath -> IO.FilePath -> Id.BlockId -> IO.FilePath
chunkPath :: IO.FilePath -> IO.FilePath -> Id.BlockId -> ScoreT.Instrument -> ChunkNum -> IO.FilePath
chunkName :: ChunkNum -> IO.FilePath
isOutputLink :: IO.FilePath -> Maybe.Maybe ChunkNum
playFilename :: IO.FilePath -> Id.BlockId -> IO.FilePath
idFilename :: Id.Ident a => a -> IO.FilePath
clearUnusedInstruments :: IO.FilePath -> HashSet ScoreT.Instrument -> IO.IO ()
instrumentToDir :: ScoreT.Instrument -> IO.FilePath
dirToInstrument :: IO.FilePath -> ScoreT.Instrument
listDir :: IO.FilePath -> IO.IO [IO.FilePath]
data Message = Message {
- _blockId :: !Id.BlockId
- _trackIds :: !(Set Id.TrackId)
- _instrument :: !ScoreT.Instrument
- _payload :: !Payload
}
data Payload
- = RenderingRange !RealTime !RealTime
- | WaveformsCompleted ![ChunkNum]
- | Warn !Stack.Stack !Text
- | Failure !Text
emitMessage :: HasCallStack => Message -> IO.IO ()
parseMessage :: Text -> Maybe.Maybe Message
pathToBlockId :: IO.FilePath -> Id.BlockId

Documentation

type ChunkNum = Int Source #

Index into the audio chunks for a single instrument render. This is the same as ChunkNum.

data Config Source #

Constructors

Config
Fields imDir :: IO.FilePath All of the data files used by the Im backend are based in this directory. Everything in here should be temporary files, used for communication or caching. synths :: Map SynthName Synth

Instances

Instances details

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

getConfig :: IO.IO Config Source #

getLogFilename :: String -> IO.IO IO.FilePath Source #

config :: Path.AppDir -> Config Source #

data Synth Source #

Constructors

Synth
Fields synthName :: !IO.FilePath This should uniquely determine the synth, since it becomes the notes filename. binary :: !IO.FilePath Path to the binary. Don't run a binary if it's empty.

Instances

Instances details

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

type SynthName = Text Source #

nessName :: SynthName Source #

samplerName :: SynthName Source #

sampler :: Synth Source #

samplerRoot :: Path.Relative Source #

Base directory for sampler patches.

unsafeSamplerRoot :: IO.FilePath Source #

This is samplerRoot, but as an absolute path.

Technically, Path.get_app_dir is in IO, so I can't get an absolute path without IO. However, I need to put the absolute path in the Thru play msgs (ultimately since play_cache runs with an unknown CWD), and it gets really annoying to try to get a Path.AppDir into the thru function's closure. So unsafePerformIO it is. I could probably just put that on app_dir, but this is the only thing that actually needs it.

faustName :: SynthName Source #

faust :: Synth Source #

ness :: Synth Source #

notesParentDir :: IO.FilePath Source #

All serialized notes are in im / notesParentDir.

cacheDir :: IO.FilePath Source #

All rendered output is in im / cacheDir.

samplingRate :: Int Source #

All im synths render at this sampling rate, and the sequencer sets the start time by it.

type SamplingRate = 44100 Source #

chunkSize :: AudioT.Frames Source #

Save an audio chunk and checkpoint in this many frames.

A smaller size will lead to more checkpoints, which means finer grained caching, but more overhead saving the intermediate states. So a slower synthesizer with smaller state should use small chunks, fast rendering or large state imply large chunks. I could in theory adjust this per synthesizer, though currently karya relies on it being constant.

blockSize :: AudioT.Frames Source #

Number of frames in each audio block. A chunk corresponds to the output file size, and the block is the internal processing size.

To make sure checkpoint states line up with the file boundaries, this must divide into chunkSize.

chunkSeconds :: Int Source #

startLatency :: AudioT.Frames Source #

play_cache delays play start by this many frames, so MIDI output should also be delayed by this much to match.

It has to cue up the sample streaming, which means it has to find and seek to the right file. If playback starts immediately then the first chunk gets cut off, which cuts off note attacks.

thruPort :: Socket.PortNumber Source #

cache files

notesFilename Source #

Arguments

:: IO.FilePath
-> IO.FilePath	Path to the score, relative to the save dir. This should uniquely identify this score.
-> Id.BlockId
-> Synth
-> IO.FilePath

Write serialized notes to this file.

notesDirectory :: IO.FilePath -> IO.FilePath -> Id.BlockId -> IO.FilePath Source #

outputDirectory :: IO.FilePath -> IO.FilePath -> Id.BlockId -> IO.FilePath Source #

Top level output for for a block render. It will have directories below it for each instrument.

chunkPath :: IO.FilePath -> IO.FilePath -> Id.BlockId -> ScoreT.Instrument -> ChunkNum -> IO.FilePath Source #

Get the filename for a particular checkpoint.

chunkName :: ChunkNum -> IO.FilePath Source #

isOutputLink :: IO.FilePath -> Maybe.Maybe ChunkNum Source #

This relies on the format from chunkName.

playFilename :: IO.FilePath -> Id.BlockId -> IO.FilePath Source #

This is text sent over MIDI to tell play_cache which directory to play from. Relative to imDir/cacheDir.

idFilename :: Id.Ident a => a -> IO.FilePath Source #

clearUnusedInstruments :: IO.FilePath -> HashSet ScoreT.Instrument -> IO.IO () Source #

Delete output links for instruments that have disappeared entirely. This often happens when I disable a track.

instrumentToDir :: ScoreT.Instrument -> IO.FilePath Source #

There is a subdirectory for each instrument. There has to be a direct correspondance with ScoreT.Instrument, because clearUnusedInstruments uses it.

dirToInstrument :: IO.FilePath -> ScoreT.Instrument Source #

listDir :: IO.FilePath -> IO.IO [IO.FilePath] Source #

progress

data Message Source #

Constructors

Message
Fields _blockId :: !Id.BlockId _trackIds :: !(Set Id.TrackId) _instrument :: !ScoreT.Instrument _payload :: !Payload

Instances

Instances details

Generics.Generic Message Source #
Instance details Defined in Synth.Shared.Config Associated Types type Generics.Rep Message :: Type -> Type # Methods from :: Message -> Generics.Rep Message x # to :: Generics.Rep Message x -> Message #
Show Message Source #
Instance details Defined in Synth.Shared.Config Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #
FromJSON Message Source #
Instance details Defined in Synth.Shared.Config Methods parseJSON :: Value -> Parser Message # parseJSONList :: Value -> Parser [Message] #
ToJSON Message Source #
Instance details Defined in Synth.Shared.Config Methods toJSON :: Message -> Value # toEncoding :: Message -> Encoding # toJSONList :: [Message] -> Value # toEncodingList :: [Message] -> Encoding #
type Generics.Rep Message Source #
Instance details Defined in Synth.Shared.Config type Generics.Rep Message = Generics.D1 ('Generics.MetaData "Message" "Synth.Shared.Config" "main" 'False) (Generics.C1 ('Generics.MetaCons "Message" 'Generics.PrefixI 'True) ((Generics.S1 ('Generics.MetaSel ('Maybe.Just "_blockId") 'Generics.NoSourceUnpackedness 'Generics.SourceStrict 'Generics.DecidedStrict) (Generics.Rec0 Id.BlockId) Generics.:: Generics.S1 ('Generics.MetaSel ('Maybe.Just "_trackIds") 'Generics.NoSourceUnpackedness 'Generics.SourceStrict 'Generics.DecidedStrict) (Generics.Rec0 (Set Id.TrackId))) Generics.:: (Generics.S1 ('Generics.MetaSel ('Maybe.Just "_instrument") 'Generics.NoSourceUnpackedness 'Generics.SourceStrict 'Generics.DecidedStrict) (Generics.Rec0 ScoreT.Instrument) Generics.:*: Generics.S1 ('Generics.MetaSel ('Maybe.Just "_payload") 'Generics.NoSourceUnpackedness 'Generics.SourceStrict 'Generics.DecidedStrict) (Generics.Rec0 Payload))))

data Payload Source #

Constructors

RenderingRange !RealTime !RealTime
WaveformsCompleted ![ChunkNum]	Completed waveforms.
Warn !Stack.Stack !Text
Failure !Text	A failure will cause karya to log the msg and mark the track as incomplete. It should be fatal, so don't do any `emitMessage` afterwards.

Instances

Instances details

Generics.Generic Payload Source #
Instance details Defined in Synth.Shared.Config Associated Types type Generics.Rep Payload :: Type -> Type # Methods from :: Payload -> Generics.Rep Payload x # to :: Generics.Rep Payload x -> Payload #
Show Payload Source #
Instance details Defined in Synth.Shared.Config Methods showsPrec :: Int -> Payload -> ShowS # show :: Payload -> String # showList :: [Payload] -> ShowS #
FromJSON Payload Source #
Instance details Defined in Synth.Shared.Config Methods parseJSON :: Value -> Parser Payload # parseJSONList :: Value -> Parser [Payload] #
ToJSON Payload Source #
Instance details Defined in Synth.Shared.Config Methods toJSON :: Payload -> Value # toEncoding :: Payload -> Encoding # toJSONList :: [Payload] -> Value # toEncodingList :: [Payload] -> Encoding #
type Generics.Rep Payload Source #
Instance details Defined in Synth.Shared.Config type Generics.Rep Payload = Generics.D1 ('Generics.MetaData "Payload" "Synth.Shared.Config" "main" 'False) ((Generics.C1 ('Generics.MetaCons "RenderingRange" 'Generics.PrefixI 'False) (Generics.S1 ('Generics.MetaSel ('Maybe.Nothing :: Maybe.Maybe Symbol) 'Generics.NoSourceUnpackedness 'Generics.SourceStrict 'Generics.DecidedStrict) (Generics.Rec0 RealTime) Generics.:: Generics.S1 ('Generics.MetaSel ('Maybe.Nothing :: Maybe.Maybe Symbol) 'Generics.NoSourceUnpackedness 'Generics.SourceStrict 'Generics.DecidedStrict) (Generics.Rec0 RealTime)) Generics.:+: Generics.C1 ('Generics.MetaCons "WaveformsCompleted" 'Generics.PrefixI 'False) (Generics.S1 ('Generics.MetaSel ('Maybe.Nothing :: Maybe.Maybe Symbol) 'Generics.NoSourceUnpackedness 'Generics.SourceStrict 'Generics.DecidedStrict) (Generics.Rec0 [ChunkNum]))) Generics.:+: (Generics.C1 ('Generics.MetaCons "Warn" 'Generics.PrefixI 'False) (Generics.S1 ('Generics.MetaSel ('Maybe.Nothing :: Maybe.Maybe Symbol) 'Generics.NoSourceUnpackedness 'Generics.SourceStrict 'Generics.DecidedStrict) (Generics.Rec0 Stack.Stack) Generics.:: Generics.S1 ('Generics.MetaSel ('Maybe.Nothing :: Maybe.Maybe Symbol) 'Generics.NoSourceUnpackedness 'Generics.SourceStrict 'Generics.DecidedStrict) (Generics.Rec0 Text)) Generics.:+: Generics.C1 ('Generics.MetaCons "Failure" 'Generics.PrefixI 'False) (Generics.S1 ('Generics.MetaSel ('Maybe.Nothing :: Maybe.Maybe Symbol) 'Generics.NoSourceUnpackedness 'Generics.SourceStrict 'Generics.DecidedStrict) (Generics.Rec0 Text))))

emitMessage :: HasCallStack => Message -> IO.IO () Source #

parseMessage :: Text -> Maybe.Maybe Message Source #

pathToBlockId :: IO.FilePath -> Id.BlockId Source #

Infer namespace/block from ...imcache$scorePath$scoreFname$namespace$block/$instrument