-
Notifications
You must be signed in to change notification settings - Fork 208
/
AKTelephone.h
190 lines (152 loc) · 7.37 KB
/
AKTelephone.h
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
//
// AKTelephone.h
// Telephone
//
// Copyright (c) 2008-2009 Alexei Kuznetsov. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
// 1. Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
// 3. The name of the author may not be used to endorse or promote products
// derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY ALEXEI KUZNETSOV "AS IS" AND ANY EXPRESS
// OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
// IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
// EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
#import <Foundation/Foundation.h>
#import <pjsua-lib/pjsua.h>
extern const NSInteger AKTelephoneInvalidIdentifier;
typedef struct _AKTelephoneCallData {
pj_timer_entry timer;
pj_bool_t ringbackOn;
pj_bool_t ringbackOff;
} AKTelephoneCallData;
typedef enum _AKNATType {
// NAT type is unknown because the detection has not been performed.
AKNATTypeUnknown = PJ_STUN_NAT_TYPE_UNKNOWN,
// NAT type is unknown because there is failure in the detection
// process, possibly because server does not support RFC 3489.
AKNATTypeErrorUnknown = PJ_STUN_NAT_TYPE_ERR_UNKNOWN,
// This specifies that the client has open access to Internet (or
// at least, its behind a firewall that behaves like a full-cone NAT,
// but without the translation)
AKNATTypeOpen = PJ_STUN_NAT_TYPE_OPEN,
// This specifies that communication with server has failed, probably
// because UDP packets are blocked.
AKNATTypeBlocked = PJ_STUN_NAT_TYPE_BLOCKED,
// Firewall that allows UDP out, and responses have to come back to
// the source of the request (like a symmetric NAT, but no translation.
AKNATTypeSymmetricUDP = PJ_STUN_NAT_TYPE_SYMMETRIC_UDP,
// A full cone NAT is one where all requests from the same internal
// IP address and port are mapped to the same external IP address and
// port. Furthermore, any external host can send a packet to the
// internal host, by sending a packet to the mapped external address.
AKNATTypeFullCone = PJ_STUN_NAT_TYPE_FULL_CONE,
// A symmetric NAT is one where all requests from the same internal
// IP address and port, to a specific destination IP address and port,
// are mapped to the same external IP address and port. If the same
// host sends a packet with the same source address and port, but to
// a different destination, a different mapping is used. Furthermore,
// only the external host that receives a packet can send a UDP packet
// back to the internal host.
AKNATTypeSymmetric = PJ_STUN_NAT_TYPE_SYMMETRIC,
// A restricted cone NAT is one where all requests from the same
// internal IP address and port are mapped to the same external IP
// address and port. Unlike a full cone NAT, an external host (with
// IP address X) can send a packet to the internal host only if the
// internal host had previously sent a packet to IP address X.
AKNATTypeRestricted = PJ_STUN_NAT_TYPE_RESTRICTED,
// A port restricted cone NAT is like a restricted cone NAT, but the
// restriction includes port numbers. Specifically, an external host
// can send a packet, with source IP address X and source port P,
// to the internal host only if the internal host had previously sent
// a packet to IP address X and port P.
AKNATTypePortRestricted = PJ_STUN_NAT_TYPE_PORT_RESTRICTED
} AKNATType;
@class AKTelephoneAccount, AKTelephoneCall;
@protocol AKTelephoneDelegate;
@interface AKTelephone : NSObject {
@private
id <AKTelephoneDelegate> delegate;
NSMutableArray *accounts;
BOOL started;
BOOL soundStopped;
AKNATType detectedNATType;
NSString *STUNServerHost;
NSUInteger STUNServerPort;
NSString *userAgentString;
NSString *logFileName;
NSUInteger logLevel;
NSUInteger consoleLogLevel;
BOOL detectsVoiceActivity;
NSUInteger transportPort;
// PJSUA config
AKTelephoneCallData callData[PJSUA_MAX_CALLS];
pj_pool_t *pjPool;
NSInteger ringbackSlot;
NSInteger ringbackCount;
pjmedia_port *ringbackPort;
}
@property(nonatomic, readwrite, assign) id <AKTelephoneDelegate> delegate;
@property(readonly, retain) NSMutableArray *accounts;
@property(readonly, assign) BOOL started;
@property(readonly, assign) BOOL soundStopped;
@property(readwrite, assign) AKNATType detectedNATType;
@property(nonatomic, readonly, assign) NSUInteger activeCallsCount;
@property(nonatomic, readonly, assign) AKTelephoneCallData *callData;
@property(readonly, assign) pj_pool_t *pjPool;
@property(readonly, assign) NSInteger ringbackSlot;
@property(readwrite, assign) NSInteger ringbackCount;
@property(readonly, assign) pjmedia_port *ringbackPort;
@property(readwrite, copy) NSString *STUNServerHost; // Default: @"".
@property(nonatomic, readwrite, assign) NSUInteger STUNServerPort; // Default: 3478.
@property(readwrite, copy) NSString *userAgentString; // Default: @"".
@property(nonatomic, readwrite, copy) NSString *logFileName; // Default: @"~/Library/Logs/Telephone.log".
@property(readwrite, assign) NSUInteger logLevel; // Default: 3.
@property(readwrite, assign) NSUInteger consoleLogLevel; // Default: 0.
@property(readwrite, assign) BOOL detectsVoiceActivity; // Default: YES.
@property(nonatomic, readwrite, assign) NSUInteger transportPort; // Default: 0 for any available port.
+ (id)telephoneWithDelegate:(id)aDelegate;
+ (id)telephone;
+ (AKTelephone *)sharedTelephone;
// Designated initializer
- (id)initWithDelegate:(id)aDelegate;
// Start user agent.
- (BOOL)startUserAgent;
// Destroy undelying sip user agent correctly
- (BOOL)destroyUserAgent;
// Dealing with accounts
- (BOOL)addAccount:(AKTelephoneAccount *)anAccount withPassword:(NSString *)aPassword;
- (BOOL)removeAccount:(AKTelephoneAccount *)account;
- (AKTelephoneAccount *)accountByIdentifier:(NSInteger)anIdentifier;
// Dealing with calls
- (AKTelephoneCall *)telephoneCallByIdentifier:(NSInteger)anIdentifier;
- (void)hangUpAllCalls;
// Set new sound IO.
- (BOOL)setSoundInputDevice:(NSInteger)input soundOutputDevice:(NSInteger)output;
- (BOOL)stopSound;
// Update list of audio devices.
// After calling this method, setSoundInputDevice:soundOutputDevice: must be called to set appropriate IO.
- (void)updateAudioDevices;
- (NSString *)stringForSIPResponseCode:(NSInteger)responseCode;
@end
// Callback from PJSUA
void AKTelephoneDetectedNAT(const pj_stun_nat_detect_result *result);
@protocol AKTelephoneDelegate <NSObject>
@optional
- (BOOL)telephoneShouldAddAccount:(AKTelephoneAccount *)anAccount;
@end
// Notifications.
extern NSString * const AKTelephoneDidDetectNATNotification;