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