# HG changeset patch
# User mawalch
# Date 1520866161 -3600
# Node ID c3f514269170bee9c3e88fcb13defd89c5cb4578
# Parent  22f8c0303a8bc60ec2e05823c3c92644d44aa668
#DOCUMENTATION by mawalch
Fix spelling in comments.

diff -r 22f8c0303a8b -r c3f514269170 SoundStream.st
--- a/SoundStream.st	Thu Mar 08 13:45:05 2018 +0100
+++ b/SoundStream.st	Mon Mar 12 15:49:21 2018 +0100
@@ -1126,132 +1126,132 @@
 
 setAudioFormat:aSymbol
     "set the format of the audio data as specified by aSymbol.
-     Returns true if sucessfull - may fail with some formats on many sound devices."
+     Returns true if sucessful - may fail with some formats on many sound devices."
 
     |fd|
 
     handle notNil ifTrue:[
-	fd := self fileDescriptor.
-	fd isNil ifTrue:[
-	    self errorNotOpen.
-	    ^ nil
-	]
+        fd := self fileDescriptor.
+        fd isNil ifTrue:[
+            self errorNotOpen.
+            ^ nil
+        ]
     ].
 %{
     OBJ sym = aSymbol;
 
     if (__INST(audioFormat) == sym) {
-	RETURN (self);
+        RETURN (self);
     }
 
 #if defined(DEV_AUDIO)
     if (__isSmallInteger(fd)) {
-	int f = __intVal(fd);
-	int __fmt = 0, __fmtWant;
-	union {
-	    unsigned short us;
-	    unsigned char ub[2];
-	} u;
+        int f = __intVal(fd);
+        int __fmt = 0, __fmtWant;
+        union {
+            unsigned short us;
+            unsigned char ub[2];
+        } u;
 
-	if (__isSymbol(sym)) {
-	    if (sym == @symbol(U16)) {
-		u.us = 0x1234;
-		if (u.ub[0] == 0x34) {
+        if (__isSymbol(sym)) {
+            if (sym == @symbol(U16)) {
+                u.us = 0x1234;
+                if (u.ub[0] == 0x34) {
 /* printf("U16_LE\n"); */
-		    sym = @symbol(U16_LE);
-		} else {
+                    sym = @symbol(U16_LE);
+                } else {
 /* printf("U16_BE\n"); */
-		    sym = @symbol(U16_BE);
-		}
-	    } else if (sym == @symbol(S16)) {
-		u.us = 0x1234;
-		if (u.ub[0] == 0x34) {
+                    sym = @symbol(U16_BE);
+                }
+            } else if (sym == @symbol(S16)) {
+                u.us = 0x1234;
+                if (u.ub[0] == 0x34) {
 /* printf("S16_LE\n"); */
-		   sym = @symbol(S16_LE);
-		} else {
+                   sym = @symbol(S16_LE);
+                } else {
 /* printf("S16_BE\n"); */
-		   sym = @symbol(S16_BE);
-		}
-	    }
+                   sym = @symbol(S16_BE);
+                }
+            }
 
-	    if (0) {
+            if (0) {
 # ifdef AFMT_MU_LAW
-	    } else if (sym == @symbol(MU_LAW)) {
-		__fmt = AFMT_MU_LAW;
+            } else if (sym == @symbol(MU_LAW)) {
+                __fmt = AFMT_MU_LAW;
 # endif
 # ifdef AFMT_A_LAW
-	    } else if (sym == @symbol(A_LAW)) {
-		__fmt = AFMT_A_LAW;
+            } else if (sym == @symbol(A_LAW)) {
+                __fmt = AFMT_A_LAW;
 # endif
 # ifdef AFMT_IMA_ADPCM
-	    } else if (sym == @symbol(IMA_ADPCM)) {
-		__fmt = AFMT_IMA_ADPCM;
+            } else if (sym == @symbol(IMA_ADPCM)) {
+                __fmt = AFMT_IMA_ADPCM;
 # endif
 # ifdef AFMT_U8
-	    } else if (sym == @symbol(U8)) {
-		__fmt = AFMT_U8;
+            } else if (sym == @symbol(U8)) {
+                __fmt = AFMT_U8;
 # endif
 # ifdef AFMT_S8
-	    } else if (sym == @symbol(S8)) {
-		__fmt = AFMT_S8;
+            } else if (sym == @symbol(S8)) {
+                __fmt = AFMT_S8;
 # endif
 # ifdef AFMT_U16_LE
-	    } else if (sym == @symbol(U16_LE)) {
-		__fmt = AFMT_U16_LE;
+            } else if (sym == @symbol(U16_LE)) {
+                __fmt = AFMT_U16_LE;
 # endif
 # ifdef AFMT_U16_BE
-	    } else if (sym == @symbol(U16_BE)) {
-		__fmt = AFMT_U16_BE;
+            } else if (sym == @symbol(U16_BE)) {
+                __fmt = AFMT_U16_BE;
 # endif
 # ifdef AFMT_S16_LE
-	    } else if (sym == @symbol(S16_LE)) {
-		__fmt = AFMT_S16_LE;
+            } else if (sym == @symbol(S16_LE)) {
+                __fmt = AFMT_S16_LE;
 # endif
 # ifdef AFMT_S16_BE
-	    } else if (sym == @symbol(S16_BE)) {
-		__fmt = AFMT_S16_BE;
+            } else if (sym == @symbol(S16_BE)) {
+                __fmt = AFMT_S16_BE;
 # endif
 # ifdef AFMT_MPEG
-	    } else if (sym == @symbol(MPEG)) {
-		__fmt = AFMT_MPEG;
+            } else if (sym == @symbol(MPEG)) {
+                __fmt = AFMT_MPEG;
 # endif
 
 # ifdef AUDIO_FORMAT_LINEAR16BIT
-	    } else if (sym == @symbol(S16)) {
-		__fmt = AUDIO_FORMAT_LINEAR16BIT;
+            } else if (sym == @symbol(S16)) {
+                __fmt = AUDIO_FORMAT_LINEAR16BIT;
 # endif
 # ifdef AUDIO_FORMAT_ULAW
-	    } else if (sym == @symbol(MU_LAW)) {
-		__fmt = AUDIO_FORMAT_ULAW;
+            } else if (sym == @symbol(MU_LAW)) {
+                __fmt = AUDIO_FORMAT_ULAW;
 # endif
 # ifdef AUDIO_FORMAT_ALAW
-	    } else if (sym == @symbol(A_LAW)) {
-		__fmt = AUDIO_FORMAT_ALAW;
+            } else if (sym == @symbol(A_LAW)) {
+                __fmt = AUDIO_FORMAT_ALAW;
 # endif
-	    } else {
-		console_fprintf(stderr, "bad format: %s\n", __stringVal(sym));
-		goto bad;
-	    }
-	}
+            } else {
+                console_fprintf(stderr, "bad format: %s\n", __stringVal(sym));
+                goto bad;
+            }
+        }
 
 # ifdef SNDCTL_DSP_SETFMT
-	__fmtWant = __fmt;
+        __fmtWant = __fmt;
 
-	if (ioctl(f, SNDCTL_DSP_SETFMT, &__fmt) >= 0) {
-	    if (__fmt == __fmtWant) {
-		__INST(audioFormat) = sym;
-		RETURN (self);
-	    } else {
-		/* console_fprintf(stderr, "want: %x; got: %x\n", __fmtWant, __fmt); */
-	    }
-	} else {
-		/* console_fprintf(stderr, "got err-ret from setFmp %x\n", __fmt); */
-	}
+        if (ioctl(f, SNDCTL_DSP_SETFMT, &__fmt) >= 0) {
+            if (__fmt == __fmtWant) {
+                __INST(audioFormat) = sym;
+                RETURN (self);
+            } else {
+                /* console_fprintf(stderr, "want: %x; got: %x\n", __fmtWant, __fmt); */
+            }
+        } else {
+                /* console_fprintf(stderr, "got err-ret from setFmp %x\n", __fmt); */
+        }
 # else
 #  ifdef AUDIO_SET_DATA_FORMAT /* hpux */
-	if (ioctl (f, AUDIO_SET_DATA_FORMAT, __fmt)) {
-	    /* console_fprintf(stderr, "got err-ret from AUDIO_SET_DATA_FORMAT\n"); */
-	}
+        if (ioctl (f, AUDIO_SET_DATA_FORMAT, __fmt)) {
+            /* console_fprintf(stderr, "got err-ret from AUDIO_SET_DATA_FORMAT\n"); */
+        }
 #  endif
 # endif /* SNDCTL_DSP_SETFMT */
 
@@ -1273,50 +1273,50 @@
 
 setChannels:nChannels
     "set the number of channels (1 -> mono; 2 -> stereo).
-     Returns true if sucessfull - may fail with many sound devices."
+     Returns true if sucessful - may fail with many sound devices."
 
     |fd|
 
     handle notNil ifTrue:[
-	fd := self fileDescriptor.
-	fd isNil ifTrue:[
-	    self errorNotOpen.
-	    ^ nil
-	]
+        fd := self fileDescriptor.
+        fd isNil ifTrue:[
+            self errorNotOpen.
+            ^ nil
+        ]
     ].
 %{
 
 #if defined(DEV_AUDIO)
     if (__isSmallInteger(fd) && __isSmallInteger(nChannels)) {
-	int f = __intVal(fd);
-	int __nCh = __intVal(nChannels);
+        int f = __intVal(fd);
+        int __nCh = __intVal(nChannels);
 
 # if defined(SNDCTL_DSP_STEREO)
-	if ((__nCh == 1) || (__nCh == 2)) {
-	    int __stereo = (__nCh == 2) ? 1 : 0;
+        if ((__nCh == 1) || (__nCh == 2)) {
+            int __stereo = (__nCh == 2) ? 1 : 0;
 
-	    if (ioctl(f, SNDCTL_DSP_STEREO, &__stereo) >= 0) {
-		if (__stereo == 0) {
-		    __INST(numberOfChannels) = __MKSMALLINT(1);
-		} else {
-		    __INST(numberOfChannels) = __MKSMALLINT(2);
-		}
-		RETURN (self);
-	    }
-	}
+            if (ioctl(f, SNDCTL_DSP_STEREO, &__stereo) >= 0) {
+                if (__stereo == 0) {
+                    __INST(numberOfChannels) = __MKSMALLINT(1);
+                } else {
+                    __INST(numberOfChannels) = __MKSMALLINT(2);
+                }
+                RETURN (self);
+            }
+        }
 # else
 #  if defined(SOUND_PCM_WRITE_CHANNELS)
-	if (ioctl(f, SOUND_PCM_WRITE_CHANNELS, &__nCh) >= 0) {
-	    __INST(numberOfChannels) = nChannels;
-	    RETURN (self);
-	}
+        if (ioctl(f, SOUND_PCM_WRITE_CHANNELS, &__nCh) >= 0) {
+            __INST(numberOfChannels) = nChannels;
+            RETURN (self);
+        }
 #  else
 #   ifdef AUDIO_SET_CHANNELS /* hpux */
-	if (ioctl (f, AUDIO_SET_CHANNELS, __nCh)) {
-	    /* console_fprintf(stderr, "got err-ret from AUDIO_SET_CHANNELS\n"); */
-	    __INST(numberOfChannels) = nChannels;
-	    RETURN (self);
-	}
+        if (ioctl (f, AUDIO_SET_CHANNELS, __nCh)) {
+            /* console_fprintf(stderr, "got err-ret from AUDIO_SET_CHANNELS\n"); */
+            __INST(numberOfChannels) = nChannels;
+            RETURN (self);
+        }
 #   endif
 #  endif
 # endif
@@ -1334,16 +1334,16 @@
 
 setFragmentSize:blockSize
     "set the soundDrivers fragmentSize.
-     Returns true if sucessfull - may fail with many sound devices."
+     Returns true if sucessful - may fail with many sound devices."
 
     |fd|
 
     handle notNil ifTrue:[
-	fd := self fileDescriptor.
-	fd isNil ifTrue:[
-	    self errorNotOpen.
-	    ^ nil
-	]
+        fd := self fileDescriptor.
+        fd isNil ifTrue:[
+            self errorNotOpen.
+            ^ nil
+        ]
     ].
 %{
     int f = __intVal(fd);
@@ -1351,19 +1351,19 @@
 
 #if defined(DEV_AUDIO)
     if (__isSmallInteger(fd) && __isSmallInteger(blockSize)) {
-	__blockSize = __intVal(blockSize);
+        __blockSize = __intVal(blockSize);
 # if defined(SNDCTL_DSP_SETFRAGMENT)
-	if (ioctl(f, SNDCTL_DSP_SETFRAGMENT, &__blockSize) >= 0) {
-	    /* __INST(blockSize) = blockSize; */
-	    RETURN (self);
-	}
+        if (ioctl(f, SNDCTL_DSP_SETFRAGMENT, &__blockSize) >= 0) {
+            /* __INST(blockSize) = blockSize; */
+            RETURN (self);
+        }
 # endif
 # ifdef AUDIO_SET_CHANNELS /* hpux */
-	if (ioctl (f, AUDIO_SET_TXBUFSIZE, __blockSize)) {
-	    /* console_fprintf(stderr, "got err-ret from AUDIO_SET_TXBUFSIZE\n"); */
-	    /* __INST(blockSize) = blockSize; */
-	    RETURN (self);
-	}
+        if (ioctl (f, AUDIO_SET_TXBUFSIZE, __blockSize)) {
+            /* console_fprintf(stderr, "got err-ret from AUDIO_SET_TXBUFSIZE\n"); */
+            /* __INST(blockSize) = blockSize; */
+            RETURN (self);
+        }
 # endif
     }
 #endif
@@ -1373,50 +1373,50 @@
 
 setSampleRate:hz
     "set the sample rate.
-     Returns true if sucessfull - may fail with many sound devices."
+     Returns true if sucessful - may fail with many sound devices."
 
     |fd|
 
     handle notNil ifTrue:[
-	fd := self fileDescriptor.
-	fd isNil ifTrue:[
-	    self errorNotOpen.
-	    ^ nil
-	]
+        fd := self fileDescriptor.
+        fd isNil ifTrue:[
+            self errorNotOpen.
+            ^ nil
+        ]
     ].
 %{
 #if defined(DEV_AUDIO)
     if (__isSmallInteger(fd) && __isSmallInteger(hz)) {
-	int f = __intVal(fd);
-	int __rate = __intVal(hz);
-	int __rateWant = __rate;
+        int f = __intVal(fd);
+        int __rate = __intVal(hz);
+        int __rateWant = __rate;
 
 # if defined(SNDCTL_DSP_SPEED)
-	if (ioctl(f, SNDCTL_DSP_SPEED, &__rate) >= 0) {
-	    if (__rate != __rateWant) {
-		console_fprintf(stderr, "SoundStream [warning]: actual rate is %d\n", __rate);
-		hz = __MKSMALLINT(__rate);
-	    }
-	    __INST(sampleRate) = hz;
-	    RETURN (self);
-	}
+        if (ioctl(f, SNDCTL_DSP_SPEED, &__rate) >= 0) {
+            if (__rate != __rateWant) {
+                console_fprintf(stderr, "SoundStream [warning]: actual rate is %d\n", __rate);
+                hz = __MKSMALLINT(__rate);
+            }
+            __INST(sampleRate) = hz;
+            RETURN (self);
+        }
 # else
 #  if defined(SOUND_PCM_WRITE_RATE)
-	if (ioctl(f, SOUND_PCM_WRITE_RATE, &__rate) >= 0) {
-	    if (__rate != __rateWant) {
-		console_fprintf(stderr, "SoundStream [warning]: actual rate is %d\n", __rate);
-		hz = __MKSMALLINT(__rate);
-	    }
-	    __INST(sampleRate) = hz;
-	    RETURN (self);
-	}
+        if (ioctl(f, SOUND_PCM_WRITE_RATE, &__rate) >= 0) {
+            if (__rate != __rateWant) {
+                console_fprintf(stderr, "SoundStream [warning]: actual rate is %d\n", __rate);
+                hz = __MKSMALLINT(__rate);
+            }
+            __INST(sampleRate) = hz;
+            RETURN (self);
+        }
 #  else
 #   ifdef AUDIO_SET_SAMPLE_RATE /* hpux */
-	if (ioctl (f, AUDIO_SET_SAMPLE_RATE, __rate)) {
-	    /* console_fprintf(stderr, "got err-ret from AUDIO_SET_SAMPLE_RATE\n"); */
-	    __INST(sampleRate) = hz;
-	    RETURN (self);
-	}
+        if (ioctl (f, AUDIO_SET_SAMPLE_RATE, __rate)) {
+            /* console_fprintf(stderr, "got err-ret from AUDIO_SET_SAMPLE_RATE\n"); */
+            __INST(sampleRate) = hz;
+            RETURN (self);
+        }
 #   endif
 #  endif
 # endif