User API Window

The User API window is used to demonstrate the controls commonly found on all audio products.  These controls are tightly integrated into the DPS algorithm.

  1. User Volume – This is the volume control for users of the final product.  Parameter smoothing is applied to prevent noise when changing the level.  This volume control’s location in the signal path may be changed in the drop-down menu.
    • INPUT – The volume control is located before the Multiband AGC.  This is best for most speaker applications so the Multiband AGC can control bass levels when the volume level is high.
    • OUTPUT – The volume control is located after the Multiband AGC.  This is best for headphone applications when the sound should not change when the volume level is changed.
  2. User EQ – Bass and Treble controls are provided as 2 fully parametric EQ bands.  
    • Bass and Treble are disabled by default.  Click the checkbox below each band to enable the control.
    • These EQ bands are located with the User Volume control in the signal path and are affected by the User Volume INPUT/OUTPUT selection.
    • PEQ checkbox – By default, only EQ parameters (gain, frequency, Q) are sent to the platform.  Coefficients for the filters are calculated on the target platform according to the platform’s current sample rate.  
      • Enabling PEQ will send pre-calculated coefficients to the platform to save CPU cycles.
      • PEQ mode applies to User Bass/Treble and the 10 band Parametric EQ.
  3. Fade/Balance – This control is provided for automotive or other systems with 4 or more channels.  
    • Scalar gain values are provided in the control for each of the 4 channels.
    • This is useful for generating gain parameters for HUI programming.
    • Mute –  Mutes all channels.  Smoothing is applied to prevent clicks or pops during mute/unmute.
    • VSUB – Simple enable/disable for the Virtual Subwoofer algorithm.
      • Provides a calibrated “Bass Boost” control to the end-user.
  4. V3D Selection – Provides HRTF virtual surround sound effects.
    • Algo – Select the desired V3D algorithm:
      1. HP Transparent – Headphone enhancement with light surround effect and very little effect on frequency response.  Good for hi-fi music listening,
      2. HP V3D v1 – Headphone effect as found on Nuvoton and Realtek ALC567x platforms.  Best for gaming.  Maximum of 128 taps available.
      3. HP V3D v2 – Headphone effect currently available in Bongiovi Microsoft Windows and MacOS solutions.  Best for gaming and movies.  Maximum of 512 taps available.
      4. SPK V3D v1 – Speaker “holographic” surround effect for soundbars, laptops, and tablets that have front-facing speakers.  Maximum of 256 taps available.
    • Mode – Select one of the 6 preset effect modes.  These are common for all stereo-input (272 or virtual surround sound) V3D algorithms.
    • Taps – Set the number of taps used for the HRTF FIR filters.  More taps = better quality = more CPU usage.
  5. Stereo Widening – Basic user on/off and adjustment of the Dynamic Stereo Speaker Enhancement effect.
  6. Platform Presets – Press one of these buttons to send a single command to the platform that loads an embedded preset.
    • NOTE: This does not send profile data from the Profile Creator.  These controls are used to audition presets that have already been loaded into the target platform/product.
  7. Local Presets – Select and load a preset that exists in the Profile Creator working memory.
    • NOTE: As of version 2.0.4, this feature has been replaced by the Preset Manager
    • Presets dropdown menu – Select the preset you wish to load and modify.
      • A Preset manages one or more instances of the algorithm.  
      • A Profile contains all of the parameters that may be loaded into a single instance of the algorithm.
    • Instance dropdown menu – Select one of the instances/profiles associated with the current Preset.
      • An instance may be stereo (2 linked channels) or mono (a single channel).
  8. Sync status – This icon shows the status of the connection to the platform.
    • Not connected to any platform.
    • Connected to the target platform.  All UI controls and parameters are synchronized with the target platform.
      • This indicates normal operation.  The Profile Creator UI is the master controller of all algorithm parameters on the target platform.
      • Click this icon at any time to pull all data from the platform.
    • Out of sync with the target platform.  The UI is connected, but the parameters on the platform no longer match the UI.
      • This will occur when using the Platform Presets buttons.  When a preset is loaded on the platform side, the UI will become out of sync with the platform.
      • Click the icon to pull the parameters from the platform into the UI.
        • NOTE:  This will overwrite the existing parameters/control settings in the UI.
Was this page helpful?