usbaudio.h File Reference

#include <ntddk.h>
#include <portcls.h>
#include <ksmedia.h>
#include <hubbusif.h>
#include <usbbusif.h>
#include <usbioctl.h>
#include <usb.h>
#include <usbdlib.h>
#include <debug.h>
#include <pshpack1.h>
#include <poppack.h>

Include dependency graph for usbaudio.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	USB_AUDIO_CONTROL_INTERFACE_HEADER_DESCRIPTOR
struct	USB_AUDIO_CONTROL_OUTPUT_TERMINAL_DESCRIPTOR
struct	USB_AUDIO_CONTROL_INPUT_TERMINAL_DESCRIPTOR
struct	USB_AUDIO_CONTROL_FEATURE_UNIT_DESCRIPTOR
struct	USB_AUDIO_CONTROL_MIXER_UNIT_DESCRIPTOR
struct	USB_AUDIO_CONTROL_SELECTOR_UNIT_DESCRIPTOR
struct	USB_AUDIO_STREAMING_INTERFACE_DESCRIPTOR
struct	USB_AUDIO_STREAMING_FORMAT_TYPE_DESCRIPTOR
struct	NODE_CONTEXT
struct	__DEVICE_EXTENSION__
struct	FILTER_CONTEXT
struct	PIN_CONTEXT

Macros
#define	USBAUDIO_TAG   'AbsU'
#define	USB_AUDIO_CONTROL_TERMINAL_DESCRIPTOR_TYPE   (0x24)
#define	USB_AUDIO_STREAMING_TERMINAL_TYPE   (0x0101)
#define	USB_AUDIO_MICROPHONE_TERMINAL_TYPE   (0x0201)
#define	USB_AUDIO_DESKTOP_MICROPHONE_TERMINAL_TYPE   (0x0202)
#define	USB_AUDIO_PERSONAL_MICROPHONE_TERMINAL_TYPE   (0x0203)
#define	USB_AUDIO_OMMNI_MICROPHONE_TERMINAL_TYPE   (0x0204)
#define	USB_AUDIO_ARRAY_MICROPHONE_TERMINAL_TYPE   (0x0205)
#define	USB_AUDIO_ARRAY_PROCESSING_MICROPHONE_TERMINAL_TYPE   (0x0206)
#define	USB_AUDIO_SPEAKER_TERMINAL_TYPE   (0x0301)
#define	USB_HEADPHONES_SPEAKER_TERMINAL_TYPE   (0x0302)
#define	USB_AUDIO_HMDA_TERMINAL_TYPE   (0x0303)
#define	USB_AUDIO_DESKTOP_SPEAKER_TERMINAL_TYPE   (0x0304)
#define	USB_AUDIO_ROOM_SPEAKER_TERMINAL_TYPE   (0x0305)
#define	USB_AUDIO_COMMUNICATION_SPEAKER_TERMINAL_TYPE   (0x0306)
#define	USB_AUDIO_SUBWOOFER_TERMINAL_TYPE   (0x0307)
#define	USB_AUDIO_UNDEFINED_TERMINAL_TYPE   (0xFFFF)
#define	USB_AUDIO_INPUT_TERMINAL   (0x02)
#define	USB_AUDIO_OUTPUT_TERMINAL   (0x03)
#define	DEFINE_KSPROPERTY_ITEM_AUDIO_VOLUME(Handler)
#define	DEFINE_KSPROPERTY_TABLE_AUDIO_VOLUME(TopologySet, Handler)
#define	DEFINE_KSPROPERTY_ITEM_AUDIO_MUTE(Handler)
#define	DEFINE_KSPROPERTY_TABLE_AUDIO_MUTE(TopologySet, Handler)

Typedefs
typedef struct USB_AUDIO_CONTROL_INTERFACE_HEADER_DESCRIPTOR *	PUSB_AUDIO_CONTROL_INTERFACE_HEADER_DESCRIPTOR
typedef struct USB_AUDIO_CONTROL_OUTPUT_TERMINAL_DESCRIPTOR *	PUSB_AUDIO_CONTROL_OUTPUT_TERMINAL_DESCRIPTOR
typedef struct USB_AUDIO_CONTROL_INPUT_TERMINAL_DESCRIPTOR *	PUSB_AUDIO_CONTROL_INPUT_TERMINAL_DESCRIPTOR
typedef struct USB_AUDIO_CONTROL_FEATURE_UNIT_DESCRIPTOR *	PUSB_AUDIO_CONTROL_FEATURE_UNIT_DESCRIPTOR
typedef struct USB_AUDIO_CONTROL_MIXER_UNIT_DESCRIPTOR *	PUSB_AUDIO_CONTROL_MIXER_UNIT_DESCRIPTOR
typedef struct USB_AUDIO_CONTROL_SELECTOR_UNIT_DESCRIPTOR *	PUSB_AUDIO_CONTROL_SELECTOR_UNIT_DESCRIPTOR
typedef struct USB_AUDIO_STREAMING_INTERFACE_DESCRIPTOR *	PUSB_AUDIO_STREAMING_INTERFACE_DESCRIPTOR
typedef struct USB_AUDIO_STREAMING_FORMAT_TYPE_DESCRIPTOR *	PUSB_AUDIO_STREAMING_FORMAT_TYPE_DESCRIPTOR
typedef struct NODE_CONTEXT *	PNODE_CONTEXT
typedef struct __DEVICE_EXTENSION__	DEVICE_EXTENSION
typedef struct __DEVICE_EXTENSION__ *	PDEVICE_EXTENSION
typedef struct FILTER_CONTEXT *	PFILTER_CONTEXT
typedef struct PIN_CONTEXT *	PPIN_CONTEXT

