monolith.h, monolith.c, main.c, jmonolith.c

• 1. Statement Of Purpose
• 1.1. Principles
• 1.1.1. Preservation
• 1.1.2. Mostly in-the-box, but who cares about that
• 1.1.3. Anti-DAW, Anti-Mouse
• 1.1.4. Architects build Gardens

• 2. Core Program Structure
• 3. Top-level
• 3.1. Header File
• 3.2. C file
• 3.3. main.c
• 3.4. Version Number
• 3.5. Subprograms
• 3.5.1. Check for SQLar
• 3.5.2. Check for Runt
• 3.5.3. Check for Janet
• 3.5.4. mkimg
• 3.5.5. Stretcher
• 3.5.6. JPM (Janet Plugin Manager)
• 3.5.7. cfloop
• 3.5.8. scrambler
• 3.5.9. wavdraw
• 3.5.10. sndkit
• 3.5.11. minimp4

• 4. Global Data
• 4.1. typedef
• 4.2. global variable
• 4.3. getting global variable
• 4.4. data init
• 4.5. data cleanup

• 5. DSP Kernel
• 5.1. Top-level Kernel Compute
• 5.1.1. Computing graforge blocks
• 5.1.2. Swapping in the Audio callback
• 5.2. Hot Swapping
• 5.2.1. The Monolith Audio Cable
• 5.2.2. Cable Output Node (monout)
• 5.2.3. Cable Input Node (monin)
• 5.2.4. Swap Flag
• 5.3. Play/Pause
• 5.3.1. Play/Pause Flags
• 5.3.2. Check if Monolith is Playing
• 5.3.3. Play/Pause functions
• 5.4. Crossfade
• 5.4.1. Enabling/Disabling Crossfade
• 5.4.1.1. Enabling/Disabling Crossfade in C
• 5.4.1.2. Enabling/Disabling Crossfade in Scheme
• 5.4.2. Setting Crossfade size
• 5.4.2.1. Setting the Crossfade Size in C
• 5.4.2.2. Setting the Crossfade Size in Scheme
• 5.4.3. Crossfade Struct Contents
• 5.4.4. Crossfade State
• 5.4.5. Starting crossfades
• 5.4.6. Computing both blocks
• 5.4.7. Crossfade computation
• 5.4.8. Crossfade Cleanup

• 6. Graforge and Soundpipe
• 6.1. Graforge Top
• 6.2. samplerate
• 6.3. Seeding
• 6.3.1. Seeding In C
• 6.3.2. Seeding in Scheme
• 6.4. ftables
• 6.4.1. creating an ftable
• 6.4.1.1. creating an ftable in C
• 6.4.1.2. ftable creation in scheme (monolith:ftbl-create)
• 6.4.1.3. ftable creation in janet (monolith/ftbl-create)
• 6.4.2. destroying the ftable
• 6.4.3. accessing an ftable
• 6.4.3.1. monolith_ftbl_get
• 6.4.3.2. DONE monft
• 6.4.4. saving/loading an ftable
• 6.4.4.1. Low Level C functions
• 6.4.4.2. Pop-n-Save (Scheme)
• 6.4.4.3. Pop-n-Load (Scheme)
• 6.4.5. initializaing an ftable dictionary entry
• 6.5. Re-allocating graforge
• 6.5.1. Reallocation in C
• 6.5.2. Reallocation in Scheme
• 6.6. Resetting Graforge Error Flag
• 6.6.1. Reset the PW error Flag in C
• 6.6.2. Reset the PW error flag in Scheme

• 7. Audio Render Thread
• 7.1. JACK audio
• 7.1.1. JACK data
• 7.1.2. JACK callbacks
• 7.1.3. Starting Audio
• 7.1.3.1. In C
• 7.1.3.2. In Scheme
• 7.1.3.3. In Janet
• 7.1.4. Stopping Audio

