midi.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Titouan Christophe
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_AUDIO_MIDI_H_
#define ZEPHYR_INCLUDE_AUDIO_MIDI_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>



struct midi_ump {
        uint32_t data[4]; 
};


#define UMP_MT_UTILITY             0x00
#define UMP_MT_SYS_RT_COMMON       0x01
#define UMP_MT_MIDI1_CHANNEL_VOICE 0x02
#define UMP_MT_DATA_64             0x03
#define UMP_MT_MIDI2_CHANNEL_VOICE 0x04
#define UMP_MT_DATA_128            0x05
#define UMP_MT_FLEX_DATA           0x0d
#define UMP_MT_UMP_STREAM          0x0f

#define UMP_MT(ump) \
        ((ump).data[0] >> 28)

#define UMP_NUM_WORDS_LOOKUP_TABLE \
        ((0U << 0) | (0U << 2) | (0U << 4) | (1U << 6) | \
        (1U << 8) | (3U << 10) | (0U << 12) | (0U << 14) | \
        (1U << 16) | (1U << 18) | (1U << 20) | (2U << 22) | \
        (2U << 24) | (3U << 26) | (3U << 28) | (3U << 30))

#define UMP_NUM_WORDS(ump) \
        (1 + ((UMP_NUM_WORDS_LOOKUP_TABLE >> (2 * UMP_MT(ump))) & 3))

#define UMP_GROUP(ump) \
        (((ump).data[0] >> 24) & 0xF)

#define UMP_MIDI_STATUS(ump) \
        (((ump).data[0] >> 16) & 0xFF)

#define UMP_MIDI_COMMAND(ump) \
        (UMP_MIDI_STATUS(ump) >> 4)

#define UMP_MIDI_CHANNEL(ump) \
        (UMP_MIDI_STATUS(ump) & 0xF)

#define UMP_MIDI1_P1(ump) \
        (((ump).data[0] >> 8) & 0x7F)

#define UMP_MIDI1_P2(ump) \
        ((ump).data[0] & 0x7F)

#define UMP_MIDI1_CHANNEL_VOICE(group, command, channel, p1, p2) \
        (struct midi_ump) {.data = {                             \
                (UMP_MT_MIDI1_CHANNEL_VOICE << 28)               \
                | (((group) & 0x0f) << 24)                       \
                | (((command) & 0x0f) << 20)                     \
                | (((channel) & 0x0f) << 16)                     \
                | (((p1) & 0x7f) << 8)                           \
                | ((p2) & 0x7f)                                  \
        }}

#define UMP_MIDI_NOTE_OFF        0x8 
#define UMP_MIDI_NOTE_ON         0x9 
#define UMP_MIDI_AFTERTOUCH      0xa 
#define UMP_MIDI_CONTROL_CHANGE  0xb 
#define UMP_MIDI_PROGRAM_CHANGE  0xc 
#define UMP_MIDI_CHAN_AFTERTOUCH 0xd 
#define UMP_MIDI_PITCH_BEND      0xe 

#define UMP_SYS_RT_COMMON(group, status, p1, p2) \
        (struct midi_ump) {.data = {             \
                (UMP_MT_SYS_RT_COMMON << 28)     \
                | (((group) & 0x0f) << 24)       \
                | ((status) << 16)               \
                | (((p1) & 0x7f) << 8)           \
                | ((p2) & 0x7f)                  \
        }}

#define UMP_SYS_MIDI_TIME_CODE 0xf1 
#define UMP_SYS_SONG_POSITION  0xf2 
#define UMP_SYS_SONG_SELECT    0xf3 
#define UMP_SYS_TUNE_REQUEST   0xf6 
#define UMP_SYS_TIMING_CLOCK   0xf8 
#define UMP_SYS_START          0xfa 
#define UMP_SYS_CONTINUE       0xfb 
#define UMP_SYS_STOP           0xfc 
#define UMP_SYS_ACTIVE_SENSING 0xfe 
#define UMP_SYS_RESET          0xff 
 


#define UMP_STREAM_FORMAT(ump) \
        (((ump).data[0] >> 26) & 0x03)


#define UMP_STREAM_FORMAT_COMPLETE 0x00
#define UMP_STREAM_FORMAT_START    0x01
#define UMP_STREAM_FORMAT_CONTINUE 0x02
#define UMP_STREAM_FORMAT_END      0x03


#define UMP_STREAM_STATUS(ump) \
        (((ump).data[0] >> 16) & 0x3FF)


#define UMP_STREAM_STATUS_EP_DISCOVERY 0x00
#define UMP_STREAM_STATUS_EP_INFO      0x01
#define UMP_STREAM_STATUS_DEVICE_IDENT 0x02
#define UMP_STREAM_STATUS_EP_NAME      0x03
#define UMP_STREAM_STATUS_PROD_ID      0x04
#define UMP_STREAM_STATUS_CONF_REQ     0x05
#define UMP_STREAM_STATUS_CONF_NOTIF   0x06
#define UMP_STREAM_STATUS_FB_DISCOVERY 0x10
#define UMP_STREAM_STATUS_FB_INFO      0x11
#define UMP_STREAM_STATUS_FB_NAME      0x12

#define UMP_STREAM_EP_DISCOVERY_FILTER(ump) \
        ((ump).data[1] & 0xFF)


#define UMP_EP_DISC_FILTER_EP_INFO    BIT(0)
#define UMP_EP_DISC_FILTER_DEVICE_ID  BIT(1)
#define UMP_EP_DISC_FILTER_EP_NAME    BIT(2)
#define UMP_EP_DISC_FILTER_PRODUCT_ID BIT(3)
#define UMP_EP_DISC_FILTER_STREAM_CFG BIT(4)

#define UMP_STREAM_FB_DISCOVERY_FILTER(ump) \
        ((ump).data[0] & 0xFF)

#define UMP_STREAM_FB_DISCOVERY_NUM(ump) \
        (((ump).data[0] >> 8) & 0xFF)

#define UMP_FB_DISC_FILTER_INFO BIT(0)
#define UMP_FB_DISC_FILTER_NAME BIT(1)


 
#ifdef __cplusplus
}
#endif
 
#endif