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