/*      $OpenBSD: sysex.h,v 1.5 2022/12/26 19:16:00 jmc Exp $   */
/*
 * Copyright (c) 2011 Alexandre Ratchov <alex@caoua.org>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */
#ifndef SYSEX_H
#define SYSEX_H

#include <stdint.h>

/*
 * start and end markers
 */
#define SYSEX_START             0xf0
#define SYSEX_END               0xf7

/*
 * type/vendor namespace IDs we use
 */
#define SYSEX_TYPE_RT           0x7f    /* real-time universal */
#define SYSEX_TYPE_EDU          0x7d    /* non-comercial */

/*
 * realtime messages in the "universal real-time" namespace
 */
#define SYSEX_MTC               0x01            /* mtc messages */
#define   SYSEX_MTC_FULL        0x01            /* mtc full frame message */
#define SYSEX_CONTROL           0x04
#define   SYSEX_MASTER          0x01
#define SYSEX_MMC               0x06
#define   SYSEX_MMC_STOP        0x01
#define   SYSEX_MMC_START       0x02
#define   SYSEX_MMC_LOC         0x44
#define   SYSEX_MMC_LOC_LEN     0x06
#define   SYSEX_MMC_LOC_CMD     0x01

/*
 * special "any" midi device number
 */
#define SYSEX_DEV_ANY           0x7f

/*
 * minimum size of sysex message we accept
 */
#define SYSEX_SIZE(m)   (5 + sizeof(struct sysex_ ## m))

/*
 * all possible system exclusive messages we support.
 */
struct sysex {
        uint8_t start;
        uint8_t type;                           /* type or vendor id */
        uint8_t dev;                            /* device or product id */
        uint8_t id0;                            /* message id */
        uint8_t id1;                            /* sub-id */
        union sysex_all {
                struct sysex_empty {
                        uint8_t end;
                } empty;
                struct sysex_master {
                        uint8_t fine;
                        uint8_t coarse;
                        uint8_t end;
                } master;
                struct sysex_start {
                        uint8_t end;
                } start;
                struct sysex_stop {
                        uint8_t end;
                } stop;
                struct sysex_loc {
                        uint8_t len;
                        uint8_t cmd;
#define MTC_FPS_24      0
#define MTC_FPS_25      1
#define MTC_FPS_30      3
                        uint8_t hr;             /* MSB contain MTC_FPS */
                        uint8_t min;
                        uint8_t sec;
                        uint8_t fr;
                        uint8_t cent;
                        uint8_t end;
                } loc;
                struct sysex_full {
                        uint8_t hr;
                        uint8_t min;
                        uint8_t sec;
                        uint8_t fr;
                        uint8_t end;
                } full;
        } u;
};

#endif /* !defined(SYSEX_H) */