Files
harbour-core/harbour/source/rtl/tone.c

206 lines
6.8 KiB
C

/*
* $Id$
*/
/*
Harbour Project source code
Copyright 1999 by Chen Kedem <niki@actcom.co.il>
www - http://www.harbour-project.org
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version, with one exception:
The exception is that if you link the Harbour Runtime Library (HRL)
and/or the Harbour Virtual Machine (HVM) with other files to produce
an executable, this does not by itself cause the resulting executable
to be covered by the GNU General Public License. Your use of that
executable is in no way restricted on account of linking the HRL
and/or HVM code into it.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA (or visit
their web site at http://www.gnu.org/).
V 1.4 David G. Holm Upper limit for frequency for OS/2
DosBeep() is 32767. The CA-Clipper
Tone() function does not have an
upper limit on the duration, so I
had to add an inner loop to deal
with very long durations. There are
actually 18.2 Clipper (PC) timer
ticks per second.
V 1.2 David G. Holm Added OS/2 GCC/EMX support.
V 1.1 David G. Holm Split machine dependent code into
hb_tone() function for internal use
by other Harbour C functions.
V 1.0 Chen Kedem Initial version (only OS/2 support).
*/
#if defined(__DJGPP__)
#include <pc.h>
#include <time.h>
#endif
#if defined(OS2) || defined(__BORLANDC__)
#include <dos.h>
#endif
#include "extend.h"
#include "init.h"
#include "inkey.h" /* For hb_releaseCPU() */
#if defined(HARBOUR_GCC_OS2)
ULONG DosBeep (ULONG ulFrequency, ULONG ulDuration);
#endif
/* $DOC$
* $FUNCNAME$
* TONE()
* $CATEGORY$
* Misc.
* $ONELINER$
* Sound a tone with a specifies frequency and duration
* $SYNTAX$
* TONE( <nFrequency>, <nDuration> ) --> NIL
* $ARGUMENTS$
* <nFrequency> is a non-negative numeric value that specifies the
* frequency of the tone in hertz.
* <nDuration> is a positive numeric value which specifies the duration
* of the tone in 1/18 of a second units.
* $RETURNS$
* TONE() always return NIL.
* $DESCRIPTION$
* TONE() is a sound function that could be used to irritate the end
* user, his or her dog, and the surrounding neighborhood. The frequency
* is clamped to the range 0 to 32767 Hz.
* $EXAMPLES$
* If lOk // Good Sound
* TONE( 500, 1 )
* TONE( 4000, 1 )
* TONE( 2500, 1 )
* Else // Bad Sound
* TONE( 300, 1 )
* TONE( 499, 5 )
* TONE( 700, 5 )
* EndIf
* $TESTS$
* TONE( 800, 1 ) // same as ? CHR(7)
* TONE( 32000, 200 ) // any dogs around yet?
* TONE( 130.80, 1 ) // musical note - C
* TONE( 400, 0 ) // short beep
* TONE( 700 ) // short beep
* TONE( 10, 18.2 ) // 1 second delay
* TONE( -1 ) // 1/18.2 second delay
* TONE( ) // 1/18.2 second delay
* $STATUS$
*
* $COMPLIANCE$
* TONE() works exactly like CA-Clipper's TONE().
* $SEEALSO$
* CHR(), SET BELL
* $END$
*/
HARBOUR HB_TONE(void);
HB_INIT_SYMBOLS_BEGIN( Tone__InitSymbols )
{ "TONE", FS_PUBLIC, HB_TONE, 0 }
HB_INIT_SYMBOLS_END( Tone__InitSymbols )
#if ! defined(__GNUC__)
#pragma startup Tone__InitSymbols
#endif
void hb_tone( double frequency, double duration )
{
/* platform specific code */
/*
The conversion from Clipper timer tick units to
milliseconds is * 1000.0 / 18.2.
*/
/* TODO: add more platform support */
#if defined(HARBOUR_GCC_OS2)
ULONG temp;
#elif defined(OS2) || defined(__BORLANDC__)
USHORT temp;
#elif defined(__DJGPP__)
USHORT temp; /* Use USHORT, because this variable gets added to clock()
to form end_clock and we want to minimize overflow risk */
clock_t end_clock;
#else
/* Unsupported platform. */
ULONG temp; /* Avoid unreferenced temp */
duration = -1; /* Exit without delay */
#endif
#if defined(HARBOUR_GCC_OS2) || defined(OS2) || defined(__BORLANDC__)
frequency = MIN( MAX( 0.0, frequency ), 32767.0 );
duration = duration * 1000.0 / 18.2; /* milliseconds */
#endif
#if defined(__BORLANDC__)
sound( ( unsigned ) frequency );
#elif defined(__DJGPP__)
/* Note: delay() in <dos.h> does not work! */
frequency = MIN( MAX( 0.0, frequency ), 32767.0 );
duration = duration * CLOCKS_PER_SEC / 18.2 ; /* clocks */
sound( ( int ) frequency );
#endif
while( duration > 0.0 )
{
#if defined(HARBOUR_GCC_OS2)
temp = MIN( MAX ( 0, duration ), ULONG_MAX );
#elif defined(OS2) || defined(__BORLANDC__) || defined(__DJGPP__)
temp = MIN( MAX ( 0, duration ), USHRT_MAX );
#endif
duration -= temp;
if( temp <= 0 )
{
// Ensure that the loop gets terminated when
// only a fraction of the delay time remains.
duration = -1.0;
}
else
{
#if defined(HARBOUR_GCC_OS2)
DosBeep( ( ULONG ) frequency, ( ULONG ) temp );
#elif defined(OS2)
DosBeep( ( USHORT ) frequency, ( USHORT ) temp );
#elif defined(__BORLANDC__)
delay( temp ); /* Probably not multi-tasking OS friendly!
TODO: Change from delay() to clock() method? */
#elif defined(__DJGPP__)
end_clock = clock() + ( clock_t ) temp;
while( clock() < end_clock )
hb_releaseCPU();
#endif
}
hb_releaseCPU(); /* Try to be somewhat multi-tasking OS friendly */
}
#if defined(__BORLANDC__)
nosound();
#elif defined(__DJGPP__)
sound( 0 );
#endif
}
HARBOUR HB_TONE(void)
{
double frequency, duration;
if( PCOUNT > 0 && ISNUM( 1 ) )
{
frequency = hb_parnd ( 1 );
if( PCOUNT > 1 && ISNUM( 2 ) )
duration = hb_parnd( 2 );
else
duration = 1.0;
hb_tone( frequency, duration );
}
}