3 Copyright (C) 2010 Simon MORLAT (simon.morlat@free.fr)
5 This program is free software; you can redistribute it and/or
6 modify it under the terms of the GNU General Public License
7 as published by the Free Software Foundation; either version 2
8 of the License, or (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
21 This header files defines the Signaling Abstraction Layer.
22 The purpose of this layer is too allow experiment different call signaling
23 protocols and implementations under linphone, for example SIP, JINGLE...
29 #include "mediastreamer2/mscommon.h"
30 #include "ortp/ortp_srtp.h"
32 /*Dirty hack, keep in sync with mediastreamer2/include/mediastream.h */
33 #ifndef PAYLOAD_TYPE_FLAG_CAN_RECV
34 #define PAYLOAD_TYPE_FLAG_CAN_RECV PAYLOAD_TYPE_USER_FLAG_1
35 #define PAYLOAD_TYPE_FLAG_CAN_SEND PAYLOAD_TYPE_USER_FLAG_2
39 typedef struct Sal Sal;
43 typedef struct SalOp SalOp;
47 typedef struct SalAddress SalAddress;
50 SalTransportUDP, /*UDP*/
51 SalTransportTCP, /*TCP*/
52 SalTransportTLS, /*TLS*/
53 SalTransportDTLS /*DTLS*/
56 #define SAL_MEDIA_DESCRIPTION_UNCHANGED 0x00
57 #define SAL_MEDIA_DESCRIPTION_NETWORK_CHANGED 0x01
58 #define SAL_MEDIA_DESCRIPTION_CODEC_CHANGED 0x02
59 #define SAL_MEDIA_DESCRIPTION_CHANGED (SAL_MEDIA_DESCRIPTION_NETWORK_CHANGED | SAL_MEDIA_DESCRIPTION_CODEC_CHANGED)
61 const char* sal_transport_to_string(SalTransport transport);
62 SalTransport sal_transport_parse(const char*);
63 /* Address manipulation API*/
64 SalAddress * sal_address_new(const char *uri);
65 SalAddress * sal_address_clone(const SalAddress *addr);
66 const char *sal_address_get_scheme(const SalAddress *addr);
67 const char *sal_address_get_display_name(const SalAddress* addr);
68 char *sal_address_get_display_name_unquoted(const SalAddress *addr);
69 const char *sal_address_get_username(const SalAddress *addr);
70 const char *sal_address_get_domain(const SalAddress *addr);
71 const char * sal_address_get_port(const SalAddress *addr);
72 int sal_address_get_port_int(const SalAddress *addr);
73 SalTransport sal_address_get_transport(const SalAddress* addr);
75 void sal_address_set_display_name(SalAddress *addr, const char *display_name);
76 void sal_address_set_username(SalAddress *addr, const char *username);
77 void sal_address_set_domain(SalAddress *addr, const char *host);
78 void sal_address_set_port(SalAddress *addr, const char *port);
79 void sal_address_set_port_int(SalAddress *uri, int port);
80 void sal_address_clean(SalAddress *addr);
81 char *sal_address_as_string(const SalAddress *u);
82 char *sal_address_as_string_uri_only(const SalAddress *u);
83 void sal_address_destroy(SalAddress *u);
84 void sal_address_set_param(SalAddress *u,const char* name,const char* value);
85 void sal_address_set_transport(SalAddress* addr,SalTransport transport);
89 void sal_uninit(Sal* sal);
90 void sal_set_user_pointer(Sal *sal, void *user_data);
91 void *sal_get_user_pointer(const Sal *sal);
113 #define SAL_ENDPOINT_CANDIDATE_MAX 2
115 #define SAL_MEDIA_DESCRIPTION_MAX_ICE_ADDR_LEN 64
116 #define SAL_MEDIA_DESCRIPTION_MAX_ICE_FOUNDATION_LEN 32
117 #define SAL_MEDIA_DESCRIPTION_MAX_ICE_TYPE_LEN 6
119 typedef struct SalIceCandidate {
120 char addr[SAL_MEDIA_DESCRIPTION_MAX_ICE_ADDR_LEN];
121 char raddr[SAL_MEDIA_DESCRIPTION_MAX_ICE_ADDR_LEN];
122 char foundation[SAL_MEDIA_DESCRIPTION_MAX_ICE_FOUNDATION_LEN];
123 char type[SAL_MEDIA_DESCRIPTION_MAX_ICE_TYPE_LEN];
124 unsigned int componentID;
125 unsigned int priority;
130 #define SAL_MEDIA_DESCRIPTION_MAX_ICE_CANDIDATES 10
132 typedef struct SalIceRemoteCandidate {
133 char addr[SAL_MEDIA_DESCRIPTION_MAX_ICE_ADDR_LEN];
135 } SalIceRemoteCandidate;
137 #define SAL_MEDIA_DESCRIPTION_MAX_ICE_REMOTE_CANDIDATES 2
139 #define SAL_MEDIA_DESCRIPTION_MAX_ICE_UFRAG_LEN 256
140 #define SAL_MEDIA_DESCRIPTION_MAX_ICE_PWD_LEN 256
142 typedef struct SalSrtpCryptoAlgo {
144 enum ortp_srtp_crypto_suite_t algo;
145 /* 41= 40 max(key_length for all algo) + '\0' */
149 #define SAL_CRYPTO_ALGO_MAX 4
151 typedef struct SalStreamDescription{
159 MSList *payloads; //<list of PayloadType
163 SalSrtpCryptoAlgo crypto[SAL_CRYPTO_ALGO_MAX];
164 unsigned int crypto_local_tag;
166 SalIceCandidate ice_candidates[SAL_MEDIA_DESCRIPTION_MAX_ICE_CANDIDATES];
167 SalIceRemoteCandidate ice_remote_candidates[SAL_MEDIA_DESCRIPTION_MAX_ICE_REMOTE_CANDIDATES];
168 char ice_ufrag[SAL_MEDIA_DESCRIPTION_MAX_ICE_UFRAG_LEN];
169 char ice_pwd[SAL_MEDIA_DESCRIPTION_MAX_ICE_PWD_LEN];
171 bool_t ice_completed;
172 } SalStreamDescription;
174 #define SAL_MEDIA_DESCRIPTION_MAX_STREAMS 4
176 typedef struct SalMediaDescription{
182 unsigned int session_ver;
183 unsigned int session_id;
184 SalStreamDescription streams[SAL_MEDIA_DESCRIPTION_MAX_STREAMS];
185 char ice_ufrag[SAL_MEDIA_DESCRIPTION_MAX_ICE_UFRAG_LEN];
186 char ice_pwd[SAL_MEDIA_DESCRIPTION_MAX_ICE_PWD_LEN];
188 bool_t ice_completed;
189 } SalMediaDescription;
191 typedef struct SalMessage{
195 const char *message_id;
198 #define SAL_MEDIA_DESCRIPTION_MAX_MESSAGE_ATTRIBUTES 5
200 SalMediaDescription *sal_media_description_new();
201 void sal_media_description_ref(SalMediaDescription *md);
202 void sal_media_description_unref(SalMediaDescription *md);
203 bool_t sal_media_description_empty(const SalMediaDescription *md);
204 int sal_media_description_equals(const SalMediaDescription *md1, const SalMediaDescription *md2);
205 bool_t sal_media_description_has_dir(const SalMediaDescription *md, SalStreamDir dir);
206 SalStreamDescription *sal_media_description_find_stream(SalMediaDescription *md,
207 SalMediaProto proto, SalStreamType type);
208 void sal_media_description_set_dir(SalMediaDescription *md, SalStreamDir stream_dir);
210 /*this structure must be at the first byte of the SalOp structure defined by implementors*/
211 typedef struct SalOpBase{
213 char *route; /*or request-uri for REGISTER*/
219 SalMediaDescription *local_media;
220 SalMediaDescription *remote_media;
226 typedef enum SalError{
229 SalErrorFailure, /* see SalReason for more details */
233 typedef enum SalReason{
237 SalReasonTemporarilyUnavailable,
239 SalReasonDoNotDisturb,
245 typedef enum SalPresenceStatus{
249 SalPresenceBerightback,
251 SalPresenceOnthephone,
252 SalPresenceOuttolunch,
253 SalPresenceDonotdisturb,
255 SalPresenceAltService,
258 typedef enum SalReferStatus{
264 typedef enum SalSubscribeStatus{
266 SalSubscribeTerminated
269 typedef enum SalTextDeliveryStatus{
270 SalTextDeliveryInProgress,
272 SalTextDeliveryFailed
273 }SalTextDeliveryStatus;
275 typedef void (*SalOnCallReceived)(SalOp *op);
276 typedef void (*SalOnCallRinging)(SalOp *op);
277 typedef void (*SalOnCallAccepted)(SalOp *op);
278 typedef void (*SalOnCallAck)(SalOp *op);
279 typedef void (*SalOnCallUpdating)(SalOp *op);/*< Called when a reINVITE is received*/
280 typedef void (*SalOnCallTerminated)(SalOp *op, const char *from);
281 typedef void (*SalOnCallFailure)(SalOp *op, SalError error, SalReason reason, const char *details, int code);
282 typedef void (*SalOnCallReleased)(SalOp *salop);
283 typedef void (*SalOnAuthRequested)(SalOp *op, const char *realm, const char *username);
284 typedef void (*SalOnAuthSuccess)(SalOp *op, const char *realm, const char *username);
285 typedef void (*SalOnRegisterSuccess)(SalOp *op, bool_t registered);
286 typedef void (*SalOnRegisterFailure)(SalOp *op, SalError error, SalReason reason, const char *details);
287 typedef void (*SalOnVfuRequest)(SalOp *op);
288 typedef void (*SalOnDtmfReceived)(SalOp *op, char dtmf);
289 typedef void (*SalOnRefer)(Sal *sal, SalOp *op, const char *referto);
290 typedef void (*SalOnTextReceived)(Sal *sal, const SalMessage *msg);
291 typedef void (*SalOnTextDeliveryUpdate)(SalOp *op, SalTextDeliveryStatus status);
292 typedef void (*SalOnNotify)(SalOp *op, const char *from, const char *event);
293 typedef void (*SalOnNotifyRefer)(SalOp *op, SalReferStatus state);
294 typedef void (*SalOnNotifyPresence)(SalOp *op, SalSubscribeStatus ss, SalPresenceStatus status, const char *msg);
295 typedef void (*SalOnSubscribeReceived)(SalOp *salop, const char *from);
296 typedef void (*SalOnSubscribeClosed)(SalOp *salop, const char *from);
297 typedef void (*SalOnPingReply)(SalOp *salop);
299 typedef struct SalCallbacks{
300 SalOnCallReceived call_received;
301 SalOnCallRinging call_ringing;
302 SalOnCallAccepted call_accepted;
303 SalOnCallAck call_ack;
304 SalOnCallUpdating call_updating;
305 SalOnCallTerminated call_terminated;
306 SalOnCallFailure call_failure;
307 SalOnCallReleased call_released;
308 SalOnAuthRequested auth_requested;
309 SalOnAuthSuccess auth_success;
310 SalOnRegisterSuccess register_success;
311 SalOnRegisterFailure register_failure;
312 SalOnVfuRequest vfu_request;
313 SalOnDtmfReceived dtmf_received;
314 SalOnRefer refer_received;
315 SalOnTextReceived text_received;
316 SalOnTextDeliveryUpdate text_delivery_update;
318 SalOnNotifyPresence notify_presence;
319 SalOnNotifyRefer notify_refer;
320 SalOnSubscribeReceived subscribe_received;
321 SalOnSubscribeClosed subscribe_closed;
322 SalOnPingReply ping_reply;
325 typedef struct SalAuthInfo{
332 SalAuthInfo* sal_auth_info_new();
333 SalAuthInfo* sal_auth_info_clone(const SalAuthInfo* auth_info);
334 void sal_auth_info_delete(const SalAuthInfo* auth_info);
336 void sal_set_callbacks(Sal *ctx, const SalCallbacks *cbs);
337 int sal_listen_port(Sal *ctx, const char *addr, int port, SalTransport tr, int is_secure);
338 int sal_unlisten_ports(Sal *ctx);
339 void sal_set_dscp(Sal *ctx, int dscp);
340 int sal_reset_transports(Sal *ctx);
341 ortp_socket_t sal_get_socket(Sal *ctx);
342 void sal_set_user_agent(Sal *ctx, const char *user_agent);
343 /*keepalive period in ms*/
344 void sal_set_keepalive_period(Sal *ctx,unsigned int value);
346 * returns keepalive period in ms
349 unsigned int sal_get_keepalive_period(Sal *ctx);
350 void sal_use_session_timers(Sal *ctx, int expires);
351 void sal_use_double_registrations(Sal *ctx, bool_t enabled);
352 void sal_expire_old_registration_contacts(Sal *ctx, bool_t enabled);
353 void sal_use_dates(Sal *ctx, bool_t enabled);
354 void sal_reuse_authorization(Sal *ctx, bool_t enabled);
355 void sal_use_one_matching_codec_policy(Sal *ctx, bool_t one_matching_codec);
356 void sal_use_rport(Sal *ctx, bool_t use_rports);
357 void sal_use_101(Sal *ctx, bool_t use_101);
358 void sal_set_root_ca(Sal* ctx, const char* rootCa);
359 void sal_verify_server_certificates(Sal *ctx, bool_t verify);
361 int sal_iterate(Sal *sal);
362 MSList * sal_get_pending_auths(Sal *sal);
364 /*create an operation */
365 SalOp * sal_op_new(Sal *sal);
367 /*generic SalOp API, working for all operations */
368 Sal *sal_op_get_sal(const SalOp *op);
369 void sal_op_set_contact(SalOp *op, const char *contact);
370 void sal_op_set_route(SalOp *op, const char *route);
371 void sal_op_set_from(SalOp *op, const char *from);
372 void sal_op_set_to(SalOp *op, const char *to);
373 void sal_op_release(SalOp *h);
374 void sal_op_authenticate(SalOp *h, const SalAuthInfo *info);
375 void sal_op_cancel_authentication(SalOp *h);
376 void sal_op_set_user_pointer(SalOp *h, void *up);
377 int sal_op_get_auth_requested(SalOp *h, const char **realm, const char **username);
378 const char *sal_op_get_from(const SalOp *op);
379 const char *sal_op_get_to(const SalOp *op);
380 const char *sal_op_get_contact(const SalOp *op);
381 const char *sal_op_get_route(const SalOp *op);
382 const char *sal_op_get_proxy(const SalOp *op);
383 /*for incoming requests, returns the origin of the packet as a sip uri*/
384 const char *sal_op_get_network_origin(const SalOp *op);
385 /*returns far-end "User-Agent" string */
386 const char *sal_op_get_remote_ua(const SalOp *op);
387 void *sal_op_get_user_pointer(const SalOp *op);
388 const char* sal_op_get_call_id(const SalOp *op);
391 int sal_call_set_local_media_description(SalOp *h, SalMediaDescription *desc);
392 int sal_call(SalOp *h, const char *from, const char *to);
393 int sal_call_notify_ringing(SalOp *h, bool_t early_media);
394 /*accept an incoming call or, during a call accept a reINVITE*/
395 int sal_call_accept(SalOp*h);
396 int sal_call_decline(SalOp *h, SalReason reason, const char *redirection /*optional*/);
397 int sal_call_update(SalOp *h, const char *subject);
398 SalMediaDescription * sal_call_get_remote_media_description(SalOp *h);
399 SalMediaDescription * sal_call_get_final_media_description(SalOp *h);
400 int sal_call_refer(SalOp *h, const char *refer_to);
401 int sal_call_refer_with_replaces(SalOp *h, SalOp *other_call_h);
402 int sal_call_accept_refer(SalOp *h);
403 /*informs this call is consecutive to an incoming refer */
404 int sal_call_set_referer(SalOp *h, SalOp *refered_call);
405 /* returns the SalOp of a call that should be replaced by h, if any */
406 SalOp *sal_call_get_replaces(SalOp *h);
407 int sal_call_send_dtmf(SalOp *h, char dtmf);
408 int sal_call_terminate(SalOp *h);
409 bool_t sal_call_autoanswer_asked(SalOp *op);
410 void sal_call_send_vfu_request(SalOp *h);
411 int sal_call_is_offerer(const SalOp *h);
412 int sal_call_notify_refer_state(SalOp *h, SalOp *newcall);
415 int sal_register(SalOp *op, const char *proxy, const char *from, int expires);
416 int sal_register_refresh(SalOp *op, int expires);
417 int sal_unregister(SalOp *h);
420 int sal_text_send(SalOp *op, const char *from, const char *to, const char *text);
421 int sal_message_send(SalOp *op, const char *from, const char *to, const char* content_type, const char *msg);
423 /*presence Subscribe/notify*/
424 int sal_subscribe_presence(SalOp *op, const char *from, const char *to);
425 int sal_unsubscribe(SalOp *op);
426 int sal_subscribe_accept(SalOp *op);
427 int sal_subscribe_decline(SalOp *op);
428 int sal_notify_presence(SalOp *op, SalPresenceStatus status, const char *status_message);
429 int sal_notify_close(SalOp *op);
431 /*presence publish */
432 int sal_publish(SalOp *op, const char *from, const char *to, SalPresenceStatus status);
435 /*ping: main purpose is to obtain its own contact address behind firewalls*/
436 int sal_ping(SalOp *op, const char *from, const char *to);
440 #define payload_type_set_number(pt,n) (pt)->user_data=(void*)((long)n);
441 #define payload_type_get_number(pt) ((int)(long)(pt)->user_data)
444 void sal_get_default_local_ip(Sal *sal, int address_family, char *ip, size_t iplen);
448 void __sal_op_init(SalOp *b, Sal *sal);
449 void __sal_op_set_network_origin(SalOp *op, const char *origin /*a sip uri*/);
450 void __sal_op_free(SalOp *b);