AudioIO.cpp File Reference

#include "AudioIO.h"
#include "AudioIOExt.h"
#include "AudioIOListener.h"
#include "float_cast.h"
#include "DeviceManager.h"
#include <cfloat>
#include <math.h>
#include <stdlib.h>
#include <algorithm>
#include <numeric>
#include <optional>
#include <malloc.h>
#include "portaudio.h"
#include "pa_win_wasapi.h"
#include <wx/wxcrtvararg.h>
#include <wx/log.h>
#include <wx/time.h>
#include <wx/debug.h>
#include <wx/power.h>
#include "Channel.h"
#include "Meter.h"
#include "Mix.h"
#include "Resample.h"
#include "RingBuffer.h"
#include "Decibels.h"
#include "Prefs.h"
#include "Project.h"
#include "TransactionScope.h"
#include "RealtimeEffectManager.h"
#include "QualitySettings.h"
#include "BasicUI.h"
#include "Gain.h"

Include dependency graph for AudioIO.cpp:

Go to the source code of this file.

Classes
struct	AudioIoCallback::TransportState

Macros
#define	stackAllocate(T, count)   static_cast<T*>(alloca(count * sizeof(T)))

Functions
int	audacityAudioCallback (const void *inputBuffer, void *outputBuffer, unsigned long framesPerBuffer, const PaStreamCallbackTimeInfo *timeInfo, PaStreamCallbackFlags statusFlags, void *userData)
static PaSampleFormat	AudacityToPortAudioSampleFormat (sampleFormat format)
static void	DoSoftwarePlaythrough (constSamplePtr inputBuffer, sampleFormat inputFormat, unsigned inputChannels, float *outputBuffer, unsigned long len)
void	ClampBuffer (float *pBuffer, unsigned long len)

Variables
BoolSetting	SoundActivatedRecord { "/AudioIO/SoundActivatedRecord", false }

Macro Definition Documentation

stackAllocate

#define stackAllocate	(		T,
			count
	)		static_cast<T*>(alloca(count * sizeof(T)))

Definition at line 1956 of file AudioIO.cpp.

Function Documentation

audacityAudioCallback()

int audacityAudioCallback	(	const void *	inputBuffer,
		void *	outputBuffer,
		unsigned long	framesPerBuffer,
		const PaStreamCallbackTimeInfo *	timeInfo,
		PaStreamCallbackFlags	statusFlags,
		void *	userData
	)

brief The function which is called from PortAudio's callback thread context to collect and deliver audio for / from the sound device.

This covers recording, playback, and doing both simultaneously. It is also invoked to do monitoring and software playthrough. Note that dealing with the two buffers needs some care to ensure that the right things happen for all possible cases.

Parameters

inputBuffer	Buffer of length framesPerBuffer containing samples from the sound card, or null if not capturing audio. Note that the data type will depend on the format of audio data that was chosen when the stream was created (so could be floats or various integers)
outputBuffer	Uninitialised buffer of length framesPerBuffer which will be sent to the sound card after the callback, or null if not playing audio back.
framesPerBuffer	The length of the playback and recording buffers
PaStreamCallbackTimeInfo	Pointer to PortAudio time information structure, which tells us how long we have been playing / recording
statusFlags	PortAudio stream status flags
userData	pointer to user-defined data structure. Provided for flexibility by PortAudio, but not used by Audacity - the data is stored in the AudioIO class instead.

Definition at line 2617 of file AudioIO.cpp.

{
   auto gAudioIO = AudioIO::Get();
   return gAudioIO->AudioCallback(
      static_cast<constSamplePtr>(inputBuffer),
      static_cast<float*>(outputBuffer), framesPerBuffer,
      timeInfo, statusFlags, userData);
}

References AudioIO::Get().

Referenced by AudioIO::StartPortAudioStream().

Here is the call graph for this function:

Here is the caller graph for this function:

AudacityToPortAudioSampleFormat()

static PaSampleFormat AudacityToPortAudioSampleFormat ( sampleFormat  format )

static

Definition at line 460 of file AudioIO.cpp.

{
   switch(format) {
   case int16Sample:
      return paInt16;
   case int24Sample:
      return paInt24;
   case floatSample:
   default:
      return paFloat32;
   }
}

References floatSample, anonymous_namespace{ExportPCM.cpp}::format, int16Sample, and int24Sample.

Referenced by AudioIO::StartPortAudioStream().

Here is the caller graph for this function:

ClampBuffer()

void ClampBuffer	(	float *	pBuffer,
		unsigned long	len
	)

Definition at line 2663 of file AudioIO.cpp.

                                                    {
   for(unsigned i = 0; i < len; i++)
      pBuffer[i] = std::clamp(pBuffer[i], -1.0f, 1.0f);
};

Referenced by AudioIoCallback::FillOutputBuffers().

Here is the caller graph for this function:

DoSoftwarePlaythrough()

static void DoSoftwarePlaythrough ( constSamplePtr  inputBuffer, sampleFormat  inputFormat, unsigned  inputChannels, float *  outputBuffer, unsigned long  len  )

static

Definition at line 2598 of file AudioIO.cpp.

{
   for (unsigned int i=0; i < inputChannels; i++) {
      auto inputPtr = inputBuffer + (i * SAMPLE_SIZE(inputFormat));
 
      SamplesToFloats(inputPtr, inputFormat,
         outputBuffer + i, len, inputChannels, 2);
   }
 
   // One mono input channel goes to both output channels...
   if (inputChannels == 1)
      for (int i=0; i < len; i++)
         outputBuffer[2*i + 1] = outputBuffer[2*i];
}

References SAMPLE_SIZE, and SamplesToFloats().

Referenced by AudioIoCallback::DoPlaythrough().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

SoundActivatedRecord

BoolSetting SoundActivatedRecord { "/AudioIO/SoundActivatedRecord", false }

Definition at line 3370 of file AudioIO.cpp.

Referenced by RecordingPrefs::Commit(), anonymous_namespace{PluginMenus.cpp}::OnResetConfig(), anonymous_namespace{TransportMenus.cpp}::OnToggleSoundActivated(), anonymous_namespace{HelpMenus.cpp}::QuickFixDialog::PopulateOrExchange(), RecordingPrefs::PopulateOrExchange(), AudioIO::StartStream(), and anonymous_namespace{TransportMenus.cpp}::TransportMenu().