| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell98 |
Sound.Jammit.Base
Description
Basic types and functions for dealing with Jammit song packages.
- data Instrument
- data Part
- data AudioPart
- data SheetPart
- titleToPart :: String -> Maybe Part
- titleToAudioPart :: String -> Instrument -> Maybe AudioPart
- partToInstrument :: Part -> Instrument
- audioPartToInstrument :: AudioPart -> Instrument
- data Info = Info {
- album :: String
- artist :: String
- bpm :: String
- copyright :: String
- countInBeats :: Integer
- courtesyOf :: String
- demo :: Bool
- explicit :: Bool
- genre :: String
- instrument :: Instrument
- publishedBy :: String
- skillLevel :: SkillLevel
- sku :: String
- slow :: Double
- title :: String
- version :: Integer
- writtenBy :: String
- loadInfo :: FilePath -> IO (Maybe Info)
- data Track = Track {}
- loadTracks :: FilePath -> IO (Maybe [Track])
- data SkillLevel
- = OneSkill Integer
- | ManySkills [(Instrument, Integer)]
- findJammitDir :: IO (Maybe FilePath)
- songSubdirs :: FilePath -> IO [FilePath]
- data Beat = Beat {
- isDownbeat :: Bool
- isGhostBeat :: Bool
- position :: Double
- loadBeats :: FilePath -> IO (Maybe [Beat])
- loadGhost :: FilePath -> IO (Maybe [Beat])
- data Section = Section {}
- loadSections :: FilePath -> IO (Maybe [Section])
- findNotation :: Track -> FilePath -> IO [FilePath]
- findTab :: Track -> FilePath -> IO [FilePath]
- findAudio :: Track -> FilePath -> IO (Maybe FilePath)
- sheetWidth :: Num a => a
- sheetHeight :: Num a => a
Documentation
data Instrument Source
The Enum instance corresponds to the number used in the instrument
property, and the names (used by Show and Read) are capitalized versions
of those used in the skillLevel property.
Constructors
| PartGuitar1 | Used for both Guitar and Guitar 1 |
| PartGuitar2 | |
| PartBass | |
| PartDrums1 | Used for both Drums and Drums 1 |
| PartDrums2 | Rarely used. Seen in "Space Truckin'" |
| PartKeys1 | Used for both Keys and Keys 1 |
| PartKeys2 | |
| PartPiano | Rarely used. Seen in "The Answer Lies Within" and "Wait for Sleep" |
| PartSynth | Rarely used. Seen in "Wait for Sleep" |
| PartOrgan | Rarely used. Seen in "Smoke on the Water" |
| PartVocal | |
| PartBVocals |
Constructors
| Only Part | An audio file for a single notated part. |
| Without Instrument | The backing track for an instrument package. |
titleToPart :: String -> Maybe Part Source
titleToAudioPart :: String -> Instrument -> Maybe AudioPart Source
partToInstrument :: Part -> Instrument Source
Constructors
| Info | |
Fields
| |
Constructors
| Track | |
Fields | |
findJammitDir :: IO (Maybe FilePath) Source
Tries to find the top-level Jammit library directory on Windows or Mac OS X.
songSubdirs :: FilePath -> IO [FilePath] Source
Searches a directory and all subdirectories for folders containing a Jammit info file.
Constructors
| Beat | |
Fields
| |
Constructors
| Section | |
Fields
| |
sheetWidth :: Num a => a Source
sheetHeight :: Num a => a Source