/* packet-usb-audio.c

 *

 * usb audio dissector

 * Tomasz Mon 2012

 *

 * SPDX-License-Identifier: GPL-2.0-or-later

 */

/* the parsing of audio-specific descriptors is based on

   USB Audio Device Class Specification for Basic Audio Devices, Release 1.0,

   USB Device Class Definition for Audio Devices, Release 2.0 and

   USB Device Class Definition for MIDI Devices, Release 1.0 */

#include "config.h"

#include <epan/packet.h>

#include <epan/expert.h>

#include <epan/reassemble.h>

#include "packet-usb.h"

/* XXX - we use the same macro for mpeg sections,

         can we put this in a common include file? */

#define USB_AUDIO_BCD44_TO_DEC(x)  ((((x)&0xf0) >> 4) * 10 + ((x)&0x0f))

void proto_register_usb_audio(void);

void proto_reg_handoff_usb_audio(void);

/* protocols and header fields */

static int proto_usb_audio;

static int hf_midi_cable_number;

static int hf_midi_code_index;

static int hf_midi_event;

static int hf_midi_padding;

static int hf_ac_if_desc_subtype;

static int hf_ac_if_hdr_ver;

static int hf_ac_if_hdr_total_len;

static int hf_ac_if_hdr_bInCollection;

static int hf_ac_if_hdr_if_num;

static int hf_ac_if_hdr_category;

static int hf_ac_if_hdr_controls;

static int hf_ac_if_hdr_controls_latency;

static int hf_ac_if_hdr_controls_rsv;

static int hf_ac_if_input_terminalid;

static int hf_ac_if_input_terminaltype;

static int hf_ac_if_input_assocterminal;

static int hf_ac_if_input_csourceid;

static int hf_ac_if_input_nrchannels;

static int hf_ac_if_input_wchannelconfig;

static int hf_ac_if_input_wchannelconfig_d0;

static int hf_ac_if_input_wchannelconfig_d1;

static int hf_ac_if_input_wchannelconfig_d2;

static int hf_ac_if_input_wchannelconfig_d3;

static int hf_ac_if_input_wchannelconfig_d4;

static int hf_ac_if_input_wchannelconfig_d5;

static int hf_ac_if_input_wchannelconfig_d6;

static int hf_ac_if_input_wchannelconfig_d7;

static int hf_ac_if_input_wchannelconfig_d8;

static int hf_ac_if_input_wchannelconfig_d9;

static int hf_ac_if_input_wchannelconfig_d10;

static int hf_ac_if_input_wchannelconfig_d11;

static int hf_ac_if_input_wchannelconfig_rsv;

static int hf_ac_if_input_bmchannelconfig;

static int hf_ac_if_input_bmchannelconfig_d0;

static int hf_ac_if_input_bmchannelconfig_d1;

static int hf_ac_if_input_bmchannelconfig_d2;

static int hf_ac_if_input_bmchannelconfig_d3;

static int hf_ac_if_input_bmchannelconfig_d4;

static int hf_ac_if_input_bmchannelconfig_d5;

static int hf_ac_if_input_bmchannelconfig_d6;

static int hf_ac_if_input_bmchannelconfig_d7;

static int hf_ac_if_input_bmchannelconfig_d8;

static int hf_ac_if_input_bmchannelconfig_d9;

static int hf_ac_if_input_bmchannelconfig_d10;

static int hf_ac_if_input_bmchannelconfig_d11;

static int hf_ac_if_input_bmchannelconfig_d12;

static int hf_ac_if_input_bmchannelconfig_d13;

static int hf_ac_if_input_bmchannelconfig_d14;

static int hf_ac_if_input_bmchannelconfig_d15;

static int hf_ac_if_input_bmchannelconfig_d16;

static int hf_ac_if_input_bmchannelconfig_d17;

static int hf_ac_if_input_bmchannelconfig_d18;

static int hf_ac_if_input_bmchannelconfig_d19;

static int hf_ac_if_input_bmchannelconfig_d20;

static int hf_ac_if_input_bmchannelconfig_d21;

static int hf_ac_if_input_bmchannelconfig_d22;

static int hf_ac_if_input_bmchannelconfig_d23;

static int hf_ac_if_input_bmchannelconfig_d24;

static int hf_ac_if_input_bmchannelconfig_d25;

static int hf_ac_if_input_bmchannelconfig_d26;

static int hf_ac_if_input_bmchannelconfig_rsv;

static int hf_ac_if_input_bmchannelconfig_d31;

static int hf_ac_if_input_channelnames;

static int hf_ac_if_input_controls;

static int hf_ac_if_input_controls_copy;

static int hf_ac_if_input_controls_connector;

static int hf_ac_if_input_controls_overload;

static int hf_ac_if_input_controls_cluster;

static int hf_ac_if_input_controls_underflow;

static int hf_ac_if_input_controls_overflow;

static int hf_ac_if_input_controls_rsv;

static int hf_ac_if_input_terminal;

static int hf_ac_if_output_terminalid;

static int hf_ac_if_output_terminaltype;

static int hf_ac_if_output_assocterminal;

static int hf_ac_if_output_sourceid;

static int hf_ac_if_output_clk_sourceid;

static int hf_ac_if_output_controls;

static int hf_ac_if_output_controls_copy;

static int hf_ac_if_output_controls_connector;

static int hf_ac_if_output_controls_overload;

static int hf_ac_if_output_controls_underflow;

static int hf_ac_if_output_controls_overflow;

static int hf_ac_if_output_controls_rsv;

static int hf_ac_if_output_terminal;

static int hf_ac_if_fu_unitid;

static int hf_ac_if_fu_sourceid;

static int hf_ac_if_fu_controlsize;

static int hf_ac_if_fu_controls;

static int hf_ac_if_fu_control;

static int hf_ac_if_fu_controls_d0;

static int hf_ac_if_fu_controls_d1;

static int hf_ac_if_fu_controls_d2;

static int hf_ac_if_fu_controls_d3;

static int hf_ac_if_fu_controls_d4;

static int hf_ac_if_fu_controls_d5;

static int hf_ac_if_fu_controls_d6;

static int hf_ac_if_fu_controls_d7;

static int hf_ac_if_fu_controls_d8;

static int hf_ac_if_fu_controls_d9;

static int hf_ac_if_fu_controls_rsv;

