Skip to content

user-guide.md

Latest commit

 

History

History
265 lines (212 loc) · 8.98 KB

user-guide.md

File metadata and controls

265 lines (212 loc) · 8.98 KB

Modurust DAW User Guide

⚠️ CRITICAL: Implementation Status

This guide documents features that are NOT YET IMPLEMENTED. Current application only shows basic visual nodes with test tone audio.

Getting Started

First Launch - ACTUAL REALITY

  1. Build from Source: No releases available - must compile
  2. Run the Application: cargo run opens basic UI window
  3. Audio Setup: Basic CPAL initialization only - no device configuration
  4. MIDI Setup: ❌ NOT IMPLEMENTED - No MIDI support

Interface Overview - WHAT ACTUALLY WORKS

Modurust has a three-view system with LIMITED functionality:

Arrangement View (Default) - ❌ NOT FUNCTIONAL

  • Timeline: ❌ Not implemented
  • Tracks: ❌ No mixer functionality
  • Transport: ❌ No play/stop/record controls
  • Browser: ❌ No file management

Live View - ❌ NOT IMPLEMENTED

  • Clip Matrix: ❌ No live performance features
  • Scenes: ❌ No scene management
  • Crossfader: ❌ No crossfading
  • Performance Controls: ❌ No real-time manipulation

Node View - ✅ PARTIALLY WORKING

  • Visual Patching: ✅ Visual nodes can be dragged
  • Node Library: ✅ 8 visual node types (no audio function)
  • Connections: ✅ Visual connections (no signal flow)
  • Real-time Editing: ✅ Visual editing only (no audio processing)

Desktop Demo Walkthrough - ⚠️ LIMITED FUNCTIONALITY

⚠️ WARNING: This demo script documents INTENDED functionality, not current reality

What Actually Works:

  • ✅ Visual Node Creation: Can add visual nodes to canvas
  • ✅ Node Dragging: Can move nodes around
  • ✅ Visual Connections: Can draw lines between nodes
  • ✅ Parameter Sliders: UI sliders exist (no audio effect)

What Does NOT Work:

  • ❌ Audio Output: Only basic test tones, not connected to nodes
  • ❌ Play/Stop Controls: No functional transport
  • ❌ Parameter Changes: Sliders move but don't affect audio
  • ❌ Real-time Processing: No audio signal flow

Current Demo Experience:

cargo run
# Opens window with basic UI
# Can see and drag visual nodes
# Can draw connections
# No meaningful audio processing

Intended Demo (NOT YET IMPLEMENTED):

  • Open Node View and add nodes in order: Sine Oscillator → Low-Pass Filter (LPF) → Delay → Output.
  • Create connections: Osc → LPF → Delay → Output.
  • Click Play to enable audio; use Stop to disable.
  • Select a node to reveal its parameter panel:
    • Oscillator: adjust Frequency (e.g., 220–880 Hz).
    • LPF: adjust Cutoff (e.g., 200–8000 Hz).
    • Delay: adjust Feedback (e.g., 0.0–0.8).
  • Canvas controls for visuals:
    • Sides slider (3–12) re-renders polygon nodes (default 6 = hex).
    • Ports on vertices moves ports to corners; wiring remains valid.
    • Lock Nodes and Grid Snap affect drag behavior.
  • Expected: audible output via CPAL; parameter tweaks change sound immediately.

Basic Workflow

Creating a New Project

  1. File Menu → New Project
  2. Choose Template: Empty, Drum Kit, Synth Setup, etc.
  3. Set Parameters: Sample rate, buffer size, tempo
  4. Save Location: Choose project directory

Adding Audio

  1. Import Audio: Drag files into the browser or use File → Import
  2. Create Track: Right-click in arrangement view
  3. Add Clip: Drag audio file to track
  4. Adjust Timing: Move and resize clips on timeline

Recording

  1. Arm Track: Click record button on track header
  2. Set Levels: Adjust input gain in mixer
  3. Start Recording: Use transport record button
  4. Monitor: Use headphones to avoid feedback

Audio Nodes

Generator Nodes

  • Oscillator: Sine, square, sawtooth, triangle waves
  • Noise: White, pink, brown noise generators
  • Sampler: Load and play audio files
  • Granular: Advanced granular synthesis

Effect Nodes

  • Filter: Low-pass, high-pass, band-pass, notch
  • Delay: Digital delay with feedback
  • Reverb: Algorithmic and convolution reverbs
  • Distortion: Various saturation and overdrive types

Utility Nodes

  • Mixer: Combine multiple audio signals
  • Splitter: Route one signal to multiple destinations
  • Analyzer: Real-time spectrum and waveform display
  • MIDI-to-CV: Convert MIDI to control voltage

MIDI 2.0 and MPE

