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 n_active_streams;
 182         int n_total_streams;
 183         int bandwidth;
 184         unsigned int session_ver;
 185         unsigned int session_id;
 186         SalStreamDescription streams[SAL_MEDIA_DESCRIPTION_MAX_STREAMS];
 187         char ice_ufrag[SAL_MEDIA_DESCRIPTION_MAX_ICE_UFRAG_LEN];
 188         char ice_pwd[SAL_MEDIA_DESCRIPTION_MAX_ICE_PWD_LEN];
 189         bool_t ice_lite;
 190         bool_t ice_completed;
 191 } SalMediaDescription;
 192
 193 typedef struct SalMessage{
 194         const char *from;
 195         const char *text;
 196         const char *url;
 197         const char *message_id;
 198         time_t time;
 199 }SalMessage;
 200
 201 #define SAL_MEDIA_DESCRIPTION_MAX_MESSAGE_ATTRIBUTES 5
 202
 203 SalMediaDescription *sal_media_description_new();
 204 void sal_media_description_ref(SalMediaDescription *md);
 205 void sal_media_description_unref(SalMediaDescription *md);
 206 bool_t sal_media_description_empty(const SalMediaDescription *md);
 207 int sal_media_description_equals(const SalMediaDescription *md1, const SalMediaDescription *md2);
 208 bool_t sal_media_description_has_dir(const SalMediaDescription *md, SalStreamDir dir);
 209 SalStreamDescription *sal_media_description_find_stream(SalMediaDescription *md,
 210     SalMediaProto proto, SalStreamType type);
 211 void sal_media_description_set_dir(SalMediaDescription *md, SalStreamDir stream_dir);
 212
 213 /*this structure must be at the first byte of the SalOp structure defined by implementors*/
 214 typedef struct SalOpBase{
 215         Sal *root;
 216         char *route; /*or request-uri for REGISTER*/
 217         char *contact;
 218         char *from;
 219         char *to;
 220         char *origin;
 221         char *remote_ua;
 222         SalMediaDescription *local_media;
 223         SalMediaDescription *remote_media;
 224         void *user_pointer;
 225         char* call_id;
 226         char *remote_contact;
 227 } SalOpBase;
 228
 229
 230 typedef enum SalError{
 231         SalErrorNoResponse,
 232         SalErrorProtocol,
 233         SalErrorFailure, /* see SalReason for more details */
 234         SalErrorUnknown
 235 } SalError;
 236
 237 typedef enum SalReason{
 238         SalReasonDeclined,
 239         SalReasonBusy,
 240         SalReasonRedirect,
 241         SalReasonTemporarilyUnavailable,
 242         SalReasonNotFound,
 243         SalReasonDoNotDisturb,
 244         SalReasonMedia,
 245         SalReasonForbidden,
 246         SalReasonUnknown
 247 }SalReason;
 248
 249 typedef enum SalPresenceStatus{
 250         SalPresenceOffline,
 251         SalPresenceOnline,
 252         SalPresenceBusy,
 253         SalPresenceBerightback,
 254         SalPresenceAway,
 255         SalPresenceOnthephone,
 256         SalPresenceOuttolunch,
 257         SalPresenceDonotdisturb,
 258         SalPresenceMoved,
 259         SalPresenceAltService,
 260 }SalPresenceStatus;
 261
 262 typedef enum SalReferStatus{
 263         SalReferTrying,
 264         SalReferSuccess,
 265         SalReferFailed
 266 }SalReferStatus;
 267
 268 typedef enum SalSubscribeStatus{
 269         SalSubscribeActive,
 270         SalSubscribeTerminated
 271 }SalSubscribeStatus;
 272
 273 typedef enum SalTextDeliveryStatus{
 274         SalTextDeliveryInProgress,
 275         SalTextDeliveryDone,
 276         SalTextDeliveryFailed
 277 }SalTextDeliveryStatus;
 278
 279 typedef void (*SalOnCallReceived)(SalOp *op);
 280 typedef void (*SalOnCallRinging)(SalOp *op);
 281 typedef void (*SalOnCallAccepted)(SalOp *op);
 282 typedef void (*SalOnCallAck)(SalOp *op);
 283 typedef void (*SalOnCallUpdating)(SalOp *op);/*< Called when a reINVITE is received*/
 284 typedef void (*SalOnCallTerminated)(SalOp *op, const char *from);
 285 typedef void (*SalOnCallFailure)(SalOp *op, SalError error, SalReason reason, const char *details, int code);
 286 typedef void (*SalOnCallReleased)(SalOp *salop);
 287 typedef void (*SalOnAuthRequested)(SalOp *op, const char *realm, const char *username);
 288 typedef void (*SalOnAuthSuccess)(SalOp *op, const char *realm, const char *username);
 289 typedef void (*SalOnRegisterSuccess)(SalOp *op, bool_t registered);
 290 typedef void (*SalOnRegisterFailure)(SalOp *op, SalError error, SalReason reason, const char *details);
 291 typedef void (*SalOnVfuRequest)(SalOp *op);
 292 typedef void (*SalOnDtmfReceived)(SalOp *op, char dtmf);
 293 typedef void (*SalOnRefer)(Sal *sal, SalOp *op, const char *referto);
 294 typedef void (*SalOnTextReceived)(Sal *sal, const SalMessage *msg);
 295 typedef void (*SalOnTextDeliveryUpdate)(SalOp *op, SalTextDeliveryStatus status);
 296 typedef void (*SalOnNotify)(SalOp *op, const char *from, const char *event);
 297 typedef void (*SalOnNotifyRefer)(SalOp *op, SalReferStatus state);
 298 typedef void (*SalOnNotifyPresence)(SalOp *op, SalSubscribeStatus ss, SalPresenceStatus status, const char *msg);
 299 typedef void (*SalOnSubscribeReceived)(SalOp *salop, const char *from);
 300 typedef void (*SalOnSubscribeClosed)(SalOp *salop, const char *from);
 301 typedef void (*SalOnPingReply)(SalOp *salop);
 302
 303 typedef struct SalCallbacks{
 304         SalOnCallReceived call_received;
 305         SalOnCallRinging call_ringing;
 306         SalOnCallAccepted call_accepted;
 307         SalOnCallAck call_ack;
 308         SalOnCallUpdating call_updating;
 309         SalOnCallTerminated call_terminated;
 310         SalOnCallFailure call_failure;
 311         SalOnCallReleased call_released;
 312         SalOnAuthRequested auth_requested;
 313         SalOnAuthSuccess auth_success;
 314         SalOnRegisterSuccess register_success;
 315         SalOnRegisterFailure register_failure;
 316         SalOnVfuRequest vfu_request;
 317         SalOnDtmfReceived dtmf_received;
 318         SalOnRefer refer_received;
 319         SalOnTextReceived text_received;
 320         SalOnTextDeliveryUpdate text_delivery_update;
 321         SalOnNotify notify;
 322         SalOnNotifyPresence notify_presence;
 323         SalOnNotifyRefer notify_refer;
 324         SalOnSubscribeReceived subscribe_received;
 325         SalOnSubscribeClosed subscribe_closed;
 326         SalOnPingReply ping_reply;
 327 }SalCallbacks;
 328
 329 typedef struct SalAuthInfo{
 330         char *username;
 331         char *userid;
 332         char *password;
 333         char *realm;
 334 }SalAuthInfo;
 335
 336 SalAuthInfo* sal_auth_info_new();
 337 SalAuthInfo* sal_auth_info_clone(const SalAuthInfo* auth_info);
 338 void sal_auth_info_delete(const SalAuthInfo* auth_info);
 339
 340 void sal_set_callbacks(Sal *ctx, const SalCallbacks *cbs);
 341 int sal_listen_port(Sal *ctx, const char *addr, int port, SalTransport tr, int is_secure);
 342 int sal_unlisten_ports(Sal *ctx);
 343 void sal_set_dscp(Sal *ctx, int dscp);
 344 int sal_reset_transports(Sal *ctx);
 345 ortp_socket_t sal_get_socket(Sal *ctx);
 346 void sal_set_user_agent(Sal *ctx, const char *user_agent);
 347 /*keepalive period in ms*/
 348 void sal_set_keepalive_period(Sal *ctx,unsigned int value);
 349 void sal_use_tcp_tls_keepalive(Sal *ctx, bool_t enabled);
 350 /**
 351  * returns keepalive period in ms
 352  * 0 desactiaved
 353  * */
 354 unsigned int sal_get_keepalive_period(Sal *ctx);
 355 void sal_use_session_timers(Sal *ctx, int expires);
 356 void sal_use_double_registrations(Sal *ctx, bool_t enabled);
 357 void sal_expire_old_registration_contacts(Sal *ctx, bool_t enabled);
 358 void sal_use_dates(Sal *ctx, bool_t enabled);
 359 void sal_reuse_authorization(Sal *ctx, bool_t enabled);
 360 void sal_use_one_matching_codec_policy(Sal *ctx, bool_t one_matching_codec);
 361 void sal_use_rport(Sal *ctx, bool_t use_rports);
 362 void sal_use_101(Sal *ctx, bool_t use_101);
 363 void sal_set_root_ca(Sal* ctx, const char* rootCa);
 364 const char *sal_get_root_ca(Sal* ctx);
 365 void sal_verify_server_certificates(Sal *ctx, bool_t verify);
 366 void sal_verify_server_cn(Sal *ctx, bool_t verify);
 367
 368 int sal_iterate(Sal *sal);
 369 MSList * sal_get_pending_auths(Sal *sal);
 370
 371 /*create an operation */
 372 SalOp * sal_op_new(Sal *sal);
 373
 374 /*generic SalOp API, working for all operations */
 375 Sal *sal_op_get_sal(const SalOp *op);
 376 void sal_op_set_contact(SalOp *op, const char *contact);
 377 void sal_op_set_route(SalOp *op, const char *route);
 378 void sal_op_set_from(SalOp *op, const char *from);
 379 void sal_op_set_to(SalOp *op, const char *to);
 380 void sal_op_release(SalOp *h);
 381 void sal_op_authenticate(SalOp *h, const SalAuthInfo *info);
 382 void sal_op_cancel_authentication(SalOp *h);
 383 void sal_op_set_user_pointer(SalOp *h, void *up);
 384 int sal_op_get_auth_requested(SalOp *h, const char **realm, const char **username);
 385 const char *sal_op_get_from(const SalOp *op);
 386 const char *sal_op_get_to(const SalOp *op);
 387 const char *sal_op_get_contact(const SalOp *op);
 388 const char *sal_op_get_route(const SalOp *op);
 389 const char *sal_op_get_proxy(const SalOp *op);
 390 const char *sal_op_get_remote_contact(const SalOp *op);
 391 /*for incoming requests, returns the origin of the packet as a sip uri*/
 392 const char *sal_op_get_network_origin(const SalOp *op);
 393 /*returns far-end "User-Agent" string */
 394 const char *sal_op_get_remote_ua(const SalOp *op);
 395 void *sal_op_get_user_pointer(const SalOp *op);
 396 const char* sal_op_get_call_id(const SalOp *op);
 397
 398 /*Call API*/
 399 int sal_call_set_local_media_description(SalOp *h, SalMediaDescription *desc);
 400 int sal_call(SalOp *h, const char *from, const char *to);
 401 int sal_call_notify_ringing(SalOp *h, bool_t early_media);
 402 /*accept an incoming call or, during a call accept a reINVITE*/
 403 int sal_call_accept(SalOp*h);
 404 int sal_call_decline(SalOp *h, SalReason reason, const char *redirection /*optional*/);
 405 int sal_call_update(SalOp *h, const char *subject);
 406 SalMediaDescription * sal_call_get_remote_media_description(SalOp *h);
 407 SalMediaDescription * sal_call_get_final_media_description(SalOp *h);
 408 int sal_call_refer(SalOp *h, const char *refer_to);
 409 int sal_call_refer_with_replaces(SalOp *h, SalOp *other_call_h);
 410 int sal_call_accept_refer(SalOp *h);
 411 /*informs this call is consecutive to an incoming refer */
 412 int sal_call_set_referer(SalOp *h, SalOp *refered_call);
 413 /* returns the SalOp of a call that should be replaced by h, if any */
 414 SalOp *sal_call_get_replaces(SalOp *h);
 415 int sal_call_send_dtmf(SalOp *h, char dtmf);
 416 int sal_call_terminate(SalOp *h);
 417 bool_t sal_call_autoanswer_asked(SalOp *op);
 418 void sal_call_send_vfu_request(SalOp *h);
 419 int sal_call_is_offerer(const SalOp *h);
 420 int sal_call_notify_refer_state(SalOp *h, SalOp *newcall);
 421
 422 /*Registration*/
 423 int sal_register(SalOp *op, const char *proxy, const char *from, int expires);
 424 int sal_register_refresh(SalOp *op, int expires);
 425 int sal_unregister(SalOp *h);
 426
 427 /*Messaging */
 428 int sal_text_send(SalOp *op, const char *from, const char *to, const char *text);
 429 int sal_message_send(SalOp *op, const char *from, const char *to, const char* content_type, const char *msg);
 430
 431 /*presence Subscribe/notify*/
 432 int sal_subscribe_presence(SalOp *op, const char *from, const char *to);
 433 int sal_unsubscribe(SalOp *op);
 434 int sal_subscribe_accept(SalOp *op);
 435 int sal_subscribe_decline(SalOp *op);
 436 int sal_notify_presence(SalOp *op, SalPresenceStatus status, const char *status_message);
 437 int sal_notify_close(SalOp *op);
 438
 439 /*presence publish */
 440 int sal_publish(SalOp *op, const char *from, const char *to, SalPresenceStatus status);
 441
 442
 443 /*ping: main purpose is to obtain its own contact address behind firewalls*/
 444 int sal_ping(SalOp *op, const char *from, const char *to);
 445
 446
 447
 448 #define payload_type_set_number(pt,n)           (pt)->user_data=(void*)((long)n);
 449 #define payload_type_get_number(pt)             ((int)(long)(pt)->user_data)
 450
 451 /*misc*/
 452 void sal_get_default_local_ip(Sal *sal, int address_family, char *ip, size_t iplen);
 453
 454
 455 /*internal API */
 456 void __sal_op_init(SalOp *b, Sal *sal);
 457 void __sal_op_set_network_origin(SalOp *op, const char *origin /*a sip uri*/);
 458 void __sal_op_set_remote_contact(SalOp *op, const char *ct);
 459 void __sal_op_free(SalOp *b);
 460
 461 #endif