Patroneo/template/calfbox/usbio_impl.h

/*
Calf Box, an open source musical instrument.
Copyright (C) 2010-2013 Krzysztof Foltman

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

/*

Note:
Those are private structures and functions for the USB driver implementation.
I'm not too happy with the organization of the code yet, it's just a first
try at breaking it up into manageable parts.
*/


#ifndef USBIO_IMPL_H
#define USBIO_IMPL_H

#include <libusb.h>

#include "errors.h"
#include "io.h"
#include "midi.h"
#include "mididest.h"

struct usbio_endpoint_descriptor
{
    uint8_t found:1;
    uint8_t interrupt:1;
    uint8_t reserved:6;
    uint8_t bEndpointAddress;
    uint16_t wMaxPacketSize;
};

struct usbio_transfer
{
    struct libusb_context *usbctx;
    struct libusb_transfer *transfer;
    void *user_data;
    gboolean pending;
    gboolean cancel_confirm;
    const char *transfer_type;
    int index;
};

enum usb_sync_protocol_type
{
    USBAUDIOSYNC_PROTOCOL_NONE = 0,
    USBAUDIOSYNC_PROTOCOL_CLASS,
    USBAUDIOSYNC_PROTOCOL_MULTIMIX8,
};

struct cbox_usb_io_impl
{
    struct cbox_io_impl ioi;

    struct libusb_context *usbctx;
    struct libusb_context *usbctx_probe;
    
    GHashTable *device_table;
    
    struct libusb_device_handle *handle_audiodev;
    int sample_rate, buffer_size, output_resolution;
    int output_channels; // always 2 for now

    unsigned int playback_buffers;
    unsigned int sync_buffers;
    unsigned int playback_counter;
    unsigned int sync_counter;
    unsigned int device_removed;
    enum usb_sync_protocol_type sync_protocol;

    unsigned int iso_packets, iso_packets_multimix;

    pthread_t thr_engine;
    volatile gboolean stop_engine, setup_error, no_resubmit;
    
    int desync;
    uint64_t samples_played;
    struct usbio_transfer **playback_transfers;
    struct usbio_transfer **sync_transfers;
    int read_ptr;
    
    GList *midi_ports;
    GList *rt_midi_ports;
    struct cbox_midi_merger midi_input_merger;
    void (*play_function)(struct cbox_usb_io_impl *uii);
    int8_t audio_output_endpoint;
    int8_t audio_sync_endpoint;
    gboolean is_hispeed;
    uint32_t samples_per_sec; // current estimated sample rate / 100
    uint32_t audio_output_pktsize;
    int debug_sync;
};

enum cbox_usb_device_status
{
    CBOX_DEVICE_STATUS_PROBING,
    CBOX_DEVICE_STATUS_UNSUPPORTED,
    CBOX_DEVICE_STATUS_OPENED,
};

struct cbox_usb_device_info
{
    struct libusb_device *dev;
    struct libusb_device_handle *handle;
    enum cbox_usb_device_status status;
    uint8_t bus;
    uint8_t devadr;
    uint16_t busdevadr;
    struct {
        uint16_t vid;
        uint16_t pid;
    };
    int active_config;
    gboolean is_midi, is_audio;
    uint32_t configs_with_midi;
    uint32_t configs_with_audio;
    time_t last_probe_time;
    int failures;
};

struct cbox_usb_audio_info
{
    struct cbox_usb_device_info *udi;
    int intf;
    int alt_setting;
    struct usbio_endpoint_descriptor epdesc;
    enum usb_sync_protocol_type sync_protocol;
    struct usbio_endpoint_descriptor sync_epdesc;
};

enum usb_midi_protocol_type
{
    USBMIDI_PROTOCOL_CLASS,
    USBMIDI_PROTOCOL_MPD16,
    USBMIDI_PROTOCOL_NOCTURN,
};

struct cbox_usb_midi_info
{
    struct cbox_usb_device_info *udi;
    int intf;
    int alt_setting;
    struct usbio_endpoint_descriptor epdesc_in;
    struct usbio_endpoint_descriptor epdesc_out;
    enum usb_midi_protocol_type protocol;
};

#define MAX_MIDI_PACKET_SIZE 256
#define MAX_SYSEX_SIZE CBOX_MIDI_MAX_LONG_DATA