Functions
NTSTATUS NTAPI	USBAudioCreateFilterContext (PKSDEVICE Device)
PUSB_AUDIO_CONTROL_INPUT_TERMINAL_DESCRIPTOR	UsbAudioGetStreamingTerminalDescriptorByIndex (IN PUSB_CONFIGURATION_DESCRIPTOR ConfigurationDescriptor, IN ULONG Index)
PVOID NTAPI	AllocFunction (IN ULONG ItemSize)
VOID NTAPI	FreeFunction (IN PVOID Item)
VOID NTAPI	CountTerminalUnits (IN PUSB_CONFIGURATION_DESCRIPTOR ConfigurationDescriptor, OUT PULONG NonStreamingTerminalDescriptorCount, OUT PULONG TotalTerminalDescriptorCount)
NTSTATUS	SubmitUrbSync (IN PDEVICE_OBJECT Device, IN PURB Urb)
NTSTATUS NTAPI	USBAudioAddDevice (_In_ PKSDEVICE Device)
NTSTATUS NTAPI	USBAudioPnPStart (_In_ PKSDEVICE Device, _In_ PIRP Irp, _In_opt_ PCM_RESOURCE_LIST TranslatedResourceList, _In_opt_ PCM_RESOURCE_LIST UntranslatedResourceList)
NTSTATUS NTAPI	USBAudioPnPQueryStop (_In_ PKSDEVICE Device, _In_ PIRP Irp)
VOID NTAPI	USBAudioPnPCancelStop (_In_ PKSDEVICE Device, _In_ PIRP Irp)
VOID NTAPI	USBAudioPnPStop (_In_ PKSDEVICE Device, _In_ PIRP Irp)
NTSTATUS NTAPI	USBAudioPnPQueryRemove (_In_ PKSDEVICE Device, _In_ PIRP Irp)
VOID NTAPI	USBAudioPnPCancelRemove (_In_ PKSDEVICE Device, _In_ PIRP Irp)
VOID NTAPI	USBAudioPnPRemove (_In_ PKSDEVICE Device, _In_ PIRP Irp)
NTSTATUS NTAPI	USBAudioPnPQueryCapabilities (_In_ PKSDEVICE Device, _In_ PIRP Irp, _Inout_ PDEVICE_CAPABILITIES Capabilities)
VOID NTAPI	USBAudioPnPSurpriseRemoval (_In_ PKSDEVICE Device, _In_ PIRP Irp)
NTSTATUS NTAPI	USBAudioPnPQueryPower (_In_ PKSDEVICE Device, _In_ PIRP Irp, _In_ DEVICE_POWER_STATE DeviceTo, _In_ DEVICE_POWER_STATE DeviceFrom, _In_ SYSTEM_POWER_STATE SystemTo, _In_ SYSTEM_POWER_STATE SystemFrom, _In_ POWER_ACTION Action)
VOID NTAPI	USBAudioPnPSetPower (_In_ PKSDEVICE Device, _In_ PIRP Irp, _In_ DEVICE_POWER_STATE To, _In_ DEVICE_POWER_STATE From)
NTSTATUS NTAPI	UsbAudioPinDataIntersect (_In_ PVOID Context, _In_ PIRP Irp, _In_ PKSP_PIN Pin, _In_ PKSDATARANGE DataRange, _In_ PKSDATARANGE MatchingDataRange, _In_ ULONG DataBufferSize, _Out_ PVOID Data, _Out_ PULONG DataSize)
NTSTATUS NTAPI	UsbAudioCaptureComplete (IN PDEVICE_OBJECT DeviceObject, IN PIRP Irp, IN PVOID Context)
NTSTATUS NTAPI	UsbAudioRenderComplete (IN PDEVICE_OBJECT DeviceObject, IN PIRP Irp, IN PVOID Context)
NTSTATUS NTAPI	USBAudioPinCreate (_In_ PKSPIN Pin, _In_ PIRP Irp)
NTSTATUS NTAPI	USBAudioPinClose (_In_ PKSPIN Pin, _In_ PIRP Irp)
NTSTATUS NTAPI	USBAudioPinProcess (_In_ PKSPIN Pin)
VOID NTAPI	USBAudioPinReset (_In_ PKSPIN Pin)
NTSTATUS NTAPI	USBAudioPinSetDataFormat (_In_ PKSPIN Pin, _In_opt_ PKSDATAFORMAT OldFormat, _In_opt_ PKSMULTIPLE_ITEM OldAttributeList, _In_ const KSDATARANGE *DataRange, _In_opt_ const KSATTRIBUTE_LIST *AttributeRange)
NTSTATUS NTAPI	USBAudioPinSetDeviceState (_In_ PKSPIN Pin, _In_ KSSTATE ToState, _In_ KSSTATE FromState)

Macro Definition Documentation

DEFINE_KSPROPERTY_ITEM_AUDIO_MUTE

#define DEFINE_KSPROPERTY_ITEM_AUDIO_MUTE

(

Handler

)

Value:

    DEFINE_KSPROPERTY_ITEM(\
        KSPROPERTY_AUDIO_MUTE,\
        (Handler),\
        sizeof(KSNODEPROPERTY_AUDIO_CHANNEL),\
        sizeof(BOOL),\
        (Handler), NULL, 0, NULL, NULL, 0)

Definition at line 52 of file usbaudio.h.

DEFINE_KSPROPERTY_ITEM_AUDIO_VOLUME

#define DEFINE_KSPROPERTY_ITEM_AUDIO_VOLUME

(

Handler

)

Value:

    DEFINE_KSPROPERTY_ITEM(\
        KSPROPERTY_AUDIO_VOLUMELEVEL,\
        (Handler),\
        sizeof(KSNODEPROPERTY_AUDIO_CHANNEL),\
        sizeof(LONG),\
        (Handler), NULL, 0, NULL, NULL, 0)

Definition at line 38 of file usbaudio.h.

DEFINE_KSPROPERTY_TABLE_AUDIO_MUTE

#define DEFINE_KSPROPERTY_TABLE_AUDIO_MUTE	(		TopologySet,
			Handler
	)

Value:

DEFINE_KSPROPERTY_TABLE(TopologySet) {\
    DEFINE_KSPROPERTY_ITEM_AUDIO_MUTE(Handler)\
}

Definition at line 60 of file usbaudio.h.

DEFINE_KSPROPERTY_TABLE_AUDIO_VOLUME

#define DEFINE_KSPROPERTY_TABLE_AUDIO_VOLUME	(		TopologySet,
			Handler
	)

Value:

DEFINE_KSPROPERTY_TABLE(TopologySet) {\
    DEFINE_KSPROPERTY_ITEM_AUDIO_VOLUME(Handler)\
}

Definition at line 47 of file usbaudio.h.

USB_AUDIO_ARRAY_MICROPHONE_TERMINAL_TYPE

#define USB_AUDIO_ARRAY_MICROPHONE_TERMINAL_TYPE   (0x0205)

Definition at line 23 of file usbaudio.h.

USB_AUDIO_ARRAY_PROCESSING_MICROPHONE_TERMINAL_TYPE