static int hf_ac_if_fu_controls_v2;

static int hf_ac_if_fu_control_v2;

static int hf_ac_if_fu_controls_v2_d0;

static int hf_ac_if_fu_controls_v2_d1;

static int hf_ac_if_fu_controls_v2_d2;

static int hf_ac_if_fu_controls_v2_d3;

static int hf_ac_if_fu_controls_v2_d4;

static int hf_ac_if_fu_controls_v2_d5;

static int hf_ac_if_fu_controls_v2_d6;

static int hf_ac_if_fu_controls_v2_d7;

static int hf_ac_if_fu_controls_v2_d8;

static int hf_ac_if_fu_controls_v2_d9;

static int hf_ac_if_fu_controls_v2_d10;

static int hf_ac_if_fu_controls_v2_d11;

static int hf_ac_if_fu_controls_v2_d12;

static int hf_ac_if_fu_controls_v2_d13;

static int hf_ac_if_fu_controls_v2_d14;

static int hf_ac_if_fu_controls_v2_rsv;

static int hf_ac_if_fu_ifeature;

static int hf_ac_if_su_unitid;

static int hf_ac_if_su_nrinpins;

static int hf_ac_if_su_sourceids;

static int hf_ac_if_su_sourceid;

static int hf_ac_if_su_controls;

static int hf_ac_if_su_controls_d0;

static int hf_ac_if_su_controls_rsv;

static int hf_ac_if_su_iselector;

static int hf_ac_if_mu_unitid;

static int hf_ac_if_mu_nrinpins;

static int hf_ac_if_mu_sourceid;

static int hf_ac_if_mu_nrchannels;

static int hf_ac_if_mu_channelconfig;

static int hf_ac_if_mu_channelconfig_d0;

static int hf_ac_if_mu_channelconfig_d1;

static int hf_ac_if_mu_channelconfig_d2;

static int hf_ac_if_mu_channelconfig_d3;

static int hf_ac_if_mu_channelconfig_d4;

static int hf_ac_if_mu_channelconfig_d5;

static int hf_ac_if_mu_channelconfig_d6;

static int hf_ac_if_mu_channelconfig_d7;

static int hf_ac_if_mu_channelconfig_d8;

static int hf_ac_if_mu_channelconfig_d9;

static int hf_ac_if_mu_channelconfig_d10;

static int hf_ac_if_mu_channelconfig_d11;

static int hf_ac_if_mu_channelconfig_rsv;

static int hf_ac_if_mu_channelnames;

static int hf_ac_if_mu_controls;

static int hf_ac_if_mu_imixer;

static int hf_ac_if_clksrc_id;

static int hf_ac_if_clksrc_attr;

static int hf_ac_if_clksrc_attr_type;

static int hf_ac_if_clksrc_attr_d2;

static int hf_ac_if_clksrc_attr_rsv;

static int hf_ac_if_clksrc_controls;

static int hf_ac_if_clksrc_controls_freq;

static int hf_ac_if_clksrc_controls_validity;

static int hf_ac_if_clksrc_controls_rsv;

static int hf_ac_if_clksrc_assocterminal;

static int hf_ac_if_clksrc_clocksource;

static int hf_ac_if_clksel_id;

static int hf_ac_if_clksel_nrpins;

static int hf_ac_if_clksel_sourceid;

static int hf_ac_if_clksel_controls;

static int hf_ac_if_clksel_controls_clksel;

static int hf_ac_if_clksel_controls_rsv;

static int hf_ac_if_clksel_clockselector;

static int hf_as_if_desc_subtype;

static int hf_ac_if_extunit_id;

static int hf_ac_if_extunit_code;

static int hf_ac_if_extunit_nrpins;

static int hf_ac_if_extunit_sourceid;

static int hf_ac_if_extunit_nrchannels;

static int hf_ac_if_extunit_bmchannelconfig;

static int hf_ac_if_extunit_channelnames;

static int hf_ac_if_extunit_bmcontrols;

static int hf_ac_if_extunit_bmcontrols_enable_ctrl;

static int hf_ac_if_extunit_bmcontrols_cluster_ctrl;

static int hf_ac_if_extunit_bmcontrols_underflow_ctrl;

static int hf_ac_if_extunit_bmcontrols_overflowflow_ctrl;

static int hf_ac_if_extunit_iext;

static int hf_as_if_gen_term_link;

static int hf_as_if_gen_delay;

static int hf_as_if_gen_wformattag;

static int hf_as_if_gen_controls;

static int hf_as_if_gen_controls_active;

static int hf_as_if_gen_controls_valid;

static int hf_as_if_gen_controls_rsv;

static int hf_as_if_gen_formattype;

static int hf_as_if_gen_formats;

static int hf_as_if_gen_formats_i_d0;

static int hf_as_if_gen_formats_i_d1;

static int hf_as_if_gen_formats_i_d2;

static int hf_as_if_gen_formats_i_d3;

static int hf_as_if_gen_formats_i_d4;

static int hf_as_if_gen_formats_i_rsv;

static int hf_as_if_gen_formats_i_d31;

static int hf_as_if_gen_formats_ii_d0;

static int hf_as_if_gen_formats_ii_d1;

static int hf_as_if_gen_formats_ii_d2;

static int hf_as_if_gen_formats_ii_d3;

static int hf_as_if_gen_formats_ii_rsv;

static int hf_as_if_gen_formats_ii_d31;

static int hf_as_if_gen_formats_iii_d0;

static int hf_as_if_gen_formats_iii_d1;

static int hf_as_if_gen_formats_iii_d2;

static int hf_as_if_gen_formats_iii_d3;

static int hf_as_if_gen_formats_iii_d4;

static int hf_as_if_gen_formats_iii_d5;

static int hf_as_if_gen_formats_iii_d6;

static int hf_as_if_gen_formats_iii_d7;

static int hf_as_if_gen_formats_iii_d8;

static int hf_as_if_gen_formats_iii_d9;

static int hf_as_if_gen_formats_iii_d10;

static int hf_as_if_gen_formats_iii_d11;

static int hf_as_if_gen_formats_iii_d12;

static int hf_as_if_gen_formats_iii_rsv;

static int hf_as_if_gen_formats_iv_d0;

static int hf_as_if_gen_formats_iv_d1;

static int hf_as_if_gen_formats_iv_d2;

static int hf_as_if_gen_formats_iv_d3;