• 8. Virtual Interface Layer
• 8.1. Monome Interface
• 8.1.1. Monome Interface Top-level Declaration
• 8.1.2. Monome Interface Struct
• 8.1.3. Monome Initialization
• 8.1.4. Top-level monolith data reference
• 8.1.5. Monome User Data
• 8.1.6. LED press
• 8.1.7. LED set
• 8.1.7.1. LED set callback
• 8.1.7.2. LED set setter
• 8.1.7.3. LED set in scheme
• 8.1.8. LED row
• 8.1.8.1. LED row callback
• 8.1.8.2. LED row setter
• 8.1.8.3. LED row in scheme
• 8.1.8.4. LED row (16-bit)
• 8.1.9. LED all
• 8.1.9.1. LED all callback
• 8.1.9.2. LED all setter
• 8.1.9.3. LED all in scheme
• 8.1.10. DONE LED Column
• 8.1.10.1. DONE LED column callback
• 8.1.10.2. DONE LED column setter
• 8.1.10.3. DONE LED column in scheme
• 8.2. Griffin Knob Interface
• 8.2.1. Griffin Top-Level Declaration
• 8.2.2. Griffin Struct
• 8.2.3. Griffin Top-level struct reference
• 8.2.4. Griffin Initialization
• 8.2.5. Griffin User Data
• 8.2.6. Griffin Knob Turn
• 8.2.7. Griffin Push
• 8.2.7.1. Griffin Push in C
• 8.2.7.2. Griffin Press in Scheme
• 8.3. Arc Interface
• 8.3.1. Arc Interface Top-Level Declaration
• 8.3.2. Arc Interface Struct
• 8.3.3. Arc Initialization
• 8.3.4. Top-level Arc Data Reference
• 8.3.5. Arc User Data
• 8.3.6. Arc Delta
• 8.3.7. Arc Map
• 8.3.8. Arc All

• 9. Runt
• 9.1. Core Data
• 9.2. Runt Initialization
• 9.2.1. The Main Runt Loader
• 9.2.1.1. The Runt Loader in C (monolith_runt_loader)
• 9.2.1.2. Runt Loader in Scheme (monolith:runt-loader)
• 9.2.1.3. DONE Runt Loader in Janet (monolith/runt-loader)
• 9.2.2. A Runt Loader for the Runt Interpreter
• 9.2.3. Monolith Runt Functions
• 9.2.4. Auxiliary Runt Words and Libraries
• 9.3. Runt Evaluation
• 9.3.1. In C
• 9.3.2. In Scheme
• 9.3.3. In Janet
• 9.4. Runt Mark Set
• 9.5. Creating a new runt keyword
• 9.6. Runt Word Search Loader
• 9.7. Runt Libraries
• 9.7.1. Runt-img
• 9.8. C Data, Runt and Janet Janet
• 9.8.1. Push/Pop Data from Janet
• 9.8.1.1. Pushing
• 9.8.1.2. Popping
• 9.8.2. TODO Push/Pop Data from Scheme
• 9.8.2.1. TODO Pushing
• 9.8.2.2. TODO Popping
• 9.8.3. TODO Set/Get Registers From Scheme
• 9.8.3.1. Getting
• 9.8.3.2. Setting
• 9.9. Next Free Register
• 9.9.1. Nextfree in C
• 9.9.2. Nextfree in Scheme
• 9.10. Loading More Runt Words
• 9.11. Retrieving Runt Graforge Pointer
• 9.12. Runt + Scheme Error Handling

• 10. Scheme
• 10.1. Scheme Loader
• 10.2. Scheme Primitives Table
• 10.3. Scheme Page Loader
• 10.3.1. Grid Page
• 10.3.2. Sliders Page
• 10.3.3. Step Page
• 10.3.4. Line16 Page
• 10.3.5. Foo Loader
• 10.3.6. Knobs Page
• 10.3.7. Seq16 Page
• 10.3.8. Trig Page
• 10.4. Scheme Aux loader
• 10.4.1. SQLar Loader
• 10.4.2. Janet Loader
• 10.4.3. SQLar wavread
• 10.4.4. Graphics
• 10.4.5. Gest
• 10.4.6. Nodes
• 10.5. Scheme Sample Foo Function

