Subversion Repositories svn.mios32

Rev

Rev 481 | Rev 513 | 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 484 2009-05-04 20:16:40Z 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 {
44
    unsigned MENU_PRESSED:1;
306 tk 45
    unsigned MENU_FIRST_PAGE_SELECTED:1;
178 tk 46
    unsigned CHANGE_ALL_STEPS:1;
47
    unsigned CHANGE_ALL_STEPS_SAME_VALUE:1;
48
    unsigned FAST_ENCODERS:1;
49
    unsigned SOLO:1;
50
    unsigned METRONOME:1;
51
    unsigned SCRUB:1;
303 tk 52
    unsigned STEPVIEW:1;
326 tk 53
    unsigned PAR_LAYER_SEL:1;
54
    unsigned TRG_LAYER_SEL:1;
240 tk 55
    unsigned REW:1;
56
    unsigned FWD:1;
57
    unsigned COPY:1;
58
    unsigned PASTE:1;
59
    unsigned CLEAR:1;
60
    unsigned F1:1;
61
    unsigned F2:1;
62
    unsigned F3:1;
63
    unsigned F4:1;
64
    unsigned UP:1;
65
    unsigned DOWN:1;
167 tk 66
  };
67
} seq_ui_button_state_t;
134 tk 68
 
167 tk 69
 
168 tk 70
typedef enum {
71
  SEQ_UI_BUTTON_GP1,
72
  SEQ_UI_BUTTON_GP2,
73
  SEQ_UI_BUTTON_GP3,
74
  SEQ_UI_BUTTON_GP4,
75
  SEQ_UI_BUTTON_GP5,
76
  SEQ_UI_BUTTON_GP6,
77
  SEQ_UI_BUTTON_GP7,
78
  SEQ_UI_BUTTON_GP8,
79
  SEQ_UI_BUTTON_GP9,
80
  SEQ_UI_BUTTON_GP10,
81
  SEQ_UI_BUTTON_GP11,
82
  SEQ_UI_BUTTON_GP12,
83
  SEQ_UI_BUTTON_GP13,
84
  SEQ_UI_BUTTON_GP14,
85
  SEQ_UI_BUTTON_GP15,
86
  SEQ_UI_BUTTON_GP16,
87
  SEQ_UI_BUTTON_Exit,
88
  SEQ_UI_BUTTON_Select,
89
  SEQ_UI_BUTTON_Left,
90
  SEQ_UI_BUTTON_Right,
91
  SEQ_UI_BUTTON_Up,
92
  SEQ_UI_BUTTON_Down
93
} seq_ui_button_t;
167 tk 94
 
168 tk 95
 
96
typedef enum {
97
  SEQ_UI_ENCODER_GP1,
98
  SEQ_UI_ENCODER_GP2,
99
  SEQ_UI_ENCODER_GP3,
100
  SEQ_UI_ENCODER_GP4,
101
  SEQ_UI_ENCODER_GP5,
102
  SEQ_UI_ENCODER_GP6,
103
  SEQ_UI_ENCODER_GP7,
104
  SEQ_UI_ENCODER_GP8,
105
  SEQ_UI_ENCODER_GP9,
106
  SEQ_UI_ENCODER_GP10,
107
  SEQ_UI_ENCODER_GP11,
108
  SEQ_UI_ENCODER_GP12,
109
  SEQ_UI_ENCODER_GP13,
110
  SEQ_UI_ENCODER_GP14,
111
  SEQ_UI_ENCODER_GP15,
112
  SEQ_UI_ENCODER_GP16,
113
  SEQ_UI_ENCODER_Datawheel
114
} seq_ui_encoder_t;
115
 
116
 
240 tk 117
typedef enum {
118
  SEQ_UI_EDIT_MODE_NORMAL,
119
  SEQ_UI_EDIT_MODE_COPY,
120
  SEQ_UI_EDIT_MODE_PASTE,
121
  SEQ_UI_EDIT_MODE_CLEAR,
122
  SEQ_UI_EDIT_MODE_MOVE,
123
  SEQ_UI_EDIT_MODE_SCROLL,
124
  SEQ_UI_EDIT_MODE_RANDOM,
125
  SEQ_UI_EDIT_MODE_RECORD
126
} seq_ui_edit_mode_t;
168 tk 127
 
240 tk 128
 
134 tk 129
/////////////////////////////////////////////////////////////////////////////
130
// Prototypes
131
/////////////////////////////////////////////////////////////////////////////
132
 
133
extern s32 SEQ_UI_Init(u32 mode);
134
 
178 tk 135
extern s32 SEQ_UI_InitEncSpeed(u32 auto_config);
136
 
134 tk 137
extern s32 SEQ_UI_Button_Handler(u32 pin, u32 pin_value);
138
extern s32 SEQ_UI_Encoder_Handler(u32 encoder, s32 incrementer);
139
extern s32 SEQ_UI_LED_Handler(void);
140
extern s32 SEQ_UI_LED_Handler_Periodic();
184 tk 141
extern s32 SEQ_UI_LCD_Handler(void);
168 tk 142
extern s32 SEQ_UI_MENU_Handler_Periodic();
134 tk 143
 
167 tk 144
extern s32 SEQ_UI_PageSet(seq_ui_page_t page);
272 tk 145
extern char *SEQ_UI_PageNameGet(seq_ui_page_t page);
167 tk 146
 
