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;
49 struct SalCustomHeader;
51 typedef struct SalCustomHeader SalCustomHeader;
54 SalTransportUDP, /*UDP*/
55 SalTransportTCP, /*TCP*/
56 SalTransportTLS, /*TLS*/
57 SalTransportDTLS /*DTLS*/
60 #define SAL_MEDIA_DESCRIPTION_UNCHANGED 0x00
61 #define SAL_MEDIA_DESCRIPTION_NETWORK_CHANGED 0x01
62 #define SAL_MEDIA_DESCRIPTION_CODEC_CHANGED 0x02
63 #define SAL_MEDIA_DESCRIPTION_CRYPTO_CHANGED 0x04
64 #define SAL_MEDIA_DESCRIPTION_CHANGED (SAL_MEDIA_DESCRIPTION_NETWORK_CHANGED | SAL_MEDIA_DESCRIPTION_CODEC_CHANGED | SAL_MEDIA_DESCRIPTION_CRYPTO_CHANGED)
66 const char* sal_transport_to_string(SalTransport transport);
67 SalTransport sal_transport_parse(const char*);
68 /* Address manipulation API*/
69 SalAddress * sal_address_new(const char *uri);
70 SalAddress * sal_address_clone(const SalAddress *addr);
71 const char *sal_address_get_scheme(const SalAddress *addr);
72 const char *sal_address_get_display_name(const SalAddress* addr);
73 char *sal_address_get_display_name_unquoted(const SalAddress *addr);
74 const char *sal_address_get_username(const SalAddress *addr);
75 const char *sal_address_get_domain(const SalAddress *addr);
76 const char * sal_address_get_port(const SalAddress *addr);
77 int sal_address_get_port_int(const SalAddress *addr);
78 SalTransport sal_address_get_transport(const SalAddress* addr);
80 void sal_address_set_display_name(SalAddress *addr, const char *display_name);
81 void sal_address_set_username(SalAddress *addr, const char *username);
82 void sal_address_set_domain(SalAddress *addr, const char *host);
83 void sal_address_set_port(SalAddress *addr, const char *port);
84 void sal_address_set_port_int(SalAddress *uri, int port);
85 void sal_address_clean(SalAddress *addr);
86 char *sal_address_as_string(const SalAddress *u);
87 char *sal_address_as_string_uri_only(const SalAddress *u);
88 void sal_address_destroy(SalAddress *u);
89 void sal_address_set_param(SalAddress *u,const char* name,const char* value);
90 void sal_address_set_transport(SalAddress* addr,SalTransport transport);
94 void sal_uninit(Sal* sal);
95 void sal_set_user_pointer(Sal *sal, void *user_data);
96 void *sal_get_user_pointer(const Sal *sal);
118 #define SAL_ENDPOINT_CANDIDATE_MAX 2
120 #define SAL_MEDIA_DESCRIPTION_MAX_ICE_ADDR_LEN 64
121 #define SAL_MEDIA_DESCRIPTION_MAX_ICE_FOUNDATION_LEN 32
122 #define SAL_MEDIA_DESCRIPTION_MAX_ICE_TYPE_LEN 6
124 typedef struct SalIceCandidate {
125 char addr[SAL_MEDIA_DESCRIPTION_MAX_ICE_ADDR_LEN];
126 char raddr[SAL_MEDIA_DESCRIPTION_MAX_ICE_ADDR_LEN];
127 char foundation[SAL_MEDIA_DESCRIPTION_MAX_ICE_FOUNDATION_LEN];
128 char type[SAL_MEDIA_DESCRIPTION_MAX_ICE_TYPE_LEN];
129 unsigned int componentID;
130 unsigned int priority;
135 #define SAL_MEDIA_DESCRIPTION_MAX_ICE_CANDIDATES 10
137 typedef struct SalIceRemoteCandidate {
138 char addr[SAL_MEDIA_DESCRIPTION_MAX_ICE_ADDR_LEN];
140 } SalIceRemoteCandidate;
142 #define SAL_MEDIA_DESCRIPTION_MAX_ICE_REMOTE_CANDIDATES 2
143 #define SAL_MEDIA_DESCRIPTION_MAX_ZRTP_HELLO_HASH 128
144 #define SAL_MEDIA_DESCRIPTION_MAX_ICE_UFRAG_LEN 256
145 #define SAL_MEDIA_DESCRIPTION_MAX_ICE_PWD_LEN 256
147 typedef struct SalSrtpCryptoAlgo {
149 enum ortp_srtp_crypto_suite_t algo;
150 /* 41= 40 max(key_length for all algo) + '\0' */
154 #define SAL_CRYPTO_ALGO_MAX 4
156 typedef struct SalStreamDescription{
164 MSList *payloads; //<list of PayloadType
168 SalSrtpCryptoAlgo crypto[SAL_CRYPTO_ALGO_MAX];
169 unsigned int crypto_local_tag;
171 SalIceCandidate ice_candidates[SAL_MEDIA_DESCRIPTION_MAX_ICE_CANDIDATES];
172 SalIceRemoteCandidate ice_remote_candidates[SAL_MEDIA_DESCRIPTION_MAX_ICE_REMOTE_CANDIDATES];
173 char ice_ufrag[SAL_MEDIA_DESCRIPTION_MAX_ICE_UFRAG_LEN];
174 char ice_pwd[SAL_MEDIA_DESCRIPTION_MAX_ICE_PWD_LEN];
175 char zrtp_hello_hash[SAL_MEDIA_DESCRIPTION_MAX_ZRTP_HELLO_HASH];
177 bool_t ice_completed;
178 } SalStreamDescription;
180 #define SAL_MEDIA_DESCRIPTION_MAX_STREAMS 4
182 typedef struct SalMediaDescription{
186 int n_active_streams;
189 unsigned int session_ver;
190 unsigned int session_id;
191 SalStreamDescription streams[SAL_MEDIA_DESCRIPTION_MAX_STREAMS];
192 char ice_ufrag[SAL_MEDIA_DESCRIPTION_MAX_ICE_UFRAG_LEN];
193 char ice_pwd[SAL_MEDIA_DESCRIPTION_MAX_ICE_PWD_LEN];
195 bool_t ice_completed;
196 } SalMediaDescription;
198 typedef struct SalMessage{
202 const char *message_id;
206 #define SAL_MEDIA_DESCRIPTION_MAX_MESSAGE_ATTRIBUTES 5
208 SalMediaDescription *sal_media_description_new();
209 void sal_media_description_ref(SalMediaDescription *md);
210 void sal_media_description_unref(SalMediaDescription *md);
211 bool_t sal_media_description_empty(const SalMediaDescription *md);
212 int sal_media_description_equals(const SalMediaDescription *md1, const SalMediaDescription *md2);
213 bool_t sal_media_description_has_dir(const SalMediaDescription *md, SalStreamDir dir);
214 SalStreamDescription *sal_media_description_find_stream(SalMediaDescription *md,
215 SalMediaProto proto, SalStreamType type);
216 void sal_media_description_set_dir(SalMediaDescription *md, SalStreamDir stream_dir);
218 /*this structure must be at the first byte of the SalOp structure defined by implementors*/
219 typedef struct SalOpBase{
221 char *route; /*or request-uri for REGISTER*/
227 SalMediaDescription *local_media;
228 SalMediaDescription *remote_media;
231 char *remote_contact;
232 SalCustomHeader *custom_headers;
236 typedef enum SalError{
239 SalErrorFailure, /* see SalReason for more details */
243 typedef enum SalReason{
247 SalReasonTemporarilyUnavailable,
249 SalReasonDoNotDisturb,
255 typedef enum SalPresenceStatus{
259 SalPresenceBerightback,
261 SalPresenceOnthephone,
262 SalPresenceOuttolunch,
263 SalPresenceDonotdisturb,
265 SalPresenceAltService,
268 typedef enum SalReferStatus{
274 typedef enum SalSubscribeStatus{
276 SalSubscribeTerminated
279 typedef enum SalTextDeliveryStatus{
280 SalTextDeliveryInProgress,
282 SalTextDeliveryFailed
283 }SalTextDeliveryStatus;
285 typedef void (*SalOnCallReceived)(SalOp *op);
286 typedef void (*SalOnCallRinging)(SalOp *op);
287 typedef void (*SalOnCallAccepted)(SalOp *op);
288 typedef void (*SalOnCallAck)(SalOp *op);
289 typedef void (*SalOnCallUpdating)(SalOp *op);/*< Called when a reINVITE is received*/
290 typedef void (*SalOnCallTerminated)(SalOp *op, const char *from);
291 typedef void (*SalOnCallFailure)(SalOp *op, SalError error, SalReason reason, const char *details, int code);
292 typedef void (*SalOnCallReleased)(SalOp *salop);
293 typedef void (*SalOnAuthRequested)(SalOp *op, const char *realm, const char *username);
294 typedef void (*SalOnAuthSuccess)(SalOp *op, const char *realm, const char *username);
295 typedef void (*SalOnRegisterSuccess)(SalOp *op, bool_t registered);
296 typedef void (*SalOnRegisterFailure)(SalOp *op, SalError error, SalReason reason, const char *details);
297 typedef void (*SalOnVfuRequest)(SalOp *op);
298 typedef void (*SalOnDtmfReceived)(SalOp *op, char dtmf);
299 typedef void (*SalOnRefer)(Sal *sal, SalOp *op, const char *referto);
300 typedef void (*SalOnTextReceived)(SalOp *op, const SalMessage *msg);
301 typedef void (*SalOnTextDeliveryUpdate)(SalOp *op, SalTextDeliveryStatus status);
302 typedef void (*SalOnNotify)(SalOp *op, const char *from, const char *event);
303 typedef void (*SalOnNotifyRefer)(SalOp *op, SalReferStatus state);
304 typedef void (*SalOnNotifyPresence)(SalOp *op, SalSubscribeStatus ss, SalPresenceStatus status, const char *msg);
305 typedef void (*SalOnSubscribeReceived)(SalOp *salop, const char *from);
306 typedef void (*SalOnSubscribeClosed)(SalOp *salop, const char *from);
307 typedef void (*SalOnPingReply)(SalOp *salop);
309 typedef struct SalCallbacks{
310 SalOnCallReceived call_received;
311 SalOnCallRinging call_ringing;
312 SalOnCallAccepted call_accepted;
313 SalOnCallAck call_ack;
314 SalOnCallUpdating call_updating;
315 SalOnCallTerminated call_terminated;
316 SalOnCallFailure call_failure;
317 SalOnCallReleased call_released;
318 SalOnAuthRequested auth_requested;
319 SalOnAuthSuccess auth_success;
320 SalOnRegisterSuccess register_success;
321 SalOnRegisterFailure register_failure;
322 SalOnVfuRequest vfu_request;
323 SalOnDtmfReceived dtmf_received;
324 SalOnRefer refer_received;
325 SalOnTextReceived text_received;
326 SalOnTextDeliveryUpdate text_delivery_update;
328 SalOnNotifyPresence notify_presence;
329 SalOnNotifyRefer notify_refer;
330 SalOnSubscribeReceived subscribe_received;
331 SalOnSubscribeClosed subscribe_closed;
332 SalOnPingReply ping_reply;
335 typedef struct SalAuthInfo{
342 SalAuthInfo* sal_auth_info_new();
343 SalAuthInfo* sal_auth_info_clone(const SalAuthInfo* auth_info);
344 void sal_auth_info_delete(const SalAuthInfo* auth_info);
346 void sal_set_callbacks(Sal *ctx, const SalCallbacks *cbs);
347 int sal_listen_port(Sal *ctx, const char *addr, int port, SalTransport tr, int is_secure);
348 int sal_unlisten_ports(Sal *ctx);
349 void sal_set_dscp(Sal *ctx, int dscp);
350 int sal_reset_transports(Sal *ctx);
351 ortp_socket_t sal_get_socket(Sal *ctx);
352 void sal_set_user_agent(Sal *ctx, const char *user_agent);
353 /*keepalive period in ms*/
354 void sal_set_keepalive_period(Sal *ctx,unsigned int value);
355 void sal_use_tcp_tls_keepalive(Sal *ctx, bool_t enabled);
357 * returns keepalive period in ms
360 unsigned int sal_get_keepalive_period(Sal *ctx);
361 void sal_use_session_timers(Sal *ctx, int expires);
362 void sal_use_double_registrations(Sal *ctx, bool_t enabled);
363 void sal_expire_old_registration_contacts(Sal *ctx, bool_t enabled);
364 void sal_use_dates(Sal *ctx, bool_t enabled);
365 void sal_reuse_authorization(Sal *ctx, bool_t enabled);
366 void sal_use_one_matching_codec_policy(Sal *ctx, bool_t one_matching_codec);
367 void sal_use_rport(Sal *ctx, bool_t use_rports);
368 void sal_use_101(Sal *ctx, bool_t use_101);
369 void sal_set_root_ca(Sal* ctx, const char* rootCa);
370 const char *sal_get_root_ca(Sal* ctx);
371 void sal_verify_server_certificates(Sal *ctx, bool_t verify);
372 void sal_verify_server_cn(Sal *ctx, bool_t verify);
374 int sal_iterate(Sal *sal);
375 MSList * sal_get_pending_auths(Sal *sal);
377 /*create an operation */
378 SalOp * sal_op_new(Sal *sal);
380 /*generic SalOp API, working for all operations */
381 Sal *sal_op_get_sal(const SalOp *op);
382 void sal_op_set_contact(SalOp *op, const char *contact);
383 void sal_op_set_route(SalOp *op, const char *route);
384 void sal_op_set_from(SalOp *op, const char *from);
385 void sal_op_set_to(SalOp *op, const char *to);
386 void sal_op_release(SalOp *h);
387 void sal_op_authenticate(SalOp *h, const SalAuthInfo *info);
388 void sal_op_cancel_authentication(SalOp *h);
389 void sal_op_set_user_pointer(SalOp *h, void *up);
390 int sal_op_get_auth_requested(SalOp *h, const char **realm, const char **username);
391 const char *sal_op_get_from(const SalOp *op);
392 const char *sal_op_get_to(const SalOp *op);
393 const char *sal_op_get_contact(const SalOp *op);
394 const char *sal_op_get_route(const SalOp *op);
395 const char *sal_op_get_proxy(const SalOp *op);
396 const char *sal_op_get_remote_contact(const SalOp *op);
397 /*for incoming requests, returns the origin of the packet as a sip uri*/
398 const char *sal_op_get_network_origin(const SalOp *op);
399 /*returns far-end "User-Agent" string */
400 const char *sal_op_get_remote_ua(const SalOp *op);
401 void *sal_op_get_user_pointer(const SalOp *op);
402 const char* sal_op_get_call_id(const SalOp *op);
405 int sal_call_set_local_media_description(SalOp *h, SalMediaDescription *desc);
406 int sal_call(SalOp *h, const char *from, const char *to);
407 int sal_call_notify_ringing(SalOp *h, bool_t early_media);
408 /*accept an incoming call or, during a call accept a reINVITE*/
409 int sal_call_accept(SalOp*h);
410 int sal_call_decline(SalOp *h, SalReason reason, const char *redirection /*optional*/);
411 int sal_call_update(SalOp *h, const char *subject);
412 SalMediaDescription * sal_call_get_remote_media_description(SalOp *h);
413 SalMediaDescription * sal_call_get_final_media_description(SalOp *h);
414 int sal_call_refer(SalOp *h, const char *refer_to);
415 int sal_call_refer_with_replaces(SalOp *h, SalOp *other_call_h);
416 int sal_call_accept_refer(SalOp *h);
417 /*informs this call is consecutive to an incoming refer */
418 int sal_call_set_referer(SalOp *h, SalOp *refered_call);
419 /* returns the SalOp of a call that should be replaced by h, if any */
420 SalOp *sal_call_get_replaces(SalOp *h);
421 int sal_call_send_dtmf(SalOp *h, char dtmf);
422 int sal_call_terminate(SalOp *h);
423 bool_t sal_call_autoanswer_asked(SalOp *op);
424 void sal_call_send_vfu_request(SalOp *h);
425 int sal_call_is_offerer(const SalOp *h);
426 int sal_call_notify_refer_state(SalOp *h, SalOp *newcall);
429 int sal_register(SalOp *op, const char *proxy, const char *from, int expires);
430 int sal_register_refresh(SalOp *op, int expires);
431 int sal_unregister(SalOp *h);
434 int sal_text_send(SalOp *op, const char *from, const char *to, const char *text);
435 int sal_message_send(SalOp *op, const char *from, const char *to, const char* content_type, const char *msg);
437 /*presence Subscribe/notify*/
438 int sal_subscribe_presence(SalOp *op, const char *from, const char *to);
439 int sal_unsubscribe(SalOp *op);
440 int sal_subscribe_accept(SalOp *op);
441 int sal_subscribe_decline(SalOp *op);
442 int sal_notify_presence(SalOp *op, SalPresenceStatus status, const char *status_message);
443 int sal_notify_close(SalOp *op);
445 /*presence publish */
446 int sal_publish(SalOp *op, const char *from, const char *to, SalPresenceStatus status);
449 /*ping: main purpose is to obtain its own contact address behind firewalls*/
450 int sal_ping(SalOp *op, const char *from, const char *to);
454 #define payload_type_set_number(pt,n) (pt)->user_data=(void*)((long)n);
455 #define payload_type_get_number(pt) ((int)(long)(pt)->user_data)
458 void sal_get_default_local_ip(Sal *sal, int address_family, char *ip, size_t iplen);
460 struct SalCustomHeader{
466 SalCustomHeader *sal_custom_header_append(SalCustomHeader *ch, const char *name, const char *value);
467 const char *sal_custom_header_find(const SalCustomHeader *ch, const char *name);
468 void sal_custom_header_free(SalCustomHeader *ch);
469 SalCustomHeader *sal_custom_header_clone(const SalCustomHeader *ch);
470 const SalCustomHeader *sal_op_get_custom_header(SalOp *op);
471 void sal_op_set_custom_header(SalOp *op, SalCustomHeader* ch);
475 void __sal_op_init(SalOp *b, Sal *sal);
476 void __sal_op_set_network_origin(SalOp *op, const char *origin /*a sip uri*/);
477 void __sal_op_set_remote_contact(SalOp *op, const char *ct);
478 void __sal_op_free(SalOp *b);