static int hf_as_if_gen_formats_iv_d4;

static int hf_as_if_gen_formats_iv_d5;

static int hf_as_if_gen_formats_iv_d6;

static int hf_as_if_gen_formats_iv_d7;

static int hf_as_if_gen_formats_iv_d8;

static int hf_as_if_gen_formats_iv_d9;

static int hf_as_if_gen_formats_iv_d10;

static int hf_as_if_gen_formats_iv_d11;

static int hf_as_if_gen_formats_iv_d12;

static int hf_as_if_gen_formats_iv_d13;

static int hf_as_if_gen_formats_iv_d14;

static int hf_as_if_gen_formats_iv_d15;

static int hf_as_if_gen_formats_iv_d16;

static int hf_as_if_gen_formats_iv_d17;

static int hf_as_if_gen_formats_iv_d18;

static int hf_as_if_gen_formats_iv_d19;

static int hf_as_if_gen_formats_iv_d20;

static int hf_as_if_gen_formats_iv_d21;

static int hf_as_if_gen_formats_iv_rsv;

static int hf_as_if_gen_nrchannels;

static int hf_as_if_gen_bmchannelconfig;

static int hf_as_if_gen_bmchannelconfig_d0;

static int hf_as_if_gen_bmchannelconfig_d1;

static int hf_as_if_gen_bmchannelconfig_d2;

static int hf_as_if_gen_bmchannelconfig_d3;

static int hf_as_if_gen_bmchannelconfig_d4;

static int hf_as_if_gen_bmchannelconfig_d5;

static int hf_as_if_gen_bmchannelconfig_d6;

static int hf_as_if_gen_bmchannelconfig_d7;

static int hf_as_if_gen_bmchannelconfig_d8;

static int hf_as_if_gen_bmchannelconfig_d9;

static int hf_as_if_gen_bmchannelconfig_d10;

static int hf_as_if_gen_bmchannelconfig_d11;

static int hf_as_if_gen_bmchannelconfig_d12;

static int hf_as_if_gen_bmchannelconfig_d13;

static int hf_as_if_gen_bmchannelconfig_d14;

static int hf_as_if_gen_bmchannelconfig_d15;

static int hf_as_if_gen_bmchannelconfig_d16;

static int hf_as_if_gen_bmchannelconfig_d17;

static int hf_as_if_gen_bmchannelconfig_d18;

static int hf_as_if_gen_bmchannelconfig_d19;

static int hf_as_if_gen_bmchannelconfig_d20;

static int hf_as_if_gen_bmchannelconfig_d21;

static int hf_as_if_gen_bmchannelconfig_d22;

static int hf_as_if_gen_bmchannelconfig_d23;

static int hf_as_if_gen_bmchannelconfig_d24;

static int hf_as_if_gen_bmchannelconfig_d25;

static int hf_as_if_gen_bmchannelconfig_d26;

static int hf_as_if_gen_bmchannelconfig_rsv;

static int hf_as_if_gen_bmchannelconfig_d31;

static int hf_as_if_gen_channelnames;

static int hf_as_if_ft_formattype;

static int hf_as_if_ft_maxbitrate;

static int hf_as_if_ft_nrchannels;

static int hf_as_if_ft_subframesize;

static int hf_as_if_ft_subslotsize;

static int hf_as_if_ft_bitresolution;

static int hf_as_if_ft_samplesperframe;

static int hf_as_if_ft_samfreqtype;

static int hf_as_if_ft_lowersamfreq;

static int hf_as_if_ft_uppersamfreq;

static int hf_as_if_ft_samfreq;

static int hf_as_ep_desc_subtype;

static int hf_as_ep_gen_bmattributes;

static int hf_as_ep_gen_bmattributes_d0;

static int hf_as_ep_gen_bmattributes_d1;

static int hf_as_ep_gen_bmattributes_rsv;

static int hf_as_ep_gen_bmattributes_d7;

static int hf_as_ep_gen_controls;

static int hf_as_ep_gen_controls_pitch;

static int hf_as_ep_gen_controls_data_overrun;

static int hf_as_ep_gen_controls_data_underrun;

static int hf_as_ep_gen_controls_rsv;

static int hf_as_ep_gen_lockdelayunits;

static int hf_as_ep_gen_lockdelay;

static int hf_ms_if_desc_subtype;

static int hf_ms_if_hdr_ver;

static int hf_ms_if_hdr_total_len;

static int hf_ms_if_midi_in_bjacktype;

static int hf_ms_if_midi_in_bjackid;

static int hf_ms_if_midi_in_ijack;

static int hf_ms_if_midi_out_bjacktype;

static int hf_ms_if_midi_out_bjackid;

static int hf_ms_if_midi_out_bnrinputpins;

static int hf_ms_if_midi_out_basourceid;

static int hf_ms_if_midi_out_basourcepin;

static int hf_ms_if_midi_out_ijack;

static int hf_ms_if_midi_element_belementid;

static int hf_ms_if_midi_element_bnrinputpins;

static int hf_ms_if_midi_element_basourceid;

static int hf_ms_if_midi_element_basourcepin;

static int hf_ms_if_midi_element_bnroutputpins;

static int hf_ms_if_midi_element_binterminallink;

static int hf_ms_if_midi_element_boutterminallink;

static int hf_ms_if_midi_element_belcapssize;

static int hf_ms_if_midi_element_caps;

static int hf_ms_if_midi_element_cap1;

static int hf_ms_if_midi_element_caps_d0;

static int hf_ms_if_midi_element_caps_d1;

static int hf_ms_if_midi_element_caps_d2;

static int hf_ms_if_midi_element_caps_d3;

static int hf_ms_if_midi_element_caps_d4;

static int hf_ms_if_midi_element_caps_d5;

static int hf_ms_if_midi_element_caps_d6;

static int hf_ms_if_midi_element_caps_d7;

static int hf_ms_if_midi_element_cap2;

static int hf_ms_if_midi_element_caps_d8;

static int hf_ms_if_midi_element_caps_d9;

static int hf_ms_if_midi_element_caps_d10;

static int hf_ms_if_midi_element_caps_d11;

static int hf_ms_if_midi_element_cap2_rsv;

static int hf_ms_if_midi_element_cap3_rsv;

static int hf_ms_if_midi_element_ielement;

static int hf_ms_ep_gen_numjacks;