147
extern s32 SEQ_UI_InstallInitCallback(void *callback);
168 tk 148
extern s32 SEQ_UI_InstallButtonCallback(void *callback);
149
extern s32 SEQ_UI_InstallEncoderCallback(void *callback);
150
extern s32 SEQ_UI_InstallLEDCallback(void *callback);
151
extern s32 SEQ_UI_InstallLCDCallback(void *callback);
167 tk 152
 
353 tk 153
extern s32 SEQ_UI_LCD_Update(void);
154
 
328 tk 155
extern s32 SEQ_UI_CheckSelections(void);
156
 
168 tk 157
extern u8  SEQ_UI_VisibleTrackGet(void);
178 tk 158
extern s32 SEQ_UI_IsSelectedTrack(u8 track);
159
 
240 tk 160
extern s32 SEQ_UI_SelectedStepSet(u8 step);
161
 
168 tk 162
extern s32 SEQ_UI_GxTyInc(s32 incrementer);
240 tk 163
extern s32 SEQ_UI_Var16_Inc(u16 *value, u16 min, u16 max, s32 incrementer);
164
extern s32 SEQ_UI_Var8_Inc(u8 *value, u16 min, u16 max, s32 incrementer);
248 tk 165
extern s32 SEQ_UI_CC_Inc(u8 cc, u8 min, u8 max, s32 incrementer);
166
extern s32 SEQ_UI_CC_Set(u8 cc, u8 value);
167
extern s32 SEQ_UI_CC_SetFlags(u8 cc, u8 flag_mask, u8 value);
134 tk 168
 
169
 
170
/////////////////////////////////////////////////////////////////////////////
240 tk 171
// Prototypes for functions implemented in seq_ui_*.c
172
/////////////////////////////////////////////////////////////////////////////
173
 
174
extern s32 SEQ_UI_EDIT_LCD_Handler(u8 high_prio, seq_ui_edit_mode_t edit_mode);
175
extern s32 SEQ_UI_EDIT_LED_Handler(u16 *gp_leds);
176
 
286 tk 177
extern s32 SEQ_UI_MENU_StopwatchInit(void);
178
extern s32 SEQ_UI_MENU_StopwatchReset(void);
179
extern s32 SEQ_UI_MENU_StopwatchCapture(void);
180
 
240 tk 181
extern s32 SEQ_UI_UTIL_CopyButton(s32 depressed);
182
extern s32 SEQ_UI_UTIL_PasteButton(s32 depressed);
183
extern s32 SEQ_UI_UTIL_ClearButton(s32 depressed);
184
extern s32 SEQ_UI_UTIL_UndoButton(s32 depressed);
185
 
280 tk 186
extern s32 SEQ_UI_MIXER_Copy(void);
187
extern s32 SEQ_UI_MIXER_Paste(void);
188
extern s32 SEQ_UI_MIXER_Clear(void);
189
extern s32 SEQ_UI_MIXER_Undo(u8 mixer_map);
190
extern s32 SEQ_UI_MIXER_UndoUpdate(void);
191
 
240 tk 192
extern s32 SEQ_UI_UTIL_UndoUpdate(u8 track);
193
 
194
extern u8 SEQ_UI_UTIL_CopyPasteBeginGet(void);
195
extern u8 SEQ_UI_UTIL_CopyPasteEndGet(void);
196
 
299 tk 197
extern s32 SEQ_UI_SDCardMsg(u16 delay, char *line1, char *line2);
198
extern s32 SEQ_UI_SDCardErrMsg(u16 delay, s32 status);
240 tk 199
 
299 tk 200
 
240 tk 201
/////////////////////////////////////////////////////////////////////////////
134 tk 202
// Export global variables
203
/////////////////////////////////////////////////////////////////////////////
204
 
159 tk 205
extern u8 seq_ui_display_update_req;
206
extern u8 seq_ui_display_init_req;
134 tk 207
 
167 tk 208
extern seq_ui_button_state_t seq_ui_button_state;
209
 
134 tk 210
extern u8 ui_selected_group;
484 tk 211
extern u16 ui_selected_tracks;
134 tk 212
extern u8 ui_selected_par_layer;
213
extern u8 ui_selected_trg_layer;
328 tk 214
extern u8 ui_selected_instrument;
134 tk 215
extern u8 ui_selected_step_view;
216
extern u8 ui_selected_step;
168 tk 217
extern u8 ui_selected_item;
134 tk 218
 
240 tk 219
extern u16 ui_hold_msg_ctr;
220
 
206 tk 221
extern seq_ui_page_t ui_page;
272 tk 222
extern seq_ui_page_t ui_selected_page;
303 tk 223
extern seq_ui_page_t ui_stepview_prev_page;
326 tk 224
extern seq_ui_page_t ui_trglayer_prev_page;
225
extern seq_ui_page_t ui_parlayer_prev_page;
206 tk 226
 
173 tk 227
extern volatile u8 ui_cursor_flash;
168 tk 228
 
316 tk 229
extern u8 ui_edit_name_cursor;
230
extern u8 ui_edit_preset_num_category;
231
extern u8 ui_edit_preset_num_label;
232
 
193 tk 233
extern u8 ui_seq_pause;
234
 
134 tk 235
#endif /* _SEQ_UI_H */