.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "pods::SDL::AudioCVT 3pm"
.TH pods::SDL::AudioCVT 3pm 2024-03-28 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
SDL::AudioCVT \-\- Audio Conversion Structure
.SH CATEGORY
.IX Header "CATEGORY"
Core, Audio, Structure
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \f(CW\*(C`SDL::AudioCVT\*(C'\fR is used to convert audio data between different formats. A \f(CW\*(C`SDL::AudioCVT\*(C'\fR structure is created with the 
\&\f(CW\*(C`SDL::AudioCVT\-\*(C'\fRbuild> function, while the actual conversion is done by the \f(CW\*(C`SDL::Audio::convert_audio\*(C'\fR function.
.SH METHODS
.IX Header "METHODS"
.SS new
.IX Subsection "new"
This constructor returns an empty \f(CW\*(C`SDL::AudioCVT\*(C'\fR structure.
.SS build
.IX Subsection "build"
.Vb 2
\& $cvt = SDL::AudioCVT\->build( $src_format, $src_channels, $src_rate
\&                              $dst_format, $dst_channels, $dst_rate );
.Ve
.PP
Before an \f(CW\*(C`SDL::AudioCVT\*(C'\fR structure can be used to convert audio data it must be initialized with source and destination information.
.PP
\&\f(CW\*(C`src_format\*(C'\fR and \f(CW\*(C`dst_format\*(C'\fR are the source and destination format of the conversion. (For information on audio formats see 
\&\f(CW\*(C`SDL::AudioSpec\*(C'\fR). \f(CW\*(C`src_channels\*(C'\fR and \f(CW\*(C`dst_channels\*(C'\fR are the number of channels in the source and destination formats. 
Finally, \f(CW\*(C`src_rate\*(C'\fR and \f(CW\*(C`dst_rate\*(C'\fR are the frequency or samples-per-second of the source and destination formats. Once again, 
see \f(CW\*(C`SDL::AudioSpec\*(C'\fR.
.PP
Currently (SDL\-1.2.11) only rate conversions of 2x and (1/2)x with x > 0 are done, nearing the requested rate conversion.
.PP
See \f(CW\*(C`SDL::Audio::convert_audio\*(C'\fR.
.SS needed
.IX Subsection "needed"
Set to one if the conversion is possible
.SS src_format
.IX Subsection "src_format"
Audio format of the source
.SS dest_format
.IX Subsection "dest_format"
Audio format of the destination
.SS rate_incr
.IX Subsection "rate_incr"
Rate conversion increment
.SS len
.IX Subsection "len"
Length of the original audio buffer in bytes
.SS len_cvt
.IX Subsection "len_cvt"
Length of converted audio buffer in bytes (calculated)
.SS len_mult
.IX Subsection "len_mult"
\&\f(CW\*(C`buf\*(C'\fR must be \f(CW\*(C`len*len_mult\*(C'\fR bytes in size (calculated)
.SS len_ratio
.IX Subsection "len_ratio"
Final audio size is \f(CW\*(C`len*len_ratio\*(C'\fR
.SH AUTHORS
.IX Header "AUTHORS"
See "AUTHORS" in SDL.