diff --git a/.gitignore b/.gitignore index 3ee22367..6f4dc7a2 100644 --- a/.gitignore +++ b/.gitignore @@ -15,6 +15,10 @@ *.a *.swp *.*~ +*.pyc +.build* +.DS_Store +test_results.csv # waf build files .lock-waf_* diff --git a/README.rst b/README.rst index 9c0d4a97..0de1b1fb 100644 --- a/README.rst +++ b/README.rst @@ -1,18 +1,57 @@ lib_xua ======= +Summary +------- + USB Audio Shared Components. For use in the XMOS USB Audio Refererence Designs. +Features +........ -Required software (dependencies) -................................ +Key features of the various applications in this repository are as follows - * lib_logging - * lib_xud +- USB Audio Class 1.0/2.0 Compliant + +- Fully Asynchronous operation + +- Support for the following sample frequencies: 8, 11.025, 12, 16, 32, 44.1, 48, 88.2, 96, 176.4, 192, 352.8, 384kHz + +- Input/output channel and individual volume/mute controls supported + +- Support for dynamically selectable output audio formats (e.g. resolution) + +- Field firmware upgrade compliant to the USB Device Firmware Upgrade (DFU) Class Specification + +- S/PDIF output + +- S/PDIF input + +- ADAT output + +- ADAT input + +- MIDI input/output (Compliant to USB Class Specification for MIDI devices) + +- DSD output (Native and DoP mode) at DSD64 and DSD128 rates + +- Mixer with flexible routing + +- Simple playback controls via Human Interface Device (HID) + +- Support for operation with Apple devices (requires software module sc_mfi for MFI licensees only - please contact XMOS) + +Note, not all features may be supported at all sample frequencies, simultaneously or on all devices. Some features also require specific host driver support. -Checking dependent libs Software version and dependencies ................................. .. libdeps:: + +Related Application Notes +......................... + +The following application notes use this library: + + * AN000246 - Simple USB Audio Device using lib_xua diff --git a/examples/AN00246_xua_example/README.rst b/examples/AN00246_xua_example/README.rst index 125adb13..ef159ebf 100644 --- a/examples/AN00246_xua_example/README.rst +++ b/examples/AN00246_xua_example/README.rst @@ -1,6 +1,6 @@ -How to use the lib_xua_library -=============================== +Simple USB Audio Device using lib_xua +===================================== .. version:: 0.1.0