#define USB_AUDIO_ARRAY_PROCESSING_MICROPHONE_TERMINAL_TYPE   (0x0206)

Definition at line 24 of file usbaudio.h.

USB_AUDIO_COMMUNICATION_SPEAKER_TERMINAL_TYPE

#define USB_AUDIO_COMMUNICATION_SPEAKER_TERMINAL_TYPE   (0x0306)

Definition at line 31 of file usbaudio.h.

USB_AUDIO_CONTROL_TERMINAL_DESCRIPTOR_TYPE

#define USB_AUDIO_CONTROL_TERMINAL_DESCRIPTOR_TYPE   (0x24)

Definition at line 14 of file usbaudio.h.

USB_AUDIO_DESKTOP_MICROPHONE_TERMINAL_TYPE

#define USB_AUDIO_DESKTOP_MICROPHONE_TERMINAL_TYPE   (0x0202)

Definition at line 20 of file usbaudio.h.

USB_AUDIO_DESKTOP_SPEAKER_TERMINAL_TYPE

#define USB_AUDIO_DESKTOP_SPEAKER_TERMINAL_TYPE   (0x0304)

Definition at line 29 of file usbaudio.h.

USB_AUDIO_HMDA_TERMINAL_TYPE

#define USB_AUDIO_HMDA_TERMINAL_TYPE   (0x0303)

Definition at line 28 of file usbaudio.h.

USB_AUDIO_INPUT_TERMINAL

#define USB_AUDIO_INPUT_TERMINAL   (0x02)

Definition at line 35 of file usbaudio.h.

USB_AUDIO_MICROPHONE_TERMINAL_TYPE

#define USB_AUDIO_MICROPHONE_TERMINAL_TYPE   (0x0201)

Definition at line 19 of file usbaudio.h.

USB_AUDIO_OMMNI_MICROPHONE_TERMINAL_TYPE

#define USB_AUDIO_OMMNI_MICROPHONE_TERMINAL_TYPE   (0x0204)

Definition at line 22 of file usbaudio.h.

USB_AUDIO_OUTPUT_TERMINAL

#define USB_AUDIO_OUTPUT_TERMINAL   (0x03)

Definition at line 36 of file usbaudio.h.

USB_AUDIO_PERSONAL_MICROPHONE_TERMINAL_TYPE

#define USB_AUDIO_PERSONAL_MICROPHONE_TERMINAL_TYPE   (0x0203)

Definition at line 21 of file usbaudio.h.

USB_AUDIO_ROOM_SPEAKER_TERMINAL_TYPE

#define USB_AUDIO_ROOM_SPEAKER_TERMINAL_TYPE   (0x0305)

Definition at line 30 of file usbaudio.h.

USB_AUDIO_SPEAKER_TERMINAL_TYPE

#define USB_AUDIO_SPEAKER_TERMINAL_TYPE   (0x0301)

Definition at line 26 of file usbaudio.h.

USB_AUDIO_STREAMING_TERMINAL_TYPE

#define USB_AUDIO_STREAMING_TERMINAL_TYPE   (0x0101)

Definition at line 17 of file usbaudio.h.

USB_AUDIO_SUBWOOFER_TERMINAL_TYPE

#define USB_AUDIO_SUBWOOFER_TERMINAL_TYPE   (0x0307)

Definition at line 32 of file usbaudio.h.

USB_AUDIO_UNDEFINED_TERMINAL_TYPE

#define USB_AUDIO_UNDEFINED_TERMINAL_TYPE   (0xFFFF)

Definition at line 33 of file usbaudio.h.

USB_HEADPHONES_SPEAKER_TERMINAL_TYPE

#define USB_HEADPHONES_SPEAKER_TERMINAL_TYPE   (0x0302)

Definition at line 27 of file usbaudio.h.

USBAUDIO_TAG

#define USBAUDIO_TAG   'AbsU'

Definition at line 13 of file usbaudio.h.

Typedef Documentation

DEVICE_EXTENSION

typedef struct __DEVICE_EXTENSION__ DEVICE_EXTENSION

PDEVICE_EXTENSION

typedef struct __DEVICE_EXTENSION__ * PDEVICE_EXTENSION

PFILTER_CONTEXT

typedef struct FILTER_CONTEXT * PFILTER_CONTEXT

PNODE_CONTEXT

typedef struct NODE_CONTEXT * PNODE_CONTEXT

PPIN_CONTEXT

typedef struct PIN_CONTEXT * PPIN_CONTEXT

PUSB_AUDIO_CONTROL_FEATURE_UNIT_DESCRIPTOR

typedef struct USB_AUDIO_CONTROL_FEATURE_UNIT_DESCRIPTOR * PUSB_AUDIO_CONTROL_FEATURE_UNIT_DESCRIPTOR

PUSB_AUDIO_CONTROL_INPUT_TERMINAL_DESCRIPTOR

typedef struct USB_AUDIO_CONTROL_INPUT_TERMINAL_DESCRIPTOR * PUSB_AUDIO_CONTROL_INPUT_TERMINAL_DESCRIPTOR

PUSB_AUDIO_CONTROL_INTERFACE_HEADER_DESCRIPTOR

typedef struct USB_AUDIO_CONTROL_INTERFACE_HEADER_DESCRIPTOR * PUSB_AUDIO_CONTROL_INTERFACE_HEADER_DESCRIPTOR

PUSB_AUDIO_CONTROL_MIXER_UNIT_DESCRIPTOR

typedef struct USB_AUDIO_CONTROL_MIXER_UNIT_DESCRIPTOR * PUSB_AUDIO_CONTROL_MIXER_UNIT_DESCRIPTOR

PUSB_AUDIO_CONTROL_OUTPUT_TERMINAL_DESCRIPTOR

typedef struct USB_AUDIO_CONTROL_OUTPUT_TERMINAL_DESCRIPTOR * PUSB_AUDIO_CONTROL_OUTPUT_TERMINAL_DESCRIPTOR

PUSB_AUDIO_CONTROL_SELECTOR_UNIT_DESCRIPTOR

typedef struct USB_AUDIO_CONTROL_SELECTOR_UNIT_DESCRIPTOR * PUSB_AUDIO_CONTROL_SELECTOR_UNIT_DESCRIPTOR

PUSB_AUDIO_STREAMING_FORMAT_TYPE_DESCRIPTOR

