Chris@4: /** @file patest_stop.c
Chris@4: 	@ingroup test_src
Chris@4: 	@brief Test different ways of stopping audio.
Chris@4: 
Chris@4: 	Test the three ways of stopping audio:
Chris@4: 		- calling Pa_StopStream(),
Chris@4: 		- calling Pa_AbortStream(),
Chris@4: 		- and returning a 1 from the callback function.
Chris@4: 
Chris@4: 	A long latency is set up so that you can hear the difference.
Chris@4: 	Then a simple 8 note sequence is repeated twice.
Chris@4: 	The program will print what you should hear.
Chris@4: 
Chris@4: 	@author Phil Burk <philburk@softsynth.com>
Chris@4: */
Chris@4: /*
Chris@4:  * $Id: patest_stop.c 1368 2008-03-01 00:38:27Z rossb $
Chris@4:  *
Chris@4:  * This program uses the PortAudio Portable Audio Library.
Chris@4:  * For more information see: http://www.portaudio.com
Chris@4:  * Copyright (c) 1999-2000 Ross Bencina and Phil Burk
Chris@4:  *
Chris@4:  * Permission is hereby granted, free of charge, to any person obtaining
Chris@4:  * a copy of this software and associated documentation files
Chris@4:  * (the "Software"), to deal in the Software without restriction,
Chris@4:  * including without limitation the rights to use, copy, modify, merge,
Chris@4:  * publish, distribute, sublicense, and/or sell copies of the Software,
Chris@4:  * and to permit persons to whom the Software is furnished to do so,
Chris@4:  * subject to the following conditions:
Chris@4:  *
Chris@4:  * The above copyright notice and this permission notice shall be
Chris@4:  * included in all copies or substantial portions of the Software.
Chris@4:  *
Chris@4:  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
Chris@4:  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Chris@4:  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
Chris@4:  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
Chris@4:  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
Chris@4:  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
Chris@4:  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Chris@4:  */
Chris@4: 
Chris@4: /*
Chris@4:  * The text above constitutes the entire PortAudio license; however, 
Chris@4:  * the PortAudio community also makes the following non-binding requests:
Chris@4:  *
Chris@4:  * Any person wishing to distribute modifications to the Software is
Chris@4:  * requested to send the modifications to the original developer so that
Chris@4:  * they can be incorporated into the canonical version. It is also 
Chris@4:  * requested that these non-binding requests be included along with the 
Chris@4:  * license above.
Chris@4:  */
Chris@4: #include <stdio.h>
Chris@4: #include <math.h>
Chris@4: #include "portaudio.h"
Chris@4: 
Chris@4: #define OUTPUT_DEVICE       (Pa_GetDefaultOutputDevice())
Chris@4: #define SLEEP_DUR           (200)
Chris@4: #define SAMPLE_RATE         (44100)
Chris@4: #define FRAMES_PER_BUFFER   (256)
Chris@4: #define LATENCY_SECONDS     (3.f)
Chris@4: #define FRAMES_PER_NOTE     (SAMPLE_RATE/2)
Chris@4: #define MAX_REPEATS         (2)
Chris@4: #define FUNDAMENTAL         (400.0f / SAMPLE_RATE)
Chris@4: #define NOTE_0              (FUNDAMENTAL * 1.0f / 1.0f)
Chris@4: #define NOTE_1              (FUNDAMENTAL * 5.0f / 4.0f)
Chris@4: #define NOTE_2              (FUNDAMENTAL * 4.0f / 3.0f)
Chris@4: #define NOTE_3              (FUNDAMENTAL * 3.0f / 2.0f)
Chris@4: #define NOTE_4              (FUNDAMENTAL * 2.0f / 1.0f)
Chris@4: #define MODE_FINISH    (0)
Chris@4: #define MODE_STOP      (1)
Chris@4: #define MODE_ABORT     (2)
Chris@4: #ifndef M_PI
Chris@4: #define M_PI  (3.14159265)
Chris@4: #endif
Chris@4: #define TABLE_SIZE   (400)
Chris@4: 
Chris@4: typedef struct
Chris@4: {
Chris@4:     float  waveform[TABLE_SIZE + 1]; /* Add one for guard point for interpolation. */
Chris@4:     float  phase_increment;
Chris@4:     float  phase;
Chris@4:     float *tune;
Chris@4:     int    notesPerTune;
Chris@4:     int    frameCounter;
Chris@4:     int    noteCounter;
Chris@4:     int    repeatCounter;
Chris@4:     PaTime outTime;
Chris@4:     int    stopMode;
Chris@4:     int    done;
Chris@4: }
Chris@4: paTestData;
Chris@4: 
Chris@4: /************* Prototypes *****************************/
Chris@4: int TestStopMode( paTestData *data );
Chris@4: float LookupWaveform( paTestData *data, float phase );
Chris@4: 
Chris@4: /******************************************************
Chris@4:  * Convert phase between 0.0 and 1.0 to waveform value 
Chris@4:  * using linear interpolation.
Chris@4:  */
Chris@4: float LookupWaveform( paTestData *data, float phase )
Chris@4: {
Chris@4:     float fIndex = phase*TABLE_SIZE;
Chris@4:     int   index = (int) fIndex;
Chris@4:     float fract = fIndex - index;
Chris@4:     float lo = data->waveform[index];
Chris@4:     float hi = data->waveform[index+1];
Chris@4:     float val = lo + fract*(hi-lo);
Chris@4:     return val;
Chris@4: }
Chris@4: 
Chris@4: /* This routine will be called by the PortAudio engine when audio is needed.
Chris@4: ** It may called at interrupt level on some machines so don't do anything
Chris@4: ** that could mess up the system like calling malloc() or free().
Chris@4: */
Chris@4: static int patestCallback( const void *inputBuffer, void *outputBuffer,
Chris@4:                             unsigned long framesPerBuffer,
Chris@4:                             const PaStreamCallbackTimeInfo* timeInfo,
Chris@4:                             PaStreamCallbackFlags statusFlags,
Chris@4:                             void *userData )
Chris@4: {
Chris@4:     paTestData *data = (paTestData*)userData;
Chris@4:     float *out = (float*)outputBuffer;
Chris@4:     float value;
Chris@4:     unsigned int i = 0;
Chris@4:     int finished = paContinue;
Chris@4: 
Chris@4:     (void) inputBuffer;     /* Prevent unused variable warnings. */
Chris@4:     (void) timeInfo;
Chris@4:     (void) statusFlags;
Chris@4: 
Chris@4: 
Chris@4:     /* data->outTime = outTime; */
Chris@4:     
Chris@4:     if( !data->done )
Chris@4:     {
Chris@4:         for( i=0; i<framesPerBuffer; i++ )
Chris@4:         {
Chris@4:             /* Are we done with this note? */
Chris@4:             if( data->frameCounter >= FRAMES_PER_NOTE )
Chris@4:             {
Chris@4:                 data->noteCounter += 1;
Chris@4:                 data->frameCounter = 0;
Chris@4:                 /* Are we done with this tune? */
Chris@4:                 if( data->noteCounter >= data->notesPerTune )
Chris@4:                 {
Chris@4:                     data->noteCounter = 0;
Chris@4:                     data->repeatCounter += 1;
Chris@4:                     /* Are we totally done? */
Chris@4:                     if( data->repeatCounter >= MAX_REPEATS )
Chris@4:                     {
Chris@4:                         data->done = 1;
Chris@4:                         if( data->stopMode == MODE_FINISH )
Chris@4:                         {
Chris@4:                             finished = paComplete;
Chris@4:                             break;
Chris@4:                         }
Chris@4:                     }
Chris@4:                 }
Chris@4:                 data->phase_increment = data->tune[data->noteCounter];
Chris@4:             }
Chris@4:             value = LookupWaveform(data, data->phase);
Chris@4:             *out++ = value;  /* left */
Chris@4:             *out++ = value;  /* right */
Chris@4:             data->phase += data->phase_increment;
Chris@4:             if( data->phase >= 1.0f ) data->phase -= 1.0f;
Chris@4: 
Chris@4:             data->frameCounter += 1;
Chris@4:         }
Chris@4:     }
Chris@4:     /* zero remainder of final buffer */
Chris@4:     for( ; i<framesPerBuffer; i++ )
Chris@4:     {
Chris@4:         *out++ = 0; /* left */
Chris@4:         *out++ = 0; /* right */
Chris@4:     }
Chris@4:     return finished;
Chris@4: }
Chris@4: /*******************************************************************/
Chris@4: int main(void);
Chris@4: int main(void)
Chris@4: {
Chris@4:     paTestData data;
Chris@4:     int i;
Chris@4:     float simpleTune[] = { NOTE_0, NOTE_1, NOTE_2, NOTE_3, NOTE_4, NOTE_3, NOTE_2, NOTE_1 };
Chris@4:     
Chris@4:     printf("PortAudio Test: play song and test stopping. ask for %f seconds latency\n", LATENCY_SECONDS );
Chris@4:     /* initialise sinusoidal wavetable */
Chris@4:     for( i=0; i<TABLE_SIZE; i++ )
Chris@4:     {
Chris@4:         data.waveform[i] = (float) (
Chris@4:                                (0.2 * sin( ((double)i/(double)TABLE_SIZE) * M_PI * 2. )) +
Chris@4:                                (0.2 * sin( ((double)(3*i)/(double)TABLE_SIZE) * M_PI * 2. )) +
Chris@4:                                (0.1 * sin( ((double)(5*i)/(double)TABLE_SIZE) * M_PI * 2. ))
Chris@4:                            );
Chris@4:     }
Chris@4:     data.waveform[TABLE_SIZE] = data.waveform[0]; /* Set guard point. */
Chris@4:     data.tune = &simpleTune[0];
Chris@4:     data.notesPerTune = sizeof(simpleTune) / sizeof(float);
Chris@4: 
Chris@4:     printf("Test MODE_FINISH - callback returns 1.\n");
Chris@4:     printf("Should hear entire %d note tune repeated twice.\n", data.notesPerTune);
Chris@4:     data.stopMode = MODE_FINISH;
Chris@4:     if( TestStopMode( &data ) != paNoError )
Chris@4:     {
Chris@4:         printf("Test of MODE_FINISH failed!\n");
Chris@4:         goto error;
Chris@4:     }
Chris@4: 
Chris@4:     printf("Test MODE_STOP - stop when song is done.\n");
Chris@4:     printf("Should hear entire %d note tune repeated twice.\n", data.notesPerTune);
Chris@4:     data.stopMode = MODE_STOP;
Chris@4:     if( TestStopMode( &data ) != paNoError )
Chris@4:     {
Chris@4:         printf("Test of MODE_STOP failed!\n");
Chris@4:         goto error;
Chris@4:     }
Chris@4: 
Chris@4:     printf("Test MODE_ABORT - abort immediately.\n");
Chris@4:     printf("Should hear last repetition cut short by %f seconds.\n", LATENCY_SECONDS);
Chris@4:     data.stopMode = MODE_ABORT;
Chris@4:     if( TestStopMode( &data ) != paNoError )
Chris@4:     {
Chris@4:         printf("Test of MODE_ABORT failed!\n");
Chris@4:         goto error;
Chris@4:     }
Chris@4: 
Chris@4:     return 0;
Chris@4: 
Chris@4: error:
Chris@4:     return 1;
Chris@4: }
Chris@4: 
Chris@4: int TestStopMode( paTestData *data )
Chris@4: {
Chris@4:     PaStreamParameters outputParameters;
Chris@4:     PaStream *stream;
Chris@4:     PaError err;
Chris@4:     
Chris@4:     data->done = 0;
Chris@4:     data->phase = 0.0;
Chris@4:     data->frameCounter = 0;
Chris@4:     data->noteCounter = 0;
Chris@4:     data->repeatCounter = 0;
Chris@4:     data->phase_increment = data->tune[data->noteCounter];
Chris@4:     
Chris@4:     err = Pa_Initialize();
Chris@4:     if( err != paNoError ) goto error;
Chris@4: 
Chris@4:     outputParameters.device = OUTPUT_DEVICE;
Chris@4:     if (outputParameters.device == paNoDevice) {
Chris@4:         fprintf(stderr,"Error: No default output device.\n");
Chris@4:         goto error;
Chris@4:     }
Chris@4:     outputParameters.channelCount = 2;          /* stereo output */
Chris@4:     outputParameters.sampleFormat = paFloat32;  /* 32 bit floating point output */
Chris@4:     outputParameters.suggestedLatency = LATENCY_SECONDS;
Chris@4:     outputParameters.hostApiSpecificStreamInfo = NULL;
Chris@4:     
Chris@4:     err = Pa_OpenStream(
Chris@4:               &stream,
Chris@4:               NULL, /* no input */
Chris@4:               &outputParameters,
Chris@4:               SAMPLE_RATE,
Chris@4:               FRAMES_PER_BUFFER,            /* frames per buffer */
Chris@4:               paClipOff,      /* we won't output out of range samples so don't bother clipping them */
Chris@4:               patestCallback,
Chris@4:               data );
Chris@4:     if( err != paNoError ) goto error;
Chris@4: 
Chris@4:     err = Pa_StartStream( stream );
Chris@4:     if( err != paNoError ) goto error;
Chris@4: 
Chris@4:     if( data->stopMode == MODE_FINISH )
Chris@4:     {
Chris@4:         while( ( err = Pa_IsStreamActive( stream ) ) == 1 )
Chris@4:         {
Chris@4:             /*printf("outTime = %g, note# = %d, repeat# = %d\n", data->outTime,
Chris@4:              data->noteCounter, data->repeatCounter  );
Chris@4:             fflush(stdout); */
Chris@4:             Pa_Sleep( SLEEP_DUR );
Chris@4:         }
Chris@4:         if( err < 0 ) goto error;
Chris@4:     }
Chris@4:     else
Chris@4:     {
Chris@4:         while( data->repeatCounter < MAX_REPEATS )
Chris@4:         {
Chris@4:             /*printf("outTime = %g, note# = %d, repeat# = %d\n", data->outTime,
Chris@4:              data->noteCounter, data->repeatCounter  );
Chris@4:             fflush(stdout); */
Chris@4:             Pa_Sleep( SLEEP_DUR );
Chris@4:         }
Chris@4:     }
Chris@4: 
Chris@4:     if( data->stopMode == MODE_ABORT )
Chris@4:     {
Chris@4:         printf("Call Pa_AbortStream()\n");
Chris@4:         err = Pa_AbortStream( stream );
Chris@4:     }
Chris@4:     else
Chris@4:     {
Chris@4:         printf("Call Pa_StopStream()\n");
Chris@4:         err = Pa_StopStream( stream );
Chris@4:     }
Chris@4:     if( err != paNoError ) goto error;
Chris@4: 
Chris@4:     printf("Call Pa_CloseStream()\n"); fflush(stdout);
Chris@4:     err = Pa_CloseStream( stream );
Chris@4:     if( err != paNoError ) goto error;
Chris@4: 
Chris@4:     Pa_Terminate();
Chris@4:     printf("Test finished.\n");
Chris@4: 
Chris@4:     return err;
Chris@4: 
Chris@4: error:
Chris@4:     Pa_Terminate();
Chris@4:     fprintf( stderr, "An error occured while using the portaudio stream\n" );
Chris@4:     fprintf( stderr, "Error number: %d\n", err );
Chris@4:     fprintf( stderr, "Error message: %s\n", Pa_GetErrorText( err ) );
Chris@4:     return err;
Chris@4: }