<?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="buffir~" module="msp" category="MSP Filters">
	<digest>
		buffer-based FIR filter
	</digest>
	<description>
		Use <o>buffir~</o> object when you need a finite impulse response (FIR) filter that convolves an input signal with samples from an input buffer.
	</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="int/float/sig">
			<digest>
				(int/float/sig) Begin (samples)
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
		<inlet id="2" type="int/float/sig">
			<digest>
				(int/float/sig) Length (samples)
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
	</inletlist>
	<!--OUTLETS-->
	<outletlist>
		<outlet id="0" type="signal">
			<digest>
				(signal) Output
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
	</outletlist>
	<!--ARGUMENTS-->
	<objarglist>
		<objarg name="buffer-name" optional="0" type="symbol">
			<digest>
				Buffer name
			</digest>
			<description>
				The name of a <o>buffer~</o> object which <o>buffir~</o> uses to filter the input signal.
			</description>
		</objarg>
		<objarg name="read-offset" optional="1" units="samples" type="int or float">
			<digest>
				Buffer read offset
			</digest>
			<description>
				The offset, in samples, into the <o>buffer~</o> object before <o>buffir~</o> begins reading samples to construct the filter. The default is 0.
			</description>
		</objarg>
		<objarg name="read-duration" optional="1" units="samples" type="int or float">
			<digest>
				Size of input buffer to use when filtering
			</digest>
			<description>
				The size, in samples, of the slice in the <o>buffer~</o> which <o>buffir~</o> will use for the filter. The default is 0, and the maximum is 4096.
			</description>
		</objarg>
	</objarglist>
	<!--MESSAGES-->
	<methodlist>
		<method name="int">
			<arglist>
				<arg name="read-offset" optional="0" units="samples" type="int" />
			</arglist>
			<digest>
				Function depends on inlet
			</digest>
			<description>
				In middle inlet: The offset into the filter <o>buffer~</o> from which <o>buffir~</o> begins to read, in samples.
				<br />
				<br />
				In right inlet: The size (in samples) of the slice from the <o>buffer~</o> which is used to filter the input signal (the maximum is 4096).
			</description>
		</method>
		<method name="float">
			<arglist>
				<arg name="read-offset" optional="0" units="samples" type="float" />
			</arglist>
			<digest>
				Function depends on inlet
			</digest>
			<description>
				In middle inlet: The offset into the filter <o>buffer~</o> from which <o>buffir~</o> begins to read, in samples.
				<br />
				<br />
				In right inlet: The size (in samples) of the slice from the <o>buffer~</o> which is used to filter the input signal (the maximum is 4096).
			</description>
		</method>
		<method name="clear">
			<arglist />
			<digest>
				Clear the filter input history
			</digest>
			<description>
				The word <m>clear</m> erases (zeroes) the current input history for the filter.
			</description>
		</method>
		<method name="(mouse)">
			<digest>
				TEXT_HERE
			</digest>
			<description>
				TEXT_HERE
			</description>
		</method>
		<method name="set">
			<arglist>
				<arg name="buffer-name" optional="0" type="symbol" />
				<arg name="read-offset" optional="0" units="samples" type="int" />
				<arg name="read-duration" optional="1" units="samples" type="int" />
			</arglist>
			<digest>
				Specify the <o>buffer~</o> object used to filter the input signal
			</digest>
			<description>
				The word <m>set</m>, followed by the name of a <o>buffer~</o> object, an int which specifies sample offset, and an optional int which specifies a number of samples, specifies the name of a <o>buffer~</o> object which <o>buffir~</o> uses to filter its input signal.
			</description>
		</method>
		<method name="signal">
			<arglist />
			<digest>
				Function depends on inlet
			</digest>
			<description>
				In left inlet: The signal to be convolved with samples from the <o>buffer~</o>.				<br />
				<br />
				In middle inlet: The offset (in samples) into the filter <o>buffer~</o> from which the <o>buffir~</o> object begins to read.
				<br />
				<br />
				In right inlet: The size of the slice from the filter <o>buffer~</o> which is used to filter the input signal, in samples. The maximum is 4096.
			</description>
		</method>
	</methodlist>
	<!--ATTRIBUTES-->
	<!--EXAMPLE-->
	<examplelist>
		<example img="buffir~.png" caption="buffir~ lets you use slices of a buffer~ as an impulse response for an FIR filter" />
	</examplelist>
	<!--SEEALSO-->
	<seealsolist>
		<seealso name="biquad~" />
		<seealso name="buffer~" />
		<seealso name="cascade~" />
		<seealso name="audio_filtering" module="core" type="vignette" />
	</seealsolist>
	<misc name="Output">
		<entry name="signal">
			<description>
				The filtered signal, based on a convolution of the input signal with samples in the <o>buffer~</o>.
			</description>
		</entry>
	</misc>
</c74object>
