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