Package soundPlayback.preprocess

Interface PlaybackPreprocess

All Known Implementing Classes:
EnvelopeTracer, PlaybackDecimator, PlaybackFilter, PlaybackGain
public interface PlaybackPreprocess

  • Method Summary

    Modifier and Type
    Method
    Description
    PreprocessSwingComponent
    getSideParComponent()
    Get a component to include in the PAMGuard side panel.
    PreProcessFXPane
    getSideParPane()
    Get a node to include in the PAMGuard side panel.
    boolean
    isActive()
    return true if the preprocess is doing anything.
    RawDataUnit
    processDataUnit(RawDataUnit inputDataUnit, boolean mustCopy)
    Process a data unit.
    void
    reset(double inputSampleRate, int channelMap)
    Reset or prepare the process
    Will almost definitely need another less abstract process for setting more specific task parameters.

  • Method Details

    • reset

      void reset(double inputSampleRate, int channelMap)
      Reset or prepare the process
      Will almost definitely need another less abstract process for setting more specific task parameters.
      Parameters:
      channelMap - map of channels that are going to get processed.

    • processDataUnit

      RawDataUnit processDataUnit(RawDataUnit inputDataUnit, boolean mustCopy)
      Process a data unit.
      Parameters:
      inputDataUnit - source data unit.
      mustCopy - data must not be modified in place. This will be set true for the rist unit in a chain in the playback system (generally a decimator) after that it will be false meaning that processes are free to modify the data in place so long as it remains consistent in length, etc.
      Returns:
      a Raw data unit which may or may not be the same as the input one.

    • getSideParComponent

      PreprocessSwingComponent getSideParComponent()
      Get a component to include in the PAMGuard side panel.
      Returns:
      Component for the side panel

    • getSideParPane

      PreProcessFXPane getSideParPane()
      Get a node to include in the PAMGuard side panel.
      Returns:
      pane for the side panel

    • isActive

      boolean isActive()
      return true if the preprocess is doing anything.
      Returns:
      Component for the side panel