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