static int hf_ms_ep_gen_baassocjackid;

static int hf_ms_ep_desc_subtype;

static int hf_brequest_v1;

static int hf_brequest_v2;

static int hf_wvalue;

static int hf_wvalue_channel_number;

static int hf_wvalue_fu_cs_v1;

static int hf_wvalue_clksrc_cs;

static int hf_wvalue_clksel_cs;

static int hf_windex;

static int hf_windex_interface;

static int hf_windex_entity_id;

static int hf_windex_endpoint;

static int hf_wlength;

static int hf_parameter_bselector;

static int hf_parameter_bmute;

static int hf_parameter_wvolume;

static int hf_parameter_wnumsubranges;

static int hf_parameter_bcur;

static int hf_parameter_bmin;

static int hf_parameter_bmax;

static int hf_parameter_bres;

static int hf_parameter_wcur;

static int hf_parameter_wmin;

static int hf_parameter_wmax;

static int hf_parameter_wres;

static int hf_parameter_dcur;

static int hf_parameter_dmin;

static int hf_parameter_dmax;

static int hf_parameter_dres;

static reassembly_table midi_data_reassembly_table;

static int ett_usb_audio;

static int ett_usb_audio_desc;

static int ett_ac_if_hdr_controls;

static int ett_ac_if_fu_controls;

static int ett_ac_if_fu_controls0;

static int ett_ac_if_fu_controls1;

static int ett_ac_if_fu_controls_v2;

static int ett_ac_if_fu_control_v2;

static int ett_ac_if_su_sourceids;

static int ett_ac_if_su_controls;

static int ett_ac_if_input_wchannelconfig;

static int ett_ac_if_input_bmchannelconfig;

static int ett_ac_if_input_controls;

static int ett_ac_if_output_controls;

static int ett_ac_if_mu_channelconfig;

static int ett_ac_if_clksrc_attr;

static int ett_ac_if_clksrc_controls;

static int ett_ac_if_clksel_controls;

static int ett_ac_if_extunit_bmchannelconfig;

static int ett_ac_if_extunit_bmcontrols;

static int ett_as_if_gen_controls;

static int ett_as_if_gen_formats;

static int ett_as_if_gen_bmchannelconfig;

static int ett_as_ep_gen_attributes;

static int ett_as_ep_gen_controls;

static int ett_ms_if_midi_element_caps1;

static int ett_ms_if_midi_element_caps2;

static int ett_wvalue;

static int ett_windex;

static int ett_parameter_block;

static dissector_handle_t midi_sysex_handle;

static dissector_handle_t usb_audio_bulk_handle;

static dissector_handle_t usb_audio_descr_handle;

static dissector_handle_t usb_audio_control_handle;

#define AUDIO_IF_SUBCLASS_UNDEFINED        0x00

#define AUDIO_IF_SUBCLASS_AUDIOCONTROL     0x01

#define AUDIO_IF_SUBCLASS_AUDIOSTREAMING   0x02

#define AUDIO_IF_SUBCLASS_MIDISTREAMING    0x03

static const value_string usb_audio_subclass_vals[] = {

    {AUDIO_IF_SUBCLASS_UNDEFINED,      "Undefined"},

    {AUDIO_IF_SUBCLASS_AUDIOCONTROL,   "Audio Control"},

    {AUDIO_IF_SUBCLASS_AUDIOSTREAMING, "Audio Streaming"},

    {AUDIO_IF_SUBCLASS_MIDISTREAMING,  "MIDI Streaming"},

    {0,NULL}

};

value_string_ext ext_usb_audio_subclass_vals =

    VALUE_STRING_EXT_INIT(usb_audio_subclass_vals);

#define AUDIO_PROTOCOL_V1                  0x00

#define AUDIO_PROTOCOL_V2                  0x20

#define V1_REQUEST_CODE_UNDEFINED          0x00

#define V1_REQUEST_SET_CUR                 0x01

#define V1_REQUEST_SET_MIN                 0x02

#define V1_REQUEST_SET_MAX                 0x03

#define V1_REQUEST_SET_RES                 0x04

#define V1_REQUEST_SET_MEM                 0x05

#define V1_REQUEST_GET_CUR                 0x81

#define V1_REQUEST_GET_MIN                 0x82

#define V1_REQUEST_GET_MAX                 0x83

#define V1_REQUEST_GET_RES                 0x84

#define V1_REQUEST_GET_MEM                 0x85

#define V1_REQUEST_GET_STAT                0xFF

static const value_string v1_brequest_vals[] = {

    {V1_REQUEST_CODE_UNDEFINED, "REQUEST_CODE_UNDEFINED"},

    {V1_REQUEST_SET_CUR,        "SET_CUR"},

    {V1_REQUEST_SET_MIN,        "SET_MIN"},

    {V1_REQUEST_SET_MAX,        "SET_MAX"},

    {V1_REQUEST_SET_RES,        "SET_RES"},

    {V1_REQUEST_SET_MEM,        "SET_MEM"},

    {V1_REQUEST_GET_CUR,        "GET_CUR"},

    {V1_REQUEST_GET_MIN,        "GET_MIN"},

    {V1_REQUEST_GET_MAX,        "GET_MAX"},

    {V1_REQUEST_GET_RES,        "GET_RES"},

    {V1_REQUEST_GET_MEM,        "GET_MEM"},

    {V1_REQUEST_GET_STAT,       "GET_STAT"},

    {0,NULL}

};

static value_string_ext v1_brequest_vals_ext =

    VALUE_STRING_EXT_INIT(v1_brequest_vals);

/* A.17.7 Feature Unit Control Selectors */

#define FU_CONTROL_UNDEFINED                0x00

#define MUTE_CONTROL                        0x01

#define VOLUME_CONTROL                      0x02

#define BASS_CONTROL                        0x03

#define MID_CONTROL                         0x04

#define TREBLE_CONTROL                      0x05

#define GRAPHIC_EQUALIZER_CONTROL           0x06

#define AUTOMATIC_GAIN_CONTROL              0x07

#define DELAY_CONTROL                       0x08

#define BASS_BOOST_CONTROL                  0x09

#define LOUDNESS_CONTROL                    0x0A

