private.h 13.7 KB
Newer Older
aymeric's avatar
aymeric committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
/***************************************************************************
 *            private.h
 *
 *  Mon Jun 13 14:23:23 2005
 *  Copyright  2005  Simon Morlat
 *  Email simon dot morlat at linphone dot org
 ****************************************************************************/

/*
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */
 
#ifndef _PRIVATE_H
#define _PRIVATE_H

#include "linphonecore.h"
29
#include "sal.h"
aymeric's avatar
aymeric committed
30 31 32 33

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
34
#include "mediastreamer2/mediastream.h"
aymeric's avatar
aymeric committed
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49

#ifndef LIBLINPHONE_VERSION 
#define LIBLINPHONE_VERSION LINPHONE_VERSION
#endif

#ifndef PACKAGE_SOUND_DIR 
#define PACKAGE_SOUND_DIR "."
#endif

#ifdef HAVE_GETTEXT
#include <libintl.h>
#ifndef _
#define _(String) gettext(String)
#endif
#else
smorlat's avatar
smorlat committed
50
#ifndef _
aymeric's avatar
aymeric committed
51 52
#define _(something)	(something)
#endif
53 54 55
#ifndef ngettext
#define ngettext(singular, plural, number)	(((number)==1)?(singular):(plural))
#endif
smorlat's avatar
smorlat committed
56
#endif
aymeric's avatar
aymeric committed
57

58 59 60 61 62 63

struct _LinphoneCallParams{
	bool_t has_video;
	bool_t pad[3];
};

64
struct _LinphoneCall
smorlat's avatar
smorlat committed
65 66
{
	struct _LinphoneCore *core;
67 68
	SalMediaDescription *localdesc;
	SalMediaDescription *resultdesc;
smorlat's avatar
smorlat committed
69
	LinphoneCallDir dir;
Simon Morlat's avatar
Simon Morlat committed
70 71
	struct _RtpProfile *audio_profile;
	struct _RtpProfile *video_profile;
smorlat's avatar
smorlat committed
72
	struct _LinphoneCallLog *log;
73
	SalOp *op;
74
	SalOp *ping_op;
smorlat's avatar
smorlat committed
75 76 77
	char localip[LINPHONE_IPADDR_SIZE]; /* our best guess for local ipaddress for this call */
	time_t start_time; /*time at which the call was initiated*/
	time_t media_start_time; /*time at which it was accepted, media streams established*/
78 79
	LinphoneCallState	state;
	int refcnt;
80
	void * user_pointer;
81 82 83 84
	int audio_port;
	int video_port;
	struct _AudioStream *audiostream;  /**/
	struct _VideoStream *videostream;
Simon Morlat's avatar
Simon Morlat committed
85
	char *refer_to;
86
	LinphoneCallParams params;
87
	bool_t refer_pending;
88 89
	bool_t media_pending;
	bool_t audio_muted;
90
	bool_t camera_active;
91
};
smorlat's avatar
smorlat committed
92

93 94

LinphoneCall * linphone_call_new_outgoing(struct _LinphoneCore *lc, LinphoneAddress *from, LinphoneAddress *to, const LinphoneCallParams *params);
95
LinphoneCall * linphone_call_new_incoming(struct _LinphoneCore *lc, LinphoneAddress *from, LinphoneAddress *to, SalOp *op);
96
void linphone_call_set_state(LinphoneCall *call, LinphoneCallState cstate, const char *message);
smorlat's avatar
smorlat committed
97 98

/* private: */
99
LinphoneCallLog * linphone_call_log_new(LinphoneCall *call, LinphoneAddress *local, LinphoneAddress * remote);
100
void linphone_call_log_completed(LinphoneCallLog *calllog, LinphoneCall *call, LinphoneCallStatus status);
smorlat's avatar
smorlat committed
101 102
void linphone_call_log_destroy(LinphoneCallLog *cl);

aymeric's avatar
aymeric committed
103 104 105 106
void linphone_auth_info_write_config(struct _LpConfig *config, LinphoneAuthInfo *obj, int pos);

void linphone_core_update_proxy_register(LinphoneCore *lc);
void linphone_core_refresh_subscribes(LinphoneCore *lc);
107
int linphone_core_abort_call(LinphoneCore *lc, LinphoneCall *call, const char *error);
aymeric's avatar
aymeric committed
108 109

int linphone_proxy_config_send_publish(LinphoneProxyConfig *cfg, LinphoneOnlineStatus os);
110
void linphone_proxy_config_set_state(LinphoneProxyConfig *cfg, LinphoneRegistrationState rstate, const char *message);
aymeric's avatar
aymeric committed
111 112

