<?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="lores~" module="msp" category="MSP Filters">
	<digest>
		Resonant lowpass filter
	</digest>
	<description>
		<o>lores~</o> implements an inexpensive lowpass with an adjustment that lets you add a specified resonance. The middle inlet sets a kind of cutoff frequency, but the sharpness of the filter depends on the resonance passed in through the right inlet (0 is a little bit sharp and 1 as sharp as possible).
	</description>
	<!--METADATA-->
	<metadatalist>
		<metadata name="author">
			Cycling '74
		</metadata>
		<metadata name="tag">
			MSP
		</metadata>
		<metadata name="tag">
			MSP Filters
		</metadata>
	</metadatalist>
	<!--INLETS-->
	<inletlist>
		<inlet id="0" type="signal">
			<digest>
				(signal) Input
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
		<inlet id="1" type="signal/float">
			<digest>
				(signal/float) Cutoff Frequency
			</digest>
			<description>
				sets the cutoff frequency of the filter
			</description>
		</inlet>
		<inlet id="2" type="signal/float">
			<digest>
				(signal/float) Resonance Control (0-1)
			</digest>
			<description>
				sets the resonance value of the filter
			</description>
		</inlet>
	</inletlist>
	<!--OUTLETS-->
	<outletlist>
		<outlet id="0" type="signal">
			<digest>
				(signal) Output
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
	</outletlist>
	<!--ARGUMENTS-->
	<objarglist>
		<objarg name="cutoff" optional="1" type="number">
			<digest>
				Set the filter cutoff
			</digest>
			<description>
				A number sets the initial cutoff frequency. The default value is 0. If a signal is connected to the inlet, the argument corresponding to the inlet is ignored.
			</description>
		</objarg>
		<objarg name="resonance" optional="1" type="number">
			<digest>
				Set the filter resonance
			</digest>
			<description>
				A number sets the filter resonance. The default value is 0. If a signal is connected to the inlet, the argument corresponding to the inlet is ignored. A resonance of 0 is a little bit sharp and 1 is as sharp as possible.
			</description>
		</objarg>
	</objarglist>
	<!--MESSAGES-->
	<methodlist>
		<method name="int">
			<arglist>
				<arg name="cutoff-frequency/resonance" optional="0" type="int" />
			</arglist>
			<digest>
				Function depends on inlet
			</digest>
			<description>
				An <m>int</m> can be sent in the middle or right inlets to change the cutoff frequency or resonance. If a signal is connected one of the inlets, a number received in that inlet is ignored. A resonance of 0 is a little bit sharp and 1 is as sharp as possible.
			</description>
		</method>
		<method name="float">
			<arglist>
				<arg name="cutoff-frequency/resonance" optional="0" type="float" />
			</arglist>
			<digest>
				Function depends on inlet
			</digest>
			<description>
				<m>float</m> can be sent in the middle or right inlets to change the cutoff frequency or resonance. If a signal is connected one of the inlets, a number received in that inlet is ignored. A resonance of 0 is a little bit sharp and 1 is as sharp as possible.
			</description>
		</method>
		<method name="clear">
			<arglist />
			<digest>
				Clear the filter memory
			</digest>
			<description>
				Clears the filter's memory. Since <o>lores~</o> is a recursive filter, this message may be necessary to recover from blowups.
			</description>
		</method>
		<method name="signal">
			<arglist />
			<digest>
				Function depends on inlet
			</digest>
			<description>
				In left inlet: Any signal to be filtered.
				<br />
				<br />
				In middle inlet: Sets the lowpass filter cutoff frequency.
				<br />
				<br />
				In right inlet: Sets a &quot;resonance factor&quot; between 0 (minimum resonance) and 1 (maximum resonance). Values very close to 1 may produce clipping with certain types of input signals.
			</description>
		</method>
	</methodlist>
	<!--ATTRIBUTES-->
	<attributelist>
		<attribute name="cutoff" get="1" set="1" type="float" size="1">
			<digest>
				Sets the initial cutoff frequency.
			</digest>
			<description>
			</description>
			<attributelist>
				<attribute name="basic" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Cutoff Frequency" />
			</attributelist>
		</attribute>
		<attribute name="resonance" get="1" set="1" type="float" size="1">
			<digest>
				Sets the filter resonance. A resonance of 0 is a little bit sharp and 1 is as sharp as possible.
			</digest>
			<description>
			</description>
			<attributelist>
				<attribute name="basic" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Resonance" />
			</attributelist>
		</attribute>
	</attributelist>
	<!--EXAMPLE-->
	<examplelist>
		<example img="lores~.png" caption="Specify cutoff frequency and resonance of lowpass filter" />
	</examplelist>
	<!--SEEALSO-->
	<seealsolist>
		<seealso name="biquad~" />
		<seealso name="buffir~" />
		<seealso name="comb~" />
		<seealso name="cross~" />
		<seealso name="onepole~" />
		<seealso name="svf~" />
		<seealso name="reson~" />
		<seealso name="audio_filtering" module="core" type="vignette" />
	</seealsolist>
	<misc name="Output">
		<entry name="signal">
			<description>
				The filtered input signal. The equation of the filter is
				<br />
				<br />
				yn = scale * xn - c1 * yn-1 + c2 * yn-2
				<br />
				<br />
				where scale, c1, and c2 are parameters calculated from the cutoff frequency and resonance factor.
			</description>
		</entry>
	</misc>
</c74object>
