vibelang-http 0.3.0

HTTP REST API server for VibeLang
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
//! MIDI HTTP API endpoints.
//!
//! Provides endpoints for:
//! - Device discovery and management
//! - MIDI input/output routing
//! - Recording control
//! - Clock output control

use axum::{extract::State, http::StatusCode, Json};
use serde::{Deserialize, Serialize};
use std::sync::Arc;
use vibelang_core::types::MidiDeviceId;

use crate::AppState;

// ============================================================================
// DTOs
// ============================================================================

/// Information about a MIDI device.
#[derive(Debug, Serialize)]
pub struct MidiDeviceDto {
    pub id: u32,
    pub name: String,
    pub has_input: bool,
    pub has_output: bool,
}

/// Request to open a MIDI device.
#[derive(Debug, Deserialize)]
pub struct OpenDeviceRequest {
    pub device_id: u32,
}

/// Request to send a MIDI note.
#[derive(Debug, Deserialize)]
pub struct SendNoteRequest {
    pub device_id: u32,
    pub channel: u8,
    pub note: u8,
    pub velocity: Option<u8>,
}

/// Request to send a MIDI CC.
#[derive(Debug, Deserialize)]
pub struct SendCcRequest {
    pub device_id: u32,
    pub channel: u8,
    pub cc: u8,
    pub value: u8,
}

/// Request to start recording.
#[derive(Debug, Deserialize)]
pub struct StartRecordingRequest {
    pub device_id: u32,
    pub channel: Option<u8>,
}

/// Request to stop recording.
#[derive(Debug, Deserialize)]
pub struct StopRecordingRequest {
    pub device_id: u32,
    /// Quantization value for recorded notes (not yet implemented in backend).
    #[allow(dead_code)]
    pub quantize: Option<f64>,
}

/// Recorded note DTO.
/// Reserved for future use when stop_recording returns recording data.
#[derive(Debug, Serialize)]
#[allow(dead_code)]
pub struct RecordedNoteDto {
    pub beat: f64,
    pub note: u8,
    pub velocity: u8,
    pub duration: Option<f64>,
}

/// Recording result DTO.
/// Reserved for future use when stop_recording returns recording data.
#[derive(Debug, Serialize)]
#[allow(dead_code)]
pub struct RecordingResultDto {
    pub device_id: u32,
    pub note_count: usize,
    pub cc_count: usize,
    pub duration_beats: f64,
    pub notes: Vec<RecordedNoteDto>,
}

/// Request to enable/disable clock output.
/// Reserved for future unified clock control endpoint (currently enable/disable are separate endpoints).
#[derive(Debug, Deserialize)]
#[allow(dead_code)]
pub struct ClockOutputRequest {
    pub device_id: u32,
    pub enabled: bool,
}

/// Response for clock output status.
/// Reserved for future GET /midi/clock/status endpoint.
#[derive(Debug, Serialize)]
#[allow(dead_code)]
pub struct ClockStatusDto {
    pub device_id: u32,
    pub enabled: bool,
}

/// Error response.
#[derive(Debug, Serialize)]
pub struct ErrorResponse {
    pub error: String,
}

// ============================================================================
// Device Endpoints
// ============================================================================

/// List all available MIDI devices.
///
/// GET /midi/devices
pub async fn list_devices(State(_state): State<Arc<AppState>>) -> Json<Vec<MidiDeviceDto>> {
    // Note: This requires direct access to the MIDI handler.
    // For now, we'll use the midir crate directly here.
    use midir::{MidiInput, MidiOutput};

    let mut devices = Vec::new();
    let mut seen_names = std::collections::HashMap::new();

    // List input devices
    if let Ok(midi_in) = MidiInput::new("vibelang-http2-list") {
        for (idx, port) in midi_in.ports().iter().enumerate() {
            if let Ok(name) = midi_in.port_name(port) {
                devices.push(MidiDeviceDto {
                    id: idx as u32,
                    name: name.clone(),
                    has_input: true,
                    has_output: false,
                });
                seen_names.insert(name, idx);
            }
        }
    }

    // List output devices
    if let Ok(midi_out) = MidiOutput::new("vibelang-http2-list") {
        for port in midi_out.ports().iter() {
            if let Ok(name) = midi_out.port_name(port) {
                // Check if we already have this device from input
                if let Some(&existing_idx) = seen_names.get(&name) {
                    devices[existing_idx].has_output = true;
                } else {
                    let id = devices.len() as u32;
                    devices.push(MidiDeviceDto {
                        id,
                        name,
                        has_input: false,
                        has_output: true,
                    });
                }
            }
        }
    }

    Json(devices)
}

