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