• 11. Pages
• 11.1. Active Page Selection
• 11.1.1. Find and set a page
• 11.1.2. Scheme Function
• 11.1.3. Janet Function
• 11.2. Checking if a Page is Selected
• 11.3. Page Dictionary (included in top-level struct)
• 11.3.1. Entry Page Lookup
• 11.3.1.1. Dictionary Lookup
• 11.3.1.2. Page Lookup
• 11.3.2. Entry Find
• 11.3.3. Entry Struct
• 11.3.4. Entry List
• 11.3.4.1. Entry List Struct
• 11.3.4.2. Entry List Initialization
• 11.3.4.3. Entry List Cleanup
• 11.3.4.4. Appending an Entry to an Entry-List
• 11.3.5. Dictionary Struct Initialization and Cleanup
• 11.3.6. Dictionary in Main Struct
• 11.3.7. Dictionary Hash
• 11.3.8. Dictionary Contents
• 11.3.8.1. Monolith Data Reference
• 11.3.8.2. Number of Types
• 11.3.8.3. Number of Words
• 11.3.8.4. Entry Lists
• 11.3.9. Type Handling
• 11.3.10. Page Entry Creation
• 11.3.11. Generic Entry Creation
• 11.3.12. TODO Erasing an Entry
• 11.4. Page Struct Declaration
• 11.5. User Data
• 11.6. Monolith Top-level data
• 11.7. Type Information
• 11.8. Page Callbacks
• 11.8.1. Page Open
• 11.8.2. Page Close
• 11.8.3. Page Monome key
• 11.8.4. Page Griffin Turn
• 11.8.5. Page Griffin Push
• 11.8.6. Page Arc Delta
• 11.8.7. Page Free
• 11.8.8. Page State Callbacks
• 11.8.8.1. Page Save
• 11.8.8.2. Page Load
• 11.9. Loading/Saving Page State
• 11.9.1. Saving Page Data
• 11.9.1.1. Saving Page Data in C
• 11.9.1.2. DONE Saving Page Data in Scheme
• 11.9.1.3. Saving Page Data in Janet
• 11.9.2. Loading Page Data
• 11.9.2.1. Loading Page Data in C
• 11.9.2.2. Loading Page Data in Scheme
• 11.9.2.3. Loading Page Data in Janet
• 11.10. Page Pin
• 11.11. Monome Page State
• 11.11.1. Monome Page State Data
• 11.11.1.1. Struct Declarations
• 11.11.1.2. Struct Initialization
• 11.11.1.3. Struct Creation/Destruction
• 11.11.1.4. State Data Getter
• 11.11.2. Monome Interface Wrapper
• 11.11.2.1. Wrapper for led_set
• 11.11.2.2. Wrapper led_row
• 11.11.2.3. Wrapper led_row16
• 11.11.2.4. Wrapper led_col
• 11.11.3. Monome Page State Recall
• 11.11.4. Setting/Getting XY value state
• 11.11.5. Checking if Monome State is actively selected
• 11.12. Arc Page State
• 11.12.1. Arc Page State Data
• 11.12.1.1. Struct Declarations
• 11.12.1.2. Struct Initialization
• 11.12.1.3. Struct Creation/Destruction
• 11.12.1.4. State Data Getter/Setter
• 11.12.2. Arc Interface Wrapper
• 11.12.2.1. Wrapper for Map
• 11.12.3. Checking if Arc is actively selected
• 11.12.4. Arc State Recall
• 11.12.5. Map value to Arc
• 11.13. Page Lookup from Runt
• 11.14. Retrieve Graforge from Page
• 11.15. Print Page List
• 11.15.1. DONE Page List Creation
• 11.15.2. Sorting the page list
• 11.15.3. in C
• 11.15.4. in Scheme

• 12. Hardware Listener
• 12.1. Thread hardware listener callback
• 12.2. Monolith listener data
• 12.3. Starting/Stopping the hardware listener
• 12.4. Stopping the listener at cleanup
• 12.5. Single-threaded event polling

