sjero.net Git - linphone/blob - coreapi/sal.h

   1 /*
   2 linphone
   3 Copyright (C) 2010  Simon MORLAT (simon.morlat@free.fr)
   4
   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.
   9
  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.
  14
  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.
  18 */
  19
  20 /**
  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...
  24 **/
  25
  26 #ifndef sal_h
  27 #define sal_h
  28
  29 #include "mediastreamer2/mscommon.h"
  30 #include "ortp/ortp_srtp.h"
  31
  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
  36 #endif
  37 struct Sal;
  38
  39 typedef struct Sal Sal;
  40
  41 struct SalOp;
  42
  43 typedef struct SalOp SalOp;
  44
  45 struct SalAddress;
  46
  47 typedef struct SalAddress SalAddress;
  48
  49 struct SalCustomHeader;
  50
  51 typedef struct SalCustomHeader SalCustomHeader;
  52
  53 typedef enum {
  54         SalTransportUDP, /*UDP*/
  55         SalTransportTCP, /*TCP*/
  56         SalTransportTLS, /*TLS*/
  57         SalTransportDTLS /*DTLS*/
  58 }SalTransport;
  59
  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)
  65
  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);
  79
  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);
  91
  92
  93 Sal * sal_init();
  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);
  97
  98
  99 typedef enum {
 100         SalAudio,
 101         SalVideo,
 102         SalOther
 103 } SalStreamType;
 104
 105 typedef enum{
 106         SalProtoUnknown,
 107         SalProtoRtpAvp,
 108         SalProtoRtpSavp
 109 }SalMediaProto;
 110
 111 typedef enum{
 112         SalStreamSendRecv,
 113         SalStreamSendOnly,
 114         SalStreamRecvOnly,
 115         SalStreamInactive
 116 }SalStreamDir;
 117
 118 #define SAL_ENDPOINT_CANDIDATE_MAX 2
 119
 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
 123
 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;
 131         int port;
 132         int rport;
 133 } SalIceCandidate;
 134
 135 #define SAL_MEDIA_DESCRIPTION_MAX_ICE_CANDIDATES 10
 136
 137 typedef struct SalIceRemoteCandidate {
 138         char addr[SAL_MEDIA_DESCRIPTION_MAX_ICE_ADDR_LEN];
 139         int port;
 140 } SalIceRemoteCandidate;
 141
 142 #define SAL_MEDIA_DESCRIPTION_MAX_ICE_REMOTE_CANDIDATES 2
 143
 144 #define SAL_MEDIA_DESCRIPTION_MAX_ICE_UFRAG_LEN 256
 145 #define SAL_MEDIA_DESCRIPTION_MAX_ICE_PWD_LEN 256
 146
 147 typedef struct SalSrtpCryptoAlgo {
 148         unsigned int tag;
 149         enum ortp_srtp_crypto_suite_t algo;
 150         /* 41= 40 max(key_length for all algo) + '\0' */
 151         char master_key[41];
 152 } SalSrtpCryptoAlgo;
 153
 154 #define SAL_CRYPTO_ALGO_MAX 4
 155
 156 typedef struct SalStreamDescription{
 157         SalMediaProto proto;
 158         SalStreamType type;
 159         char typeother[32];
 160         char rtp_addr[64];
 161         char rtcp_addr[64];
 162         int rtp_port;
 163         int rtcp_port;
 164         MSList *payloads; //<list of PayloadType
 165         int bandwidth;
 166         int ptime;
 167         SalStreamDir dir;
 168         SalSrtpCryptoAlgo crypto[SAL_CRYPTO_ALGO_MAX];
 169         unsigned int crypto_local_tag;
 170         int max_rate;
 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         bool_t ice_mismatch;
 176         bool_t ice_completed;
 177 } SalStreamDescription;
 178
 179 #define SAL_MEDIA_DESCRIPTION_MAX_STREAMS 4
 180
 181 typedef struct SalMediaDescription{
 182         int refcount;
 183         char addr[64];
 184         char username[64];
 185         int n_active_streams;
 186         int n_total_streams;
 187         int bandwidth;
 188         unsigned int session_ver;
 189         unsigned int session_id;
 190         SalStreamDescription streams[SAL_MEDIA_DESCRIPTION_MAX_STREAMS];
 191         char ice_ufrag[SAL_MEDIA_DESCRIPTION_MAX_ICE_UFRAG_LEN];
 192         char ice_pwd[SAL_MEDIA_DESCRIPTION_MAX_ICE_PWD_LEN];
 193         bool_t ice_lite;
 194         bool_t ice_completed;
 195 } SalMediaDescription;
 196
 197 typedef struct SalMessage{
 198         const char *from;
 199         const char *text;
 200         const char *url;
 201         const char *message_id;
 202         time_t time;
 203 }SalMessage;
 204
 205 #define SAL_MEDIA_DESCRIPTION_MAX_MESSAGE_ATTRIBUTES 5
 206
 207 SalMediaDescription *sal_media_description_new();
 208 void sal_media_description_ref(SalMediaDescription *md);
 209 void sal_media_description_unref(SalMediaDescription *md);
 210 bool_t sal_media_description_empty(const SalMediaDescription *md);
 211 int sal_media_description_equals(const SalMediaDescription *md1, const SalMediaDescription *md2);
 212 bool_t sal_media_description_has_dir(const SalMediaDescription *md, SalStreamDir dir);
 213 SalStreamDescription *sal_media_description_find_stream(SalMediaDescription *md,
 214     SalMediaProto proto, SalStreamType type);
 215 void sal_media_description_set_dir(SalMediaDescription *md, SalStreamDir stream_dir);
 216
 217 /*this structure must be at the first byte of the SalOp structure defined by implementors*/
 218 typedef struct SalOpBase{
 219         Sal *root;
 220         char *route; /*or request-uri for REGISTER*/
 221         char *contact;
 222         char *from;
 223         char *to;
 224         char *origin;
 225         char *remote_ua;
 226         SalMediaDescription *local_media;
 227         SalMediaDescription *remote_media;
 228         void *user_pointer;
 229         char* call_id;
 230         char *remote_contact;
 231         SalCustomHeader *custom_headers;
 232 } SalOpBase;
 233
 234
 235 typedef enum SalError{
 236         SalErrorNoResponse,
 237         SalErrorProtocol,
 238         SalErrorFailure, /* see SalReason for more details */
 239         SalErrorUnknown
 240 } SalError;
 241
 242 typedef enum SalReason{
 243         SalReasonDeclined,
 244         SalReasonBusy,
 245         SalReasonRedirect,
 246         SalReasonTemporarilyUnavailable,
 247         SalReasonNotFound,
 248         SalReasonDoNotDisturb,
 249         SalReasonMedia,
 250         SalReasonForbidden,
 251         SalReasonUnknown
 252 }SalReason;
 253
 254 typedef enum SalPresenceStatus{
 255         SalPresenceOffline,
 256         SalPresenceOnline,
 257         SalPresenceBusy,
 258         SalPresenceBerightback,
 259         SalPresenceAway,
 260         SalPresenceOnthephone,
 261         SalPresenceOuttolunch,
 262         SalPresenceDonotdisturb,
 263         SalPresenceMoved,
 264         SalPresenceAltService,
 265 }SalPresenceStatus;
 266
 267 typedef enum SalReferStatus{
 268         SalReferTrying,
 269         SalReferSuccess,
 270         SalReferFailed
 271 }SalReferStatus;
 272
 273 typedef enum SalSubscribeStatus{
 274         SalSubscribeActive,
 275         SalSubscribeTerminated
 276 }SalSubscribeStatus;
 277
 278 typedef enum SalTextDeliveryStatus{
 279         SalTextDeliveryInProgress,
 280         SalTextDeliveryDone,
 281         SalTextDeliveryFailed
 282 }SalTextDeliveryStatus;
 283
 284 typedef void (*SalOnCallReceived)(SalOp *op);
 285 typedef void (*SalOnCallRinging)(SalOp *op);
 286 typedef void (*SalOnCallAccepted)(SalOp *op);
 287 typedef void (*SalOnCallAck)(SalOp *op);
 288 typedef void (*SalOnCallUpdating)(SalOp *op);/*< Called when a reINVITE is received*/
 289 typedef void (*SalOnCallTerminated)(SalOp *op, const char *from);
 290 typedef void (*SalOnCallFailure)(SalOp *op, SalError error, SalReason reason, const char *details, int code);
 291 typedef void (*SalOnCallReleased)(SalOp *salop);
 292 typedef void (*SalOnAuthRequested)(SalOp *op, const char *realm, const char *username);
 293 typedef void (*SalOnAuthSuccess)(SalOp *op, const char *realm, const char *username);
 294 typedef void (*SalOnRegisterSuccess)(SalOp *op, bool_t registered);
 295 typedef void (*SalOnRegisterFailure)(SalOp *op, SalError error, SalReason reason, const char *details);
 296 typedef void (*SalOnVfuRequest)(SalOp *op);
 297 typedef void (*SalOnDtmfReceived)(SalOp *op, char dtmf);
 298 typedef void (*SalOnRefer)(Sal *sal, SalOp *op, const char *referto);
 299 typedef void (*SalOnTextReceived)(SalOp *op, const SalMessage *msg);
 300 typedef void (*SalOnTextDeliveryUpdate)(SalOp *op, SalTextDeliveryStatus status);
 301 typedef void (*SalOnNotify)(SalOp *op, const char *from, const char *event);
 302 typedef void (*SalOnNotifyRefer)(SalOp *op, SalReferStatus state);
 303 typedef void (*SalOnNotifyPresence)(SalOp *op, SalSubscribeStatus ss, SalPresenceStatus status, const char *msg);
 304 typedef void (*SalOnSubscribeReceived)(SalOp *salop, const char *from);
 305 typedef void (*SalOnSubscribeClosed)(SalOp *salop, const char *from);
 306 typedef void (*SalOnPingReply)(SalOp *salop);
 307
 308 typedef struct SalCallbacks{
 309         SalOnCallReceived call_received;
 310         SalOnCallRinging call_ringing;
 311         SalOnCallAccepted call_accepted;
 312         SalOnCallAck call_ack;
 313         SalOnCallUpdating call_updating;
 314         SalOnCallTerminated call_terminated;
 315         SalOnCallFailure call_failure;
 316         SalOnCallReleased call_released;
 317         SalOnAuthRequested auth_requested;
 318         SalOnAuthSuccess auth_success;
 319         SalOnRegisterSuccess register_success;
 320         SalOnRegisterFailure register_failure;
 321         SalOnVfuRequest vfu_request;
 322         SalOnDtmfReceived dtmf_received;
 323         SalOnRefer refer_received;
 324         SalOnTextReceived text_received;
 325         SalOnTextDeliveryUpdate text_delivery_update;
 326         SalOnNotify notify;
 327         SalOnNotifyPresence notify_presence;
 328         SalOnNotifyRefer notify_refer;
 329         SalOnSubscribeReceived subscribe_received;
 330         SalOnSubscribeClosed subscribe_closed;
 331         SalOnPingReply ping_reply;
 332 }SalCallbacks;
 333
 334 typedef struct SalAuthInfo{
 335         char *username;
 336         char *userid;
 337         char *password;
 338         char *realm;
 339 }SalAuthInfo;
 340
 341 SalAuthInfo* sal_auth_info_new();
 342 SalAuthInfo* sal_auth_info_clone(const SalAuthInfo* auth_info);
 343 void sal_auth_info_delete(const SalAuthInfo* auth_info);
 344
 345 void sal_set_callbacks(Sal *ctx, const SalCallbacks *cbs);
 346 int sal_listen_port(Sal *ctx, const char *addr, int port, SalTransport tr, int is_secure);
 347 int sal_unlisten_ports(Sal *ctx);
 348 void sal_set_dscp(Sal *ctx, int dscp);
 349 int sal_reset_transports(Sal *ctx);
 350 ortp_socket_t sal_get_socket(Sal *ctx);
 351 void sal_set_user_agent(Sal *ctx, const char *user_agent);
 352 /*keepalive period in ms*/
 353 void sal_set_keepalive_period(Sal *ctx,unsigned int value);
 354 void sal_use_tcp_tls_keepalive(Sal *ctx, bool_t enabled);
 355 /**
 356  * returns keepalive period in ms
 357  * 0 desactiaved
 358  * */
 359 unsigned int sal_get_keepalive_period(Sal *ctx);
 360 void sal_use_session_timers(Sal *ctx, int expires);
 361 void sal_use_double_registrations(Sal *ctx, bool_t enabled);
 362 void sal_expire_old_registration_contacts(Sal *ctx, bool_t enabled);
 363 void sal_use_dates(Sal *ctx, bool_t enabled);
 364 void sal_reuse_authorization(Sal *ctx, bool_t enabled);
 365 void sal_use_one_matching_codec_policy(Sal *ctx, bool_t one_matching_codec);
 366 void sal_use_rport(Sal *ctx, bool_t use_rports);
 367 void sal_use_101(Sal *ctx, bool_t use_101);
 368 void sal_set_root_ca(Sal* ctx, const char* rootCa);
 369 const char *sal_get_root_ca(Sal* ctx);
 370 void sal_verify_server_certificates(Sal *ctx, bool_t verify);
 371 void sal_verify_server_cn(Sal *ctx, bool_t verify);
 372
 373 int sal_iterate(Sal *sal);
 374 MSList * sal_get_pending_auths(Sal *sal);
 375
 376 /*create an operation */
 377 SalOp * sal_op_new(Sal *sal);
 378
 379 /*generic SalOp API, working for all operations */
 380 Sal *sal_op_get_sal(const SalOp *op);
 381 void sal_op_set_contact(SalOp *op, const char *contact);
 382 void sal_op_set_route(SalOp *op, const char *route);
 383 void sal_op_set_from(SalOp *op, const char *from);
 384 void sal_op_set_to(SalOp *op, const char *to);
 385 void sal_op_release(SalOp *h);
 386 void sal_op_authenticate(SalOp *h, const SalAuthInfo *info);
 387 void sal_op_cancel_authentication(SalOp *h);
 388 void sal_op_set_user_pointer(SalOp *h, void *up);
 389 int sal_op_get_auth_requested(SalOp *h, const char **realm, const char **username);
 390 const char *sal_op_get_from(const SalOp *op);
 391 const char *sal_op_get_to(const SalOp *op);
 392 const char *sal_op_get_contact(const SalOp *op);
 393 const char *sal_op_get_route(const SalOp *op);
 394 const char *sal_op_get_proxy(const SalOp *op);
 395 const char *sal_op_get_remote_contact(const SalOp *op);
 396 /*for incoming requests, returns the origin of the packet as a sip uri*/
 397 const char *sal_op_get_network_origin(const SalOp *op);
 398 /*returns far-end "User-Agent" string */
 399 const char *sal_op_get_remote_ua(const SalOp *op);
 400 void *sal_op_get_user_pointer(const SalOp *op);
 401 const char* sal_op_get_call_id(const SalOp *op);
 402
 403 /*Call API*/
 404 int sal_call_set_local_media_description(SalOp *h, SalMediaDescription *desc);
 405 int sal_call(SalOp *h, const char *from, const char *to);
 406 int sal_call_notify_ringing(SalOp *h, bool_t early_media);
 407 /*accept an incoming call or, during a call accept a reINVITE*/
 408 int sal_call_accept(SalOp*h);
 409 int sal_call_decline(SalOp *h, SalReason reason, const char *redirection /*optional*/);
 410 int sal_call_update(SalOp *h, const char *subject);
 411 SalMediaDescription * sal_call_get_remote_media_description(SalOp *h);
 412 SalMediaDescription * sal_call_get_final_media_description(SalOp *h);
 413 int sal_call_refer(SalOp *h, const char *refer_to);
 414 int sal_call_refer_with_replaces(SalOp *h, SalOp *other_call_h);
 415 int sal_call_accept_refer(SalOp *h);
 416 /*informs this call is consecutive to an incoming refer */
 417 int sal_call_set_referer(SalOp *h, SalOp *refered_call);
 418 /* returns the SalOp of a call that should be replaced by h, if any */
 419 SalOp *sal_call_get_replaces(SalOp *h);
 420 int sal_call_send_dtmf(SalOp *h, char dtmf);
 421 int sal_call_terminate(SalOp *h);
 422 bool_t sal_call_autoanswer_asked(SalOp *op);
 423 void sal_call_send_vfu_request(SalOp *h);
 424 int sal_call_is_offerer(const SalOp *h);
 425 int sal_call_notify_refer_state(SalOp *h, SalOp *newcall);
 426
 427 /*Registration*/
 428 int sal_register(SalOp *op, const char *proxy, const char *from, int expires);
 429 int sal_register_refresh(SalOp *op, int expires);
 430 int sal_unregister(SalOp *h);
 431
 432 /*Messaging */
 433 int sal_text_send(SalOp *op, const char *from, const char *to, const char *text);
 434 int sal_message_send(SalOp *op, const char *from, const char *to, const char* content_type, const char *msg);
 435
 436 /*presence Subscribe/notify*/
 437 int sal_subscribe_presence(SalOp *op, const char *from, const char *to);
 438 int sal_unsubscribe(SalOp *op);
 439 int sal_subscribe_accept(SalOp *op);
 440 int sal_subscribe_decline(SalOp *op);
 441 int sal_notify_presence(SalOp *op, SalPresenceStatus status, const char *status_message);
 442 int sal_notify_close(SalOp *op);
 443
 444 /*presence publish */
 445 int sal_publish(SalOp *op, const char *from, const char *to, SalPresenceStatus status);
 446
 447
 448 /*ping: main purpose is to obtain its own contact address behind firewalls*/
 449 int sal_ping(SalOp *op, const char *from, const char *to);
 450
 451
 452
 453 #define payload_type_set_number(pt,n)           (pt)->user_data=(void*)((long)n);
 454 #define payload_type_get_number(pt)             ((int)(long)(pt)->user_data)
 455
 456 /*misc*/
 457 void sal_get_default_local_ip(Sal *sal, int address_family, char *ip, size_t iplen);
 458
 459 struct SalCustomHeader{
 460         MSList node;
 461         char *header_name;
 462         char *header_value;
 463 };
 464
 465 SalCustomHeader *sal_custom_header_append(SalCustomHeader *ch, const char *name, const char *value);
 466 const char *sal_custom_header_find(const SalCustomHeader *ch, const char *name);
 467 void sal_custom_header_free(SalCustomHeader *ch);
 468 SalCustomHeader *sal_custom_header_clone(const SalCustomHeader *ch);
 469 const SalCustomHeader *sal_op_get_custom_header(SalOp *op);
 470 void sal_op_set_custom_header(SalOp *op, SalCustomHeader* ch);
 471
 472
 473 /*internal API */
 474 void __sal_op_init(SalOp *b, Sal *sal);
 475 void __sal_op_set_network_origin(SalOp *op, const char *origin /*a sip uri*/);
 476 void __sal_op_set_remote_contact(SalOp *op, const char *ct);
 477 void __sal_op_free(SalOp *b);
 478
 479 #endif