static const value_string v1_fu_cs_vals[] = {

    {FU_CONTROL_UNDEFINED,      "FU_CONTROL_UNDEFINED"},

    {MUTE_CONTROL,              "MUTE_CONTROL"},

    {VOLUME_CONTROL,            "VOLUME_CONTROL"},

    {BASS_CONTROL,              "BASS_CONTROL"},

    {MID_CONTROL,               "MID_CONTROL"},

    {TREBLE_CONTROL,            "TREBLE_CONTROL"},

    {GRAPHIC_EQUALIZER_CONTROL, "GRAPHIC_EQUALIZER_CONTROL"},

    {AUTOMATIC_GAIN_CONTROL,    "AUTOMATIC_GAIN_CONTROL"},

    {DELAY_CONTROL,             "DELAY_CONTROL"},

    {BASS_BOOST_CONTROL,        "BASS_BOOST_CONTROL"},

    {LOUDNESS_CONTROL,          "LOUDNESS_CONTROL"},

    {0,NULL}

};

static value_string_ext v1_fu_cs_vals_ext =

    VALUE_STRING_EXT_INIT(v1_fu_cs_vals);

#define V2_REQUEST_CODE_UNDEFINED          0x00

#define V2_REQUEST_CUR                     0x01

#define V2_REQUEST_RANGE                   0x02

#define V2_REQUEST_MEM                     0x03

static const value_string v2_brequest_vals[] = {

    {V2_REQUEST_CODE_UNDEFINED, "REQUEST_CODE_UNDEFINED"},

    {V2_REQUEST_CUR,            "CUR"},

    {V2_REQUEST_RANGE,          "RANGE"},

    {V2_REQUEST_MEM,            "MEM"},

    {0,NULL}

};

static value_string_ext v2_brequest_vals_ext =

    VALUE_STRING_EXT_INIT(v2_brequest_vals);

/* A.17.1 Clock Source Control Selectors */

#define V2_CS_CONTROL_UNDEFINED            0x00

#define V2_CS_SAM_FREQ_CONTROL             0x01

#define V2_CS_CLOCK_VALID_CONTROL          0x02

static const value_string v2_clksrc_cs_vals[] = {

    {V2_CS_CONTROL_UNDEFINED,   "CS_CONTROL_UNDEFINED"},

    {V2_CS_SAM_FREQ_CONTROL,    "CS_SAM_FREQ_CONTROL"},

    {V2_CS_CLOCK_VALID_CONTROL, "CS_CLOCK_VALID_CONTROL"},

    {0,NULL}

};

/* A.17.2 Clock Selector Control Selectors */

#define V2_CX_CONTROL_UNDEFINED          0x00

#define V2_CX_CLOCK_SELECTOR_CONTROL     0x01

static const value_string v2_clksel_cs_vals[] = {

    {V2_CX_CONTROL_UNDEFINED,      "CX_CONTROL_UNDEFINED"},

    {V2_CX_CLOCK_SELECTOR_CONTROL, "CX_CLOCK_SELECTOR_CONTROL"},

    {0,NULL}

};

static const value_string code_index_vals[] = {

    { 0x0, "Miscellaneous (Reserved)" },

    { 0x1, "Cable events (Reserved)" },

    { 0x2, "Two-byte System Common message" },

    { 0x3, "Three-byte System Common message" },

    { 0x4, "SysEx starts or continues" },

    { 0x5, "SysEx ends with following single byte/Single-byte System Common Message" },

    { 0x6, "SysEx ends with following two bytes" },

    { 0x7, "SysEx ends with following three bytes" },

    { 0x8, "Note-off" },

    { 0x9, "Note-on" },

    { 0xA, "Poly-KeyPress" },

    { 0xB, "Control Change" },

    { 0xC, "Program Change" },

    { 0xD, "Channel Pressure" },

    { 0xE, "PitchBend Change" },

    { 0xF, "Single Byte" },

    { 0, NULL }

};

/* USB audio specification, section A.8 */

#define CS_INTERFACE       0x24

#define CS_ENDPOINT        0x25

static const value_string aud_descriptor_type_vals[] = {

        {CS_INTERFACE, "audio class interface"},

        {CS_ENDPOINT,  "audio class endpoint"},

        {0,NULL}

};

static value_string_ext aud_descriptor_type_vals_ext =

    VALUE_STRING_EXT_INIT(aud_descriptor_type_vals);

#define AC_SUBTYPE_HEADER                0x01

#define AC_SUBTYPE_INPUT_TERMINAL        0x02

#define AC_SUBTYPE_OUTPUT_TERMINAL       0x03

#define AC_SUBTYPE_MIXER_UNIT            0x04

#define AC_SUBTYPE_SELECTOR_UNIT         0x05

#define AC_SUBTYPE_FEATURE_UNIT          0x06

#define AC_SUBTYPE_EFFECT_UNIT           0x07

#define AC_SUBTYPE_PROCESSING_UNIT       0x08

#define AC_SUBTYPE_EXTENSION_UNIT        0x09

#define AC_SUBTYPE_CLOCK_SOURCE          0x0A

#define AC_SUBTYPE_CLOCK_SELECTOR        0x0B

#define AC_SUBTYPE_CLOCK_MULTIPLIER      0x0C

#define AC_SUBTYPE_SAMPLE_RATE_CONVERTER 0x0D

static const value_string ac_subtype_vals[] = {

    {AC_SUBTYPE_HEADER,                "Header Descriptor"},

    {AC_SUBTYPE_INPUT_TERMINAL,        "Input terminal descriptor"},

    {AC_SUBTYPE_OUTPUT_TERMINAL,       "Output terminal descriptor"},

    {AC_SUBTYPE_MIXER_UNIT,            "Mixer unit descriptor"},

    {AC_SUBTYPE_SELECTOR_UNIT,         "Selector unit descriptor"},

    {AC_SUBTYPE_FEATURE_UNIT,          "Feature unit descriptor"},

    {AC_SUBTYPE_EFFECT_UNIT,           "Effect unit descriptor"},

    {AC_SUBTYPE_PROCESSING_UNIT,       "Processing unit descriptor"},

    {AC_SUBTYPE_EXTENSION_UNIT,        "Extension unit descriptor"},

    {AC_SUBTYPE_CLOCK_SOURCE,          "Clock source descriptor"},

    {AC_SUBTYPE_CLOCK_SELECTOR,        "Clock selector descriptor"},

    {AC_SUBTYPE_CLOCK_MULTIPLIER,      "Clock multiplier descriptor"},

    {AC_SUBTYPE_SAMPLE_RATE_CONVERTER, "Sample rate converter descriptor"},

    {0,NULL}

};