• 13. Monome Hardware (Arc, Grid) and Libmonome
• 13.1. Header Includes
• 13.2. Device Location (Platform-dependent)
• 13.3. Determining Device Path (Linux Only)
• 13.3.1. Path finder system includes
• 13.3.2. Get TTY Function
• 13.3.3. Get Grid Path
• 13.3.4. Get Arc Path
• 13.4. Libmonome Data (grid + arc)
• 13.5. Monome (Grid) Setup and Cleanup
• 13.5.1. Monome Setup/Cleanup Top-level Callbacks
• 13.5.2. Monome Press Handlers
• 13.5.3. Monome Virtual Interface Binding
• 13.5.3.1. Set Monome Hardware Data
• 13.5.3.2. Set Monome Hardware Press Callback
• 13.5.3.3. Set Monome LED set Callback
• 13.5.3.4. Set Monome LED row callback
• 13.5.3.5. Set Monome LED all callback
• 13.5.3.6. DONE Set Monome LED column Callback
• 13.6. Arc Setup and Cleanup
• 13.6.1. Arc Setup/Cleanup Top-level Callbacks
• 13.6.2. Arc Handlers
• 13.6.3. Arc Virtual Interface Binding
• 13.6.3.1. Set Arc Hardware Data
• 13.6.3.2. Set Arc Hardware Delta Callback
• 13.6.3.3. Set Arc Map Callback
• 13.6.3.4. Set Arc All Callback
• 13.7. Polling and Processing Monome/Arc Events
• 13.7.1. Monome (Grid)
• 13.7.2. DONE Arc

• 14. Griffin Hardware
• 14.1. hidapi system include
• 14.2. Griffin Hardware Data
• 14.3. Griffin Setup and Cleanup
• 14.4. Polling the Griffin
• 14.5. Set Griffin Callbacks
• 14.5.1. Set Default Turn Callback
• 14.5.2. Set Default Push Callback

• 15. Janet
• 15.1. tangled file
• 15.2. struct declarations
• 15.2.1. Janet Env
• 15.3. deinit
• 15.4. jex loader
• 15.5. DONE core monolith janet functions
• 15.6. Foo Janet Function

• 16. Error Handling
• 17. Norns
• 17.1. Top Level Constructs
• 17.2. TODO Monolith Drawing Thread
• 17.2.1. TODO Running flag
• 17.2.2. TODO Drawing Thread Data in Struct
• 17.2.3. TODO Opening + Allocating the framebuffer
• 17.2.3.1. In C (via monolith_norns_gfx_init)
• 17.2.3.2. In Janet (via monolith/norns-gfx-init)
• 17.2.4. TODO Starting the thread (user-level)
• 17.2.4.1. TODO From Scheme
• 17.2.4.2. TODO From Janet
• 17.2.5. TODO Drawing Thread at Cleanup
• 17.2.6. DONE Getting the buffers
• 17.2.7. TODO Updating the display (via the drawing thread)
• 17.3. Monolith Norns Event Polling
• 17.3.1. Event polling struct declaration
• 17.3.2. Setup + Start the norns listener
• 17.3.2.1. norns listener setup in C
• 17.3.2.2. norns listener setup in Janet
• 17.3.3. Stop + Clean the norns listener
• 17.3.4. Setting peripheral callbacks
• 17.3.4.1. Setting Buttons
• 17.3.4.2. Setting Knobs
• 17.3.5. Norns polling in the main event loop
• 17.3.6. Getting the poll data
• 17.4. Simple Loop
• 17.4.1. C Function (monolith_norns_simpleloop)
• 17.4.2. Janet Function (monolith/norns-simpleloop)
• 17.5. Norns Wait + Quit

