Subversion Repositories svn.mios32

Rev

Rev 729 | Rev 741 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
134 tk 1
// $Id: seq_ui.h 740 2009-10-09 20:24:39Z tk $
2
/*
3
 * Header file for user interface routines
4
 *
5
 * ==========================================================================
6
 *
7
 *  Copyright (C) 2008 Thorsten Klose (tk@midibox.org)
8
 *  Licensed for personal non-commercial use only.
9
 *  All other rights reserved.
10
 *
11
 * ==========================================================================
12
 */
13
 
14
#ifndef _SEQ_UI_H
15
#define _SEQ_UI_H
16
 
167 tk 17
/////////////////////////////////////////////////////////////////////////////
18
// Menu Page definitions
19
/////////////////////////////////////////////////////////////////////////////
134 tk 20
 
272 tk 21
#include "seq_ui_pages.inc"
167 tk 22
 
23
 
134 tk 24
/////////////////////////////////////////////////////////////////////////////
25
// Global definitions
26
/////////////////////////////////////////////////////////////////////////////
27
 
168 tk 28
// cursor flash with following waveform:
29
// 0..399 mS: cursor on
30
// 400..499 mS: cursor off
31
#define SEQ_UI_CURSOR_FLASH_CTR_MAX     500  // mS
32
#define SEQ_UI_CURSOR_FLASH_CTR_LED_OFF 400  // mS
134 tk 33
 
168 tk 34
 
134 tk 35
/////////////////////////////////////////////////////////////////////////////
36
// Global Types
37
/////////////////////////////////////////////////////////////////////////////
38
 
167 tk 39
typedef union {
40
  struct {
326 tk 41
    unsigned ALL:32;
167 tk 42
  };
43
  struct {
678 tk 44
    unsigned PAGE_CHANGE_BUTTON_FLAGS:6;
45
  };
46
  struct {
47
    // these button functions will change a page (special "radio button" handling required)
167 tk 48
    unsigned MENU_PRESSED:1;
678 tk 49
    unsigned STEP_VIEW:1;
50
    unsigned PAR_LAYER_SEL:1;
51
    unsigned TRG_LAYER_SEL:1;
52
    unsigned TRACK_SEL:1;
53
    unsigned TEMPO_PRESET:1;
54
 
55
    // remaining functions
306 tk 56
    unsigned MENU_FIRST_PAGE_SELECTED:1;
178 tk 57
    unsigned CHANGE_ALL_STEPS:1;
58
    unsigned CHANGE_ALL_STEPS_SAME_VALUE:1;
591 tk 59
    unsigned SELECT_PRESSED:1;
60
    unsigned EXIT_PRESSED:1;
61
    unsigned EDIT_PRESSED:1;
62
    unsigned MUTE_PRESSED:1;
63
    unsigned PATTERN_PRESSED:1;
64
    unsigned SONG_PRESSED:1;
178 tk 65
    unsigned FAST_ENCODERS:1;
66
    unsigned SOLO:1;
67
    unsigned SCRUB:1;
240 tk 68
    unsigned REW:1;
69
    unsigned FWD:1;
70
    unsigned COPY:1;
71
    unsigned PASTE:1;
72
    unsigned CLEAR:1;
513 tk 73
    unsigned TAP_TEMPO:1;
240 tk 74
    unsigned UP:1;
75
    unsigned DOWN:1;
167 tk 76
  };
77
} seq_ui_button_state_t;
134 tk 78
 
167 tk 79
 
