<?xml version="1.0" encoding="utf-8" standalone="yes"?>

<?xml-stylesheet href="./_c74_ref.xsl" type="text/xsl"?>

<!--This is an automatically generated file. DO NOT EDIT THIS FILE DIRECTLY. Rather, use the _ref.xml files found in the 'edits' folder.-->
<c74object name="overdrive~" module="msp" category="MSP Modifiers">
	<digest>
		Soft-clipping signal distortion
	</digest>
	<description>
		The <o>overdrive~</o> object uses a waveshaping function to distort audio signals. It amplifies signals, limiting the maximum value of the signal to +/- 1. Values outside of this range are removed using &quot;soft clipping&quot; somewhat like that of an overdriven tube-based circuit.
	</description>
	<!--METADATA-->
	<metadatalist>
		<metadata name="author">
			Cycling '74
		</metadata>
		<metadata name="tag">
			MSP
		</metadata>
		<metadata name="tag">
			MSP Modifiers
		</metadata>
	</metadatalist>
	<!--INLETS-->
	<inletlist>
		<inlet id="0" type="signal">
			<digest>
				(signal) Input signal, (float) Drive factor (1, 10)
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
		<inlet id="1" type="signal or float">
			<digest>
				(signal or float) Drive factor (1, 10)
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
	</inletlist>
	<!--OUTLETS-->
	<outletlist>
		<outlet id="0" type="OUTLET_TYPE">
			<digest>
				Signal Output
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
	</outletlist>
	<!--ARGUMENTS-->
	<objarglist>
		<objarg name="drive-factor" optional="1" type="float">
			<digest>
				Drive factor
			</digest>
			<description>
				A single number can be provided to set the drive factor. If no argument is provided, the drive factor is set to 1.0.
			</description>
		</objarg>
		<objarg name="drive-factor" optional="0" type="int">
			<digest>
				Drive factor
			</digest>
			<description>
				Integer inputs are converted to <m>float</m> and set the drive factor.
			</description>
		</objarg>
	</objarglist>
	<!--MESSAGES-->
	<methodlist>
		<method name="int">
			<arglist>
				<arg name="drive-factor" optional="0" type="int" />
			</arglist>
			<digest>
				Set the drive factor
			</digest>
			<description>
				Integer inputs are converted to <m>float</m> and set the drive factor. The drive factor should usually be in the range 1 - 10. Using a factor of 1 creates a linear response without distortion, and higher values increase the distortion. Values less than 1, including negative values, produce very heavily distorted signals. Use with caution.
			</description>
		</method>
		<method name="float">
			<arglist>
				<arg name="drive-factor" optional="0" type="float" />
			</arglist>
			<digest>
				Set the drive factor
			</digest>
			<description>
				In right inlet: The <o>overdrive~</o> object accepts a floating-point &quot;drive factor&quot;. The drive factor should usually be in the range 1.0-10.0. Using a factor of 1.0 creates a linear response without distortion, and higher values increase the distortion. Values less than 1, including negative values, produce very heavily distorted signals. Use with caution, this behavior was originally considered a bug until friends of the object's creator insisted that it should be considered a feature and left intact.)
			</description>
		</method>
		<method name="signal">
			<arglist />
			<digest>
				Function depends on inlet
			</digest>
			<description>
				In left inlet: the signal to be distorted.
				<br />
				<br />
				In right inlet: the drive factor as a signal value.
			</description>
		</method>
	</methodlist>
	<!--ATTRIBUTES-->
	<!--EXAMPLE-->
	<examplelist>
		<example img="overdrive~.png" caption="Waveshape a signal similar to an overdriven amplifier" />
	</examplelist>
	<!--SEEALSO-->
	<seealsolist>
		<seealso name="kink~" />
		<seealso name="lookup~" />
	</seealsolist>
	<misc name="Output">
		<entry name="signal">
			<description>
				The distorted signal.
			</description>
		</entry>
	</misc>
</c74object>
