]> sjero.net Git - linphone/blob - coreapi/private.h
sal in progress, near to code complete.
[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
28 #include "linphonecore.h"
29 #include "sal.h"
30
31 #ifdef HAVE_CONFIG_H
32 #include "config.h"
33 #endif
34
35 #ifndef LIBLINPHONE_VERSION 
36 #define LIBLINPHONE_VERSION LINPHONE_VERSION
37 #endif
38
39 #ifndef PACKAGE_SOUND_DIR 
40 #define PACKAGE_SOUND_DIR "."
41 #endif
42
43 #ifdef HAVE_GETTEXT
44 #include <libintl.h>
45 #ifndef _
46 #define _(String) gettext(String)
47 #endif
48 #else
49 #ifndef _
50 #define _(something)    (something)
51 #endif
52 #ifndef ngettext
53 #define ngettext(singular, plural, number)      (((number)==1)?(singular):(plural))
54 #endif
55 #endif
56
57 typedef enum _LCState{
58         LCStateInit,
59         LCStateRinging,
60         LCStateAVRunning
61 }LCState;
62
63
64 typedef struct _LinphoneCall
65 {
66         struct _LinphoneCore *core;
67         SalMediaDescription *localdesc;
68         SalMediaDescription *resultdesc;
69         LinphoneCallDir dir;
70         struct _RtpProfile *audio_profile;
71         struct _RtpProfile *video_profile;
72         struct _LinphoneCallLog *log;
73         SalOp *op;
74         char localip[LINPHONE_IPADDR_SIZE]; /* our best guess for local ipaddress for this call */
75         time_t start_time; /*time at which the call was initiated*/
76         time_t media_start_time; /*time at which it was accepted, media streams established*/
77         LCState state;
78 } LinphoneCall;
79
80 LinphoneCall * linphone_call_new_outgoing(struct _LinphoneCore *lc, LinphoneAddress *from, LinphoneAddress *to);
81 LinphoneCall * linphone_call_new_incoming(struct _LinphoneCore *lc, LinphoneAddress *from, LinphoneAddress *to, SalOp *op);
82 #define linphone_call_set_state(lcall,st)       (lcall)->state=(st)
83 void linphone_call_destroy(struct _LinphoneCall *obj);
84
85 /* private: */
86 LinphoneCallLog * linphone_call_log_new(LinphoneCall *call, LinphoneAddress *local, LinphoneAddress * remote);
87 void linphone_call_log_completed(LinphoneCallLog *calllog, LinphoneCall *call);
88 void linphone_call_log_destroy(LinphoneCallLog *cl);
89
90
91 void linphone_core_init_media_streams(LinphoneCore *lc, LinphoneCall *call);
92
93 void linphone_auth_info_write_config(struct _LpConfig *config, LinphoneAuthInfo *obj, int pos);
94
95 void linphone_core_update_proxy_register(LinphoneCore *lc);
96 void linphone_core_refresh_subscribes(LinphoneCore *lc);
97
98 int linphone_proxy_config_send_publish(LinphoneProxyConfig *cfg, LinphoneOnlineStatus os);
99
100 int linphone_online_status_to_eXosip(LinphoneOnlineStatus os);
101
102 void linphone_friend_notify(LinphoneFriend *lf, LinphoneOnlineStatus os);
103 LinphoneFriend *linphone_find_friend_by_inc_subscribe(MSList *l, SalOp *op);
104 LinphoneFriend *linphone_find_friend_by_out_subscribe(MSList *l, SalOp *op);
105
106
107 int set_lock_file();
108 int get_lock_file();
109 int remove_lock_file();
110 int do_registration(LinphoneCore *lc, bool_t doit);
111 void check_for_registration(LinphoneCore *lc);
112 void check_sound_device(LinphoneCore *lc);
113 void linphone_core_verify_codecs(LinphoneCore *lc);
114 void linphone_core_get_local_ip(LinphoneCore *lc, const char *to, char *result);
115 bool_t host_has_ipv6_network();
116 bool_t lp_spawn_command_line_sync(const char *command, char **result,int *command_ret);
117
118 static inline int get_min_bandwidth(int dbw, int ubw){
119         if (dbw<=0) return ubw;
120         if (ubw<=0) return dbw;
121         return MIN(dbw,ubw);
122 }
123
124 static inline bool_t bandwidth_is_greater(int bw1, int bw2){
125         if (bw1<0) return TRUE;
126         else if (bw2<0) return FALSE;
127         else return bw1>=bw2;
128 }
129
130 static inline void set_string(char **dest, const char *src){
131         if (*dest){
132                 ms_free(*dest);
133                 *dest=NULL;
134         }
135         if (src)
136                 *dest=ms_strdup(src);
137 }
138
139 #define PAYLOAD_TYPE_ENABLED    PAYLOAD_TYPE_USER_FLAG_0
140
141 SalPresenceStatus linphone_online_status_to_sal(LinphoneOnlineStatus os);
142 void linphone_process_authentication(LinphoneCore* lc, SalOp *op);
143 void linphone_authentication_ok(LinphoneCore *lc, SalOp *op);
144 void linphone_subscription_new(LinphoneCore *lc, SalOp *op, const char *from);
145 void linphone_notify_recv(LinphoneCore *lc, SalOp *op, SalSubscribeState ss, SalPresenceStatus status);
146 void linphone_proxy_config_process_authentication_failure(LinphoneCore *lc, SalOp *op);
147
148 void linphone_subscription_answered(LinphoneCore *lc, SalOp *op);
149 void linphone_subscription_closed(LinphoneCore *lc, SalOp *op);
150
151 MSList *linphone_find_friend(MSList *fl, const LinphoneAddress *fri, LinphoneFriend **lf);
152
153 void linphone_core_update_allocated_audio_bandwidth(LinphoneCore *lc);
154 void linphone_core_update_allocated_audio_bandwidth_in_call(LinphoneCore *lc, const PayloadType *pt);
155 void linphone_core_run_stun_tests(LinphoneCore *lc, LinphoneCall *call);
156
157 void linphone_core_write_friends_config(LinphoneCore* lc);
158 void linphone_friend_write_to_config_file(struct _LpConfig *config, LinphoneFriend *lf, int index);
159 LinphoneFriend * linphone_friend_new_from_config_file(struct _LinphoneCore *lc, int index);
160
161 void linphone_proxy_config_update(LinphoneProxyConfig *cfg);
162 void linphone_proxy_config_get_contact(LinphoneProxyConfig *cfg, const char **ip, int *port);
163 LinphoneProxyConfig * linphone_core_lookup_known_proxy(LinphoneCore *lc, const LinphoneAddress *uri);
164 int linphone_core_get_local_ip_for(const char *dest, char *result);
165
166 LinphoneProxyConfig *linphone_proxy_config_new_from_config_file(struct _LpConfig *config, int index);
167 void linphone_proxy_config_write_to_config_file(struct _LpConfig* config,LinphoneProxyConfig *obj, int index);
168
169 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *cfg, const char *username, char *result, size_t result_len);
170
171 void linphone_core_text_received(LinphoneCore *lc, const char *from, const char *msg);
172
173 void linphone_core_start_media_streams(LinphoneCore *lc, struct _LinphoneCall *call);
174 void linphone_core_stop_media_streams(LinphoneCore *lc, struct _LinphoneCall *call);
175 const char * linphone_core_get_identity(LinphoneCore *lc);
176 const char * linphone_core_get_route(LinphoneCore *lc);
177 bool_t linphone_core_interpret_url(LinphoneCore *lc, const char *url, LinphoneAddress **real_parsed_url, char **route);
178 void linphone_core_start_waiting(LinphoneCore *lc, const char *purpose);
179 void linphone_core_update_progress(LinphoneCore *lc, const char *purpose, float progresses);
180 void linphone_core_stop_waiting(LinphoneCore *lc);
181
182
183 extern SalCallbacks linphone_sal_callbacks;
184
185
186 struct _LinphoneProxyConfig
187 {
188         struct _LinphoneCore *lc;
189         char *reg_proxy;
190         char *reg_identity;
191         char *reg_route;
192         char *realm;
193         int expires;
194         int reg_time;
195         SalOp *op;
196         char *type;
197         struct _SipSetupContext *ssctx;
198         int auth_failures;
199         char *dial_prefix;
200         bool_t commit;
201         bool_t reg_sendregister;
202         bool_t registered;
203         bool_t publish;
204         bool_t dial_escape_plus;
205 };
206
207 struct _LinphoneAuthInfo 
208 {
209         char *username;
210         char *realm;
211         char *userid;
212         char *passwd;
213         char *ha1;
214         int usecount;
215         bool_t works;
216 };
217
218 struct _LinphoneChatRoom{
219         struct _LinphoneCore *lc;
220         char  *peer;
221         char *route;
222         LinphoneAddress *peer_url;
223         void * user_data;
224 };
225
226 struct _LinphoneFriend{
227         LinphoneAddress *uri;
228         SalOp *insub;
229         SalOp *outsub;
230         LinphoneSubscribePolicy pol;
231         LinphoneOnlineStatus status;
232         struct _LinphoneCore *lc;
233         BuddyInfo *info;
234         char *refkey;
235         bool_t subscribe;
236         bool_t inc_subscribe_pending;
237 };      
238
239 typedef struct sip_config
240 {
241         char *contact;
242         char *guessed_contact;
243         int sip_port;
244         MSList *proxies;
245         MSList *deleted_proxies;
246         int inc_timeout;        /*timeout after an un-answered incoming call is rejected*/
247         bool_t use_info;
248         bool_t use_rfc2833;     /*force RFC2833 to be sent*/
249         bool_t guess_hostname;
250         bool_t loopback_only;
251         bool_t ipv6_enabled;
252         bool_t sdp_200_ack;
253         bool_t only_one_codec; /*in SDP answers*/
254         bool_t register_only_when_network_is_up;
255 } sip_config_t;
256
257 typedef struct rtp_config
258 {
259         int audio_rtp_port;
260         int video_rtp_port;
261         int audio_jitt_comp;  /*jitter compensation*/
262         int video_jitt_comp;  /*jitter compensation*/
263         int nortp_timeout;
264 }rtp_config_t;
265
266
267
268 typedef struct net_config
269 {
270         char *nat_address;
271         char *stun_server;
272         char *relay;
273         int download_bw;
274         int upload_bw;
275         int firewall_policy;
276         int mtu;
277         bool_t nat_sdp_only;
278 }net_config_t;
279
280
281 typedef struct sound_config
282 {
283         struct _MSSndCard * ring_sndcard;       /* the playback sndcard currently used */
284         struct _MSSndCard * play_sndcard;       /* the playback sndcard currently used */
285         struct _MSSndCard * capt_sndcard; /* the capture sndcard currently used */
286         const char **cards;
287         int latency;    /* latency in samples of the current used sound device */
288         char rec_lev;
289         char play_lev;
290         char ring_lev;
291         char source;
292         char *local_ring;
293         char *remote_ring;
294         bool_t ec;
295         bool_t ea;
296         bool_t agc;
297 } sound_config_t;
298
299 typedef struct codecs_config
300 {
301         MSList *audio_codecs;  /* list of audio codecs in order of preference*/
302         MSList *video_codecs;   /* for later use*/
303 }codecs_config_t;
304
305 typedef struct video_config{
306         struct _MSWebCam *device;
307         const char **cams;
308         MSVideoSize vsize;
309         bool_t capture;
310         bool_t show_local;
311         bool_t display;
312         bool_t selfview; /*during calls*/
313 }video_config_t;
314
315 typedef struct ui_config
316 {
317         int is_daemon;
318         int is_applet;
319         unsigned int timer_id;  /* the timer id for registration */
320 }ui_config_t;
321
322
323
324 typedef struct autoreplier_config
325 {
326         int enabled;
327         int after_seconds;              /* accept the call after x seconds*/
328         int max_users;                  /* maximum number of user that can call simultaneously */
329         int max_rec_time;       /* the max time of incoming voice recorded */
330         int max_rec_msg;                /* maximum number of recorded messages */
331         const char *message;            /* the path of the file to be played */
332 }autoreplier_config_t;
333
334
335 struct _LinphoneCore
336 {
337         LinphoneCoreVTable vtable;
338         Sal *sal;
339         struct _LpConfig *config;
340         net_config_t net_conf;
341         sip_config_t sip_conf;
342         rtp_config_t rtp_conf;
343         sound_config_t sound_conf;
344         video_config_t video_conf;
345         codecs_config_t codecs_conf;
346         ui_config_t ui_conf;
347         autoreplier_config_t autoreplier_conf;
348         LinphoneProxyConfig *default_proxy;
349         MSList *friends;
350         MSList *auth_info;
351         struct _RingStream *ringstream;
352         LCCallbackObj preview_finished_cb;
353         struct _LinphoneCall *call;   /* the current call, in the future it will be a list of calls (conferencing)*/
354         MSList *queued_calls;   /* used by the autoreplier */
355         MSList *call_logs;
356         MSList *chatrooms;
357         int max_call_logs;
358         int missed_calls;
359         struct _AudioStream *audiostream;  /**/
360         struct _VideoStream *videostream;
361         struct _VideoStream *previewstream;
362         RtpTransport *a_rtp,*a_rtcp;
363         MSList *bl_reqs;
364         MSList *subscribers;    /* unknown subscribers */
365         int minutes_away;
366         LinphoneOnlineStatus presence_mode;
367         LinphoneOnlineStatus prev_mode;
368         char *alt_contact;
369         void *data;
370         char *play_file;
371         char *rec_file;
372         time_t prevtime;
373         int dw_audio_bw;
374         int up_audio_bw;
375         int dw_video_bw;
376         int up_video_bw;
377         int audio_bw;
378         gstate_t gstate_power;
379         gstate_t gstate_reg;
380         gstate_t gstate_call;
381         LinphoneWaitingCallback wait_cb;
382         void *wait_ctx;
383         bool_t use_files;
384         bool_t apply_nat_settings;
385         bool_t ready;
386         bool_t bl_refresh;
387         bool_t preview_finished;
388 };
389
390 #endif /* _PRIVATE_H */