168 tk 80
typedef enum {
81
  SEQ_UI_BUTTON_GP1,
82
  SEQ_UI_BUTTON_GP2,
83
  SEQ_UI_BUTTON_GP3,
84
  SEQ_UI_BUTTON_GP4,
85
  SEQ_UI_BUTTON_GP5,
86
  SEQ_UI_BUTTON_GP6,
87
  SEQ_UI_BUTTON_GP7,
88
  SEQ_UI_BUTTON_GP8,
89
  SEQ_UI_BUTTON_GP9,
90
  SEQ_UI_BUTTON_GP10,
91
  SEQ_UI_BUTTON_GP11,
92
  SEQ_UI_BUTTON_GP12,
93
  SEQ_UI_BUTTON_GP13,
94
  SEQ_UI_BUTTON_GP14,
95
  SEQ_UI_BUTTON_GP15,
96
  SEQ_UI_BUTTON_GP16,
97
  SEQ_UI_BUTTON_Exit,
98
  SEQ_UI_BUTTON_Select,
99
  SEQ_UI_BUTTON_Left,
100
  SEQ_UI_BUTTON_Right,
101
  SEQ_UI_BUTTON_Up,
102
  SEQ_UI_BUTTON_Down
103
} seq_ui_button_t;
167 tk 104
 
168 tk 105
 
106
typedef enum {
107
  SEQ_UI_ENCODER_GP1,
108
  SEQ_UI_ENCODER_GP2,
109
  SEQ_UI_ENCODER_GP3,
110
  SEQ_UI_ENCODER_GP4,
111
  SEQ_UI_ENCODER_GP5,
112
  SEQ_UI_ENCODER_GP6,
113
  SEQ_UI_ENCODER_GP7,
114
  SEQ_UI_ENCODER_GP8,
115
  SEQ_UI_ENCODER_GP9,
116
  SEQ_UI_ENCODER_GP10,
117
  SEQ_UI_ENCODER_GP11,
118
  SEQ_UI_ENCODER_GP12,
119
  SEQ_UI_ENCODER_GP13,
120
  SEQ_UI_ENCODER_GP14,
121
  SEQ_UI_ENCODER_GP15,
122
  SEQ_UI_ENCODER_GP16,
123
  SEQ_UI_ENCODER_Datawheel
124
} seq_ui_encoder_t;
125
 
126
 
240 tk 127
typedef enum {
128
  SEQ_UI_EDIT_MODE_NORMAL,
129
  SEQ_UI_EDIT_MODE_COPY,
130
  SEQ_UI_EDIT_MODE_PASTE,
131
  SEQ_UI_EDIT_MODE_CLEAR,
132
  SEQ_UI_EDIT_MODE_MOVE,
133
  SEQ_UI_EDIT_MODE_SCROLL,
134
  SEQ_UI_EDIT_MODE_RANDOM,
600 tk 135
  SEQ_UI_EDIT_MODE_RECORD,
136
  SEQ_UI_EDIT_MODE_MANUAL
240 tk 137
} seq_ui_edit_mode_t;
168 tk 138
 
240 tk 139
 
596 tk 140
typedef enum {
141
  SEQ_UI_MSG_USER,
740 tk 142
  SEQ_UI_MSG_SDCARD,
143
  SEQ_UI_MSG_DELAYED_ACTION
596 tk 144
} seq_ui_msg_type_t;
145
 
146
 
625 tk 147
typedef enum {
626 tk 148
  SEQ_UI_REMOTE_MODE_AUTO=0,
625 tk 149
  SEQ_UI_REMOTE_MODE_SERVER,
150
  SEQ_UI_REMOTE_MODE_CLIENT
151
} seq_ui_remote_mode_t;
152
 
153
 
134 tk 154
/////////////////////////////////////////////////////////////////////////////
155
// Prototypes
156
/////////////////////////////////////////////////////////////////////////////
157
 
158
extern s32 SEQ_UI_Init(u32 mode);
159
 
178 tk 160
extern s32 SEQ_UI_InitEncSpeed(u32 auto_config);
161
 
