<?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="pitchshift~" module="" category="">
	<digest>
		Ztx-based real-time pitchshifting
	</digest>
	<description>
		Use the <o>pitchshift~</o> object to load a perform pitch-shifting on an input signal.
	</description>
	<!--METADATA-->
	<metadatalist>
		<metadata name="author">
			Cycling '74
		</metadata>
		<metadata name="tag">
			TEXT_HERE
		</metadata>
	</metadatalist>
	<!--INLETS-->
	<inletlist>
		<inlet id="0" type="Signal">
			<digest>
				original signal, channel: 1
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
		<inlet id="1" type="Signal">
			<digest>
				Pitchshift factor (int or float)
			</digest>
			<description>
				A signal value can be used to specify pitchshift as a factor of the original pitch (i.e. 2.0 = doubling of pitch, .5 = halving of the original pitch, etc.).
			</description>
		</inlet>
	</inletlist>
	<!--OUTLETS-->
	<outletlist>
		<outlet id="0" type="Signal">
			<digest>
				pitchshifted signal, channel: 1
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
		<outlet id="1" type="Signal">
			<digest>
				Current latency, reported in samples
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
	</outletlist>
	<!--ARGUMENTS-->
	<objarglist>
		<objarg id="0" name="channels" type="int" optional="1">
			<digest>
				Number of audio channels
			</digest>
			<description>
				An optional argument can be used to specify the number of channels of the signal to be processed (default = 1).
			</description>
		</objarg>
	</objarglist>
	<!--MESSAGES-->
	<methodlist>
		<method name="getlatency">
			<arglist />
			<digest>
				Toggle latency reporting
			</digest>
			<description>
				The word <m>getlatency</m>, followed by a zero or one, toggles reporting the latency, in samples, introduced by the <o>pitchshift~</o> object's calculations. Latency is output from the object's right-hand outlet in the form of a message in the form <m>latency [number-of-samples]</m>.
			</description>
		</method>
		<method name="signal">
			<arglist />
			<digest>
				The pitch of signal(s) in the left input(s) will be shifted. A signal in the rightmost inlet defines the shifting as a factor of the original pitch or in cents (when <m>usecents</m> is enabled).
			</digest>
			<description>
				TEXT_HERE
			</description>
		</method>
	</methodlist>
	<!--ATTRIBUTES-->
	<attributelist>
		<attribute name="enabled" get="1" set="1" type="int" size="1">
			<digest>
				Turn on pitchshift
			</digest>
			<description>
				Enable or disable pitchshifting.
			</description>
			<attributelist>
				<attribute name="category" get="1" set="1" type="symbol" size="1" value="Pitchshifting" />
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Turn on pitchshift" />
				<attribute name="save" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="style" get="1" set="1" type="symbol" size="1" value="onoff" />
			</attributelist>
		</attribute>
		<attribute name="pitchshift" get="1" set="1" type="float" size="1">
			<digest>
				Pitch Shifting Factor
			</digest>
			<description>
				Set the pitchshifting as a factor of the original pitch (i.e. 2.0 = doubling of pitch, .5 = halving of the original pitch, etc.).
			</description>
			<attributelist>
				<attribute name="category" get="1" set="1" type="symbol" size="1" value="Pitchshifting" />
				<attribute name="default" get="1" set="1" type="float" size="1" value="1." />
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Pitch Shifting Factor" />
				<attribute name="save" get="1" set="1" type="int" size="1" value="1" />
			</attributelist>
		</attribute>
		<attribute name="pitchshiftcent" get="1" set="1" type="int" size="1">
			<digest>
				Pitch Shifting in Cents
			</digest>
			<description>
				Set the amount of pitchshift as positive or negative cent values (i.e. 100 = semitone up, -1200 = octave down). Cents may be specified as ints or floats.
			</description>
			<attributelist>
				<attribute name="category" get="1" set="1" type="symbol" size="1" value="Pitchshifting" />
				<attribute name="default" get="1" set="1" type="int" size="1" value="0" />
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Pitch Shifting in Cents" />
				<attribute name="save" get="1" set="1" type="int" size="1" value="1" />
			</attributelist>
		</attribute>
		<attribute name="quality" get="1" set="1" type="int" size="1">
			<digest>
				Quality
			</digest>
			<description>
				Pitch shifting output quality.
				<br />
			</description>
			<attributelist>
				<attribute name="category" get="1" set="1" type="symbol" size="1" value="Pitchshifting" />
				<attribute name="enumvals" get="1" set="1" type="atom" size="4">
					<enumlist>
						<enum name="basic">
							<digest>
								Basic quality (the default)
							</digest>
							<description>
								TEXT_HERE
							</description>
						</enum>
						<enum name="good">
							<digest>
								Good quality
							</digest>
							<description>
								TEXT_HERE
							</description>
						</enum>
						<enum name="better">
							<digest>
								Better quality
							</digest>
							<description>
								TEXT_HERE
							</description>
						</enum>
						<enum name="best">
							<digest>
								Highest quality
							</digest>
							<description>
								TEXT_HERE
							</description>
						</enum>
					</enumlist>
				</attribute>
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Quality" />
				<attribute name="save" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="style" get="1" set="1" type="symbol" size="1" value="enum" />
			</attributelist>
		</attribute>
		<attribute name="reportlatency" get="1" set="1" type="int" size="1">
			<digest>
				Report latency
			</digest>
			<description>
				Enable/disable reporting latency, in samples, introduced by the <o>pitchshift~</o> object's calculations. Latency is output from the object's right-hand outlet in the form of a message in the form <m>latency [number-of-samples]</m>.
			</description>
			<attributelist>
				<attribute name="category" get="1" set="1" type="symbol" size="1" value="Pitchshifting" />
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Report latency" />
				<attribute name="save" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="style" get="1" set="1" type="symbol" size="1" value="onoff" />
			</attributelist>
		</attribute>
		<attribute name="usecents" get="1" set="1" type="int" size="1">
			<digest>
				Use cents for second inlet
			</digest>
			<description>
				Enable/disable the use of cent values in the second inlet of the <o>pitchshift~</o> object to specify pitch change.
			</description>
			<attributelist>
				<attribute name="category" get="1" set="1" type="symbol" size="1" value="Pitchshifting" />
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Use cents for second inlet" />
				<attribute name="save" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="style" get="1" set="1" type="symbol" size="1" value="onoff" />
			</attributelist>
		</attribute>
	</attributelist>
	<!--EXAMPLE-->
	<examplelist>
		<example caption="" img="" />
	</examplelist>
	<!--SEEALSO-->
	<seealsolist>
		<seealso name="retune~">
			<seealso name="gizmo~" />
			<seealso name="fbinshift~" />
			<seealso name="freqshift~" />
			<seealso name="hilbert~" />
		</seealso>
	</seealsolist>
</c74object>
