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 "linphonecore_utils.h"
  30 #include "sal.h"
  31
  32 #ifdef HAVE_CONFIG_H
  33 #include "config.h"
  34 #endif
  35 #include "mediastreamer2/mediastream.h"
  36
  37 #ifndef LIBLINPHONE_VERSION
  38 #define LIBLINPHONE_VERSION LINPHONE_VERSION
  39 #endif
  40
  41 #ifndef PACKAGE_SOUND_DIR
  42 #define PACKAGE_SOUND_DIR "."
  43 #endif
  44
  45 #ifdef HAVE_GETTEXT
  46 #include <libintl.h>
  47 #ifndef _
  48 #define _(String) gettext(String)
  49 #endif
  50 #else
  51 #ifndef _
  52 #define _(something)    (something)
  53 #endif
  54 #ifndef ngettext
  55 #define ngettext(singular, plural, number)      (((number)==1)?(singular):(plural))
  56 #endif
  57 #endif
  58
  59
  60 struct _LinphoneCallParams{
  61         LinphoneCall *referer; /*in case this call creation is consecutive to an incoming transfer, this points to the original call */
  62         int audio_bw; /* bandwidth limit for audio stream */
  63         bool_t has_video;
  64         bool_t real_early_media; /*send real media even during early media (for outgoing calls)*/
  65         bool_t pad[2];
  66 };
  67
  68 struct _LinphoneCall
  69 {
  70         struct _LinphoneCore *core;
  71         SalMediaDescription *localdesc;
  72         SalMediaDescription *resultdesc;
  73         LinphoneCallDir dir;
  74         struct _RtpProfile *audio_profile;
  75         struct _RtpProfile *video_profile;
  76         struct _LinphoneCallLog *log;
  77         SalOp *op;
  78         SalOp *ping_op;
  79         char localip[LINPHONE_IPADDR_SIZE]; /* our best guess for local ipaddress for this call */
  80         time_t start_time; /*time at which the call was initiated*/
  81         time_t media_start_time; /*time at which it was accepted, media streams established*/
  82         LinphoneCallState       state;
  83         LinphoneReason reason;
  84         int refcnt;
  85         void * user_pointer;
  86         int audio_port;
  87         int video_port;
  88         struct _AudioStream *audiostream;  /**/
  89         struct _VideoStream *videostream;
  90         char *refer_to;
  91         LinphoneCallParams params;
  92         LinphoneCallParams current_params;
  93         int up_bw; /*upload bandwidth setting at the time the call is started. Used to detect if it changes during a call */
  94         int audio_bw;   /*upload bandwidth used by audio */
  95         bool_t refer_pending;
  96         bool_t media_pending;
  97         bool_t audio_muted;
  98         bool_t camera_active;
  99         bool_t all_muted; /*this flag is set during early medias*/
 100         bool_t playing_ringbacktone;
 101 };
 102
 103
 104 LinphoneCall * linphone_call_new_outgoing(struct _LinphoneCore *lc, LinphoneAddress *from, LinphoneAddress *to, const LinphoneCallParams *params);
 105 LinphoneCall * linphone_call_new_incoming(struct _LinphoneCore *lc, LinphoneAddress *from, LinphoneAddress *to, SalOp *op);
 106 void linphone_call_set_state(LinphoneCall *call, LinphoneCallState cstate, const char *message);
 107
 108 /* private: */
 109 LinphoneCallLog * linphone_call_log_new(LinphoneCall *call, LinphoneAddress *local, LinphoneAddress * remote);
 110 void linphone_call_log_completed(LinphoneCallLog *calllog, LinphoneCall *call, LinphoneCallStatus status);
 111 void linphone_call_log_destroy(LinphoneCallLog *cl);
 112
 113 void linphone_auth_info_write_config(struct _LpConfig *config, LinphoneAuthInfo *obj, int pos);
 114
 115 void linphone_core_update_proxy_register(LinphoneCore *lc);
 116 void linphone_core_refresh_subscribes(LinphoneCore *lc);
 117 int linphone_core_abort_call(LinphoneCore *lc, LinphoneCall *call, const char *error);
 118
 119 int linphone_proxy_config_send_publish(LinphoneProxyConfig *cfg, LinphoneOnlineStatus os);
 120 void linphone_proxy_config_set_state(LinphoneProxyConfig *cfg, LinphoneRegistrationState rstate, const char *message);
 121
 122 int linphone_online_status_to_eXosip(LinphoneOnlineStatus os);
 123 void linphone_friend_close_subscriptions(LinphoneFriend *lf);
 124 void linphone_friend_notify(LinphoneFriend *lf, LinphoneOnlineStatus os);
 125 LinphoneFriend *linphone_find_friend_by_inc_subscribe(MSList *l, SalOp *op);
 126 LinphoneFriend *linphone_find_friend_by_out_subscribe(MSList *l, SalOp *op);
 127
 128
 129 int set_lock_file();
 130 int get_lock_file();
 131 int remove_lock_file();
 132 int do_registration(LinphoneCore *lc, bool_t doit);
 133 void check_for_registration(LinphoneCore *lc);
 134 void check_sound_device(LinphoneCore *lc);
 135 void linphone_core_verify_codecs(LinphoneCore *lc);
 136 void linphone_core_get_local_ip(LinphoneCore *lc, const char *to, char *result);
 137 bool_t host_has_ipv6_network();
 138 bool_t lp_spawn_command_line_sync(const char *command, char **result,int *command_ret);
 139
 140 static inline int get_min_bandwidth(int dbw, int ubw){
 141         if (dbw<=0) return ubw;
 142         if (ubw<=0) return dbw;
 143         return MIN(dbw,ubw);
 144 }
 145
 146 static inline bool_t bandwidth_is_greater(int bw1, int bw2){
 147         if (bw1<0) return TRUE;
 148         else if (bw2<0) return FALSE;
 149         else return bw1>=bw2;
 150 }
 151
 152 static inline int get_video_bandwidth(int total, int audio){
 153         if (total<=0) return 0;
 154         return total-audio-10;
 155 }
 156
 157 static inline void set_string(char **dest, const char *src){
 158         if (*dest){
 159                 ms_free(*dest);
 160                 *dest=NULL;
 161         }
 162         if (src)
 163                 *dest=ms_strdup(src);
 164 }
 165
 166 #define PAYLOAD_TYPE_ENABLED    PAYLOAD_TYPE_USER_FLAG_0
 167
 168 SalPresenceStatus linphone_online_status_to_sal(LinphoneOnlineStatus os);
 169 void linphone_process_authentication(LinphoneCore* lc, SalOp *op);
 170 void linphone_authentication_ok(LinphoneCore *lc, SalOp *op);
 171 void linphone_subscription_new(LinphoneCore *lc, SalOp *op, const char *from);
 172 void linphone_notify_recv(LinphoneCore *lc, SalOp *op, SalSubscribeState ss, SalPresenceStatus status);
 173 void linphone_proxy_config_process_authentication_failure(LinphoneCore *lc, SalOp *op);
 174
 175 void linphone_subscription_answered(LinphoneCore *lc, SalOp *op);
 176 void linphone_subscription_closed(LinphoneCore *lc, SalOp *op);
 177
 178 MSList *linphone_find_friend(MSList *fl, const LinphoneAddress *fri, LinphoneFriend **lf);
 179
 180 void linphone_core_update_allocated_audio_bandwidth(LinphoneCore *lc);
 181 void linphone_core_update_allocated_audio_bandwidth_in_call(LinphoneCall *call, const PayloadType *pt);
 182 void linphone_core_run_stun_tests(LinphoneCore *lc, LinphoneCall *call);
 183
 184 void linphone_core_send_initial_subscribes(LinphoneCore *lc);
 185 void linphone_core_write_friends_config(LinphoneCore* lc);
 186 void linphone_friend_write_to_config_file(struct _LpConfig *config, LinphoneFriend *lf, int index);
 187 LinphoneFriend * linphone_friend_new_from_config_file(struct _LinphoneCore *lc, int index);
 188
 189 void linphone_proxy_config_update(LinphoneProxyConfig *cfg);
 190 void linphone_proxy_config_get_contact(LinphoneProxyConfig *cfg, const char **ip, int *port);
 191 LinphoneProxyConfig * linphone_core_lookup_known_proxy(LinphoneCore *lc, const LinphoneAddress *uri);
 192 const char *linphone_core_find_best_identity(LinphoneCore *lc, const LinphoneAddress *to, const char **route);
 193 int linphone_core_get_local_ip_for(int type, const char *dest, char *result);
 194
 195 LinphoneProxyConfig *linphone_proxy_config_new_from_config_file(struct _LpConfig *config, int index);
 196 void linphone_proxy_config_write_to_config_file(struct _LpConfig* config,LinphoneProxyConfig *obj, int index);
 197
 198 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *cfg, const char *username, char *result, size_t result_len);
 199
 200 void linphone_core_text_received(LinphoneCore *lc, const char *from, const char *msg);
 201
 202 void linphone_call_init_media_streams(LinphoneCall *call);
 203 void linphone_call_start_media_streams(LinphoneCall *call, bool_t all_inputs_muted, bool_t send_ringbacktone);
 204 void linphone_call_stop_media_streams(LinphoneCall *call);
 205
 206 const char * linphone_core_get_identity(LinphoneCore *lc);
 207 const char * linphone_core_get_route(LinphoneCore *lc);
 208 void linphone_core_start_waiting(LinphoneCore *lc, const char *purpose);
 209 void linphone_core_update_progress(LinphoneCore *lc, const char *purpose, float progresses);
 210 void linphone_core_stop_waiting(LinphoneCore *lc);
 211
 212 int linphone_core_start_invite(LinphoneCore *lc, LinphoneCall *call, LinphoneProxyConfig *dest_proxy);
 213 void linphone_core_start_refered_call(LinphoneCore *lc, LinphoneCall *call);
 214 extern SalCallbacks linphone_sal_callbacks;
 215 void linphone_proxy_config_set_error(LinphoneProxyConfig *cfg, LinphoneReason error);
 216
 217 struct _LinphoneProxyConfig
 218 {
 219         struct _LinphoneCore *lc;
 220         char *reg_proxy;
 221         char *reg_identity;
 222         char *reg_route;
 223         char *realm;
 224         int expires;
 225         int reg_time;
 226         SalOp *op;
 227         char *type;
 228         struct _SipSetupContext *ssctx;
 229         int auth_failures;
 230         char *dial_prefix;
 231         LinphoneRegistrationState state;
 232         SalOp *publish_op;
 233         bool_t commit;
 234         bool_t reg_sendregister;
 235         bool_t registered;
 236         bool_t publish;
 237         bool_t dial_escape_plus;
 238         void* user_data;
 239         time_t deletion_date;
 240         LinphoneReason error;
 241 };
 242
 243 struct _LinphoneAuthInfo
 244 {
 245         char *username;
 246         char *realm;
 247         char *userid;
 248         char *passwd;
 249         char *ha1;
 250         int usecount;
 251         bool_t works;
 252 };
 253
 254 struct _LinphoneChatRoom{
 255         struct _LinphoneCore *lc;
 256         char  *peer;
 257         LinphoneAddress *peer_url;
 258         SalOp *op;
 259         void * user_data;
 260 };
 261
 262 struct _LinphoneFriend{
 263         LinphoneAddress *uri;
 264         SalOp *insub;
 265         SalOp *outsub;
 266         LinphoneSubscribePolicy pol;
 267         LinphoneOnlineStatus status;
 268         struct _LinphoneCore *lc;
 269         BuddyInfo *info;
 270         char *refkey;
 271         bool_t subscribe;
 272         bool_t subscribe_active;
 273         bool_t inc_subscribe_pending;
 274         bool_t commit;
 275 };
 276
 277
 278 typedef struct sip_config
 279 {
 280         char *contact;
 281         char *guessed_contact;
 282         MSList *proxies;
 283         MSList *deleted_proxies;
 284         int inc_timeout;        /*timeout after an un-answered incoming call is rejected*/
 285         unsigned int keepalive_period; /* interval in ms between keep alive messages sent to the proxy server*/
 286         LCSipTransports transports;
 287         bool_t use_info;
 288         bool_t use_rfc2833;     /*force RFC2833 to be sent*/
 289         bool_t guess_hostname;
 290         bool_t loopback_only;
 291         bool_t ipv6_enabled;
 292         bool_t sdp_200_ack;
 293         bool_t register_only_when_network_is_up;
 294         bool_t ping_with_options;
 295         bool_t auto_net_state_mon;
 296 } sip_config_t;
 297
 298 typedef struct rtp_config
 299 {
 300         int audio_rtp_port;
 301         int video_rtp_port;
 302         int audio_jitt_comp;  /*jitter compensation*/
 303         int video_jitt_comp;  /*jitter compensation*/
 304         int nortp_timeout;
 305         bool_t rtp_no_xmit_on_audio_mute;
 306                               /* stop rtp xmit when audio muted */
 307 }rtp_config_t;
 308
 309
 310
 311 typedef struct net_config
 312 {
 313         char *nat_address;
 314         char *stun_server;
 315         char *relay;
 316         int download_bw;
 317         int upload_bw;
 318         int firewall_policy;
 319         int mtu;
 320         int down_ptime;
 321         bool_t nat_sdp_only;
 322 }net_config_t;
 323
 324
 325 typedef struct sound_config
 326 {
 327         struct _MSSndCard * ring_sndcard;       /* the playback sndcard currently used */
 328         struct _MSSndCard * play_sndcard;       /* the playback sndcard currently used */
 329         struct _MSSndCard * capt_sndcard; /* the capture sndcard currently used */
 330         struct _MSSndCard * lsd_card; /* dummy playback card for Linphone Sound Daemon extension */
 331         const char **cards;
 332         int latency;    /* latency in samples of the current used sound device */
 333         char rec_lev;
 334         char play_lev;
 335         char ring_lev;
 336         char soft_play_lev;
 337         char source;
 338         char *local_ring;
 339         char *remote_ring;
 340         char *ringback_tone;
 341         bool_t ec;
 342         bool_t ea;
 343         bool_t agc;
 344 } sound_config_t;
 345
 346 typedef struct codecs_config
 347 {
 348         MSList *audio_codecs;  /* list of audio codecs in order of preference*/
 349         MSList *video_codecs;   /* for later use*/
 350 }codecs_config_t;
 351
 352 typedef struct video_config{
 353         struct _MSWebCam *device;
 354         const char **cams;
 355         MSVideoSize vsize;
 356         bool_t capture;
 357         bool_t show_local;
 358         bool_t display;
 359         bool_t selfview; /*during calls*/
 360         const char *displaytype;
 361 }video_config_t;
 362
 363 typedef struct ui_config
 364 {
 365         int is_daemon;
 366         int is_applet;
 367         unsigned int timer_id;  /* the timer id for registration */
 368 }ui_config_t;
 369
 370
 371
 372 typedef struct autoreplier_config
 373 {
 374         int enabled;
 375         int after_seconds;              /* accept the call after x seconds*/
 376         int max_users;                  /* maximum number of user that can call simultaneously */
 377         int max_rec_time;       /* the max time of incoming voice recorded */
 378         int max_rec_msg;                /* maximum number of recorded messages */
 379         const char *message;            /* the path of the file to be played */
 380 }autoreplier_config_t;
 381
 382
 383 struct _LinphoneCore
 384 {
 385         LinphoneCoreVTable vtable;
 386         Sal *sal;
 387         LinphoneGlobalState state;
 388         struct _LpConfig *config;
 389         net_config_t net_conf;
 390         sip_config_t sip_conf;
 391         rtp_config_t rtp_conf;
 392         sound_config_t sound_conf;
 393         video_config_t video_conf;
 394         codecs_config_t codecs_conf;
 395         ui_config_t ui_conf;
 396         autoreplier_config_t autoreplier_conf;
 397         LinphoneProxyConfig *default_proxy;
 398         MSList *friends;
 399         MSList *auth_info;
 400         struct _RingStream *ringstream;
 401         time_t dmfs_playing_start_time;
 402         LCCallbackObj preview_finished_cb;
 403         LinphoneCall *current_call;   /* the current call */
 404         MSList *calls;                          /* all the processed calls */
 405         MSList *queued_calls;   /* used by the autoreplier */
 406         MSList *call_logs;
 407         MSList *chatrooms;
 408         int max_call_logs;
 409         int missed_calls;
 410         VideoPreview *previewstream;
 411         struct _MSEventQueue *msevq;
 412         RtpTransport *a_rtp,*a_rtcp;
 413         MSList *bl_reqs;
 414         MSList *subscribers;    /* unknown subscribers */
 415         int minutes_away;
 416         LinphoneOnlineStatus presence_mode;
 417         char *alt_contact;
 418         void *data;
 419         char *play_file;
 420         char *rec_file;
 421         time_t prevtime;
 422         int audio_bw;
 423         LinphoneWaitingCallback wait_cb;
 424         void *wait_ctx;
 425         unsigned long video_window_id;
 426         unsigned long preview_window_id;
 427         time_t netup_time; /*time when network went reachable */
 428         struct _EcCalibrator *ecc;
 429         bool_t use_files;
 430         bool_t apply_nat_settings;
 431         bool_t initial_subscribes_sent;
 432         bool_t bl_refresh;
 433         bool_t preview_finished;
 434         bool_t auto_net_state_mon;
 435         bool_t network_reachable;
 436         bool_t use_preview_window;
 437 };
 438
 439 bool_t linphone_core_can_we_add_call(LinphoneCore *lc);
 440 int linphone_core_add_call( LinphoneCore *lc, LinphoneCall *call);
 441 int linphone_core_del_call( LinphoneCore *lc, LinphoneCall *call);
 442 int linphone_core_set_as_current_call(LinphoneCore *lc, LinphoneCall *call);
 443 int linphone_core_get_calls_nb(const LinphoneCore *lc);
 444
 445 void linphone_core_set_state(LinphoneCore *lc, LinphoneGlobalState gstate, const char *message);
 446
 447 SalMediaDescription *create_local_media_description(LinphoneCore *lc, LinphoneCall *call);
 448
 449 void linphone_core_update_streams(LinphoneCore *lc, LinphoneCall *call, SalMediaDescription *new_md);
 450
 451 bool_t linphone_core_is_payload_type_usable_for_bandwidth(LinphoneCore *lc, PayloadType *pt,  int bandwidth_limit);
 452
 453 #define linphone_core_ready(lc) ((lc)->state!=LinphoneGlobalStartup)
 454 void _linphone_core_configure_resolver();
 455
 456 struct _EcCalibrator{
 457         ms_thread_t thread;
 458         MSSndCard *play_card,*capt_card;
 459         MSFilter *sndread,*det,*rec;
 460         MSFilter *play, *gen, *sndwrite,*resampler;
 461         MSTicker *ticker;
 462         LinphoneEcCalibrationCallback cb;
 463         void *cb_data;
 464         int recv_count;
 465         int sent_count;
 466         int64_t acc;
 467         int delay;
 468         LinphoneEcCalibratorStatus status;
 469 };
 470
 471 typedef struct _EcCalibrator EcCalibrator;
 472
 473 LinphoneEcCalibratorStatus ec_calibrator_get_status(EcCalibrator *ecc);
 474
 475 void ec_calibrator_destroy(EcCalibrator *ecc);
 476
 477 #define HOLD_OFF        (0)
 478 #define HOLD_ON         (1)
 479
 480 #ifndef NB_MAX_CALLS
 481 #define NB_MAX_CALLS    (10)
 482 #endif
 483
 484 #endif /* _PRIVATE_H */