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