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