typedef struct USB_AUDIO_STREAMING_FORMAT_TYPE_DESCRIPTOR * PUSB_AUDIO_STREAMING_FORMAT_TYPE_DESCRIPTOR

PUSB_AUDIO_STREAMING_INTERFACE_DESCRIPTOR

typedef struct USB_AUDIO_STREAMING_INTERFACE_DESCRIPTOR * PUSB_AUDIO_STREAMING_INTERFACE_DESCRIPTOR

Function Documentation

AllocFunction()

PVOID NTAPI AllocFunction

(

IN ULONG

ItemSize

)

Definition at line 45 of file hid.c.

{
    return LocalAlloc(LHND, ItemSize);
}

Referenced by BuildUSBAudioFilterTopology(), FilterAudioVolumeHandler(), HidParser_AddCollection(), HidParser_AddReportToCollection(), HidParser_AllocateCollection(), HidParser_AllocateReport(), HidParser_BuildContext(), HidParser_GetCollectionDescription(), HidParser_ParseReportDescriptor(), HidParser_ReserveReportItems(), InitCapturePin(), InitStreamPin(), RenderInitializeUrbAndIrp(), UsbAudioAllocCaptureUrbIso(), USBAudioCreateFilterContext(), USBAudioFilterCreate(), UsbAudioGetDataRanges(), USBAudioGetDescriptor(), UsbAudioGetSetProperty(), USBAudioPinBuildDescriptors(), USBAudioPinCreate(), USBAudioPnPStart(), USBAudioSelectAudioStreamingInterface(), USBAudioSelectConfiguration(), UsbAudioSetFormat(), and USBAudioStartDevice().

CountTerminalUnits()

VOID NTAPI CountTerminalUnits	(	IN PUSB_CONFIGURATION_DESCRIPTOR	ConfigurationDescriptor,
		OUT PULONG	NonStreamingTerminalDescriptorCount,
		OUT PULONG	TotalTerminalDescriptorCount
	)

Definition at line 970 of file filter.c.

{
    PUSB_INTERFACE_DESCRIPTOR Descriptor;
    PUSB_AUDIO_CONTROL_INTERFACE_HEADER_DESCRIPTOR InterfaceHeaderDescriptor;
    PUSB_COMMON_DESCRIPTOR CommonDescriptor;
    PUSB_AUDIO_CONTROL_INPUT_TERMINAL_DESCRIPTOR InputTerminalDescriptor;
    ULONG NonStreamingTerminalCount = 0;
    ULONG TotalTerminalCount = 0;
 
    for(Descriptor = USBD_ParseConfigurationDescriptorEx(ConfigurationDescriptor, ConfigurationDescriptor, -1, -1, USB_DEVICE_CLASS_AUDIO, -1, -1);
        Descriptor != NULL;
        Descriptor = USBD_ParseConfigurationDescriptorEx(ConfigurationDescriptor, (PVOID)((ULONG_PTR)Descriptor + Descriptor->bLength), -1, -1, USB_DEVICE_CLASS_AUDIO, -1, -1))
    {
        if (Descriptor->bInterfaceSubClass == 0x01) /* AUDIO_CONTROL */
        {
            InterfaceHeaderDescriptor = (PUSB_AUDIO_CONTROL_INTERFACE_HEADER_DESCRIPTOR)USBD_ParseDescriptors(ConfigurationDescriptor, ConfigurationDescriptor->wTotalLength, Descriptor, USB_AUDIO_CONTROL_TERMINAL_DESCRIPTOR_TYPE);
            if (InterfaceHeaderDescriptor != NULL)
            {
                CommonDescriptor = USBD_ParseDescriptors(InterfaceHeaderDescriptor, InterfaceHeaderDescriptor->wTotalLength, (PVOID)((ULONG_PTR)InterfaceHeaderDescriptor + InterfaceHeaderDescriptor->bLength), USB_AUDIO_CONTROL_TERMINAL_DESCRIPTOR_TYPE);
                while (CommonDescriptor)
                {
                    InputTerminalDescriptor = (PUSB_AUDIO_CONTROL_INPUT_TERMINAL_DESCRIPTOR)CommonDescriptor;
                    if (InputTerminalDescriptor->bDescriptorSubtype == 0x02 /* INPUT TERMINAL*/ || InputTerminalDescriptor->bDescriptorSubtype == 0x03 /* OUTPUT_TERMINAL*/)
                    {
                        if (InputTerminalDescriptor->wTerminalType != USB_AUDIO_STREAMING_TERMINAL_TYPE)
                        {
                            NonStreamingTerminalCount++;
                        }
                        TotalTerminalCount++;
                    }
                    CommonDescriptor = (PUSB_COMMON_DESCRIPTOR)((ULONG_PTR)CommonDescriptor + CommonDescriptor->bLength);
                    if ((ULONG_PTR)CommonDescriptor >= ((ULONG_PTR)InterfaceHeaderDescriptor + InterfaceHeaderDescriptor->wTotalLength))
                        break;
                }
            }
        }
        else if (Descriptor->bInterfaceSubClass == 0x03) /* MIDI_STREAMING */
        {
            UNIMPLEMENTED;
        }
    }
    *NonStreamingTerminalDescriptorCount = NonStreamingTerminalCount;
    *TotalTerminalDescriptorCount = TotalTerminalCount;
}

Referenced by BuildUSBAudioFilterTopology(), and USBAudioPinBuildDescriptors().

FreeFunction()

VOID NTAPI FreeFunction

(

IN PVOID

Item

)

Definition at line 53 of file hid.c.

{
    LocalFree((HLOCAL)Item);
}

Referenced by FilterAudioVolumeHandler(), HidParser_AddCollection(), HidParser_AddReportToCollection(), HidParser_FreeCollectionDescription(), HidParser_GetCollectionDescription(), HidParser_GetReport(), HidParser_ParseReportDescriptor(), USBAudioCreateFilterContext(), USBAudioGetDescriptor(), UsbAudioGetSetProperty(), USBAudioInitComponentId(), UsbAudioRenderComplete(), USBAudioSelectAudioStreamingInterface(), USBAudioSelectConfiguration(), UsbAudioSetFormat(), and USBAudioStartDevice().

SubmitUrbSync()

NTSTATUS SubmitUrbSync	(	IN PDEVICE_OBJECT	Device,
		IN PURB	Urb
	)

Definition at line 37 of file usbaudio.c.