static value_string_ext ac_subtype_vals_ext =

    VALUE_STRING_EXT_INIT(ac_subtype_vals);

#define AS_SUBTYPE_GENERAL         0x01

#define AS_SUBTYPE_FORMAT_TYPE     0x02

#define AS_SUBTYPE_ENCODER         0x03

static const value_string as_subtype_vals[] = {

    {AS_SUBTYPE_GENERAL,     "General AS Descriptor"},

    {AS_SUBTYPE_FORMAT_TYPE, "Format type descriptor"},

    {AS_SUBTYPE_ENCODER,     "Encoder descriptor"},

    {0,NULL}

};

static value_string_ext as_subtype_vals_ext =

    VALUE_STRING_EXT_INIT(as_subtype_vals);

#define AS_EP_SUBTYPE_GENERAL       0x01

static const value_string as_ep_subtype_vals[] = {

    {AS_EP_SUBTYPE_GENERAL,       "General Descriptor"},

    {0,NULL}

};

#define MS_IF_SUBTYPE_HEADER        0x01

#define MS_IF_SUBTYPE_MIDI_IN_JACK  0x02

#define MS_IF_SUBTYPE_MIDI_OUT_JACK 0x03

#define MS_IF_SUBTYPE_ELEMENT       0x04

static const value_string ms_if_subtype_vals[] = {

    {MS_IF_SUBTYPE_HEADER,        "Header Descriptor"},

    {MS_IF_SUBTYPE_MIDI_IN_JACK,  "MIDI IN Jack descriptor"},

    {MS_IF_SUBTYPE_MIDI_OUT_JACK, "MIDI OUT Jack descriptor"},

    {MS_IF_SUBTYPE_ELEMENT,       "MIDI Element descriptor"},

    {0,NULL}

};

static value_string_ext ms_if_subtype_vals_ext =

    VALUE_STRING_EXT_INIT(ms_if_subtype_vals);

#define MS_MIDI_JACK_TYPE_EMBEDDED  0x01

#define MS_MIDI_JACK_TYPE_EXTERNAL  0x02

static const value_string ms_midi_jack_type_vals[] = {

    {MS_MIDI_JACK_TYPE_EMBEDDED, "Embedded"},

    {MS_MIDI_JACK_TYPE_EXTERNAL, "External"},

    {0,NULL}

};

#define MS_EP_SUBTYPE_GENERAL       0x01

static const value_string ms_ep_subtype_vals[] = {

    {MS_EP_SUBTYPE_GENERAL,       "General Descriptor"},

    {0,NULL}

};

/* Table A-7: Audio Function Category Codes */

static const value_string audio_function_categories_vals[] = {

    {0x00, "Undefined"},

    {0x01, "Desktop speaker"},

    {0x02, "Home theater"},

    {0x03, "Microphone"},

    {0x04, "Headset"},

    {0x05, "Telephone"},

    {0x06, "Converter"},

    {0x07, "Voice/Sound recorder"},

    {0x08, "I/O box"},

    {0x09, "Musical instrument"},

    {0x0A, "Pro-audio"},

    {0x0B, "Audio/Video"},

    {0x0C, "Control panel"},

    {0xFF, "Other"},

    {0,NULL}

};

static value_string_ext audio_function_categories_vals_ext =

    VALUE_STRING_EXT_INIT(audio_function_categories_vals);

/* Described in 4.7.2 Class-Specific AC Interface Descriptor */

static const value_string controls_capabilities_vals[] = {

    {0x00, "Not present"},

    {0x01, "Present, read-only"},

    {0x02, "Value not allowed"},

    {0x03, "Host programmable"},

    {0,NULL}

};

static value_string_ext controls_capabilities_vals_ext =

    VALUE_STRING_EXT_INIT(controls_capabilities_vals);

/* Described in 4.9.2 Class-Specific AS Interface Descriptor */

static const value_string controls_capabilities_read_only_vals[] = {

    {0x00, "Not present"},

    {0x01, "Present, read-only"},

    {0x02, "Value not allowed"},

    {0x03, "Value not allowed"},

    {0,NULL}

};

static value_string_ext controls_capabilities_read_only_vals_ext =

    VALUE_STRING_EXT_INIT(controls_capabilities_read_only_vals);

/* Described in 4.7.2.1 Clock Source Descriptor */

static const value_string clock_types_vals[] = {

    {0x00, "External clock"},

    {0x01, "Internal fixed clock"},

    {0x02, "Internal variable clock"},

    {0x03, "Internal programmable clock"},

    {0,NULL}

};

static const value_string clock_sync_vals[] = {

    {0x00, "Free running"},

    {0x01, "Synchronized to the Start of Frame"},

    {0,NULL}

};

static const value_string lock_delay_unit_vals[] = {

    {0, "Undefined"},

    {1, "Milliseconds"},

    {2, "Decoded PCM samples"},

    {0,NULL}

};

/* From https://www.usb.org/sites/default/files/termt10.pdf */

