XMOS xsoftip Audio Delay-line Function Library

Transcription

1 XMOS xsoftip Audio Delay-line Function Library Publication Date: 2012/10/15 XMOS 2012, All Rights Reserved.

2 XMOS xsoftip Audio Delay-line Function Library 2/10 Table of Contents 1 Overview 3 2 Resource Requirements Available Memory Computation Hardware Platforms Recommended Hardware Slicekit Demonstration Applications Stand Alone Demo Reverb Demo API Configuration Defines Functions Data Structures Configuration Functions DSP Processing Functions Programming Guide Key Files Usage Demo Applications Short-Delay Application For SliceKit Board (app_slicekit_short_delay) Makefile Running the application with the Command Line Tools Trouble-shooting

3 1 Overview This function library can be used to create multiple echos by feeding the input audio stream into a delay-line. The delay-line returns a set of delayed outputs (taps), with the number of taps being configurable. The delay-line uses only local memory, so only short delays up to 12,000 samples are possible. For longer delays see the Audio Long Delay Function Library.

4 2 Resource Requirements IN THIS CHAPTER Available Memory Computation 2.1 Available Memory This application uses variable amounts of memory depending on the size of the delay-line, and the number of channels being processed. A #define MEM_SAMPS is used to indicate the amount of memory available for the delay-line. Currently this is set at samples, which uses almost all the available memory on Tile_0. Used memory(bytes) is about: codememory: 5K datamemory: 49K 2.2 Computation The Delay-line uses no multiples. So far a maximum of 4 delay taps have been used successfully, each on 4 channels. By inspecting timings the processing time for one tap is about 80 cycles. For a 48 khz sample rate and 500 MHz processor, this would allow about 100 taps/sample/channel.

5 3 Hardware Platforms IN THIS CHAPTER Recommended Hardware Demonstration Applications 3.1 Recommended Hardware Slicekit This module may be evaluated using the Slicekit Modular Development Platform, available from digikey. Minimum Required board SKUs are: XP-SKC-L2 (Slicekit L2 Core Board) plus XA-SK-AUDIO plus XA-SK-XTAG2 (Slicekit XTAG adaptor) 3.2 Demonstration Applications Stand Alone Demo Example stand alone usage of this module can be found within the XSoftIP suite as follows: Package: sw_audio_effects Application: app_slicekit_short_delay Reverb Demo This module is used in the app_slicekit_short_reverb example application which shows how the module is deployed within the context of a more complex audio processing application. Note that in addition to the recommended hardware above, the XA-SK-SDRAM Slice Card will also be required, since this application buffers more audio samples than can be accomodated in the free internal SRAM of the xcore Tile. Package: sw_audio_effects Application: app_slicekit_short_reverb

6 4 API IN THIS CHAPTER Configuration Defines Functions 4.1 Configuration Defines DEF_SAMP_FREQ Default Sample Frequency (In Hz): MEM_SAMPS DELAY_SIZE Memory available to configure delay buffers (in samples). Adjust to suit platform: Size of channel delay buffer (in samples): (MEM_SAMPS / NUM_DELAY_CHANS). MAX_TAPS Maximum number of different taps supported: 8. DEF_TAPS Default number of taps: Functions Data Structures DELAY_PARAM_TAG Structure containing Delay-line parameters. This structure has the following members: S32_T us_delays S32_T num S32_T freq Configuration Functions void config_delay_line(delay_param_s &cur_param_s) Configure delay_line parameters. NB Must be called before use_delay_line. This function has the following parameters:

7 XMOS xsoftip Audio Delay-line Function Library 7/10 cur_param_s // Reference to structure containing delay-line parameters DSP Processing Functions void use_delay_line(s32_t out_samps[], S32_T inp_samp, S32_T cur_chan) Exercise delay-line for one input sample. NB Must have previously called config_delay_line. Samples are left-aligned signed values. e.g. 24-bit audio will look like 0x (positive) or 0xFF (negative) This function has the following parameters: out_samps[] inp_samp // array of delayed output samples at channel precision // Input Sample cur_chan // current channel This function returns: The delayed output sample

8 5 Programming Guide IN THIS CHAPTER Key Files Usage 5.1 Key Files delay_line.c: Contains C function library delay_line.h: Header file for C function library 5.2 Usage config_delay() Called to do initial configuration of delay parameters (e.g. delay offsets). WARNING: This must be called before... use_delay() Called to apply set of delays to one audio-sample, designed to be called from an *.xc file. Note After initialisation, config_delay() can be called again as required to reconfigure the delay offsets. Delays are set in microseconds in the us_delays field of the DELAY_PARAM_S structure.

9 6 Demo Applications IN THIS CHAPTER Short-Delay Application For SliceKit Board (app_slicekit_short_delay) 6.1 Short-Delay Application For SliceKit Board (app_slicekit_short_delay) This application uses module_dsp_short_delay to create a set of delays (or echos) for an audio-stream, passing through the SliceKit Core board. The audio is connected to the board using the following Analogue ports: Input 0/1 (Microphone mini-jack) Output 0/1 (Headphone mini-jack) An itermediate signal is created mixing the input stream with the output of the delay-line, which is set-up to produce 4 different echos. This intermedate signal is used for the output, but also fed back into the delay-line, to create a potentially infinite set of echos. In fact the mixing is arranged so that the echos decay exponentially in amplitude Makefile The Makefile is found in the top level directory of the application (e.g. app_slicekit_short_delay) The application is for the Slicekit Core Board so the TARGET variable needs to be set in the Makefile: e.g TARGET = xp-skc-l2-single-xscope.xn The number of channels supported in currently 2 or 4, this is set in auto_conf.h: e.g. NUM_DELAY_CHANS = Running the application with the Command Line Tools xmake clean xmake all Connect the board to your PC using an XTAG-2

10 XMOS xsoftip Audio Delay-line Function Library 10/10 xrun io bin/app_slicekit_short_delay.xe About 8 seconds of the effect (i.e. multiple echos decaying in amplitude), followed by About 8 seconds of the dry (un-effected) signal. This cycle will repeat indefinitely Trouble-shooting During initialisation, and when the system is reconfigured, there may be audible clicks in the audio. This is expected. Copyright 2012, All Rights Reserved. Xmos Ltd. is the owner or licensee of this design, code, or Information (collectively, the Information ) and is providing it to you AS IS with no warranty of any kind, express or implied and shall have no liability in relation to its use. Xmos Ltd. makes no representation that the Information, or any particular implementation thereof, is or will be free from any claims of infringement and again, shall have no liability in relation to any such claims. XMOS and the XMOS logo are registered trademarks of Xmos Ltd. in the United Kingdom and other countries, and may not be used without written permission. All other trademarks are property of their respective owners. Where those designations appear in this book, and XMOS was aware of a trademark claim, the designations have been printed with initial capital letters or in all capitals.