adopt language guidance from the INCITS Inclusive Terminology Guidelines

Author: sophiapoirier

README.md

@@ -26,7 +26,7 @@ distribute the source package in order to be in compliance with the
 license (see the file COPYING for full license terms).
 
 This software comes with no warranty (see the file COPYING). In fact,
-it is likely that some of these crazy effects could crash hosts (by
+it is likely that some of these unusual effects could crash hosts (by
 sending out-of-range samples or taking too much time to process), so
 you should be careful to save your work when using them in important
 songs. Tom uses Cakewalk on the PC, and Sophia uses Logic on the Mac,
@@ -75,7 +75,7 @@ features the possibility for extreme settings and MIDI control.
 
 ### geometer/
 
-A laboratory for waveform geometry. All sorts of crazy effects are
+A laboratory for waveform geometry. All sorts of weird effects are
 possible with this thing, and sports a neat visual display of what's
 happening to your sound.
 
@@ -138,7 +138,7 @@ testing:
 ### brokenfft/
 
 One of Tom's favorite plugins; this converts to the frequency domain
-using the FFT, and then does a number of crazy effects. It has an
+using the FFT, and then does a number of unusual effects. It has an
 almost limitless variety of sounds that will come out of it...
 
 

dfx-library/dfx-au-utilities-preset-files.m

@@ -514,10 +514,10 @@ CFPropertyListRef CreatePropertyListFromXMLFile(CFURLRef inXMLFileURL, SInt32* o
 	CFErrorRef error = NULL;
 
 	// allow a null input for outErrorCode, and just point it to something, for safety
-	SInt32 dummyErrorCode;
+	SInt32 ignoredErrorCode = 0;
 	if (outErrorCode == NULL)
 	{
-		outErrorCode = &dummyErrorCode;
+		outErrorCode = &ignoredErrorCode;
 	}
 	*outErrorCode = noErr;
 
@@ -569,11 +569,11 @@ SInt32 GetDictionarySInt32Value(CFDictionaryRef inAUStateDictionary, CFStringRef
 {
 	CFNumberRef cfNumber = NULL;
 	SInt32 numberValue = 0;
-	Boolean dummySuccess;
+	Boolean ignoredSuccess = false;
 
 	if (outSuccess == NULL)
 	{
-		outSuccess = &dummySuccess;
+		outSuccess = &ignoredSuccess;
 	}
 	if ((inAUStateDictionary == NULL) || (inDictionaryKey == NULL))
 	{
@@ -703,9 +703,9 @@ OSStatus SaveAUStateToPresetFile_Bundle(AudioComponentInstance inAUComponentInst
 {
 	OSStatus status = noErr;
 
-	HFSUniStr255 dummyUniName;
 	// get the absolute maximum length that a file name can be
-	size_t const maxUnicodeNameLength = sizeof(dummyUniName.unicode) / sizeof(UniChar);
+	HFSUniStr255 const placeholderUniName;
+	size_t const maxUnicodeNameLength = sizeof(placeholderUniName.unicode) / sizeof(UniChar);
 	// this is how much longer the file name will be after the AU preset file name extension is appended
 	CFIndex const presetFileNameExtensionLength = CFStringGetLength(kAUPresetFileNameExtension) + 1;  // +1 for the period before the extension
 	// this is the maximum allowable length of the preset file's name without the extension

dfx-library/dfxmidi.cpp

@@ -482,7 +482,7 @@ void DfxMidi::setLegatoMode(bool inEnable)
 	if (std::exchange(mLegatoMode, inEnable) != inEnable)
 	{
 		// if we have just entered legato mode, we must end any active notes so that 
-		// they don't hang in legato mode (which ignores note-offs)
+		// they don't remain stuck in legato mode (which ignores note-offs)
 		if (inEnable)
 		{
 			for (int noteIndex = 0; noteIndex < kNumNotes; noteIndex++)
@@ -598,8 +598,9 @@ bool DfxMidi::incNumEvents()
 	// TODO: actually truncating capacity by one event because of the way that events are added, could be fixed
 	if (mNumBlockEvents >= static_cast<long>(mBlockEvents.size()))
 	{
+		// revert and bail
 		mNumBlockEvents = static_cast<long>(mBlockEvents.size()) - 1;
-		return false;  // ! abort !
+		return false;
 	}
 	return true;  // successful increment
 }

dfx-library/dfxmisc.cpp

@@ -106,7 +106,7 @@ size_t StrlCat(char* buf, std::string_view appendme, size_t maxlen)
 }
 
 //------------------------------------------------------
-// adapted from Darwin https://github.com/apple/darwin-xnu/blob/master/osfmk/arm/strlcpy.c
+// adapted from Darwin https://github.com/apple/darwin-xnu/blob/main/osfmk/arm/strlcpy.c
 size_t StrLCpy(char* dst, std::string_view src, size_t maxlen)
 {
 	if ((src.size() + 1) < maxlen)

dfx-library/dfxplugin-audiounit.cpp

@@ -1048,8 +1048,8 @@ OSStatus DfxPlugin::GetParameterInfo(AudioUnitScope inScope,
 	// then make sure to only copy as much as the ParameterInfo name C string can hold
 	strlcpy(outParameterInfo.name, getparametername(inParameterID).c_str(), std::size(outParameterInfo.name));
 	// in case the parameter name was dfx::kParameterNameMaxLength or longer, 
-	// make sure that the ParameterInfo name string is terminated
-	outParameterInfo.name[sizeof(outParameterInfo.name) - 1] = 0;
+	// make sure that the ParameterInfo name string is nul-terminated
+	outParameterInfo.name[sizeof(outParameterInfo.name) - 1] = '\0';
 	//
 	outParameterInfo.cfNameString = getparametercfname(inParameterID);
 	outParameterInfo.minValue = getparametermin_f(inParameterID);
@@ -1449,7 +1449,7 @@ OSStatus DfxPlugin::SaveState(CFPropertyListRef* outData)
 OSStatus DfxPlugin::RestoreState(CFPropertyListRef inData)
 {
 	auto const status = TARGET_API_BASE_CLASS::RestoreState(inData);
-	// abort if the base implementation of RestoreState failed
+	// bail if the base implementation of RestoreState failed
 	if (status != noErr)
 	{
 		return status;

dfx-library/dfxplugin-base.h

@@ -115,7 +115,7 @@ To contact the author, use the contact form at http://destroyfx.org/
 // end of target API check
 
 
-// Now, sanity check defines. 
+// Now, consistency check defines. 
 
 // Some preprocessor defines are meant to be used with "ifdef" (TARGET_API_*)
 // and others are meant to be defined to 1/0. Test that these are configured
@@ -224,8 +224,8 @@ enum
 constexpr long kParameterShortNameMax_RTAS = 4;  // XXX hack (this just happens to be what I've been doing)
 constexpr long kParameterValueShortNameMax_RTAS = 6;  // XXX hack
 
-constexpr long kParameterID_RTASMasterBypass = 1;
-constexpr long kParameterID_RTASOffset = kParameterID_RTASMasterBypass + 1;
+constexpr long kParameterID_RTASGlobalBypass = 1;
+constexpr long kParameterID_RTASOffset = kParameterID_RTASGlobalBypass + 1;
 //-----------------------------------------------------------------------------
 constexpr long ParameterID_ToRTAS(long inParameterID)
 {

dfx-library/dfxplugin-rtas.cpp

@@ -144,10 +144,10 @@ void DfxPlugin::DoTokenIdle()
 //-----------------------------------------------------------------------------
 void DfxPlugin::AddParametersToList()
 {
-	constexpr OSType masterBypassFourCharID = 'bypa';
+	constexpr OSType globalBypassFourCharID = FOURCC('b', 'y', 'p', 'a');
 
-	AddControl(new CPluginControl_OnOff(masterBypassFourCharID, "Master Bypass\nM Bypass\nMByp\nByp", false, true));
-	DefineMasterBypassControlIndex(dfx::kParameterID_RTASMasterBypass);
+	AddControl(new CPluginControl_OnOff(globalBypassFourCharID, "Global Bypass\nG Bypass\nGByp\nByp", false, true));
+	DefineMasterBypassControlIndex(dfx::kParameterID_RTASGlobalBypass);
 
 	OSType paramFourCharID = 0;
 	for (long i = 0; i < getnumparameters(); i++)
@@ -162,9 +162,11 @@ void DfxPlugin::AddParametersToList()
 		auto const paramName = getparametername(i);
 
 		paramFourCharID = DFX_IterateAlphaNumericFourCharCode(paramFourCharID);
-		// make sure to skip over the ID already used for master bypass
-		if (paramFourCharID == masterBypassFourCharID)
+		// make sure to skip over the ID already used for global bypass
+		if (paramFourCharID == globalBypassFourCharID)
+		{
 			paramFourCharID = DFX_IterateAlphaNumericFourCharCode(paramFourCharID);
+		}
 		bool const paramAutomatable = (getparameterattributes(i) & (DfxParam::kAttribute_Hidden | DfxParam::kAttribute_Unused)) ? false : true;
 		constexpr int numCurvedSteps = 1000;
 		double const stepSize_default = (paramMax_f - paramMin_f) / (double)numCurvedSteps;
@@ -262,7 +264,7 @@ ComponentResult DfxPlugin::GetControlNameOfLength(long inParameterIndex, char *
 	if (inNameLength <= dfx::kParameterShortNameMax_RTAS)
 	{
 		char * shortNameString = NULL;
-		if (inParameterIndex == dfx::kParameterID_RTASMasterBypass)
+		if (inParameterIndex == dfx::kParameterID_RTASGlobalBypass)
 			shortNameString = "Bypass";	// any shortened version of this is fine
 		else
 			shortNameString = GetParameterShortName( dfx::ParameterID_FromRTAS(inParameterIndex) );
@@ -306,9 +308,9 @@ ComponentResult DfxPlugin::GetValueString(long inParameterIndex, long inValue, S
 //-----------------------------------------------------------------------------
 void DfxPlugin::UpdateControlValueInAlgorithm(long inParameterIndex)
 {
-	if (inParameterIndex == dfx::kParameterID_RTASMasterBypass)
+	if (inParameterIndex == dfx::kParameterID_RTASGlobalBypass)
 	{
-		mMasterBypass_rtas = dynamic_cast<CPluginControl_Discrete*>(GetControl(inParameterIndex))->GetDiscrete();
+		mGlobalBypass_rtas = dynamic_cast<CPluginControl_Discrete*>(GetControl(inParameterIndex))->GetDiscrete();
 		return;
 	}
 
@@ -363,7 +365,7 @@ ComponentResult DfxPlugin::IsControlAutomatable(long inControlIndex, short * out
 		return paramErr;
 
 	// XXX test this first, since dfx::ParameterID_FromRTAS() makes it an invalid ID
-	if (inControlIndex == dfx::kParameterID_RTASMasterBypass)
+	if (inControlIndex == dfx::kParameterID_RTASGlobalBypass)
 	{
 		*outItIs = 1;
 		return noErr;
@@ -439,7 +441,7 @@ ComponentResult DfxPlugin::SetChunk(OSType inChunkID, SFicPlugInChunk * chunk)
 
 #ifdef TARGET_API_AUDIOSUITE
 //-----------------------------------------------------------------------------
-UInt32 DfxPlugin::ProcessAudio(bool inIsMasterBypassed)
+UInt32 DfxPlugin::ProcessAudio(bool inIsGlobalBypassed)
 {
 	if (!IsAS())
 	{
@@ -478,7 +480,7 @@ UInt32 DfxPlugin::ProcessAudio(bool inIsMasterBypassed)
 				mInputAudioStreams_as[ch] = mZeroAudioBuffer.data();
 			}
 
-			if (inIsMasterBypassed)
+			if (inIsGlobalBypassed)
 			{
 				for (long i = 0; i < totalInputSamples; i++)
 					mOutputAudioStreams_as[ch][i] = mInputAudioStreams_as[ch][i];
@@ -490,8 +492,10 @@ UInt32 DfxPlugin::ProcessAudio(bool inIsMasterBypassed)
 		}
 	}
 
-	if (!inIsMasterBypassed)
+	if (!inIsGlobalBypassed)
+	{
 		RenderAudio(mInputAudioStreams_as.data(), mOutputAudioStreams_as.data(), totalInputSamples);
+	}
 
 	// Get the current number of samples analyzed and pass this info 
 	// back to the DAE application so it knows how much we've processed.  
@@ -539,7 +543,7 @@ void DfxPlugin::RenderAudio(float ** inAudioStreams, float ** outAudioStreams, l
 		{
 			continue;
 		}
-		if (mMasterBypass_rtas)
+		if (mGlobalBypass_rtas)
 		{
 			SInt32 const inputChannelIndex = (GetNumInputs() < GetNumOutputs()) ? (GetNumInputs() - 1) : channel;
 			std::copy_n(mInputAudioStreams[inputChannelIndex], dfx::math::ToIndex(inNumFramesToProcess), outAudioStreams[channel]);
@@ -568,7 +572,7 @@ void DfxPlugin::RenderAudio(float ** inAudioStreams, float ** outAudioStreams, l
 		}
 	}
 #if !TARGET_PLUGIN_USES_DSPCORE
-	if (!mMasterBypass_rtas)
+	if (!mGlobalBypass_rtas)
 	{
 		processaudio(const_cast<float const* const*>(mInputAudioStreams.data()), const_cast<float* const*>(outAudioStreams), (unsigned)inNumFramesToProcess);
 	}
@@ -781,11 +785,15 @@ void DfxPlugin::ProcessDoIdle()
 //-----------------------------------------------------------------------------
 ComponentResult DfxPlugin::SetControlHighliteInfo(long inControlIndex, short inIsHighlighted, short inColor)
 {
-	if (inControlIndex == dfx::kParameterID_RTASMasterBypass)
+	if (inControlIndex == dfx::kParameterID_RTASGlobalBypass)
+	{
 		CProcess::SetControlHighliteInfo(inControlIndex, inIsHighlighted, inColor);
+	}
 
 	if (mCustomUI_p)
+	{
 		mCustomUI_p->SetControlHighlight(inControlIndex, inIsHighlighted, inColor);
+	}
 
 	return noErr;
 }

dfx-library/dfxplugin-vst.cpp

@@ -410,7 +410,7 @@ bool DfxPlugin::getParameterProperties(VstInt32 index, VstParameterProperties* p
 	*properties = {};
 
 	// note that kVstMax* are specified as "number of characters excluding the null terminator", 
-	// and vst_strncpy behaves accordingly and terminates at array[N], however the static arrays 
+	// and vst_strncpy behaves accordingly and writes null at array[N], however the static arrays 
 	// in struct types (like VstParameterProperties here) size the arrays by N, meaning that 
 	// array[N] is out of range, so we call vst_strncpy in these cases passing N-1 as max length
 	vst_strncpy(properties->label, getparametername(index).c_str(), kVstMaxLabelLen - 1);

dfx-library/dfxplugin.h

@@ -878,7 +878,7 @@ class DfxPlugin : public TARGET_API_BASE_CLASS
 
 #ifdef TARGET_API_RTAS
 	void AddParametersToList();
-	bool mMasterBypass_rtas = false;
+	bool mGlobalBypass_rtas = false;
 	std::vector<float*> mInputAudioStreams_as;
 	std::vector<float*> mOutputAudioStreams_as;
 	std::vector<float> mZeroAudioBuffer;
@@ -1107,7 +1107,7 @@ class DfxPlugin : public TARGET_API_BASE_CLASS
 #ifdef TARGET_API_RTAS
 	void EffectInit() override;
 #ifdef TARGET_API_AUDIOSUITE
-	UInt32 ProcessAudio(bool inIsMasterBypassed) override;
+	UInt32 ProcessAudio(bool inIsGlobalBypassed) override;
 #endif
 	void RenderAudio(float** inAudioStreams, float** outAudioStreams, long inNumFramesToProcess) override;
 #endif

dfx-library/dfxsettings.cpp

@@ -303,8 +303,8 @@ bool DfxSettings::restore(void const* inData, size_t inBufferSize, bool inIsPres
 			crisisFlags = crisisFlags | kCrisisReasonFlag_MorePresets;
 		}
 	}
-	// handle the crisis situations (if any) and abort loading if we're told to
-	if (handleCrisis(crisisFlags) == CrisisError::AbortError)
+	// handle the crisis situations (if any) and stop trying to load if we're told to
+	if (handleCrisis(crisisFlags) == CrisisError::QuitError)
 	{
 		return false;
 	}
@@ -1141,12 +1141,12 @@ void DfxSettings::assignParam(long inParamTag, dfx::MidiEventType inEventType, l
 							  long inEventNum2, dfx::MidiEventBehaviorFlags inEventBehaviorFlags, 
 							  long inDataInt1, long inDataInt2, float inDataFloat1, float inDataFloat2)
 {
-	// abort if the parameter index is not valid
+	// bail if the parameter index is not valid
 	if (!paramTagIsValid(inParamTag))
 	{
 		return;
 	}
-	// abort if inEventNum is not a valid MIDI value
+	// bail if inEventNum is not a valid MIDI value
 	if ((inEventNum < 0) || (inEventNum > DfxMidi::kMaxValue))
 	{
 		return;
@@ -1459,7 +1459,7 @@ DfxSettings::CrisisError DfxSettings::handleCrisis(CrisisReasonFlags inFlags)
 			return CrisisError::NoError;
 
 		case CrisisBehavior::DontLoad:
-			return CrisisError::AbortError;
+			return CrisisError::QuitError;
 
 		case CrisisBehavior::LoadButComplain:
 			crisisAlert(inFlags);

dfx-library/dfxsettings.h

@@ -182,8 +182,8 @@ class DfxSettings
 	// - - - - - - - - - version compatibility management - - - - - - - - -
 
 	// if you set this to something and data is received during restore()
-	// which has a version number in its header that's lower than this, 
-	// then loading will abort
+	// which has a version number in its header that is lower than this, 
+	// then loading will fail
 	void setLowestLoadableVersion(long inVersion) noexcept
 	{
 		mSettingsInfo.mLowestLoadableVersion = inVersion;
@@ -305,7 +305,7 @@ class DfxSettings
 	{
 		// crisis-handling errors
 		NoError,
-		AbortError,
+		QuitError,
 		ComplainError,
 		FailedCrashError
 	};

dfxgui/dfxgui-fontfactory.cpp

@@ -124,7 +124,7 @@ std::optional<std::string> InstallFontWin32(const char *resource_name) {
     return {};
   }
   if (bytes_written != rsize) {
-    // (Sanity checking; WriteFile should have returned false.)
+    // (Consistency checking; WriteFile should have returned false.)
     return {};
   }
 
@@ -220,7 +220,7 @@ class FFImpl : public FontFactory {
     // Register any fonts located within our plugin bundle resources.
     // The registration occurs locally for the process, and thus need
     // only occur once and requires no clean up, as that will happen
-    // automatically upon process termination.  All current and future
+    // automatically upon process exit.  All current and future
     // instances of the plugin in that process will have access to the
     // fonts registered here.
     static std::once_flag once;

dfxgui/dfxguitextdisplay.cpp

@@ -247,7 +247,7 @@ bool DGTextDisplay::valueToTextProc_LinearToDb(float inValue, char outTextUTF8[]
 
 	auto const decibelValue = dfx::math::Linear2dB(inValue);
 	auto precisionOffset = reinterpret_cast<intptr_t>(inPrecisionOffset);  // HACK :(
-	precisionOffset = (std::abs(precisionOffset) > 15) ? 0 : precisionOffset;  // sanity check to avert misuse with actual pointer
+	precisionOffset = (std::abs(precisionOffset) > 15) ? 0 : precisionOffset;  // reasonable range check to avert misuse with actual pointer
 	auto const prefix = (decibelValue >= (0.01f / std::pow(10.f, precisionOffset))) ? "+" : "";
 	int precision = (std::fabs(decibelValue) >= 100.0f) ? 0 : ((std::fabs(decibelValue) >= 10.0f) ? 1 : 2);
 	precision = std::max(precision + static_cast<int>(precisionOffset), 0);