int linphone_online_status_to_eXosip(LinphoneOnlineStatus os);
113
void linphone_friend_close_subscriptions(LinphoneFriend *lf);
114 115 116 117
void linphone_friend_notify(LinphoneFriend *lf, LinphoneOnlineStatus os);
LinphoneFriend *linphone_find_friend_by_inc_subscribe(MSList *l, SalOp *op);
LinphoneFriend *linphone_find_friend_by_out_subscribe(MSList *l, SalOp *op);

aymeric's avatar
aymeric committed
118 119 120 121 122 123 124

int set_lock_file();
int get_lock_file();
int remove_lock_file();
int do_registration(LinphoneCore *lc, bool_t doit);
void check_for_registration(LinphoneCore *lc);
void check_sound_device(LinphoneCore *lc);
125
void linphone_core_verify_codecs(LinphoneCore *lc);
aymeric's avatar
aymeric committed
126 127 128 129 130
void linphone_core_get_local_ip(LinphoneCore *lc, const char *to, char *result);
bool_t host_has_ipv6_network();
bool_t lp_spawn_command_line_sync(const char *command, char **result,int *command_ret);

static inline int get_min_bandwidth(int dbw, int ubw){
Simon Morlat's avatar
Simon Morlat committed
131 132
	if (dbw<=0) return ubw;
	if (ubw<=0) return dbw;
aymeric's avatar
aymeric committed
133 134 135 136 137 138 139 140 141
	return MIN(dbw,ubw);
}

static inline bool_t bandwidth_is_greater(int bw1, int bw2){
	if (bw1<0) return TRUE;
	else if (bw2<0) return FALSE;
	else return bw1>=bw2;
}

smorlat's avatar
smorlat committed
142 143 144 145 146 147 148 149 150
static inline void set_string(char **dest, const char *src){
	if (*dest){
		ms_free(*dest);
		*dest=NULL;
	}
	if (src)
		*dest=ms_strdup(src);
}

aymeric's avatar
aymeric committed
151 152
#define PAYLOAD_TYPE_ENABLED	PAYLOAD_TYPE_USER_FLAG_0

153
SalPresenceStatus linphone_online_status_to_sal(LinphoneOnlineStatus os);
154 155
void linphone_process_authentication(LinphoneCore* lc, SalOp *op);
void linphone_authentication_ok(LinphoneCore *lc, SalOp *op);
156 157
void linphone_subscription_new(LinphoneCore *lc, SalOp *op, const char *from);
void linphone_notify_recv(LinphoneCore *lc, SalOp *op, SalSubscribeState ss, SalPresenceStatus status);
158
void linphone_proxy_config_process_authentication_failure(LinphoneCore *lc, SalOp *op);
aymeric's avatar
aymeric committed
159

160 161
void linphone_subscription_answered(LinphoneCore *lc, SalOp *op);
void linphone_subscription_closed(LinphoneCore *lc, SalOp *op);
aymeric's avatar
aymeric committed
162

163
MSList *linphone_find_friend(MSList *fl, const LinphoneAddress *fri, LinphoneFriend **lf);
aymeric's avatar
aymeric committed
164

165 166
void linphone_core_update_allocated_audio_bandwidth(LinphoneCore *lc);
void linphone_core_update_allocated_audio_bandwidth_in_call(LinphoneCore *lc, const PayloadType *pt);
smorlat's avatar
smorlat committed
167
void linphone_core_run_stun_tests(LinphoneCore *lc, LinphoneCall *call);
aymeric's avatar
aymeric committed
168

169
void linphone_core_send_initial_subscribes(LinphoneCore *lc);
170
void linphone_core_write_friends_config(LinphoneCore* lc);
smorlat's avatar
smorlat committed
171 172 173
void linphone_friend_write_to_config_file(struct _LpConfig *config, LinphoneFriend *lf, int index);
LinphoneFriend * linphone_friend_new_from_config_file(struct _LinphoneCore *lc, int index);

smorlat's avatar
smorlat committed
174
void linphone_proxy_config_update(LinphoneProxyConfig *cfg);
175
void linphone_proxy_config_get_contact(LinphoneProxyConfig *cfg, const char **ip, int *port);
176
LinphoneProxyConfig * linphone_core_lookup_known_proxy(LinphoneCore *lc, const LinphoneAddress *uri);
177
const char *linphone_core_find_best_identity(LinphoneCore *lc, const LinphoneAddress *to, const char **route);
178
int linphone_core_get_local_ip_for(int type, const char *dest, char *result);
179

smorlat's avatar
smorlat committed
180 181 182
LinphoneProxyConfig *linphone_proxy_config_new_from_config_file(struct _LpConfig *config, int index);
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);
void linphone_call_start_media_streams(LinphoneCall *call);
189
void linphone_call_start_early_media(LinphoneCall *call);
190 191
void linphone_call_stop_media_streams(LinphoneCall *call);