• 18. Graphics
• 18.1. The Graphics Framebuffer
• 18.1.1. GFX Framebuffer Top-Level
• 18.1.1.1. GFX Framebuffer Struct Declaration
• 18.1.1.2. GFX Framebuffer Top-level initialization/cleanup
• 18.1.2. The Framebuffer Struct
• 18.1.3. A Single Pixel
• 18.1.4. The Pixel Array
• 18.1.5. Framebuffer Dimensions
• 18.1.6. Zoom Factor
• 18.2. The Zoom Buffer
• 18.3. Channels Interface
• 18.3.1. Channel Worgle Constructs
• 18.3.2. Channels Top Level Declaration
• 18.3.3. Channel Initialization
• 18.3.4. Channel Get
• 18.3.5. Channel Set
• 18.3.6. Channel Nodes + Words
• 18.3.6.1. monget
• 18.3.6.1.1. DONE monget node
• 18.3.6.1.2. DONE monget runt word
• 18.3.6.2. monset
• 18.3.6.2.1. monset node
• 18.3.6.2.2. monset runt word
• 18.4. H264 Video Support
• 18.4.1. x264 system include
• 18.4.2. h264 top level constructs
• 18.4.3. h264 top-level struct declaration
• 18.4.3.1. h264 struct entry
• 18.4.3.2. h264 struct init/cleanup
• 18.4.3.3. h264 struct retrieval
• 18.4.4. h264 video struct
• 18.4.5. h264 video initialization
• 18.4.6. h264 video cleanup
• 18.4.7. h264 video interface
• 18.4.7.1. begin
• 18.4.7.2. append
• 18.4.7.2.1. rgb2yuv
• 18.4.7.2.2. mkyuv
• 18.4.7.2.3. append C function
• 18.4.7.3. end
• 18.5. Image Loading and Storing
• 18.5.1. Image Struct
• 18.5.1.1. Typedef
• 18.5.1.2. Struct Contents
• 18.5.2. Loading Image Data
• 18.5.3. Freeing Image Data
• 18.5.4. Loading an image to a dictionary
• 18.5.5. Finding an entry
• 18.6. Setting/Getting Pixels
• 18.6.1. Get Pixel
• 18.6.2. Set Pixel in C