/// Open a MIDI input device.
///
/// POST /midi/input/open
pub async fn open_input(
    State(state): State<Arc<AppState>>,
    Json(req): Json<OpenDeviceRequest>,
) -> Result<StatusCode, (StatusCode, Json<ErrorResponse>)> {
    use vibelang_core::message::MidiMessage;
    use vibelang_core::Message;

    let device_id = MidiDeviceId::new(req.device_id);
    state
        .handle
        .send(Message::Midi(MidiMessage::OpenInput { device: device_id }))
        .await
        .map_err(|e| {
            (
                StatusCode::INTERNAL_SERVER_ERROR,
                Json(ErrorResponse {
                    error: format!("Failed to open MIDI input: {}", e),
                }),
            )
        })?;

    Ok(StatusCode::OK)
}

/// Open a MIDI output device.
///
/// POST /midi/output/open
pub async fn open_output(
    State(state): State<Arc<AppState>>,
    Json(req): Json<OpenDeviceRequest>,
) -> Result<StatusCode, (StatusCode, Json<ErrorResponse>)> {
    use vibelang_core::message::MidiMessage;
    use vibelang_core::Message;

    let device_id = MidiDeviceId::new(req.device_id);
    state
        .handle
        .send(Message::Midi(MidiMessage::OpenOutput { device: device_id }))
        .await
        .map_err(|e| {
            (
                StatusCode::INTERNAL_SERVER_ERROR,
                Json(ErrorResponse {
                    error: format!("Failed to open MIDI output: {}", e),
                }),
            )
        })?;

    Ok(StatusCode::OK)
}

/// Close a MIDI device.
///
/// POST /midi/close
pub async fn close_device(
    State(state): State<Arc<AppState>>,
    Json(req): Json<OpenDeviceRequest>,
) -> Result<StatusCode, (StatusCode, Json<ErrorResponse>)> {
    use vibelang_core::message::MidiMessage;
    use vibelang_core::Message;

    let device_id = MidiDeviceId::new(req.device_id);
    state
        .handle
        .send(Message::Midi(MidiMessage::CloseDevice {
            device: device_id,
        }))
        .await
        .map_err(|e| {
            (
                StatusCode::INTERNAL_SERVER_ERROR,
                Json(ErrorResponse {
                    error: format!("Failed to close MIDI device: {}", e),
                }),
            )
        })?;

    Ok(StatusCode::OK)
}

// ============================================================================
// Note/CC Output Endpoints
// ============================================================================

/// Send a MIDI note-on message.
///
/// POST /midi/note/on
pub async fn send_note_on(
    State(state): State<Arc<AppState>>,
    Json(req): Json<SendNoteRequest>,
) -> Result<StatusCode, (StatusCode, Json<ErrorResponse>)> {
    use vibelang_core::message::MidiMessage;
    use vibelang_core::Message;

    let device_id = MidiDeviceId::new(req.device_id);
    state
        .handle
        .send(Message::Midi(MidiMessage::SendNoteOn {
            device: device_id,
            channel: req.channel,
            note: req.note,
            velocity: req.velocity.unwrap_or(100),
        }))
        .await
        .map_err(|e| {
            (
                StatusCode::INTERNAL_SERVER_ERROR,
                Json(ErrorResponse {
                    error: format!("Failed to send note on: {}", e),
                }),
            )
        })?;

    Ok(StatusCode::OK)
}

