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 void sal_address_set_display_name(SalAddress *addr, const char *display_name);
  52 void sal_address_set_username(SalAddress *addr, const char *username);
  53 void sal_address_set_domain(SalAddress *addr, const char *host);
  54 void sal_address_set_port(SalAddress *addr, const char *port);
  55 void sal_address_set_port_int(SalAddress *uri, int port);
  56 void sal_address_clean(SalAddress *addr);
  57 char *sal_address_as_string(const SalAddress *u);
  58 char *sal_address_as_string_uri_only(const SalAddress *u);
  59 void sal_address_destroy(SalAddress *u);
  60
  61
  62
  63
  64 Sal * sal_init();
  65 void sal_uninit(Sal* sal);
  66 void sal_set_user_pointer(Sal *sal, void *user_data);
  67 void *sal_get_user_pointer(const Sal *sal);
  68
  69 typedef enum {
  70         SalTransportDatagram,
  71         SalTransportStream
  72 }SalTransport;
  73
  74 typedef enum {
  75         SalAudio,
  76         SalVideo,
  77         SalOther
  78 } SalStreamType;
  79
  80 typedef enum{
  81         SalProtoUnknown,
  82         SalProtoRtpAvp,
  83         SalProtoRtpSavp
  84 }SalMediaProto;
  85
  86 typedef struct SalEndpointCandidate{
  87         char addr[64];
  88         int port;
  89 }SalEndpointCandidate;
  90
  91 #define SAL_ENDPOINT_CANDIDATE_MAX 2
  92
  93 typedef struct SalStreamDescription{
  94         SalMediaProto proto;
  95         SalStreamType type;
  96         char addr[64];
  97         int port;
  98         MSList *payloads; //<list of PayloadType
  99         int bandwidth;
 100         int ptime;
 101         SalEndpointCandidate candidates[SAL_ENDPOINT_CANDIDATE_MAX];
 102         bool_t notsending;
 103 } SalStreamDescription;
 104
 105 #define SAL_MEDIA_DESCRIPTION_MAX_STREAMS 4
 106
 107 typedef struct SalMediaDescription{
 108         int refcount;
 109         char addr[64];
 110         char username[64];
 111         int nstreams;
 112         int bandwidth;
 113         SalStreamDescription streams[SAL_MEDIA_DESCRIPTION_MAX_STREAMS];
 114         bool_t notsending;
 115 } SalMediaDescription;
 116
 117 SalMediaDescription *sal_media_description_new();
 118 void sal_media_description_ref(SalMediaDescription *md);
 119 void sal_media_description_unref(SalMediaDescription *md);
 120 bool_t sal_media_description_empty(SalMediaDescription *md);
 121 const SalStreamDescription *sal_media_description_find_stream(const SalMediaDescription *md,
 122     SalMediaProto proto, SalStreamType type);
 123
 124 /*this structure must be at the first byte of the SalOp structure defined by implementors*/
 125 typedef struct SalOpBase{
 126         Sal *root;
 127         char *route; /*or request-uri for REGISTER*/
 128         char *contact;
 129         char *from;
 130         char *to;
 131         char *origin;
 132         SalMediaDescription *local_media;
 133         SalMediaDescription *remote_media;
 134         void *user_pointer;
 135 } SalOpBase;
 136
 137
 138 typedef enum SalError{
 139         SalErrorNoResponse,
 140         SalErrorProtocol,
 141         SalErrorFailure, /* see SalReason for more details */
 142         SalErrorUnknown
 143 } SalError;
 144
 145 typedef enum SalReason{
 146         SalReasonDeclined,
 147         SalReasonBusy,
 148         SalReasonRedirect,
 149         SalReasonTemporarilyUnavailable,
 150         SalReasonNotFound,
 151         SalReasonDoNotDisturb,
 152         SalReasonMedia,
 153         SalReasonForbidden,
 154         SalReasonUnknown
 155 }SalReason;
 156
 157 typedef enum SalPresenceStatus{
 158         SalPresenceOffline,
 159         SalPresenceOnline,
 160         SalPresenceBusy,
 161         SalPresenceBerightback,
 162         SalPresenceAway,
 163         SalPresenceOnthephone,
 164         SalPresenceOuttolunch,
 165         SalPresenceDonotdisturb,
 166         SalPresenceMoved,
 167         SalPresenceAltService,
 168 }SalPresenceStatus;
 169
 170 typedef enum SalSubscribeState{
 171         SalSubscribeActive,
 172         SalSubscribeTerminated
 173 }SalSubscribeState;
 174
 175 typedef void (*SalOnCallReceived)(SalOp *op);
 176 typedef void (*SalOnCallRinging)(SalOp *op);
 177 typedef void (*SalOnCallAccepted)(SalOp *op);
 178 typedef void (*SalOnCallAck)(SalOp *op);
 179 typedef void (*SalOnCallUpdated)(SalOp *op);
 180 typedef void (*SalOnCallTerminated)(SalOp *op, const char *from);
 181 typedef void (*SalOnCallFailure)(SalOp *op, SalError error, SalReason reason, const char *details, int code);
 182 typedef void (*SalOnAuthRequested)(SalOp *op, const char *realm, const char *username);
 183 typedef void (*SalOnAuthSuccess)(SalOp *op, const char *realm, const char *username);
 184 typedef void (*SalOnRegisterSuccess)(SalOp *op, bool_t registered);
 185 typedef void (*SalOnRegisterFailure)(SalOp *op, SalError error, SalReason reason, const char *details);
 186 typedef void (*SalOnVfuRequest)(SalOp *op);
 187 typedef void (*SalOnDtmfReceived)(SalOp *op, char dtmf);
 188 typedef void (*SalOnRefer)(Sal *sal, SalOp *op, const char *referto);
 189 typedef void (*SalOnTextReceived)(Sal *sal, const char *from, const char *msg);
 190 typedef void (*SalOnNotify)(SalOp *op, const char *from, const char *value);
 191 typedef void (*SalOnNotifyPresence)(SalOp *op, SalSubscribeState ss, SalPresenceStatus status, const char *msg);
 192 typedef void (*SalOnSubscribeReceived)(SalOp *salop, const char *from);
 193 typedef void (*SalOnSubscribeClosed)(SalOp *salop, const char *from);
 194 typedef void (*SalOnInternalMsg)(Sal *sal, const char *msg);
 195 typedef void (*SalOnPingReply)(SalOp *salop);
 196
 197 typedef struct SalCallbacks{
 198         SalOnCallReceived call_received;
 199         SalOnCallRinging call_ringing;
 200         SalOnCallAccepted call_accepted;
 201         SalOnCallAck call_ack;
 202         SalOnCallUpdated call_updated;
 203         SalOnCallTerminated call_terminated;
 204         SalOnCallFailure call_failure;
 205         SalOnAuthRequested auth_requested;
 206         SalOnAuthSuccess auth_success;
 207         SalOnRegisterSuccess register_success;
 208         SalOnRegisterFailure register_failure;
 209         SalOnVfuRequest vfu_request;
 210         SalOnDtmfReceived dtmf_received;
 211         SalOnRefer refer_received;
 212         SalOnTextReceived text_received;
 213         SalOnNotify notify;
 214         SalOnNotifyPresence notify_presence;
 215         SalOnSubscribeReceived subscribe_received;
 216         SalOnSubscribeClosed subscribe_closed;
 217         SalOnInternalMsg internal_message;
 218         SalOnPingReply ping_reply;
 219 }SalCallbacks;
 220
 221 typedef struct SalAuthInfo{
 222         char *username;
 223         char *userid;
 224         char *password;
 225         char *realm;
 226 }SalAuthInfo;
 227
 228 void sal_set_callbacks(Sal *ctx, const SalCallbacks *cbs);
 229 int sal_listen_port(Sal *ctx, const char *addr, int port, SalTransport tr, int is_secure);
 230 ortp_socket_t sal_get_socket(Sal *ctx);
 231 void sal_set_user_agent(Sal *ctx, const char *user_agent);
 232 /*keepalive period in ms*/
 233 void sal_set_keepalive_period(Sal *ctx,unsigned int value);
 234 void sal_use_session_timers(Sal *ctx, int expires);
 235 int sal_iterate(Sal *sal);
 236 MSList * sal_get_pending_auths(Sal *sal);
 237
 238 /*create an operation */
 239 SalOp * sal_op_new(Sal *sal);
 240
 241 /*generic SalOp API, working for all operations */
 242 Sal *sal_op_get_sal(const SalOp *op);
 243 void sal_op_set_contact(SalOp *op, const char *contact);
 244 void sal_op_set_route(SalOp *op, const char *route);
 245 void sal_op_set_from(SalOp *op, const char *from);
 246 void sal_op_set_to(SalOp *op, const char *to);
 247 void sal_op_release(SalOp *h);
 248 void sal_op_authenticate(SalOp *h, const SalAuthInfo *info);
 249 void sal_op_set_user_pointer(SalOp *h, void *up);
 250 int sal_op_get_auth_requested(SalOp *h, const char **realm, const char **username);
 251 const char *sal_op_get_from(const SalOp *op);
 252 const char *sal_op_get_to(const SalOp *op);
 253 const char *sal_op_get_contact(const SalOp *op);
 254 const char *sal_op_get_route(const SalOp *op);
 255 const char *sal_op_get_proxy(const SalOp *op);
 256 /*for incoming requests, returns the origin of the packet as a sip uri*/
 257 const char *sal_op_get_network_origin(const SalOp *op);
 258 void *sal_op_get_user_pointer(const SalOp *op);
 259
 260 /*Call API*/
 261 int sal_call_set_local_media_description(SalOp *h, SalMediaDescription *desc);
 262 int sal_call(SalOp *h, const char *from, const char *to);
 263 int sal_call_notify_ringing(SalOp *h);
 264 int sal_call_accept(SalOp*h);
 265 int sal_call_decline(SalOp *h, SalReason reason, const char *redirection /*optional*/);
 266 int sal_call_hold(SalOp *h, bool_t holdon);
 267 SalMediaDescription * sal_call_get_final_media_description(SalOp *h);
 268 int sal_refer(SalOp *h, const char *refer_to);
 269 int sal_refer_accept(SalOp *h);
 270 int sal_call_send_dtmf(SalOp *h, char dtmf);
 271 int sal_call_terminate(SalOp *h);
 272 bool_t sal_call_autoanswer_asked(SalOp *op);
 273
 274 /*Registration*/
 275 int sal_register(SalOp *op, const char *proxy, const char *from, int expires);
 276 int sal_unregister(SalOp *h);
 277
 278 /*Messaging */
 279 int sal_text_send(SalOp *op, const char *from, const char *to, const char *text);
 280
 281 /*presence Subscribe/notify*/
 282 int sal_subscribe_presence(SalOp *op, const char *from, const char *to);
 283 int sal_unsubscribe(SalOp *op);
 284 int sal_subscribe_accept(SalOp *op);
 285 int sal_subscribe_decline(SalOp *op);
 286 int sal_notify_presence(SalOp *op, SalPresenceStatus status, const char *status_message);
 287 int sal_notify_close(SalOp *op);
 288
 289 /*presence publish */
 290 int sal_publish(SalOp *op, const char *from, const char *to, SalPresenceStatus status);
 291
 292
 293 /*ping: main purpose is to obtain its own contact address behind firewalls*/
 294 int sal_ping(SalOp *op, const char *from, const char *to);
 295
 296 #define payload_type_set_number(pt,n)   (pt)->user_data=(void*)((long)n);
 297 #define payload_type_get_number(pt)             ((int)(long)(pt)->user_data)
 298
 299 /*misc*/
 300 void sal_get_default_local_ip(Sal *sal, int address_family, char *ip, size_t iplen);
 301
 302
 303 /*internal API */
 304 void __sal_op_init(SalOp *b, Sal *sal);
 305 void __sal_op_set_network_origin(SalOp *op, const char *origin /*a sip uri*/);
 306 void __sal_op_free(SalOp *b);
 307
 308 #endif