.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28) .\" .\" 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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 turned on, 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 .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Wav::Write 3pm" .TH Wav::Write 3pm "2014-04-27" "perl v5.18.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" Audio::Wav::Write \- Module for writing Microsoft WAV files. .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Audio::Wav; \& \& my $wav = new Audio::Wav; \& \& my $sample_rate = 44100; \& my $bits_sample = 16; \& \& my $details = { \& \*(Aqbits_sample\*(Aq => $bits_sample, \& \*(Aqsample_rate\*(Aq => $sample_rate, \& \*(Aqchannels\*(Aq => 1, \& # if you\*(Aqd like this module not to use a write cache, uncomment the next line \& #\*(Aqno_cache\*(Aq => 1, \& \& }; \& \& my $write = $wav \-> write( \*(Aqtestout.wav\*(Aq, $details ); \& \& &add_sine( 200, 1 ); \& \& sub add_sine { \& my $hz = shift; \& my $length = shift; \& my $pi = ( 22 / 7 ) * 2; \& $length *= $sample_rate; \& my $max_no = ( 2 ** $bits_sample ) / 2 \- 1; \& for my $pos ( 0 .. $length ) { \& $time = $pos / $sample_rate; \& $time *= $hz; \& my $val = sin $pi * $time; \& my $samp = $val * $max_no; \& $write \-> write( $samp ); \& } \& } \& \& $write \-> finish(); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Currently only writes to a file. .SH "SEE ALSO" .IX Header "SEE ALSO" Audio::Wav .PP Audio::Wav::Read .SH "NOTES" .IX Header "NOTES" This module shouldn't be used directly, a blessed object can be returned from Audio::Wav. .SH "METHODS" .IX Header "METHODS" .SS "finish" .IX Subsection "finish" Finishes off & closes the current wav file. .PP .Vb 1 \& $write \-> finish(); .Ve .SS "add_cue" .IX Subsection "add_cue" Adds a cue point to the wav file. If \f(CW$sample\fR is undefined then the position will be the current position (end of all data written so far). .PP .Vb 2 \& # $byte_offset for 01 compatibility mode \& $write \-> add_cue( $sample, "label", "note" ); .Ve .SS "set_sampler_info" .IX Subsection "set_sampler_info" All parameters are optional. .PP .Vb 11 \& my %info = ( \& \*(Aqmidi_pitch_fraction\*(Aq => 0, \& \*(Aqsmpte_format\*(Aq => 0, \& \*(Aqsmpte_offset\*(Aq => 0, \& \*(Aqproduct\*(Aq => 0, \& \*(Aqsample_period\*(Aq => 0, \& \*(Aqmanufacturer\*(Aq => 0, \& \*(Aqsample_data\*(Aq => 0, \& \*(Aqmidi_unity_note\*(Aq => 65, \& ); \& $write \-> set_sampler_info( %info ); .Ve .SS "add_sampler_loop" .IX Subsection "add_sampler_loop" All parameters are optional except start & end. .PP .Vb 9 \& my $length = $read \-> length_samples(); \& my( $third, $twothirds ) = map int( $length / $_ ), ( 3, 1.5 ); \& my %loop = ( \& \*(Aqstart\*(Aq => $third, \& \*(Aqend\*(Aq => $twothirds, \& \*(Aqfraction\*(Aq => 0, \& \*(Aqtype\*(Aq => 0, \& ); \& $write \-> add_sampler_loop( %loop ); .Ve .SS "add_display" .IX Subsection "add_display" .SS "set_info" .IX Subsection "set_info" Sets information to be contained in the wav file. .PP .Vb 1 \& $write \-> set_info( \*(Aqartist\*(Aq => \*(AqNightmares on Wax\*(Aq, \*(Aqname\*(Aq => \*(AqMission Venice\*(Aq ); .Ve .SS "file_name" .IX Subsection "file_name" Returns the current filename. .PP .Vb 1 \& my $file = $write \-> file_name(); .Ve .SS "write" .IX Subsection "write" Adds a sample to the current file. .PP .Vb 1 \& $write \-> write( @sample_channels ); .Ve .PP Each element in \f(CW@sample_channels\fR should be in the range of; .PP .Vb 2 \& where $samp_max = ( 2 ** bits_per_sample ) / 2 \& \-$samp_max to +$samp_max .Ve .SS "write_raw" .IX Subsection "write_raw" Adds some pre-packed data to the current file. .PP .Vb 1 \& $write \-> write_raw( $data, $data_length ); .Ve .PP Where; .PP .Vb 2 \& $data is the packed data \& $data_length (optional) is the length in bytes of the data .Ve .SS "write_raw_samples" .IX Subsection "write_raw_samples" Adds some pre-packed data to the current file, returns number of samples written. .PP .Vb 1 \& $write \-> write_raw_samples( $data, $data_length ); .Ve .PP Where; .PP .Vb 2 \& $data is the packed data \& $data_length (optional) is the length in bytes of the data .Ve .SH "AUTHORS" .IX Header "AUTHORS" .Vb 2 \& Nick Peskett (see http://www.peskett.co.uk/ for contact details). \& Kurt George Gjerde . (0.02\-0.03) .Ve