/// Send a MIDI note-off message.
///
/// POST /midi/note/off
pub async fn send_note_off(
    State(state): State<Arc<AppState>>,
    Json(req): Json<SendNoteRequest>,
) -> Result<StatusCode, (StatusCode, Json<ErrorResponse>)> {
    use vibelang_core::message::MidiMessage;
    use vibelang_core::Message;

    let device_id = MidiDeviceId::new(req.device_id);
    state
        .handle
        .send(Message::Midi(MidiMessage::SendNoteOff {
            device: device_id,
            channel: req.channel,
            note: req.note,
        }))
        .await
        .map_err(|e| {
            (
                StatusCode::INTERNAL_SERVER_ERROR,
                Json(ErrorResponse {
                    error: format!("Failed to send note off: {}", e),
                }),
            )
        })?;

    Ok(StatusCode::OK)
}

/// Send a MIDI CC message.
///
/// POST /midi/cc
pub async fn send_cc(
    State(state): State<Arc<AppState>>,
    Json(req): Json<SendCcRequest>,
) -> Result<StatusCode, (StatusCode, Json<ErrorResponse>)> {
    use vibelang_core::message::MidiMessage;
    use vibelang_core::Message;

    let device_id = MidiDeviceId::new(req.device_id);
    state
        .handle
        .send(Message::Midi(MidiMessage::SendCC {
            device: device_id,
            channel: req.channel,
            cc: req.cc,
            value: req.value,
        }))
        .await
        .map_err(|e| {
            (
                StatusCode::INTERNAL_SERVER_ERROR,
                Json(ErrorResponse {
                    error: format!("Failed to send CC: {}", e),
                }),
            )
        })?;

    Ok(StatusCode::OK)
}

// ============================================================================
// Recording Endpoints
// ============================================================================

/// Start MIDI recording.
///
/// POST /midi/record/start
pub async fn start_recording(
    State(state): State<Arc<AppState>>,
    Json(req): Json<StartRecordingRequest>,
) -> Result<StatusCode, (StatusCode, Json<ErrorResponse>)> {
    use vibelang_core::message::MidiMessage;
    use vibelang_core::Message;

    let device_id = MidiDeviceId::new(req.device_id);

    let msg = if let Some(channel) = req.channel {
        Message::Midi(MidiMessage::StartRecordingChannel {
            device: device_id,
            channel,
        })
    } else {
        Message::Midi(MidiMessage::StartRecording { device: device_id })
    };

    state.handle.send(msg).await.map_err(|e| {
        (
            StatusCode::INTERNAL_SERVER_ERROR,
            Json(ErrorResponse {
                error: format!("Failed to start recording: {}", e),
            }),
        )
    })?;

    Ok(StatusCode::OK)
}

/// Stop MIDI recording.
///
/// POST /midi/record/stop
///
/// Note: This stops recording but doesn't return the recording data.
/// The recording is stored and can be retrieved via other means (e.g., WebSocket events).
pub async fn stop_recording(
    State(state): State<Arc<AppState>>,
    Json(req): Json<StopRecordingRequest>,
) -> Result<StatusCode, (StatusCode, Json<ErrorResponse>)> {
    use vibelang_core::message::MidiMessage;
    use vibelang_core::Message;

    let device_id = MidiDeviceId::new(req.device_id);

    state
        .handle
        .send(Message::Midi(MidiMessage::StopRecording {
            device: device_id,
        }))
        .await
        .map_err(|e| {
            (
                StatusCode::INTERNAL_SERVER_ERROR,
                Json(ErrorResponse {
                    error: format!("Failed to stop recording: {}", e),
                }),
            )
        })?;

    Ok(StatusCode::OK)
}

// ============================================================================
// Clock Output Endpoints
// ============================================================================