static const value_string terminal_types_vals[] = {

    /* USB Terminal Types */

    {0x0100, "USB Undefined"},

    {0x0101, "USB Streaming"},

    {0x01FF, "USB vendor specific"},

    /* Input Terminal Types */

    {0x0200, "Input Undefined"},

    {0x0201, "Microphone"},

    {0x0202, "Desktop Microphone"},

    {0x0203, "Personal microphone"},

    {0x0204, "Omni-directional microphone"},

    {0x0205, "Microphone array"},

    {0x0206, "Processing microphone array"},

    {0x0300, "Output Undefined"},

    {0x0301, "Speaker"},

    {0x0302, "Headphones"},

    {0x0303, "Head Mounted Display Audio"},

    {0x0304, "Desktop speaker"},

    {0x0305, "Room speaker"},

    {0x0306, "Communication speaker"},

    {0x0307, "Low frequency effects speaker"},

    /* Bi-directional Terminal Types */

    {0x0400, "Bi-directional Undefined"},

    {0x0401, "Handset"},

    {0x0402, "Headset"},

    {0x0403, "Speakerphone, no echoreduction"},

    {0x0404, "Echo-suppressing speakerphone"},

    {0x0405, "Echo-canceling speakerphone"},

    /* Telephony Terminal Types */

    {0x0500, "Telephony Undefined"},

    {0x0501, "Phone line"},

    {0x0502, "Telephone"},

    {0x0503, "Down Line Pone"},

    /* External Terminal Types */

    {0x0600, "External Undefined"},

    {0x0601, "Analog connector"},

    {0x0602, "Digital audio interface"},

    {0x0603, "Line connector"},

    {0x0604, "Legacy audio connector"},

    {0x0605, "S/PDIF interface"},

    {0x0606, "1394 DA stream"},

    {0x0607, "1394 DV stream soundtrack"},

    /* Embedded Function Terminal Types */

    {0x0700, "Embedded Undefined"},

    {0x0701, "Level Calibration Noise Source"},

    {0x0702, "Equalization Noise"},

    {0x0703, "CD player"},

    {0x0704, "DAT"},

    {0x0705, "DCC"},

    {0x0706, "MiniDisk"},

    {0x0707, "Analog Tape"},

    {0x0708, "Phonograph"},

    {0x0709, "VCR Audio"},

    {0x070A, "Video Disc Audio"},

    {0x070B, "DVD Audio"},

    {0x070C, "TV Tuner Audio"},

    {0x070D, "Satellite Receiver Audio"},

    {0x070E, "Cable Tuner Audio"},

    {0x070F, "DSS Audio"},

    {0x0710, "Radio Receiver"},

    {0x0711, "Radio Transmitter"},

    {0x0712, "Multi-track Recorder"},

    {0x0713, "Synthesizer"},

    {0,NULL}

};

static value_string_ext terminal_types_vals_ext =

    VALUE_STRING_EXT_INIT(terminal_types_vals);

/* From https://usb.org/sites/default/files/frmts10.pdf */

static const value_string audio_data_format_tag_vals[] = {

    /* Audio Data Format Type I Codes */

    {0x0000, "Type I Undefined"},

    {0x0001, "PCM"},

    {0x0002, "PCM8"},

    {0x0003, "IEEE Float"},

    {0x0004, "ALAW"},

    {0x0005, "MULAW"},

    /* Audio Data Format Type II Codes */

    {0x1000, "Type II Undefined"},

    {0x1001, "MPEG"},

    {0x1002, "AC-3"},

    /* Audio Data Format Type III Codes */

    {0x2000, "Type III Undefined"},

    {0x2001, "IEC1937 AC-3"},

    {0x2002, "IEC1937 MPEG-1 Layer1"},

    {0x2003, "IEC1937 MPEG-1 Layer2/3 or IEC1937 MPEG-2 NOEXT"},

    {0x2004, "IEC1937 MPEG-2 EXT"},

    {0x2005, "IEC1937 MPEG-2 Layer1 LS"},

    {0x2006, "IEC1937 MPEG-2 Layer2/3 LS"},

    {0,NULL}

};

static value_string_ext audio_data_format_tag_vals_ext =

    VALUE_STRING_EXT_INIT(audio_data_format_tag_vals);

/* Enumerator with arbitrarily chosen values to map IDs to entity types */

typedef enum {

    USB_AUDIO_ENTITY_UNKNOWN,

    USB_AUDIO_ENTITY_INTERFACE,

    USB_AUDIO_ENTITY_CLOCK_SOURCE,

    USB_AUDIO_ENTITY_CLOCK_SELECTOR,

    USB_AUDIO_ENTITY_CLOCK_MULTIPLIER,

    USB_AUDIO_ENTITY_TERMINAL,

    USB_AUDIO_ENTITY_MIXER,

    USB_AUDIO_ENTITY_SELECTOR,

    USB_AUDIO_ENTITY_FEATURE_UNIT,

    USB_AUDIO_ENTITY_PARAMETRIC_EQUALIZER,

    USB_AUDIO_ENTITY_REVERBERATION,

    USB_AUDIO_ENTITY_MODULATION_DELAY,

    USB_AUDIO_ENTITY_DYNAMIC_RANGE_COMPRESSOR,

    USB_AUDIO_ENTITY_UP_DOWN_MIX,

    USB_AUDIO_ENTITY_DOLBY_PROLOGIC,

    USB_AUDIO_ENTITY_STEREO_EXTENDER,

    USB_AUDIO_ENTITY_EXTENSION_UNIT,

    USB_AUDIO_ENTITY_AUDIOSTREAMING_INTERFACE,

    USB_AUDIO_ENTITY_ENCODER,

    USB_AUDIO_ENTITY_MPEG_DECODER,

    USB_AUDIO_ENTITY_AC3_DECODER,

    USB_AUDIO_ENTITY_WMA_DECODER,

    USB_AUDIO_ENTITY_DTS_DECODER,

} usb_audio_entity_t;

typedef enum {

    PARAMETER_LAYOUT_UNKNOWN,

    PARAMETER_LAYOUT_1,

    PARAMETER_LAYOUT_2,

    PARAMETER_LAYOUT_3,

} parameter_layout_t;

typedef struct _audio_conv_info_t {

    /* Mapping from entity ID to its type. */

    usb_audio_entity_t entity_type[256];

} audio_conv_info_t;

static int hf_sysex_msg_fragments;

static int hf_sysex_msg_fragment;

static int hf_sysex_msg_fragment_overlap;

static int hf_sysex_msg_fragment_overlap_conflicts;

static int hf_sysex_msg_fragment_multiple_tails;

static int hf_sysex_msg_fragment_too_long_fragment;

static int hf_sysex_msg_fragment_error;

static int hf_sysex_msg_fragment_count;

static int hf_sysex_msg_reassembled_in;

static int hf_sysex_msg_reassembled_length;

static int hf_sysex_msg_reassembled_data;

static int ett_sysex_msg_fragment;

static int ett_sysex_msg_fragments;

static expert_field ei_usb_audio_undecoded;

static expert_field ei_usb_audio_invalid_feature_unit_length;

static expert_field ei_usb_audio_invalid_type_3_ft_nrchannels;

static expert_field ei_usb_audio_invalid_type_3_ft_subframesize;

static expert_field ei_usb_audio_invalid_type_3_ft_bitresolution;

