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