source/modules/juce_audio_basics/sources/juce_ReverbAudioSource.h

   1 /*
   2   ==============================================================================
   3
   4    This file is part of the JUCE library.
   5    Copyright (c) 2022 - Raw Material Software Limited
   6
   7    JUCE is an open source library subject to commercial or open-source
   8    licensing.
   9
  10    The code included in this file is provided under the terms of the ISC license
  11    http://www.isc.org/downloads/software-support-policy/isc-license. Permission
  12    To use, copy, modify, and/or distribute this software for any purpose with or
  13    without fee is hereby granted provided that the above copyright notice and
  14    this permission notice appear in all copies.
  15
  16    JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
  17    EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
  18    DISCLAIMED.
  19
  20   ==============================================================================
  21 */
  22
  23 namespace juce
  24 {
  25
  26 //==============================================================================
  27 /**
  28     An AudioSource that uses the Reverb class to apply a reverb to another AudioSource.
  29
  30     @see Reverb
  31
  32     @tags{Audio}
  33 */
  34 class JUCE_API  ReverbAudioSource   : public AudioSource
  35 {
  36 public:
  37     /** Creates a ReverbAudioSource to process a given input source.
  38
  39         @param inputSource              the input source to read from - this must not be null
  40         @param deleteInputWhenDeleted   if true, the input source will be deleted when
  41                                         this object is deleted
  42     */
  43     ReverbAudioSource (AudioSource* inputSource,
  44                        bool deleteInputWhenDeleted);
  45
  46     /** Destructor. */
  47     ~ReverbAudioSource() override;
  48
  49     //==============================================================================
  50     /** Returns the parameters from the reverb. */
  51     const Reverb::Parameters& getParameters() const noexcept    { return reverb.getParameters(); }
  52
  53     /** Changes the reverb's parameters. */
  54     void setParameters (const Reverb::Parameters& newParams);
  55
  56     void setBypassed (bool isBypassed) noexcept;
  57     bool isBypassed() const noexcept                            { return bypass; }
  58
  59     //==============================================================================
  60     void prepareToPlay (int samplesPerBlockExpected, double sampleRate) override;
  61     void releaseResources() override;
  62     void getNextAudioBlock (const AudioSourceChannelInfo&) override;
  63
  64 private:
  65     //==============================================================================
  66     CriticalSection lock;
  67     OptionalScopedPointer<AudioSource> input;
  68     Reverb reverb;
  69     std::atomic<bool> bypass;
  70
  71     JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ReverbAudioSource)
  72 };
  73
  74 } // namespace juce