]> sjero.net Git - linphone/blob - coreapi/linphonecore.h
Merge branch 'master' of git.linphone.org:linphone
[linphone] / coreapi / linphonecore.h
1 /*
2 linphone
3 Copyright (C) 2000 - 2010 Simon MORLAT (simon.morlat@linphone.org)
4
5 This program is free software; you can redistribute it and/or
6 modify it under the terms of the GNU General Public License
7 as published by the Free Software Foundation; either version 2
8 of the License, or (at your option) any later version.
9
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18 */
19 #ifndef LINPHONECORE_H
20 #define LINPHONECORE_H
21
22 #include "ortp/ortp.h"
23 #include "ortp/payloadtype.h"
24 #include "mediastreamer2/mscommon.h"
25 #include "mediastreamer2/msvideo.h"
26
27 #ifdef IN_LINPHONE
28 #include "sipsetup.h"
29 #else
30 #include "linphone/sipsetup.h"
31 #endif
32
33 #define LINPHONE_IPADDR_SIZE 64
34 #define LINPHONE_HOSTNAME_SIZE 128
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 struct _MSSndCard;
41 struct _LinphoneCore;
42 /**
43  * Linphone core main object created by function linphone_core_new() .
44  * @ingroup initializing
45  */
46 typedef struct _LinphoneCore LinphoneCore;
47 struct SalOp;
48
49 struct _LpConfig;
50
51
52 struct _LCSipTransports{
53         int udp_port;
54         int tcp_port;
55         int dtls_port;
56         int tls_port;
57 };
58
59 typedef struct _LCSipTransports LCSipTransports;
60
61 /**
62  * Object that represents a SIP address.
63  *
64  * The LinphoneAddress is an opaque object to represents SIP addresses, ie
65  * the content of SIP's 'from' and 'to' headers.
66  * A SIP address is made of display name, username, domain name, port, and various
67  * uri headers (such as tags). It looks like 'Alice <sip:alice@example.net>'.
68  * The LinphoneAddress has methods to extract and manipulate all parts of the address.
69  * When some part of the address (for example the username) is empty, the accessor methods
70  * return NULL.
71  *
72  * @ingroup linphone_address
73  * @var LinphoneAddress
74  */
75 typedef struct SalAddress LinphoneAddress;
76 #ifdef IN_LINPHONE
77 #include "linphonefriend.h"
78 #else
79 #include "linphone/linphonefriend.h"
80 #endif
81
82 LinphoneAddress * linphone_address_new(const char *uri);
83 LinphoneAddress * linphone_address_clone(const LinphoneAddress *uri);
84 const char *linphone_address_get_scheme(const LinphoneAddress *u);
85 const char *linphone_address_get_display_name(const LinphoneAddress* u);
86 const char *linphone_address_get_username(const LinphoneAddress *u);
87 const char *linphone_address_get_domain(const LinphoneAddress *u);
88 /**
89  * Get port number as an integer value.
90  *
91  */
92 int linphone_address_get_port_int(const LinphoneAddress *u);
93 /**
94  * Get port number, null if not present.
95  */
96 const char* linphone_address_get_port(const LinphoneAddress *u);
97 void linphone_address_set_display_name(LinphoneAddress *u, const char *display_name);
98 void linphone_address_set_username(LinphoneAddress *uri, const char *username);
99 void linphone_address_set_domain(LinphoneAddress *uri, const char *host);
100 void linphone_address_set_port(LinphoneAddress *uri, const char *port);
101 void linphone_address_set_port_int(LinphoneAddress *uri, int port);
102 /*remove tags, params etc... so that it is displayable to the user*/
103 void linphone_address_clean(LinphoneAddress *uri);
104 char *linphone_address_as_string(const LinphoneAddress *u);
105 char *linphone_address_as_string_uri_only(const LinphoneAddress *u);
106 bool_t linphone_address_weak_equal(const LinphoneAddress *a1, const LinphoneAddress *a2);
107 void linphone_address_destroy(LinphoneAddress *u);
108
109 struct _SipSetupContext;
110
111
112 /**
113  * Enum representing the direction of a call.
114  * @ingroup call_logs
115 **/
116 enum _LinphoneCallDir {
117         LinphoneCallOutgoing, /**< outgoing calls*/
118         LinphoneCallIncoming  /**< incoming calls*/
119 };
120
121 /**
122  * Typedef for enum
123  * @ingroup call_logs
124 **/
125 typedef enum _LinphoneCallDir LinphoneCallDir;
126
127 /**
128  * Enum representing the status of a call
129  * @ingroup call_logs
130 **/
131 typedef enum _LinphoneCallStatus {
132         LinphoneCallSuccess, /**< The call was sucessful*/
133         LinphoneCallAborted, /**< The call was aborted */
134         LinphoneCallMissed, /**< The call was missed (unanswered)*/
135         LinphoneCallDeclined /**< The call was declined, either locally or by remote end*/
136 } LinphoneCallStatus;
137
138 /**
139  * Structure representing a call log.
140  *
141  * @ingroup call_logs
142  *
143 **/
144 typedef struct _LinphoneCallLog{
145         LinphoneCallDir dir; /**< The direction of the call*/
146         LinphoneCallStatus status; /**< The status of the call*/
147         LinphoneAddress *from; /**<Originator of the call as a LinphoneAddress object*/
148         LinphoneAddress *to; /**<Destination of the call as a LinphoneAddress object*/
149         char start_date[128]; /**<Human readable string containing the start date*/
150         int duration; /**<Duration of the call in seconds*/
151         char *refkey;
152         void *user_pointer;
153         rtp_stats_t local_stats;
154         rtp_stats_t remote_stats;
155         float quality;
156     int video_enabled;
157         struct _LinphoneCore *lc;
158         time_t start_date_time; /**Start date of the call in seconds as expressed in a time_t */
159         const char* call_id; /**unique id of a call*/
160 } LinphoneCallLog;
161
162
163 /**
164  * Enum describing type of media encryption types.
165 **/
166 enum LinphoneMediaEncryption {
167         LinphoneMediaEncryptionNone,
168         LinphoneMediaEncryptionSRTP,
169         LinphoneMediaEncryptionZRTP
170 };
171
172 /**
173  * Enum describing type of media encryption types.
174 **/
175 typedef enum LinphoneMediaEncryption LinphoneMediaEncryption;
176
177 /*public: */
178 void linphone_call_log_set_user_pointer(LinphoneCallLog *cl, void *up);
179 void *linphone_call_log_get_user_pointer(const LinphoneCallLog *cl);
180 void linphone_call_log_set_ref_key(LinphoneCallLog *cl, const char *refkey);
181 const char *linphone_call_log_get_ref_key(const LinphoneCallLog *cl);
182 const rtp_stats_t *linphone_call_log_get_local_stats(const LinphoneCallLog *cl);
183 const rtp_stats_t *linphone_call_log_get_remote_stats(const LinphoneCallLog *cl);
184 char * linphone_call_log_to_str(LinphoneCallLog *cl);
185
186 struct _LinphoneCallParams;
187
188 /**
189  * The LinphoneCallParams is an object containing various call related parameters.
190  * It can be used to retrieve parameters from a currently running call or modify the call's characteristics
191  * dynamically.
192 **/
193 typedef struct _LinphoneCallParams LinphoneCallParams;
194
195 const PayloadType* linphone_call_params_get_used_audio_codec(const LinphoneCallParams *cp);
196 const PayloadType* linphone_call_params_get_used_video_codec(const LinphoneCallParams *cp);
197 LinphoneCallParams * linphone_call_params_copy(const LinphoneCallParams *cp);
198 void linphone_call_params_enable_video(LinphoneCallParams *cp, bool_t enabled);
199 bool_t linphone_call_params_video_enabled(const LinphoneCallParams *cp);
200 LinphoneMediaEncryption linphone_call_params_get_media_encryption(const LinphoneCallParams *cp);
201 void linphone_call_params_set_media_encryption(LinphoneCallParams *cp, LinphoneMediaEncryption e);
202 void linphone_call_params_enable_early_media_sending(LinphoneCallParams *cp, bool_t enabled);
203 bool_t linphone_call_params_early_media_sending_enabled(const LinphoneCallParams *cp);
204 bool_t linphone_call_params_local_conference_mode(const LinphoneCallParams *cp);
205 void linphone_call_params_set_audio_bandwidth_limit(LinphoneCallParams *cp, int bw);
206 void linphone_call_params_destroy(LinphoneCallParams *cp);
207 /**
208  * @ingroup call_control
209  * Use to know if this call has been configured in low bandwidth mode.
210  * This mode can be automatically discovered thanks to a stun server when activate_edge_workarounds=1 in section [net] of configuration file
211  * <br> When enabled, this param may transform a call request with video in audio only mode.
212  * @return TRUE if low bandwidth has been configured/detected
213  */
214 bool_t linphone_call_params_low_bandwidth_enabled(const LinphoneCallParams *cp);
215 /**
216  * Enum describing failure reasons.
217  * @ingroup initializing
218 **/
219 enum _LinphoneReason{
220         LinphoneReasonNone,
221         LinphoneReasonNoResponse, /**<No response received from remote*/
222         LinphoneReasonBadCredentials, /**<Authentication failed due to bad or missing credentials*/
223         LinphoneReasonDeclined, /**<The call has been declined*/
224         LinphoneReasonNotFound, /**<Destination of the calls was not found.*/
225         LinphoneReasonNotAnswered, /**<The call was not answered in time*/
226         LinphoneReasonBusy /**<Phone line was busy */
227 };
228
229 /**
230  * Enum describing failure reasons.
231  * @ingroup initializing
232 **/
233 typedef enum _LinphoneReason LinphoneReason;
234
235 const char *linphone_reason_to_string(LinphoneReason err);
236
237 /**
238  * Structure describing policy regarding video streams establishments.
239  * @ingroup media_parameters
240 **/
241 struct _LinphoneVideoPolicy{
242         bool_t automatically_initiate; /**<Whether video shall be automatically proposed for outgoing calls.*/ 
243         bool_t automatically_accept; /**<Whether video shall be automatically accepted for incoming calls*/
244         bool_t unused[2];
245 };
246
247 /**
248  * Structure describing policy regarding video streams establishments.
249  * @ingroup media_parameters
250 **/
251 typedef struct _LinphoneVideoPolicy LinphoneVideoPolicy;
252
253 /**
254  * The LinphoneCall object represents a call issued or received by the LinphoneCore
255  * @ingroup call_control
256 **/
257 struct _LinphoneCall;
258 /**
259  * The LinphoneCall object represents a call issued or received by the LinphoneCore
260  * @ingroup call_control
261 **/
262 typedef struct _LinphoneCall LinphoneCall;
263
264
265 /**
266  * @addtogroup call_misc
267  * @{
268 **/
269
270 #define LINPHONE_CALL_STATS_AUDIO 0
271 #define LINPHONE_CALL_STATS_VIDEO 1
272
273 /**
274  * Enum describing ICE states.
275  * @ingroup initializing
276 **/
277 enum _LinphoneIceState{
278         LinphoneIceStateNotActivated, /**< ICE has not been activated for this call */
279         LinphoneIceStateFailed, /**< ICE processing has failed */
280         LinphoneIceStateInProgress, /**< ICE process is in progress */
281         LinphoneIceStateHostConnection, /**< ICE has established a direct connection to the remote host */
282         LinphoneIceStateReflexiveConnection, /**< ICE has established a connection to the remote host through one or several NATs */
283         LinphoneIceStateRelayConnection /**< ICE has established a connection through a relay */
284 };
285
286 /**
287  * Enum describing Ice states.
288  * @ingroup initializing
289 **/
290 typedef enum _LinphoneIceState LinphoneIceState;
291
292 /**
293  * The LinphoneCallStats objects carries various statistic informations regarding quality of audio or video streams.
294  *
295  * To receive these informations periodically and as soon as they are computed, the application is invited to place a #CallStatsUpdated callback in the LinphoneCoreVTable structure
296  * it passes for instanciating the LinphoneCore object (see linphone_core_new() ).
297  *
298  * At any time, the application can access last computed statistics using linphone_call_get_audio_stats() or linphone_call_get_video_stats().
299 **/
300 typedef struct _LinphoneCallStats LinphoneCallStats;
301
302 /**
303  * The LinphoneCallStats objects carries various statistic informations regarding quality of audio or video streams.
304  *
305  * To receive these informations periodically and as soon as they are computed, the application is invited to place a #CallStatsUpdated callback in the LinphoneCoreVTable structure
306  * it passes for instanciating the LinphoneCore object (see linphone_core_new() ).
307  *
308  * At any time, the application can access last computed statistics using linphone_call_get_audio_stats() or linphone_call_get_video_stats().
309 **/
310 struct _LinphoneCallStats {
311         int             type; /**< Can be either LINPHONE_CALL_STATS_AUDIO or LINPHONE_CALL_STATS_VIDEO*/
312         jitter_stats_t  jitter_stats; /**<jitter buffer statistics, see oRTP documentation for details */
313         mblk_t*         received_rtcp; /**<Last RTCP packet received, as a mblk_t structure. See oRTP documentation for details how to extract information from it*/
314         mblk_t*         sent_rtcp;/**<Last RTCP packet sent, as a mblk_t structure. See oRTP documentation for details how to extract information from it*/
315         float           round_trip_delay; /**<Round trip propagation time in seconds if known, -1 if unknown.*/
316         LinphoneIceState        ice_state; /**< State of ICE processing. */
317         float download_bandwidth; /**<Download bandwidth measurement of received stream, expressed in kbit/s, including IP/UDP/RTP headers*/
318         float upload_bandwidth; /**<Download bandwidth measurement of sent stream, expressed in kbit/s, including IP/UDP/RTP headers*/
319 };
320
321 /**
322  * @}
323 **/
324
325 const LinphoneCallStats *linphone_call_get_audio_stats(const LinphoneCall *call);
326 const LinphoneCallStats *linphone_call_get_video_stats(const LinphoneCall *call);
327
328
329 /** Callback prototype */
330 typedef void (*LinphoneCallCbFunc)(struct _LinphoneCall *call,void * user_data);
331
332 /**
333  * LinphoneCallState enum represents the different state a call can reach into.
334  * The application is notified of state changes through the LinphoneCoreVTable::call_state_changed callback.
335  * @ingroup call_control
336 **/
337 typedef enum _LinphoneCallState{
338         LinphoneCallIdle,                                       /**<Initial call state */
339         LinphoneCallIncomingReceived, /**<This is a new incoming call */
340         LinphoneCallOutgoingInit, /**<An outgoing call is started */
341         LinphoneCallOutgoingProgress, /**<An outgoing call is in progress */
342         LinphoneCallOutgoingRinging, /**<An outgoing call is ringing at remote end */
343         LinphoneCallOutgoingEarlyMedia, /**<An outgoing call is proposed early media */
344         LinphoneCallConnected, /**<Connected, the call is answered */
345         LinphoneCallStreamsRunning, /**<The media streams are established and running*/
346         LinphoneCallPausing, /**<The call is pausing at the initiative of local end */
347         LinphoneCallPaused, /**< The call is paused, remote end has accepted the pause */
348         LinphoneCallResuming, /**<The call is being resumed by local end*/
349         LinphoneCallRefered, /**<The call is being transfered to another party, resulting in a new outgoing call to follow immediately*/
350         LinphoneCallError, /**<The call encountered an error*/
351         LinphoneCallEnd, /**<The call ended normally*/
352         LinphoneCallPausedByRemote, /**<The call is paused by remote end*/
353         LinphoneCallUpdatedByRemote, /**<The call's parameters change is requested by remote end, used for example when video is added by remote */
354         LinphoneCallIncomingEarlyMedia, /**<We are proposing early media to an incoming call */
355         LinphoneCallUpdating, /**<A call update has been initiated by us */
356         LinphoneCallReleased /**< The call object is no more retained by the core */
357 } LinphoneCallState;
358
359 const char *linphone_call_state_to_string(LinphoneCallState cs);
360
361 LinphoneCore *linphone_call_get_core(const LinphoneCall *call);
362 LinphoneCallState linphone_call_get_state(const LinphoneCall *call);
363 bool_t linphone_call_asked_to_autoanswer(LinphoneCall *call);
364 const LinphoneAddress * linphone_core_get_current_call_remote_address(struct _LinphoneCore *lc);
365 const LinphoneAddress * linphone_call_get_remote_address(const LinphoneCall *call);
366 char *linphone_call_get_remote_address_as_string(const LinphoneCall *call);
367 LinphoneCallDir linphone_call_get_dir(const LinphoneCall *call);
368 LinphoneCall * linphone_call_ref(LinphoneCall *call);
369 void linphone_call_unref(LinphoneCall *call);
370 LinphoneCallLog *linphone_call_get_call_log(const LinphoneCall *call);
371 const char *linphone_call_get_refer_to(const LinphoneCall *call);
372 bool_t linphone_call_has_transfer_pending(const LinphoneCall *call);
373 LinphoneCall *linphone_call_get_replaced_call(LinphoneCall *call);
374 int linphone_call_get_duration(const LinphoneCall *call);
375 const LinphoneCallParams * linphone_call_get_current_params(const LinphoneCall *call);
376 const LinphoneCallParams * linphone_call_get_remote_params(LinphoneCall *call);
377 void linphone_call_enable_camera(LinphoneCall *lc, bool_t enabled);
378 bool_t linphone_call_camera_enabled(const LinphoneCall *lc);
379 int linphone_call_take_video_snapshot(LinphoneCall *call, const char *file);
380 LinphoneReason linphone_call_get_reason(const LinphoneCall *call);
381 const char *linphone_call_get_remote_user_agent(LinphoneCall *call);
382 float linphone_call_get_play_volume(LinphoneCall *call);
383 float linphone_call_get_record_volume(LinphoneCall *call);
384 float linphone_call_get_current_quality(LinphoneCall *call);
385 float linphone_call_get_average_quality(LinphoneCall *call);
386 const char* linphone_call_get_authentication_token(LinphoneCall *call);
387 bool_t linphone_call_get_authentication_token_verified(LinphoneCall *call);
388 void linphone_call_set_authentication_token_verified(LinphoneCall *call, bool_t verified);
389 void linphone_call_send_vfu_request(LinphoneCall *call);
390 void *linphone_call_get_user_pointer(LinphoneCall *call);
391 void linphone_call_set_user_pointer(LinphoneCall *call, void *user_pointer);
392 void linphone_call_set_next_video_frame_decoded_callback(LinphoneCall *call, LinphoneCallCbFunc cb, void* user_data);
393 LinphoneCallState linphone_call_get_transfer_state(LinphoneCall *call);
394 void linphone_call_zoom_video(LinphoneCall* call, float zoom_factor, float* cx, float* cy);
395 /**
396  * Return TRUE if this call is currently part of a conference
397  *@param call #LinphoneCall
398  *@return TRUE if part of a conference.
399  *
400  @ingroup call_control
401  */
402 bool_t linphone_call_is_in_conference(const LinphoneCall *call);
403 /**
404  * Enables or disable echo cancellation for this call
405  * @param call
406  * @param val
407  *
408  * @ingroup media_parameters
409 **/
410 void linphone_call_enable_echo_cancellation(LinphoneCall *call, bool_t val) ;
411 /**
412  * Returns TRUE if echo cancellation is enabled.
413  *
414  * @ingroup media_parameters
415 **/
416 bool_t linphone_call_echo_cancellation_enabled(LinphoneCall *lc);
417 /**
418  * Enables or disable echo limiter for this call
419  * @param call
420  * @param val
421  *
422  * @ingroup media_parameters
423 **/
424 void linphone_call_enable_echo_limiter(LinphoneCall *call, bool_t val);
425 /**
426  * Returns TRUE if echo limiter is enabled.
427  *
428  * @ingroup media_parameters
429 **/
430 bool_t linphone_call_echo_limiter_enabled(const LinphoneCall *call);
431
432 /*keep this in sync with mediastreamer2/msvolume.h*/
433
434 /**
435  * Lowest volume measurement that can be returned by linphone_call_get_play_volume() or linphone_call_get_record_volume(), corresponding to pure silence.
436  * @ingroup call_misc
437 **/
438 #define LINPHONE_VOLUME_DB_LOWEST (-120)
439
440 /**
441  * @addtogroup proxies
442  * @{
443 **/
444 /**
445  * The LinphoneProxyConfig object represents a proxy configuration to be used
446  * by the LinphoneCore object.
447  * Its fields must not be used directly in favour of the accessors methods.
448  * Once created and filled properly the LinphoneProxyConfig can be given to
449  * LinphoneCore with linphone_core_add_proxy_config().
450  * This will automatically triggers the registration, if enabled.
451  *
452  * The proxy configuration are persistent to restarts because they are saved
453  * in the configuration file. As a consequence, after linphone_core_new() there
454  * might already be a list of configured proxy that can be examined with
455  * linphone_core_get_proxy_config_list().
456  *
457  * The default proxy (see linphone_core_set_default_proxy() ) is the one of the list
458  * that is used by default for calls.
459 **/
460 typedef struct _LinphoneProxyConfig LinphoneProxyConfig;
461
462 /**
463  * LinphoneRegistrationState describes proxy registration states.
464 **/
465 typedef enum _LinphoneRegistrationState{
466         LinphoneRegistrationNone, /**<Initial state for registrations */
467         LinphoneRegistrationProgress, /**<Registration is in progress */
468         LinphoneRegistrationOk, /**< Registration is successful */
469         LinphoneRegistrationCleared, /**< Unregistration succeeded */
470         LinphoneRegistrationFailed      /**<Registration failed */
471 }LinphoneRegistrationState;
472
473 /**
474  * Human readable version of the #LinphoneRegistrationState
475  * @param cs sate
476  */
477 const char *linphone_registration_state_to_string(LinphoneRegistrationState cs);
478
479 LinphoneProxyConfig *linphone_proxy_config_new(void);
480 int linphone_proxy_config_set_server_addr(LinphoneProxyConfig *obj, const char *server_addr);
481 int linphone_proxy_config_set_identity(LinphoneProxyConfig *obj, const char *identity);
482 int linphone_proxy_config_set_route(LinphoneProxyConfig *obj, const char *route);
483 void linphone_proxy_config_expires(LinphoneProxyConfig *obj, int expires);
484 /**
485  * Indicates  either or not, REGISTRATION must be issued for this #LinphoneProxyConfig .
486  * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
487  * @param obj object pointer
488  * @param val if true, registration will be engaged
489  */
490 void linphone_proxy_config_enable_register(LinphoneProxyConfig *obj, bool_t val);
491 #define linphone_proxy_config_enableregister linphone_proxy_config_enable_register
492 void linphone_proxy_config_edit(LinphoneProxyConfig *obj);
493 int linphone_proxy_config_done(LinphoneProxyConfig *obj);
494 /**
495  * Indicates  either or not, PUBLISH must be issued for this #LinphoneProxyConfig .
496  * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
497  * @param obj object pointer
498  * @param val if true, publish will be engaged
499  *
500  */
501 void linphone_proxy_config_enable_publish(LinphoneProxyConfig *obj, bool_t val);
502 void linphone_proxy_config_set_dial_escape_plus(LinphoneProxyConfig *cfg, bool_t val);
503 void linphone_proxy_config_set_dial_prefix(LinphoneProxyConfig *cfg, const char *prefix);
504
505 LinphoneRegistrationState linphone_proxy_config_get_state(const LinphoneProxyConfig *obj);
506 bool_t linphone_proxy_config_is_registered(const LinphoneProxyConfig *obj);
507 const char *linphone_proxy_config_get_domain(const LinphoneProxyConfig *cfg);
508
509 const char *linphone_proxy_config_get_route(const LinphoneProxyConfig *obj);
510 const char *linphone_proxy_config_get_identity(const LinphoneProxyConfig *obj);
511 bool_t linphone_proxy_config_publish_enabled(const LinphoneProxyConfig *obj);
512 const char *linphone_proxy_config_get_addr(const LinphoneProxyConfig *obj);
513 int linphone_proxy_config_get_expires(const LinphoneProxyConfig *obj);
514 bool_t linphone_proxy_config_register_enabled(const LinphoneProxyConfig *obj);
515 void linphone_proxy_config_refresh_register(LinphoneProxyConfig *obj);
516 const char *linphone_proxy_config_get_contact_parameters(const LinphoneProxyConfig *obj);
517 void linphone_proxy_config_set_contact_parameters(LinphoneProxyConfig *obj, const char *contact_params);
518 struct _LinphoneCore * linphone_proxy_config_get_core(const LinphoneProxyConfig *obj);
519
520 bool_t linphone_proxy_config_get_dial_escape_plus(const LinphoneProxyConfig *cfg);
521 const char * linphone_proxy_config_get_dial_prefix(const LinphoneProxyConfig *cfg);
522
523 LinphoneReason linphone_proxy_config_get_error(const LinphoneProxyConfig *cfg);
524
525 /* destruction is called automatically when removing the proxy config */
526 void linphone_proxy_config_destroy(LinphoneProxyConfig *cfg);
527 void linphone_proxy_config_set_sip_setup(LinphoneProxyConfig *cfg, const char *type);
528 SipSetupContext *linphone_proxy_config_get_sip_setup_context(LinphoneProxyConfig *cfg);
529 SipSetup *linphone_proxy_config_get_sip_setup(LinphoneProxyConfig *cfg);
530 /**
531  * normalize a human readable phone number into a basic string. 888-444-222 becomes 888444222
532  */
533 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *proxy, const char *username, char *result, size_t result_len);
534 /*
535  *  attached a user data to a proxy config
536  */
537 void linphone_proxy_config_set_user_data(LinphoneProxyConfig *cr, void * ud);
538 /*
539  *  get user data to a proxy config. return null if any
540  */
541 void * linphone_proxy_config_get_user_data(LinphoneProxyConfig *cr);
542
543 /**
544  * @}
545 **/
546
547 typedef struct _LinphoneAccountCreator{
548         struct _LinphoneCore *lc;
549         struct _SipSetupContext *ssctx;
550         char *username;
551         char *password;
552         char *domain;
553         char *route;
554         char *email;
555         int suscribe;
556         bool_t succeeded;
557 }LinphoneAccountCreator;
558
559 LinphoneAccountCreator *linphone_account_creator_new(struct _LinphoneCore *core, const char *type);
560 void linphone_account_creator_set_username(LinphoneAccountCreator *obj, const char *username);
561 void linphone_account_creator_set_password(LinphoneAccountCreator *obj, const char *password);
562 void linphone_account_creator_set_domain(LinphoneAccountCreator *obj, const char *domain);
563 void linphone_account_creator_set_route(LinphoneAccountCreator *obj, const char *route);
564 void linphone_account_creator_set_email(LinphoneAccountCreator *obj, const char *email);
565 void linphone_account_creator_set_suscribe(LinphoneAccountCreator *obj, int suscribre);
566 const char * linphone_account_creator_get_username(LinphoneAccountCreator *obj);
567 const char * linphone_account_creator_get_domain(LinphoneAccountCreator *obj);
568 int linphone_account_creator_test_existence(LinphoneAccountCreator *obj);
569 int linphone_account_creator_test_validation(LinphoneAccountCreator *obj);
570 LinphoneProxyConfig * linphone_account_creator_validate(LinphoneAccountCreator *obj);
571 void linphone_account_creator_destroy(LinphoneAccountCreator *obj);
572
573 struct _LinphoneAuthInfo;
574
575 /**
576  * @ingroup authentication
577  * Object holding authentication information.
578  *
579  * @note The object's fields should not be accessed directly. Prefer using
580  * the accessor methods.
581  *
582  * In most case, authentication information consists of a username and password.
583  * Sometimes, a userid is required by proxy, and realm can be useful to discriminate
584  * different SIP domains.
585  *
586  * Once created and filled, a LinphoneAuthInfo must be added to the LinphoneCore in
587  * order to become known and used automatically when needed.
588  * Use linphone_core_add_auth_info() for that purpose.
589  *
590  * The LinphoneCore object can take the initiative to request authentication information
591  * when needed to the application through the auth_info_requested callback of the
592  * LinphoneCoreVTable structure.
593  *
594  * The application can respond to this information request later using
595  * linphone_core_add_auth_info(). This will unblock all pending authentication
596  * transactions and retry them with authentication headers.
597  *
598 **/
599 typedef struct _LinphoneAuthInfo LinphoneAuthInfo;
600
601 LinphoneAuthInfo *linphone_auth_info_new(const char *username, const char *userid,
602                 const char *passwd, const char *ha1,const char *realm);
603 void linphone_auth_info_set_passwd(LinphoneAuthInfo *info, const char *passwd);
604 void linphone_auth_info_set_username(LinphoneAuthInfo *info, const char *username);
605 void linphone_auth_info_set_userid(LinphoneAuthInfo *info, const char *userid);
606
607 const char *linphone_auth_info_get_username(const LinphoneAuthInfo *i);
608 const char *linphone_auth_info_get_passwd(const LinphoneAuthInfo *i);
609 const char *linphone_auth_info_get_userid(const LinphoneAuthInfo *i);
610
611 /* you don't need those function*/
612 void linphone_auth_info_destroy(LinphoneAuthInfo *info);
613 LinphoneAuthInfo * linphone_auth_info_new_from_config_file(struct _LpConfig *config, int pos);
614
615
616 struct _LinphoneChatRoom;
617 /**
618  * @addtogroup chatroom
619  * @{
620  */
621
622 /**
623  * A chat room message to old content to be sent.
624  * <br> Can be created by linphone_chat_room_create_message().
625  */
626 typedef struct _LinphoneChatMessage LinphoneChatMessage;
627         
628 /**
629  * A chat room is the place where text messages are exchanged.
630  * <br> Can be created by linphone_core_create_chat_room().
631  */
632 typedef struct _LinphoneChatRoom LinphoneChatRoom;
633
634 /**
635  * Create a new chat room for messaging from a sip uri like sip:joe@sip.linphone.org
636  * @param lc #LinphoneCore object
637  * @param to destination address for messages
638  * @return #LinphoneChatRoom where messaging can take place.
639  */
640 LinphoneChatRoom * linphone_core_create_chat_room(LinphoneCore *lc, const char *to);
641 /**
642  * Destructor
643  * @param cr #LinphoneChatRoom object
644  */
645 void linphone_chat_room_destroy(LinphoneChatRoom *cr);
646
647 /**
648  * create a message attached to a dedicated chat room;
649  */
650 LinphoneChatMessage* linphone_chat_room_create_message(const LinphoneChatRoom *cr,const char* message);
651
652
653 /**
654  * get peer address \link linphone_core_create_chat_room() associated to \endlink this #LinphoneChatRoom
655  * @param cr #LinphoneChatRoom object
656  * @return #LinphoneAddress peer address
657  */
658 const LinphoneAddress* linphone_chat_room_get_peer_address(LinphoneChatRoom *cr);
659 /**
660  * send a message to peer member of this chat room.
661  * @param cr #LinphoneChatRoom object
662  * @param msg message to be sent
663  */
664 void linphone_chat_room_send_message(LinphoneChatRoom *cr, const char *msg);
665 /**
666  *LinphoneChatMessageStatus used to notify if message has been succesfully delivered or not
667  */
668 typedef enum _LinphoneChatMessageStates {
669         LinphoneChatMessageStateIdle, /** initial state*/
670         LinphoneChatMessageStateInProgress, /*delivery in progress**/
671         LinphoneChatMessageStateDelivered, /** message succesffully delivered an acknoleged by remote end point*/
672         LinphoneChatMessageStateNotDelivered /** message was not delivered*/
673 }LinphoneChatMessageState;
674
675         
676 /**
677  * to string function
678  */
679 const char* linphone_chat_message_state_to_string(const LinphoneChatMessageState state);
680
681 /**
682  * clone a chat message 
683  *@param message #LinphoneChatMessage obj
684  *@return #LinphoneChatMessage
685  */
686 LinphoneChatMessage* linphone_chat_message_clone(const LinphoneChatMessage* message);
687 /**
688  * set origine of the message
689  *@param message #LinphoneChatMessage obj
690  *@param from #LinphoneAddress origin of this message (copied)
691  */
692 void linphone_chat_message_set_from(LinphoneChatMessage* message, const LinphoneAddress* from);
693
694 /**
695  * get origine of the message 
696  *@param message #LinphoneChatMessage obj
697  *@return #LinphoneAddress
698  */
699 LinphoneAddress* linphone_chat_message_get_from(const LinphoneChatMessage* message);
700         
701 /**
702  * Linphone message can carry external body as defined by rfc2017
703  * @param message #LinphoneChatMessage
704  * @return return external body url null if not present.
705  */
706 const char* linphone_chat_message_get_external_body_url(const LinphoneChatMessage* message);
707         
708 /**
709  * Linphone message can carry external body as defined by rfc2017
710  * 
711  * @param  #LinphoneChatMessage  
712  * @param url ex: access-type=URL; URL="http://www.foo.com/file"
713  */
714 void linphone_chat_message_set_external_body_url(LinphoneChatMessage* message,const char* url);
715
716 /**
717  * get text part of this message
718  *@return text or NULL if no text.
719  */
720 const char * linphone_chat_message_get_text(const LinphoneChatMessage* message);        
721 /**
722  * user pointer get function
723  */
724
725 void* linphone_chat_message_get_user_data(const LinphoneChatMessage* message);
726 /**
727  * user pointer set function
728  */
729 void linphone_chat_message_set_user_data(LinphoneChatMessage* message,void*);
730         
731 /**
732  * Call back used to notify message delivery status
733  *@param msg #LinphoneChatMessage object
734  *@param status #LinphoneChatMessageStatus
735  *@param ud us user data
736  */
737 typedef void (*LinphoneChatMessageStateChangeCb)(LinphoneChatMessage* msg,LinphoneChatMessageState state,void* ud);
738 /**
739  * send a message to peer member of this chat room.
740  * @param cr #LinphoneChatRoom object
741  * @param msg #LinphoneChatMessage message to be sent
742  * @param status_cb #LinphoneChatMessageStatus status call back invoked when to message is delivered or not. May be NULL
743  * @param ud user data for the status cb.
744  */
745 void linphone_chat_room_send_message2(LinphoneChatRoom *cr, LinphoneChatMessage* msg,LinphoneChatMessageStateChangeCb status_cb,void* ud);
746 LinphoneCore* linphone_chat_room_get_lc(LinphoneChatRoom *cr);
747 LinphoneChatRoom* linphone_chat_message_get_chat_room(LinphoneChatMessage *msg);
748 char* linphone_chat_message_get_message(LinphoneChatMessage *msg);
749 const LinphoneAddress* linphone_chat_message_get_peer_address(LinphoneChatMessage *msg);
750 void linphone_chat_room_set_user_data(LinphoneChatRoom *cr, void * ud);
751 void * linphone_chat_room_get_user_data(LinphoneChatRoom *cr);
752
753 /**
754  * @}
755  */
756
757
758 /**
759  * @addtogroup initializing
760  * @{
761 **/
762
763 /**
764  * LinphoneGlobalState describes the global state of the LinphoneCore object.
765  * It is notified via the LinphoneCoreVTable::global_state_changed
766 **/
767 typedef enum _LinphoneGlobalState{
768         LinphoneGlobalOff,
769         LinphoneGlobalStartup,
770         LinphoneGlobalOn,
771         LinphoneGlobalShutdown
772 }LinphoneGlobalState;
773
774 const char *linphone_global_state_to_string(LinphoneGlobalState gs);
775
776
777 /**Call state notification callback prototype*/
778 typedef void (*LinphoneGlobalStateCb)(struct _LinphoneCore *lc, LinphoneGlobalState gstate, const char *message);
779 /**Call state notification callback prototype*/
780 typedef void (*LinphoneCallStateCb)(struct _LinphoneCore *lc, LinphoneCall *call, LinphoneCallState cstate, const char *message);
781 /**Call encryption changed callback prototype*/
782 typedef void (*CallEncryptionChangedCb)(struct _LinphoneCore *lc, LinphoneCall *call, bool_t on, const char *authentication_token);
783
784 /** @ingroup Proxies
785  * Registration state notification callback prototype
786  * */
787 typedef void (*LinphoneRegistrationStateCb)(struct _LinphoneCore *lc, LinphoneProxyConfig *cfg, LinphoneRegistrationState cstate, const char *message);
788 /** Callback prototype */
789 typedef void (*ShowInterfaceCb)(struct _LinphoneCore *lc);
790 /** Callback prototype */
791 typedef void (*DisplayStatusCb)(struct _LinphoneCore *lc, const char *message);
792 /** Callback prototype */
793 typedef void (*DisplayMessageCb)(struct _LinphoneCore *lc, const char *message);
794 /** Callback prototype */
795 typedef void (*DisplayUrlCb)(struct _LinphoneCore *lc, const char *message, const char *url);
796 /** Callback prototype */
797 typedef void (*LinphoneCoreCbFunc)(struct _LinphoneCore *lc,void * user_data);
798 /** Callback prototype */
799 typedef void (*NotifyReceivedCb)(struct _LinphoneCore *lc, LinphoneCall *call, const char *from, const char *event);
800 /**
801  * Report status change for a friend previously \link linphone_core_add_friend() added \endlink to #LinphoneCore.
802  * @param lc #LinphoneCore object .
803  * @param lf Updated #LinphoneFriend .
804  */
805 typedef void (*NotifyPresenceReceivedCb)(struct _LinphoneCore *lc, LinphoneFriend * lf);
806 /**
807  *  Reports that a new subscription request has been received and wait for a decision.
808  *  <br> Status on this subscription request is notified by \link linphone_friend_set_inc_subscribe_policy() changing policy \endlink for this friend
809  *      @param lc #LinphoneCore object
810  *      @param lf #LinphoneFriend corresponding to the subscriber
811  *      @param url of the subscriber
812  *  Callback prototype
813  *  */
814 typedef void (*NewSubscribtionRequestCb)(struct _LinphoneCore *lc, LinphoneFriend *lf, const char *url);
815 /** Callback prototype */
816 typedef void (*AuthInfoRequested)(struct _LinphoneCore *lc, const char *realm, const char *username);
817 /** Callback prototype */
818 typedef void (*CallLogUpdated)(struct _LinphoneCore *lc, struct _LinphoneCallLog *newcl);
819 /**
820  * Callback prototype
821  * @deprecated use #MessageReceived instead.
822  *
823  * @param lc #LinphoneCore object
824  * @param room #LinphoneChatRoom involved in this conversation. Can be be created by the framework in case \link #LinphoneAddress the from \endlink is not present in any chat room.
825  * @param from #LinphoneAddress from
826  * @param message incoming message
827  *  */
828 typedef void (*TextMessageReceived)(LinphoneCore *lc, LinphoneChatRoom *room, const LinphoneAddress *from, const char *message);
829 /**
830  * Chat message callback prototype
831  *
832  * @param lc #LinphoneCore object
833  * @param room #LinphoneChatRoom involved in this conversation. Can be be created by the framework in case \link #LinphoneAddress the from \endlink is not present in any chat room.
834  * @param LinphoneChatMessage incoming message
835  * */
836 typedef void (*MessageReceived)(LinphoneCore *lc, LinphoneChatRoom *room, LinphoneChatMessage *message);
837         
838 /** Callback prototype */
839 typedef void (*DtmfReceived)(struct _LinphoneCore* lc, LinphoneCall *call, int dtmf);
840 /** Callback prototype */
841 typedef void (*ReferReceived)(struct _LinphoneCore *lc, const char *refer_to);
842 /** Callback prototype */
843 typedef void (*BuddyInfoUpdated)(struct _LinphoneCore *lc, LinphoneFriend *lf);
844 /** Callback prototype for in progress transfers. The new_call_state is the state of the call resulting of the transfer, at the other party. */
845 typedef void (*LinphoneTransferStateChanged)(struct _LinphoneCore *lc, LinphoneCall *transfered, LinphoneCallState new_call_state);
846 /** Callback prototype for receiving quality statistics for calls*/
847 typedef void (*CallStatsUpdated)(struct _LinphoneCore *lc, LinphoneCall *call, const LinphoneCallStats *stats);
848
849 /**
850  * This structure holds all callbacks that the application should implement.
851  *  None is mandatory.
852 **/
853 typedef struct _LinphoneVTable{
854         LinphoneGlobalStateCb global_state_changed; /**<Notifies globlal state changes*/
855         LinphoneRegistrationStateCb registration_state_changed;/**<Notifies registration state changes*/
856         LinphoneCallStateCb call_state_changed;/**<Notifies call state changes*/
857         NotifyPresenceReceivedCb notify_presence_recv; /**< Notify received presence events*/
858         NewSubscribtionRequestCb new_subscription_request; /**< Notify about pending subscription request */
859         AuthInfoRequested auth_info_requested; /**< Ask the application some authentication information */
860         CallLogUpdated call_log_updated; /**< Notifies that call log list has been updated */
861         TextMessageReceived text_received; /** @deprecated, use #message_received instead <br> A text message has been received */
862         MessageReceived message_received; /** a message is received, can be text or external body*/
863         DtmfReceived dtmf_received; /**< A dtmf has been received received */
864         ReferReceived refer_received; /**< An out of call refer was received */
865         CallEncryptionChangedCb call_encryption_changed; /**<Notifies on change in the encryption of call streams */
866         LinphoneTransferStateChanged transfer_state_changed; /**<Notifies when a transfer is in progress */
867         BuddyInfoUpdated buddy_info_updated; /**< a LinphoneFriend's BuddyInfo has changed*/
868         NotifyReceivedCb notify_recv; /**< Other notifications*/
869         CallStatsUpdated call_stats_updated; /**<Notifies on refreshing of call's statistics. */
870         DisplayStatusCb display_status; /**< DEPRECATED Callback that notifies various events with human readable text.*/
871         DisplayMessageCb display_message;/**< DEPRECATED Callback to display a message to the user */
872         DisplayMessageCb display_warning;/**< DEPRECATED Callback to display a warning to the user */
873         DisplayUrlCb display_url; /**< DEPRECATED */
874         ShowInterfaceCb show; /**< DEPRECATED Notifies the application that it should show up*/
875 } LinphoneCoreVTable;
876
877 /**
878  * @}
879 **/
880
881 typedef struct _LCCallbackObj
882 {
883   LinphoneCoreCbFunc _func;
884   void * _user_data;
885 }LCCallbackObj;
886
887
888
889 typedef enum _LinphoneFirewallPolicy{
890         LinphonePolicyNoFirewall,
891         LinphonePolicyUseNatAddress,
892         LinphonePolicyUseStun,
893         LinphonePolicyUseIce
894 } LinphoneFirewallPolicy;
895
896 typedef enum _LinphoneWaitingState{
897         LinphoneWaitingStart,
898         LinphoneWaitingProgress,
899         LinphoneWaitingFinished
900 } LinphoneWaitingState;
901 typedef void * (*LinphoneWaitingCallback)(struct _LinphoneCore *lc, void *context, LinphoneWaitingState ws, const char *purpose, float progress);
902
903
904 /* THE main API */
905
906 void linphone_core_enable_logs(FILE *file);
907 void linphone_core_enable_logs_with_cb(OrtpLogFunc logfunc);
908 void linphone_core_disable_logs(void);
909 /*sets the user-agent string in sip messages, must be set before linphone_core_new() or linphone_core_init() */
910 void linphone_core_set_user_agent(const char *ua_name, const char *version);
911 const char *linphone_core_get_version(void);
912 const char *linphone_core_get_user_agent_name(void);
913 const char *linphone_core_get_user_agent_version(void);
914
915 LinphoneCore *linphone_core_new(const LinphoneCoreVTable *vtable,
916                                                 const char *config_path, const char *factory_config, void* userdata);
917
918 /* function to be periodically called in a main loop */
919 /* For ICE to work properly it should be called every 20ms */
920 void linphone_core_iterate(LinphoneCore *lc);
921 #if 0 /*not implemented yet*/
922 /**
923  * @ingroup initializing
924  * Provide Linphone Core with an unique identifier. This be later used to identified contact address coming from this device.
925  * Value is not saved.
926  * @param lc object
927  * @param string identifying the device, can be EMEI or UDID
928  *
929  */
930 void linphone_core_set_device_identifier(LinphoneCore *lc,const char* device_id);
931 /**
932  * @ingroup initializing
933  * get Linphone unique identifier
934  *
935  */
936 const char*  linphone_core_get_device_identifier(const LinphoneCore *lc);
937
938 #endif
939
940 LinphoneAddress * linphone_core_interpret_url(LinphoneCore *lc, const char *url);
941
942 LinphoneCall * linphone_core_invite(LinphoneCore *lc, const char *url);
943
944 LinphoneCall * linphone_core_invite_address(LinphoneCore *lc, const LinphoneAddress *addr);
945
946 LinphoneCall * linphone_core_invite_with_params(LinphoneCore *lc, const char *url, const LinphoneCallParams *params);
947
948 LinphoneCall * linphone_core_invite_address_with_params(LinphoneCore *lc, const LinphoneAddress *addr, const LinphoneCallParams *params);
949
950 int linphone_core_transfer_call(LinphoneCore *lc, LinphoneCall *call, const char *refer_to);
951
952 int linphone_core_transfer_call_to_another(LinphoneCore *lc, LinphoneCall *call, LinphoneCall *dest);
953
954 bool_t linphone_core_inc_invite_pending(LinphoneCore*lc);
955
956 bool_t linphone_core_in_call(const LinphoneCore *lc);
957
958 LinphoneCall *linphone_core_get_current_call(const LinphoneCore *lc);
959
960 int linphone_core_accept_call(LinphoneCore *lc, LinphoneCall *call);
961
962 int linphone_core_accept_call_with_params(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
963
964 int linphone_core_terminate_call(LinphoneCore *lc, LinphoneCall *call);
965
966 int linphone_core_redirect_call(LinphoneCore *lc, LinphoneCall *call, const char *redirect_uri);
967
968 int linphone_core_decline_call(LinphoneCore *lc, LinphoneCall * call, LinphoneReason reason);
969
970 int linphone_core_terminate_all_calls(LinphoneCore *lc);
971
972 int linphone_core_pause_call(LinphoneCore *lc, LinphoneCall *call);
973
974 int linphone_core_pause_all_calls(LinphoneCore *lc);
975
976 int linphone_core_resume_call(LinphoneCore *lc, LinphoneCall *call);
977
978 int linphone_core_update_call(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
979
980 int linphone_core_defer_call_update(LinphoneCore *lc, LinphoneCall *call);
981
982 int linphone_core_accept_call_update(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallParams *params);
983
984 LinphoneCallParams *linphone_core_create_default_call_parameters(LinphoneCore *lc);
985
986 LinphoneCall *linphone_core_get_call_by_remote_address(LinphoneCore *lc, const char *remote_address);
987
988 void linphone_core_send_dtmf(LinphoneCore *lc,char dtmf);
989
990 int linphone_core_set_primary_contact(LinphoneCore *lc, const char *contact);
991
992 const char *linphone_core_get_primary_contact(LinphoneCore *lc);
993
994 const char * linphone_core_get_identity(LinphoneCore *lc);
995
996 void linphone_core_set_guess_hostname(LinphoneCore *lc, bool_t val);
997 bool_t linphone_core_get_guess_hostname(LinphoneCore *lc);
998
999 bool_t linphone_core_ipv6_enabled(LinphoneCore *lc);
1000 void linphone_core_enable_ipv6(LinphoneCore *lc, bool_t val);
1001
1002 LinphoneAddress *linphone_core_get_primary_contact_parsed(LinphoneCore *lc);
1003 const char * linphone_core_get_identity(LinphoneCore *lc);
1004 /*0= no bandwidth limit*/
1005 void linphone_core_set_download_bandwidth(LinphoneCore *lc, int bw);
1006 void linphone_core_set_upload_bandwidth(LinphoneCore *lc, int bw);
1007
1008 int linphone_core_get_download_bandwidth(const LinphoneCore *lc);
1009 int linphone_core_get_upload_bandwidth(const LinphoneCore *lc);
1010
1011 void linphone_core_enable_adaptive_rate_control(LinphoneCore *lc, bool_t enabled);
1012 bool_t linphone_core_adaptive_rate_control_enabled(const LinphoneCore *lc);
1013 /**
1014  * set audio packetization time linphone expect to receive from peer
1015  * @ingroup media_parameters
1016  *
1017  */
1018 void linphone_core_set_download_ptime(LinphoneCore *lc, int ptime);
1019 /**
1020  * get audio packetization time linphone expect to receive from peer, 0 means unspecified
1021  * @ingroup media_parameters
1022  */
1023 int  linphone_core_get_download_ptime(LinphoneCore *lc);
1024
1025 void linphone_core_set_upload_ptime(LinphoneCore *lc, int ptime);
1026
1027 int linphone_core_get_upload_ptime(LinphoneCore *lc);
1028
1029 /* returns a MSList of PayloadType */
1030 const MSList *linphone_core_get_audio_codecs(const LinphoneCore *lc);
1031
1032 int linphone_core_set_audio_codecs(LinphoneCore *lc, MSList *codecs);
1033 /* returns a MSList of PayloadType */
1034 const MSList *linphone_core_get_video_codecs(const LinphoneCore *lc);
1035
1036 int linphone_core_set_video_codecs(LinphoneCore *lc, MSList *codecs);
1037
1038 bool_t linphone_core_payload_type_enabled(LinphoneCore *lc, const PayloadType *pt);
1039
1040 int linphone_core_enable_payload_type(LinphoneCore *lc, PayloadType *pt, bool_t enable);
1041
1042 /**
1043  * Wildcard value used by #linphone_core_find_payload_type to ignore rate in search algirithm
1044  * @ingroup media_parameters
1045  */
1046 #define LINPHONE_FIND_PAYLOAD_IGNORE_RATE -1
1047 /**
1048  * Wildcard value used by #linphone_core_find_payload_type to ignore channel in search algirithm
1049  * @ingroup media_parameters
1050  */
1051 #define LINPHONE_FIND_PAYLOAD_IGNORE_CHANNELS -1
1052 /**
1053  * Get payload type  from mime type and clock rate
1054  * @ingroup media_parameters
1055  * This function searches in audio and video codecs for the given payload type name and clockrate.
1056  * @param lc #LinphoneCore object
1057  * @param type payload mime type (I.E SPEEX, PCMU, VP8)
1058  * @param rate, can be #LINPHONE_FIND_PAYLOAD_IGNORE_RATE
1059  * @param channels, number of channels, can be #LINPHONE_FIND_PAYLOAD_IGNORE_CHANNELS
1060  * @return Returns NULL if not found.
1061  */     
1062 PayloadType* linphone_core_find_payload_type(LinphoneCore* lc, const char* type, int rate, int channels) ;
1063
1064 int linphone_core_get_payload_type_number(LinphoneCore *lc, const PayloadType *pt);
1065
1066 const char *linphone_core_get_payload_type_description(LinphoneCore *lc, PayloadType *pt);
1067
1068 bool_t linphone_core_check_payload_type_usability(LinphoneCore *lc, PayloadType *pt);
1069
1070 /**
1071  * @ingroup proxy 
1072  *Create a proxy config with default value from Linphone core.
1073  *@param lc #LinphoneCore object
1074  *@return #LinphoneProxyConfig with defualt value set 
1075  */
1076 LinphoneProxyConfig * linphone_core_create_proxy_config(LinphoneCore *lc);
1077         
1078 int linphone_core_add_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
1079
1080 void linphone_core_clear_proxy_config(LinphoneCore *lc);
1081
1082 void linphone_core_remove_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
1083
1084 const MSList *linphone_core_get_proxy_config_list(const LinphoneCore *lc);
1085
1086 void linphone_core_set_default_proxy(LinphoneCore *lc, LinphoneProxyConfig *config);
1087
1088 void linphone_core_set_default_proxy_index(LinphoneCore *lc, int index);
1089
1090 int linphone_core_get_default_proxy(LinphoneCore *lc, LinphoneProxyConfig **config);
1091
1092 void linphone_core_add_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
1093
1094 void linphone_core_remove_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
1095
1096 const MSList *linphone_core_get_auth_info_list(const LinphoneCore *lc);
1097
1098 const LinphoneAuthInfo *linphone_core_find_auth_info(LinphoneCore *lc, const char *realm, const char *username);
1099
1100 void linphone_core_abort_authentication(LinphoneCore *lc,  LinphoneAuthInfo *info);
1101
1102 void linphone_core_clear_all_auth_info(LinphoneCore *lc);
1103
1104 void linphone_core_enable_audio_adaptive_jittcomp(LinphoneCore *lc, bool_t enable);
1105
1106 bool_t linphone_core_audio_adaptive_jittcomp_enabled(LinphoneCore *lc);
1107
1108 int linphone_core_get_audio_jittcomp(LinphoneCore *lc);
1109
1110 void linphone_core_set_audio_jittcomp(LinphoneCore *lc, int value);
1111
1112 void linphone_core_enable_video_adaptive_jittcomp(LinphoneCore *lc, bool_t enable);
1113
1114 bool_t linphone_core_video_adaptive_jittcomp_enabled(LinphoneCore *lc);
1115
1116 int linphone_core_get_video_jittcomp(LinphoneCore *lc);
1117
1118 void linphone_core_set_video_jittcomp(LinphoneCore *lc, int value);
1119
1120 int linphone_core_get_audio_port(const LinphoneCore *lc);
1121
1122 void linphone_core_get_audio_port_range(const LinphoneCore *lc, int *min_port, int *max_port);
1123
1124 int linphone_core_get_video_port(const LinphoneCore *lc);
1125
1126 void linphone_core_get_video_port_range(const LinphoneCore *lc, int *min_port, int *max_port);
1127
1128 int linphone_core_get_nortp_timeout(const LinphoneCore *lc);
1129
1130 void linphone_core_set_audio_port(LinphoneCore *lc, int port);
1131
1132 void linphone_core_set_audio_port_range(LinphoneCore *lc, int min_port, int max_port);
1133
1134 void linphone_core_set_video_port(LinphoneCore *lc, int port);
1135
1136 void linphone_core_set_video_port_range(LinphoneCore *lc, int min_port, int max_port);
1137
1138 void linphone_core_set_nortp_timeout(LinphoneCore *lc, int port);
1139
1140 void linphone_core_set_use_info_for_dtmf(LinphoneCore *lc, bool_t use_info);
1141
1142 bool_t linphone_core_get_use_info_for_dtmf(LinphoneCore *lc);
1143
1144 void linphone_core_set_use_rfc2833_for_dtmf(LinphoneCore *lc,bool_t use_rfc2833);
1145
1146 bool_t linphone_core_get_use_rfc2833_for_dtmf(LinphoneCore *lc);
1147
1148 void linphone_core_set_sip_port(LinphoneCore *lc, int port);
1149
1150 int linphone_core_get_sip_port(LinphoneCore *lc);
1151
1152 int linphone_core_set_sip_transports(LinphoneCore *lc, const LCSipTransports *transports);
1153
1154 int linphone_core_get_sip_transports(LinphoneCore *lc, LCSipTransports *transports);
1155 /**
1156  *
1157  * Give access to the UDP sip socket. Can be useful to configure this socket as persistent I.E kCFStreamNetworkServiceType set to kCFStreamNetworkServiceTypeVoIP)
1158  * @param lc #LinphoneCore
1159  * @return socket file descriptor
1160  */
1161 ortp_socket_t linphone_core_get_sip_socket(LinphoneCore *lc);
1162
1163 void linphone_core_set_inc_timeout(LinphoneCore *lc, int seconds);
1164
1165 int linphone_core_get_inc_timeout(LinphoneCore *lc);
1166
1167 void linphone_core_set_in_call_timeout(LinphoneCore *lc, int seconds);
1168
1169 int linphone_core_get_in_call_timeout(LinphoneCore *lc);
1170
1171 void linphone_core_set_stun_server(LinphoneCore *lc, const char *server);
1172
1173 const char * linphone_core_get_stun_server(const LinphoneCore *lc);
1174
1175 void linphone_core_set_nat_address(LinphoneCore *lc, const char *addr);
1176
1177 const char *linphone_core_get_nat_address(const LinphoneCore *lc);
1178
1179 void linphone_core_set_firewall_policy(LinphoneCore *lc, LinphoneFirewallPolicy pol);
1180
1181 LinphoneFirewallPolicy linphone_core_get_firewall_policy(const LinphoneCore *lc);
1182
1183 const char * linphone_core_get_relay_addr(const LinphoneCore *lc);
1184
1185 int linphone_core_set_relay_addr(LinphoneCore *lc, const char *addr);
1186
1187 /* sound functions */
1188 /* returns a null terminated static array of string describing the sound devices */
1189 const char**  linphone_core_get_sound_devices(LinphoneCore *lc);
1190 void linphone_core_reload_sound_devices(LinphoneCore *lc);
1191 bool_t linphone_core_sound_device_can_capture(LinphoneCore *lc, const char *device);
1192 bool_t linphone_core_sound_device_can_playback(LinphoneCore *lc, const char *device);
1193 int linphone_core_get_ring_level(LinphoneCore *lc);
1194 int linphone_core_get_play_level(LinphoneCore *lc);
1195 int linphone_core_get_rec_level(LinphoneCore *lc);
1196 void linphone_core_set_ring_level(LinphoneCore *lc, int level);
1197 void linphone_core_set_play_level(LinphoneCore *lc, int level);
1198
1199 void linphone_core_set_mic_gain_db(LinphoneCore *lc, float level);
1200 float linphone_core_get_mic_gain_db(LinphoneCore *lc);
1201 void linphone_core_set_playback_gain_db(LinphoneCore *lc, float level);
1202 float linphone_core_get_playback_gain_db(LinphoneCore *lc);
1203
1204 void linphone_core_set_rec_level(LinphoneCore *lc, int level);
1205 const char * linphone_core_get_ringer_device(LinphoneCore *lc);
1206 const char * linphone_core_get_playback_device(LinphoneCore *lc);
1207 const char * linphone_core_get_capture_device(LinphoneCore *lc);
1208 int linphone_core_set_ringer_device(LinphoneCore *lc, const char * devid);
1209 int linphone_core_set_playback_device(LinphoneCore *lc, const char * devid);
1210 int linphone_core_set_capture_device(LinphoneCore *lc, const char * devid);
1211 char linphone_core_get_sound_source(LinphoneCore *lc);
1212 void linphone_core_set_sound_source(LinphoneCore *lc, char source);
1213 void linphone_core_set_ring(LinphoneCore *lc, const char *path);
1214 const char *linphone_core_get_ring(const LinphoneCore *lc);
1215 void linphone_core_verify_server_certificates(LinphoneCore *lc, bool_t yesno);
1216 void linphone_core_set_root_ca(LinphoneCore *lc, const char *path);
1217 void linphone_core_set_ringback(LinphoneCore *lc, const char *path);
1218 const char * linphone_core_get_ringback(const LinphoneCore *lc);
1219
1220 void linphone_core_set_remote_ringback_tone(LinphoneCore *lc,const char *);
1221 const char *linphone_core_get_remote_ringback_tone(const LinphoneCore *lc);
1222
1223 int linphone_core_preview_ring(LinphoneCore *lc, const char *ring,LinphoneCoreCbFunc func,void * userdata);
1224 void linphone_core_enable_echo_cancellation(LinphoneCore *lc, bool_t val);
1225 bool_t linphone_core_echo_cancellation_enabled(LinphoneCore *lc);
1226
1227 void linphone_core_enable_echo_limiter(LinphoneCore *lc, bool_t val);
1228 bool_t linphone_core_echo_limiter_enabled(const LinphoneCore *lc);
1229
1230 void linphone_core_enable_agc(LinphoneCore *lc, bool_t val);
1231 bool_t linphone_core_agc_enabled(const LinphoneCore *lc);
1232
1233 void linphone_core_mute_mic(LinphoneCore *lc, bool_t muted);
1234 /**
1235  * return mic state.
1236  *
1237  * @ingroup media_parameters
1238 **/
1239 bool_t linphone_core_is_mic_muted(LinphoneCore *lc);
1240
1241 bool_t linphone_core_is_audio_muted(LinphoneCore *lc);
1242 bool_t linphone_core_is_rtp_muted(LinphoneCore *lc);
1243
1244 bool_t linphone_core_get_rtp_no_xmit_on_audio_mute(const LinphoneCore *lc);
1245 void linphone_core_set_rtp_no_xmit_on_audio_mute(LinphoneCore *lc, bool_t val);
1246
1247
1248 /* returns a list of LinphoneCallLog */
1249 const MSList * linphone_core_get_call_logs(LinphoneCore *lc);
1250 void linphone_core_clear_call_logs(LinphoneCore *lc);
1251 int linphone_core_get_missed_calls_count(LinphoneCore *lc);
1252 void linphone_core_reset_missed_calls_count(LinphoneCore *lc);
1253 void linphone_core_remove_call_log(LinphoneCore *lc, LinphoneCallLog *call_log);
1254
1255 /* video support */
1256 bool_t linphone_core_video_supported(LinphoneCore *lc);
1257 void linphone_core_enable_video(LinphoneCore *lc, bool_t vcap_enabled, bool_t display_enabled);
1258 bool_t linphone_core_video_enabled(LinphoneCore *lc);
1259 void linphone_core_set_video_policy(LinphoneCore *lc, const LinphoneVideoPolicy *policy);
1260 const LinphoneVideoPolicy *linphone_core_get_video_policy(LinphoneCore *lc);
1261
1262 typedef struct MSVideoSizeDef{
1263         MSVideoSize vsize;
1264         const char *name;
1265 }MSVideoSizeDef;
1266 /* returns a zero terminated table of MSVideoSizeDef*/
1267 const MSVideoSizeDef *linphone_core_get_supported_video_sizes(LinphoneCore *lc);
1268 void linphone_core_set_preferred_video_size(LinphoneCore *lc, MSVideoSize vsize);
1269 MSVideoSize linphone_core_get_preferred_video_size(LinphoneCore *lc);
1270 void linphone_core_set_preferred_video_size_by_name(LinphoneCore *lc, const char *name);
1271
1272 void linphone_core_enable_video_preview(LinphoneCore *lc, bool_t val);
1273 bool_t linphone_core_video_preview_enabled(const LinphoneCore *lc);
1274
1275 void linphone_core_enable_self_view(LinphoneCore *lc, bool_t val);
1276 bool_t linphone_core_self_view_enabled(const LinphoneCore *lc);
1277
1278
1279 /* returns a null terminated static array of string describing the webcams */
1280 void linphone_core_reload_video_devices(LinphoneCore *lc);
1281 const char**  linphone_core_get_video_devices(const LinphoneCore *lc);
1282 int linphone_core_set_video_device(LinphoneCore *lc, const char *id);
1283 const char *linphone_core_get_video_device(const LinphoneCore *lc);
1284
1285 /* Set static picture to be used when "Static picture" is the video device */
1286 int linphone_core_set_static_picture(LinphoneCore *lc, const char *path);
1287
1288 /* Set and get frame rate for static picture */
1289 int linphone_core_set_static_picture_fps(LinphoneCore *lc, float fps);
1290 float linphone_core_get_static_picture_fps(LinphoneCore *lc);
1291
1292 /*function to be used for eventually setting window decorations (icons, title...)*/
1293 unsigned long linphone_core_get_native_video_window_id(const LinphoneCore *lc);
1294 void linphone_core_set_native_video_window_id(LinphoneCore *lc, unsigned long id);
1295
1296 unsigned long linphone_core_get_native_preview_window_id(const LinphoneCore *lc);
1297 void linphone_core_set_native_preview_window_id(LinphoneCore *lc, unsigned long id);
1298
1299 void linphone_core_use_preview_window(LinphoneCore *lc, bool_t yesno);
1300 int linphone_core_get_device_rotation(LinphoneCore *lc );
1301 void linphone_core_set_device_rotation(LinphoneCore *lc, int rotation);
1302
1303 /* start or stop streaming video in case of embedded window */
1304 void linphone_core_show_video(LinphoneCore *lc, bool_t show);
1305
1306 /*play/record support: use files instead of soundcard*/
1307 void linphone_core_use_files(LinphoneCore *lc, bool_t yesno);
1308 void linphone_core_set_play_file(LinphoneCore *lc, const char *file);
1309 void linphone_core_set_record_file(LinphoneCore *lc, const char *file);
1310
1311 void linphone_core_play_dtmf(LinphoneCore *lc, char dtmf, int duration_ms);
1312 void linphone_core_stop_dtmf(LinphoneCore *lc);
1313
1314 int linphone_core_get_current_call_duration(const LinphoneCore *lc);
1315
1316
1317 int linphone_core_get_mtu(const LinphoneCore *lc);
1318 void linphone_core_set_mtu(LinphoneCore *lc, int mtu);
1319
1320 /**
1321  * @ingroup network_parameters
1322  * This method is called by the application to notify the linphone core library when network is reachable.
1323  * Calling this method with true trigger linphone to initiate a registration process for all proxies.
1324  * Calling this method disables the automatic network detection mode. It means you must call this method after each network state changes.
1325  */
1326 void linphone_core_set_network_reachable(LinphoneCore* lc,bool_t value);
1327 /**
1328  * @ingroup network_parameters
1329  * return network state either as positioned by the application or by linphone itself.
1330  */
1331 bool_t linphone_core_is_network_reachable(LinphoneCore* lc);
1332
1333 /**
1334  *  @ingroup network_parameters
1335  *  enable signaling keep alive. small udp packet sent periodically to keep udp NAT association
1336  */
1337 void linphone_core_enable_keep_alive(LinphoneCore* lc,bool_t enable);
1338 /**
1339  *  @ingroup network_parameters
1340  * Is signaling keep alive
1341  */
1342 bool_t linphone_core_keep_alive_enabled(LinphoneCore* lc);
1343
1344 void *linphone_core_get_user_data(LinphoneCore *lc);
1345 void linphone_core_set_user_data(LinphoneCore *lc, void *userdata);
1346
1347 /* returns LpConfig object to read/write to the config file: usefull if you wish to extend
1348 the config file with your own sections */
1349 struct _LpConfig *linphone_core_get_config(LinphoneCore *lc);
1350
1351 /*set a callback for some blocking operations, it takes you informed of the progress of the operation*/
1352 void linphone_core_set_waiting_callback(LinphoneCore *lc, LinphoneWaitingCallback cb, void *user_context);
1353
1354 /*returns the list of registered SipSetup (linphonecore plugins) */
1355 const MSList * linphone_core_get_sip_setups(LinphoneCore *lc);
1356
1357 void linphone_core_destroy(LinphoneCore *lc);
1358
1359 /*for advanced users:*/
1360 typedef RtpTransport * (*LinphoneRtpTransportFactoryFunc)(void *data, int port);
1361 struct _LinphoneRtpTransportFactories{
1362         LinphoneRtpTransportFactoryFunc audio_rtp_func;
1363         void *audio_rtp_func_data;
1364         LinphoneRtpTransportFactoryFunc audio_rtcp_func;
1365         void *audio_rtcp_func_data;
1366         LinphoneRtpTransportFactoryFunc video_rtp_func;
1367         void *video_rtp_func_data;
1368         LinphoneRtpTransportFactoryFunc video_rtcp_func;
1369         void *video_rtcp_func_data;
1370 };
1371 typedef struct _LinphoneRtpTransportFactories LinphoneRtpTransportFactories;
1372
1373 void linphone_core_set_rtp_transport_factories(LinphoneCore* lc, LinphoneRtpTransportFactories *factories);
1374
1375 int linphone_core_get_current_call_stats(LinphoneCore *lc, rtp_stats_t *local, rtp_stats_t *remote);
1376
1377 int linphone_core_get_calls_nb(const LinphoneCore *lc);
1378
1379 const MSList *linphone_core_get_calls(LinphoneCore *lc);
1380
1381 LinphoneGlobalState linphone_core_get_global_state(const LinphoneCore *lc);
1382 /**
1383  * force registration refresh to be initiated upon next iterate
1384  * @ingroup proxies
1385  */
1386 void linphone_core_refresh_registers(LinphoneCore* lc);
1387
1388 /* Path to the file storing secrets cache */
1389 void linphone_core_set_zrtp_secrets_file(LinphoneCore *lc, const char* file);
1390
1391
1392 const LinphoneCall* linphone_core_find_call_from_uri(LinphoneCore *lc, const char *uri);
1393
1394 int linphone_core_add_to_conference(LinphoneCore *lc, LinphoneCall *call);
1395 int linphone_core_add_all_to_conference(LinphoneCore *lc);
1396 int linphone_core_remove_from_conference(LinphoneCore *lc, LinphoneCall *call);
1397 bool_t linphone_core_is_in_conference(const LinphoneCore *lc);
1398 int linphone_core_enter_conference(LinphoneCore *lc);
1399 int linphone_core_leave_conference(LinphoneCore *lc);
1400 float linphone_core_get_conference_local_input_volume(LinphoneCore *lc);
1401
1402 int linphone_core_terminate_conference(LinphoneCore *lc);
1403 int linphone_core_get_conference_size(LinphoneCore *lc);
1404
1405 int linphone_core_get_max_calls(LinphoneCore *lc);
1406 void linphone_core_set_max_calls(LinphoneCore *lc, int max);
1407
1408 bool_t linphone_core_sound_resources_locked(LinphoneCore *lc);
1409
1410 bool_t linphone_core_media_encryption_supported(const LinphoneCore *lc, LinphoneMediaEncryption menc);
1411
1412 /**
1413  * Choose media encryption policy to be used for RTP packets
1414  */
1415 int linphone_core_set_media_encryption(LinphoneCore *lc, enum LinphoneMediaEncryption menc);
1416 LinphoneMediaEncryption linphone_core_get_media_encryption(LinphoneCore *lc);
1417
1418 bool_t linphone_core_is_media_encryption_mandatory(LinphoneCore *lc);
1419 /**
1420  * Defines Linphone behaviour when encryption parameters negociation fails on outoing call.
1421  * If set to TRUE call will fail; if set to FALSE will resend an INVITE with encryption disabled
1422  */
1423 void linphone_core_set_media_encryption_mandatory(LinphoneCore *lc, bool_t m);
1424
1425 /**
1426  * Init call params using LinphoneCore's current configuration
1427  */
1428 void linphone_core_init_default_params(LinphoneCore*lc, LinphoneCallParams *params);
1429
1430 /**
1431  * True if tunnel support was compiled.
1432  */
1433 bool_t linphone_core_tunnel_available(void);
1434
1435 typedef struct LinphoneTunnel LinphoneTunnel;
1436 /**
1437 * get tunnel instance if available
1438 */
1439 LinphoneTunnel *linphone_core_get_tunnel(LinphoneCore *lc);
1440
1441 void linphone_core_set_sip_dscp(LinphoneCore *lc, int dscp);
1442 int linphone_core_get_sip_dscp(const LinphoneCore *lc);
1443
1444 void linphone_core_set_audio_dscp(LinphoneCore *lc, int dscp);
1445 int linphone_core_get_audio_dscp(const LinphoneCore *lc);
1446
1447 void linphone_core_set_video_dscp(LinphoneCore *lc, int dscp);
1448 int linphone_core_get_video_dscp(const LinphoneCore *lc);
1449
1450
1451
1452 #ifdef __cplusplus
1453 }
1454 #endif
1455
1456
1457 #endif