MIDI 2.0 Setup

  1. Device Detection: DAW automatically detects MIDI 2.0 devices
  2. Channel Configuration: Assign channels to tracks
  3. Controller Mapping: Map CC messages to parameters

MPE (MIDI Polyphonic Expression)

  1. Enable MPE: In device settings
  2. Zone Configuration: Set up MPE zones
  3. Per-Note Control: Pitch bend, pressure, timbre per note
  4. Advanced Mapping: Custom parameter assignments

AI Tools

SAI (Sonic AI)

  1. Text Prompt: Describe the sound you want
  2. Parameters: Duration, complexity, style
  3. Generation: AI creates audio from description
  4. Refinement: Iterate with additional prompts

Stream Diffusion

  1. Audio Input: Select source audio
  2. Diffusion Settings: Amount, style, intensity
  3. Real-time Processing: Apply effects live
  4. Parameter Automation: Control via MIDI/automation

Stem Separation

  1. Load Mix: Import full mix
  2. AI Analysis: Separate into stems (vocals, drums, bass, etc.)
  3. Individual Processing: Edit stems separately
  4. Reconstruction: Recombine with new balance

Automation

Creating Automation

  1. Show Automation: Click automation button on track
  2. Draw Curves: Click and drag to create automation
  3. Parameter Mapping: Right-click parameters to automate
  4. MIDI Learn: Assign MIDI controllers to parameters

Automation Modes

  • Linear: Straight line interpolation
  • Smooth: Curved interpolation
  • Step: Instant value changes
  • Relative: Percentage-based changes

Effects and Processing

Real-time Effects

  1. Insert Effects: Add to individual tracks
  2. Send Effects: Shared effects via aux sends
  3. Master Bus: Overall mix processing
  4. Sidechain: Trigger effects with other signals

Built-in Effects

  • EQ: 4-band parametric equalizer
  • Compressor: Dynamics processing
  • Reverb: Space simulation
  • Delay: Echo effects
  • Chorus: Modulation effects
  • Phaser: Phase shifting
  • Distortion: Wave shaping

Export and Sharing

Audio Export

  1. File Menu → Export
  2. Format Selection: WAV, AIFF, MP3, FLAC
  3. Quality Settings: Bit depth, sample rate
  4. Stem Export: Individual tracks or groups

Project Sharing

  1. Save Project: Includes all assets and settings
  2. Collaboration: Share projects with other users
  3. Version Control: Track changes and revisions
  4. Backup: Automatic project backups

Advanced Features

Node Graph Programming

  1. Visual Programming: Connect nodes with cables
  2. Modular Synthesis: Create custom signal chains
  3. Real-time Patching: Modify while playing
  4. Preset Management: Save and recall patches

Live Performance

  1. Scene Management: Prepare multiple arrangements
  2. Clip Launching: Trigger clips with pads/controllers
  3. Parameter Mapping: Control everything via MIDI
  4. Backup Plans: Redundant systems for live shows

Web Integration

  1. Browser Interface: Access DAW from web browser
  2. Remote Control: Control from mobile devices
  3. Collaboration: Real-time multi-user editing
  4. Cloud Storage: Projects stored in the cloud

Troubleshooting

Audio Issues

  • No Sound: Check audio device selection and levels
  • Latency: Adjust buffer size in settings
  • Dropouts: Reduce CPU load or increase buffer size
  • Distortion: Check levels and gain staging

MIDI Issues

  • No MIDI: Verify device connections and drivers
  • Wrong Messages: Check MIDI channel assignments
  • Timing Issues: Calibrate MIDI timing if needed

Performance Issues

  • High CPU: Close unnecessary applications
  • Memory Usage: Reduce project complexity
  • UI Lag: Lower UI refresh rate if needed

Keyboard Shortcuts

Transport

  • Space: Play/Stop
  • Enter: Record
  • R: Record mode toggle
  • L: Loop toggle

Navigation

  • 1/2/3: Switch between views (Arrangement/Live/Node)
  • Tab: Cycle through tracks
  • Arrow Keys: Navigate timeline/clips

Editing

  • Ctrl+C/V/X: Copy/Paste/Cut
  • Delete: Remove selected items
  • Ctrl+Z/Y: Undo/Redo
  • Ctrl+A: Select all

Best Practices

Gain Staging

  • Keep levels around -18dBFS during mixing
  • Use compressors for dynamic control
  • Avoid clipping at any stage

Organization

  • Use descriptive names for tracks and clips
  • Group related tracks with colors
  • Save versions regularly

Performance

  • Freeze tracks when not editing
  • Use sends for shared effects
  • Monitor CPU and memory usage

This guide covers the essential features and workflows for getting started with Modurust DAW. Explore the interface and experiment with different features to discover the full potential of this revolutionary audio workstation.