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 "linphonefriend.h"
32 #include "linphone_tunnel.h"
33 #include "linphonecore_utils.h"
40 #include "mediastreamer2/ice.h"
41 #include "mediastreamer2/mediastream.h"
42 #include "mediastreamer2/msconference.h"
47 #ifndef LIBLINPHONE_VERSION
48 #define LIBLINPHONE_VERSION LINPHONE_VERSION
51 #ifndef PACKAGE_SOUND_DIR
52 #define PACKAGE_SOUND_DIR "."
55 #ifndef PACKAGE_DATA_DIR
56 #define PACKAGE_DATA_DIR "."
62 #define _(String) gettext(String)
66 #define _(something) (something)
69 #define ngettext(singular, plural, number) (((number)==1)?(singular):(plural))
73 struct _LinphoneCallParams{
74 LinphoneCall *referer; /*in case this call creation is consecutive to an incoming transfer, this points to the original call */
75 int audio_bw; /* bandwidth limit for audio stream */
76 LinphoneMediaEncryption media_encryption;
77 PayloadType *audio_codec; /*audio codec currently in use */
78 PayloadType *video_codec; /*video codec currently in use */
85 bool_t real_early_media; /*send real media even during early media (for outgoing calls)*/
86 bool_t in_conference; /*in conference mode */
91 typedef struct _CallCallbackObj
93 LinphoneCallCbFunc _func;
97 static const int linphone_call_magic=0x3343;
99 struct _LinphoneChatMessage {
101 LinphoneChatRoom* chat_room;
102 LinphoneChatMessageStateChangeCb cb;
104 void* message_userdata;
105 char* external_body_url;
106 LinphoneAddress* from;
110 typedef struct StunCandidate{
118 int magic; /*used to distinguish from proxy config*/
119 struct _LinphoneCore *core;
120 SalMediaDescription *localdesc;
121 SalMediaDescription *resultdesc;
123 LinphoneCall *referer; /*when this call is the result of a transfer, referer is set to the original call that caused the transfer*/
124 struct _RtpProfile *audio_profile;
125 struct _RtpProfile *video_profile;
126 struct _LinphoneCallLog *log;
129 char localip[LINPHONE_IPADDR_SIZE]; /* our best guess for local ipaddress for this call */
130 time_t start_time; /*time at which the call was initiated*/
131 time_t media_start_time; /*time at which it was accepted, media streams established*/
132 LinphoneCallState state;
133 LinphoneCallState transfer_state; /*idle if no transfer*/
134 LinphoneReason reason;
135 LinphoneProxyConfig *dest_proxy;
140 StunCandidate ac,vc; /*audio video ip/port discovered by STUN*/
141 struct _AudioStream *audiostream; /**/
142 struct _VideoStream *videostream;
143 MSAudioEndpoint *endpoint; /*used for conferencing*/
145 LinphoneCallParams params;
146 LinphoneCallParams current_params;
147 LinphoneCallParams remote_params;
148 int up_bw; /*upload bandwidth setting at the time the call is started. Used to detect if it changes during a call */
149 int audio_bw; /*upload bandwidth used by audio */
150 OrtpEvQueue *audiostream_app_evq;
152 OrtpEvQueue *videostream_app_evq;
153 CallCallbackObj nextVideoFrameDecoded;
154 LinphoneCallStats stats[2];
156 UpnpSession *upnp_session;
158 IceSession *ice_session;
159 LinphoneChatMessage* pending_message;
161 unsigned int remote_session_id;
162 unsigned int remote_session_ver;
163 bool_t refer_pending;
164 bool_t media_pending;
166 bool_t camera_active;
168 bool_t all_muted; /*this flag is set during early medias*/
169 bool_t playing_ringbacktone;
170 bool_t owns_call_log;
171 bool_t ringing_beep; /* whether this call is ringing through an already existent current call*/
173 bool_t videostream_encrypted;
174 bool_t audiostream_encrypted;
175 bool_t auth_token_verified;
178 bool_t was_automatically_paused;
180 bool_t record_active;
184 LinphoneCall * linphone_call_new_outgoing(struct _LinphoneCore *lc, LinphoneAddress *from, LinphoneAddress *to, const LinphoneCallParams *params);
185 LinphoneCall * linphone_call_new_incoming(struct _LinphoneCore *lc, LinphoneAddress *from, LinphoneAddress *to, SalOp *op);
186 void linphone_call_set_state(LinphoneCall *call, LinphoneCallState cstate, const char *message);
189 LinphoneCallLog * linphone_call_log_new(LinphoneCall *call, LinphoneAddress *local, LinphoneAddress * remote);
190 void linphone_call_log_completed(LinphoneCall *call);
191 void linphone_call_log_destroy(LinphoneCallLog *cl);
192 void linphone_call_set_transfer_state(LinphoneCall* call, LinphoneCallState state);
194 void linphone_auth_info_write_config(struct _LpConfig *config, LinphoneAuthInfo *obj, int pos);
196 void linphone_core_update_proxy_register(LinphoneCore *lc);
197 void linphone_core_refresh_subscribes(LinphoneCore *lc);
198 int linphone_core_abort_call(LinphoneCore *lc, LinphoneCall *call, const char *error);
200 int linphone_proxy_config_send_publish(LinphoneProxyConfig *cfg, LinphoneOnlineStatus os);
201 void linphone_proxy_config_set_state(LinphoneProxyConfig *cfg, LinphoneRegistrationState rstate, const char *message);
203 int linphone_online_status_to_eXosip(LinphoneOnlineStatus os);
204 void linphone_friend_close_subscriptions(LinphoneFriend *lf);
205 void linphone_friend_notify(LinphoneFriend *lf, LinphoneOnlineStatus os);
206 LinphoneFriend *linphone_find_friend_by_inc_subscribe(MSList *l, SalOp *op);
207 LinphoneFriend *linphone_find_friend_by_out_subscribe(MSList *l, SalOp *op);
209 int parse_hostname_to_addr(const char *server, struct sockaddr_storage *ss, socklen_t *socklen);
212 int remove_lock_file();
213 void check_sound_device(LinphoneCore *lc);
214 void linphone_core_get_local_ip(LinphoneCore *lc, const char *to, char *result);
215 bool_t host_has_ipv6_network();
216 bool_t lp_spawn_command_line_sync(const char *command, char **result,int *command_ret);
218 static inline int get_min_bandwidth(int dbw, int ubw){
219 if (dbw<=0) return ubw;
220 if (ubw<=0) return dbw;
224 static inline bool_t bandwidth_is_greater(int bw1, int bw2){
225 if (bw1<0) return TRUE;
226 else if (bw2<0) return FALSE;
227 else return bw1>=bw2;
230 static inline int get_video_bandwidth(int total, int audio){
231 if (total<=0) return 0;
232 return total-audio-10;
235 static inline void set_string(char **dest, const char *src){
241 *dest=ms_strdup(src);
244 #define PAYLOAD_TYPE_ENABLED PAYLOAD_TYPE_USER_FLAG_0
246 SalPresenceStatus linphone_online_status_to_sal(LinphoneOnlineStatus os);
247 void linphone_process_authentication(LinphoneCore* lc, SalOp *op);
248 void linphone_authentication_ok(LinphoneCore *lc, SalOp *op);
249 void linphone_subscription_new(LinphoneCore *lc, SalOp *op, const char *from);
250 void linphone_notify_recv(LinphoneCore *lc, SalOp *op, SalSubscribeStatus ss, SalPresenceStatus status);
251 void linphone_proxy_config_process_authentication_failure(LinphoneCore *lc, SalOp *op);
253 void linphone_subscription_answered(LinphoneCore *lc, SalOp *op);
254 void linphone_subscription_closed(LinphoneCore *lc, SalOp *op);
256 MSList *linphone_find_friend(MSList *fl, const LinphoneAddress *fri, LinphoneFriend **lf);
258 void linphone_core_update_allocated_audio_bandwidth(LinphoneCore *lc);
259 void linphone_core_update_allocated_audio_bandwidth_in_call(LinphoneCall *call, const PayloadType *pt);
261 int linphone_core_run_stun_tests(LinphoneCore *lc, LinphoneCall *call);
262 void linphone_core_adapt_to_network(LinphoneCore *lc, int ping_time_ms, LinphoneCallParams *params);
263 int linphone_core_gather_ice_candidates(LinphoneCore *lc, LinphoneCall *call);
264 void linphone_core_update_ice_state_in_call_stats(LinphoneCall *call);
265 void linphone_core_update_local_media_description_from_ice(SalMediaDescription *desc, IceSession *session);
266 void linphone_core_update_ice_from_remote_media_description(LinphoneCall *call, const SalMediaDescription *md);
267 bool_t linphone_core_media_description_contains_video_stream(const SalMediaDescription *md);
269 void linphone_core_send_initial_subscribes(LinphoneCore *lc);
270 void linphone_core_write_friends_config(LinphoneCore* lc);
271 void linphone_friend_write_to_config_file(struct _LpConfig *config, LinphoneFriend *lf, int index);
272 LinphoneFriend * linphone_friend_new_from_config_file(struct _LinphoneCore *lc, int index);
274 void linphone_proxy_config_update(LinphoneProxyConfig *cfg);
275 void linphone_proxy_config_get_contact(LinphoneProxyConfig *cfg, const char **ip, int *port);
276 LinphoneProxyConfig * linphone_core_lookup_known_proxy(LinphoneCore *lc, const LinphoneAddress *uri);
277 const char *linphone_core_find_best_identity(LinphoneCore *lc, const LinphoneAddress *to, const char **route);
278 int linphone_core_get_local_ip_for(int type, const char *dest, char *result);
280 LinphoneProxyConfig *linphone_proxy_config_new_from_config_file(struct _LpConfig *config, int index);
281 void linphone_proxy_config_write_to_config_file(struct _LpConfig* config,LinphoneProxyConfig *obj, int index);
283 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *cfg, const char *username, char *result, size_t result_len);
285 void linphone_core_message_received(LinphoneCore *lc, const SalMessage *msg);
287 void linphone_core_play_tone(LinphoneCore *lc);
289 void linphone_call_init_stats(LinphoneCallStats *stats, int type);
291 void linphone_call_init_audio_stream(LinphoneCall *call);
292 void linphone_call_init_video_stream(LinphoneCall *call);
293 void linphone_call_init_media_streams(LinphoneCall *call);
294 void linphone_call_start_media_streams(LinphoneCall *call, bool_t all_inputs_muted, bool_t send_ringbacktone);
295 void linphone_call_start_media_streams_for_ice_gathering(LinphoneCall *call);
296 void linphone_call_stop_audio_stream(LinphoneCall *call);
297 void linphone_call_stop_video_stream(LinphoneCall *call);
298 void linphone_call_stop_media_streams(LinphoneCall *call);
299 void linphone_call_delete_ice_session(LinphoneCall *call);
300 void linphone_call_delete_upnp_session(LinphoneCall *call);
301 void linphone_call_stop_media_streams_for_ice_gathering(LinphoneCall *call);
302 void linphone_call_update_crypto_parameters(LinphoneCall *call, SalMediaDescription *old_md, SalMediaDescription *new_md);
303 void linphone_call_update_remote_session_id_and_ver(LinphoneCall *call);
305 const char * linphone_core_get_identity(LinphoneCore *lc);
306 const char * linphone_core_get_route(LinphoneCore *lc);
307 void linphone_core_start_waiting(LinphoneCore *lc, const char *purpose);
308 void linphone_core_update_progress(LinphoneCore *lc, const char *purpose, float progresses);
309 void linphone_core_stop_waiting(LinphoneCore *lc);
311 int linphone_core_proceed_with_invite_if_ready(LinphoneCore *lc, LinphoneCall *call, LinphoneProxyConfig *dest_proxy);
312 int linphone_core_start_invite(LinphoneCore *lc, LinphoneCall *call);
313 int linphone_core_start_update_call(LinphoneCore *lc, LinphoneCall *call);
314 int linphone_core_start_accept_call_update(LinphoneCore *lc, LinphoneCall *call);
315 void linphone_core_start_refered_call(LinphoneCore *lc, LinphoneCall *call);
316 void linphone_core_notify_incoming_call(LinphoneCore *lc, LinphoneCall *call);
317 bool_t linphone_core_incompatible_security(LinphoneCore *lc, SalMediaDescription *md);
318 extern SalCallbacks linphone_sal_callbacks;
319 void linphone_proxy_config_set_error(LinphoneProxyConfig *cfg, LinphoneReason error);
320 bool_t linphone_core_rtcp_enabled(const LinphoneCore *lc);
322 LinphoneCall * is_a_linphone_call(void *user_pointer);
323 LinphoneProxyConfig * is_a_linphone_proxy_config(void *user_pointer);
325 static const int linphone_proxy_config_magic=0x7979;
328 void linphone_chat_message_destroy(LinphoneChatMessage* msg);
331 struct _LinphoneProxyConfig
334 struct _LinphoneCore *lc;
339 char *contact_params;
344 struct _SipSetupContext *ssctx;
347 LinphoneRegistrationState state;
350 bool_t reg_sendregister;
352 bool_t dial_escape_plus;
354 time_t deletion_date;
355 LinphoneReason error;
358 struct _LinphoneAuthInfo
366 time_t last_use_time;
370 struct _LinphoneChatRoom{
371 struct _LinphoneCore *lc;
373 LinphoneAddress *peer_url;
379 struct _LinphoneFriend{
380 LinphoneAddress *uri;
383 LinphoneSubscribePolicy pol;
384 LinphoneOnlineStatus status;
385 struct _LinphoneCore *lc;
389 bool_t subscribe_active;
390 bool_t inc_subscribe_pending;
395 typedef struct sip_config
398 char *guessed_contact;
400 MSList *deleted_proxies;
401 int inc_timeout; /*timeout after an un-answered incoming call is rejected*/
402 int in_call_timeout; /*timeout after a call is hangup */
403 unsigned int keepalive_period; /* interval in ms between keep alive messages sent to the proxy server*/
404 LCSipTransports transports;
406 bool_t use_rfc2833; /*force RFC2833 to be sent*/
407 bool_t guess_hostname;
408 bool_t loopback_only;
411 bool_t register_only_when_network_is_up;
412 bool_t ping_with_options;
413 bool_t auto_net_state_mon;
414 bool_t tcp_tls_keepalive;
417 typedef struct rtp_config
419 int audio_rtp_min_port;
420 int audio_rtp_max_port;
421 int video_rtp_min_port;
422 int video_rtp_max_port;
423 int audio_jitt_comp; /*jitter compensation*/
424 int video_jitt_comp; /*jitter compensation*/
426 bool_t rtp_no_xmit_on_audio_mute;
427 /* stop rtp xmit when audio muted */
428 bool_t audio_adaptive_jitt_comp_enabled;
429 bool_t video_adaptive_jitt_comp_enabled;
435 typedef struct net_config
437 char *nat_address; /* may be IP or host name */
438 char *nat_address_ip; /* ip translated from nat_address */
449 typedef struct sound_config
451 struct _MSSndCard * ring_sndcard; /* the playback sndcard currently used */
452 struct _MSSndCard * play_sndcard; /* the playback sndcard currently used */
453 struct _MSSndCard * capt_sndcard; /* the capture sndcard currently used */
454 struct _MSSndCard * lsd_card; /* dummy playback card for Linphone Sound Daemon extension */
456 int latency; /* latency in samples of the current used sound device */
457 float soft_play_lev; /*playback gain in db.*/
458 float soft_mic_lev; /*mic gain in db.*/
471 typedef struct codecs_config
473 MSList *audio_codecs; /* list of audio codecs in order of preference*/
474 MSList *video_codecs; /* for later use*/
477 typedef struct video_config{
478 struct _MSWebCam *device;
484 bool_t selfview; /*during calls*/
485 const char *displaytype;
488 typedef struct ui_config
492 unsigned int timer_id; /* the timer id for registration */
497 typedef struct autoreplier_config
500 int after_seconds; /* accept the call after x seconds*/
501 int max_users; /* maximum number of user that can call simultaneously */
502 int max_rec_time; /* the max time of incoming voice recorded */
503 int max_rec_msg; /* maximum number of recorded messages */
504 const char *message; /* the path of the file to be played */
505 }autoreplier_config_t;
507 struct _LinphoneConference{
508 MSAudioConference *conf;
509 AudioStream *local_participant;
510 MSAudioEndpoint *local_endpoint;
511 RtpProfile *local_dummy_profile;
515 typedef struct _LinphoneConference LinphoneConference;
519 LinphoneCoreVTable vtable;
521 LinphoneGlobalState state;
522 struct _LpConfig *config;
523 RtpProfile *default_profile;
524 net_config_t net_conf;
525 sip_config_t sip_conf;
526 rtp_config_t rtp_conf;
527 sound_config_t sound_conf;
528 video_config_t video_conf;
529 codecs_config_t codecs_conf;
531 autoreplier_config_t autoreplier_conf;
532 MSList *payload_types;
534 LinphoneProxyConfig *default_proxy;
537 struct _RingStream *ringstream;
538 time_t dmfs_playing_start_time;
539 LCCallbackObj preview_finished_cb;
540 LinphoneCall *current_call; /* the current call */
541 MSList *calls; /* all the processed calls */
542 MSList *queued_calls; /* used by the autoreplier */
547 VideoPreview *previewstream;
548 struct _MSEventQueue *msevq;
549 LinphoneRtpTransportFactories *rtptf;
551 MSList *subscribers; /* unknown subscribers */
553 LinphoneOnlineStatus presence_mode;
560 LinphoneWaitingCallback wait_cb;
562 unsigned long video_window_id;
563 unsigned long preview_window_id;
564 time_t netup_time; /*time when network went reachable */
565 struct _EcCalibrator *ecc;
567 LinphoneConference conf_ctx;
568 char* zrtp_secrets_cache;
569 LinphoneVideoPolicy video_policy;
571 bool_t apply_nat_settings;
572 bool_t initial_subscribes_sent;
575 bool_t preview_finished;
576 bool_t auto_net_state_mon;
577 bool_t network_reachable;
578 bool_t use_preview_window;
580 time_t network_last_check;
581 bool_t network_last_status;
583 bool_t ringstream_autorelease;
587 LinphoneTunnel *tunnel;
589 MSList *last_recv_msg_ids;
595 LinphoneTunnel *linphone_core_tunnel_new(LinphoneCore *lc);
596 void linphone_tunnel_destroy(LinphoneTunnel *tunnel);
597 void linphone_tunnel_configure(LinphoneTunnel *tunnel);
598 void linphone_tunnel_enable_logs_with_handler(LinphoneTunnel *tunnel, bool_t enabled, OrtpLogFunc logHandler);
600 bool_t linphone_core_can_we_add_call(LinphoneCore *lc);
601 int linphone_core_add_call( LinphoneCore *lc, LinphoneCall *call);
602 int linphone_core_del_call( LinphoneCore *lc, LinphoneCall *call);
603 int linphone_core_set_as_current_call(LinphoneCore *lc, LinphoneCall *call);
604 int linphone_core_get_calls_nb(const LinphoneCore *lc);
606 void linphone_core_set_state(LinphoneCore *lc, LinphoneGlobalState gstate, const char *message);
607 void linphone_call_make_local_media_description(LinphoneCore *lc, LinphoneCall *call);
608 void linphone_core_update_streams(LinphoneCore *lc, LinphoneCall *call, SalMediaDescription *new_md);
610 bool_t linphone_core_is_payload_type_usable_for_bandwidth(LinphoneCore *lc, PayloadType *pt, int bandwidth_limit);
612 #define linphone_core_ready(lc) ((lc)->state!=LinphoneGlobalStartup)
613 void _linphone_core_configure_resolver();
615 struct _EcCalibrator{
617 MSSndCard *play_card,*capt_card;
618 MSFilter *sndread,*det,*rec;
619 MSFilter *play, *gen, *sndwrite;
620 MSFilter *read_resampler,*write_resampler;
622 LinphoneEcCalibrationCallback cb;
629 LinphoneEcCalibratorStatus status;
632 typedef struct _EcCalibrator EcCalibrator;
634 LinphoneEcCalibratorStatus ec_calibrator_get_status(EcCalibrator *ecc);
636 void ec_calibrator_destroy(EcCalibrator *ecc);
638 void linphone_call_background_tasks(LinphoneCall *call, bool_t one_second_elapsed);
639 void linphone_core_preempt_sound_resources(LinphoneCore *lc);
640 /*conferencing subsystem*/
641 void _post_configure_audio_stream(AudioStream *st, LinphoneCore *lc, bool_t muted);
642 /* When a conference participant pause the conference he may send a music.
643 * We don't want to hear that music or to send it to the other participants.
644 * Use muted=yes to handle this case.
646 void linphone_call_add_to_conf(LinphoneCall *call, bool_t muted);
647 void linphone_call_remove_from_conf(LinphoneCall *call);
648 void linphone_core_conference_check_uninit(LinphoneCore *lc);
649 bool_t linphone_core_sound_resources_available(LinphoneCore *lc);
650 void linphone_core_notify_refer_state(LinphoneCore *lc, LinphoneCall *referer, LinphoneCall *newcall);
651 unsigned int linphone_core_get_audio_features(LinphoneCore *lc);
653 void __linphone_core_invalidate_registers(LinphoneCore* lc);
654 void _linphone_core_codec_config_write(LinphoneCore *lc);
660 #define NB_MAX_CALLS (10)
662 void call_logs_write_to_config_file(LinphoneCore *lc);
664 int linphone_core_get_edge_bw(LinphoneCore *lc);
665 int linphone_core_get_edge_ptime(LinphoneCore *lc);
666 void _linphone_call_params_copy(LinphoneCallParams *params, const LinphoneCallParams *refparams);
668 int linphone_upnp_init(LinphoneCore *lc);
669 void linphone_upnp_destroy(LinphoneCore *lc);
675 #endif /* _PRIVATE_H */