134 tk 162
extern s32 SEQ_UI_Button_Handler(u32 pin, u32 pin_value);
524 tk 163
extern s32 SEQ_UI_BLM_Button_Handler(u32 row, u32 pin, u32 pin_value);
134 tk 164
extern s32 SEQ_UI_Encoder_Handler(u32 encoder, s32 incrementer);
626 tk 165
extern s32 SEQ_UI_REMOTE_MIDI_Receive(mios32_midi_port_t port, mios32_midi_package_t midi_package);
134 tk 166
extern s32 SEQ_UI_LED_Handler(void);
167
extern s32 SEQ_UI_LED_Handler_Periodic();
184 tk 168
extern s32 SEQ_UI_LCD_Handler(void);
168 tk 169
extern s32 SEQ_UI_MENU_Handler_Periodic();
134 tk 170
 
167 tk 171
extern s32 SEQ_UI_PageSet(seq_ui_page_t page);
272 tk 172
extern char *SEQ_UI_PageNameGet(seq_ui_page_t page);
167 tk 173
 
174
extern s32 SEQ_UI_InstallInitCallback(void *callback);
168 tk 175
extern s32 SEQ_UI_InstallButtonCallback(void *callback);
176
extern s32 SEQ_UI_InstallEncoderCallback(void *callback);
177
extern s32 SEQ_UI_InstallLEDCallback(void *callback);
178
extern s32 SEQ_UI_InstallLCDCallback(void *callback);
690 tk 179
extern s32 SEQ_UI_InstallExitCallback(void *callback);
740 tk 180
extern s32 SEQ_UI_InstallDelayedActionCallback(void *callback, u16 ctr, char *msg);
181
extern s32 SEQ_UI_UnInstallDelayedActionCallback(void *callback);
167 tk 182
 
353 tk 183
extern s32 SEQ_UI_LCD_Update(void);
184
 
328 tk 185
extern s32 SEQ_UI_CheckSelections(void);
186
 
168 tk 187
extern u8  SEQ_UI_VisibleTrackGet(void);
178 tk 188
extern s32 SEQ_UI_IsSelectedTrack(u8 track);
189
 
240 tk 190
extern s32 SEQ_UI_SelectedStepSet(u8 step);
191
 
168 tk 192
extern s32 SEQ_UI_GxTyInc(s32 incrementer);
240 tk 193
extern s32 SEQ_UI_Var16_Inc(u16 *value, u16 min, u16 max, s32 incrementer);
194
extern s32 SEQ_UI_Var8_Inc(u8 *value, u16 min, u16 max, s32 incrementer);
248 tk 195
extern s32 SEQ_UI_CC_Inc(u8 cc, u8 min, u8 max, s32 incrementer);
196
extern s32 SEQ_UI_CC_Set(u8 cc, u8 value);
197
extern s32 SEQ_UI_CC_SetFlags(u8 cc, u8 flag_mask, u8 value);
134 tk 198
 
199
 
200
/////////////////////////////////////////////////////////////////////////////
240 tk 201
// Prototypes for functions implemented in seq_ui_*.c
202
/////////////////////////////////////////////////////////////////////////////
203
 
204
extern s32 SEQ_UI_EDIT_LCD_Handler(u8 high_prio, seq_ui_edit_mode_t edit_mode);
205
extern s32 SEQ_UI_EDIT_LED_Handler(u16 *gp_leds);
206
 
286 tk 207
extern s32 SEQ_UI_MENU_StopwatchInit(void);
208
extern s32 SEQ_UI_MENU_StopwatchReset(void);
209
extern s32 SEQ_UI_MENU_StopwatchCapture(void);
210
 
702 tk 211
extern s32 SEQ_UI_MENU_Idle(void);
212
 
240 tk 213
extern s32 SEQ_UI_UTIL_CopyButton(s32 depressed);
214
extern s32 SEQ_UI_UTIL_PasteButton(s32 depressed);
215
extern s32 SEQ_UI_UTIL_ClearButton(s32 depressed);
216
extern s32 SEQ_UI_UTIL_UndoButton(s32 depressed);
217
 
