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