jackoviz/jvzcontroller.proto at master · phstrauss/jackoviz · GitHub

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
syntax = "proto3";

package jvz;

option cc_enable_arenas = true;

// Remote control surface for jackoviz setters (mirrors set_* in jackoviz.c).
service JvzController {
  rpc SetDbFloor(SetDbFloorRequest) returns (SetResponse);
  rpc SetDbCeil(SetDbCeilRequest) returns (SetResponse);
  rpc SetViewMode(SetViewModeRequest) returns (SetResponse);
  rpc SetLineWidth(SetLineWidthRequest) returns (SetResponse);
  rpc SetPause(SetPauseRequest) returns (SetResponse);
  rpc SetPlotFreq(SetPlotFreqRequest) returns (SetResponse);
  rpc SetKaiserBeta(SetKaiserBetaRequest) returns (SetResponse);
  rpc Quit(QuitRequest) returns (SetResponse);
  rpc ConnectJackPort(ConnectJackPortRequest) returns (SetResponse);
}

// Mirrors C setter returns: ok is false on sentinel/error; value/code echo the C return.
message SetResponse {
  bool ok = 1;
  string message = 2;
  double value = 3; // double/float setters: applied value (or error sentinel)
  int32 code = 4;   // int setters: applied mode/pause flag (or -1)
}

// Matches ViewMode in jackoviz.h / jackoviz.c.
enum ViewMode {
  VIEW_MODE_3D = 0;
  VIEW_MODE_2D = 1;
  VIEW_MODE_1D = 2;
  VIEW_MODE_SCOPE = 3;
}

message SetDbFloorRequest {
  double floor_db = 1; // typically -200 … -20
}

message SetDbCeilRequest {
  double ceil_db = 1; // typically -20 … 0
}

message SetViewModeRequest {
  ViewMode mode = 1;
}

message SetLineWidthRequest {
  float width_px = 1; // typically 1 … 3
}

message SetPauseRequest {
  bool paused = 1;
}

message SetPlotFreqRequest {
  double freq_hz = 1; // max plotted frequency
}

message SetKaiserBetaRequest {
  double beta = 1; // typically 1 … 10
}

message QuitRequest {
}

message ConnectJackPortRequest {
  string port_name = 1; // e.g. "system:capture_1"
}