{
    PIRP Irp;
    KEVENT Event;
    IO_STATUS_BLOCK IoStatus;
    PIO_STACK_LOCATION IoStack;
    NTSTATUS Status;
 
    // init event
    KeInitializeEvent(&Event, NotificationEvent, FALSE);
 
    // build irp
    Irp = IoBuildDeviceIoControlRequest(IOCTL_INTERNAL_USB_SUBMIT_URB,
        DeviceObject,
        NULL,
        0,
        NULL,
        0,
        TRUE,
        &Event,
        &IoStatus);
 
    if (!Irp)
    {
        //
        // no memory
        //
        return STATUS_INSUFFICIENT_RESOURCES;
    }
 
    // get next stack location
    IoStack = IoGetNextIrpStackLocation(Irp);
 
    // store urb
    IoStack->Parameters.Others.Argument1 = Urb;
 
    // call driver
    Status = IoCallDriver(DeviceObject, Irp);
 
    // wait for the request to finish
    if (Status == STATUS_PENDING)
    {
        KeWaitForSingleObject(&Event, Executive, KernelMode, FALSE, NULL);
        Status = IoStatus.Status;
    }
 
    // done
    return Status;
}

Referenced by USBAudioGetDescriptor(), UsbAudioGetSetProperty(), USBAudioSelectAudioStreamingInterface(), USBAudioSelectConfiguration(), UsbAudioSetFormat(), and USBAudioStartDevice().

USBAudioAddDevice()

NTSTATUS NTAPI USBAudioAddDevice

(

_In_ PKSDEVICE

Device

)

Definition at line 287 of file usbaudio.c.

{
    /* no op */
    DPRINT1("USBAudioAddDevice\n");
    return STATUS_SUCCESS;
}

UsbAudioCaptureComplete()

NTSTATUS NTAPI UsbAudioCaptureComplete	(	IN PDEVICE_OBJECT	DeviceObject,
		IN PIRP	Irp,
		IN PVOID	Context
	)

Definition at line 909 of file pin.c.

{
    PKSPIN Pin;
    PPIN_CONTEXT PinContext;
    KIRQL OldLevel;
    PURB Urb;
 
    /* get pin context */
    Pin = Context;
    PinContext = Pin->Context;
 
    /* get urb */
    Urb = Irp->Tail.Overlay.DriverContext[0];
 
    /* acquire lock */
    KeAcquireSpinLock(&PinContext->IrpListLock, &OldLevel);
 
    if (!NT_SUCCESS(Urb->UrbIsochronousTransfer.Hdr.Status))
    {
        //DPRINT("UsbAudioCaptureComplete Irp %p Urb %p Status %x Packet Status %x\n", Irp, Urb, Urb->UrbIsochronousTransfer.Hdr.Status, Urb->UrbIsochronousTransfer.IsoPacket[0].Status);
 
        /* insert entry into ready list */
        InsertTailList(&PinContext->IrpListHead, &Irp->Tail.Overlay.ListEntry);
 
        /* release lock */
        KeReleaseSpinLock(&PinContext->IrpListLock, OldLevel);
 
        KsIncrementCountedWorker(PinContext->StarvationWorker);
    }
    else
    {
        /* insert entry into done list */
        InsertTailList(&PinContext->DoneIrpListHead, &Irp->Tail.Overlay.ListEntry);
 
        /* release lock */
        KeReleaseSpinLock(&PinContext->IrpListLock, OldLevel);
 
        KsIncrementCountedWorker(PinContext->CaptureWorker);
    }
 
    /* done */
    return STATUS_MORE_PROCESSING_REQUIRED;
}

Referenced by CaptureInitializeUrbAndIrp(), and InitCapturePin().

USBAudioCreateFilterContext()

NTSTATUS NTAPI USBAudioCreateFilterContext

(

PKSDEVICE

Device

)

Definition at line 1525 of file filter.c.

{
    PKSFILTER_DESCRIPTOR FilterDescriptor;
    PKSCOMPONENTID ComponentId;
    NTSTATUS Status;
 
    /* allocate descriptor */
    FilterDescriptor = AllocFunction(sizeof(KSFILTER_DESCRIPTOR));
    if (!FilterDescriptor)
    {
        /* no memory */
        return USBD_STATUS_INSUFFICIENT_RESOURCES;
    }
 
    /* init filter descriptor*/
    FilterDescriptor->Version = KSFILTER_DESCRIPTOR_VERSION;
    FilterDescriptor->Flags = 0;
    FilterDescriptor->ReferenceGuid = &KSNAME_Filter;
    FilterDescriptor->Dispatch = &USBAudioFilterDispatch;
    FilterDescriptor->CategoriesCount = 1;
    FilterDescriptor->Categories = &GUID_KSCATEGORY_AUDIO;
 
    /* init component id*/
    ComponentId = AllocFunction(sizeof(KSCOMPONENTID));
    if (!ComponentId)
    {
        /* no memory */
        return STATUS_INSUFFICIENT_RESOURCES;
    }
    Status = USBAudioInitComponentId(Device, ComponentId);
    if (!NT_SUCCESS(Status))
    {
        /* failed*/
        FreeFunction(ComponentId);
        return Status;
    }
    FilterDescriptor->ComponentId = ComponentId;
 
    /* build pin descriptors */
    Status = USBAudioPinBuildDescriptors(Device, (PKSPIN_DESCRIPTOR_EX *)&FilterDescriptor->PinDescriptors, &FilterDescriptor->PinDescriptorsCount, &FilterDescriptor->PinDescriptorSize);
    if (!NT_SUCCESS(Status))
    {
        /* failed*/
        FreeFunction(ComponentId);
        return Status;
    }
 
    /* build topology */
    Status = BuildUSBAudioFilterTopology(Device, FilterDescriptor);
    if (!NT_SUCCESS(Status))
    {
        /* failed*/
        FreeFunction(ComponentId);
        return Status;
    }
 
    /* lets create the filter */
    Status = KsCreateFilterFactory(Device->FunctionalDeviceObject, FilterDescriptor, ReferenceString, NULL, KSCREATE_ITEM_FREEONSTOP, NULL, NULL, NULL);
    DPRINT("KsCreateFilterFactory: %x\n", Status);
 
    return Status;
}

Referenced by USBAudioPnPStart().

UsbAudioGetStreamingTerminalDescriptorByIndex()

