<?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="cascade~" module="msp" category="MSP Filters">
	<digest>
		Cascaded series of biquad filters
	</digest>
	<description>
		Use the <o>cascade~</o> to filter an input signal using a series of biquad filters.
	</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) signal to be filtered
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
		<inlet id="1" type="signal">
			<digest>
				(signal) list of filter coefficients
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
	</inletlist>
	<!--OUTLETS-->
	<outletlist>
		<outlet id="0" type="signal">
			<digest>
				(signal) filtered signal out
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
	</outletlist>
	<!--ARGUMENTS-->
	<objarglist>
		<objarg id="0" name="OBJARG_NAME" type="OBJARG_TYPE" optional="0">
			<digest>
				TEXT_HERE
			</digest>
			<description>
				TEXT_HERE
			</description>
		</objarg>
	</objarglist>
	<!--MESSAGES-->
	<methodlist>
		<method name="list">
			<arglist>
				<arg name="filter-coefficients" optional="0" type="list" />
			</arglist>
			<digest>
				Set the filter coefficients using sets of five biquad coefficients
			</digest>
			<description>
				In right inlet: The filter coefficients can be provided as a <m>list</m> in the left inlet. The coefficients should be in sets of five, each set corresponding to a second-order section or biquad. The first five coefficients in the <m>list</m> are used for the first second-order section in the series, the next five for the second, and so on.
			</description>
		</method>
		<method name="dictionary">
			<arglist>
				<arg name="dictionary-name" optional="0" type="symbol" />
			</arglist>
			<digest>
				Use a <o>filterdesign</o> dictionary's filter coefficients
			</digest>
			<description>
				The word <m>dictionary</m>, followed by a symbol that references a named <o>filterdesign</o> object dictionary (set via the <m>name</m> attribute), will cause the <o>cascade~</o> object to use the dictionary values for filter coefficients.
			</description>
		</method>
		<method name="clear">
			<arglist />
			<digest>
				Reset all filter coefficients and sample memory
			</digest>
			<description>
				Resets all coefficients and sample-memory to 0.
			</description>
		</method>
		<method name="bypass">
			<arglist>
				<arg name="operational-flag" optional="0" type="int" />
			</arglist>
			<digest>
				Bypass the filter and output a dry signal
			</digest>
			<description>
				The word <m>bypass</m> followed by a nonzero number will turn bypass mode on and cause the dry unfiltered signal to pass through to the object's outlet; followed by a 0 will output the filtered signal.
			</description>
		</method>
		<method name="signal">
			<arglist />
			<digest>
				Signal to be filtered
			</digest>
			<description>
				In left inlet: Signal to be filtered. The signal is filtered by a series of two-pole two-zero (i.e. biquad) filters, often referred to as &quot;second order sections&quot;.
			</description>
		</method>
		<method name="zero">
			<arglist>
				<arg name="operational-flag" optional="0" type="int" />
			</arglist>
			<digest>
				Mute the filtered signal
			</digest>
			<description>
				The word <m>zero</m> followed by a nonzero number will cause the filtered signal to be muted; followed by a 0 will output the filtered signal (this will not prevent the unfiltered signal from appearing at the outlet when bypass mode is turned on).
			</description>
		</method>
	</methodlist>
	<!--ATTRIBUTES-->
	<!--EXAMPLE-->
	<examplelist>
		<example img="cascade~.png" caption="Use cascade~ with filtergraph~ in multi-filter mode to efficiently process a complex parametric filter" />
	</examplelist>
	<!--SEEALSO-->
	<seealsolist>
		<seealso name="biquad~" />
		<seealso name="buffir~" />
		<seealso name="comb~" />
		<seealso name="filtergraph~" />
		<seealso name="lores~" />
		<seealso name="onepole~" />
		<seealso name="reson~" />
		<seealso name="teeth~" />
		<seealso name="audio_filtering" module="core" type="vignette" />
	</seealsolist>
	<misc name="Output">
		<entry name="signal">
			<description>
				The filtered signal.
			</description>
		</entry>
	</misc>
</c74object>