static const fragment_items sysex_msg_frag_items = {

    /* Fragment subtrees */

    &ett_sysex_msg_fragment,

    &ett_sysex_msg_fragments,

    /* Fragment fields */

    &hf_sysex_msg_fragments,

    &hf_sysex_msg_fragment,

    &hf_sysex_msg_fragment_overlap,

    &hf_sysex_msg_fragment_overlap_conflicts,

    &hf_sysex_msg_fragment_multiple_tails,

    &hf_sysex_msg_fragment_too_long_fragment,

    &hf_sysex_msg_fragment_error,

    &hf_sysex_msg_fragment_count,

    /* Reassembled in field */

    &hf_sysex_msg_reassembled_in,

    /* Reassembled length field */

    &hf_sysex_msg_reassembled_length,

    &hf_sysex_msg_reassembled_data,

    /* Tag */

    "Message fragments"

};

static int

get_midi_event_size(uint8_t code)

{

    switch (code)

    {

        case 0x0: /* Miscellaneous function codes. Reserved for future extensions. */

        case 0x1: /* Cable events. Reserved for future expansion. */

            /* The Event size can be 1, 2 or 3 bytes. Assume 3. */

            return 3;

        case 0x5: /* Single-byte System Common Message or SysEx ends with following single byte. */

        case 0xF: /* Single Byte */

            return 1;

        case 0x2: /* 2 Two-byte System Common messages like MTC, SongSelect, etc. */

        case 0x6: /* SysEx ends with following two bytes. */

        case 0xC: /* Program Change */

        case 0xD: /* Channel Pressure */

            return 2;

        case 0x3: /* Three-byte System Common messages like SPP, etc. */

        case 0x4: /* SysEx starts or continues */

        case 0x7: /* SysEx ends with following three bytes. */

        case 0x8: /* Note-off */

        case 0x9: /* Note-on */

        case 0xA: /* Poly-KeyPress */

        case 0xB: /* Control Change */

        case 0xE: /* PitchBend Change */

            return 3;

        default:

            /* Invalid Code Index Number */

            return 0;

    }

}

static inline bool

is_sysex_code(uint8_t code)

{

    return (code == 0x04 || code == 0x05 || code == 0x06 || code == 0x07);

}

static bool

is_last_sysex_packet_in_tvb(tvbuff_t *tvb, int offset)

{

    bool last   = true;

    int      length = tvb_reported_length(tvb);

    offset += 4;

    while (offset < length)

    {

        uint8_t code = tvb_get_uint8(tvb, offset);

        code &= 0x0F;

        if (is_sysex_code(code))

        {

            last = false;

            break;

        }

        offset += 4;

    }

    return last;

}

static void

dissect_usb_midi_event(tvbuff_t *tvb, packet_info *pinfo,

                       proto_tree *parent_tree,

                       int offset)

{

    uint8_t     code;

    uint8_t     cable;

    bool        save_fragmented;

    proto_tree *tree = NULL;

    code = tvb_get_uint8(tvb, offset);

    cable = (code & 0xF0) >> 4;

    code &= 0x0F;

    if (parent_tree)

    {

        proto_item *ti;

        int event_size, padding_size;

        ti = proto_tree_add_protocol_format(parent_tree, proto_usb_audio, tvb, offset, 4, "USB Midi Event Packet: %s",

                 try_val_to_str(code, code_index_vals));

        tree = proto_item_add_subtree(ti, ett_usb_audio);

        proto_tree_add_item(tree, hf_midi_cable_number, tvb, offset, 1, ENC_BIG_ENDIAN);

        proto_tree_add_item(tree, hf_midi_code_index, tvb, offset, 1, ENC_BIG_ENDIAN);

        event_size = get_midi_event_size(code);

        padding_size = 3 - event_size;

        if (event_size > 0)

        {

            /* TODO: Create MIDI dissector and pass the event data to it */

            const uint8_t *event_data = tvb_get_ptr(tvb, offset+1, event_size);

            proto_tree_add_bytes(tree, hf_midi_event, tvb, offset+1, event_size, event_data);

        }

        if (padding_size > 0)

        {

            const uint8_t *padding = tvb_get_ptr(tvb, offset+1+event_size, padding_size);

            proto_tree_add_bytes(tree, hf_midi_padding, tvb, offset+1+event_size, padding_size, padding);

        }

    }

    save_fragmented = pinfo->fragmented;

    /* Reassemble SysEx commands */

    if (is_sysex_code(code))

    {

        tvbuff_t* new_tvb = NULL;

        fragment_head *frag_sysex_msg = NULL;

        pinfo->fragmented = true;

        if (code == 0x04)

        {

            frag_sysex_msg = fragment_add_seq_next(&midi_data_reassembly_table,

                tvb, offset+1,

                pinfo,

                cable, /* ID for fragments belonging together */

                NULL,

                3,

                true);

        }

        else

        {

            frag_sysex_msg = fragment_add_seq_next(&midi_data_reassembly_table,

                tvb, offset+1,

                pinfo,

                cable, /* ID for fragments belonging together */

                NULL,

                (int)(code - 4),

                false);

        }

        if (is_last_sysex_packet_in_tvb(tvb, offset))

        {

            new_tvb = process_reassembled_data(tvb, offset+1, pinfo,

                "Reassembled Message", frag_sysex_msg, &sysex_msg_frag_items,

                NULL, tree);

            if (code != 0x04) { /* Reassembled */

                col_append_str(pinfo->cinfo, COL_INFO,

                        " (SysEx Reassembled)");

            } else { /* Not last packet of reassembled Short Message */

                col_append_str(pinfo->cinfo, COL_INFO,

                        " (SysEx fragment)");

            }

            if (new_tvb)

            {

                call_dissector(midi_sysex_handle, new_tvb, pinfo, parent_tree);

            }

        }

    }

    pinfo->fragmented = save_fragmented;

}

static audio_conv_info_t*

allocate_audio_conv_info(void)

{

    audio_conv_info_t *info = wmem_new(wmem_file_scope(), audio_conv_info_t);

    info->entity_type[0] = USB_AUDIO_ENTITY_INTERFACE;

    for (int i = 1; i < 256; i++) {

        info->entity_type[i] = USB_AUDIO_ENTITY_UNKNOWN;

    }

    return info;

}

static void

set_entity_type(urb_info_t *urb, uint8_t id, usb_audio_entity_t type)

{

    audio_conv_info_t *audio_conv_info = (audio_conv_info_t *)urb->conv->class_data;

    if (!audio_conv_info) {