PUSB_AUDIO_CONTROL_INPUT_TERMINAL_DESCRIPTOR UsbAudioGetStreamingTerminalDescriptorByIndex	(	IN PUSB_CONFIGURATION_DESCRIPTOR	ConfigurationDescriptor,
		IN ULONG	Index
	)

Definition at line 1063 of file filter.c.

{
    PUSB_INTERFACE_DESCRIPTOR Descriptor;
    PUSB_AUDIO_CONTROL_INTERFACE_HEADER_DESCRIPTOR InterfaceHeaderDescriptor;
    PUSB_COMMON_DESCRIPTOR CommonDescriptor;
    PUSB_AUDIO_CONTROL_INPUT_TERMINAL_DESCRIPTOR InputTerminalDescriptor;
    ULONG TerminalCount = 0;
 
    for (Descriptor = USBD_ParseConfigurationDescriptorEx(ConfigurationDescriptor, ConfigurationDescriptor, -1, -1, USB_DEVICE_CLASS_AUDIO, -1, -1);
    Descriptor != NULL;
        Descriptor = USBD_ParseConfigurationDescriptorEx(ConfigurationDescriptor, (PVOID)((ULONG_PTR)Descriptor + Descriptor->bLength), -1, -1, USB_DEVICE_CLASS_AUDIO, -1, -1))
    {
        if (Descriptor->bInterfaceSubClass == 0x01) /* AUDIO_CONTROL */
        {
            InterfaceHeaderDescriptor = (PUSB_AUDIO_CONTROL_INTERFACE_HEADER_DESCRIPTOR)USBD_ParseDescriptors(ConfigurationDescriptor, ConfigurationDescriptor->wTotalLength, Descriptor, USB_AUDIO_CONTROL_TERMINAL_DESCRIPTOR_TYPE);
            if (InterfaceHeaderDescriptor != NULL)
            {
                CommonDescriptor = USBD_ParseDescriptors(InterfaceHeaderDescriptor, InterfaceHeaderDescriptor->wTotalLength, (PVOID)((ULONG_PTR)InterfaceHeaderDescriptor + InterfaceHeaderDescriptor->bLength), USB_AUDIO_CONTROL_TERMINAL_DESCRIPTOR_TYPE);
                while (CommonDescriptor)
                {
                    InputTerminalDescriptor = (PUSB_AUDIO_CONTROL_INPUT_TERMINAL_DESCRIPTOR)CommonDescriptor;
                    if (InputTerminalDescriptor->bDescriptorSubtype == 0x02 /* INPUT TERMINAL*/ || InputTerminalDescriptor->bDescriptorSubtype == 0x03 /* OUTPUT_TERMINAL*/)
                    {
                        if (InputTerminalDescriptor->wTerminalType == USB_AUDIO_STREAMING_TERMINAL_TYPE)
                        {
                            if (TerminalCount == Index)
                            {
                                return InputTerminalDescriptor;
                            }
                            TerminalCount++;
                        }
                    }
                    CommonDescriptor = (PUSB_COMMON_DESCRIPTOR)((ULONG_PTR)CommonDescriptor + CommonDescriptor->bLength);
                    if ((ULONG_PTR)CommonDescriptor >= ((ULONG_PTR)InterfaceHeaderDescriptor + InterfaceHeaderDescriptor->wTotalLength))
                        break;
                }
            }
        }
    }
    return NULL;
}

Referenced by USBAudioPinBuildDescriptors(), and USBAudioSelectAudioStreamingInterface().

USBAudioPinClose()

NTSTATUS NTAPI USBAudioPinClose	(	_In_ PKSPIN	Pin,
		_In_ PIRP	Irp
	)

Definition at line 843 of file pin.c.

{
    UNIMPLEMENTED;
    return STATUS_NOT_IMPLEMENTED;
}

USBAudioPinCreate()

NTSTATUS NTAPI USBAudioPinCreate	(	_In_ PKSPIN	Pin,
		_In_ PIRP	Irp
	)

Definition at line 764 of file pin.c.

{
    PKSFILTER Filter;
    PFILTER_CONTEXT FilterContext;
    PPIN_CONTEXT PinContext;
    NTSTATUS Status;
    ULONG FormatIndex;
 
    Filter = KsPinGetParentFilter(Pin);
    if (Filter == NULL)
    {
        /* invalid parameter */
        return STATUS_INVALID_PARAMETER;
    }
 
    /* get filter context */
    FilterContext = Filter->Context;
 
    /* allocate pin context */
    PinContext = AllocFunction(sizeof(PIN_CONTEXT));
    if (!PinContext)
    {
        /* no memory*/
        return STATUS_INSUFFICIENT_RESOURCES;
    }
 
    /* init pin context */
    PinContext->DeviceExtension = FilterContext->DeviceExtension;
    PinContext->LowerDevice = FilterContext->LowerDevice;
    InitializeListHead(&PinContext->IrpListHead);
    InitializeListHead(&PinContext->DoneIrpListHead);
    KeInitializeSpinLock(&PinContext->IrpListLock);
 
    /* store pin context*/
    Pin->Context = PinContext;
 
    /* lets edit allocator framing struct */
    Status = _KsEdit(Pin->Bag, (PVOID*)&Pin->Descriptor, sizeof(KSPIN_DESCRIPTOR_EX), sizeof(KSPIN_DESCRIPTOR_EX), USBAUDIO_TAG);
    if (NT_SUCCESS(Status))
    {
        Status = _KsEdit(Pin->Bag, (PVOID*)&Pin->Descriptor->AllocatorFraming, sizeof(KSALLOCATOR_FRAMING_EX), sizeof(KSALLOCATOR_FRAMING_EX), USBAUDIO_TAG);
        ASSERT(Status == STATUS_SUCCESS);
    }
 
    /* choose correct dataformat */
    FormatIndex = GetDataRangeIndexForFormat(Pin->ConnectionFormat, Pin->Descriptor->PinDescriptor.DataRanges, Pin->Descriptor->PinDescriptor.DataRangesCount);
    if (FormatIndex == MAXULONG)
    {
        /* no format match */
        return STATUS_NO_MATCH;
    }
 
    /* select streaming interface */
    Status = USBAudioSelectAudioStreamingInterface(Pin, PinContext, PinContext->DeviceExtension, PinContext->DeviceExtension->ConfigurationDescriptor, FormatIndex);
    if (!NT_SUCCESS(Status))
    {
        /* failed */
        DPRINT1("USBAudioSelectAudioStreamingInterface failed with %x\n", Status);
        return Status;
    }
 
    if (Pin->DataFlow == KSPIN_DATAFLOW_OUT)
    {
        /* init capture pin */
        Status = InitCapturePin(Pin);
    }
    else
    {
        /* audio streaming pin*/
        Status = InitStreamPin(Pin);
    }
 
    return Status;
}