192 193 194 195 196 197
const char * linphone_core_get_identity(LinphoneCore *lc);
const char * linphone_core_get_route(LinphoneCore *lc);
void linphone_core_start_waiting(LinphoneCore *lc, const char *purpose);
void linphone_core_update_progress(LinphoneCore *lc, const char *purpose, float progresses);
void linphone_core_stop_waiting(LinphoneCore *lc);

198
int linphone_core_start_invite(LinphoneCore *lc, LinphoneCall *call, LinphoneProxyConfig *dest_proxy);
199
void linphone_core_start_pending_refered_calls(LinphoneCore *lc);
200
extern SalCallbacks linphone_sal_callbacks;
jehan's avatar
jehan committed
201
void linphone_proxy_config_set_error(LinphoneProxyConfig *cfg,LinphoneError error);
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216

struct _LinphoneProxyConfig
{
	struct _LinphoneCore *lc;
	char *reg_proxy;
	char *reg_identity;
	char *reg_route;
	char *realm;
	int expires;
	int reg_time;
	SalOp *op;
	char *type;
	struct _SipSetupContext *ssctx;
	int auth_failures;
	char *dial_prefix;
217
	LinphoneRegistrationState state;
Simon Morlat's avatar
Simon Morlat committed
218
	SalOp *publish_op;
219 220 221 222 223
	bool_t commit;
	bool_t reg_sendregister;
	bool_t registered;
	bool_t publish;
	bool_t dial_escape_plus;
jehan's avatar
jehan committed
224
	void* user_data;
225
	time_t deletion_date;
jehan's avatar
jehan committed
226
	LinphoneError error;
227 228 229 230 231 232 233 234 235
};

struct _LinphoneAuthInfo 
{
	char *username;
	char *realm;
	char *userid;
	char *passwd;
	char *ha1;
236
	int usecount;
237 238 239 240 241 242 243
	bool_t works;
};

struct _LinphoneChatRoom{
	struct _LinphoneCore *lc;
	char  *peer;
	LinphoneAddress *peer_url;
244
	SalOp *op;
245 246 247 248 249 250 251 252 253 254 255 256 257
	void * user_data;
};

struct _LinphoneFriend{
	LinphoneAddress *uri;
	SalOp *insub;
	SalOp *outsub;
	LinphoneSubscribePolicy pol;
	LinphoneOnlineStatus status;
	struct _LinphoneCore *lc;
	BuddyInfo *info;
	char *refkey;
	bool_t subscribe;
258
	bool_t subscribe_active;
259
	bool_t inc_subscribe_pending;
260
	bool_t commit;
261 262
};	

jehan's avatar
jehan committed
263

264 265 266 267 268 269 270
typedef struct sip_config
{
	char *contact;
	char *guessed_contact;
	MSList *proxies;
	MSList *deleted_proxies;
	int inc_timeout;	/*timeout after an un-answered incoming call is rejected*/
271 272
	unsigned int keepalive_period; /* interval in ms between keep alive messages sent to the proxy server*/
	LCSipTransports transports;
273 274 275 276 277 278 279 280
	bool_t use_info;
	bool_t use_rfc2833;	/*force RFC2833 to be sent*/
	bool_t guess_hostname;
	bool_t loopback_only;
	bool_t ipv6_enabled;
	bool_t sdp_200_ack;
	bool_t only_one_codec; /*in SDP answers*/
	bool_t register_only_when_network_is_up;
281
	bool_t ping_with_options;
jehan's avatar
jehan committed
282
	bool_t auto_net_state_mon;
283 284 285 286 287 288 289 290 291
} sip_config_t;

typedef struct rtp_config
{
	int audio_rtp_port;
	int video_rtp_port;
	int audio_jitt_comp;  /*jitter compensation*/
	int video_jitt_comp;  /*jitter compensation*/
	int nortp_timeout;
292
	bool_t rtp_no_xmit_on_audio_mute;                              
Simon Morlat's avatar
Simon Morlat committed
293
                              /* stop rtp xmit when audio muted */
294 295 296 297 298 299 300 301 302 303 304 305 306
}rtp_config_t;



typedef struct net_config
{
	char *nat_address;
	char *stun_server;
	char *relay;
	int download_bw;
	int upload_bw;
	int firewall_policy;
	int mtu;
307
	int down_ptime;
308 309 310 311 312 313 314 315 316
	bool_t nat_sdp_only;
}net_config_t;


