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