• 19. State
• 19.1. SQLite Header Include
• 19.2. Monolith State in Top-level Struct
• 19.3. Monolith State Data
• 19.4. Parameter and Schema State Data
• 19.4.1. Parameter Data
• 19.4.1.1. Parameter Struct Initialization/Cleanup
• 19.4.1.2. Parameter Struct Contents
• 19.4.1.2.1. Param Name
• 19.4.1.2.2. Param Type Flag
• 19.4.1.2.3. Param User Data
• 19.4.1.2.4. Param Destructor (Optional)
• 19.4.1.3. Parameter State Types
• 19.4.1.3.1. Type Enum Declaration
• 19.4.1.3.2. Floating Point Parameter
• 19.4.1.3.2.1. state_param_mkfloat
• 19.4.1.3.2.2. state_param_float
• 19.4.1.3.2.3. state_param_float_set
• 19.4.1.3.3. Integer Parameter
• 19.4.1.3.3.1. state_param_mkint
• 19.4.1.3.3.2. state_param_int
• 19.4.1.3.3.3. state_param_int_set
• 19.4.1.3.4. String Parameter
• 19.4.1.3.4.1. state_param_mkstring
• 19.4.1.3.4.2. state_param_string
• 19.4.1.3.5. Monome State Parameter
• 19.4.1.3.5.1. monome state type enum
• 19.4.1.3.5.2. state_param_mkmstate
• 19.4.1.3.5.3. state_param_mstate
• 19.4.1.3.5.4. state_param_mstate_set
• 19.4.1.3.6. DONE Blob Parameter [4/4
• 19.4.1.3.6.1. DONE Blob Enum
• 19.4.1.3.6.2. DONE state_param_mkblob
• 19.4.1.3.6.3. DONE state_param_blob
• 19.4.1.3.6.4. DONE state_param_blob_set
• 19.4.2. Monolith Schema Data
• 19.4.2.1. Schema Initialization/Cleanup
• 19.4.2.2. Schema Contents
• 19.4.2.2.1. Schema Struct Declaration
• 19.4.2.2.2. Param Array
• 19.4.2.2.3. Number of Parameters
• 19.4.2.3. Schema Parameter Setters/Getters
• 19.4.2.3.1. Schema Floating Point Parameter
• 19.4.2.3.2. Schema Integer Parameter
• 19.4.2.3.2.1. Integer Param Maker
• 19.4.2.3.2.2. Integer Param Getter
• 19.4.2.3.3. Schema String Parameter
• 19.4.2.3.3.1. String Param Maker
• 19.4.2.3.3.2. String Param Getter
• 19.4.2.3.3.3. Const String Param Getter
• 19.4.2.3.4. Schema Monolith State Parameter
• 19.4.2.3.4.1. Schema State Param Maker
• 19.4.2.3.4.2. Schema State Param Getter
• 19.4.2.3.5. DONE Schema Blob Parameter
• 19.4.2.3.5.1. DONE Blob Param Maker
• 19.4.2.3.5.2. DONE Blob Param Getter
• 19.4.2.3.5.3. DONE Blob Param Setter
• 19.4.3. Monolith Schema write test
• 19.5. How monome state data is stored
• 19.5.1. Encoding/Decoding 6 bit values
• 19.5.2. Encoding/Decoding a monome row
• 19.5.3. Encoding/Decoding a monome grid
• 19.5.4. Base64 Scheme functions
• 19.6. Generating SQL commands from Schema data
• 19.6.1. SQL Create Command from Schema
• 19.6.1.1. monolith_state_schema_sql_create
• 19.6.1.2. Parameter types
• 19.6.1.2.1. No Parameter
• 19.6.1.2.2. SQLite Float
• 19.6.1.2.3. SQLite Integer
• 19.6.1.2.4. SQLite String
• 19.6.1.2.5. SQLite Monome State
• 19.6.1.2.6. SQLite Blob
• 19.6.2. SQL Insert Command from Schema
• 19.6.3. SQL Select Command from Schema
• 19.7. SQLite File I/O
• 19.7.1. Opening/Closing a SQLite database.
• 19.7.2. A Note on Blobs
• 19.7.3. Writing a Schema to a SQLite database
• 19.7.4. Reading from a SQLite databse to a Schema
• 19.8. Opening/Closing a Monolith State database
• 19.8.1. Opening The Monolith State
• 19.8.1.1. Opening State From C
• 19.8.1.2. Opening State from Scheme
• 19.8.1.3. Opening State from Janet
• 19.8.2. Closing Monolith State
• 19.8.2.1. Closing the State from C
• 19.8.2.2. Closing the State from Scheme
• 19.8.2.3. Opening State from Janet
• 19.9. Raw SQLite commands on open state file
• 19.9.1. In C
• 19.9.2. In Scheme

• 20. Offline Rendering
• 20.1. What is Offline Rendering?
• 20.2. Manual Compute from Scheme

• 21. The G430 Interface
• 21.1. DONE Virtual Interface
• 21.1.1. DONE Top Level Declaration
• 21.1.2. DONE Struct
• 21.1.2.1. Typedef
• 21.1.2.2. Contents
• 21.1.2.2.1. User Data
• 21.1.2.2.2. Callback
• 21.1.2.2.3. HID handle
• 21.1.3. DONE Event Callback
• 21.1.4. DONE Initialization
• 21.2. DONE Hardware Polling
• 21.2.1. DONE Setup and Cleanup
• 21.2.2. DONE Polling
• 21.2.3. DONE Scheme Functions
• 21.3. DONE Default Behavior + Nodes
• 21.3.1. Set Default
• 21.3.2. Data
• 21.3.3. Callback
• 21.3.4. DONE Nodes
• 21.3.4.1. g430_val
• 21.3.4.1.1. Init
• 21.3.4.1.2. Compute
• 21.3.4.1.3. Destroy
• 21.3.5. DONE Runt Words
• 21.3.5.1. g430x
• 21.3.5.2. DONE g430y
• 21.3.5.3. DONE g430z
• 21.3.5.4. DONE g430s