midi2.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025 Titouan Christophe
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_NET_MIDI2_H_
#define ZEPHYR_INCLUDE_NET_MIDI2_H_


 
 
#include <stdint.h>
#include <zephyr/audio/midi.h>
#include <zephyr/net/socket.h>
#include <zephyr/posix/poll.h>

#define NETMIDI2_NONCE_SIZE  16

#define NETMIDI2_EP_DEFINE(_var_name, _ep_name, _piid, _port) \
        static struct netmidi2_ep _var_name = { \
                .name = (_ep_name), \
                .piid = (_piid), \
                .addr4.sin_port = (_port), \
                .auth_type = NETMIDI2_AUTH_NONE, \
        }

#define NETMIDI2_EP_DEFINE_WITH_AUTH(_var_name, _ep_name, _piid, _port, _secret) \
        static struct netmidi2_ep _var_name = { \
                .name = (_ep_name), \
                .piid = (_piid), \
                .addr4.sin_port = (_port), \
                .auth_type = NETMIDI2_AUTH_SHARED_SECRET, \
                .shared_auth_secret = (_secret), \
        }

#define NETMIDI2_EP_DEFINE_WITH_USERS(_var_name, _ep_name, _piid, _port, ...) \
        static const struct netmidi2_userlist users_of_##_var_name = { \
                .n_users = ARRAY_SIZE(((struct netmidi2_user []) { __VA_ARGS__ })), \
                .users = { __VA_ARGS__ }, \
        }; \
        static struct netmidi2_ep _var_name = { \
                .name = (_ep_name), \
                .piid = (_piid), \
                .addr4.sin_port = (_port), \
                .auth_type = NETMIDI2_AUTH_USER_PASSWORD, \
                .userlist = &users_of_##_var_name, \
        }
 
struct netmidi2_ep;

struct netmidi2_user {
        const char *name;
        const char *password;
};

struct netmidi2_userlist {
        size_t n_users;
        const struct netmidi2_user users[];
};

struct netmidi2_session {
        enum {
                NETMIDI2_SESSION_NOT_INITIALIZED = 0,
                NETMIDI2_SESSION_IDLE,
                NETMIDI2_SESSION_PENDING_INVITATION,
                NETMIDI2_SESSION_AUTH_REQUIRED,
                NETMIDI2_SESSION_ESTABLISHED,
                NETMIDI2_SESSION_PENDING_RESET,
                NETMIDI2_SESSION_PENDING_BYE,
        } state;
        uint16_t tx_ump_seq;
        uint16_t rx_ump_seq;
        struct sockaddr_storage addr;
        socklen_t addr_len;
        struct netmidi2_ep *ep;
#if defined(CONFIG_NETMIDI2_HOST_AUTH) || defined(__DOXYGEN__)
        const struct netmidi2_user *user;
        char nonce[NETMIDI2_NONCE_SIZE];
#endif
        struct net_buf *tx_buf;
        struct k_work tx_work;
};

enum netmidi2_auth_type {
        NETMIDI2_AUTH_NONE,
        NETMIDI2_AUTH_SHARED_SECRET,
        NETMIDI2_AUTH_USER_PASSWORD,
};

struct netmidi2_ep {
        const char *name;
        const char *piid;
        union {
                struct sockaddr addr;
                struct sockaddr_in addr4;
                struct sockaddr_in6 addr6;
        };
        struct pollfd pollsock;
        void (*rx_packet_cb)(struct netmidi2_session *session,
                             const struct midi_ump ump);
        struct netmidi2_session peers[CONFIG_NETMIDI2_HOST_MAX_CLIENTS];
        enum netmidi2_auth_type auth_type;
#if defined(CONFIG_NETMIDI2_HOST_AUTH) || defined(__DOXYGEN__)
        union {
                const char *shared_auth_secret;
                const struct netmidi2_userlist *userlist;
        };
#endif
};

int netmidi2_host_ep_start(struct netmidi2_ep *ep);

void netmidi2_broadcast(struct netmidi2_ep *ep, const struct midi_ump ump);

void netmidi2_send(struct netmidi2_session *sess, const struct midi_ump ump);

 
#endif