UsbAudioPinDataIntersect()

NTSTATUS NTAPI UsbAudioPinDataIntersect	(	_In_ PVOID	Context,
		_In_ PIRP	Irp,
		_In_ PKSP_PIN	Pin,
		_In_ PKSDATARANGE	DataRange,
		_In_ PKSDATARANGE	MatchingDataRange,
		_In_ ULONG	DataBufferSize,
		_Out_ PVOID	Data,
		_Out_ PULONG	DataSize
	)

Definition at line 1416 of file pin.c.

{
    PKSFILTER Filter;
    PKSPIN_DESCRIPTOR_EX PinDescriptor;
    PKSDATAFORMAT_WAVEFORMATEX DataFormat;
    PKSDATARANGE_AUDIO DataRangeAudio;
 
    /* get filter from irp*/
    Filter = KsGetFilterFromIrp(Irp);
    if (!Filter)
    {
        /* no match*/
        return STATUS_NO_MATCH;
    }
 
    /* get pin descriptor */
    PinDescriptor = (PKSPIN_DESCRIPTOR_EX)&Filter->Descriptor->PinDescriptors[Pin->PinId];
 
    *DataSize = sizeof(KSDATAFORMAT_WAVEFORMATEX);
    if (DataBufferSize == 0)
    {
        /* buffer too small */
        return STATUS_BUFFER_OVERFLOW;
    }
 
    /* sanity checks*/
    ASSERT(PinDescriptor->PinDescriptor.DataRangesCount >= 0);
    ASSERT(PinDescriptor->PinDescriptor.DataRanges[0]->FormatSize == sizeof(KSDATARANGE_AUDIO));
 
    DataRangeAudio = (PKSDATARANGE_AUDIO)PinDescriptor->PinDescriptor.DataRanges[0];
 
    DataFormat = Data;
    DataFormat->WaveFormatEx.wFormatTag = WAVE_FORMAT_PCM;
    DataFormat->WaveFormatEx.nChannels = DataRangeAudio->MaximumChannels;
    DataFormat->WaveFormatEx.nSamplesPerSec = DataRangeAudio->MaximumSampleFrequency;
    DataFormat->WaveFormatEx.nAvgBytesPerSec = DataRangeAudio->MaximumSampleFrequency * (DataRangeAudio->MaximumBitsPerSample / 8) * DataRangeAudio->MaximumChannels;
    DataFormat->WaveFormatEx.nBlockAlign = (DataRangeAudio->MaximumBitsPerSample / 8) * DataRangeAudio->MaximumChannels;
    DataFormat->WaveFormatEx.wBitsPerSample = DataRangeAudio->MaximumBitsPerSample;
    DataFormat->WaveFormatEx.cbSize = 0;
 
    DataFormat->DataFormat.FormatSize = sizeof(KSDATAFORMAT) + sizeof(WAVEFORMATEX);
    DataFormat->DataFormat.Flags = 0;
    DataFormat->DataFormat.Reserved = 0;
    DataFormat->DataFormat.MajorFormat = KSDATAFORMAT_TYPE_AUDIO;
    DataFormat->DataFormat.SubFormat = KSDATAFORMAT_SUBTYPE_PCM;
    DataFormat->DataFormat.Specifier = KSDATAFORMAT_SPECIFIER_WAVEFORMATEX;
    DataFormat->DataFormat.SampleSize = (DataRangeAudio->MaximumBitsPerSample / 8) * DataRangeAudio->MaximumChannels;
 
    return STATUS_SUCCESS;
}

Referenced by USBAudioPinBuildDescriptors().

USBAudioPinProcess()

NTSTATUS NTAPI USBAudioPinProcess

(

_In_ PKSPIN

Pin

)

Definition at line 1270 of file pin.c.

{
    NTSTATUS Status;
 
    if (Pin->DataFlow == KSPIN_DATAFLOW_OUT)
    {
        Status = PinCaptureProcess(Pin);
    }
    else
    {
        Status = PinRenderProcess(Pin);
    }
 
    return Status;
}

USBAudioPinReset()

VOID NTAPI USBAudioPinReset

(

_In_ PKSPIN

Pin

)

Definition at line 1290 of file pin.c.

{
    UNIMPLEMENTED;
}

USBAudioPinSetDataFormat()

NTSTATUS NTAPI USBAudioPinSetDataFormat	(	_In_ PKSPIN	Pin,
		_In_opt_ PKSDATAFORMAT	OldFormat,
		_In_opt_ PKSMULTIPLE_ITEM	OldAttributeList,
		_In_ const KSDATARANGE *	DataRange,
		_In_opt_ const KSATTRIBUTE_LIST *	AttributeRange
	)

Definition at line 1298 of file pin.c.

{
    if (OldFormat == NULL)
    {
        /* TODO: verify connection format */
        UNIMPLEMENTED;
        return STATUS_SUCCESS;
    }
 
    return UsbAudioSetFormat(Pin);
}

USBAudioPinSetDeviceState()

NTSTATUS NTAPI USBAudioPinSetDeviceState	(	_In_ PKSPIN	Pin,
		_In_ KSSTATE	ToState,
		_In_ KSSTATE	FromState
	)

Definition at line 1392 of file pin.c.

{
    NTSTATUS Status;
 
    if (Pin->DataFlow == KSPIN_DATAFLOW_OUT)
    {
        /* handle capture state changes */
        Status = CapturePinStateChange(Pin, ToState, FromState);
    }
    else
    {
        UNIMPLEMENTED;
        Status = STATUS_SUCCESS;
    }
 
    return Status;
}

USBAudioPnPCancelRemove()

VOID NTAPI USBAudioPnPCancelRemove	(	_In_ PKSDEVICE	Device,
		_In_ PIRP	Irp
	)

Definition at line 377 of file usbaudio.c.

{
    /* no op */
}

USBAudioPnPCancelStop()

VOID NTAPI USBAudioPnPCancelStop	(	_In_ PKSDEVICE	Device,
		_In_ PIRP	Irp
	)

