mirror of https://github.com/dcoredump/dexed.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
117 lines
5.1 KiB
117 lines
5.1 KiB
/*
|
|
==============================================================================
|
|
|
|
This file is part of the JUCE library.
|
|
Copyright (c) 2015 - ROLI Ltd.
|
|
|
|
Permission is granted to use this software under the terms of either:
|
|
a) the GPL v2 (or any later version)
|
|
b) the Affero GPL v3
|
|
|
|
Details of these licenses can be found at: www.gnu.org/licenses
|
|
|
|
JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
|
|
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
|
|
A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
|
|
|
------------------------------------------------------------------------------
|
|
|
|
To release a closed-source product which uses JUCE, commercial licenses are
|
|
available: visit www.juce.com for more information.
|
|
|
|
==============================================================================
|
|
*/
|
|
|
|
#ifndef JUCE_AUDIOAPPCOMPONENT_H_INCLUDED
|
|
#define JUCE_AUDIOAPPCOMPONENT_H_INCLUDED
|
|
|
|
|
|
//==============================================================================
|
|
/**
|
|
A base class for writing audio apps that stream from the audio i/o devices.
|
|
|
|
A subclass can inherit from this and implement just a few methods such as
|
|
getNextAudioBlock(). The base class provides a basic AudioDeviceManager object
|
|
and runs audio through the default output device.
|
|
*/
|
|
class AudioAppComponent : public Component,
|
|
public AudioSource
|
|
{
|
|
public:
|
|
AudioAppComponent();
|
|
~AudioAppComponent();
|
|
|
|
/** A subclass should call this from their constructor, to set up the audio. */
|
|
void setAudioChannels (int numInputChannels, int numOutputChannels);
|
|
|
|
/** Tells the source to prepare for playing.
|
|
|
|
An AudioSource has two states: prepared and unprepared.
|
|
|
|
The prepareToPlay() method is guaranteed to be called at least once on an 'unpreprared'
|
|
source to put it into a 'prepared' state before any calls will be made to getNextAudioBlock().
|
|
This callback allows the source to initialise any resources it might need when playing.
|
|
|
|
Once playback has finished, the releaseResources() method is called to put the stream
|
|
back into an 'unprepared' state.
|
|
|
|
Note that this method could be called more than once in succession without
|
|
a matching call to releaseResources(), so make sure your code is robust and
|
|
can handle that kind of situation.
|
|
|
|
@param samplesPerBlockExpected the number of samples that the source
|
|
will be expected to supply each time its
|
|
getNextAudioBlock() method is called. This
|
|
number may vary slightly, because it will be dependent
|
|
on audio hardware callbacks, and these aren't
|
|
guaranteed to always use a constant block size, so
|
|
the source should be able to cope with small variations.
|
|
@param sampleRate the sample rate that the output will be used at - this
|
|
is needed by sources such as tone generators.
|
|
@see releaseResources, getNextAudioBlock
|
|
*/
|
|
virtual void prepareToPlay (int samplesPerBlockExpected,
|
|
double sampleRate) = 0;
|
|
|
|
/** Allows the source to release anything it no longer needs after playback has stopped.
|
|
|
|
This will be called when the source is no longer going to have its getNextAudioBlock()
|
|
method called, so it should release any spare memory, etc. that it might have
|
|
allocated during the prepareToPlay() call.
|
|
|
|
Note that there's no guarantee that prepareToPlay() will actually have been called before
|
|
releaseResources(), and it may be called more than once in succession, so make sure your
|
|
code is robust and doesn't make any assumptions about when it will be called.
|
|
|
|
@see prepareToPlay, getNextAudioBlock
|
|
*/
|
|
virtual void releaseResources() = 0;
|
|
|
|
/** Called repeatedly to fetch subsequent blocks of audio data.
|
|
|
|
After calling the prepareToPlay() method, this callback will be made each
|
|
time the audio playback hardware (or whatever other destination the audio
|
|
data is going to) needs another block of data.
|
|
|
|
It will generally be called on a high-priority system thread, or possibly even
|
|
an interrupt, so be careful not to do too much work here, as that will cause
|
|
audio glitches!
|
|
|
|
@see AudioSourceChannelInfo, prepareToPlay, releaseResources
|
|
*/
|
|
virtual void getNextAudioBlock (const AudioSourceChannelInfo& bufferToFill) = 0;
|
|
|
|
void shutdownAudio();
|
|
|
|
|
|
AudioDeviceManager deviceManager;
|
|
|
|
private:
|
|
//==============================================================================
|
|
AudioSourcePlayer audioSourcePlayer;
|
|
|
|
JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (AudioAppComponent)
|
|
};
|
|
|
|
|
|
#endif // JUCE_AUDIOAPPCOMPONENT_H_INCLUDED
|
|
|