struct cbox_usb_midi_interface
{
    struct cbox_usb_io_impl *uii;
    struct cbox_usb_device_info *devinfo;
    struct libusb_device_handle *handle;
    int busdevadr;
    struct usbio_endpoint_descriptor epdesc_in, epdesc_out;
    struct usbio_transfer *transfer_in, *transfer_out;
    uint8_t midi_recv_data[MAX_MIDI_PACKET_SIZE];
    uint8_t sysex_data[MAX_SYSEX_SIZE];
    uint32_t current_sysex_length;
    enum usb_midi_protocol_type protocol;
    struct cbox_usb_midi_input *input_port;
    struct cbox_usb_midi_output *output_port;
};

#define USB_MIDI_OUTPUT_QUEUE 256

struct cbox_usb_midi_input
{
    struct cbox_midi_input hdr;
    struct cbox_usb_midi_interface *ifptr;
};

struct cbox_usb_midi_output
{
    struct cbox_midi_output hdr;
    struct cbox_usb_midi_interface *ifptr;
    uint8_t endpoint_buffer[USB_MIDI_OUTPUT_QUEUE];
    uint32_t endpoint_buffer_pos;
};

extern struct usbio_transfer *usbio_transfer_new(struct libusb_context *usbctx, const char *transfer_type, int index, int isopackets, void *user_data);
extern void usbio_transfer_shutdown(struct usbio_transfer *xfer);
extern int usbio_transfer_submit(struct usbio_transfer *xfer);
extern void usbio_transfer_destroy(struct usbio_transfer *xfer);

extern void cbox_usb_midi_info_init(struct cbox_usb_midi_info *umi, struct cbox_usb_device_info *udi);
extern void usbio_start_midi_capture(struct cbox_usb_io_impl *uii);
extern void usbio_stop_midi_capture(struct cbox_usb_io_impl *uii);
extern struct cbox_usb_midi_interface *usbio_open_midi_interface(struct cbox_usb_io_impl *uii,
    const struct cbox_usb_midi_info *uminf, struct libusb_device_handle *handle);
extern void usbio_send_midi_to_output(struct cbox_usb_midi_output *umo);
extern void usbio_fill_midi_output_buffer(struct cbox_usb_midi_output *umo);

extern void cbox_usb_audio_info_init(struct cbox_usb_audio_info *uai, struct cbox_usb_device_info *udi);
extern void usbio_start_audio_playback(struct cbox_usb_io_impl *uii);
extern void usbio_stop_audio_playback(struct cbox_usb_io_impl *uii);
extern gboolean usbio_open_audio_interface(struct cbox_usb_io_impl *uii, 
    struct cbox_usb_audio_info *uainf, struct libusb_device_handle *handle, GError **error);
extern gboolean usbio_open_audio_interface_multimix(struct cbox_usb_io_impl *uii, int bus, int devadr, struct libusb_device_handle *handle, GError **error);
extern void usbio_update_port_routing(struct cbox_io_impl *ioi);


extern void usbio_play_buffer_asynchronous(struct cbox_usb_io_impl *uii);
extern gboolean usbio_scan_devices(struct cbox_usb_io_impl *uii, gboolean probe_only);

extern void usbio_forget_device(struct cbox_usb_io_impl *uii, struct cbox_usb_device_info *devinfo);
extern void usbio_run_idle_loop(struct cbox_usb_io_impl *uii);

#define USB_DEVICE_SETUP_TIMEOUT 2000

static inline gboolean configure_usb_interface(struct libusb_device_handle *handle, int bus, int devadr, int ifno, int altset, const char *purpose, GError **error)
{
    int err = 0;
    if (libusb_kernel_driver_active(handle, ifno) == 1)
    {
        err = libusb_detach_kernel_driver(handle, ifno);
        if (err)
        {
            g_set_error(error, CBOX_MODULE_ERROR, CBOX_MODULE_ERROR_FAILED, "Cannot detach kernel driver from interface %d on device %03d:%03d: %s. Please rmmod snd-usb-audio as root.", ifno, bus, devadr, libusb_error_name(err));
            return FALSE;
        }            
    }
    err = libusb_claim_interface(handle, ifno);
    if (err)
    {
        g_set_error(error, CBOX_MODULE_ERROR, CBOX_MODULE_ERROR_FAILED, "Cannot claim interface %d on device %03d:%03d for %s: %s", ifno, bus, devadr, purpose, libusb_error_name(err));
        return FALSE;
    }
    err = altset ? libusb_set_interface_alt_setting(handle, ifno, altset) : 0;
    if (err)
    {
        g_set_error(error, CBOX_MODULE_ERROR, CBOX_MODULE_ERROR_FAILED, "Cannot set alt-setting %d for interface %d on device %03d:%03d for %s: %s", altset, ifno, bus, devadr, purpose, libusb_error_name(err));
        return FALSE;
    }
    return TRUE;
}


#endif