Definition at line 347 of file usbaudio.c.

{
    /* no op */
}

USBAudioPnPQueryCapabilities()

NTSTATUS NTAPI USBAudioPnPQueryCapabilities	(	_In_ PKSDEVICE	Device,
		_In_ PIRP	Irp,
		_Inout_ PDEVICE_CAPABILITIES	Capabilities
	)

Definition at line 396 of file usbaudio.c.

{
    /* TODO: set caps */
    UNIMPLEMENTED;
    return STATUS_SUCCESS;
}

USBAudioPnPQueryPower()

NTSTATUS NTAPI USBAudioPnPQueryPower	(	_In_ PKSDEVICE	Device,
		_In_ PIRP	Irp,
		_In_ DEVICE_POWER_STATE	DeviceTo,
		_In_ DEVICE_POWER_STATE	DeviceFrom,
		_In_ SYSTEM_POWER_STATE	SystemTo,
		_In_ SYSTEM_POWER_STATE	SystemFrom,
		_In_ POWER_ACTION	Action
	)

Definition at line 418 of file usbaudio.c.

{
    /* no op */
    return STATUS_SUCCESS;
}

USBAudioPnPQueryRemove()

NTSTATUS NTAPI USBAudioPnPQueryRemove	(	_In_ PKSDEVICE	Device,
		_In_ PIRP	Irp
	)

Definition at line 366 of file usbaudio.c.

{
    /* no op */
    return STATUS_SUCCESS;
}

USBAudioPnPQueryStop()

NTSTATUS NTAPI USBAudioPnPQueryStop	(	_In_ PKSDEVICE	Device,
		_In_ PIRP	Irp
	)

Definition at line 337 of file usbaudio.c.

{
    /* no op */
    return STATUS_SUCCESS;
}

USBAudioPnPRemove()

VOID NTAPI USBAudioPnPRemove	(	_In_ PKSDEVICE	Device,
		_In_ PIRP	Irp
	)

Definition at line 386 of file usbaudio.c.

{
    /* TODO: stop device */
    UNIMPLEMENTED;
}

USBAudioPnPSetPower()

VOID NTAPI USBAudioPnPSetPower	(	_In_ PKSDEVICE	Device,
		_In_ PIRP	Irp,
		_In_ DEVICE_POWER_STATE	To,
		_In_ DEVICE_POWER_STATE	From
	)

Definition at line 433 of file usbaudio.c.

{
    /* TODO: stop streams */
    UNIMPLEMENTED;
}

USBAudioPnPStart()

NTSTATUS NTAPI USBAudioPnPStart	(	_In_ PKSDEVICE	Device,
		_In_ PIRP	Irp,
		_In_opt_ PCM_RESOURCE_LIST	TranslatedResourceList,
		_In_opt_ PCM_RESOURCE_LIST	UntranslatedResourceList
	)

Definition at line 297 of file usbaudio.c.

{
    NTSTATUS Status = STATUS_SUCCESS;
    PDEVICE_EXTENSION DeviceExtension;
 
    if (!Device->Started)
    {
        /* alloc context  */
        DeviceExtension = AllocFunction(sizeof(DEVICE_EXTENSION));
        if (DeviceExtension == NULL)
        {
             /* insufficient resources */
             return STATUS_INSUFFICIENT_RESOURCES;
        }
 
        /* init context */
        Device->Context = DeviceExtension;
        DeviceExtension->LowerDevice = Device->NextDeviceObject;
 
        /* add to object bag*/
        KsAddItemToObjectBag(Device->Bag, Device->Context, ExFreePool);
 
        /* init device*/
        Status = USBAudioStartDevice(Device);
        if (NT_SUCCESS(Status))
        {
            /* TODO retrieve interface */
            Status = USBAudioCreateFilterContext(Device);
        }
    }
 
    return Status;
}

USBAudioPnPStop()

VOID NTAPI USBAudioPnPStop	(	_In_ PKSDEVICE	Device,
		_In_ PIRP	Irp
	)

Definition at line 356 of file usbaudio.c.

{
    /* TODO: stop device */
    UNIMPLEMENTED;
}

USBAudioPnPSurpriseRemoval()

VOID NTAPI USBAudioPnPSurpriseRemoval	(	_In_ PKSDEVICE	Device,
		_In_ PIRP	Irp
	)

Definition at line 408 of file usbaudio.c.

{
    /* TODO: stop streams */
    UNIMPLEMENTED;
}

UsbAudioRenderComplete()

NTSTATUS NTAPI UsbAudioRenderComplete	(	IN PDEVICE_OBJECT	DeviceObject,
		IN PIRP	Irp,
		IN PVOID	Context
	)

Definition at line 853 of file pin.c.

{
    PKSPIN Pin;
    PPIN_CONTEXT PinContext;
    KIRQL OldLevel;
    PKSSTREAM_POINTER StreamPointerClone;
    NTSTATUS Status;
    PURB Urb;
 
    /* get pin context */
    Pin = Context;
    PinContext = Pin->Context;
 
    /* get status */
    Status = Irp->IoStatus.Status;
 
    /* get streampointer */
    StreamPointerClone = Irp->Tail.Overlay.DriverContext[1];
 
    /* get urb */
    Urb = Irp->Tail.Overlay.DriverContext[0];
 
    /* and free it */
    FreeFunction(Urb);
 
    /* acquire lock */
    KeAcquireSpinLock(&PinContext->IrpListLock, &OldLevel);
 
    /* insert entry into ready list */
    InsertTailList(&PinContext->IrpListHead, &Irp->Tail.Overlay.ListEntry);
 
    /* release lock */
    KeReleaseSpinLock(&PinContext->IrpListLock, OldLevel);
 
    if (!NT_SUCCESS(Status) && StreamPointerClone)
    {
        /* set status code because it failed */
        KsStreamPointerSetStatusCode(StreamPointerClone, STATUS_DEVICE_DATA_ERROR);
        DPRINT1("UsbAudioRenderComplete failed with %x\n", Status);
    }
 
    if (StreamPointerClone)
    {
        /* lets delete the stream pointer clone */
        KsStreamPointerDelete(StreamPointerClone);
    }
 
    /* done */
    return STATUS_MORE_PROCESSING_REQUIRED;
}

Referenced by InitStreamPin(), and RenderInitializeUrbAndIrp().