280 tk 218
extern s32 SEQ_UI_MIXER_Copy(void);
219
extern s32 SEQ_UI_MIXER_Paste(void);
220
extern s32 SEQ_UI_MIXER_Clear(void);
221
extern s32 SEQ_UI_MIXER_Undo(u8 mixer_map);
222
extern s32 SEQ_UI_MIXER_UndoUpdate(void);
223
 
729 tk 224
extern s32 SEQ_UI_SONG_Copy(void);
225
extern s32 SEQ_UI_SONG_Paste(void);
226
extern s32 SEQ_UI_SONG_Clear(void);
227
extern s32 SEQ_UI_SONG_Insert(void);
228
extern s32 SEQ_UI_SONG_Delete(void);
229
 
240 tk 230
extern s32 SEQ_UI_UTIL_UndoUpdate(u8 track);
231
 
232
extern u8 SEQ_UI_UTIL_CopyPasteBeginGet(void);
233
extern u8 SEQ_UI_UTIL_CopyPasteEndGet(void);
234
 
596 tk 235
extern s32 SEQ_UI_Msg(seq_ui_msg_type_t msg_type, u16 delay, char *line1, char *line2);
236
extern s32 SEQ_UI_MsgStop(void);
299 tk 237
extern s32 SEQ_UI_SDCardErrMsg(u16 delay, s32 status);
240 tk 238
 
299 tk 239
 
240 tk 240
/////////////////////////////////////////////////////////////////////////////
134 tk 241
// Export global variables
242
/////////////////////////////////////////////////////////////////////////////
243
 
159 tk 244
extern u8 seq_ui_display_update_req;
245
extern u8 seq_ui_display_init_req;
134 tk 246
 
167 tk 247
extern seq_ui_button_state_t seq_ui_button_state;
248
 
134 tk 249
extern u8 ui_selected_group;
484 tk 250
extern u16 ui_selected_tracks;
134 tk 251
extern u8 ui_selected_par_layer;
252
extern u8 ui_selected_trg_layer;
328 tk 253
extern u8 ui_selected_instrument;
134 tk 254
extern u8 ui_selected_step_view;
255
extern u8 ui_selected_step;
168 tk 256
extern u8 ui_selected_item;
134 tk 257
 
240 tk 258
extern u16 ui_hold_msg_ctr;
259
 
206 tk 260
extern seq_ui_page_t ui_page;
272 tk 261
extern seq_ui_page_t ui_selected_page;
303 tk 262
extern seq_ui_page_t ui_stepview_prev_page;
326 tk 263
extern seq_ui_page_t ui_trglayer_prev_page;
264
extern seq_ui_page_t ui_parlayer_prev_page;
206 tk 265
 
173 tk 266
extern volatile u8 ui_cursor_flash;
740 tk 267
extern volatile u8 ui_cursor_flash_overrun_ctr;
168 tk 268
 
316 tk 269
extern u8 ui_edit_name_cursor;
270
extern u8 ui_edit_preset_num_category;
271
extern u8 ui_edit_preset_num_label;
729 tk 272
extern u8 ui_edit_preset_num_drum;
316 tk 273
 
193 tk 274
extern u8 ui_seq_pause;
275
 
625 tk 276
extern seq_ui_remote_mode_t seq_ui_remote_mode;
626 tk 277
extern seq_ui_remote_mode_t seq_ui_remote_active_mode;
625 tk 278
extern mios32_midi_port_t seq_ui_remote_port;
626 tk 279
extern mios32_midi_port_t seq_ui_remote_active_port;
625 tk 280
extern u8 seq_ui_remote_id;
626 tk 281
extern u16 seq_ui_remote_client_timeout_ctr;
282
extern u8 seq_ui_remote_force_lcd_update;
283
extern u8 seq_ui_remote_force_led_update;
625 tk 284
 
634 tk 285
extern u8 seq_ui_backup_req;
740 tk 286
extern u8 seq_ui_format_req;
634 tk 287
 
134 tk 288
#endif /* _SEQ_UI_H */