Csound.Control.Gui

GUI (Graphical User Interface) elements are handy to change the parameters of the sound in real time. It includes sliders, knobs, rollers, buttons and other widgets.

A GUI element consists of two parts. They are view (how it looks) and logic (what's going on with it). For example a slider can be horizontal or vertical or green or yellow or small or big. It's the view of the slider. And a slider can produce a continuous signal within the given interval. It's a logic of the slider.

Let's talk about the view. The view is divided on two parts:

• where element is placed or Layout.
• all other properties or just Properties.

The layout is defined with very simple functions. There are vertical and horizontal grouping of the elements. We can scale the element within the group and include an empty space in the group. Everything is aligned (see Csound.Gui.Layout). Other properties include colors, fonts (size and type), borders, specific properties of the widgets (see Csound.Gui.Props).

Let's consider the logic. The logic consists of three parts:

• what is consumed (Output)
• what is produced (Input)
• what's going on inside (Inner)

A widget can react on values, produce values or do something useful. There are special types of widgets:

• Source - they produce values only
• Sink - they consume values only
• Display - something is going on inside them (for example, it can show a "hello world" message)

Widgets can be simple and compound. Simple widgets are primitive elements (sliders, knobs, rollers, buttons). We have a special constructors that produce simple widgets (see Csound.Gui.Widget). Compound widgets glue together several widgets. That is the view contains several elements and all of them involved in the logic of the widget.

Gui

data Gui

A visual representation of the GUI-element.

Instances

At Sig2 Sig2 a => At Sig2 Sig2 (Source a)

Defined in Csound.Control.Gui

Associated Types

type AtOut Sig2 Sig2 (Source a)

Methods

at :: (Sig2 -> Sig2) -> Source a -> AtOut Sig2 Sig2 (Source a)

At Sig (SE Sig) a => At Sig (SE Sig) (Source a)

Defined in Csound.Control.Gui

Associated Types

type AtOut Sig (SE Sig) (Source a)

Methods

at :: (Sig -> SE Sig) -> Source a -> AtOut Sig (SE Sig) (Source a)

At Sig2 (SE Sig2) a => At Sig2 (SE Sig2) (Source a)

Defined in Csound.Control.Gui

Associated Types

type AtOut Sig2 (SE Sig2) (Source a)

Methods

at :: (Sig2 -> SE Sig2) -> Source a -> AtOut Sig2 (SE Sig2) (Source a)

SigSpace a => SigSpace (Source a)

Defined in Csound.Control.Gui

Methods

mapSig :: (Sig -> Sig) -> Source a -> Source a

RenderCsd (Source ())

Defined in Csound.IO

Methods

renderCsdBy :: Options -> Source () -> IO String

csdArity :: Source () -> CsdArity

Sigs a => RenderCsd (Source a)

Defined in Csound.IO

Methods

renderCsdBy :: Options -> Source a -> IO String

csdArity :: Source a -> CsdArity

RenderCsd (Source (SE ()))

Defined in Csound.IO

Methods

renderCsdBy :: Options -> Source (SE ()) -> IO String

csdArity :: Source (SE ()) -> CsdArity

Sigs a => RenderCsd (Source (SE a))

Defined in Csound.IO

Methods

renderCsdBy :: Options -> Source (SE a) -> IO String

csdArity :: Source (SE a) -> CsdArity

Sigs a => RenderCsd (a -> Source (SE Sig2))

Defined in Csound.IO

Methods

renderCsdBy :: Options -> (a -> Source (SE Sig2)) -> IO String

csdArity :: (a -> Source (SE Sig2)) -> CsdArity

(Sigs a, Sigs b) => RenderCsd (a -> Source (SE b))

Defined in Csound.IO

Methods

renderCsdBy :: Options -> (a -> Source (SE b)) -> IO String

csdArity :: (a -> Source (SE b)) -> CsdArity

(Sigs a, Sigs b) => RenderCsd (a -> Source b)

Defined in Csound.IO

Methods

renderCsdBy :: Options -> (a -> Source b) -> IO String

csdArity :: (a -> Source b) -> CsdArity

type AtOut Sig2 Sig2 (Source a)

Defined in Csound.Control.Gui

type AtOut Sig2 Sig2 (Source a) = Source (AtOut Sig2 Sig2 a)

type AtOut Sig (SE Sig) (Source a)

Defined in Csound.Control.Gui

type AtOut Sig (SE Sig) (Source a) = Source (AtOut Sig (SE Sig) a)

type AtOut Sig2 (SE Sig2) (Source a)

Defined in Csound.Control.Gui

type AtOut Sig2 (SE Sig2) (Source a) = Source (AtOut Sig2 (SE Sig2) a)

type Widget a b = SE (Gui, Output a, Input b, Inner)

A widget consists of visible element (Gui), value consumer (Output) and producer (Input) and an inner state (Inner).

type Input a = a

Widgets that produce something has inputs.

type Output a = a -> SE ()

Widgets that consume something has outputs.

type Inner = SE ()

Widgets that just do something inside them or have an inner state.

type Sink a = SE (Gui, Output a)

A consumer of the values.

type Source a = SE (Gui, Input a)

A producer of the values.

type Display = SE Gui

A static element. We can only look at it.

type SinkSource a = SE (Gui, Output a, Input a)

widget :: SE (Gui, Output a, Input b, Inner) -> Widget a b

A widget constructor.

sink :: SE (Gui, Output a) -> Sink a

A consumer constructor.

source :: SE (Gui, Input a) -> Source a

A producer constructor.

display :: SE Gui -> Display

A display constructor.

sinkSource :: SE (Gui, Output a, Input a) -> SinkSource a

sinkSlice :: SinkSource a -> Sink a

sourceSlice :: SinkSource a -> Source a

mapSource :: (a -> b) -> Source a -> Source b

A handy function for transforming the value of producers.

mapGuiSource :: (Gui -> Gui) -> Source a -> Source a

A handy function for transforming the GUIs of producers.

mhor :: Monoid a => [Source a] -> Source a

Horizontal grouping of widgets that can produce monoidal values.

mver :: Monoid a => [Source a] -> Source a

Vertical grouping of widgets that can produce monoidal values.

msca :: Double -> Source a -> Source a

Scaling of widgets that can produce values.

joinSource :: Source (SE a) -> Source a

Hides the SE inside Source.

fromSource :: Source a -> SE a

fromSourceSE :: Source (SE a) -> SE a

resizeSource :: (Double, Double) -> Source a -> Source a

Resizes all default minimal sizes for all elements in the source. It affects the total sizes of the widgets. So for example if our UI is too big and it doesn't fir to the screen we can make it smaller by scaling:

resizeSource (0.75, 0.5) uiSource

Panels

panel :: Gui -> SE ()

Renders the GUI elements on the window. Rectangle is calculated automatically (window doesn't listens for keyboard events).

win :: String -> (Int, Int) -> Gui -> SE ()

Creates a window with the given name, size and content

win name (width, height) gui

panels :: [Gui] -> SE ()

Renders a list of panels.

panelBy :: String -> Maybe Rect -> Gui -> SE ()

Renders the GUI elements on the window. We can specify the window title and rectangle of the window.

keyPanel :: Gui -> SE ()

Renders the GUI elements on the window. Rectangle is calculated automatically (window listens for keyboard events).

keyWin :: String -> (Int, Int) -> Gui -> SE ()

keyPanels :: [Gui] -> SE ()

Renders a list of panels. Panels are sensitive to keyboard events.

keyPanelBy :: String -> Maybe Rect -> Gui -> SE ()

Renders the GUI elements on the window. We can specify the window title and rectangle of the window. Panesls are sensitive to keyboard events.

Re-exports

module Csound.Control.Gui.Layout

setOrient :: Orient -> Gui -> Gui

setEmphasis :: Emphasis -> Gui -> Gui

setFontType :: FontType -> Gui -> Gui

setFontSize :: Int -> Gui -> Gui

setTextColor :: Color -> Gui -> Gui

setColors :: Color -> Color -> Gui -> Gui

setColor2 :: Color -> Gui -> Gui

setColor1 :: Color -> Gui -> Gui

setMaterial :: Material -> Gui -> Gui

setLabel :: String -> Gui -> Gui

setBorder :: BorderType -> Gui -> Gui

forceProps :: [Prop] -> Gui -> Gui

Sets the properties for a GUI element on all levels.

type Color = Colour Double

The Csound colours.

data Orient

The orientation of the widget (slider, roller). This property is never needs to be set in practice. If this property is not set then default orientation is calculated from the bounding box of the widget. If the width is greater than the height then we need to use a horizontal widget otherwise it should be a vertical one.

Constructors

Hor

Ver

data FontType

Constructors

Helvetica

Courier

Times

Symbol

Screen

Dingbats

Instances

Default FontType

Defined in Csound.Typed.Gui.Types

Methods

def :: FontType

data Emphasis

Constructors

NoEmphasis

Italic

Bold

BoldItalic

Instances

Default Emphasis

Defined in Csound.Typed.Gui.Types

Methods

def :: Emphasis

data Material

The type of the material of the element. It affects sliders and buttons.

Constructors

NoPlastic

Plastic

Instances

Default Material

Defined in Csound.Typed.Gui.Types

Methods

def :: Material

data BorderType

Constructors

NoBorder

DownBoxBorder

UpBoxBorder

EngravedBorder

EmbossedBorder

BlackLine

ThinDown

ThinUp

Instances

Enum BorderType

Defined in Csound.Typed.Gui.Types

Methods

succ :: BorderType -> BorderType

pred :: BorderType -> BorderType

toEnum :: Int -> BorderType

fromEnum :: BorderType -> Int

enumFrom :: BorderType -> [BorderType]

enumFromThen :: BorderType -> BorderType -> [BorderType]

enumFromTo :: BorderType -> BorderType -> [BorderType]

enumFromThenTo :: BorderType -> BorderType -> BorderType -> [BorderType]

data Prop

Properties of the widgets.

Constructors

SetLabel String

SetMaterial Material

SetBoxType BoxType

SetColor1 Color

SetColor2 Color

SetTextColor Color

SetFontSize Int

SetFontType FontType

SetEmphasis Emphasis

SetSliderType SliderType

SetTextType TextType

SetButtonType ButtonType

SetOrient Orient

SetKnobType KnobType

SetLabelType LabelType

data Rect

A rectangle.

Constructors

Rect

Fields

• px :: Int
• py :: Int
• width :: Int
• height :: Int

Instances

Show Rect

Defined in Csound.Typed.Gui.BoxModel

Methods

showsPrec :: Int -> Rect -> ShowS

show :: Rect -> String

showList :: [Rect] -> ShowS

module Csound.Control.Gui.Widget

Lifters

An easy way to combine visuals for sound sources.

hlifts :: ([a] -> b) -> [Source a] -> Source b

Groups a list of Source-widgets. The visuals are horizontally aligned.

vlifts :: ([a] -> b) -> [Source a] -> Source b

Groups a list of Source-widgets. The visuals are vertically aligned.

gridLifts :: Int -> ([a] -> b) -> [Source a] -> Source b

Groups a list of Source-widgets. The visuals are put on the grid. The first argument is numer of elements i each row.

lift1 :: (a -> b) -> Source a -> Source b

The shortcut for mapSource.

hlift2 :: (a -> b -> c) -> Source a -> Source b -> Source c

Combines two sound sources. Visuals are aligned horizontally and the sound sources a grouped with the given function.

vlift2 :: (a -> b -> c) -> Source a -> Source b -> Source c

Combines two sound sources. Visuals are aligned vertically and the sound sources a grouped with the given function.

hlift3 :: (a -> b -> c -> d) -> Source a -> Source b -> Source c -> Source d

The same as hlift2 but for three sound sources.

vlift3 :: (a -> b -> c -> d) -> Source a -> Source b -> Source c -> Source d

The same as vlift2 but for three sound sources.

hlift4 :: (a -> b -> c -> d -> e) -> Source a -> Source b -> Source c -> Source d -> Source e

The same as hlift2 but for four sound sources.

vlift4 :: (a -> b -> c -> d -> e) -> Source a -> Source b -> Source c -> Source d -> Source e

The same as vlift2 but for four sound sources.

hlift5 :: (a1 -> a2 -> a3 -> a4 -> a5 -> b) -> Source a1 -> Source a2 -> Source a3 -> Source a4 -> Source a5 -> Source b

The same as hlift2 but for five sound sources.

vlift5 :: (a1 -> a2 -> a3 -> a4 -> a5 -> b) -> Source a1 -> Source a2 -> Source a3 -> Source a4 -> Source a5 -> Source b

The same as vlift2 but for five sound sources.

Lifters with visual scaling

hlifts' :: [Double] -> ([a] -> b) -> [Source a] -> Source b

Groups a list of Source-widgets. The visuals are horizontally aligned. It uses the list of proportions.

vlifts' :: [Double] -> ([a] -> b) -> [Source a] -> Source b

Groups a list of Source-widgets. The visuals are vertically aligned. It uses the list of proportions.

hlift2' :: Double -> Double -> (a -> b -> c) -> Source a -> Source b -> Source c

It's just like the hlift2 but two more parameters change visual scaling of the widgets.

vlift2' :: Double -> Double -> (a -> b -> c) -> Source a -> Source b -> Source c

It's just like the vlift2 but two more parameters change visual scaling of the widgets.

hlift3' :: Double -> Double -> Double -> (a -> b -> c -> d) -> Source a -> Source b -> Source c -> Source d

The same as hlift2' but for three sound sources.

vlift3' :: Double -> Double -> Double -> (a -> b -> c -> d) -> Source a -> Source b -> Source c -> Source d

The same as vlift2' but for three sound sources.

hlift4' :: Double -> Double -> Double -> Double -> (a -> b -> c -> d -> e) -> Source a -> Source b -> Source c -> Source d -> Source e

The same as hlift2' but for four sound sources.

vlift4' :: Double -> Double -> Double -> Double -> (a -> b -> c -> d -> e) -> Source a -> Source b -> Source c -> Source d -> Source e

The same as vlift2' but for four sound sources.

hlift5' :: Double -> Double -> Double -> Double -> Double -> (a1 -> a2 -> a3 -> a4 -> a5 -> b) -> Source a1 -> Source a2 -> Source a3 -> Source a4 -> Source a5 -> Source b

The same as hlift2' but for five sound sources.

vlift5' :: Double -> Double -> Double -> Double -> Double -> (a1 -> a2 -> a3 -> a4 -> a5 -> b) -> Source a1 -> Source a2 -> Source a3 -> Source a4 -> Source a5 -> Source b

The same as vlift2' but for five sound sources.

Monadic binds

hbind :: Source a -> (a -> Source b) -> Source b

Monadic bind with horizontal concatenation of visuals.

vbind :: Source a -> (a -> Source b) -> Source b

Monadic bind with vertical concatenation of visuals.

happly :: (a -> Source b) -> Source a -> Source b

Monadic apply with horizontal concatenation of visuals.

vapply :: (a -> Source b) -> Source a -> Source b

Monadic apply with vertical concatenation of visuals.

hmapM :: (a -> Source b) -> [a] -> Source [b]

Creates a list of sources with mapping a function and stacks them horizontally.

vmapM :: (a -> Source b) -> [a] -> Source [b]

Creates a list of sources with mapping a function and stacks them vertically.

hbind' :: Double -> Double -> Source a -> (a -> Source b) -> Source b

Monadic bind with horizontal concatenation of visuals. It expects scaling factors for visuals as first two arguments.

vbind' :: Double -> Double -> Source a -> (a -> Source b) -> Source b

Monadic bind with vertical concatenation of visuals. It expects scaling factors for visuals as first two arguments.

happly' :: Double -> Double -> (a -> Source b) -> Source a -> Source b

Monadic apply with horizontal concatenation of visuals. It expects scaling factors for visuals as first two arguments.

vapply' :: Double -> Double -> (a -> Source b) -> Source a -> Source b

Monadic apply with vertical concatenation of visuals. It expects scaling factors for visuals as first two arguments.

hmapM' :: [Double] -> (a -> Source b) -> [a] -> Source [b]

It's like hmapM but we can supply the list of relative sizes.

vmapM' :: [Double] -> (a -> Source b) -> [a] -> Source [b]

It's like hvapM but we can supply the list of relative sizes.

gridMapM :: Int -> (a -> Source b) -> [a] -> Source [b]

Creates a list of sources with mapping a function and puts them on the grid. The first argument is the number of items in the row.

Orphan instances

At Sig2 Sig2 a => At Sig2 Sig2 (Source a)

Associated Types

type AtOut Sig2 Sig2 (Source a)

Methods

at :: (Sig2 -> Sig2) -> Source a -> AtOut Sig2 Sig2 (Source a)

At Sig (SE Sig) a => At Sig (SE Sig) (Source a)

Associated Types

type AtOut Sig (SE Sig) (Source a)

Methods

at :: (Sig -> SE Sig) -> Source a -> AtOut Sig (SE Sig) (Source a)

At Sig2 (SE Sig2) a => At Sig2 (SE Sig2) (Source a)

Associated Types

type AtOut Sig2 (SE Sig2) (Source a)

Methods

at :: (Sig2 -> SE Sig2) -> Source a -> AtOut Sig2 (SE Sig2) (Source a)

SigSpace a => SigSpace (Source a)

Methods

mapSig :: (Sig -> Sig) -> Source a -> Source a