home *** CD-ROM | disk | FTP | other *** search
/ ftp.muug.mb.ca / 2014.06.ftp.muug.mb.ca.tar / ftp.muug.mb.ca / pub / openh323.tar.gz / openh323.tar / openh323 / include / ixjlid.h < prev    next >
Text File  |  2003-04-29  |  26KB  |  853 lines
  1. /*
  2.  * ixjlid.h
  3.  *
  4.  * QuickNet Internet Phone/Line JACK codec interface
  5.  *
  6.  * Open H323 Library
  7.  *
  8.  * Copyright (c) 1999-2000 Equivalence Pty. Ltd.
  9.  *
  10.  * The contents of this file are subject to the Mozilla Public License
  11.  * Version 1.0 (the "License"); you may not use this file except in
  12.  * compliance with the License. You may obtain a copy of the License at
  13.  * http://www.mozilla.org/MPL/
  14.  *
  15.  * Software distributed under the License is distributed on an "AS IS"
  16.  * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
  17.  * the License for the specific language governing rights and limitations
  18.  * under the License.
  19.  *
  20.  * The Original Code is Open H323 Library.
  21.  *
  22.  * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
  23.  *
  24.  * Portions of this code were written with the assisance of funding from
  25.  * Quicknet Technologies, Inc. http://www.quicknet.net.
  26.  *
  27.  * Contributor(s): ______________________________________.
  28.  *
  29.  * $Log: ixjlid.h,v $
  30.  * Revision 1.63  2003/04/29 08:27:47  robertj
  31.  * Cleaned up documentation for new wink duration functions.
  32.  *
  33.  * Revision 1.62  2003/04/28 01:47:53  dereks
  34.  * Add ability to set/get wink duration for ixj device.
  35.  *
  36.  * Revision 1.61  2002/11/06 04:03:38  dereks
  37.  * Improve docs for  SetToneFilterParameters().
  38.  *
  39.  * Revision 1.60  2002/11/05 04:26:21  robertj
  40.  * Imported RingLine() by array from OPAL.
  41.  *
  42.  * Revision 1.59  2002/09/16 01:14:15  robertj
  43.  * Added #define so can select if #pragma interface/implementation is used on
  44.  *   platform basis (eg MacOS) rather than compiler, thanks Robert Monaghan.
  45.  *
  46.  * Revision 1.58  2002/09/03 06:19:37  robertj
  47.  * Normalised the multi-include header prevention ifdef/define symbol.
  48.  *
  49.  * Revision 1.57  2002/08/05 10:03:47  robertj
  50.  * Cosmetic changes to normalise the usage of pragma interface/implementation.
  51.  *
  52.  * Revision 1.56  2002/05/09 06:26:30  robertj
  53.  * Added fuction to get the current audio enable state for line in device.
  54.  * Changed IxJ EnableAudio() semantics so is exclusive, no direct switching
  55.  *   from PSTN to POTS and vice versa without disabling the old one first.
  56.  *
  57.  * Revision 1.55  2001/09/24 12:31:35  robertj
  58.  * Added backward compatibility with old drivers.
  59.  *
  60.  * Revision 1.54  2001/07/19 05:54:27  robertj
  61.  * Updated interface to xJACK drivers to utilise cadence and filter functions
  62.  *   for dial tone, busy tone and ringback tone detection.
  63.  *
  64.  * Revision 1.53  2001/05/21 06:36:46  craigs
  65.  * Changed to allow optional wink detection for line disconnect
  66.  *
  67.  * Revision 1.52  2001/03/29 23:38:48  robertj
  68.  * Added ability to get average signal level for both receive and transmit.
  69.  *
  70.  * Revision 1.51  2001/02/09 05:16:24  robertj
  71.  * Added #pragma interface for GNU C++.
  72.  *
  73.  * Revision 1.50  2001/01/25 07:27:14  robertj
  74.  * Major changes to add more flexible OpalMediaFormat class to normalise
  75.  *   all information about media types, especially codecs.
  76.  *
  77.  * Revision 1.49  2001/01/24 05:34:49  robertj
  78.  * Altered volume control range to be percentage, ie 100 is max volume.
  79.  *
  80.  * Revision 1.48  2000/12/19 06:38:57  robertj
  81.  * Fixed missing virtual on IsTonePlaying() function.
  82.  *
  83.  * Revision 1.47  2000/12/11 01:47:28  robertj
  84.  * Changed to use built PWLib class for overlapped I/O.
  85.  *
  86.  * Revision 1.46  2000/12/11 00:16:51  robertj
  87.  * Removed unused filter/cadence function.
  88.  *
  89.  * Revision 1.45  2000/12/05 11:29:31  craigs
  90.  * Fixed problem with DTMF signal by adding queue for DTMF digits
  91.  *
  92.  * Revision 1.44  2000/12/04 23:30:02  craigs
  93.  * Added better initialisation of Quicknet devices
  94.  *
  95.  * Revision 1.43  2000/11/30 21:28:47  eokerson
  96.  * Fixed DTMF signal handling to stop polling ixj driver.
  97.  *
  98.  * Revision 1.42  2000/11/30 08:48:35  robertj
  99.  * Added functions to enable/disable Voice Activity Detection in LID's
  100.  *
  101.  * Revision 1.41  2000/11/27 10:30:01  craigs
  102.  * Added SetRawCodec function
  103.  *
  104.  * Revision 1.40  2000/11/27 00:12:17  robertj
  105.  * Added WIN32 version of hook flash detection function.
  106.  *
  107.  * Revision 1.39  2000/11/26 23:12:18  craigs
  108.  * Added hook flash detection API
  109.  *
  110.  * Revision 1.38  2000/11/24 11:18:36  robertj
  111.  * Don't need special raw modes for Linux drivers ... yet.
  112.  *
  113.  * Revision 1.37  2000/11/24 10:50:13  robertj
  114.  * Added a raw PCM dta mode for generating/detecting standard tones.
  115.  * Modified the ReadFrame/WriteFrame functions to allow for variable length codecs.
  116.  * Fixed hook state debouncing.
  117.  * Added codec to explicitly set LineJACK mixer settings to avoid funny modes
  118.  *    the driver/hardware gets into sometimes.
  119.  *
  120.  * Revision 1.36  2000/11/20 03:15:13  craigs
  121.  * Changed tone detection API slightly to allow detection of multiple
  122.  * simultaneous tones
  123.  * Added fax CNG tone to tone list
  124.  *
  125.  * Revision 1.35  2000/11/12 22:34:32  craigs
  126.  * Changed Linux driver interface code to use signals
  127.  *
  128.  * Revision 1.34  2000/11/06 06:33:20  robertj
  129.  * Changed hook state debounce so does not block for 200ms.
  130.  *
  131.  * Revision 1.33  2000/11/03 06:22:48  robertj
  132.  * Added flag to IsLinePresent() to force slow test, guarenteeing correct value.
  133.  *
  134.  * Revision 1.32  2000/10/23 05:39:07  craigs
  135.  * Added access to exception detection on Unix
  136.  * Fixed problem with detecting available devices when
  137.  * devices with lower ordinals were used
  138.  *
  139.  * Revision 1.31  2000/10/19 04:12:13  robertj
  140.  * Added enum for xJACK card types.
  141.  *
  142.  * Revision 1.30  2000/10/19 04:00:35  robertj
  143.  * Added functions to get xJACK card type and serial number.
  144.  *
  145.  * Revision 1.29  2000/10/13 02:21:40  robertj
  146.  * Changed volume control code to set more mixer values on LineJACK.
  147.  *
  148.  * Revision 1.28  2000/09/25 23:59:42  craigs
  149.  * Finally got G.728 working on boards which use the 8021
  150.  * Added better handling for wink exceptions
  151.  *
  152.  * Revision 1.27  2000/09/22 01:35:03  robertj
  153.  * Added support for handling LID's that only do symmetric codecs.
  154.  *
  155.  * Revision 1.26  2000/09/13 09:26:28  rogerh
  156.  * Add location of FreeBSD header files
  157.  *
  158.  * Revision 1.25  2000/09/08 06:43:42  craigs
  159.  * Added additional ioctl debugging
  160.  * Added attempt to reduce ioctl count for hookstate monitoring
  161.  *
  162.  * Revision 1.24  2000/08/31 13:14:39  craigs
  163.  * Added functions to LID
  164.  * More bulletproofing to Linux driver
  165.  *
  166.  * Revision 1.23  2000/07/28 06:29:20  robertj
  167.  * Fixed AEC under Win32 so can be changed from other processes.
  168.  *
  169.  * Revision 1.22  2000/06/22 02:47:12  craigs
  170.  * Improved PSTN ring detection
  171.  *
  172.  * Revision 1.21  2000/06/17 09:34:45  robertj
  173.  * Put back variables mistakenly thought to be Linux specific.
  174.  *
  175.  * Revision 1.20  2000/06/17 04:11:13  craigs
  176.  * Fixed problem with potential codec startup problem in Linux IXJ driver
  177.  * Moved Linux specific variables to Linux specific section
  178.  *
  179.  * Revision 1.19  2000/05/24 06:42:18  craigs
  180.  * Added calls to get volume settings
  181.  *
  182.  * Revision 1.18  2000/05/02 04:32:24  robertj
  183.  * Fixed copyright notice comment.
  184.  *
  185.  * Revision 1.17  2000/04/13 23:09:38  craigs
  186.  * Fixed problem with callerId on some systems
  187.  *
  188.  * Revision 1.16  2000/04/06 20:36:25  robertj
  189.  * Fixed some LineJACK compatbility problems (eg DTMF detect stopping).
  190.  *
  191.  * Revision 1.15  2000/04/06 19:37:50  craigs
  192.  * Normalised bask to HAS_IXJ
  193.  *
  194.  * Revision 1.14  2000/04/06 19:29:04  craigs
  195.  * Removed all vestiges of the old IXJ driver
  196.  *
  197.  * Revision 1.13  2000/04/06 17:49:40  craigs
  198.  * Removed LINUX_TELEPHONY. Again.
  199.  *
  200.  * Revision 1.12  2000/04/05 18:04:12  robertj
  201.  * Changed caller ID code for better portability.
  202.  *
  203.  * Revision 1.11  2000/04/05 16:28:05  craigs
  204.  * Added caller ID function
  205.  *
  206.  * Revision 1.10  2000/03/29 20:46:47  robertj
  207.  * Added function on LID to get available codecs.
  208.  *
  209.  * Revision 1.9  2000/03/28 03:47:12  craigs
  210.  * Added stuff to stop tone playing from going wrong
  211.  *
  212.  * Revision 1.8  2000/03/22 17:18:48  robertj
  213.  * Changed default DTMF tone string times.
  214.  *
  215.  * Revision 1.7  2000/03/17 20:58:51  robertj
  216.  * Fixed line count to be xJACK card dependent.
  217.  *
  218.  * Revision 1.6  2000/03/14 11:20:49  rogerh
  219.  * Compile the ixj code on FreeBSD. This is needed for openphone support.
  220.  *
  221.  * Revision 1.5  2000/02/22 09:44:33  robertj
  222.  * Fixed compatibility with Linux systems not yet with the Linux Telephony code.
  223.  *
  224.  * Revision 1.4  2000/01/07 10:01:26  robertj
  225.  * GCC/Linux compatibility
  226.  *
  227.  * Revision 1.3  2000/01/07 08:28:09  robertj
  228.  * Additions and changes to line interface device base class.
  229.  *
  230.  * Revision 1.2  1999/12/24 00:28:03  robertj
  231.  * Changes to IXJ interface to follow LID abstraction
  232.  *
  233.  * Revision 1.1  1999/12/23 23:02:35  robertj
  234.  * File reorganision for separating RTP from H.323 and creation of LID for VPB support.
  235.  *
  236.  */
  237.  
  238. #ifndef __OPAL_IXJLID_H
  239. #define __OPAL_IXJLID_H
  240.  
  241. #ifdef P_USE_PRAGMA
  242. #pragma interface
  243. #endif
  244.  
  245.  
  246. #include "lid.h"
  247. #include "h323caps.h"
  248.  
  249.  
  250. #ifdef HAS_IXJ
  251. #ifdef P_LINUX
  252. #include <linux/telephony.h>
  253. #include <linux/ixjuser.h>
  254. #endif
  255. #ifdef P_FREEBSD
  256. #include <sys/telephony.h>
  257. #include <sys/ixjuser.h>
  258. #endif
  259. #endif
  260.  
  261.  
  262.  
  263. ///////////////////////////////////////////////////////////////////////////////
  264.  
  265. /**This class describes the xJack line interface device.
  266.  */
  267. class OpalIxJDevice : public OpalLineInterfaceDevice
  268. {
  269.   PCLASSINFO(OpalIxJDevice, OpalLineInterfaceDevice);
  270.  
  271.   enum { MaxIxjDevices = 10 };
  272.  
  273.   public:
  274.     /**Create a new, closed, device for a xJack card.
  275.       */
  276.     OpalIxJDevice();
  277.  
  278.     /**Destroy line interface device.
  279.        This calls Close() on the device.
  280.       */
  281.     ~OpalIxJDevice() { Close(); }
  282.  
  283.     /**Open the xJack device.
  284.       */
  285.     virtual BOOL Open(
  286.       const PString & device  /// Device identifier name.
  287.     );
  288.  
  289.     /**Close the xJack device.
  290.       */
  291.     virtual BOOL Close();
  292.  
  293.     /**Get the device name.
  294.       */
  295.     virtual PString GetName() const;
  296.  
  297.  
  298.     enum {
  299.       POTSLine,
  300.       PSTNLine,
  301.       NumLines
  302.     };
  303.  
  304.     /**Get the total number of lines supported by this device.
  305.       */
  306.     virtual unsigned GetLineCount();
  307.  
  308.  
  309.     /**Get the type of the line.
  310.       */
  311.     virtual BOOL IsLineTerminal(
  312.       unsigned line   /// Number of line
  313.     ) { return line == POTSLine; }
  314.  
  315.  
  316.     /**Determine if a physical line is present on the logical line.
  317.       */
  318.     virtual BOOL IsLinePresent(
  319.       unsigned line,      /// Number of line
  320.       BOOL force = FALSE  /// Force test, do not optimise
  321.     );
  322.  
  323.  
  324.     /**Determine if line is currently off hook.
  325.        This returns TRUE if GetLineState() is a state that implies the line is
  326.        off hook (eg OffHook or LineBusy).
  327.       */
  328.     virtual BOOL IsLineOffHook(
  329.       unsigned line   /// Number of line
  330.     );
  331.  
  332.     /**Set the state of the line.
  333.        Note that not be possible on a given line.
  334.       */
  335.     virtual BOOL SetLineOffHook(
  336.       unsigned line,        /// Number of line
  337.       BOOL newState = TRUE  /// New state to set
  338.     );
  339.  
  340.  
  341.     /**Determine if line is ringing.
  342.       */
  343.     virtual BOOL IsLineRinging(
  344.       unsigned line,          /// Number of line
  345.       DWORD * cadence = NULL  /// Cadence of incoming ring
  346.     );
  347.  
  348.     /**Begin ringing local phone set with specified cadence.
  349.        If cadence is zero then stops ringing.
  350.       */
  351.     virtual BOOL RingLine(
  352.       unsigned line,    /// Number of line
  353.       DWORD cadence     /// Cadence bit map for ring pattern
  354.     );
  355.  
  356.     /**Begin ringing local phone set with specified cadence.
  357.        If nCadence is zero then stops ringing.
  358.  
  359.        Note that not be possible on a given line, for example on a PSTN line
  360.        the ring state is determined by external hardware and cannot be
  361.        changed by the software.
  362.  
  363.        Also note that the cadence may be ignored by particular hardware driver
  364.        so that only the zero or non-zero values are significant.
  365.  
  366.        The ring pattern is an array of millisecond times for on and off parts
  367.        of the cadence. Thus the Australian ring cadence would be represented
  368.        by the array   unsigned AusRing[] = { 400, 200, 400, 2000 }
  369.       */
  370.     virtual BOOL RingLine(
  371.       unsigned line,     /// Number of line
  372.       PINDEX nCadence,   /// Number of entries in cadence array
  373.       unsigned * pattern /// Ring pattern times
  374.     );
  375.  
  376.  
  377.     /**Determine if line has been disconnected from a call.
  378.       */
  379.     virtual BOOL IsLineDisconnected(
  380.       unsigned line,   /// Number of line
  381.       BOOL checkForWink = TRUE
  382.     );
  383.  
  384.  
  385.     /**Directly connect the two lines.
  386.       */
  387.     BOOL SetLineToLineDirect(
  388.       unsigned line1,   /// Number of first line
  389.       unsigned line2,   /// Number of second line
  390.       BOOL connect      /// Flag for connect/disconnect
  391.     );
  392.  
  393.     /**Determine if the two lines are directly connected.
  394.       */
  395.     BOOL IsLineToLineDirect(
  396.       unsigned line1,   /// Number of first line
  397.       unsigned line2    /// Number of second line
  398.     );
  399.  
  400.  
  401.     /**Get the media formats this device is capable of using.
  402.       */
  403.     virtual OpalMediaFormat::List GetMediaFormats() const;
  404.  
  405.     /**Set the xJack codec for reading.
  406.       */
  407.     virtual BOOL SetReadFormat(
  408.       unsigned line,    /// Number of line
  409.       const OpalMediaFormat & mediaFormat   /// Codec type
  410.     );
  411.  
  412.     /**Set the xJack codec for writing.
  413.       */
  414.     virtual BOOL SetWriteFormat(
  415.       unsigned line,    /// Number of line
  416.       const OpalMediaFormat & mediaFormat   /// Codec type
  417.     );
  418.  
  419.     /**Get the media format (codec) for reading on the specified line.
  420.       */
  421.     virtual OpalMediaFormat GetReadFormat(
  422.       unsigned line    /// Number of line
  423.     );
  424.  
  425.     /**Get the media format (codec) for writing on the specified line.
  426.       */
  427.     virtual OpalMediaFormat GetWriteFormat(
  428.       unsigned line    /// Number of line
  429.     );
  430.  
  431.     /**Set the line codec for reading/writing raw PCM data.
  432.        A descendent may use this to do anything special to the device before
  433.        beginning special PCM output. For example disabling AEC and set
  434.        volume levels to standard values. This can then be used for generating
  435.        standard tones using PCM if the driver is not capable of generating or
  436.        detecting them directly.
  437.  
  438.        The default behaviour simply does a SetReadCodec and SetWriteCodec for
  439.        PCM data.
  440.       */
  441.     virtual BOOL SetRawCodec(
  442.       unsigned line    /// Number of line
  443.     );
  444.  
  445.     /**Stop the raw PCM mode codec.
  446.       */
  447.     virtual BOOL StopRawCodec(
  448.       unsigned line   /// Number of line
  449.     );
  450.  
  451.     /**Stop the read codec.
  452.       */
  453.     virtual BOOL StopReadCodec(
  454.       unsigned line   /// Number of line
  455.     );
  456.  
  457.     /**Stop the write codec.
  458.       */
  459.     virtual BOOL StopWriteCodec(
  460.       unsigned line   /// Number of line
  461.     );
  462.  
  463.     /**Get the read frame size in bytes.
  464.        All calls to ReadFrame() will return this number of bytes.
  465.       */
  466.     virtual PINDEX GetReadFrameSize(
  467.       unsigned line   /// Number of line
  468.     );
  469.  
  470.     virtual BOOL SetReadFrameSize(unsigned, PINDEX);
  471.  
  472.     /**Get the write frame size in bytes.
  473.        All calls to WriteFrame() must be this number of bytes.
  474.       */
  475.     virtual PINDEX GetWriteFrameSize(
  476.       unsigned line   /// Number of line
  477.     );
  478.  
  479.     virtual BOOL SetWriteFrameSize(unsigned, PINDEX);
  480.  
  481.     /**Low level read of a frame from the device.
  482.      */
  483.     virtual BOOL ReadFrame(
  484.       unsigned line,    /// Number of line
  485.       void * buf,       /// Pointer to a block of memory to receive data.
  486.       PINDEX & count    /// Number of bytes read, <= GetReadFrameSize()
  487.     );
  488.  
  489.     /**Low level write frame to the device.
  490.      */
  491.     virtual BOOL WriteFrame(
  492.       unsigned line,    /// Number of line
  493.       const void * buf, /// Pointer to a block of memory to write.
  494.       PINDEX count,     /// Number of bytes to write, <= GetWriteFrameSize()
  495.       PINDEX & written  /// Number of bytes written, <= GetWriteFrameSize()
  496.     );
  497.  
  498.     /**Get average signal level in last frame.
  499.       */
  500.     virtual unsigned GetAverageSignalLevel(
  501.       unsigned line,  /// Number of line
  502.       BOOL playback   /// Get average playback or record level.
  503.     );
  504.  
  505.  
  506.     /**Enable audio for the line.
  507.       */
  508.     virtual BOOL EnableAudio(
  509.       unsigned line,      /// Number of line
  510.       BOOL enable = TRUE
  511.     );
  512.  
  513.     /**Determine if audio for the line is enabled.
  514.       */
  515.     virtual BOOL IsAudioEnabled(
  516.       unsigned line      /// Number of line
  517.     );
  518.  
  519.  
  520.     /**Set volume level for recording.
  521.        A value of 100 is the maximum volume possible for the hardware.
  522.        A value of 0 is the minimum volume possible for the hardware.
  523.       */
  524.     virtual BOOL SetRecordVolume(
  525.       unsigned line,    /// Number of line
  526.       unsigned volume   /// Volume level from 0 to 100%
  527.     );
  528.  
  529.     /**Set volume level for playing.
  530.        A value of 100 is the maximum volume possible for the hardware.
  531.        A value of 0 is the minimum volume possible for the hardware.
  532.       */
  533.     virtual BOOL SetPlayVolume(
  534.       unsigned line,    /// Number of line
  535.       unsigned volume   /// Volume level from 0 to 100%
  536.     );
  537.  
  538.     /**Get volume level for recording.
  539.        A value of 100 is the maximum volume possible for the hardware.
  540.        A value of 0 is the minimum volume possible for the hardware.
  541.       */
  542.     virtual BOOL GetRecordVolume(
  543.       unsigned line,      /// Number of line
  544.       unsigned & volume   /// Volume level from 0 to 100%
  545.     );
  546.  
  547.     /**Set volume level for playing.
  548.        A value of 100 is the maximum volume possible for the hardware.
  549.        A value of 0 is the minimum volume possible for the hardware.
  550.       */
  551.     virtual BOOL GetPlayVolume(
  552.       unsigned line,      /// Number of line
  553.       unsigned & volume   /// Volume level from 0 to 100%
  554.     );
  555.  
  556.     /**Get acoustic echo cancellation.
  557.       */
  558.     AECLevels GetAEC(
  559.       unsigned line    /// Number of line
  560.     );
  561.  
  562.     /**Set acoustic echo cancellation.
  563.       */
  564.     BOOL SetAEC(
  565.       unsigned line,    /// Number of line
  566.       AECLevels level   /// AEC level
  567.     );
  568.  
  569.     /**Get wink detect minimum duration.
  570.        This is the signal used by telcos to end PSTN call.
  571.       */
  572.     unsigned GetWinkDuration(
  573.       unsigned line    /// Number of line
  574.     );
  575.  
  576.     /**Set wink detect minimum duration.
  577.        This is the signal used by telcos to end PSTN call.
  578.       */
  579.     BOOL SetWinkDuration(
  580.       unsigned line,        /// Number of line
  581.       unsigned winkDuration /// New minimum duration
  582.     );
  583.  
  584.     /**Get voice activity detection.
  585.        Note, not all devices, or selected codecs, may support this function.
  586.       */
  587.     virtual BOOL GetVAD(
  588.       unsigned line    /// Number of line
  589.     );
  590.  
  591.     /**Set voice activity detection.
  592.        Note, not all devices, or selected codecs, may support this function.
  593.       */
  594.     virtual BOOL SetVAD(
  595.       unsigned line,    /// Number of line
  596.       BOOL enable       /// Flag for enabling VAD
  597.     );
  598.  
  599.  
  600.     /**Get Caller ID from the last incoming ring.
  601.        The idString parameter is either simply the "number" field of the caller
  602.        ID data, or if full is TRUE, all of the fields in the caller ID data.
  603.  
  604.        The full data of the caller ID string consists of the number field, the
  605.        time/date and the name field separated by tabs ('\t').
  606.       */
  607.     virtual BOOL GetCallerID(
  608.       unsigned line,      /// Number of line
  609.       PString & idString, /// ID string returned
  610.       BOOL full = FALSE   /// Get full information in idString
  611.     );
  612.  
  613.     /**Set Caller ID for use in next RingLine() call.
  614.        The full data of the caller ID string consists of the number field, the
  615.        time/date and the name field separated by tabs ('\t').
  616.  
  617.        If the date field is missing (two consecutive tabs) then the current
  618.        time and date is used. Using an empty string will clear the caller ID
  619.        so that no caller ID is sent on the next RingLine() call.
  620.       */
  621.     virtual BOOL SetCallerID(
  622.       unsigned line,            /// Number of line
  623.       const PString & idString  /// ID string to use
  624.     );
  625.  
  626.     /**Send Caller ID during call
  627.      */
  628.     virtual BOOL SendCallerIDOnCallWaiting(
  629.       unsigned line,            /// Number of line
  630.       const PString & idString  /// ID string to use
  631.     );
  632.  
  633.     /**Send a Visual Message Waiting Indicator
  634.       */
  635.     virtual BOOL SendVisualMessageWaitingIndicator(
  636.       unsigned line,            /// Number of line
  637.       BOOL on
  638.     );
  639.  
  640.  
  641.  
  642.     /**Play a DTMF digit.
  643.        Any characters that are not in the set 0-9, A-D, * or # will be ignored.
  644.       */
  645.     virtual BOOL PlayDTMF(
  646.       unsigned line,            /// Number of line
  647.       const char * digits,      /// DTMF digits to be played
  648.       DWORD onTime = DefaultDTMFOnTime,  /// Number of milliseconds to play each DTMF digit
  649.       DWORD offTime = DefaultDTMFOffTime /// Number of milliseconds between digits
  650.     );
  651.  
  652.     /**Read a DTMF digit detected.
  653.        This may be characters from the set 0-9, A-D, * or #. A null ('\0')
  654.        character indicates that there are no tones in the queue.
  655.  
  656.       */
  657.     virtual char ReadDTMF(
  658.       unsigned line   /// Number of line
  659.     );
  660.  
  661.     /**Get DTMF removal mode.
  662.        When set in this mode the DTMF tones detected are removed from the
  663.        encoded data stream as returned by ReadFrame().
  664.       */
  665.     virtual BOOL GetRemoveDTMF(
  666.       unsigned line            /// Number of line
  667.     );
  668.  
  669.     /**Set DTMF removal mode.
  670.        When set in this mode the DTMF tones detected are removed from the
  671.        encoded data stream as returned by ReadFrame().
  672.       */
  673.     virtual BOOL SetRemoveDTMF(
  674.       unsigned line,            /// Number of line
  675.       BOOL removeTones   /// Flag for removing DTMF tones.
  676.     );
  677.  
  678.  
  679.     /**See if a tone is detected.
  680.       */
  681.     virtual unsigned IsToneDetected(
  682.       unsigned line   /// Number of line
  683.     );
  684.  
  685.     /**Set a tones filter parameters.
  686.  
  687.        The times are in centi-seconds. 
  688.        Thus, to have a 1 second delay, 100 is required.
  689.       */
  690.     virtual BOOL SetToneFilterParameters(
  691.       unsigned line,            /// Number of line
  692.       CallProgressTones tone,   /// Tone filter to change
  693.       unsigned lowFrequency,    /// Low frequency
  694.       unsigned highFrequency,   /// High frequency
  695.       PINDEX numCadences,       /// Number of cadence times
  696.       const unsigned * onTimes, /// Cadence ON times
  697.       const unsigned * offTimes /// Cadence OFF times
  698.     );
  699.  
  700.     /**Play a tone.
  701.       */
  702.     virtual BOOL PlayTone(
  703.       unsigned line,          /// Number of line
  704.       CallProgressTones tone  /// Tone to be played
  705.     );
  706.  
  707.     /**Determine if a tone is still playing
  708.       */
  709.     virtual BOOL IsTonePlaying(
  710.       unsigned line   /// Number of line
  711.     );
  712.  
  713.     /**Stop playing a tone.
  714.       */
  715.     virtual BOOL StopTone(
  716.       unsigned line   /// Number of line
  717.     );
  718.  
  719.    /**Return TRUE if a hook flash has been detected
  720.       */
  721.     virtual BOOL HasHookFlash(unsigned line);
  722.  
  723.     /**Set the country code set for the device.
  724.        This may change the line analogue coefficients, ring detect, call
  725.        disconnect detect and call progress tones to fit the countries
  726.        telephone network.
  727.       */
  728.     virtual BOOL SetCountryCode(
  729.       T35CountryCodes country   /// COuntry code for device
  730.     );
  731.  
  732.  
  733.     /**Get the serial number for the xJACK card.
  734.       */
  735.     virtual DWORD GetSerialNumber();
  736.  
  737.     enum CardTypes {
  738.       PhoneJACK = 1,
  739.       LineJACK = 3,
  740.       PhoneJACK_Lite,
  741.       PhoneJACK_PCI,
  742.       PhoneCARD
  743.     };
  744.  
  745.     /**Get the serial number for the xJACK card.
  746.       */
  747.     DWORD GetCardType() const { return dwCardType; }
  748.  
  749.  
  750.     /**Get all the xJack devices.
  751.       */
  752.     static PStringArray GetDeviceNames();
  753.  
  754.  
  755.   protected:
  756.     PString   deviceName;
  757.     DWORD     dwCardType;
  758.     PMutex    readMutex, writeMutex;
  759.     BOOL      readStopped, writeStopped;
  760.     PINDEX    readFrameSize, writeFrameSize;
  761.     PINDEX    readCodecType, writeCodecType;
  762.     BOOL      lastHookState, currentHookState;
  763.     PTimer    hookTimeout;
  764.     BOOL      inRawMode;
  765.     unsigned  enabledAudioLine;
  766.     BOOL      exclusiveAudioMode;
  767.  
  768. #if defined(WIN32)
  769.     BOOL InternalSetVolume(BOOL record, unsigned id, int volume, int mute);
  770.     BOOL InternalPlayTone(unsigned line,
  771.                           DWORD toneIndex,
  772.                           DWORD onTime, DWORD offTime,
  773.                           BOOL synchronous);
  774.     BOOL IoControl(DWORD dwIoControlCode,
  775.                    DWORD inParam = 0,
  776.                    DWORD * outParam = NULL);
  777.     BOOL IoControl(DWORD dwIoControlCode,
  778.                    LPVOID lpInBuffer,
  779.                    DWORD nInBufferSize,
  780.                    LPVOID lpOutBuffer,
  781.                    DWORD nOutBufferSize,
  782.                    LPDWORD lpdwBytesReturned,
  783.                    PWin32Overlapped * overlap = NULL);
  784.  
  785.     HANDLE        hDriver;
  786.     DWORD         driverVersion;
  787.     PTimer        ringTimeout;
  788.     DWORD         lastDTMFDigit;
  789.     DWORD         lastFlashState;
  790.     PTimeInterval toneSendCompletionTime;
  791.     BOOL          vadEnabled;
  792.     HANDLE        hReadEvent, hWriteEvent;
  793.  
  794. #elif defined(HAS_IXJ)
  795.  
  796.   public:
  797.     class ExceptionInfo {
  798.       public:
  799.         int fd;
  800.  
  801.         BOOL hasRing;
  802.         BOOL hookState;
  803.         BOOL hasWink;
  804.         BOOL hasFlash;
  805.         char dtmf[16];
  806.         int dtmfIn;
  807.         int dtmfOut;
  808. #ifdef IXJCTL_VMWI
  809.         BOOL hasCid;
  810.         PHONE_CID cid;
  811. #endif
  812.         BOOL filter[4];
  813.         BOOL cadence[4];
  814.         telephony_exception data;
  815.         timeval lastHookChange;
  816.     };
  817.  
  818.     static void SignalHandler(int sig);
  819.     ExceptionInfo * OpalIxJDevice::GetException();
  820.     int GetOSHandle() { return os_handle; }
  821.  
  822.   protected:
  823.     BOOL ConvertOSError(int err);
  824.  
  825.     static ExceptionInfo exceptionInfo[MaxIxjDevices];
  826.     static PMutex        exceptionMutex;
  827.     static BOOL          exceptionInit;
  828.  
  829.     AECLevels aecLevel;
  830.     BOOL removeDTMF;
  831.     PMutex toneMutex;
  832.     BOOL tonePlaying;
  833.     PTimer lastRingTime;
  834.     BOOL pstnIsOffHook;
  835.     BOOL gotWink;
  836.     int  userPlayVol, userRecVol;
  837.  
  838.     int  savedPlayVol, savedRecVol;
  839.     AECLevels savedAEC;
  840.  
  841. #ifdef IXJCTL_VMWI
  842.     PHONE_CID callerIdInfo;
  843. #endif
  844.  
  845. #endif
  846. };
  847.  
  848.  
  849. #endif // __OPAL_IXJLID_H
  850.  
  851.  
  852. /////////////////////////////////////////////////////////////////////////////
  853.