/usr/include/opal/lids/lid.h is in libopal-dev 3.10.2~dfsg-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 | /*
* lid.h
*
* Line Interface Device
*
* Open Phone Abstraction Library
*
* Copyright (c) 1999-2001 Equivalence Pty. Ltd.
*
* The contents of this file are subject to the Mozilla Public License
* Version 1.0 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
* the License for the specific language governing rights and limitations
* under the License.
*
* The Original Code is Open H323 Library.
*
* The Initial Developer of the Original Code is Equivalence Pty. Ltd.
*
* Portions of this code were written with the assisance of funding from
* Quicknet Technologies, Inc. http://www.quicknet.net.
*
* Contributor(s): ______________________________________.
*
* $Revision: 24178 $
* $Author: rjongbloed $
* $Date: 2010-04-05 19:10:56 -0500 (Mon, 05 Apr 2010) $
*/
#ifndef OPAL_LIDS_LID_H
#define OPAL_LIDS_LID_H
#ifdef P_USE_PRAGMA
#pragma interface
#endif
#include <opal/buildopts.h>
#include <opal/mediafmt.h>
///////////////////////////////////////////////////////////////////////////////
/** Line Interface Device abstraction.
Note all functions in this device abstraction are assumed to be thread atomic.
*/
class OpalLineInterfaceDevice : public PObject
{
PCLASSINFO(OpalLineInterfaceDevice, PObject);
public:
/**Construct a new line interface device.
*/
OpalLineInterfaceDevice();
/**Open the line interface device.
*/
virtual PBoolean Open(
const PString & device ///< Device identifier name.
) = 0;
/**Determine if the line interface device is open.
*/
virtual PBoolean IsOpen() const;
/**Close the line interface device.
*/
virtual PBoolean Close();
/**Get the device type identifier.
This is as is used in the factory registration.
*/
virtual PString GetDeviceType() const = 0;
/**Get the device name, as used to open the device.
Note the format of this name should be as is returned from GetAllName()
and must be able to be used in a subsequent Open() call.
*/
virtual PString GetDeviceName() const = 0;
/**Get all the possible devices that can be opened.
*/
virtual PStringArray GetAllNames() const = 0;
/**Get the description of the line interface device.
This is a string indication of the card type for user interface
display purposes or device specific control. The device should be
as detailed as possible eg "Quicknet LineJACK".
*/
virtual PString GetDescription() const = 0;
/**Get the total number of lines supported by this device.
*/
virtual unsigned GetLineCount() const = 0;
/**Get the type of the line.
A "terminal" line is one where a call may terminate. For example a POTS
line with a standard telephone handset on it would be a terminal line.
The alternative is a "network" line, that is one connected to switched
network eg the standard PSTN.
*/
virtual PBoolean IsLineTerminal(
unsigned line ///< Number of line
) = 0;
/**Determine if a physical line is present on the logical line.
*/
virtual PBoolean IsLinePresent(
unsigned line, ///< Number of line
PBoolean force = false ///< Force test, do not optimise
);
/**Determine if line is currently off hook.
This function implies that the state is debounced and that a return
value of true indicates that the phone is really off hook. That is
hook flashes and winks are masked out.
*/
virtual PBoolean IsLineOffHook(
unsigned line ///< Number of line
) = 0;
/**Set the hook state of the line.
Note that not be possible on a given line, for example a POTS line with
a standard telephone handset. The hook state is determined by external
hardware and cannot be changed by the software.
*/
virtual PBoolean SetLineOffHook(
unsigned line, ///< Number of line
PBoolean newState = true ///< New state to set
) = 0;
/**Set the hook state of the line.
This is the complement of SetLineOffHook().
*/
virtual PBoolean SetLineOnHook(
unsigned line ///< Number of line
) { return SetLineOffHook(line, false); }
/**Set the hook state off then straight back on again.
This will only operate if the line is currently off hook.
*/
virtual PBoolean HookFlash(
unsigned line, ///< Number of line
unsigned flashTime = 200 ///< Time for hook flash in milliseconds
);
/**Return true if a hook flash has been detected
*/
virtual PBoolean HasHookFlash(unsigned line);
/**Determine if line is ringing.
This function implies that the state is "debounced" and that a return
value of true indicates that the phone is still ringing and it is not
simply a pause in the ring cadence.
If cadence is not NULL then it is set with the bit pattern for the
incoming ringing. Note that in this case the funtion may take a full
sequence to return. If it is NULL it can be assumed that the function
will return quickly.
*/
virtual PBoolean IsLineRinging(
unsigned line, ///< Number of line
DWORD * cadence = NULL ///< Cadence of incoming ring
);
/**Begin ringing local phone set with specified cadence.
If nCadence is zero then stops ringing.
Note that this may not be possible on a given line, for example on a
PSTN line the ring state is determined by external hardware and cannot
be changed by the software.
Also note that the cadence may be ignored by particular hardware driver
so that only the zero or non-zero values are significant.
The ring pattern is an array of millisecond times for on and off parts
of the cadence. Thus the Australian ring cadence would be represented
by the array unsigned AusRing[] = { 400, 200, 400, 2000 }
If the nCadence in non-zero and the pattern parameter is NULL, then
the standard ring pattern for the selected country is used.
*/
virtual PBoolean RingLine(
unsigned line, ///< Number of line
PINDEX nCadence, ///< Number of entries in cadence array
const unsigned * pattern = NULL, ///< Ring pattern times
unsigned frequency = 400 ///< Frequency of ring (if relevant)
);
/**Indicate to the POTS handset that the call is connected.
This uses the hardware (and country) dependent means to indicate to
the remote end of a POTS connection that we have answerd. Typically
this is a "polarity reversal" but other techniques may be used.
The "connected" state remains in force till the remote disconnects
the call, though hanging up.
Returns true if successful, always returns false for PSTN lines.
*/
virtual PBoolean SetLineConnected(
unsigned line ///< Number of line
);
/**Determine if remote has answered call on line.
This uses the hardware (and country) dependent means for determining
if the remote end of a PSTN connection has answered. Typically this
is a "polarity reversal" but other techniques may be used.
It should be noted that IsLineConnected() is not exactly the same
thing as !IsLineDisconnected().
For a POTS port this is equivalent to IsLineOffHook().
*/
virtual PBoolean IsLineConnected(
unsigned line ///< Number of line
);
/**Determine if line has been disconnected from a call.
This uses the hardware (and country) dependent means for determining
if the remote end of a PSTN connection has hung up. For example a
"wink" or "K break" which is a short drop in line voltage similar to
(though opposite in sense) toa hook flash.
It should be noted that IsLineDisconnected() is not exactly the same
thing as !IsLineConnected().
For a POTS port this is equivalent to !IsLineOffHook().
*/
virtual PBoolean IsLineDisconnected(
unsigned line, ///< Number of line
PBoolean checkForWink = true ///< Flag to check for remote hang up
);
/**Directly connect the two lines.
*/
virtual PBoolean SetLineToLineDirect(
unsigned line1, ///< Number of first line
unsigned line2, ///< Number of second line
PBoolean connect ///< Flag for connect/disconnect
);
/**Determine if the two lines are directly connected.
*/
virtual PBoolean IsLineToLineDirect(
unsigned line1, ///< Number of first line
unsigned line2 ///< Number of second line
);
/**Get the media formats this device is capable of using.
*/
virtual OpalMediaFormatList GetMediaFormats() const = 0;
/**Set the media format (codec) for reading on the specified line.
*/
virtual PBoolean SetReadFormat(
unsigned line, ///< Number of line
const OpalMediaFormat & mediaFormat ///< Codec type
) = 0;
/**Set the media format (codec) for writing on the specified line.
*/
virtual PBoolean SetWriteFormat(
unsigned line, ///< Number of line
const OpalMediaFormat & mediaFormat ///< Codec type
) = 0;
/**Get the media format (codec) for reading on the specified line.
*/
virtual OpalMediaFormat GetReadFormat(
unsigned line ///< Number of line
) = 0;
/**Get the media format (codec) for writing on the specified line.
*/
virtual OpalMediaFormat GetWriteFormat(
unsigned line ///< Number of line
) = 0;
/**Stop the read codec.
*/
virtual PBoolean StopReading(
unsigned line ///< Number of line
);
/**Stop the write codec.
*/
virtual PBoolean StopWriting(
unsigned line ///< Number of line
);
/**Indicate that ReadFrame() & WriteFrame() take whole RTP packets.
Note that if this returns true, SetReadFrameSize(), SetWriteFrameSize(),
GetReadFrameSize() and GetWriteFrameSize() are no longer relevant.
*/
virtual bool UsesRTP() const;
/**Set the read frame size in bytes.
Note that a LID may ignore this value so always use GetReadFrameSize()
for I/O.
*/
virtual PBoolean SetReadFrameSize(
unsigned line, ///< Number of line
PINDEX frameSize ///< New frame size
);
/**Set the write frame size in bytes.
Note that a LID may ignore this value so always use GetReadFrameSize()
for I/O.
*/
virtual PBoolean SetWriteFrameSize(
unsigned line, ///< Number of line
PINDEX frameSize ///< New frame size
);
/**Get the read frame size in bytes.
All calls to ReadFrame() will return this number of bytes.
*/
virtual PINDEX GetReadFrameSize(
unsigned line ///< Number of line
);
/**Get the write frame size in bytes.
All calls to WriteFrame() must be this number of bytes.
*/
virtual PINDEX GetWriteFrameSize(
unsigned line ///< Number of line
);
/**Low level read of a frame from the device.
*/
virtual PBoolean ReadFrame(
unsigned line, ///< Number of line
void * buf, ///< Pointer to a block of memory to receive data.
PINDEX & count ///< Number of bytes read, <= GetReadFrameSize()
) = 0;
/**Low level write frame to the device.
*/
virtual PBoolean WriteFrame(
unsigned line, ///< Number of line
const void * buf, ///< Pointer to a block of memory to write.
PINDEX count, ///< Number of bytes to write, <= GetWriteFrameSize()
PINDEX & written ///< Number of bytes written, <= GetWriteFrameSize()
) = 0;
/**High level read of audio data from the device.
This version will allow non-integral number of frames to be read.
*/
virtual PBoolean ReadBlock(
unsigned line, ///< Number of line
void * buf, ///< Pointer to a block of memory to receive the read bytes.
PINDEX count ///< Count of bytes to read.
);
/**High level write audio data to the device.
*/
virtual PBoolean WriteBlock(
unsigned line, ///< Number of line
const void * buf, ///< Pointer to a block of memory to write.
PINDEX count ///< Count of bytes to write.
);
/**Get average signal level in last frame.
*/
virtual unsigned GetAverageSignalLevel(
unsigned line, ///< Number of line
PBoolean playback ///< Get average playback or record level.
);
/**Enable audio for the line.
*/
virtual PBoolean EnableAudio(
unsigned line, ///< Number of line
PBoolean enable = true ///< Enable/disable audio
);
/**Disable audio for the line.
*/
PBoolean DisableAudio(
unsigned line ///< Number of line
) { return EnableAudio(line, false); }
/**Determine if audio for the line is enabled.
*/
virtual PBoolean IsAudioEnabled(
unsigned line ///< Number of line
) const;
enum {
MaxVolume = 100
};
/**Set volume level for recording.
A value of 100 is the maximum volume possible for the hardware.
A value of 0 is the minimum volume possible for the hardware.
*/
virtual PBoolean SetRecordVolume(
unsigned line, ///< Number of line
unsigned volume ///< Volume level from 0 to 100%
);
/**Set volume level for playing.
A value of 100 is the maximum volume possible for the hardware.
A value of 0 is the minimum volume possible for the hardware.
*/
virtual PBoolean SetPlayVolume(
unsigned line, ///< Number of line
unsigned volume ///< Volume level from 0 to 100%
);
/**Get volume level for recording.
A value of 100 is the maximum volume possible for the hardware.
A value of 0 is the minimum volume possible for the hardware.
*/
virtual PBoolean GetRecordVolume(
unsigned line, ///< Number of line
unsigned & volume ///< Volume level from 0 to 100%
);
/**Set volume level for playing.
A value of 100 is the maximum volume possible for the hardware.
A value of 0 is the minimum volume possible for the hardware.
*/
virtual PBoolean GetPlayVolume(
unsigned line, ///< Number of line
unsigned & volume ///< Volume level from 0 to 100%
);
enum AECLevels {
AECOff,
AECLow,
AECMedium,
AECHigh,
AECAuto,
AECAGC,
AECError
};
/**Get acoustic echo cancellation.
Note, not all devices may support this function.
*/
virtual AECLevels GetAEC(
unsigned line ///< Number of line
) const;
/**Set acoustic echo cancellation.
Note, not all devices may support this function.
*/
virtual PBoolean SetAEC(
unsigned line, ///< Number of line
AECLevels level ///< AEC level
);
/**Get voice activity detection.
Note, not all devices, or selected codecs, may support this function.
*/
virtual PBoolean GetVAD(
unsigned line ///< Number of line
) const;
/**Set voice activity detection.
Note, not all devices, or selected codecs, may support this function.
*/
virtual PBoolean SetVAD(
unsigned line, ///< Number of line
PBoolean enable ///< Flag for enabling VAD
);
/**Get Caller ID from the last incoming ring.
The idString parameter is either simply the "number" field of the caller
ID data, or if full is true, all of the fields in the caller ID data.
The full data of the caller ID string consists fields separated by tab
characters ('\\t'), the first three are always the Calling Line Identity
(CLI or calling number), the date and the Calling Line Name field. Other
fields may follow and are the of the form name=value. The values are
LID dependent.
A false is returned if there is no Caller ID information available, e.g.
if no ring has occurred.
*/
virtual PBoolean GetCallerID(
unsigned line, ///< Number of line
PString & idString, ///< ID string returned
PBoolean full = false ///< Get full information in idString
);
/**Set Caller ID information.
The idString must be as a minimum a number fields for the Calling Line
Identity.
The full data of the caller ID string consists fields separated by tab
characters ('\\t'), the first three are always the Calling Line Identity
(CLI or calling number), the date and the Calling Line Name field. Other
fields may follow and are the of the form name=value. The values are
LID dependent.
If the date field is missing (e.g. two consecutive tabs) then the current
time and date is used. Using an empty string will clear the caller ID
so that no caller ID is sent on the next RingLine() call.
if the line is on hook then this information is sent when the next
RingLine() function is called to start a ring cycle. Note that if the
Ring cycle had already been started then this function may return false.
If the line is off hook, then a Caller ID on Message Waiting is sent, if
supported by the LID, otherwise false is returned.
*/
virtual PBoolean SetCallerID(
unsigned line, ///< Number of line
const PString & idString ///< ID string to use
);
/**Send a Visual Message Waiting Indicator
*/
virtual PBoolean SendVisualMessageWaitingIndicator(
unsigned line, ///< Number of line
PBoolean on ///< Flag for VMWI on/off
);
enum {
DefaultDTMFOnTime = 150,
DefaultDTMFOffTime = 50
};
/**Play a DTMF digit.
Any characters that are not in the set 0-9, A-D, * or # will be ignored.
*/
virtual PBoolean PlayDTMF(
unsigned line, ///< Number of line
const char * digits, ///< DTMF digits to be played
DWORD onTime = DefaultDTMFOnTime, ///< Number of milliseconds to play each DTMF digit
DWORD offTime = DefaultDTMFOffTime ///< Number of milliseconds between digits
);
/**Read a DTMF digit detected.
This may be characters from the set 0-9, A-D, * or #. A null ('\\0')
character indicates that there are no tones in the queue.
Characters E through P indicate the following tones:
E = 800 F = 1000 G = 1250 H = 950 I = 1100 J = 1400
K = 1500 L = 1600 M = 1800 N = 2100 O = 1300 P = 2450
*/
virtual char ReadDTMF(
unsigned line ///< Number of line
);
/**Get DTMF removal mode.
When set in this mode the DTMF tones detected are removed from the
encoded data stream as returned by ReadFrame().
*/
virtual PBoolean GetRemoveDTMF(
unsigned line ///< Number of line
);
/**Set DTMF removal mode.
When set in this mode the DTMF tones detected are removed from the
encoded data stream as returned by ReadFrame().
*/
virtual PBoolean SetRemoveDTMF(
unsigned line, ///< Number of line
PBoolean removeTones ///< Flag for removing DTMF tones.
);
enum CallProgressTones {
NoTone = -1, // indicates no tones
DialTone, // Dial tone
RingTone, // Ring indication tone
BusyTone, // Line engaged tone
CongestionTone,// aka fast busy tone
ClearTone, // Call failed/disconnected tone (often same as busy tone)
MwiTone, // Message Waiting Tone
RoutingTone, // Call is being routed (not normal for PSTN, but VoIP can take a while)
CNGTone, // Fax CNG tone
CEDTone, // Fax CED tone
UserDefinedTone,
NumTones
};
/**See if any tone is detected.
*/
virtual CallProgressTones IsToneDetected(
unsigned line ///< Number of line
);
/**See if any tone is detected.
*/
virtual CallProgressTones WaitForToneDetect(
unsigned line, ///< Number of line
unsigned timeout = 3000 ///< Milliseconds to wait for
);
/**See if a specific tone is detected.
*/
virtual PBoolean WaitForTone(
unsigned line, ///< Number of line
CallProgressTones tone, ///< Tone to wait for
unsigned timeout = 3000 ///< Milliseconds to wait for
);
/**Set a calling tones description.
This sets the calling tone infromation for both wtah is emitted by PlayTone
and what is detected by IsToneDetected().
The description string is of the form
frequency ':' cadence
where frequency is either
frequency play tone, detect +/- 5%
low '-' high play tone halfway, but detect anything in range
low '+' high play both tones, detect anything in range
low 'x' high play tone1 modulated by tone2, detect twice modulation range
and cadence is
mintime
ontime '-' offtime
ontime '-' offtime '-' ontime '-' offtime
examples:
300:0.25 300Hz for minimum 250ms
1100:0.4-0.4 1100Hz with cadence 400ms on, 400ms off
900-1300:1.5 900Hz to 1300Hz for minimum of 1.5 seconds
425:0.4-0.2-0.4-2 425Hz with cadence
400ms on, 200ms off, 400ms on, 2 seconds off
*/
virtual bool SetToneDescription(
unsigned line, ///< Number of line
CallProgressTones tone, ///< Tone filter to change
const PString & description ///< Description of filter parameters
);
enum ToneMixingModes {
SimpleTone,
AddedTone,
ModulatedTone
};
/**Set calling tones filter parameters. Note this function is misnamed as it
can also set the calling tone to be output by PlayTone().
*/
virtual bool SetToneParameters(
unsigned line, ///< Number of line
CallProgressTones tone, ///< Tone filter to change
unsigned frequency1, ///< Usually low frequency
unsigned frequency2, ///< Usually high frequency
ToneMixingModes mode, ///< Mode for how freqencies are mixed, -1 is
PINDEX numCadences, ///< Number of cadence times
const unsigned * onTimes, ///< Cadence ON times
const unsigned * offTimes ///< Cadence OFF times
);
/**Play a tone.
*/
virtual PBoolean PlayTone(
unsigned line, ///< Number of line
CallProgressTones tone ///< Tone to be played
);
/**Determine if a tone is still playing
*/
virtual PBoolean IsTonePlaying(
unsigned line ///< Number of line
);
/**Stop playing a tone.
*/
virtual PBoolean StopTone(
unsigned line ///< Number of line
);
/** Structure for dialling parameters */
struct DialParams {
DialParams()
: m_requireTones(false)
, m_dialToneTimeout(2500)
, m_dialStartDelay(500)
, m_dialDigitTime(DefaultDTMFOnTime)
, m_dialInterDigitTime(DefaultDTMFOffTime)
, m_progressTimeout(5000)
, m_commaDelay(2000)
{ }
bool m_requireTones; ///< Require dial/ring tone to be detected
unsigned m_dialToneTimeout; ///< Time in msec to wait for a dial tone to be detected
unsigned m_dialStartDelay; ///< Time in msec to wait between the dial tone detection and dialing the DTMF
unsigned m_dialDigitTime; ///< Time in msec to play DTMF digit
unsigned m_dialInterDigitTime;///< Time in msec of silence between each DTMF digit
unsigned m_progressTimeout; ///< Time in msec to wait for a progress tone (ring, busy or connected) to be detected
unsigned m_commaDelay; ///< Time in msec to wait when a comma (',') is found in the dial string
};
/**Dial a number on network line.
The takes the line off hook, waits for dial tone, and transmits the
specified number as DTMF tones.
If the requireTones flag is true the call is aborted of the call
progress tones are not detected. Otherwise the call proceeds with short
delays while it tries to detect the call progress tones.
The return code indicates the following:
DialTone No dial tone detected
RingTone Dial was successful
BusyTone The remote phone was busy
ClearTone Dial failed (usually means rang out)
NoTone There was an internal error making the call
*/
virtual CallProgressTones DialOut(
unsigned line, ///< Number of line
const PString & number, ///< Number to dial
const DialParams & params = DialParams() ///< Optional parameters for dial out.
);
/**Get wink detect minimum duration.
This is the signal used by telcos to end PSTN call.
*/
virtual unsigned GetWinkDuration(
unsigned line ///< Number of line
);
/**Set wink detect minimum duration.
This is the signal used by telcos to end PSTN call.
*/
virtual PBoolean SetWinkDuration(
unsigned line, ///< Number of line
unsigned winkDuration ///< New minimum duration
);
enum T35CountryCodes {
Japan, Albania, Algeria, AmericanSamoa, Germany, Anguilla, AntiguaAndBarbuda,
Argentina, Ascension, Australia, Austria, Bahamas, Bahrain, Bangladesh,
Barbados, Belgium, Belize, Benin, Bermudas, Bhutan, Bolivia, Botswana,
Brazil, BritishAntarcticTerritory, BritishIndianOceanTerritory,
BritishVirginIslands, BruneiDarussalam, Bulgaria, Myanmar, Burundi,
Byelorussia, Cameroon, Canada, CapeVerde, CaymanIslands,
CentralAfricanRepublic, Chad, Chile, China, Colombia, Comoros, Congo,
CookIslands, CostaRica, Cuba, Cyprus, Czechoslovakia, Cambodia,
DemocraticPeoplesRepublicOfKorea, Denmark, Djibouti, DominicanRepublic,
Dominica, Ecuador, Egypt, ElSalvador, EquatorialGuinea, Ethiopia,
FalklandIslands, Fiji, Finland, France, FrenchPolynesia,
FrenchSouthernAndAntarcticLands, Gabon, Gambia, Germany2, Angola, Ghana,
Gibraltar, Greece, Grenada, Guam, Guatemala, Guernsey, Guinea, GuineaBissau,
Guayana, Haiti, Honduras, Hongkong, Hungary, Iceland, India, Indonesia,
Iran, Iraq, Ireland, Israel, Italy, CotedIvoire, Jamaica, Afghanistan,
Jersey, Jordan, Kenya, Kiribati, KoreaRepublic, Kuwait, Lao, Lebanon,
Lesotho, Liberia, Libya, Liechtenstein, Luxemborg, Macao, Madagascar,
Malaysia, Malawi, Maldives, Mali, Malta, Mauritania, Mauritius, Mexico,
Monaco, Mongolia, Montserrat, Morocco, Mozambique, Nauru, Nepal,
Netherlands, NetherlandsAntilles, NewCaledonia, NewZealand, Nicaragua,
Niger, Nigeria, Norway, Oman, Pakistan, Panama, PapuaNewGuinea, Paraguay,
Peru, Philippines, Poland, Portugal, PuertoRico, Qatar, Romania, Rwanda,
SaintKittsAndNevis, SaintCroix, SaintHelenaAndAscension, SaintLucia,
SanMarino, SaintThomas, SaoTomeAndPrincipe, SaintVicentAndTheGrenadines,
SaudiArabia, Senegal, Seychelles, SierraLeone, Singapore, SolomonIslands,
Somalia, SouthAfrica, Spain, SriLanka, Sudan, Suriname, Swaziland, Sweden,
Switzerland, Syria, Tanzania, Thailand, Togo, Tonga, TrinidadAndTobago,
Tunisia, Turkey, TurksAndCaicosIslands, Tuvalu, Uganda, Ukraine,
UnitedArabEmirates, UnitedKingdom, UnitedStates, BurkinaFaso, Uruguay,
USSR, Vanuatu, VaticanCityState, Venezuela, VietNam, WallisAndFutuna,
WesternSamoa, Yemen, Yemen2, Yugoslavia, Zaire, Zambia, Zimbabwe,
NumCountryCodes,
UnknownCountry = -1
};
/**Get the country code set for the device.
*/
T35CountryCodes GetCountryCode() const { return countryCode; }
/**Get the country code set for the device as a string.
*/
PString GetCountryCodeName() const;
/**Get the country code set for the device as a string.
*/
static PString GetCountryCodeName(T35CountryCodes code);
static T35CountryCodes GetCountryCode(const PString & name);
/**Set the country code set for the device.
This may change the line analogue coefficients, ring detect, call
disconnect detect and call progress tones to fit the countries
telephone network.
*/
virtual PBoolean SetCountryCode(
T35CountryCodes country ///< COuntry code for device
);
/**Set the country code set for the device.
*/
virtual PBoolean SetCountryCodeName(
const PString & countryName ///< COuntry code for device
);
/**Get the list of countries actually supported by the device
*/
virtual PStringList GetCountryCodeNameList() const;
/**Play a wav file
*/
virtual PBoolean PlayAudio(
unsigned line, ///< Number of line
const PString & filename ///< File Name
);
/**Stop playing the Wave File
*/
virtual PBoolean StopAudio(
unsigned line ///Number of line
);
/**
* start recording audio
*/
virtual PBoolean RecordAudioStart(
unsigned line, ///< line
const PString & filename ///< File Name
);
/**
* stop recording audio
*/
virtual PBoolean RecordAudioStop(
unsigned line ///< line
);
/**Return number for last error.
*/
int GetErrorNumber() const { return osError; }
/**Return text for last error.
*/
PString GetErrorText() const;
virtual void PrintOn(
ostream & strm
) const;
/**Create a new device from the registration string
*/
static OpalLineInterfaceDevice * Create(
const PString & type, ///< Type of device to create
void * parameters = NULL ///< Arbitrary parameters for the LID
);
/**Create a new device and open it given the descriptor string.
The descriptor consists of the device type, a ':' character and then
the specific device name.
*/
static OpalLineInterfaceDevice * CreateAndOpen(
const PString & descriptor, ///< Type of device to create
void * parameters = NULL ///< Arbitrary parameters for the LID
);
/**Return an array of all the LID types registered.
*/
static PStringList GetAllTypes();
/**Return an array of all the LID types registered and all of the possible
devices each one can open. Each string will be of the form
"type: name" eg "Quicknet: 3211FFFF"
*/
static PStringList GetAllDevices();
protected:
int os_handle;
mutable int osError;
T35CountryCodes countryCode;
PBYTEArray m_readDeblockingBuffer, m_writeDeblockingBuffer;
PINDEX m_readDeblockingOffset, m_writeDeblockingOffset;
std::vector<bool> m_LineAudioEnabled;
PString m_callProgressTones[NumTones];
#if PTRACING
friend ostream & operator<<(ostream & o, CallProgressTones t);
#endif
};
PLIST(OpalLIDList, OpalLineInterfaceDevice);
/**This class describes the LID based codec capability.
*/
class OpalLine : public PObject
{
PCLASSINFO(OpalLine, PObject);
public:
/**@name Construction */
//@{
/**Create a new telephone line.
*/
OpalLine(
OpalLineInterfaceDevice & device, ///< Device to make connection with
unsigned lineNumber, ///< number of line on LID
const char * userToken = NULL ///< Unique token string for line
);
//@}
/**@name Overrides from PObject */
//@{
/**Standard stream print function.
The PObject class has a << operator defined that calls this function
polymorphically.
*/
void PrintOn(
ostream & strm ///< Stream to output text representation
) const;
//@}
/**@name Basic operations */
//@{
/**Get the type of the line.
A "terminal" line is one where a call may terminate. For example a POTS
line with a standard telephone handset on it would be a terminal line.
The alternative is a "network" line, that is one connected to switched
network eg the standard PSTN.
*/
virtual PBoolean IsTerminal() { return device.IsLineTerminal(lineNumber); }
/**Determine if a physical line is present on the logical line.
*/
virtual PBoolean IsPresent(
PBoolean force = false ///< Force test, do not optimise
) { return device.IsLinePresent(lineNumber, force); }
/**Determine if line is currently off hook.
This function implies that the state is debounced and that a return
value of true indicates that the phone is really off hook. That is
hook flashes and winks are masked out.
*/
virtual PBoolean IsOffHook() { return device.IsLineOffHook(lineNumber); }
/**Set the hook state of the line.
Note that not be possible on a given line, for example a POTS line with
a standard telephone handset. The hook state is determined by external
hardware and cannot be changed by the software.
*/
virtual PBoolean SetOffHook() { return device.SetLineOffHook(lineNumber, true); }
/**Set the hook state of the line.
This is the complement of SetLineOffHook().
*/
virtual PBoolean SetOnHook() { return device.SetLineOffHook(lineNumber, false); }
/**Set the hook state off then straight back on again.
This will only operate if the line is currently off hook.
*/
virtual PBoolean HookFlash(
unsigned flashTime = 200 ///< Time for hook flash in milliseconds
) { return device.HookFlash(lineNumber, flashTime); }
/**Return true if a hook flash has been detected
*/
virtual PBoolean HasHookFlash() { return device.HasHookFlash(lineNumber); }
/**Determine if line is ringing.
This function implies that the state is "debounced" and that a return
value of true indicates that the phone is still ringing and it is not
simply a pause in the ring cadence.
If cadence is not NULL then it is set with the bit pattern for the
incoming ringing. Note that in this case the funtion may take a full
sequence to return. If it is NULL it can be assumed that the function
will return quickly.
*/
virtual PBoolean IsRinging(
DWORD * cadence = NULL ///< Cadence of incoming ring
);
/**Get the number of rings.
If the line is ringing then
*/
virtual unsigned GetRingCount(
DWORD * cadence = NULL ///< Cadence of incoming ring
);
/**Begin ringing local phone set with specified cadence.
If nCadence is zero then stops ringing.
Note that this may not be possible on a given line, for example on a
PSTN line the ring state is determined by external hardware and cannot
be changed by the software.
Also note that the cadence may be ignored by particular hardware driver
so that only the zero or non-zero values are significant.
The ring pattern is an array of millisecond times for on and off parts
of the cadence. Thus the Australian ring cadence would be represented
by the array unsigned AusRing[] = { 400, 200, 400, 2000 }
If the nCadence in non-zero and the pattern parameter is NULL, then
the standard ring pattern for the selected country is used.
*/
virtual PBoolean Ring(
PINDEX nCadence, ///< Number of entries in cadence array
const unsigned * pattern = NULL, ///< Ring pattern times
unsigned frequency = 400 ///< Frequency of ring (if relevant)
) { return device.RingLine(lineNumber, nCadence, pattern, frequency); }
/**Indicate to the POTS handset that the call is connected.
This uses the hardware (and country) dependent means to indicate to
the remote end of a POTS connection that we have answerd. Typically
this is a "polarity reversal" but other techniques may be used.
The "connected" state remains in force till the remote disconnects
the call, though hanging up.
Returns true if successful, always returns false for PSTN lines.
*/
virtual PBoolean SetConnected() { return device.SetLineConnected(lineNumber); }
/**Determine if remote has answered call on line.
This uses the hardware (and country) dependent means for determining
if the remote end of a PSTN connection has answered. Typically this
is a "polarity reversal" but other techniques may be used.
For a POTS port this is equivalent to IsLineOffHook().
*/
virtual PBoolean IsConnected() { return device.IsLineConnected(lineNumber); }
/**Determine if line has been disconnected from a call.
This uses the hardware (and country) dependent means for determining
*/
virtual PBoolean IsDisconnected() { return device.IsLineDisconnected(lineNumber); }
/**Set the media format (codec) for reading on the specified line.
*/
virtual PBoolean SetReadFormat(
const OpalMediaFormat & mediaFormat ///< Codec type
) { return device.SetReadFormat(lineNumber, mediaFormat); }
/**Set the media format (codec) for writing on the specified line.
*/
virtual PBoolean SetWriteFormat(
const OpalMediaFormat & mediaFormat ///< Codec type
) { return device.SetWriteFormat(lineNumber, mediaFormat); }
/**Get the media format (codec) for reading on the specified line.
*/
virtual OpalMediaFormat GetReadFormat() { return device.GetReadFormat(lineNumber); }
/**Get the media format (codec) for writing on the specified line.
*/
virtual OpalMediaFormat GetWriteFormat() { return device.GetWriteFormat(lineNumber); }
/**Stop the read codec.
*/
virtual PBoolean StopReading() { return device.StopReading(lineNumber); }
/**Stop the write codec.
*/
virtual PBoolean StopWriting() { return device.StopWriting(lineNumber); }
/**Set the read frame size in bytes.
Note that a LID may ignore this value so always use GetReadFrameSize()
for I/O.
*/
virtual PBoolean SetReadFrameSize(
PINDEX frameSize ///< New frame size
) { return device.SetReadFrameSize(lineNumber, frameSize); }
/**Set the write frame size in bytes.
Note that a LID may ignore this value so always use GetReadFrameSize()
for I/O.
*/
virtual PBoolean SetWriteFrameSize(
PINDEX frameSize ///< New frame size
) { return device.SetWriteFrameSize(lineNumber, frameSize); }
/**Get the read frame size in bytes.
All calls to ReadFrame() will return this number of bytes.
*/
virtual PINDEX GetReadFrameSize() { return device.GetReadFrameSize(lineNumber); }
/**Get the write frame size in bytes.
All calls to WriteFrame() must be this number of bytes.
*/
virtual PINDEX GetWriteFrameSize() { return device.GetWriteFrameSize(lineNumber); }
/**Low level read of a frame from the device.
*/
virtual PBoolean ReadFrame(
void * buf, ///< Pointer to a block of memory to receive data.
PINDEX & count ///< Number of bytes read, <= GetReadFrameSize()
) { return device.ReadFrame(lineNumber, buf, count); }
/**Low level write frame to the device.
*/
virtual PBoolean WriteFrame(
const void * buf, ///< Pointer to a block of memory to write.
PINDEX count, ///< Number of bytes to write, <= GetWriteFrameSize()
PINDEX & written ///< Number of bytes written, <= GetWriteFrameSize()
) { return device.WriteFrame(lineNumber, buf, count, written); }
/**High level read of audio data from the device.
This version will allow non-integral number of frames to be read.
*/
virtual PBoolean ReadBlock(
void * buf, ///< Pointer to a block of memory to receive the read bytes.
PINDEX count ///< Count of bytes to read.
) { return device.ReadBlock(lineNumber, buf, count); }
/**High level write audio data to the device.
*/
virtual PBoolean WriteBlock(
const void * buf, ///< Pointer to a block of memory to write.
PINDEX count ///< Count of bytes to write.
) { return device.WriteBlock(lineNumber, buf, count); }
/**Get average signal level in last frame.
*/
virtual unsigned GetAverageSignalLevel(
PBoolean playback ///< Get average playback or record level.
) { return device.GetAverageSignalLevel(lineNumber, playback); }
/**Enable audio for the line.
*/
virtual PBoolean EnableAudio(
PBoolean enable = true
) { return device.EnableAudio(lineNumber, enable); }
/**Disable audio for the line.
*/
PBoolean DisableAudio() { return EnableAudio(false); }
/**Determine if audio is ebabled for the line.
*/
virtual PBoolean IsAudioEnabled() const { return device.IsAudioEnabled(lineNumber); }
/**Set volume level for recording.
A value of 100 is the maximum volume possible for the hardware.
A value of 0 is the minimum volume possible for the hardware.
*/
virtual PBoolean SetRecordVolume(
unsigned volume ///< Volume level from 0 to 100%
) { return device.SetRecordVolume(lineNumber, volume); }
/**Set volume level for playing.
A value of 100 is the maximum volume possible for the hardware.
A value of 0 is the minimum volume possible for the hardware.
*/
virtual PBoolean SetPlayVolume(
unsigned volume ///< Volume level from 0 to 100%
) { return device.SetPlayVolume(lineNumber, volume); }
/**Get volume level for recording.
A value of 100 is the maximum volume possible for the hardware.
A value of 0 is the minimum volume possible for the hardware.
*/
virtual PBoolean GetRecordVolume(
unsigned & volume ///< Volume level from 0 to 100%
) { return device.GetRecordVolume(lineNumber, volume); }
/**Set volume level for playing.
A value of 100 is the maximum volume possible for the hardware.
A value of 0 is the minimum volume possible for the hardware.
*/
virtual PBoolean GetPlayVolume(
unsigned & volume ///< Volume level from 0 to 100%
) { return device.GetPlayVolume(lineNumber, volume); }
/**Get acoustic echo cancellation.
Note, not all devices may support this function.
*/
virtual OpalLineInterfaceDevice::AECLevels GetAEC() const { return device.GetAEC(lineNumber); }
/**Set acoustic echo cancellation.
Note, not all devices may support this function.
*/
virtual PBoolean SetAEC(
OpalLineInterfaceDevice::AECLevels level ///< AEC level
) { return device.SetAEC(lineNumber, level); }
/**Get voice activity detection.
Note, not all devices, or selected codecs, may support this function.
*/
virtual PBoolean GetVAD() const { return device.GetVAD(lineNumber); }
/**Set voice activity detection.
Note, not all devices, or selected codecs, may support this function.
*/
virtual PBoolean SetVAD(
PBoolean enable ///< Flag for enabling VAD
) { return device.SetVAD(lineNumber, enable); }
/**Get Caller ID from the last incoming ring.
The idString parameter is either simply the "number" field of the caller
ID data, or if full is true, all of the fields in the caller ID data.
The full data of the caller ID string consists fields separated by tab
characters ('\\t'), the first three are always the Calling Line Identity
(CLI or calling number), the date and the Calling Line Name field. Other
fields may follow and are the of the form name=value. The values are
LID dependent.
A false is returned if there is no Caller ID information available, e.g.
if no ring has occurred.
*/
virtual PBoolean GetCallerID(
PString & idString, ///< ID string returned
PBoolean full = false ///< Get full information in idString
) { return device.GetCallerID(lineNumber, idString, full); }
/**Set Caller ID information.
The idString must be as a minimum a number fields for the Calling Line
Identity.
The full data of the caller ID string consists fields separated by tab
characters ('\\t'), the first three are always the Calling Line Identity
(CLI or calling number), the date and the Calling Line Name field. Other
fields may follow and are the of the form name=value. The values are
LID dependent.
If the date field is missing (e.g. two consecutive tabs) then the current
time and date is used. Using an empty string will clear the caller ID
so that no caller ID is sent on the next RingLine() call.
if the line is on hook then this information is sent when the next
RingLine() function is called to start a ring cycle. Note that if the
Ring cycle had already been started then this function may return false.
If the line is off hook, then a Caller ID on Message Waiting is sent, if
supported by the LID, otherwise false is returned.
*/
virtual PBoolean SetCallerID(
const PString & idString ///< ID string to use
) { return device.SetCallerID(lineNumber, idString); }
/**Send a Visual Message Waiting Indicator
*/
virtual PBoolean SendVisualMessageWaitingIndicator(
PBoolean on
) { return device.SendVisualMessageWaitingIndicator(lineNumber, on); }
/**Play a DTMF digit.
Any characters that are not in the set 0-9, A-D, * or # will be ignored.
*/
virtual PBoolean PlayDTMF(
const char * digits, ///< DTMF digits to be played
DWORD onTime = OpalLineInterfaceDevice::DefaultDTMFOnTime, ///< Number of milliseconds to play each DTMF digit
DWORD offTime = OpalLineInterfaceDevice::DefaultDTMFOffTime ///< Number of milliseconds between digits
) { return device.PlayDTMF(lineNumber, digits, onTime, offTime); }
/**Read a DTMF digit detected.
This may be characters from the set 0-9, A-D, * or #. A null ('\\0')
character indicates that there are no tones in the queue.
Characters E through P indicate the following tones:
E = 800 F = 1000 G = 1250 H = 950 I = 1100 J = 1400
K = 1500 L = 1600 M = 1800 N = 2100 O = 1300 P = 2450
*/
virtual char ReadDTMF() { return device.ReadDTMF(lineNumber); }
/**Get DTMF removal mode.
When set in this mode the DTMF tones detected are removed from the
encoded data stream as returned by ReadFrame().
*/
virtual PBoolean GetRemoveDTMF() { return device.GetRemoveDTMF(lineNumber); }
/**Set DTMF removal mode.
When set in this mode the DTMF tones detected are removed from the
encoded data stream as returned by ReadFrame().
*/
virtual PBoolean SetRemoveDTMF(
PBoolean removeTones ///< Flag for removing DTMF tones.
) { return device.SetRemoveDTMF(lineNumber, removeTones); }
/**See if any tone is detected.
*/
virtual OpalLineInterfaceDevice::CallProgressTones IsToneDetected() { return device.IsToneDetected(lineNumber); }
/**See if any tone is detected.
*/
virtual OpalLineInterfaceDevice::CallProgressTones WaitForToneDetect(
unsigned timeout = 3000 ///< Milliseconds to wait for
) { return device.WaitForToneDetect(lineNumber, timeout); }
/**See if a specific tone is detected.
*/
virtual PBoolean WaitForTone(
OpalLineInterfaceDevice::CallProgressTones tone, ///< Tone to wait for
unsigned timeout = 3000 ///< Milliseconds to wait for
) { return device.WaitForTone(lineNumber, tone, timeout); }
/**Play a tone.
*/
virtual PBoolean PlayTone(
OpalLineInterfaceDevice::CallProgressTones tone ///< Tone to be played
) { return device.PlayTone(lineNumber, tone); }
/**Determine if a tone is still playing
*/
virtual PBoolean IsTonePlaying() { return device.IsTonePlaying(lineNumber); }
/**Stop playing a tone.
*/
virtual PBoolean StopTone() { return device.StopTone(lineNumber); }
/**Dial a number on network line.
The takes the line off hook, waits for dial tone, and transmits the
specified number as DTMF tones.
If the requireTones flag is true the call is aborted of the call
progress tones are not detected. Otherwise the call proceeds with short
delays while it tries to detect the call progress tones.
The return code indicates the following:
DialTone No dial tone detected
RingTone Dial was successful
BusyTone The remote phone was busy
ClearTone Dial failed (usually means rang out)
NoTone There was an internal error making the call
*/
virtual OpalLineInterfaceDevice::CallProgressTones DialOut(
const PString & number, ///< Number to dial
const OpalLineInterfaceDevice::DialParams & params = OpalLineInterfaceDevice::DialParams() ///< Optional parameters for dial out.
) { return device.DialOut(lineNumber, number, params); }
//@}
/**@name Member variable access */
//@{
/**Get the device this line is on.
*/
OpalLineInterfaceDevice & GetDevice() const { return device; }
/**Get the number of the line on the device.
*/
unsigned GetLineNumber() const { return lineNumber; }
/**Get the token to uniquely identify this line.
*/
PString GetToken() const { return token; }
/**Set the token to uniquely identify this line.
*/
void SetToken(const PString & t) { token = t; }
//@}
protected:
OpalLineInterfaceDevice & device;
unsigned lineNumber;
PString token;
PTimeInterval ringStoppedTime;
PTimeInterval ringInterCadenceTime;
PTimeInterval ringTick;
unsigned ringCount;
bool lastRingState;
};
PLIST(OpalLineList, OpalLine);
/**This class embodies the description of a Line Interface Device.
An application may create a descendent off this class and override
the Create() function to make the instance of a class implementing a
transcoder.
*/
class OpalLIDRegistration : public PCaselessString
{
PCLASSINFO(OpalLIDRegistration, PCaselessString);
public:
/**@name Construction */
//@{
/**Create a new LID registration.
*/
OpalLIDRegistration(
const char * name ///< Line Interface Device type name
);
/**Destroy and remove LID registration.
*/
~OpalLIDRegistration();
//@}
/**@name Operations */
//@{
/**Create an instance of the transcoder implementation.
*/
virtual OpalLineInterfaceDevice * Create(
void * parameters ///< Arbitrary parameters for the LID
) const = 0;
//@}
protected:
OpalLIDRegistration * link;
bool duplicate;
friend class OpalLineInterfaceDevice;
};
#define OPAL_REGISTER_LID_FUNCTION(cls, type, param) \
static class cls##_Registration : public OpalLIDRegistration { \
public: \
cls##_Registration() : OpalLIDRegistration(type) { } \
OpalLineInterfaceDevice * Create(void * param) const; \
} instance_##cls##_Registration; \
OpalLineInterfaceDevice * cls##_Registration::Create(void * param) const
#ifndef OPAL_NO_PARAM
#define OPAL_NO_PARAM
#endif
#define OPAL_REGISTER_LID(cls, type) \
OPAL_REGISTER_LID_FUNCTION(cls, type, OPAL_NO_PARAM) \
{ return new cls; }
#define OPAL_REGISTER_LID_PARAM(cls, type) \
OPAL_REGISTER_LID_FUNCTION(cls, type, parameter) \
{ return new cls(parameter); }
#endif // OPAL_LIDS_LID_H
// End of File ///////////////////////////////////////////////////////////////
|