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 typedef struct SalEndpointCandidate{
 109         char addr[64];
 110         int port;
 111 }SalEndpointCandidate;
 112
 113 #define SAL_ENDPOINT_CANDIDATE_MAX 2
 114
 115 typedef struct SalSrtpCryptoAlgo {
 116         unsigned int tag;
 117         enum ortp_srtp_crypto_suite_t algo;
 118         /* 41= 40 max(key_length for all algo) + '\0' */
 119         char master_key[41];
 120 } SalSrtpCryptoAlgo;
 121
 122 #define SAL_CRYPTO_ALGO_MAX 4
 123
 124 typedef struct SalStreamDescription{
 125         SalMediaProto proto;
 126         SalStreamType type;
 127         char typeother[32];
 128         char addr[64];
 129         int port;
 130         MSList *payloads; //<list of PayloadType
 131         int bandwidth;
 132         int ptime;
 133         SalEndpointCandidate candidates[SAL_ENDPOINT_CANDIDATE_MAX];
 134         SalStreamDir dir;
 135         SalSrtpCryptoAlgo crypto[SAL_CRYPTO_ALGO_MAX];
 136         unsigned int crypto_local_tag;
 137 } SalStreamDescription;
 138
 139 #define SAL_MEDIA_DESCRIPTION_MAX_STREAMS 4
 140
 141 typedef struct SalMediaDescription{
 142         int refcount;
 143         char addr[64];
 144         char username[64];
 145         int nstreams;
 146         int bandwidth;
 147         unsigned int session_ver;
 148         unsigned int session_id;
 149         SalStreamDescription streams[SAL_MEDIA_DESCRIPTION_MAX_STREAMS];
 150 } SalMediaDescription;
 151
 152 SalMediaDescription *sal_media_description_new();
 153 void sal_media_description_ref(SalMediaDescription *md);
 154 void sal_media_description_unref(SalMediaDescription *md);
 155 bool_t sal_media_description_empty(const SalMediaDescription *md);
 156 bool_t sal_media_description_equals(const SalMediaDescription *md1, const SalMediaDescription *md2);
 157 bool_t sal_media_description_has_dir(const SalMediaDescription *md, SalStreamDir dir);
 158 SalStreamDescription *sal_media_description_find_stream(SalMediaDescription *md,
 159     SalMediaProto proto, SalStreamType type);
 160 void sal_media_description_set_dir(SalMediaDescription *md, SalStreamDir stream_dir);
 161
 162 /*this structure must be at the first byte of the SalOp structure defined by implementors*/
 163 typedef struct SalOpBase{
 164         Sal *root;
 165         char *route; /*or request-uri for REGISTER*/
 166         char *contact;
 167         char *from;
 168         char *to;
 169         char *origin;
 170         char *remote_ua;
 171         SalMediaDescription *local_media;
 172         SalMediaDescription *remote_media;
 173         void *user_pointer;
 174 } SalOpBase;
 175
 176
 177 typedef enum SalError{
 178         SalErrorNoResponse,
 179         SalErrorProtocol,
 180         SalErrorFailure, /* see SalReason for more details */
 181         SalErrorUnknown
 182 } SalError;
 183
 184 typedef enum SalReason{
 185         SalReasonDeclined,
 186         SalReasonBusy,
 187         SalReasonRedirect,
 188         SalReasonTemporarilyUnavailable,
 189         SalReasonNotFound,
 190         SalReasonDoNotDisturb,
 191         SalReasonMedia,
 192         SalReasonForbidden,
 193         SalReasonUnknown
 194 }SalReason;
 195
 196 typedef enum SalPresenceStatus{
 197         SalPresenceOffline,
 198         SalPresenceOnline,
 199         SalPresenceBusy,
 200         SalPresenceBerightback,
 201         SalPresenceAway,
 202         SalPresenceOnthephone,
 203         SalPresenceOuttolunch,
 204         SalPresenceDonotdisturb,
 205         SalPresenceMoved,
 206         SalPresenceAltService,
 207 }SalPresenceStatus;
 208
 209 typedef enum SalSubscribeState{
 210         SalSubscribeActive,
 211         SalSubscribeTerminated
 212 }SalSubscribeState;
 213
 214 typedef void (*SalOnCallReceived)(SalOp *op);
 215 typedef void (*SalOnCallRinging)(SalOp *op);
 216 typedef void (*SalOnCallAccepted)(SalOp *op);
 217 typedef void (*SalOnCallAck)(SalOp *op);
 218 typedef void (*SalOnCallUpdating)(SalOp *op);/*< Called when a reINVITE is received*/
 219 typedef void (*SalOnCallTerminated)(SalOp *op, const char *from);
 220 typedef void (*SalOnCallFailure)(SalOp *op, SalError error, SalReason reason, const char *details, int code);
 221 typedef void (*SalOnCallReleased)(SalOp *salop);
 222 typedef void (*SalOnAuthRequested)(SalOp *op, const char *realm, const char *username);
 223 typedef void (*SalOnAuthSuccess)(SalOp *op, const char *realm, const char *username);
 224 typedef void (*SalOnRegisterSuccess)(SalOp *op, bool_t registered);
 225 typedef void (*SalOnRegisterFailure)(SalOp *op, SalError error, SalReason reason, const char *details);
 226 typedef void (*SalOnVfuRequest)(SalOp *op);
 227 typedef void (*SalOnDtmfReceived)(SalOp *op, char dtmf);
 228 typedef void (*SalOnRefer)(Sal *sal, SalOp *op, const char *referto);
 229 typedef void (*SalOnTextReceived)(Sal *sal, const char *from, const char *msg);
 230 typedef void (*SalOnNotify)(SalOp *op, const char *from, const char *value);
 231 typedef void (*SalOnNotifyPresence)(SalOp *op, SalSubscribeState ss, SalPresenceStatus status, const char *msg);
 232 typedef void (*SalOnSubscribeReceived)(SalOp *salop, const char *from);
 233 typedef void (*SalOnSubscribeClosed)(SalOp *salop, const char *from);
 234 typedef void (*SalOnPingReply)(SalOp *salop);
 235
 236 typedef struct SalCallbacks{
 237         SalOnCallReceived call_received;
 238         SalOnCallRinging call_ringing;
 239         SalOnCallAccepted call_accepted;
 240         SalOnCallAck call_ack;
 241         SalOnCallUpdating call_updating;
 242         SalOnCallTerminated call_terminated;
 243         SalOnCallFailure call_failure;
 244         SalOnCallReleased call_released;
 245         SalOnAuthRequested auth_requested;
 246         SalOnAuthSuccess auth_success;
 247         SalOnRegisterSuccess register_success;
 248         SalOnRegisterFailure register_failure;
 249         SalOnVfuRequest vfu_request;
 250         SalOnDtmfReceived dtmf_received;
 251         SalOnRefer refer_received;
 252         SalOnTextReceived text_received;
 253         SalOnNotify notify;
 254         SalOnNotifyPresence notify_presence;
 255         SalOnSubscribeReceived subscribe_received;
 256         SalOnSubscribeClosed subscribe_closed;
 257         SalOnPingReply ping_reply;
 258 }SalCallbacks;
 259
 260 typedef struct SalAuthInfo{
 261         char *username;
 262         char *userid;
 263         char *password;
 264         char *realm;
 265 }SalAuthInfo;
 266
 267 SalAuthInfo* sal_auth_info_new();
 268 SalAuthInfo* sal_auth_info_clone(const SalAuthInfo* auth_info);
 269 void sal_auth_info_delete(const SalAuthInfo* auth_info);
 270
 271 void sal_set_callbacks(Sal *ctx, const SalCallbacks *cbs);
 272 int sal_listen_port(Sal *ctx, const char *addr, int port, SalTransport tr, int is_secure);
 273 int sal_unlisten_ports(Sal *ctx);
 274 ortp_socket_t sal_get_socket(Sal *ctx);
 275 void sal_set_user_agent(Sal *ctx, const char *user_agent);
 276 /*keepalive period in ms*/
 277 void sal_set_keepalive_period(Sal *ctx,unsigned int value);
 278 /**
 279  * returns keepalive period in ms
 280  * 0 desactiaved
 281  * */
 282 unsigned int sal_get_keepalive_period(Sal *ctx);
 283 void sal_use_session_timers(Sal *ctx, int expires);
 284 void sal_use_double_registrations(Sal *ctx, bool_t enabled);
 285 void sal_reuse_authorization(Sal *ctx, bool_t enabled);
 286 void sal_use_one_matching_codec_policy(Sal *ctx, bool_t one_matching_codec);
 287 void sal_use_rport(Sal *ctx, bool_t use_rports);
 288 void sal_use_101(Sal *ctx, bool_t use_101);
 289 void sal_set_root_ca(Sal* ctx, const char* rootCa);
 290 void sal_verify_server_certificates(Sal *ctx, bool_t verify);
 291
 292 int sal_iterate(Sal *sal);
 293 MSList * sal_get_pending_auths(Sal *sal);
 294
 295 /*create an operation */
 296 SalOp * sal_op_new(Sal *sal);
 297
 298 /*generic SalOp API, working for all operations */
 299 Sal *sal_op_get_sal(const SalOp *op);
 300 void sal_op_set_contact(SalOp *op, const char *contact);
 301 void sal_op_set_route(SalOp *op, const char *route);
 302 void sal_op_set_from(SalOp *op, const char *from);
 303 void sal_op_set_to(SalOp *op, const char *to);
 304 void sal_op_release(SalOp *h);
 305 void sal_op_authenticate(SalOp *h, const SalAuthInfo *info);
 306 void sal_op_cancel_authentication(SalOp *h);
 307 void sal_op_set_user_pointer(SalOp *h, void *up);
 308 int sal_op_get_auth_requested(SalOp *h, const char **realm, const char **username);
 309 const char *sal_op_get_from(const SalOp *op);
 310 const char *sal_op_get_to(const SalOp *op);
 311 const char *sal_op_get_contact(const SalOp *op);
 312 const char *sal_op_get_route(const SalOp *op);
 313 const char *sal_op_get_proxy(const SalOp *op);
 314 /*for incoming requests, returns the origin of the packet as a sip uri*/
 315 const char *sal_op_get_network_origin(const SalOp *op);
 316 /*returns far-end "User-Agent" string */
 317 const char *sal_op_get_remote_ua(const SalOp *op);
 318 void *sal_op_get_user_pointer(const SalOp *op);
 319
 320 /*Call API*/
 321 int sal_call_set_local_media_description(SalOp *h, SalMediaDescription *desc);
 322 int sal_call(SalOp *h, const char *from, const char *to);
 323 int sal_call_notify_ringing(SalOp *h, bool_t early_media);
 324 /*accept an incoming call or, during a call accept a reINVITE*/
 325 int sal_call_accept(SalOp*h);
 326 int sal_call_decline(SalOp *h, SalReason reason, const char *redirection /*optional*/);
 327 int sal_call_update(SalOp *h, const char *subject);
 328 SalMediaDescription * sal_call_get_remote_media_description(SalOp *h);
 329 SalMediaDescription * sal_call_get_final_media_description(SalOp *h);
 330 int sal_call_refer(SalOp *h, const char *refer_to);
 331 int sal_call_refer_with_replaces(SalOp *h, SalOp *other_call_h);
 332 int sal_call_accept_refer(SalOp *h);
 333 /*informs this call is consecutive to an incoming refer */
 334 int sal_call_set_referer(SalOp *h, SalOp *refered_call);
 335 /* returns the SalOp of a call that should be replaced by h, if any */
 336 SalOp *sal_call_get_replaces(SalOp *h);
 337 int sal_call_send_dtmf(SalOp *h, char dtmf);
 338 int sal_call_terminate(SalOp *h);
 339 bool_t sal_call_autoanswer_asked(SalOp *op);
 340 void sal_call_send_vfu_request(SalOp *h);
 341 int sal_call_is_offerer(const SalOp *h);
 342
 343 /*Registration*/
 344 int sal_register(SalOp *op, const char *proxy, const char *from, int expires);
 345 int sal_register_refresh(SalOp *op, int expires);
 346 int sal_unregister(SalOp *h);
 347
 348 /*Messaging */
 349 int sal_text_send(SalOp *op, const char *from, const char *to, const char *text);
 350
 351 /*presence Subscribe/notify*/
 352 int sal_subscribe_presence(SalOp *op, const char *from, const char *to);
 353 int sal_unsubscribe(SalOp *op);
 354 int sal_subscribe_accept(SalOp *op);
 355 int sal_subscribe_decline(SalOp *op);
 356 int sal_notify_presence(SalOp *op, SalPresenceStatus status, const char *status_message);
 357 int sal_notify_close(SalOp *op);
 358
 359 /*presence publish */
 360 int sal_publish(SalOp *op, const char *from, const char *to, SalPresenceStatus status);
 361
 362
 363 /*ping: main purpose is to obtain its own contact address behind firewalls*/
 364 int sal_ping(SalOp *op, const char *from, const char *to);
 365
 366
 367
 368 #define payload_type_set_number(pt,n)   (pt)->user_data=(void*)((long)n);
 369 #define payload_type_get_number(pt)             ((int)(long)(pt)->user_data)
 370
 371 /*misc*/
 372 void sal_get_default_local_ip(Sal *sal, int address_family, char *ip, size_t iplen);
 373
 374
 375 /*internal API */
 376 void __sal_op_init(SalOp *b, Sal *sal);
 377 void __sal_op_set_network_origin(SalOp *op, const char *origin /*a sip uri*/);
 378 void __sal_op_free(SalOp *b);
 379
 380 #endif