typedef struct sound_config
{
	struct _MSSndCard * ring_sndcard;	/* the playback sndcard currently used */
	struct _MSSndCard * play_sndcard;	/* the playback sndcard currently used */
	struct _MSSndCard * capt_sndcard; /* the capture sndcard currently used */
317
	struct _MSSndCard * lsd_card; /* dummy playback card for Linphone Sound Daemon extension */
318 319 320 321 322
	const char **cards;
	int latency;	/* latency in samples of the current used sound device */
	char rec_lev;
	char play_lev;
	char ring_lev;
323
	char soft_play_lev;
324 325 326
	char source;
	char *local_ring;
	char *remote_ring;
327
	char *ringback_tone;
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
	bool_t ec;
	bool_t ea;
	bool_t agc;
} sound_config_t;

typedef struct codecs_config
{
	MSList *audio_codecs;  /* list of audio codecs in order of preference*/
	MSList *video_codecs;	/* for later use*/
}codecs_config_t;

typedef struct video_config{
	struct _MSWebCam *device;
	const char **cams;
	MSVideoSize vsize;
	bool_t capture;
	bool_t show_local;
	bool_t display;
	bool_t selfview; /*during calls*/
347
	const char *displaytype;
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
}video_config_t;

typedef struct ui_config
{
	int is_daemon;
	int is_applet;
	unsigned int timer_id;  /* the timer id for registration */
}ui_config_t;



typedef struct autoreplier_config
{
	int enabled;
	int after_seconds;		/* accept the call after x seconds*/
	int max_users;			/* maximum number of user that can call simultaneously */
	int max_rec_time;  	/* the max time of incoming voice recorded */
	int max_rec_msg;		/* maximum number of recorded messages */
	const char *message;		/* the path of the file to be played */
}autoreplier_config_t;


struct _LinphoneCore
{
	LinphoneCoreVTable vtable;
	Sal *sal;
Simon Morlat's avatar
Simon Morlat committed
374
	LinphoneGlobalState state;
375 376 377 378 379 380 381 382 383 384 385 386 387
	struct _LpConfig *config;
	net_config_t net_conf;
	sip_config_t sip_conf;
	rtp_config_t rtp_conf;
	sound_config_t sound_conf;
	video_config_t video_conf;
	codecs_config_t codecs_conf;
	ui_config_t ui_conf;
	autoreplier_config_t autoreplier_conf;
	LinphoneProxyConfig *default_proxy;
	MSList *friends;
	MSList *auth_info;
	struct _RingStream *ringstream;
388
	time_t dmfs_playing_start_time;
389
	LCCallbackObj preview_finished_cb;
390 391
	LinphoneCall *current_call;   /* the current call */
	MSList *calls;				/* all the processed calls */
392 393 394 395 396
	MSList *queued_calls;	/* used by the autoreplier */
	MSList *call_logs;
	MSList *chatrooms;
	int max_call_logs;
	int missed_calls;
397
	VideoPreview *previewstream;
398
	struct _MSEventQueue *msevq;
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
	RtpTransport *a_rtp,*a_rtcp;
	MSList *bl_reqs;
	MSList *subscribers;	/* unknown subscribers */
	int minutes_away;
	LinphoneOnlineStatus presence_mode;
	char *alt_contact;
	void *data;
	char *play_file;
	char *rec_file;
	time_t prevtime;
	int dw_audio_bw;
	int up_audio_bw;
	int dw_video_bw;
	int up_video_bw;
	int audio_bw;
	LinphoneWaitingCallback wait_cb;
	void *wait_ctx;
416 417
	unsigned long video_window_id;
	unsigned long preview_window_id;
418
	time_t netup_time; /*time when network went reachable */
419 420
	bool_t use_files;
	bool_t apply_nat_settings;
421
	bool_t initial_subscribes_sent;
422 423
	bool_t bl_refresh;
	bool_t preview_finished;
424
	bool_t auto_net_state_mon;
425
	bool_t network_reachable;
426
	bool_t use_preview_window;
427 428
};

429 430 431 432 433 434
bool_t linphone_core_can_we_add_call(LinphoneCore *lc);
int linphone_core_add_call( LinphoneCore *lc, LinphoneCall *call);
int linphone_core_del_call( LinphoneCore *lc, LinphoneCall *call);
int linphone_core_set_as_current_call(LinphoneCore *lc, LinphoneCall *call);
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 439
SalMediaDescription *create_local_media_description(LinphoneCore *lc, 
    		LinphoneCall *call, bool_t with_video, bool_t only_one_codec);

440 441
#define linphone_core_ready(lc) ((lc)->state!=LinphoneGlobalStartup)

442 443 444 445 446 447 448
#define HOLD_OFF	(0)
#define HOLD_ON		(1)

#ifndef NB_MAX_CALLS
#define NB_MAX_CALLS	(10)
#endif

aymeric's avatar
aymeric committed
449
#endif /* _PRIVATE_H */