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