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