diff --git a/applications/plugins/metronome/README.md b/applications/plugins/metronome/README.md new file mode 100644 index 000000000..8376c59c4 --- /dev/null +++ b/applications/plugins/metronome/README.md @@ -0,0 +1,19 @@ +# Metronome + +A metronome for the [Flipper Zero](https://flipperzero.one/) device. Goes along perfectly with my [BPM tapper](https://github.com/panki27/bpm-tapper). + +![screenshot](img/screenshot.png) + +## Features + +- BPM adjustable, fine and coarse (hold pressed) +- Selectable amount of beats per bar +- First bar is pronounced +- Selectable note length +- LED flashes accordingly + +## Compiling + +``` +./fbt firmware_metronome +``` diff --git a/applications/plugins/metronome/application.fam b/applications/plugins/metronome/application.fam new file mode 100644 index 000000000..4e8d003b3 --- /dev/null +++ b/applications/plugins/metronome/application.fam @@ -0,0 +1,14 @@ +App( + appid="metronome", + name="Metronome", + apptype=FlipperAppType.PLUGIN, + entry_point="metronome_app", + cdefines=["APP_METRONOME"], + requires=[ + "gui", + ], + fap_icon="metronome_icon.png", + fap_category="Music", + stack_size=2 * 1024, + order=20, +) diff --git a/applications/plugins/metronome/img/screenshot.png b/applications/plugins/metronome/img/screenshot.png new file mode 100644 index 000000000..a680e1216 Binary files /dev/null and b/applications/plugins/metronome/img/screenshot.png differ diff --git a/applications/plugins/metronome/metronome.c b/applications/plugins/metronome/metronome.c new file mode 100644 index 000000000..9cec7244a --- /dev/null +++ b/applications/plugins/metronome/metronome.c @@ -0,0 +1,338 @@ +#include +#include +#include +#include +#include + +#include +#include +#include +#include + +#include +#include + +#define BPM_STEP_SIZE_FINE 0.5d +#define BPM_STEP_SIZE_COARSE 10.0d +#define BPM_BOUNDARY_LOW 10.0d +#define BPM_BOUNDARY_HIGH 300.0d +#define BEEP_DELAY_MS 50 + +typedef enum { + EventTypeTick, + EventTypeKey, +} EventType; + +typedef struct { + EventType type; + InputEvent input; +} PluginEvent; + +typedef struct { + double bpm; + bool playing; + int beats_per_bar; + int note_length; + int current_beat; + FuriTimer* timer; + NotificationApp* notifications; +} MetronomeState; + +//lib can only do bottom left/right +static void elements_button_top_left(Canvas* canvas, const char* str) { + const uint8_t button_height = 12; + const uint8_t vertical_offset = 3; + const uint8_t horizontal_offset = 3; + const uint8_t string_width = canvas_string_width(canvas, str); + const Icon* icon = &I_ButtonUp_7x4; + const uint8_t icon_h_offset = 3; + const uint8_t icon_width_with_offset = icon->width + icon_h_offset; + const uint8_t icon_v_offset = icon->height + vertical_offset; + const uint8_t button_width = string_width + horizontal_offset * 2 + icon_width_with_offset; + + const uint8_t x = 0; + const uint8_t y = 0 + button_height; + + canvas_draw_box(canvas, x, y - button_height, button_width, button_height); + canvas_draw_line(canvas, x + button_width + 0, y - button_height, x + button_width + 0, y - 1); + canvas_draw_line(canvas, x + button_width + 1, y - button_height, x + button_width + 1, y - 2); + canvas_draw_line(canvas, x + button_width + 2, y - button_height, x + button_width + 2, y - 3); + + canvas_invert_color(canvas); + canvas_draw_icon(canvas, x + horizontal_offset, y - icon_v_offset, &I_ButtonUp_7x4); + canvas_draw_str( + canvas, x + horizontal_offset + icon_width_with_offset, y - vertical_offset, str); + canvas_invert_color(canvas); +} + +void elements_button_top_right(Canvas* canvas, const char* str) { + const uint8_t button_height = 12; + const uint8_t vertical_offset = 3; + const uint8_t horizontal_offset = 3; + const uint8_t string_width = canvas_string_width(canvas, str); + const Icon* icon = &I_ButtonUp_7x4; + const uint8_t icon_h_offset = 3; + const uint8_t icon_width_with_offset = icon->width + icon_h_offset; + const uint8_t icon_v_offset = icon->height + vertical_offset; + const uint8_t button_width = string_width + horizontal_offset * 2 + icon_width_with_offset; + + const uint8_t x = canvas_width(canvas); + const uint8_t y = 0 + button_height; + + canvas_draw_box(canvas, x - button_width, y - button_height, button_width, button_height); + canvas_draw_line(canvas, x - button_width - 1, y - button_height, x - button_width - 1, y - 1); + canvas_draw_line(canvas, x - button_width - 2, y - button_height, x - button_width - 2, y - 2); + canvas_draw_line(canvas, x - button_width - 3, y - button_height, x - button_width - 3, y - 3); + + canvas_invert_color(canvas); + canvas_draw_str(canvas, x - button_width + horizontal_offset, y - vertical_offset, str); + canvas_draw_icon( + canvas, x - horizontal_offset - icon->width, y - icon_v_offset, &I_ButtonUp_7x4); + canvas_invert_color(canvas); +} + +static void render_callback(Canvas* const canvas, void* ctx) { + const MetronomeState* metronome_state = acquire_mutex((ValueMutex*)ctx, 25); + if(metronome_state == NULL) { + return; + } + string_t tempStr; + string_init(tempStr); + + // border around the edge of the screen + canvas_draw_frame(canvas, 0, 0, 128, 64); + canvas_set_font(canvas, FontPrimary); + + // draw bars/beat + string_printf(tempStr, "%d/%d", metronome_state->beats_per_bar, metronome_state->note_length); + canvas_draw_str_aligned(canvas, 64, 8, AlignCenter, AlignCenter, string_get_cstr(tempStr)); + string_reset(tempStr); + // draw BPM value + string_printf(tempStr, "%.2f", metronome_state->bpm); + canvas_set_font(canvas, FontBigNumbers); + canvas_draw_str_aligned(canvas, 64, 24, AlignCenter, AlignCenter, string_get_cstr(tempStr)); + string_reset(tempStr); + + // draw button prompts + canvas_set_font(canvas, FontSecondary); + elements_button_left(canvas, "Slow"); + elements_button_right(canvas, "Fast"); + if (metronome_state->playing) { + elements_button_center(canvas, "Stop "); + } else { + elements_button_center(canvas, "Start"); + } + elements_button_top_left(canvas, "Push"); + elements_button_top_right(canvas, "Hold"); + + // draw progress bar + elements_progress_bar(canvas, 8, 36, 112, (float)metronome_state->current_beat/metronome_state->beats_per_bar); + + string_clear(tempStr); + release_mutex((ValueMutex*)ctx, metronome_state); +} + +static void input_callback(InputEvent* input_event, FuriMessageQueue* event_queue) { + furi_assert(event_queue); + + PluginEvent event = {.type = EventTypeKey, .input = *input_event}; + furi_message_queue_put(event_queue, &event, FuriWaitForever); +} + +static void timer_callback(void* ctx) { + MetronomeState* metronome_state = acquire_mutex((ValueMutex*)ctx, 25); + metronome_state->current_beat++; + if (metronome_state->current_beat > metronome_state->beats_per_bar) { + metronome_state->current_beat = 1; + } + if (metronome_state->current_beat == 1) { + notification_message(metronome_state->notifications, &sequence_set_only_red_255); + furi_hal_speaker_start(440.0f, 1.0f); + } else { + notification_message(metronome_state->notifications, &sequence_set_only_green_255); + furi_hal_speaker_start(220.0f, 1.0f); + }; + furi_delay_ms(BEEP_DELAY_MS); + notification_message(metronome_state->notifications, &sequence_reset_rgb); + furi_hal_speaker_stop(); + + release_mutex((ValueMutex*)ctx, metronome_state); +} + + +static uint32_t state_to_sleep_ticks(MetronomeState* metronome_state) { + // calculate time between beeps + uint32_t tps = furi_kernel_get_tick_frequency(); + double multiplier = 4.0d/metronome_state->note_length; + double bps = (double)metronome_state->bpm / 60; + return (uint32_t)(round(tps / bps) - ((BEEP_DELAY_MS/1000)*tps)) * multiplier; +} + +static void update_timer(MetronomeState* metronome_state) { + if (furi_timer_is_running(metronome_state->timer)) { + furi_timer_stop(metronome_state->timer); + furi_timer_start( + metronome_state->timer, + state_to_sleep_ticks(metronome_state) + ); + } +} + +static void increase_bpm(MetronomeState* metronome_state, double amount) { + metronome_state->bpm += amount; + if(metronome_state->bpm > (double)BPM_BOUNDARY_HIGH) { + metronome_state->bpm = BPM_BOUNDARY_HIGH; + } + update_timer(metronome_state); +} + +static void decrease_bpm(MetronomeState* metronome_state, double amount) { + metronome_state->bpm -= amount; + if(metronome_state->bpm < (double)BPM_BOUNDARY_LOW) { + metronome_state->bpm = BPM_BOUNDARY_LOW; + } + update_timer(metronome_state); +} + +static void cycle_beats_per_bar(MetronomeState* metronome_state) { + metronome_state->beats_per_bar++; + if (metronome_state->beats_per_bar > metronome_state->note_length) { + metronome_state->beats_per_bar = 1; + } +} + +static void cycle_note_length(MetronomeState* metronome_state) { + metronome_state->note_length *= 2; + if (metronome_state->note_length > 16) { + metronome_state->note_length = 2; + metronome_state->beats_per_bar = 1; + } + update_timer(metronome_state); +} + +static void metronome_state_init(MetronomeState* const metronome_state) { + metronome_state->bpm = 120.0; + metronome_state->playing = false; + metronome_state->beats_per_bar = 4; + metronome_state->note_length = 4; + metronome_state->current_beat = 0; + metronome_state->notifications = furi_record_open(RECORD_NOTIFICATION); +} + +int32_t metronome_app() { + FuriMessageQueue* event_queue = furi_message_queue_alloc(8, sizeof(PluginEvent)); + + MetronomeState* metronome_state = malloc(sizeof(MetronomeState)); + metronome_state_init(metronome_state); + + ValueMutex state_mutex; + if(!init_mutex(&state_mutex, metronome_state, sizeof(MetronomeState))) { + FURI_LOG_E("Metronome", "cannot create mutex\r\n"); + free(metronome_state); + return 255; + } + + // Set system callbacks + ViewPort* view_port = view_port_alloc(); + view_port_draw_callback_set(view_port, render_callback, &state_mutex); + view_port_input_callback_set(view_port, input_callback, event_queue); + metronome_state->timer = furi_timer_alloc(timer_callback, FuriTimerTypePeriodic, &state_mutex); + + // Open GUI and register view_port + Gui* gui = furi_record_open("gui"); + gui_add_view_port(gui, view_port, GuiLayerFullscreen); + + PluginEvent event; + for(bool processing = true; processing;) { + FuriStatus event_status = furi_message_queue_get(event_queue, &event, 100); + + MetronomeState* metronome_state = (MetronomeState*)acquire_mutex_block(&state_mutex); + + if(event_status == FuriStatusOk) { + // press events + if(event.type == EventTypeKey) { + if(event.input.type == InputTypeShort) { + switch(event.input.key) { + case InputKeyUp: + cycle_beats_per_bar(metronome_state); + break; + case InputKeyDown: + break; + case InputKeyRight: + increase_bpm(metronome_state, BPM_STEP_SIZE_FINE); + break; + case InputKeyLeft: + decrease_bpm(metronome_state, BPM_STEP_SIZE_FINE); + break; + case InputKeyOk: + metronome_state->playing = !metronome_state->playing; + if (metronome_state->playing) { + furi_timer_start(metronome_state->timer, state_to_sleep_ticks(metronome_state)); + } else { + furi_timer_stop(metronome_state->timer); + } + break; + case InputKeyBack: + processing = false; + break; + } + } else if (event.input.type == InputTypeLong) { + switch(event.input.key) { + case InputKeyUp: + cycle_note_length(metronome_state); + break; + case InputKeyDown: + break; + case InputKeyRight: + increase_bpm(metronome_state, BPM_STEP_SIZE_COARSE); + break; + case InputKeyLeft: + decrease_bpm(metronome_state, BPM_STEP_SIZE_COARSE); + break; + case InputKeyOk: + break; + case InputKeyBack: + processing = false; + break; + } + } else if (event.input.type == InputTypeRepeat) { + switch(event.input.key) { + case InputKeyUp: + break; + case InputKeyDown: + break; + case InputKeyRight: + increase_bpm(metronome_state, BPM_STEP_SIZE_COARSE); + break; + case InputKeyLeft: + decrease_bpm(metronome_state, BPM_STEP_SIZE_COARSE); + break; + case InputKeyOk: + break; + case InputKeyBack: + processing = false; + break; + } + } + } + } else { + FURI_LOG_D("Hello_world", "FuriMessageQueue: event timeout"); + // event timeout + } + + view_port_update(view_port); + release_mutex(&state_mutex, metronome_state); + } + + view_port_enabled_set(view_port, false); + gui_remove_view_port(gui, view_port); + furi_record_close("gui"); + view_port_free(view_port); + furi_message_queue_free(event_queue); + delete_mutex(&state_mutex); + furi_timer_free(metronome_state->timer); + furi_record_close(RECORD_NOTIFICATION); + free(metronome_state); + + return 0; +} diff --git a/applications/plugins/metronome/metronome_icon.png b/applications/plugins/metronome/metronome_icon.png new file mode 100644 index 000000000..64d0ddbe9 Binary files /dev/null and b/applications/plugins/metronome/metronome_icon.png differ