/// Enable MIDI clock output.
///
/// POST /midi/clock/enable
pub async fn enable_clock_output(
    State(state): State<Arc<AppState>>,
    Json(req): Json<OpenDeviceRequest>,
) -> Result<StatusCode, (StatusCode, Json<ErrorResponse>)> {
    use vibelang_core::message::MidiMessage;
    use vibelang_core::Message;

    let device_id = MidiDeviceId::new(req.device_id);
    state
        .handle
        .send(Message::Midi(MidiMessage::EnableClockOutput {
            device: device_id,
        }))
        .await
        .map_err(|e| {
            (
                StatusCode::INTERNAL_SERVER_ERROR,
                Json(ErrorResponse {
                    error: format!("Failed to enable clock output: {}", e),
                }),
            )
        })?;

    Ok(StatusCode::OK)
}

/// Disable MIDI clock output.
///
/// POST /midi/clock/disable
pub async fn disable_clock_output(
    State(state): State<Arc<AppState>>,
    Json(req): Json<OpenDeviceRequest>,
) -> Result<StatusCode, (StatusCode, Json<ErrorResponse>)> {
    use vibelang_core::message::MidiMessage;
    use vibelang_core::Message;

    let device_id = MidiDeviceId::new(req.device_id);
    state
        .handle
        .send(Message::Midi(MidiMessage::DisableClockOutput {
            device: device_id,
        }))
        .await
        .map_err(|e| {
            (
                StatusCode::INTERNAL_SERVER_ERROR,
                Json(ErrorResponse {
                    error: format!("Failed to disable clock output: {}", e),
                }),
            )
        })?;

    Ok(StatusCode::OK)
}

/// Send MIDI start message.
///
/// POST /midi/transport/start
pub async fn send_midi_start(
    State(state): State<Arc<AppState>>,
    Json(req): Json<OpenDeviceRequest>,
) -> Result<StatusCode, (StatusCode, Json<ErrorResponse>)> {
    use vibelang_core::message::MidiMessage;
    use vibelang_core::Message;

    let device_id = MidiDeviceId::new(req.device_id);
    state
        .handle
        .send(Message::Midi(MidiMessage::SendStart { device: device_id }))
        .await
        .map_err(|e| {
            (
                StatusCode::INTERNAL_SERVER_ERROR,
                Json(ErrorResponse {
                    error: format!("Failed to send MIDI start: {}", e),
                }),
            )
        })?;

    Ok(StatusCode::OK)
}

/// Send MIDI stop message.
///
/// POST /midi/transport/stop
pub async fn send_midi_stop(
    State(state): State<Arc<AppState>>,
    Json(req): Json<OpenDeviceRequest>,
) -> Result<StatusCode, (StatusCode, Json<ErrorResponse>)> {
    use vibelang_core::message::MidiMessage;
    use vibelang_core::Message;

    let device_id = MidiDeviceId::new(req.device_id);
    state
        .handle
        .send(Message::Midi(MidiMessage::SendStop { device: device_id }))
        .await
        .map_err(|e| {
            (
                StatusCode::INTERNAL_SERVER_ERROR,
                Json(ErrorResponse {
                    error: format!("Failed to send MIDI stop: {}", e),
                }),
            )
        })?;

    Ok(StatusCode::OK)
}

/// Send MIDI continue message.
///
/// POST /midi/transport/continue
pub async fn send_midi_continue(
    State(state): State<Arc<AppState>>,
    Json(req): Json<OpenDeviceRequest>,
) -> Result<StatusCode, (StatusCode, Json<ErrorResponse>)> {
    use vibelang_core::message::MidiMessage;
    use vibelang_core::Message;

    let device_id = MidiDeviceId::new(req.device_id);
    state
        .handle
        .send(Message::Midi(MidiMessage::SendContinue {
            device: device_id,
        }))
        .await
        .map_err(|e| {
            (
                StatusCode::INTERNAL_SERVER_ERROR,
                Json(ErrorResponse {
                    error: format!("Failed to send MIDI continue: {}", e),
                }),
            )
        })?;

    Ok(StatusCode::OK)
}

// ============================================================================
// Route Management Endpoints
// ============================================================================

