1 /***************************************************************************
4 * Mon Jun 13 14:23:23 2005
5 * Copyright 2005 Simon Morlat
6 * Email simon dot morlat at linphone dot org
7 ****************************************************************************/
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.
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.
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.
30 #include "linphonecore.h"
31 #include "linphone_tunnel.h"
32 #include "linphonecore_utils.h"
38 #include "mediastreamer2/ice.h"
39 #include "mediastreamer2/mediastream.h"
40 #include "mediastreamer2/msconference.h"
42 #ifndef LIBLINPHONE_VERSION
43 #define LIBLINPHONE_VERSION LINPHONE_VERSION
46 #ifndef PACKAGE_SOUND_DIR
47 #define PACKAGE_SOUND_DIR "."
50 #ifndef PACKAGE_DATA_DIR
51 #define PACKAGE_DATA_DIR "."
57 #define _(String) gettext(String)
61 #define _(something) (something)
64 #define ngettext(singular, plural, number) (((number)==1)?(singular):(plural))
68 struct _LinphoneCallParams{
69 LinphoneCall *referer; /*in case this call creation is consecutive to an incoming transfer, this points to the original call */
70 int audio_bw; /* bandwidth limit for audio stream */
71 LinphoneMediaEncryption media_encryption;
72 PayloadType *audio_codec; /*audio codec currently in use */
73 PayloadType *video_codec; /*video codec currently in use */
79 bool_t real_early_media; /*send real media even during early media (for outgoing calls)*/
80 bool_t in_conference; /*in conference mode */
85 typedef struct _CallCallbackObj
87 LinphoneCallCbFunc _func;
91 static const int linphone_call_magic=0x3343;
93 struct _LinphoneChatMessage {
95 LinphoneChatRoom* chat_room;
96 LinphoneChatMessageStateChangeCb cb;
98 void* message_userdata;
99 char* external_body_url;
100 LinphoneAddress* from;
103 typedef struct StunCandidate{
111 int magic; /*used to distinguish from proxy config*/
112 struct _LinphoneCore *core;
113 SalMediaDescription *localdesc;
114 SalMediaDescription *resultdesc;
116 LinphoneCall *referer; /*when this call is the result of a transfer, referer is set to the original call that caused the transfer*/
117 struct _RtpProfile *audio_profile;
118 struct _RtpProfile *video_profile;
119 struct _LinphoneCallLog *log;
122 char localip[LINPHONE_IPADDR_SIZE]; /* our best guess for local ipaddress for this call */
123 time_t start_time; /*time at which the call was initiated*/
124 time_t media_start_time; /*time at which it was accepted, media streams established*/
125 LinphoneCallState state;
126 LinphoneCallState transfer_state; /*idle if no transfer*/
127 LinphoneReason reason;
128 LinphoneProxyConfig *dest_proxy;
133 StunCandidate ac,vc; /*audio video ip/port discovered by STUN*/
134 struct _AudioStream *audiostream; /**/
135 struct _VideoStream *videostream;
136 MSAudioEndpoint *endpoint; /*used for conferencing*/
138 LinphoneCallParams params;
139 LinphoneCallParams current_params;
140 LinphoneCallParams remote_params;
141 int up_bw; /*upload bandwidth setting at the time the call is started. Used to detect if it changes during a call */
142 int audio_bw; /*upload bandwidth used by audio */
143 OrtpEvQueue *audiostream_app_evq;
145 OrtpEvQueue *videostream_app_evq;
146 CallCallbackObj nextVideoFrameDecoded;
147 LinphoneCallStats stats[2];
148 IceSession *ice_session;
149 LinphoneChatMessage* pending_message;
151 bool_t refer_pending;
152 bool_t media_pending;
154 bool_t camera_active;
156 bool_t all_muted; /*this flag is set during early medias*/
157 bool_t playing_ringbacktone;
158 bool_t owns_call_log;
159 bool_t ringing_beep; /* whether this call is ringing through an already existent current call*/
161 bool_t videostream_encrypted;
162 bool_t audiostream_encrypted;
163 bool_t auth_token_verified;
166 bool_t was_automatically_paused;
171 LinphoneCall * linphone_call_new_outgoing(struct _LinphoneCore *lc, LinphoneAddress *from, LinphoneAddress *to, const LinphoneCallParams *params);
172 LinphoneCall * linphone_call_new_incoming(struct _LinphoneCore *lc, LinphoneAddress *from, LinphoneAddress *to, SalOp *op);
173 void linphone_call_set_state(LinphoneCall *call, LinphoneCallState cstate, const char *message);
176 LinphoneCallLog * linphone_call_log_new(LinphoneCall *call, LinphoneAddress *local, LinphoneAddress * remote);
177 void linphone_call_log_completed(LinphoneCall *call);
178 void linphone_call_log_destroy(LinphoneCallLog *cl);
179 void linphone_call_set_transfer_state(LinphoneCall* call, LinphoneCallState state);
181 void linphone_auth_info_write_config(struct _LpConfig *config, LinphoneAuthInfo *obj, int pos);
183 void linphone_core_update_proxy_register(LinphoneCore *lc);
184 void linphone_core_refresh_subscribes(LinphoneCore *lc);
185 int linphone_core_abort_call(LinphoneCore *lc, LinphoneCall *call, const char *error);
187 int linphone_proxy_config_send_publish(LinphoneProxyConfig *cfg, LinphoneOnlineStatus os);
188 void linphone_proxy_config_set_state(LinphoneProxyConfig *cfg, LinphoneRegistrationState rstate, const char *message);
190 int linphone_online_status_to_eXosip(LinphoneOnlineStatus os);
191 void linphone_friend_close_subscriptions(LinphoneFriend *lf);
192 void linphone_friend_notify(LinphoneFriend *lf, LinphoneOnlineStatus os);
193 LinphoneFriend *linphone_find_friend_by_inc_subscribe(MSList *l, SalOp *op);
194 LinphoneFriend *linphone_find_friend_by_out_subscribe(MSList *l, SalOp *op);
196 int parse_hostname_to_addr(const char *server, struct sockaddr_storage *ss, socklen_t *socklen);
199 int remove_lock_file();
200 void check_sound_device(LinphoneCore *lc);
201 void linphone_core_get_local_ip(LinphoneCore *lc, const char *to, char *result);
202 bool_t host_has_ipv6_network();
203 bool_t lp_spawn_command_line_sync(const char *command, char **result,int *command_ret);
205 static inline int get_min_bandwidth(int dbw, int ubw){
206 if (dbw<=0) return ubw;
207 if (ubw<=0) return dbw;
211 static inline bool_t bandwidth_is_greater(int bw1, int bw2){
212 if (bw1<0) return TRUE;
213 else if (bw2<0) return FALSE;
214 else return bw1>=bw2;
217 static inline int get_video_bandwidth(int total, int audio){
218 if (total<=0) return 0;
219 return total-audio-10;
222 static inline void set_string(char **dest, const char *src){
228 *dest=ms_strdup(src);
231 #define PAYLOAD_TYPE_ENABLED PAYLOAD_TYPE_USER_FLAG_0
233 SalPresenceStatus linphone_online_status_to_sal(LinphoneOnlineStatus os);
234 void linphone_process_authentication(LinphoneCore* lc, SalOp *op);
235 void linphone_authentication_ok(LinphoneCore *lc, SalOp *op);
236 void linphone_subscription_new(LinphoneCore *lc, SalOp *op, const char *from);
237 void linphone_notify_recv(LinphoneCore *lc, SalOp *op, SalSubscribeStatus ss, SalPresenceStatus status);
238 void linphone_proxy_config_process_authentication_failure(LinphoneCore *lc, SalOp *op);
240 void linphone_subscription_answered(LinphoneCore *lc, SalOp *op);
241 void linphone_subscription_closed(LinphoneCore *lc, SalOp *op);
243 MSList *linphone_find_friend(MSList *fl, const LinphoneAddress *fri, LinphoneFriend **lf);
245 void linphone_core_update_allocated_audio_bandwidth(LinphoneCore *lc);
246 void linphone_core_update_allocated_audio_bandwidth_in_call(LinphoneCall *call, const PayloadType *pt);
248 int linphone_core_run_stun_tests(LinphoneCore *lc, LinphoneCall *call);
249 void linphone_core_adapt_to_network(LinphoneCore *lc, int ping_time_ms, LinphoneCallParams *params);
250 int linphone_core_gather_ice_candidates(LinphoneCore *lc, LinphoneCall *call);
251 void linphone_core_update_ice_state_in_call_stats(LinphoneCall *call);
252 void linphone_core_update_local_media_description_from_ice(SalMediaDescription *desc, IceSession *session);
253 void linphone_core_update_ice_from_remote_media_description(LinphoneCall *call, const SalMediaDescription *md);
254 bool_t linphone_core_media_description_contains_video_stream(const SalMediaDescription *md);
256 void linphone_core_send_initial_subscribes(LinphoneCore *lc);
257 void linphone_core_write_friends_config(LinphoneCore* lc);
258 void linphone_friend_write_to_config_file(struct _LpConfig *config, LinphoneFriend *lf, int index);
259 LinphoneFriend * linphone_friend_new_from_config_file(struct _LinphoneCore *lc, int index);
261 void linphone_proxy_config_update(LinphoneProxyConfig *cfg);
262 void linphone_proxy_config_get_contact(LinphoneProxyConfig *cfg, const char **ip, int *port);
263 LinphoneProxyConfig * linphone_core_lookup_known_proxy(LinphoneCore *lc, const LinphoneAddress *uri);
264 const char *linphone_core_find_best_identity(LinphoneCore *lc, const LinphoneAddress *to, const char **route);
265 int linphone_core_get_local_ip_for(int type, const char *dest, char *result);
267 LinphoneProxyConfig *linphone_proxy_config_new_from_config_file(struct _LpConfig *config, int index);
268 void linphone_proxy_config_write_to_config_file(struct _LpConfig* config,LinphoneProxyConfig *obj, int index);
270 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *cfg, const char *username, char *result, size_t result_len);
272 void linphone_core_message_received(LinphoneCore *lc, const char *from, const char *raw_msg,const char* external_url);
274 void linphone_core_play_tone(LinphoneCore *lc);
276 void linphone_call_init_stats(LinphoneCallStats *stats, int type);
278 void linphone_call_init_audio_stream(LinphoneCall *call);
279 void linphone_call_init_video_stream(LinphoneCall *call);
280 void linphone_call_init_media_streams(LinphoneCall *call);
281 void linphone_call_start_media_streams(LinphoneCall *call, bool_t all_inputs_muted, bool_t send_ringbacktone);
282 void linphone_call_start_media_streams_for_ice_gathering(LinphoneCall *call);
283 void linphone_call_stop_audio_stream(LinphoneCall *call);
284 void linphone_call_stop_video_stream(LinphoneCall *call);
285 void linphone_call_stop_media_streams(LinphoneCall *call);
286 void linphone_call_delete_ice_session(LinphoneCall *call);
287 void linphone_call_stop_media_streams_for_ice_gathering(LinphoneCall *call);
289 const char * linphone_core_get_identity(LinphoneCore *lc);
290 const char * linphone_core_get_route(LinphoneCore *lc);
291 void linphone_core_start_waiting(LinphoneCore *lc, const char *purpose);
292 void linphone_core_update_progress(LinphoneCore *lc, const char *purpose, float progresses);
293 void linphone_core_stop_waiting(LinphoneCore *lc);
295 int linphone_core_proceed_with_invite_if_ready(LinphoneCore *lc, LinphoneCall *call, LinphoneProxyConfig *dest_proxy);
296 int linphone_core_start_invite(LinphoneCore *lc, LinphoneCall *call);
297 int linphone_core_start_update_call(LinphoneCore *lc, LinphoneCall *call);
298 int linphone_core_start_accept_call_update(LinphoneCore *lc, LinphoneCall *call);
299 void linphone_core_start_refered_call(LinphoneCore *lc, LinphoneCall *call);
300 void linphone_core_notify_incoming_call(LinphoneCore *lc, LinphoneCall *call);
301 extern SalCallbacks linphone_sal_callbacks;
302 void linphone_proxy_config_set_error(LinphoneProxyConfig *cfg, LinphoneReason error);
303 bool_t linphone_core_rtcp_enabled(const LinphoneCore *lc);
305 LinphoneCall * is_a_linphone_call(void *user_pointer);
306 LinphoneProxyConfig * is_a_linphone_proxy_config(void *user_pointer);
308 static const int linphone_proxy_config_magic=0x7979;
311 void linphone_chat_message_destroy(LinphoneChatMessage* msg);
314 struct _LinphoneProxyConfig
317 struct _LinphoneCore *lc;
322 char *contact_params;
327 struct _SipSetupContext *ssctx;
330 LinphoneRegistrationState state;
333 bool_t reg_sendregister;
335 bool_t dial_escape_plus;
337 time_t deletion_date;
338 LinphoneReason error;
341 struct _LinphoneAuthInfo
349 time_t last_use_time;
353 struct _LinphoneChatRoom{
354 struct _LinphoneCore *lc;
356 LinphoneAddress *peer_url;
362 struct _LinphoneFriend{
363 LinphoneAddress *uri;
366 LinphoneSubscribePolicy pol;
367 LinphoneOnlineStatus status;
368 struct _LinphoneCore *lc;
372 bool_t subscribe_active;
373 bool_t inc_subscribe_pending;
378 typedef struct sip_config
381 char *guessed_contact;
383 MSList *deleted_proxies;
384 int inc_timeout; /*timeout after an un-answered incoming call is rejected*/
385 int in_call_timeout; /*timeout after a call is hangup */
386 unsigned int keepalive_period; /* interval in ms between keep alive messages sent to the proxy server*/
387 LCSipTransports transports;
389 bool_t use_rfc2833; /*force RFC2833 to be sent*/
390 bool_t guess_hostname;
391 bool_t loopback_only;
394 bool_t register_only_when_network_is_up;
395 bool_t ping_with_options;
396 bool_t auto_net_state_mon;
399 typedef struct rtp_config
401 int audio_rtp_min_port;
402 int audio_rtp_max_port;
403 int video_rtp_min_port;
404 int video_rtp_max_port;
405 int audio_jitt_comp; /*jitter compensation*/
406 int video_jitt_comp; /*jitter compensation*/
408 bool_t rtp_no_xmit_on_audio_mute;
409 /* stop rtp xmit when audio muted */
410 bool_t audio_adaptive_jitt_comp_enabled;
411 bool_t video_adaptive_jitt_comp_enabled;
417 typedef struct net_config
419 char *nat_address; /* may be IP or host name */
420 char *nat_address_ip; /* ip translated from nat_address */
431 typedef struct sound_config
433 struct _MSSndCard * ring_sndcard; /* the playback sndcard currently used */
434 struct _MSSndCard * play_sndcard; /* the playback sndcard currently used */
435 struct _MSSndCard * capt_sndcard; /* the capture sndcard currently used */
436 struct _MSSndCard * lsd_card; /* dummy playback card for Linphone Sound Daemon extension */
438 int latency; /* latency in samples of the current used sound device */
439 float soft_play_lev; /*playback gain in db.*/
440 float soft_mic_lev; /*mic gain in db.*/
453 typedef struct codecs_config
455 MSList *audio_codecs; /* list of audio codecs in order of preference*/
456 MSList *video_codecs; /* for later use*/
459 typedef struct video_config{
460 struct _MSWebCam *device;
466 bool_t selfview; /*during calls*/
467 const char *displaytype;
470 typedef struct ui_config
474 unsigned int timer_id; /* the timer id for registration */
479 typedef struct autoreplier_config
482 int after_seconds; /* accept the call after x seconds*/
483 int max_users; /* maximum number of user that can call simultaneously */
484 int max_rec_time; /* the max time of incoming voice recorded */
485 int max_rec_msg; /* maximum number of recorded messages */
486 const char *message; /* the path of the file to be played */
487 }autoreplier_config_t;
489 struct _LinphoneConference{
490 MSAudioConference *conf;
491 AudioStream *local_participant;
492 MSAudioEndpoint *local_endpoint;
493 RtpProfile *local_dummy_profile;
497 typedef struct _LinphoneConference LinphoneConference;
501 LinphoneCoreVTable vtable;
503 LinphoneGlobalState state;
504 struct _LpConfig *config;
505 net_config_t net_conf;
506 sip_config_t sip_conf;
507 rtp_config_t rtp_conf;
508 sound_config_t sound_conf;
509 video_config_t video_conf;
510 codecs_config_t codecs_conf;
512 autoreplier_config_t autoreplier_conf;
513 MSList *payload_types;
515 LinphoneProxyConfig *default_proxy;
518 struct _RingStream *ringstream;
519 time_t dmfs_playing_start_time;
520 LCCallbackObj preview_finished_cb;
521 LinphoneCall *current_call; /* the current call */
522 MSList *calls; /* all the processed calls */
523 MSList *queued_calls; /* used by the autoreplier */
528 VideoPreview *previewstream;
529 struct _MSEventQueue *msevq;
530 LinphoneRtpTransportFactories *rtptf;
532 MSList *subscribers; /* unknown subscribers */
534 LinphoneOnlineStatus presence_mode;
541 LinphoneWaitingCallback wait_cb;
543 unsigned long video_window_id;
544 unsigned long preview_window_id;
545 time_t netup_time; /*time when network went reachable */
546 struct _EcCalibrator *ecc;
548 LinphoneConference conf_ctx;
549 char* zrtp_secrets_cache;
550 LinphoneVideoPolicy video_policy;
552 bool_t apply_nat_settings;
553 bool_t initial_subscribes_sent;
556 bool_t preview_finished;
557 bool_t auto_net_state_mon;
558 bool_t network_reachable;
559 bool_t use_preview_window;
561 time_t network_last_check;
562 bool_t network_last_status;
564 bool_t ringstream_autorelease;
568 LinphoneTunnel *tunnel;
570 MSList *last_recv_msg_ids;
573 LinphoneTunnel *linphone_core_tunnel_new(LinphoneCore *lc);
574 void linphone_tunnel_destroy(LinphoneTunnel *tunnel);
575 void linphone_tunnel_configure(LinphoneTunnel *tunnel);
576 void linphone_tunnel_enable_logs_with_handler(LinphoneTunnel *tunnel, bool_t enabled, OrtpLogFunc logHandler);
578 bool_t linphone_core_can_we_add_call(LinphoneCore *lc);
579 int linphone_core_add_call( LinphoneCore *lc, LinphoneCall *call);
580 int linphone_core_del_call( LinphoneCore *lc, LinphoneCall *call);
581 int linphone_core_set_as_current_call(LinphoneCore *lc, LinphoneCall *call);
582 int linphone_core_get_calls_nb(const LinphoneCore *lc);
584 void linphone_core_set_state(LinphoneCore *lc, LinphoneGlobalState gstate, const char *message);
585 void linphone_call_make_local_media_description(LinphoneCore *lc, LinphoneCall *call);
586 void linphone_core_update_streams(LinphoneCore *lc, LinphoneCall *call, SalMediaDescription *new_md);
588 bool_t linphone_core_is_payload_type_usable_for_bandwidth(LinphoneCore *lc, PayloadType *pt, int bandwidth_limit);
590 #define linphone_core_ready(lc) ((lc)->state!=LinphoneGlobalStartup)
591 void _linphone_core_configure_resolver();
593 struct _EcCalibrator{
595 MSSndCard *play_card,*capt_card;
596 MSFilter *sndread,*det,*rec;
597 MSFilter *play, *gen, *sndwrite;
598 MSFilter *read_resampler,*write_resampler;
600 LinphoneEcCalibrationCallback cb;
607 LinphoneEcCalibratorStatus status;
610 typedef struct _EcCalibrator EcCalibrator;
612 LinphoneEcCalibratorStatus ec_calibrator_get_status(EcCalibrator *ecc);
614 void ec_calibrator_destroy(EcCalibrator *ecc);
616 void linphone_call_background_tasks(LinphoneCall *call, bool_t one_second_elapsed);
617 void linphone_core_preempt_sound_resources(LinphoneCore *lc);
618 /*conferencing subsystem*/
619 void _post_configure_audio_stream(AudioStream *st, LinphoneCore *lc, bool_t muted);
620 /* When a conference participant pause the conference he may send a music.
621 * We don't want to hear that music or to send it to the other participants.
622 * Use muted=yes to handle this case.
624 void linphone_call_add_to_conf(LinphoneCall *call, bool_t muted);
625 void linphone_call_remove_from_conf(LinphoneCall *call);
626 void linphone_core_conference_check_uninit(LinphoneCore *lc);
627 bool_t linphone_core_sound_resources_available(LinphoneCore *lc);
628 void linphone_core_notify_refer_state(LinphoneCore *lc, LinphoneCall *referer, LinphoneCall *newcall);
629 unsigned int linphone_core_get_audio_features(LinphoneCore *lc);
631 void __linphone_core_invalidate_registers(LinphoneCore* lc);
632 void _linphone_core_codec_config_write(LinphoneCore *lc);
638 #define NB_MAX_CALLS (10)
640 void call_logs_write_to_config_file(LinphoneCore *lc);
648 #endif /* _PRIVATE_H */