]> sjero.net Git - linphone/blob - coreapi/private.h
Redesign ICE integration to prevent Sal from depending on ICE.
[linphone] / 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 #ifdef __cplusplus
28 extern "C" {
29 #endif
30 #include "linphonecore.h"
31 #include "linphone_tunnel.h"
32 #include "linphonecore_utils.h"
33 #include "sal.h"
34
35 #ifdef HAVE_CONFIG_H
36 #include "config.h"
37 #endif
38 #include "mediastreamer2/ice.h"
39 #include "mediastreamer2/mediastream.h"
40 #include "mediastreamer2/msconference.h"
41
42 #ifndef LIBLINPHONE_VERSION
43 #define LIBLINPHONE_VERSION LINPHONE_VERSION
44 #endif
45
46 #ifndef PACKAGE_SOUND_DIR
47 #define PACKAGE_SOUND_DIR "."
48 #endif
49
50 #ifndef PACKAGE_DATA_DIR
51 #define PACKAGE_DATA_DIR "."
52 #endif
53
54 #ifdef HAVE_GETTEXT
55 #include <libintl.h>
56 #ifndef _
57 #define _(String) gettext(String)
58 #endif
59 #else
60 #ifndef _
61 #define _(something)    (something)
62 #endif
63 #ifndef ngettext
64 #define ngettext(singular, plural, number)      (((number)==1)?(singular):(plural))
65 #endif
66 #endif
67
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;
73         PayloadType *video_codec;
74         bool_t has_video;
75         bool_t real_early_media; /*send real media even during early media (for outgoing calls)*/
76         bool_t in_conference; /*in conference mode */
77         bool_t pad;
78         
79 };
80     
81 typedef struct _CallCallbackObj
82 {
83     LinphoneCallCbFunc _func;
84     void * _user_data;
85 }CallCallbackObj;
86
87 static const int linphone_call_magic=0x3343;
88
89 struct _LinphoneCall
90 {
91         int magic; /*used to distinguish from proxy config*/
92         struct _LinphoneCore *core;
93         SalMediaDescription *localdesc;
94         SalMediaDescription *resultdesc;
95         LinphoneCallDir dir;
96         LinphoneCall *referer; /*when this call is the result of a transfer, referer is set to the original call that caused the transfer*/
97         struct _RtpProfile *audio_profile;
98         struct _RtpProfile *video_profile;
99         struct _LinphoneCallLog *log;
100         SalOp *op;
101         SalOp *ping_op;
102         char localip[LINPHONE_IPADDR_SIZE]; /* our best guess for local ipaddress for this call */
103         time_t start_time; /*time at which the call was initiated*/
104         time_t media_start_time; /*time at which it was accepted, media streams established*/
105         LinphoneCallState       state;
106         LinphoneCallState transfer_state; /*idle if no transfer*/
107         LinphoneReason reason;
108         int refcnt;
109         void * user_pointer;
110         int audio_port;
111         int video_port;
112         struct _AudioStream *audiostream;  /**/
113         struct _VideoStream *videostream;
114         MSAudioEndpoint *endpoint; /*used for conferencing*/
115         char *refer_to;
116         LinphoneCallParams params;
117         LinphoneCallParams current_params;
118         LinphoneCallParams remote_params;
119         int up_bw; /*upload bandwidth setting at the time the call is started. Used to detect if it changes during a call */
120         int audio_bw;   /*upload bandwidth used by audio */
121         bool_t refer_pending;
122         bool_t media_pending;
123         bool_t audio_muted;
124         bool_t camera_active;
125         bool_t all_muted; /*this flag is set during early medias*/
126         bool_t playing_ringbacktone;
127         bool_t owns_call_log;
128         bool_t ringing_beep; /* whether this call is ringing through an already existent current call*/
129         OrtpEvQueue *audiostream_app_evq;
130         char *auth_token;
131         OrtpEvQueue *videostream_app_evq;
132         bool_t videostream_encrypted;
133         bool_t audiostream_encrypted;
134         bool_t auth_token_verified;
135         bool_t defer_update;
136         bool_t was_automatically_paused;
137         CallCallbackObj nextVideoFrameDecoded;
138         LinphoneCallStats stats[2];
139         IceSession *ice_session;
140 };
141
142
143 LinphoneCall * linphone_call_new_outgoing(struct _LinphoneCore *lc, LinphoneAddress *from, LinphoneAddress *to, const LinphoneCallParams *params);
144 LinphoneCall * linphone_call_new_incoming(struct _LinphoneCore *lc, LinphoneAddress *from, LinphoneAddress *to, SalOp *op);
145 void linphone_call_set_state(LinphoneCall *call, LinphoneCallState cstate, const char *message);
146
147 /* private: */
148 LinphoneCallLog * linphone_call_log_new(LinphoneCall *call, LinphoneAddress *local, LinphoneAddress * remote);
149 void linphone_call_log_completed(LinphoneCall *call);
150 void linphone_call_log_destroy(LinphoneCallLog *cl);
151 void linphone_call_set_transfer_state(LinphoneCall* call, LinphoneCallState state);
152
153 void linphone_auth_info_write_config(struct _LpConfig *config, LinphoneAuthInfo *obj, int pos);
154
155 void linphone_core_update_proxy_register(LinphoneCore *lc);
156 void linphone_core_refresh_subscribes(LinphoneCore *lc);
157 int linphone_core_abort_call(LinphoneCore *lc, LinphoneCall *call, const char *error);
158
159 int linphone_proxy_config_send_publish(LinphoneProxyConfig *cfg, LinphoneOnlineStatus os);
160 void linphone_proxy_config_set_state(LinphoneProxyConfig *cfg, LinphoneRegistrationState rstate, const char *message);
161
162 int linphone_online_status_to_eXosip(LinphoneOnlineStatus os);
163 void linphone_friend_close_subscriptions(LinphoneFriend *lf);
164 void linphone_friend_notify(LinphoneFriend *lf, LinphoneOnlineStatus os);
165 LinphoneFriend *linphone_find_friend_by_inc_subscribe(MSList *l, SalOp *op);
166 LinphoneFriend *linphone_find_friend_by_out_subscribe(MSList *l, SalOp *op);
167
168 int parse_hostname_to_addr(const char *server, struct sockaddr_storage *ss, socklen_t *socklen);
169 int set_lock_file();
170 int get_lock_file();
171 int remove_lock_file();
172 int do_registration(LinphoneCore *lc, bool_t doit);
173 void check_for_registration(LinphoneCore *lc);
174 void check_sound_device(LinphoneCore *lc);
175 void linphone_core_verify_codecs(LinphoneCore *lc);
176 void linphone_core_get_local_ip(LinphoneCore *lc, const char *to, char *result);
177 bool_t host_has_ipv6_network();
178 bool_t lp_spawn_command_line_sync(const char *command, char **result,int *command_ret);
179
180 static inline int get_min_bandwidth(int dbw, int ubw){
181         if (dbw<=0) return ubw;
182         if (ubw<=0) return dbw;
183         return MIN(dbw,ubw);
184 }
185
186 static inline bool_t bandwidth_is_greater(int bw1, int bw2){
187         if (bw1<0) return TRUE;
188         else if (bw2<0) return FALSE;
189         else return bw1>=bw2;
190 }
191
192 static inline int get_video_bandwidth(int total, int audio){
193         if (total<=0) return 0;
194         return total-audio-10;
195 }
196
197 static inline void set_string(char **dest, const char *src){
198         if (*dest){
199                 ms_free(*dest);
200                 *dest=NULL;
201         }
202         if (src)
203                 *dest=ms_strdup(src);
204 }
205
206 #define PAYLOAD_TYPE_ENABLED    PAYLOAD_TYPE_USER_FLAG_0
207
208 SalPresenceStatus linphone_online_status_to_sal(LinphoneOnlineStatus os);
209 void linphone_process_authentication(LinphoneCore* lc, SalOp *op);
210 void linphone_authentication_ok(LinphoneCore *lc, SalOp *op);
211 void linphone_subscription_new(LinphoneCore *lc, SalOp *op, const char *from);
212 void linphone_notify_recv(LinphoneCore *lc, SalOp *op, SalSubscribeStatus ss, SalPresenceStatus status);
213 void linphone_proxy_config_process_authentication_failure(LinphoneCore *lc, SalOp *op);
214
215 void linphone_subscription_answered(LinphoneCore *lc, SalOp *op);
216 void linphone_subscription_closed(LinphoneCore *lc, SalOp *op);
217
218 MSList *linphone_find_friend(MSList *fl, const LinphoneAddress *fri, LinphoneFriend **lf);
219
220 void linphone_core_update_allocated_audio_bandwidth(LinphoneCore *lc);
221 void linphone_core_update_allocated_audio_bandwidth_in_call(LinphoneCall *call, const PayloadType *pt);
222 void linphone_core_run_stun_tests(LinphoneCore *lc, LinphoneCall *call);
223 int linphone_core_gather_ice_candidates(LinphoneCore *lc, LinphoneCall *call);
224
225 void linphone_core_send_initial_subscribes(LinphoneCore *lc);
226 void linphone_core_write_friends_config(LinphoneCore* lc);
227 void linphone_friend_write_to_config_file(struct _LpConfig *config, LinphoneFriend *lf, int index);
228 LinphoneFriend * linphone_friend_new_from_config_file(struct _LinphoneCore *lc, int index);
229
230 void linphone_proxy_config_update(LinphoneProxyConfig *cfg);
231 void linphone_proxy_config_get_contact(LinphoneProxyConfig *cfg, const char **ip, int *port);
232 LinphoneProxyConfig * linphone_core_lookup_known_proxy(LinphoneCore *lc, const LinphoneAddress *uri);
233 const char *linphone_core_find_best_identity(LinphoneCore *lc, const LinphoneAddress *to, const char **route);
234 int linphone_core_get_local_ip_for(int type, const char *dest, char *result);
235
236 LinphoneProxyConfig *linphone_proxy_config_new_from_config_file(struct _LpConfig *config, int index);
237 void linphone_proxy_config_write_to_config_file(struct _LpConfig* config,LinphoneProxyConfig *obj, int index);
238
239 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *cfg, const char *username, char *result, size_t result_len);
240
241 void linphone_core_text_received(LinphoneCore *lc, const char *from, const char *msg);
242
243 void linphone_core_play_tone(LinphoneCore *lc);
244
245 void linphone_call_init_stats(LinphoneCallStats *stats, int type);
246
247 void linphone_call_init_audio_stream(LinphoneCall *call);
248 void linphone_call_init_video_stream(LinphoneCall *call);
249 void linphone_call_init_media_streams(LinphoneCall *call);
250 void linphone_call_start_media_streams(LinphoneCall *call, bool_t all_inputs_muted, bool_t send_ringbacktone);
251 void linphone_call_start_media_streams_for_ice_gathering(LinphoneCall *call);
252 void linphone_call_stop_media_streams(LinphoneCall *call);
253 void linphone_call_delete_ice_session(LinphoneCall *call);
254
255 const char * linphone_core_get_identity(LinphoneCore *lc);
256 const char * linphone_core_get_route(LinphoneCore *lc);
257 void linphone_core_start_waiting(LinphoneCore *lc, const char *purpose);
258 void linphone_core_update_progress(LinphoneCore *lc, const char *purpose, float progresses);
259 void linphone_core_stop_waiting(LinphoneCore *lc);
260
261 int linphone_core_start_invite(LinphoneCore *lc, LinphoneCall *call, LinphoneProxyConfig *dest_proxy);
262 void linphone_core_start_refered_call(LinphoneCore *lc, LinphoneCall *call);
263 extern SalCallbacks linphone_sal_callbacks;
264 void linphone_proxy_config_set_error(LinphoneProxyConfig *cfg, LinphoneReason error);
265 bool_t linphone_core_rtcp_enabled(const LinphoneCore *lc);
266
267 LinphoneCall * is_a_linphone_call(void *user_pointer);
268 LinphoneProxyConfig * is_a_linphone_proxy_config(void *user_pointer);
269
270 static const int linphone_proxy_config_magic=0x7979;
271
272 struct _LinphoneProxyConfig
273 {
274         int magic;
275         struct _LinphoneCore *lc;
276         char *reg_proxy;
277         char *reg_identity;
278         char *reg_route;
279         char *realm;
280         int expires;
281         int reg_time;
282         SalOp *op;
283         char *type;
284         struct _SipSetupContext *ssctx;
285         int auth_failures;
286         char *dial_prefix;
287         LinphoneRegistrationState state;
288         SalOp *publish_op;
289         bool_t commit;
290         bool_t reg_sendregister;
291         bool_t publish;
292         bool_t dial_escape_plus;
293         void* user_data;
294         time_t deletion_date;
295         LinphoneReason error;
296 };
297
298 struct _LinphoneAuthInfo
299 {
300         char *username;
301         char *realm;
302         char *userid;
303         char *passwd;
304         char *ha1;
305         int usecount;
306         time_t last_use_time;
307         bool_t works;
308 };
309
310 struct _LinphoneChatRoom{
311         struct _LinphoneCore *lc;
312         char  *peer;
313         LinphoneAddress *peer_url;
314         SalOp *op;
315         void * user_data;
316 };
317
318 struct _LinphoneFriend{
319         LinphoneAddress *uri;
320         SalOp *insub;
321         SalOp *outsub;
322         LinphoneSubscribePolicy pol;
323         LinphoneOnlineStatus status;
324         struct _LinphoneCore *lc;
325         BuddyInfo *info;
326         char *refkey;
327         bool_t subscribe;
328         bool_t subscribe_active;
329         bool_t inc_subscribe_pending;
330         bool_t commit;
331 };
332
333
334 typedef struct sip_config
335 {
336         char *contact;
337         char *guessed_contact;
338         MSList *proxies;
339         MSList *deleted_proxies;
340         int inc_timeout;        /*timeout after an un-answered incoming call is rejected*/
341         unsigned int keepalive_period; /* interval in ms between keep alive messages sent to the proxy server*/
342         LCSipTransports transports;
343         bool_t use_info;
344         bool_t use_rfc2833;     /*force RFC2833 to be sent*/
345         bool_t guess_hostname;
346         bool_t loopback_only;
347         bool_t ipv6_enabled;
348         bool_t sdp_200_ack;
349         bool_t register_only_when_network_is_up;
350         bool_t ping_with_options;
351         bool_t auto_net_state_mon;
352 } sip_config_t;
353
354 typedef struct rtp_config
355 {
356         int audio_rtp_port;
357         int video_rtp_port;
358         int audio_jitt_comp;  /*jitter compensation*/
359         int video_jitt_comp;  /*jitter compensation*/
360         int nortp_timeout;
361         bool_t rtp_no_xmit_on_audio_mute;
362                               /* stop rtp xmit when audio muted */
363 }rtp_config_t;
364
365
366
367 typedef struct net_config
368 {
369         char *nat_address; /* may be IP or host name */
370         char *nat_address_ip; /* ip translated from nat_address */
371         char *stun_server;
372         char *relay;
373         int download_bw;
374         int upload_bw;
375         int firewall_policy;
376         int mtu;
377         int down_ptime;
378         bool_t nat_sdp_only;
379 }net_config_t;
380
381
382 typedef struct sound_config
383 {
384         struct _MSSndCard * ring_sndcard;       /* the playback sndcard currently used */
385         struct _MSSndCard * play_sndcard;       /* the playback sndcard currently used */
386         struct _MSSndCard * capt_sndcard; /* the capture sndcard currently used */
387         struct _MSSndCard * lsd_card; /* dummy playback card for Linphone Sound Daemon extension */
388         const char **cards;
389         int latency;    /* latency in samples of the current used sound device */
390         char rec_lev;
391         char play_lev;
392         char ring_lev;
393         char soft_play_lev;
394         char source;
395         char *local_ring;
396         char *remote_ring;
397         char *ringback_tone;
398         bool_t ec;
399         bool_t ea;
400         bool_t agc;
401 } sound_config_t;
402
403 typedef struct codecs_config
404 {
405         MSList *audio_codecs;  /* list of audio codecs in order of preference*/
406         MSList *video_codecs;   /* for later use*/
407 }codecs_config_t;
408
409 typedef struct video_config{
410         struct _MSWebCam *device;
411         const char **cams;
412         MSVideoSize vsize;
413         bool_t capture;
414         bool_t show_local;
415         bool_t display;
416         bool_t selfview; /*during calls*/
417         const char *displaytype;
418 }video_config_t;
419
420 typedef struct ui_config
421 {
422         int is_daemon;
423         int is_applet;
424         unsigned int timer_id;  /* the timer id for registration */
425 }ui_config_t;
426
427
428
429 typedef struct autoreplier_config
430 {
431         int enabled;
432         int after_seconds;              /* accept the call after x seconds*/
433         int max_users;                  /* maximum number of user that can call simultaneously */
434         int max_rec_time;       /* the max time of incoming voice recorded */
435         int max_rec_msg;                /* maximum number of recorded messages */
436         const char *message;            /* the path of the file to be played */
437 }autoreplier_config_t;
438
439 struct _LinphoneConference{
440         MSAudioConference *conf;
441         AudioStream *local_participant;
442         MSAudioEndpoint *local_endpoint;
443         RtpProfile *local_dummy_profile;
444         bool_t local_muted;
445 };
446
447 typedef struct _LinphoneConference LinphoneConference;
448
449 struct _LinphoneCore
450 {
451         LinphoneCoreVTable vtable;
452         Sal *sal;
453         LinphoneGlobalState state;
454         struct _LpConfig *config;
455         net_config_t net_conf;
456         sip_config_t sip_conf;
457         rtp_config_t rtp_conf;
458         sound_config_t sound_conf;
459         video_config_t video_conf;
460         codecs_config_t codecs_conf;
461         ui_config_t ui_conf;
462         autoreplier_config_t autoreplier_conf;
463         MSList *payload_types;
464         int dyn_pt;
465         LinphoneProxyConfig *default_proxy;
466         MSList *friends;
467         MSList *auth_info;
468         struct _RingStream *ringstream;
469         time_t dmfs_playing_start_time;
470         LCCallbackObj preview_finished_cb;
471         LinphoneCall *current_call;   /* the current call */
472         MSList *calls;                          /* all the processed calls */
473         MSList *queued_calls;   /* used by the autoreplier */
474         MSList *call_logs;
475         MSList *chatrooms;
476         int max_call_logs;
477         int missed_calls;
478         VideoPreview *previewstream;
479         struct _MSEventQueue *msevq;
480         LinphoneRtpTransportFactories *rtptf;
481         MSList *bl_reqs;
482         MSList *subscribers;    /* unknown subscribers */
483         int minutes_away;
484         LinphoneOnlineStatus presence_mode;
485         char *alt_contact;
486         void *data;
487         char *play_file;
488         char *rec_file;
489         time_t prevtime;
490         int audio_bw;
491         LinphoneWaitingCallback wait_cb;
492         void *wait_ctx;
493         unsigned long video_window_id;
494         unsigned long preview_window_id;
495         time_t netup_time; /*time when network went reachable */
496         struct _EcCalibrator *ecc;
497         MSList *hooks;
498         LinphoneConference conf_ctx;
499         char* zrtp_secrets_cache;
500         LinphoneVideoPolicy video_policy;
501         bool_t use_files;
502         bool_t apply_nat_settings;
503         bool_t initial_subscribes_sent;
504         bool_t bl_refresh;
505         
506         bool_t preview_finished;
507         bool_t auto_net_state_mon;
508         bool_t network_reachable;
509         bool_t use_preview_window;
510         
511         bool_t ringstream_autorelease;
512         bool_t pad[3];
513         int device_rotation;
514         int max_calls;
515         LinphoneTunnel *tunnel;
516 };
517
518 LinphoneTunnel *linphone_core_tunnel_new(LinphoneCore *lc);
519 void linphone_tunnel_destroy(LinphoneTunnel *tunnel);
520 void linphone_tunnel_configure(LinphoneTunnel *tunnel);
521 void linphone_tunnel_enable_logs_with_handler(LinphoneTunnel *tunnel, bool_t enabled, OrtpLogFunc logHandler);
522         
523 bool_t linphone_core_can_we_add_call(LinphoneCore *lc);
524 int linphone_core_add_call( LinphoneCore *lc, LinphoneCall *call);
525 int linphone_core_del_call( LinphoneCore *lc, LinphoneCall *call);
526 int linphone_core_set_as_current_call(LinphoneCore *lc, LinphoneCall *call);
527 int linphone_core_get_calls_nb(const LinphoneCore *lc);
528
529 void linphone_core_set_state(LinphoneCore *lc, LinphoneGlobalState gstate, const char *message);
530
531 SalMediaDescription *create_local_media_description(LinphoneCore *lc, LinphoneCall *call);
532 void update_local_media_description(LinphoneCore *lc, LinphoneCall *call);
533
534 void linphone_core_update_streams(LinphoneCore *lc, LinphoneCall *call, SalMediaDescription *new_md);
535
536 bool_t linphone_core_is_payload_type_usable_for_bandwidth(LinphoneCore *lc, PayloadType *pt,  int bandwidth_limit);
537
538 #define linphone_core_ready(lc) ((lc)->state!=LinphoneGlobalStartup)
539 void _linphone_core_configure_resolver();
540
541 struct _EcCalibrator{
542         ms_thread_t thread;
543         MSSndCard *play_card,*capt_card;
544         MSFilter *sndread,*det,*rec;
545         MSFilter *play, *gen, *sndwrite,*resampler;
546         MSTicker *ticker;
547         LinphoneEcCalibrationCallback cb;
548         void *cb_data;
549         int recv_count;
550         int sent_count;
551         int64_t acc;
552         int delay;
553         unsigned int rate;
554         LinphoneEcCalibratorStatus status;
555 };
556
557 typedef struct _EcCalibrator EcCalibrator;
558
559 LinphoneEcCalibratorStatus ec_calibrator_get_status(EcCalibrator *ecc);
560
561 void ec_calibrator_destroy(EcCalibrator *ecc);
562
563 void linphone_call_background_tasks(LinphoneCall *call, bool_t one_second_elapsed);
564 void linphone_core_preempt_sound_resources(LinphoneCore *lc);
565 /*conferencing subsystem*/
566 void _post_configure_audio_stream(AudioStream *st, LinphoneCore *lc, bool_t muted);
567 /* When a conference participant pause the conference he may send a music.
568  * We don't want to hear that music or to send it to the other participants.
569  * Use muted=yes to handle this case.
570  */
571 void linphone_call_add_to_conf(LinphoneCall *call, bool_t muted);
572 void linphone_call_remove_from_conf(LinphoneCall *call);
573 void linphone_core_conference_check_uninit(LinphoneCore *lc);
574 bool_t linphone_core_sound_resources_available(LinphoneCore *lc);
575 void linphone_core_notify_refer_state(LinphoneCore *lc, LinphoneCall *referer, LinphoneCall *newcall);
576
577 void __linphone_core_invalidate_registers(LinphoneCore* lc);
578 void _linphone_core_codec_config_write(LinphoneCore *lc);
579
580 #define HOLD_OFF        (0)
581 #define HOLD_ON         (1)
582
583 #ifndef NB_MAX_CALLS
584 #define NB_MAX_CALLS    (10)
585 #endif
586 void call_logs_write_to_config_file(LinphoneCore *lc);
587
588
589
590 #ifdef __cplusplus
591 }
592 #endif
593
594 #endif /* _PRIVATE_H */