/// Request to add a keyboard route.
#[derive(Debug, Deserialize)]
pub struct AddKeyboardRouteRequest {
    pub device_id: u32,
    pub voice_id: u32,
    pub channel: Option<u8>,
    pub note_min: Option<u8>,
    pub note_max: Option<u8>,
    pub transpose: Option<i8>,
}

/// Response for keyboard route creation.
#[derive(Debug, Serialize)]
pub struct AddKeyboardRouteResponse {
    pub message: String,
}

/// Route info DTO.
#[derive(Debug, Serialize)]
pub struct RouteInfoDto {
    /// Note: Route listing is informational only. Routes are primarily managed via Rhai scripts.
    pub message: String,
    pub keyboard_route_count: usize,
}

/// List MIDI routes.
///
/// GET /midi/routes
///
/// Note: This returns basic route info. Routes are primarily managed via Rhai scripts.
pub async fn list_routes(State(_state): State<Arc<AppState>>) -> Json<RouteInfoDto> {
    // Routes are managed by the MidiHandler which isn't directly accessible from HTTP.
    // This returns informational status only.
    Json(RouteInfoDto {
        message: "MIDI routes are managed via Rhai scripts. Use POST /midi/route/keyboard to add a simple route.".to_string(),
        keyboard_route_count: 0, // Can't query directly without state access
    })
}

/// Add a keyboard route.
///
/// POST /midi/route/keyboard
pub async fn add_keyboard_route(
    State(state): State<Arc<AppState>>,
    Json(req): Json<AddKeyboardRouteRequest>,
) -> Result<Json<AddKeyboardRouteResponse>, (StatusCode, Json<ErrorResponse>)> {
    use vibelang_core::message::MidiMessage;
    use vibelang_core::types::VoiceId;
    use vibelang_core::Message;

    let device_id = MidiDeviceId::new(req.device_id);
    let voice_id = VoiceId::new(req.voice_id);

    state
        .handle
        .send(Message::Midi(MidiMessage::AddKeyboardRoute {
            device: device_id,
            voice: voice_id,
            channel: req.channel,
            note_min: req.note_min,
            note_max: req.note_max,
            transpose: req.transpose,
        }))
        .await
        .map_err(|e| {
            (
                StatusCode::INTERNAL_SERVER_ERROR,
                Json(ErrorResponse {
                    error: format!("Failed to add keyboard route: {}", e),
                }),
            )
        })?;

    Ok(Json(AddKeyboardRouteResponse {
        message: format!(
            "Keyboard route added: device {} -> voice {}",
            req.device_id, req.voice_id
        ),
    }))
}

/// Remove a keyboard route by index.
///
/// DELETE /midi/route/:index
pub async fn remove_keyboard_route(
    State(state): State<Arc<AppState>>,
    axum::extract::Path(index): axum::extract::Path<usize>,
) -> Result<StatusCode, (StatusCode, Json<ErrorResponse>)> {
    use vibelang_core::message::MidiMessage;
    use vibelang_core::Message;

    state
        .handle
        .send(Message::Midi(MidiMessage::RemoveKeyboardRoute { index }))
        .await
        .map_err(|e| {
            (
                StatusCode::INTERNAL_SERVER_ERROR,
                Json(ErrorResponse {
                    error: format!("Failed to remove keyboard route: {}", e),
                }),
            )
        })?;

    Ok(StatusCode::OK)
}

/// Clear all MIDI routes.
///
/// DELETE /midi/routes
pub async fn clear_routes(
    State(state): State<Arc<AppState>>,
) -> Result<StatusCode, (StatusCode, Json<ErrorResponse>)> {
    use vibelang_core::message::MidiMessage;
    use vibelang_core::Message;

    state
        .handle
        .send(Message::Midi(MidiMessage::ClearRoutes))
        .await
        .map_err(|e| {
            (
                StatusCode::INTERNAL_SERVER_ERROR,
                Json(ErrorResponse {
                    error: format!("Failed to clear routes: {}", e),
                }),
            )
        })?;

    Ok(StatusCode::OK)
}