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
  31 struct Sal;
  32
  33 typedef struct Sal Sal;
  34
  35 struct SalOp;
  36
  37 typedef struct SalOp SalOp;
  38
  39 struct SalAddress;
  40
  41 typedef struct SalAddress SalAddress;
  42
  43 /* Address manipulation API*/
  44 SalAddress * sal_address_new(const char *uri);
  45 SalAddress * sal_address_clone(const SalAddress *addr);
  46 const char *sal_address_get_scheme(const SalAddress *addr);
  47 const char *sal_address_get_display_name(const SalAddress* addr);
  48 char *sal_address_get_display_name_unquoted(const SalAddress *addr);
  49 const char *sal_address_get_username(const SalAddress *addr);
  50 const char *sal_address_get_domain(const SalAddress *addr);
  51 const char * sal_address_get_port(const SalAddress *addr);
  52 int sal_address_get_port_int(const SalAddress *uri);
  53
  54 void sal_address_set_display_name(SalAddress *addr, const char *display_name);
  55 void sal_address_set_username(SalAddress *addr, const char *username);
  56 void sal_address_set_domain(SalAddress *addr, const char *host);
  57 void sal_address_set_port(SalAddress *addr, const char *port);
  58 void sal_address_set_port_int(SalAddress *uri, int port);
  59 void sal_address_clean(SalAddress *addr);
  60 char *sal_address_as_string(const SalAddress *u);
  61 char *sal_address_as_string_uri_only(const SalAddress *u);
  62 void sal_address_destroy(SalAddress *u);
  63 void sal_address_add_param(SalAddress *u,const char* name,const char* value);
  64
  65
  66
  67 Sal * sal_init();
  68 void sal_uninit(Sal* sal);
  69 void sal_set_user_pointer(Sal *sal, void *user_data);
  70 void *sal_get_user_pointer(const Sal *sal);
  71
  72 typedef enum {
  73         SalTransportDatagram,
  74         SalTransportStream
  75 }SalTransport;
  76
  77 typedef enum {
  78         SalAudio,
  79         SalVideo,
  80         SalOther
  81 } SalStreamType;
  82
  83 typedef enum{
  84         SalProtoUnknown,
  85         SalProtoRtpAvp,
  86         SalProtoRtpSavp
  87 }SalMediaProto;
  88
  89 typedef enum{
  90         SalStreamSendRecv,
  91         SalStreamSendOnly,
  92         SalStreamRecvOnly,
  93         SalStreamInactive
  94 }SalStreamDir;
  95
  96 typedef struct SalEndpointCandidate{
  97         char addr[64];
  98         int port;
  99 }SalEndpointCandidate;
 100
 101 #define SAL_ENDPOINT_CANDIDATE_MAX 2
 102
 103 typedef struct SalStreamDescription{
 104         SalMediaProto proto;
 105         SalStreamType type;
 106         char typeother[32];
 107         char addr[64];
 108         int port;
 109         MSList *payloads; //<list of PayloadType
 110         int bandwidth;
 111         int ptime;
 112         SalEndpointCandidate candidates[SAL_ENDPOINT_CANDIDATE_MAX];
 113         SalStreamDir dir;
 114 } SalStreamDescription;
 115
 116 #define SAL_MEDIA_DESCRIPTION_MAX_STREAMS 4
 117
 118 typedef struct SalMediaDescription{
 119         int refcount;
 120         char addr[64];
 121         char username[64];
 122         int nstreams;
 123         int bandwidth;
 124         unsigned int session_ver;
 125         unsigned int session_id;
 126         SalStreamDescription streams[SAL_MEDIA_DESCRIPTION_MAX_STREAMS];
 127 } SalMediaDescription;
 128
 129 SalMediaDescription *sal_media_description_new();
 130 void sal_media_description_ref(SalMediaDescription *md);
 131 void sal_media_description_unref(SalMediaDescription *md);
 132 bool_t sal_media_description_empty(const SalMediaDescription *md);
 133 bool_t sal_media_description_equals(const SalMediaDescription *md1, const SalMediaDescription *md2);
 134 bool_t sal_media_description_has_dir(const SalMediaDescription *md, SalStreamDir dir);
 135 SalStreamDescription *sal_media_description_find_stream(SalMediaDescription *md,
 136     SalMediaProto proto, SalStreamType type);
 137 void sal_media_description_set_dir(SalMediaDescription *md, SalStreamDir stream_dir);
 138
 139 /*this structure must be at the first byte of the SalOp structure defined by implementors*/
 140 typedef struct SalOpBase{
 141         Sal *root;
 142         char *route; /*or request-uri for REGISTER*/
 143         char *contact;
 144         char *from;
 145         char *to;
 146         char *origin;
 147         char *remote_ua;
 148         SalMediaDescription *local_media;
 149         SalMediaDescription *remote_media;
 150         void *user_pointer;
 151 } SalOpBase;
 152
 153
 154 typedef enum SalError{
 155         SalErrorNoResponse,
 156         SalErrorProtocol,
 157         SalErrorFailure, /* see SalReason for more details */
 158         SalErrorUnknown
 159 } SalError;
 160
 161 typedef enum SalReason{
 162         SalReasonDeclined,
 163         SalReasonBusy,
 164         SalReasonRedirect,
 165         SalReasonTemporarilyUnavailable,
 166         SalReasonNotFound,
 167         SalReasonDoNotDisturb,
 168         SalReasonMedia,
 169         SalReasonForbidden,
 170         SalReasonUnknown
 171 }SalReason;
 172
 173 typedef enum SalPresenceStatus{
 174         SalPresenceOffline,
 175         SalPresenceOnline,
 176         SalPresenceBusy,
 177         SalPresenceBerightback,
 178         SalPresenceAway,
 179         SalPresenceOnthephone,
 180         SalPresenceOuttolunch,
 181         SalPresenceDonotdisturb,
 182         SalPresenceMoved,
 183         SalPresenceAltService,
 184 }SalPresenceStatus;
 185
 186 typedef enum SalSubscribeState{
 187         SalSubscribeActive,
 188         SalSubscribeTerminated
 189 }SalSubscribeState;
 190
 191 typedef void (*SalOnCallReceived)(SalOp *op);
 192 typedef void (*SalOnCallRinging)(SalOp *op);
 193 typedef void (*SalOnCallAccepted)(SalOp *op);
 194 typedef void (*SalOnCallAck)(SalOp *op);
 195 typedef void (*SalOnCallUpdating)(SalOp *op);/*< Called when a reINVITE is received*/
 196 typedef void (*SalOnCallTerminated)(SalOp *op, const char *from);
 197 typedef void (*SalOnCallFailure)(SalOp *op, SalError error, SalReason reason, const char *details, int code);
 198 typedef void (*SalOnCallReleased)(SalOp *salop);
 199 typedef void (*SalOnAuthRequested)(SalOp *op, const char *realm, const char *username);
 200 typedef void (*SalOnAuthSuccess)(SalOp *op, const char *realm, const char *username);
 201 typedef void (*SalOnRegisterSuccess)(SalOp *op, bool_t registered);
 202 typedef void (*SalOnRegisterFailure)(SalOp *op, SalError error, SalReason reason, const char *details);
 203 typedef void (*SalOnVfuRequest)(SalOp *op);
 204 typedef void (*SalOnDtmfReceived)(SalOp *op, char dtmf);
 205 typedef void (*SalOnRefer)(Sal *sal, SalOp *op, const char *referto);
 206 typedef void (*SalOnTextReceived)(Sal *sal, const char *from, const char *msg);
 207 typedef void (*SalOnNotify)(SalOp *op, const char *from, const char *value);
 208 typedef void (*SalOnNotifyPresence)(SalOp *op, SalSubscribeState ss, SalPresenceStatus status, const char *msg);
 209 typedef void (*SalOnSubscribeReceived)(SalOp *salop, const char *from);
 210 typedef void (*SalOnSubscribeClosed)(SalOp *salop, const char *from);
 211 typedef void (*SalOnInternalMsg)(Sal *sal, const char *msg);
 212 typedef void (*SalOnPingReply)(SalOp *salop);
 213
 214 typedef struct SalCallbacks{
 215         SalOnCallReceived call_received;
 216         SalOnCallRinging call_ringing;
 217         SalOnCallAccepted call_accepted;
 218         SalOnCallAck call_ack;
 219         SalOnCallUpdating call_updating;
 220         SalOnCallTerminated call_terminated;
 221         SalOnCallFailure call_failure;
 222         SalOnCallReleased call_released;
 223         SalOnAuthRequested auth_requested;
 224         SalOnAuthSuccess auth_success;
 225         SalOnRegisterSuccess register_success;
 226         SalOnRegisterFailure register_failure;
 227         SalOnVfuRequest vfu_request;
 228         SalOnDtmfReceived dtmf_received;
 229         SalOnRefer refer_received;
 230         SalOnTextReceived text_received;
 231         SalOnNotify notify;
 232         SalOnNotifyPresence notify_presence;
 233         SalOnSubscribeReceived subscribe_received;
 234         SalOnSubscribeClosed subscribe_closed;
 235         SalOnInternalMsg internal_message;
 236         SalOnPingReply ping_reply;
 237 }SalCallbacks;
 238
 239 typedef struct SalAuthInfo{
 240         char *username;
 241         char *userid;
 242         char *password;
 243         char *realm;
 244 }SalAuthInfo;
 245
 246 SalAuthInfo* sal_auth_info_new();
 247 SalAuthInfo* sal_auth_info_clone(const SalAuthInfo* auth_info);
 248 void sal_auth_info_delete(const SalAuthInfo* auth_info);
 249
 250 void sal_set_callbacks(Sal *ctx, const SalCallbacks *cbs);
 251 int sal_listen_port(Sal *ctx, const char *addr, int port, SalTransport tr, int is_secure);
 252 int sal_unlisten_ports(Sal *ctx);
 253 ortp_socket_t sal_get_socket(Sal *ctx);
 254 void sal_set_user_agent(Sal *ctx, const char *user_agent);
 255 /*keepalive period in ms*/
 256 void sal_set_keepalive_period(Sal *ctx,unsigned int value);
 257 /**
 258  * returns keepalive period in ms
 259  * 0 desactiaved
 260  * */
 261 unsigned int sal_get_keepalive_period(Sal *ctx);
 262 void sal_use_session_timers(Sal *ctx, int expires);
 263 void sal_use_double_registrations(Sal *ctx, bool_t enabled);
 264 void sal_use_one_matching_codec_policy(Sal *ctx, bool_t one_matching_codec);
 265 int sal_iterate(Sal *sal);
 266 MSList * sal_get_pending_auths(Sal *sal);
 267
 268 /*create an operation */
 269 SalOp * sal_op_new(Sal *sal);
 270
 271 /*generic SalOp API, working for all operations */
 272 Sal *sal_op_get_sal(const SalOp *op);
 273 void sal_op_set_contact(SalOp *op, const char *contact);
 274 void sal_op_set_route(SalOp *op, const char *route);
 275 void sal_op_set_from(SalOp *op, const char *from);
 276 void sal_op_set_to(SalOp *op, const char *to);
 277 void sal_op_release(SalOp *h);
 278 void sal_op_authenticate(SalOp *h, const SalAuthInfo *info);
 279 void sal_op_cancel_authentication(SalOp *h);
 280 void sal_op_set_user_pointer(SalOp *h, void *up);
 281 int sal_op_get_auth_requested(SalOp *h, const char **realm, const char **username);
 282 const char *sal_op_get_from(const SalOp *op);
 283 const char *sal_op_get_to(const SalOp *op);
 284 const char *sal_op_get_contact(const SalOp *op);
 285 const char *sal_op_get_route(const SalOp *op);
 286 const char *sal_op_get_proxy(const SalOp *op);
 287 /*for incoming requests, returns the origin of the packet as a sip uri*/
 288 const char *sal_op_get_network_origin(const SalOp *op);
 289 /*returns far-end "User-Agent" string */
 290 const char *sal_op_get_remote_ua(const SalOp *op);
 291 void *sal_op_get_user_pointer(const SalOp *op);
 292
 293 /*Call API*/
 294 int sal_call_set_local_media_description(SalOp *h, SalMediaDescription *desc);
 295 int sal_call(SalOp *h, const char *from, const char *to);
 296 int sal_call_notify_ringing(SalOp *h, bool_t early_media);
 297 /*accept an incoming call or, during a call accept a reINVITE*/
 298 int sal_call_accept(SalOp*h);
 299 int sal_call_decline(SalOp *h, SalReason reason, const char *redirection /*optional*/);
 300 int sal_call_update(SalOp *h, const char *subject);
 301 SalMediaDescription * sal_call_get_final_media_description(SalOp *h);
 302 int sal_call_refer(SalOp *h, const char *refer_to);
 303 int sal_call_refer_with_replaces(SalOp *h, SalOp *other_call_h);
 304 int sal_call_accept_refer(SalOp *h);
 305 /*informs this call is consecutive to an incoming refer */
 306 int sal_call_set_referer(SalOp *h, SalOp *refered_call);
 307 /* returns the SalOp of a call that should be replaced by h, if any */
 308 SalOp *sal_call_get_replaces(SalOp *h);
 309 int sal_call_send_dtmf(SalOp *h, char dtmf);
 310 int sal_call_terminate(SalOp *h);
 311 bool_t sal_call_autoanswer_asked(SalOp *op);
 312 void sal_call_send_vfu_request(SalOp *h);
 313
 314 /*Registration*/
 315 int sal_register(SalOp *op, const char *proxy, const char *from, int expires);
 316 int sal_unregister(SalOp *h);
 317
 318 /*Messaging */
 319 int sal_text_send(SalOp *op, const char *from, const char *to, const char *text);
 320
 321 /*presence Subscribe/notify*/
 322 int sal_subscribe_presence(SalOp *op, const char *from, const char *to);
 323 int sal_unsubscribe(SalOp *op);
 324 int sal_subscribe_accept(SalOp *op);
 325 int sal_subscribe_decline(SalOp *op);
 326 int sal_notify_presence(SalOp *op, SalPresenceStatus status, const char *status_message);
 327 int sal_notify_close(SalOp *op);
 328
 329 /*presence publish */
 330 int sal_publish(SalOp *op, const char *from, const char *to, SalPresenceStatus status);
 331
 332
 333 /*ping: main purpose is to obtain its own contact address behind firewalls*/
 334 int sal_ping(SalOp *op, const char *from, const char *to);
 335
 336 #define payload_type_set_number(pt,n)   (pt)->user_data=(void*)((long)n);
 337 #define payload_type_get_number(pt)             ((int)(long)(pt)->user_data)
 338
 339 /*misc*/
 340 void sal_get_default_local_ip(Sal *sal, int address_family, char *ip, size_t iplen);
 341
 342
 343 /*internal API */
 344 void __sal_op_init(SalOp *b, Sal *sal);
 345 void __sal_op_set_network_origin(SalOp *op, const char *origin /*a sip uri*/);
 346 void __sal_op_free(SalOp *b);
 347
 348 #endif