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