sjero.net Git - linphone/blob - coreapi/private.h

   1 /***************************************************************************
   2  *            private.h
   3  *
   4  *  Mon Jun 13 14:23:23 2005
   5  *  Copyright  2005  Simon Morlat
   6  *  Email simon dot morlat at linphone dot org
   7  ****************************************************************************/
   8
   9 /*
  10  *  This program is free software; you can redistribute it and/or modify
  11  *  it under the terms of the GNU General Public License as published by
  12  *  the Free Software Foundation; either version 2 of the License, or
  13  *  (at your option) any later version.
  14  *
  15  *  This program is distributed in the hope that it will be useful,
  16  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  *  GNU General Public License for more details.
  19  *
  20  *  You should have received a copy of the GNU General Public License
  21  *  along with this program; if not, write to the Free Software
  22  *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23  */
  24
  25 #ifndef _PRIVATE_H
  26 #define _PRIVATE_H
  27
  28 #include "linphonecore.h"
  29 #include "sal.h"
  30
  31 #ifdef HAVE_CONFIG_H
  32 #include "config.h"
  33 #endif
  34
  35 #ifndef LIBLINPHONE_VERSION
  36 #define LIBLINPHONE_VERSION LINPHONE_VERSION
  37 #endif
  38
  39 #ifndef PACKAGE_SOUND_DIR
  40 #define PACKAGE_SOUND_DIR "."
  41 #endif
  42
  43 #ifdef HAVE_GETTEXT
  44 #include <libintl.h>
  45 #ifndef _
  46 #define _(String) gettext(String)
  47 #endif
  48 #else
  49 #ifndef _
  50 #define _(something)    (something)
  51 #endif
  52 #ifndef ngettext
  53 #define ngettext(singular, plural, number)      (((number)==1)?(singular):(plural))
  54 #endif
  55 #endif
  56
  57 typedef enum _LCState{
  58         LCStateInit,
  59         LCStatePreEstablishing,
  60         LCStateRinging,
  61         LCStateAVRunning
  62 }LCState;
  63
  64
  65 struct _LinphoneCall
  66 {
  67         struct _LinphoneCore *core;
  68         SalMediaDescription *localdesc;
  69         SalMediaDescription *resultdesc;
  70         LinphoneCallDir dir;
  71         struct _RtpProfile *audio_profile;
  72         struct _RtpProfile *video_profile;
  73         struct _LinphoneCallLog *log;
  74         SalOp *op;
  75         SalOp *ping_op;
  76         char localip[LINPHONE_IPADDR_SIZE]; /* our best guess for local ipaddress for this call */
  77         time_t start_time; /*time at which the call was initiated*/
  78         time_t media_start_time; /*time at which it was accepted, media streams established*/
  79         LCState state;
  80         bool_t media_pending;
  81 };
  82
  83 LinphoneCall * linphone_call_new_outgoing(struct _LinphoneCore *lc, LinphoneAddress *from, LinphoneAddress *to);
  84 LinphoneCall * linphone_call_new_incoming(struct _LinphoneCore *lc, LinphoneAddress *from, LinphoneAddress *to, SalOp *op);
  85 #define linphone_call_set_state(lcall,st)       (lcall)->state=(st)
  86 void linphone_call_destroy(struct _LinphoneCall *obj);
  87
  88 /* private: */
  89 LinphoneCallLog * linphone_call_log_new(LinphoneCall *call, LinphoneAddress *local, LinphoneAddress * remote);
  90 void linphone_call_log_completed(LinphoneCallLog *calllog, LinphoneCall *call);
  91 void linphone_call_log_destroy(LinphoneCallLog *cl);
  92
  93
  94 void linphone_core_init_media_streams(LinphoneCore *lc, LinphoneCall *call);
  95
  96 void linphone_auth_info_write_config(struct _LpConfig *config, LinphoneAuthInfo *obj, int pos);
  97
  98 void linphone_core_update_proxy_register(LinphoneCore *lc);
  99 void linphone_core_refresh_subscribes(LinphoneCore *lc);
 100
 101 int linphone_proxy_config_send_publish(LinphoneProxyConfig *cfg, LinphoneOnlineStatus os);
 102
 103 int linphone_online_status_to_eXosip(LinphoneOnlineStatus os);
 104 void linphone_friend_close_subscriptions(LinphoneFriend *lf);
 105 void linphone_friend_notify(LinphoneFriend *lf, LinphoneOnlineStatus os);
 106 LinphoneFriend *linphone_find_friend_by_inc_subscribe(MSList *l, SalOp *op);
 107 LinphoneFriend *linphone_find_friend_by_out_subscribe(MSList *l, SalOp *op);
 108
 109
 110 int set_lock_file();
 111 int get_lock_file();
 112 int remove_lock_file();
 113 int do_registration(LinphoneCore *lc, bool_t doit);
 114 void check_for_registration(LinphoneCore *lc);
 115 void check_sound_device(LinphoneCore *lc);
 116 void linphone_core_verify_codecs(LinphoneCore *lc);
 117 void linphone_core_get_local_ip(LinphoneCore *lc, const char *to, char *result);
 118 bool_t host_has_ipv6_network();
 119 bool_t lp_spawn_command_line_sync(const char *command, char **result,int *command_ret);
 120
 121 static inline int get_min_bandwidth(int dbw, int ubw){
 122         if (dbw<=0) return ubw;
 123         if (ubw<=0) return dbw;
 124         return MIN(dbw,ubw);
 125 }
 126
 127 static inline bool_t bandwidth_is_greater(int bw1, int bw2){
 128         if (bw1<0) return TRUE;
 129         else if (bw2<0) return FALSE;
 130         else return bw1>=bw2;
 131 }
 132
 133 static inline void set_string(char **dest, const char *src){
 134         if (*dest){
 135                 ms_free(*dest);
 136                 *dest=NULL;
 137         }
 138         if (src)
 139                 *dest=ms_strdup(src);
 140 }
 141
 142 #define PAYLOAD_TYPE_ENABLED    PAYLOAD_TYPE_USER_FLAG_0
 143
 144 SalPresenceStatus linphone_online_status_to_sal(LinphoneOnlineStatus os);
 145 void linphone_process_authentication(LinphoneCore* lc, SalOp *op);
 146 void linphone_authentication_ok(LinphoneCore *lc, SalOp *op);
 147 void linphone_subscription_new(LinphoneCore *lc, SalOp *op, const char *from);
 148 void linphone_notify_recv(LinphoneCore *lc, SalOp *op, SalSubscribeState ss, SalPresenceStatus status);
 149 void linphone_proxy_config_process_authentication_failure(LinphoneCore *lc, SalOp *op);
 150
 151 void linphone_subscription_answered(LinphoneCore *lc, SalOp *op);
 152 void linphone_subscription_closed(LinphoneCore *lc, SalOp *op);
 153
 154 MSList *linphone_find_friend(MSList *fl, const LinphoneAddress *fri, LinphoneFriend **lf);
 155
 156 void linphone_core_update_allocated_audio_bandwidth(LinphoneCore *lc);
 157 void linphone_core_update_allocated_audio_bandwidth_in_call(LinphoneCore *lc, const PayloadType *pt);
 158 void linphone_core_run_stun_tests(LinphoneCore *lc, LinphoneCall *call);
 159
 160 void linphone_core_write_friends_config(LinphoneCore* lc);
 161 void linphone_friend_write_to_config_file(struct _LpConfig *config, LinphoneFriend *lf, int index);
 162 LinphoneFriend * linphone_friend_new_from_config_file(struct _LinphoneCore *lc, int index);
 163
 164 void linphone_proxy_config_update(LinphoneProxyConfig *cfg);
 165 void linphone_proxy_config_get_contact(LinphoneProxyConfig *cfg, const char **ip, int *port);
 166 LinphoneProxyConfig * linphone_core_lookup_known_proxy(LinphoneCore *lc, const LinphoneAddress *uri);
 167 int linphone_core_get_local_ip_for(int type, const char *dest, char *result);
 168
 169 LinphoneProxyConfig *linphone_proxy_config_new_from_config_file(struct _LpConfig *config, int index);
 170 void linphone_proxy_config_write_to_config_file(struct _LpConfig* config,LinphoneProxyConfig *obj, int index);
 171
 172 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *cfg, const char *username, char *result, size_t result_len);
 173
 174 void linphone_core_text_received(LinphoneCore *lc, const char *from, const char *msg);
 175
 176 void linphone_core_start_media_streams(LinphoneCore *lc, struct _LinphoneCall *call);
 177 void linphone_core_stop_media_streams(LinphoneCore *lc, struct _LinphoneCall *call);
 178 const char * linphone_core_get_identity(LinphoneCore *lc);
 179 const char * linphone_core_get_route(LinphoneCore *lc);
 180 bool_t linphone_core_is_in_communication_with(LinphoneCore *lc, const char *to);
 181 void linphone_core_start_waiting(LinphoneCore *lc, const char *purpose);
 182 void linphone_core_update_progress(LinphoneCore *lc, const char *purpose, float progresses);
 183 void linphone_core_stop_waiting(LinphoneCore *lc);
 184
 185 int linphone_core_start_invite(LinphoneCore *lc, LinphoneCall *call, LinphoneProxyConfig *dest_proxy);
 186
 187 extern SalCallbacks linphone_sal_callbacks;
 188
 189
 190 struct _LinphoneProxyConfig
 191 {
 192         struct _LinphoneCore *lc;
 193         char *reg_proxy;
 194         char *reg_identity;
 195         char *reg_route;
 196         char *realm;
 197         int expires;
 198         int reg_time;
 199         SalOp *op;
 200         char *type;
 201         struct _SipSetupContext *ssctx;
 202         int auth_failures;
 203         char *dial_prefix;
 204         bool_t commit;
 205         bool_t reg_sendregister;
 206         bool_t registered;
 207         bool_t publish;
 208         bool_t dial_escape_plus;
 209         void* user_data;
 210 };
 211
 212 struct _LinphoneAuthInfo
 213 {
 214         char *username;
 215         char *realm;
 216         char *userid;
 217         char *passwd;
 218         char *ha1;
 219         int usecount;
 220         bool_t works;
 221 };
 222
 223 struct _LinphoneChatRoom{
 224         struct _LinphoneCore *lc;
 225         char  *peer;
 226         char *route;
 227         LinphoneAddress *peer_url;
 228         void * user_data;
 229 };
 230
 231 struct _LinphoneFriend{
 232         LinphoneAddress *uri;
 233         SalOp *insub;
 234         SalOp *outsub;
 235         LinphoneSubscribePolicy pol;
 236         LinphoneOnlineStatus status;
 237         struct _LinphoneCore *lc;
 238         BuddyInfo *info;
 239         char *refkey;
 240         bool_t subscribe;
 241         bool_t subscribe_active;
 242         bool_t inc_subscribe_pending;
 243 };
 244
 245 typedef struct sip_config
 246 {
 247         char *contact;
 248         char *guessed_contact;
 249         int sip_port;
 250         MSList *proxies;
 251         MSList *deleted_proxies;
 252         int inc_timeout;        /*timeout after an un-answered incoming call is rejected*/
 253         bool_t use_info;
 254         bool_t use_rfc2833;     /*force RFC2833 to be sent*/
 255         bool_t guess_hostname;
 256         bool_t loopback_only;
 257         bool_t ipv6_enabled;
 258         bool_t sdp_200_ack;
 259         bool_t only_one_codec; /*in SDP answers*/
 260         bool_t register_only_when_network_is_up;
 261         bool_t ping_with_options;
 262         bool_t auto_net_state_mon;
 263         unsigned int keepalive_period; /* interval in ms between keep alive messages sent to the proxy server*/
 264 } sip_config_t;
 265
 266 typedef struct rtp_config
 267 {
 268         int audio_rtp_port;
 269         int video_rtp_port;
 270         int audio_jitt_comp;  /*jitter compensation*/
 271         int video_jitt_comp;  /*jitter compensation*/
 272         int nortp_timeout;
 273 }rtp_config_t;
 274
 275
 276
 277 typedef struct net_config
 278 {
 279         char *nat_address;
 280         char *stun_server;
 281         char *relay;
 282         int download_bw;
 283         int upload_bw;
 284         int firewall_policy;
 285         int mtu;
 286         int down_ptime;
 287         bool_t nat_sdp_only;
 288 }net_config_t;
 289
 290
 291 typedef struct sound_config
 292 {
 293         struct _MSSndCard * ring_sndcard;       /* the playback sndcard currently used */
 294         struct _MSSndCard * play_sndcard;       /* the playback sndcard currently used */
 295         struct _MSSndCard * capt_sndcard; /* the capture sndcard currently used */
 296         struct _MSSndCard * lsd_card; /* dummy playback card for Linphone Sound Daemon extension */
 297         const char **cards;
 298         int latency;    /* latency in samples of the current used sound device */
 299         char rec_lev;
 300         char play_lev;
 301         char ring_lev;
 302         char soft_play_lev;
 303         char source;
 304         char *local_ring;
 305         char *remote_ring;
 306         bool_t ec;
 307         bool_t ea;
 308         bool_t agc;
 309 } sound_config_t;
 310
 311 typedef struct codecs_config
 312 {
 313         MSList *audio_codecs;  /* list of audio codecs in order of preference*/
 314         MSList *video_codecs;   /* for later use*/
 315 }codecs_config_t;
 316
 317 typedef struct video_config{
 318         struct _MSWebCam *device;
 319         const char **cams;
 320         MSVideoSize vsize;
 321         bool_t capture;
 322         bool_t show_local;
 323         bool_t display;
 324         bool_t selfview; /*during calls*/
 325 }video_config_t;
 326
 327 typedef struct ui_config
 328 {
 329         int is_daemon;
 330         int is_applet;
 331         unsigned int timer_id;  /* the timer id for registration */
 332 }ui_config_t;
 333
 334
 335
 336 typedef struct autoreplier_config
 337 {
 338         int enabled;
 339         int after_seconds;              /* accept the call after x seconds*/
 340         int max_users;                  /* maximum number of user that can call simultaneously */
 341         int max_rec_time;       /* the max time of incoming voice recorded */
 342         int max_rec_msg;                /* maximum number of recorded messages */
 343         const char *message;            /* the path of the file to be played */
 344 }autoreplier_config_t;
 345
 346
 347 struct _LinphoneCore
 348 {
 349         LinphoneCoreVTable vtable;
 350         Sal *sal;
 351         struct _LpConfig *config;
 352         net_config_t net_conf;
 353         sip_config_t sip_conf;
 354         rtp_config_t rtp_conf;
 355         sound_config_t sound_conf;
 356         video_config_t video_conf;
 357         codecs_config_t codecs_conf;
 358         ui_config_t ui_conf;
 359         autoreplier_config_t autoreplier_conf;
 360         LinphoneProxyConfig *default_proxy;
 361         MSList *friends;
 362         MSList *auth_info;
 363         struct _RingStream *ringstream;
 364         LCCallbackObj preview_finished_cb;
 365         struct _LinphoneCall *call;   /* the current call, in the future it will be a list of calls (conferencing)*/
 366         MSList *queued_calls;   /* used by the autoreplier */
 367         MSList *call_logs;
 368         MSList *chatrooms;
 369         int max_call_logs;
 370         int missed_calls;
 371         struct _AudioStream *audiostream;  /**/
 372         struct _VideoStream *videostream;
 373         struct _VideoStream *previewstream;
 374         RtpTransport *a_rtp,*a_rtcp;
 375         MSList *bl_reqs;
 376         MSList *subscribers;    /* unknown subscribers */
 377         int minutes_away;
 378         LinphoneOnlineStatus presence_mode;
 379         LinphoneOnlineStatus prev_mode;
 380         char *alt_contact;
 381         void *data;
 382         char *play_file;
 383         char *rec_file;
 384         time_t prevtime;
 385         int dw_audio_bw;
 386         int up_audio_bw;
 387         int dw_video_bw;
 388         int up_video_bw;
 389         int audio_bw;
 390         gstate_t gstate_power;
 391         gstate_t gstate_reg;
 392         gstate_t gstate_call;
 393         LinphoneWaitingCallback wait_cb;
 394         void *wait_ctx;
 395         bool_t use_files;
 396         bool_t apply_nat_settings;
 397         bool_t ready;
 398         bool_t bl_refresh;
 399         bool_t preview_finished;
 400         bool_t auto_net_state_mon;
 401         bool_t network_reachable;
 402 };
 403
 404 #endif /* _PRIVATE_H */