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 struct _LinphoneCall
  58 {
  59         struct _LinphoneCore *core;
  60         SalMediaDescription *localdesc;
  61         SalMediaDescription *resultdesc;
  62         LinphoneCallDir dir;
  63         struct _RtpProfile *audio_profile;
  64         struct _RtpProfile *video_profile;
  65         struct _LinphoneCallLog *log;
  66         SalOp *op;
  67         SalOp *ping_op;
  68         char localip[LINPHONE_IPADDR_SIZE]; /* our best guess for local ipaddress for this call */
  69         time_t start_time; /*time at which the call was initiated*/
  70         time_t media_start_time; /*time at which it was accepted, media streams established*/
  71         LinphoneCallState       state;
  72         int refcnt;
  73         void * user_pointer;
  74         int audio_port;
  75         int video_port;
  76         struct _AudioStream *audiostream;  /**/
  77         struct _VideoStream *videostream;
  78         bool_t media_pending;
  79         bool_t audio_muted;
  80 };
  81
  82 LinphoneCall * linphone_call_new_outgoing(struct _LinphoneCore *lc, LinphoneAddress *from, LinphoneAddress *to);
  83 LinphoneCall * linphone_call_new_incoming(struct _LinphoneCore *lc, LinphoneAddress *from, LinphoneAddress *to, SalOp *op);
  84 void linphone_call_set_state(LinphoneCall *call, LinphoneCallState cstate, const char *message);
  85
  86 /* private: */
  87 LinphoneCallLog * linphone_call_log_new(LinphoneCall *call, LinphoneAddress *local, LinphoneAddress * remote);
  88 void linphone_call_log_completed(LinphoneCallLog *calllog, LinphoneCall *call, LinphoneCallStatus status);
  89 void linphone_call_log_destroy(LinphoneCallLog *cl);
  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 int linphone_core_abort_call(LinphoneCore *lc, LinphoneCall *call, const char *error);
  96
  97 int linphone_proxy_config_send_publish(LinphoneProxyConfig *cfg, LinphoneOnlineStatus os);
  98 void linphone_proxy_config_set_state(LinphoneProxyConfig *cfg, LinphoneRegistrationState rstate, const char *message);
  99
 100 int linphone_online_status_to_eXosip(LinphoneOnlineStatus os);
 101 void linphone_friend_close_subscriptions(LinphoneFriend *lf);
 102 void linphone_friend_notify(LinphoneFriend *lf, LinphoneOnlineStatus os);
 103 LinphoneFriend *linphone_find_friend_by_inc_subscribe(MSList *l, SalOp *op);
 104 LinphoneFriend *linphone_find_friend_by_out_subscribe(MSList *l, SalOp *op);
 105
 106
 107 int set_lock_file();
 108 int get_lock_file();
 109 int remove_lock_file();
 110 int do_registration(LinphoneCore *lc, bool_t doit);
 111 void check_for_registration(LinphoneCore *lc);
 112 void check_sound_device(LinphoneCore *lc);
 113 void linphone_core_verify_codecs(LinphoneCore *lc);
 114 void linphone_core_get_local_ip(LinphoneCore *lc, const char *to, char *result);
 115 bool_t host_has_ipv6_network();
 116 bool_t lp_spawn_command_line_sync(const char *command, char **result,int *command_ret);
 117
 118 static inline int get_min_bandwidth(int dbw, int ubw){
 119         if (dbw<=0) return ubw;
 120         if (ubw<=0) return dbw;
 121         return MIN(dbw,ubw);
 122 }
 123
 124 static inline bool_t bandwidth_is_greater(int bw1, int bw2){
 125         if (bw1<0) return TRUE;
 126         else if (bw2<0) return FALSE;
 127         else return bw1>=bw2;
 128 }
 129
 130 static inline void set_string(char **dest, const char *src){
 131         if (*dest){
 132                 ms_free(*dest);
 133                 *dest=NULL;
 134         }
 135         if (src)
 136                 *dest=ms_strdup(src);
 137 }
 138
 139 #define PAYLOAD_TYPE_ENABLED    PAYLOAD_TYPE_USER_FLAG_0
 140
 141 SalPresenceStatus linphone_online_status_to_sal(LinphoneOnlineStatus os);
 142 void linphone_process_authentication(LinphoneCore* lc, SalOp *op);
 143 void linphone_authentication_ok(LinphoneCore *lc, SalOp *op);
 144 void linphone_subscription_new(LinphoneCore *lc, SalOp *op, const char *from);
 145 void linphone_notify_recv(LinphoneCore *lc, SalOp *op, SalSubscribeState ss, SalPresenceStatus status);
 146 void linphone_proxy_config_process_authentication_failure(LinphoneCore *lc, SalOp *op);
 147
 148 void linphone_subscription_answered(LinphoneCore *lc, SalOp *op);
 149 void linphone_subscription_closed(LinphoneCore *lc, SalOp *op);
 150
 151 MSList *linphone_find_friend(MSList *fl, const LinphoneAddress *fri, LinphoneFriend **lf);
 152
 153 void linphone_core_update_allocated_audio_bandwidth(LinphoneCore *lc);
 154 void linphone_core_update_allocated_audio_bandwidth_in_call(LinphoneCore *lc, const PayloadType *pt);
 155 void linphone_core_run_stun_tests(LinphoneCore *lc, LinphoneCall *call);
 156
 157 void linphone_core_write_friends_config(LinphoneCore* lc);
 158 void linphone_friend_write_to_config_file(struct _LpConfig *config, LinphoneFriend *lf, int index);
 159 LinphoneFriend * linphone_friend_new_from_config_file(struct _LinphoneCore *lc, int index);
 160
 161 void linphone_proxy_config_update(LinphoneProxyConfig *cfg);
 162 void linphone_proxy_config_get_contact(LinphoneProxyConfig *cfg, const char **ip, int *port);
 163 LinphoneProxyConfig * linphone_core_lookup_known_proxy(LinphoneCore *lc, const LinphoneAddress *uri);
 164 int linphone_core_get_local_ip_for(int type, const char *dest, char *result);
 165
 166 LinphoneProxyConfig *linphone_proxy_config_new_from_config_file(struct _LpConfig *config, int index);
 167 void linphone_proxy_config_write_to_config_file(struct _LpConfig* config,LinphoneProxyConfig *obj, int index);
 168
 169 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *cfg, const char *username, char *result, size_t result_len);
 170
 171 void linphone_core_text_received(LinphoneCore *lc, const char *from, const char *msg);
 172
 173 void linphone_call_init_media_streams(LinphoneCall *call);
 174 void linphone_call_start_media_streams(LinphoneCall *call);
 175 void linphone_call_set_media_streams_dir(LinphoneCall *call, SalStreamDir dir);
 176 void linphone_call_stop_media_streams(LinphoneCall *call);
 177
 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         time_t deletion_date;
 211 };
 212
 213 struct _LinphoneAuthInfo
 214 {
 215         char *username;
 216         char *realm;
 217         char *userid;
 218         char *passwd;
 219         char *ha1;
 220         int usecount;
 221         bool_t works;
 222 };
 223
 224 struct _LinphoneChatRoom{
 225         struct _LinphoneCore *lc;
 226         char  *peer;
 227         char *route;
 228         LinphoneAddress *peer_url;
 229         void * user_data;
 230 };
 231
 232 struct _LinphoneFriend{
 233         LinphoneAddress *uri;
 234         SalOp *insub;
 235         SalOp *outsub;
 236         LinphoneSubscribePolicy pol;
 237         LinphoneOnlineStatus status;
 238         struct _LinphoneCore *lc;
 239         BuddyInfo *info;
 240         char *refkey;
 241         bool_t subscribe;
 242         bool_t subscribe_active;
 243         bool_t inc_subscribe_pending;
 244 };
 245
 246
 247 typedef struct sip_config
 248 {
 249         char *contact;
 250         char *guessed_contact;
 251         MSList *proxies;
 252         MSList *deleted_proxies;
 253         int inc_timeout;        /*timeout after an un-answered incoming call is rejected*/
 254         unsigned int keepalive_period; /* interval in ms between keep alive messages sent to the proxy server*/
 255         LCSipTransports transports;
 256         bool_t use_info;
 257         bool_t use_rfc2833;     /*force RFC2833 to be sent*/
 258         bool_t guess_hostname;
 259         bool_t loopback_only;
 260         bool_t ipv6_enabled;
 261         bool_t sdp_200_ack;
 262         bool_t only_one_codec; /*in SDP answers*/
 263         bool_t register_only_when_network_is_up;
 264         bool_t ping_with_options;
 265         bool_t auto_net_state_mon;
 266 } sip_config_t;
 267
 268 typedef struct rtp_config
 269 {
 270         int audio_rtp_port;
 271         int video_rtp_port;
 272         int audio_jitt_comp;  /*jitter compensation*/
 273         int video_jitt_comp;  /*jitter compensation*/
 274         int nortp_timeout;
 275         bool_t rtp_no_xmit_on_audio_mute;
 276                               /* stop rtp xmit when audio muted */
 277 }rtp_config_t;
 278
 279
 280
 281 typedef struct net_config
 282 {
 283         char *nat_address;
 284         char *stun_server;
 285         char *relay;
 286         int download_bw;
 287         int upload_bw;
 288         int firewall_policy;
 289         int mtu;
 290         int down_ptime;
 291         bool_t nat_sdp_only;
 292 }net_config_t;
 293
 294
 295 typedef struct sound_config
 296 {
 297         struct _MSSndCard * ring_sndcard;       /* the playback sndcard currently used */
 298         struct _MSSndCard * play_sndcard;       /* the playback sndcard currently used */
 299         struct _MSSndCard * capt_sndcard; /* the capture sndcard currently used */
 300         struct _MSSndCard * lsd_card; /* dummy playback card for Linphone Sound Daemon extension */
 301         const char **cards;
 302         int latency;    /* latency in samples of the current used sound device */
 303         char rec_lev;
 304         char play_lev;
 305         char ring_lev;
 306         char soft_play_lev;
 307         char source;
 308         char *local_ring;
 309         char *remote_ring;
 310         bool_t ec;
 311         bool_t ea;
 312         bool_t agc;
 313 } sound_config_t;
 314
 315 typedef struct codecs_config
 316 {
 317         MSList *audio_codecs;  /* list of audio codecs in order of preference*/
 318         MSList *video_codecs;   /* for later use*/
 319 }codecs_config_t;
 320
 321 typedef struct video_config{
 322         struct _MSWebCam *device;
 323         const char **cams;
 324         MSVideoSize vsize;
 325         bool_t capture;
 326         bool_t show_local;
 327         bool_t display;
 328         bool_t selfview; /*during calls*/
 329 }video_config_t;
 330
 331 typedef struct ui_config
 332 {
 333         int is_daemon;
 334         int is_applet;
 335         unsigned int timer_id;  /* the timer id for registration */
 336 }ui_config_t;
 337
 338
 339
 340 typedef struct autoreplier_config
 341 {
 342         int enabled;
 343         int after_seconds;              /* accept the call after x seconds*/
 344         int max_users;                  /* maximum number of user that can call simultaneously */
 345         int max_rec_time;       /* the max time of incoming voice recorded */
 346         int max_rec_msg;                /* maximum number of recorded messages */
 347         const char *message;            /* the path of the file to be played */
 348 }autoreplier_config_t;
 349
 350
 351 struct _LinphoneCore
 352 {
 353         LinphoneCoreVTable vtable;
 354         Sal *sal;
 355         struct _LpConfig *config;
 356         net_config_t net_conf;
 357         sip_config_t sip_conf;
 358         rtp_config_t rtp_conf;
 359         sound_config_t sound_conf;
 360         video_config_t video_conf;
 361         codecs_config_t codecs_conf;
 362         ui_config_t ui_conf;
 363         autoreplier_config_t autoreplier_conf;
 364         LinphoneProxyConfig *default_proxy;
 365         MSList *friends;
 366         MSList *auth_info;
 367         struct _RingStream *ringstream;
 368         LCCallbackObj preview_finished_cb;
 369         LinphoneCall *current_call;   /* the current call */
 370         MSList *calls;                          /* all the processed calls */
 371         MSList *queued_calls;   /* used by the autoreplier */
 372         MSList *call_logs;
 373         MSList *chatrooms;
 374         int max_call_logs;
 375         int missed_calls;
 376         struct _VideoStream *previewstream;
 377         struct _MSEventQueue *msevq;
 378         RtpTransport *a_rtp,*a_rtcp;
 379         MSList *bl_reqs;
 380         MSList *subscribers;    /* unknown subscribers */
 381         int minutes_away;
 382         LinphoneOnlineStatus presence_mode;
 383         char *alt_contact;
 384         void *data;
 385         char *play_file;
 386         char *rec_file;
 387         time_t prevtime;
 388         int dw_audio_bw;
 389         int up_audio_bw;
 390         int dw_video_bw;
 391         int up_video_bw;
 392         int audio_bw;
 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 bool_t linphone_core_can_we_add_call(LinphoneCore *lc);
 405 int linphone_core_add_call( LinphoneCore *lc, LinphoneCall *call);
 406 int linphone_core_del_call( LinphoneCore *lc, LinphoneCall *call);
 407 int linphone_core_set_as_current_call(LinphoneCore *lc, LinphoneCall *call);
 408 int linphone_core_get_calls_nb(const LinphoneCore *lc);
 409
 410 void linphone_core_set_state(LinphoneCore *lc, LinphoneGlobalState gstate, const char *message);
 411
 412 #define HOLD_OFF        (0)
 413 #define HOLD_ON         (1)
 414
 415 #ifndef NB_MAX_CALLS
 416 #define NB_MAX_CALLS    (10)
 417 #endif
 418
 419 #endif /* _PRIVATE_H */