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