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