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