sjero.net Git - linphone/blob - 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 containg 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         struct _LinphoneCore *lc;
 156 } LinphoneCallLog;
 157
 158
 159
 160 /*public: */
 161 void linphone_call_log_set_user_pointer(LinphoneCallLog *cl, void *up);
 162 void *linphone_call_log_get_user_pointer(const LinphoneCallLog *cl);
 163 void linphone_call_log_set_ref_key(LinphoneCallLog *cl, const char *refkey);
 164 const char *linphone_call_log_get_ref_key(const LinphoneCallLog *cl);
 165 const rtp_stats_t *linphone_call_log_get_local_stats(const LinphoneCallLog *cl);
 166 const rtp_stats_t *linphone_call_log_get_remote_stats(const LinphoneCallLog *cl);
 167 char * linphone_call_log_to_str(LinphoneCallLog *cl);
 168
 169
 170 /**
 171  * The LinphoneCallParams is an object contaning various call related parameters.
 172  * It can be used to retrieve parameters from a currently running call or modify the call's characterisitcs
 173  * dynamically.
 174 **/
 175 struct _LinphoneCallParams;
 176 typedef struct _LinphoneCallParams LinphoneCallParams;
 177
 178 LinphoneCallParams * linphone_call_params_copy(const LinphoneCallParams *cp);
 179 void linphone_call_params_enable_video(LinphoneCallParams *cp, bool_t enabled);
 180 bool_t linphone_call_params_video_enabled(const LinphoneCallParams *cp);
 181 void linphone_call_params_enable_early_media_sending(LinphoneCallParams *cp, bool_t enabled);
 182 bool_t linphone_call_params_early_media_sending_enabled(const LinphoneCallParams *cp);
 183 void linphone_call_params_destroy(LinphoneCallParams *cp);
 184
 185 /**
 186  * Enum describing failure reasons.
 187 **/
 188 enum _LinphoneReason{
 189         LinphoneReasonNone,
 190         LinphoneReasonNoResponse, /**<No response received from remote*/
 191         LinphoneReasonBadCredentials, /**<Authentication failed due to bad or missing credentials*/
 192         LinphoneReasonDeclined, /**<The call has been declined*/
 193 };
 194
 195 typedef enum _LinphoneReason LinphoneReason;
 196
 197 const char *linphone_reason_to_string(LinphoneReason err);
 198
 199 /**
 200  * The LinphoneCall object represents a call issued or received by the LinphoneCore
 201 **/
 202 struct _LinphoneCall;
 203 typedef struct _LinphoneCall LinphoneCall;
 204
 205 typedef enum _LinphoneCallState{
 206         LinphoneCallIdle,
 207         LinphoneCallIncomingReceived, /**<This is a new incoming call */
 208         LinphoneCallOutgoingInit, /**<An outgoing call is started */
 209         LinphoneCallOutgoingProgress, /**<An outgoing call is in progress */
 210         LinphoneCallOutgoingRinging, /**<An outgoing call is ringing at remote end */
 211         LinphoneCallOutgoingEarlyMedia, /**<An outgoing call is proposed early media */
 212         LinphoneCallConnected, /**<Connected, the call is answered */
 213         LinphoneCallStreamsRunning, /**<The media streams are established and running*/
 214         LinphoneCallPausing, /**<The call is pausing at the initiative of local end */
 215         LinphoneCallPaused, /**< The call is paused, remote end has accepted the pause */
 216         LinphoneCallResuming, /**<The call is being resumed by local end*/
 217         LinphoneCallRefered, /**<The call is being transfered to another party, resulting in a new outgoing call to follow immediately*/
 218         LinphoneCallError, /**<The call encountered an error*/
 219         LinphoneCallEnd, /**<The call ended normally*/
 220         LinphoneCallPausedByRemote, /**<The call is paused by remote end*/
 221         LinphoneCallUpdatedByRemote, /**<The call's parameters are updated, used for example when video is asked by remote */
 222         LinphoneCallIncomingEarlyMedia /**<We are proposing early media to an incoming call */
 223 } LinphoneCallState;
 224
 225 const char *linphone_call_state_to_string(LinphoneCallState cs);
 226
 227
 228 LinphoneCallState linphone_call_get_state(const LinphoneCall *call);
 229 bool_t linphone_call_asked_to_autoanswer(LinphoneCall *call);
 230 const LinphoneAddress * linphone_core_get_current_call_remote_address(struct _LinphoneCore *lc);
 231 const LinphoneAddress * linphone_call_get_remote_address(const LinphoneCall *call);
 232 char *linphone_call_get_remote_address_as_string(const LinphoneCall *call);
 233 LinphoneCallDir linphone_call_get_dir(const LinphoneCall *call);
 234 void linphone_call_ref(LinphoneCall *call);
 235 void linphone_call_unref(LinphoneCall *call);
 236 LinphoneCallLog *linphone_call_get_call_log(const LinphoneCall *call);
 237 const char *linphone_call_get_refer_to(const LinphoneCall *call);
 238 bool_t linphone_call_has_transfer_pending(const LinphoneCall *call);
 239 int linphone_call_get_duration(const LinphoneCall *call);
 240 const LinphoneCallParams * linphone_call_get_current_params(const LinphoneCall *call);
 241 void linphone_call_enable_camera(LinphoneCall *lc, bool_t enabled);
 242 bool_t linphone_call_camera_enabled(const LinphoneCall *lc);
 243 int linphone_call_take_video_snapshot(LinphoneCall *call, const char *file);
 244 LinphoneReason linphone_call_get_reason(const LinphoneCall *call);
 245 const char *linphone_call_get_remote_user_agent(LinphoneCall *call);
 246 void *linphone_call_get_user_pointer(LinphoneCall *call);
 247 void linphone_call_set_user_pointer(LinphoneCall *call, void *user_pointer);
 248
 249
 250 /**
 251  * @addtogroup proxies
 252  * @{
 253 **/
 254 /**
 255  * The LinphoneProxyConfig object represents a proxy configuration to be used
 256  * by the LinphoneCore object.
 257  * Its fields must not be used directly in favour of the accessors methods.
 258  * Once created and filled properly the LinphoneProxyConfig can be given to
 259  * LinphoneCore with linphone_core_add_proxy_config().
 260  * This will automatically triggers the registration, if enabled.
 261  *
 262  * The proxy configuration are persistent to restarts because they are saved
 263  * in the configuration file. As a consequence, after linphone_core_new() there
 264  * might already be a list of configured proxy that can be examined with
 265  * linphone_core_get_proxy_config_list().
 266  *
 267  * The default proxy (see linphone_core_set_default_proxy() ) is the one of the list
 268  * that is used by default for calls.
 269 **/
 270 typedef struct _LinphoneProxyConfig LinphoneProxyConfig;
 271
 272 /**
 273  * LinphoneRegistrationState describes proxy registration states.
 274 **/
 275 typedef enum _LinphoneRegistrationState{
 276         LinphoneRegistrationNone,
 277         LinphoneRegistrationProgress,
 278         LinphoneRegistrationOk,
 279         LinphoneRegistrationCleared,
 280         LinphoneRegistrationFailed
 281 }LinphoneRegistrationState;
 282
 283 /**
 284  * Human readable version of the #LinphoneRegistrationState
 285  * @param cs sate
 286  */
 287 const char *linphone_registration_state_to_string(LinphoneRegistrationState cs);
 288
 289 LinphoneProxyConfig *linphone_proxy_config_new(void);
 290 int linphone_proxy_config_set_server_addr(LinphoneProxyConfig *obj, const char *server_addr);
 291 int linphone_proxy_config_set_identity(LinphoneProxyConfig *obj, const char *identity);
 292 int linphone_proxy_config_set_route(LinphoneProxyConfig *obj, const char *route);
 293 void linphone_proxy_config_expires(LinphoneProxyConfig *obj, int expires);
 294 /**
 295  * Indicates  either or not, REGISTRATION must be issued for this #LinphoneProxyConfig .
 296  * <br> In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
 297  * @param obj object pointer
 298  * @param val if true, registration will be engaged
 299  */
 300 void linphone_proxy_config_enable_register(LinphoneProxyConfig *obj, bool_t val);
 301 #define linphone_proxy_config_enableregister linphone_proxy_config_enable_register
 302 void linphone_proxy_config_edit(LinphoneProxyConfig *obj);
 303 int linphone_proxy_config_done(LinphoneProxyConfig *obj);
 304 void linphone_proxy_config_enable_publish(LinphoneProxyConfig *obj, bool_t val);
 305 void linphone_proxy_config_set_dial_escape_plus(LinphoneProxyConfig *cfg, bool_t val);
 306 void linphone_proxy_config_set_dial_prefix(LinphoneProxyConfig *cfg, const char *prefix);
 307
 308 LinphoneRegistrationState linphone_proxy_config_get_state(const LinphoneProxyConfig *obj);
 309 bool_t linphone_proxy_config_is_registered(const LinphoneProxyConfig *obj);
 310 const char *linphone_proxy_config_get_domain(const LinphoneProxyConfig *cfg);
 311
 312 const char *linphone_proxy_config_get_route(const LinphoneProxyConfig *obj);
 313 const char *linphone_proxy_config_get_identity(const LinphoneProxyConfig *obj);
 314 bool_t linphone_proxy_config_publish_enabled(const LinphoneProxyConfig *obj);
 315 const char *linphone_proxy_config_get_addr(const LinphoneProxyConfig *obj);
 316 int linphone_proxy_config_get_expires(const LinphoneProxyConfig *obj);
 317 bool_t linphone_proxy_config_register_enabled(const LinphoneProxyConfig *obj);
 318 struct _LinphoneCore * linphone_proxy_config_get_core(const LinphoneProxyConfig *obj);
 319
 320 bool_t linphone_proxy_config_get_dial_escape_plus(const LinphoneProxyConfig *cfg);
 321 const char * linphone_proxy_config_get_dial_prefix(const LinphoneProxyConfig *cfg);
 322
 323 LinphoneReason linphone_proxy_config_get_error(const LinphoneProxyConfig *cfg);
 324
 325 /* destruction is called automatically when removing the proxy config */
 326 void linphone_proxy_config_destroy(LinphoneProxyConfig *cfg);
 327 void linphone_proxy_config_set_sip_setup(LinphoneProxyConfig *cfg, const char *type);
 328 SipSetupContext *linphone_proxy_config_get_sip_setup_context(LinphoneProxyConfig *cfg);
 329 SipSetup *linphone_proxy_config_get_sip_setup(LinphoneProxyConfig *cfg);
 330 /**
 331  * normalize a human readable phone number into a basic string. 888-444-222 becomes 888444222
 332  */
 333 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *proxy, const char *username, char *result, size_t result_len);
 334 /*
 335  *  attached a user data to a proxy config
 336  */
 337 void linphone_proxy_config_set_user_data(LinphoneProxyConfig *cr, void * ud);
 338 /*
 339  *  get user data to a proxy config. return null if any
 340  */
 341 void * linphone_proxy_config_get_user_data(LinphoneProxyConfig *cr);
 342
 343 /**
 344  * @}
 345 **/
 346
 347 typedef struct _LinphoneAccountCreator{
 348         struct _LinphoneCore *lc;
 349         struct _SipSetupContext *ssctx;
 350         char *username;
 351         char *password;
 352         char *domain;
 353         bool_t succeeded;
 354 }LinphoneAccountCreator;
 355
 356 LinphoneAccountCreator *linphone_account_creator_new(struct _LinphoneCore *core, const char *type);
 357 void linphone_account_creator_set_username(LinphoneAccountCreator *obj, const char *username);
 358 void linphone_account_creator_set_password(LinphoneAccountCreator *obj, const char *password);
 359 void linphone_account_creator_set_domain(LinphoneAccountCreator *obj, const char *domain);
 360 const char * linphone_account_creator_get_username(LinphoneAccountCreator *obj);
 361 const char * linphone_account_creator_get_domain(LinphoneAccountCreator *obj);
 362 int linphone_account_creator_test_existence(LinphoneAccountCreator *obj);
 363 LinphoneProxyConfig * linphone_account_creator_validate(LinphoneAccountCreator *obj);
 364 void linphone_account_creator_destroy(LinphoneAccountCreator *obj);
 365
 366 struct _LinphoneAuthInfo;
 367
 368 /**
 369  * @ingroup authentication
 370  * Object holding authentication information.
 371  *
 372  * @note The object's fields should not be accessed directly. Prefer using
 373  * the accessor methods.
 374  *
 375  * In most case, authentication information consists of a username and password.
 376  * Sometimes, a userid is required by proxy, and realm can be useful to discriminate
 377  * different SIP domains.
 378  *
 379  * Once created and filled, a LinphoneAuthInfo must be added to the LinphoneCore in
 380  * order to become known and used automatically when needed.
 381  * Use linphone_core_add_auth_info() for that purpose.
 382  *
 383  * The LinphoneCore object can take the initiative to request authentication information
 384  * when needed to the application through the auth_info_requested callback of the
 385  * LinphoneCoreVTable structure.
 386  *
 387  * The application can respond to this information request later using
 388  * linphone_core_add_auth_info(). This will unblock all pending authentication
 389  * transactions and retry them with authentication headers.
 390  *
 391 **/
 392 typedef struct _LinphoneAuthInfo LinphoneAuthInfo;
 393
 394 LinphoneAuthInfo *linphone_auth_info_new(const char *username, const char *userid,
 395                 const char *passwd, const char *ha1,const char *realm);
 396 void linphone_auth_info_set_passwd(LinphoneAuthInfo *info, const char *passwd);
 397 void linphone_auth_info_set_username(LinphoneAuthInfo *info, const char *username);
 398 void linphone_auth_info_set_userid(LinphoneAuthInfo *info, const char *userid);
 399
 400 const char *linphone_auth_info_get_username(const LinphoneAuthInfo *i);
 401 const char *linphone_auth_info_get_passwd(const LinphoneAuthInfo *i);
 402 const char *linphone_auth_info_get_userid(const LinphoneAuthInfo *i);
 403
 404 /* you don't need those function*/
 405 void linphone_auth_info_destroy(LinphoneAuthInfo *info);
 406 LinphoneAuthInfo * linphone_auth_info_new_from_config_file(struct _LpConfig *config, int pos);
 407
 408
 409 struct _LinphoneChatRoom;
 410 /**
 411  * @addtogroup chatroom
 412  * @{
 413  */
 414 /**
 415  * A chat room is the place where text messages are exchanged.
 416  * <br> Can be created by linphone_core_create_chat_room().
 417  */
 418 typedef struct _LinphoneChatRoom LinphoneChatRoom;
 419 /**
 420  * Create a new chat room for messaging from a sip uri like sip:joe@sip.linphone.org
 421  * @param lc #LinphoneCore object
 422  * @param to destination address for messages
 423  * @return #LinphoneChatRoom where messaging can take place.
 424  */
 425 LinphoneChatRoom * linphone_core_create_chat_room(LinphoneCore *lc, const char *to);
 426 /**
 427  * Destructor
 428  * @param cr #LinphoneChatRoom object
 429  */
 430 void linphone_chat_room_destroy(LinphoneChatRoom *cr);
 431
 432
 433 /**
 434  * get peer address \link linphone_core_create_chat_room() associated to \endlink this #LinphoneChatRoom
 435  * @param cr #LinphoneChatRoom object
 436  * @return #LinphoneAddress peer address
 437  */
 438 const LinphoneAddress* linphone_chat_room_get_peer_address(LinphoneChatRoom *cr);
 439 /**
 440  * send a message to peer member of this chat room.
 441  * @param cr #LinphoneChatRoom object
 442  * @param msg message to be sent
 443  */
 444 void linphone_chat_room_send_message(LinphoneChatRoom *cr, const char *msg);
 445
 446 void linphone_chat_room_set_user_data(LinphoneChatRoom *cr, void * ud);
 447 void * linphone_chat_room_get_user_data(LinphoneChatRoom *cr);
 448
 449 /**
 450  * @}
 451  */
 452 typedef enum _LinphoneGlobalState{
 453         LinphoneGlobalOff,
 454         LinphoneGlobalStartup,
 455         LinphoneGlobalOn,
 456         LinphoneGlobalShutdown
 457 }LinphoneGlobalState;
 458
 459 const char *linphone_global_state_to_string(LinphoneGlobalState gs);
 460
 461 /**
 462  * @addtogroup initializing
 463  * @{
 464 **/
 465
 466
 467 /**Call state notification callback prototype*/
 468 typedef void (*LinphoneGlobalStateCb)(struct _LinphoneCore *lc, LinphoneGlobalState gstate, const char *message);
 469 /**Call state notification callback prototype*/
 470 typedef void (*LinphoneCallStateCb)(struct _LinphoneCore *lc, LinphoneCall *call, LinphoneCallState cstate, const char *message);
 471 /** @ingroup Proxies
 472  * Registration state notification callback prototype
 473  * */
 474 typedef void (*LinphoneRegistrationStateCb)(struct _LinphoneCore *lc, LinphoneProxyConfig *cfg, LinphoneRegistrationState cstate, const char *message);
 475 /** Callback prototype */
 476 typedef void (*ShowInterfaceCb)(struct _LinphoneCore *lc);
 477 /** Callback prototype */
 478 typedef void (*DisplayStatusCb)(struct _LinphoneCore *lc, const char *message);
 479 /** Callback prototype */
 480 typedef void (*DisplayMessageCb)(struct _LinphoneCore *lc, const char *message);
 481 /** Callback prototype */
 482 typedef void (*DisplayUrlCb)(struct _LinphoneCore *lc, const char *message, const char *url);
 483 /** Callback prototype */
 484 typedef void (*LinphoneCoreCbFunc)(struct _LinphoneCore *lc,void * user_data);
 485 /** Callback prototype */
 486 typedef void (*NotifyReceivedCb)(struct _LinphoneCore *lc, LinphoneCall *call, const char *from, const char *event);
 487 /**
 488  * Report status change for a friend previously \link linphone_core_add_friend() added \endlink to #LinphoneCore.
 489  * @param lc #LinphoneCore object .
 490  * @param lf Updated #LinphoneFriend .
 491  */
 492 typedef void (*NotifyPresenceReceivedCb)(struct _LinphoneCore *lc, LinphoneFriend * lf);
 493 /**
 494  *  Reports that a new subscription request has been received and wait for a decision.
 495  *  <br> Status on this subscription request is notified by \link linphone_friend_set_inc_subscribe_policy() changing policy \endlink for this friend
 496  *      @param lc #LinphoneCore object
 497  *      @param lf #LinphoneFriend corresponding to the subscriber
 498  *      @param url of the subscriber
 499  *  Callback prototype
 500  *  */
 501 typedef void (*NewSubscribtionRequestCb)(struct _LinphoneCore *lc, LinphoneFriend *lf, const char *url);
 502 /** Callback prototype */
 503 typedef void (*AuthInfoRequested)(struct _LinphoneCore *lc, const char *realm, const char *username);
 504 /** Callback prototype */
 505 typedef void (*CallLogUpdated)(struct _LinphoneCore *lc, struct _LinphoneCallLog *newcl);
 506 /**
 507  * Callback prototype
 508  *
 509  * @param lc #LinphoneCore object
 510  * @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.
 511  * @param from #LinphoneAddress from
 512  * @param message incoming message
 513  *  */
 514 typedef void (*TextMessageReceived)(LinphoneCore *lc, LinphoneChatRoom *room, const LinphoneAddress *from, const char *message);
 515 /** Callback prototype */
 516 typedef void (*DtmfReceived)(struct _LinphoneCore* lc, LinphoneCall *call, int dtmf);
 517 /** Callback prototype */
 518 typedef void (*ReferReceived)(struct _LinphoneCore *lc, const char *refer_to);
 519 /** Callback prototype */
 520 typedef void (*BuddyInfoUpdated)(struct _LinphoneCore *lc, LinphoneFriend *lf);
 521
 522 /**
 523  * This structure holds all callbacks that the application should implement.
 524  *  None is mandatory.
 525 **/
 526 typedef struct _LinphoneVTable{
 527         LinphoneGlobalStateCb global_state_changed; /**<Notifies globlal state changes*/
 528         LinphoneRegistrationStateCb registration_state_changed;/**<Notifies registration state changes*/
 529         LinphoneCallStateCb call_state_changed;/**<Notifies call state changes*/
 530         NotifyPresenceReceivedCb notify_presence_recv; /**< Notify received presence events*/
 531         NewSubscribtionRequestCb new_subscription_request; /**< Notify about pending subscription request */
 532         AuthInfoRequested auth_info_requested; /**< Ask the application some authentication information */
 533         CallLogUpdated call_log_updated; /**< Notifies that call log list has been updated */
 534         TextMessageReceived text_received; /**< A text message has been received */
 535         DtmfReceived dtmf_received; /**< A dtmf has been received received */
 536         ReferReceived refer_received; /**< An out of call refer was received */
 537         BuddyInfoUpdated buddy_info_updated; /**< a LinphoneFriend's BuddyInfo has changed*/
 538         NotifyReceivedCb notify_recv; /**< Other notifications*/
 539         DisplayStatusCb display_status; /**< Callback that notifies various events with human readable text.*/
 540         DisplayMessageCb display_message;/**< Callback to display a message to the user */
 541         DisplayMessageCb display_warning;/** Callback to display a warning to the user */
 542         DisplayUrlCb display_url;
 543         ShowInterfaceCb show; /**< Notifies the application that it should show up*/
 544 } LinphoneCoreVTable;
 545
 546 /**
 547  * @}
 548 **/
 549
 550 typedef struct _LCCallbackObj
 551 {
 552   LinphoneCoreCbFunc _func;
 553   void * _user_data;
 554 }LCCallbackObj;
 555
 556
 557
 558 typedef enum _LinphoneFirewallPolicy{
 559         LinphonePolicyNoFirewall,
 560         LinphonePolicyUseNatAddress,
 561         LinphonePolicyUseStun
 562 } LinphoneFirewallPolicy;
 563
 564 typedef enum _LinphoneWaitingState{
 565         LinphoneWaitingStart,
 566         LinphoneWaitingProgress,
 567         LinphoneWaitingFinished
 568 } LinphoneWaitingState;
 569 typedef void * (*LinphoneWaitingCallback)(struct _LinphoneCore *lc, void *context, LinphoneWaitingState ws, const char *purpose, float progress);
 570
 571
 572 /* THE main API */
 573
 574 void linphone_core_enable_logs(FILE *file);
 575 void linphone_core_enable_logs_with_cb(OrtpLogFunc logfunc);
 576 void linphone_core_disable_logs(void);
 577 /*sets the user-agent string in sip messages, must be set before linphone_core_new() or linphone_core_init() */
 578 void linphone_core_set_user_agent(const char *ua_name, const char *version);
 579 const char *linphone_core_get_version(void);
 580
 581 LinphoneCore *linphone_core_new(const LinphoneCoreVTable *vtable,
 582                                                 const char *config_path, const char *factory_config, void* userdata);
 583
 584 /* function to be periodically called in a main loop */
 585 void linphone_core_iterate(LinphoneCore *lc);
 586
 587 LinphoneAddress * linphone_core_interpret_url(LinphoneCore *lc, const char *url);
 588
 589 LinphoneCall * linphone_core_invite(LinphoneCore *lc, const char *url);
 590
 591 LinphoneCall * linphone_core_invite_address(LinphoneCore *lc, const LinphoneAddress *addr);
 592
 593 LinphoneCall * linphone_core_invite_with_params(LinphoneCore *lc, const char *url, const LinphoneCallParams *params);
 594
 595 LinphoneCall * linphone_core_invite_address_with_params(LinphoneCore *lc, const LinphoneAddress *addr, const LinphoneCallParams *params);
 596
 597 int linphone_core_transfer_call(LinphoneCore *lc, LinphoneCall *call, const char *refer_to);
 598
 599 int linphone_core_transfer_call_to_another(LinphoneCore *lc, LinphoneCall *call, LinphoneCall *dest);
 600
 601 bool_t linphone_core_inc_invite_pending(LinphoneCore*lc);
 602
 603 bool_t linphone_core_in_call(const LinphoneCore *lc);
 604
 605 LinphoneCall *linphone_core_get_current_call(const LinphoneCore *lc);
 606
 607 int linphone_core_accept_call(LinphoneCore *lc, LinphoneCall *call);
 608
 609 int linphone_core_terminate_call(LinphoneCore *lc, LinphoneCall *call);
 610
 611 int linphone_core_terminate_all_calls(LinphoneCore *lc);
 612
 613 int linphone_core_pause_call(LinphoneCore *lc, LinphoneCall *call);
 614
 615 int linphone_core_pause_all_calls(LinphoneCore *lc);
 616
 617 int linphone_core_resume_call(LinphoneCore *lc, LinphoneCall *call);
 618
 619 int linphone_core_update_call(LinphoneCore *lc, LinphoneCall *call, LinphoneCallParams *params);
 620
 621 LinphoneCallParams *linphone_core_create_default_call_parameters(LinphoneCore *lc);
 622
 623 LinphoneCall *linphone_core_get_call_by_remote_address(LinphoneCore *lc, const char *remote_address);
 624
 625 void linphone_core_send_dtmf(LinphoneCore *lc,char dtmf);
 626
 627 int linphone_core_set_primary_contact(LinphoneCore *lc, const char *contact);
 628
 629 const char *linphone_core_get_primary_contact(LinphoneCore *lc);
 630
 631 const char * linphone_core_get_identity(LinphoneCore *lc);
 632
 633 void linphone_core_set_guess_hostname(LinphoneCore *lc, bool_t val);
 634 bool_t linphone_core_get_guess_hostname(LinphoneCore *lc);
 635
 636 bool_t linphone_core_ipv6_enabled(LinphoneCore *lc);
 637 void linphone_core_enable_ipv6(LinphoneCore *lc, bool_t val);
 638
 639 LinphoneAddress *linphone_core_get_primary_contact_parsed(LinphoneCore *lc);
 640 const char * linphone_core_get_identity(LinphoneCore *lc);
 641 /*0= no bandwidth limit*/
 642 void linphone_core_set_download_bandwidth(LinphoneCore *lc, int bw);
 643 void linphone_core_set_upload_bandwidth(LinphoneCore *lc, int bw);
 644
 645 int linphone_core_get_download_bandwidth(const LinphoneCore *lc);
 646 int linphone_core_get_upload_bandwidth(const LinphoneCore *lc);
 647 /**
 648  * set audio packetization time linphone expect to received from peer
 649  * @ingroup media_parameters
 650  *
 651  */
 652 void linphone_core_set_download_ptime(LinphoneCore *lc, int ptime);
 653 /**
 654  * get audio packetization time linphone expect to received from peer, 0 means unspecified
 655  * @ingroup media_parameters
 656  */
 657 int  linphone_core_get_download_ptime(LinphoneCore *lc);
 658
 659 /* returns a MSList of PayloadType */
 660 const MSList *linphone_core_get_audio_codecs(const LinphoneCore *lc);
 661
 662 int linphone_core_set_audio_codecs(LinphoneCore *lc, MSList *codecs);
 663 /* returns a MSList of PayloadType */
 664 const MSList *linphone_core_get_video_codecs(const LinphoneCore *lc);
 665
 666 int linphone_core_set_video_codecs(LinphoneCore *lc, MSList *codecs);
 667
 668 bool_t linphone_core_payload_type_enabled(LinphoneCore *lc, PayloadType *pt);
 669
 670 int linphone_core_enable_payload_type(LinphoneCore *lc, PayloadType *pt, bool_t enable);
 671
 672 PayloadType* linphone_core_find_payload_type(LinphoneCore* lc, const char* type, int rate) ;
 673
 674 const char *linphone_core_get_payload_type_description(LinphoneCore *lc, PayloadType *pt);
 675
 676 bool_t linphone_core_check_payload_type_usability(LinphoneCore *lc, PayloadType *pt);
 677
 678 int linphone_core_add_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
 679
 680 void linphone_core_clear_proxy_config(LinphoneCore *lc);
 681
 682 void linphone_core_remove_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
 683
 684 const MSList *linphone_core_get_proxy_config_list(const LinphoneCore *lc);
 685
 686 void linphone_core_set_default_proxy(LinphoneCore *lc, LinphoneProxyConfig *config);
 687
 688 void linphone_core_set_default_proxy_index(LinphoneCore *lc, int index);
 689
 690 int linphone_core_get_default_proxy(LinphoneCore *lc, LinphoneProxyConfig **config);
 691
 692 void linphone_core_add_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
 693
 694 void linphone_core_remove_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
 695
 696 const MSList *linphone_core_get_auth_info_list(const LinphoneCore *lc);
 697
 698 const LinphoneAuthInfo *linphone_core_find_auth_info(LinphoneCore *lc, const char *realm, const char *username);
 699
 700 void linphone_core_abort_authentication(LinphoneCore *lc,  LinphoneAuthInfo *info);
 701
 702 void linphone_core_clear_all_auth_info(LinphoneCore *lc);
 703
 704 int linphone_core_get_audio_jittcomp(LinphoneCore *lc);
 705
 706 void linphone_core_set_audio_jittcomp(LinphoneCore *lc, int value);
 707
 708 int linphone_core_get_audio_port(const LinphoneCore *lc);
 709
 710 int linphone_core_get_video_port(const LinphoneCore *lc);
 711
 712 int linphone_core_get_nortp_timeout(const LinphoneCore *lc);
 713
 714 void linphone_core_set_audio_port(LinphoneCore *lc, int port);
 715
 716 void linphone_core_set_video_port(LinphoneCore *lc, int port);
 717
 718 void linphone_core_set_nortp_timeout(LinphoneCore *lc, int port);
 719
 720 void linphone_core_set_use_info_for_dtmf(LinphoneCore *lc, bool_t use_info);
 721
 722 bool_t linphone_core_get_use_info_for_dtmf(LinphoneCore *lc);
 723
 724 void linphone_core_set_use_rfc2833_for_dtmf(LinphoneCore *lc,bool_t use_rfc2833);
 725
 726 bool_t linphone_core_get_use_rfc2833_for_dtmf(LinphoneCore *lc);
 727
 728 void linphone_core_set_sip_port(LinphoneCore *lc, int port);
 729
 730 int linphone_core_get_sip_port(LinphoneCore *lc);
 731
 732 int linphone_core_set_sip_transports(LinphoneCore *lc, const LCSipTransports *transports);
 733
 734 int linphone_core_get_sip_transports(LinphoneCore *lc, LCSipTransports *transports);
 735
 736 ortp_socket_t linphone_core_get_sip_socket(LinphoneCore *lc);
 737
 738 void linphone_core_set_inc_timeout(LinphoneCore *lc, int seconds);
 739
 740 int linphone_core_get_inc_timeout(LinphoneCore *lc);
 741
 742 void linphone_core_set_stun_server(LinphoneCore *lc, const char *server);
 743
 744 const char * linphone_core_get_stun_server(const LinphoneCore *lc);
 745
 746 void linphone_core_set_nat_address(LinphoneCore *lc, const char *addr);
 747
 748 const char *linphone_core_get_nat_address(const LinphoneCore *lc);
 749
 750 void linphone_core_set_firewall_policy(LinphoneCore *lc, LinphoneFirewallPolicy pol);
 751
 752 LinphoneFirewallPolicy linphone_core_get_firewall_policy(const LinphoneCore *lc);
 753
 754 const char * linphone_core_get_relay_addr(const LinphoneCore *lc);
 755
 756 int linphone_core_set_relay_addr(LinphoneCore *lc, const char *addr);
 757
 758 /* sound functions */
 759 /* returns a null terminated static array of string describing the sound devices */
 760 const char**  linphone_core_get_sound_devices(LinphoneCore *lc);
 761 bool_t linphone_core_sound_device_can_capture(LinphoneCore *lc, const char *device);
 762 bool_t linphone_core_sound_device_can_playback(LinphoneCore *lc, const char *device);
 763 int linphone_core_get_ring_level(LinphoneCore *lc);
 764 int linphone_core_get_play_level(LinphoneCore *lc);
 765 int linphone_core_get_rec_level(LinphoneCore *lc);
 766 void linphone_core_set_ring_level(LinphoneCore *lc, int level);
 767 void linphone_core_set_play_level(LinphoneCore *lc, int level);
 768
 769 void linphone_core_set_playback_gain_db(LinphoneCore *lc, float level);
 770
 771 float linphone_core_get_playback_gain_db(LinphoneCore *lc);
 772 void linphone_core_set_rec_level(LinphoneCore *lc, int level);
 773 const char * linphone_core_get_ringer_device(LinphoneCore *lc);
 774 const char * linphone_core_get_playback_device(LinphoneCore *lc);
 775 const char * linphone_core_get_capture_device(LinphoneCore *lc);
 776 int linphone_core_set_ringer_device(LinphoneCore *lc, const char * devid);
 777 int linphone_core_set_playback_device(LinphoneCore *lc, const char * devid);
 778 int linphone_core_set_capture_device(LinphoneCore *lc, const char * devid);
 779 char linphone_core_get_sound_source(LinphoneCore *lc);
 780 void linphone_core_set_sound_source(LinphoneCore *lc, char source);
 781 void linphone_core_set_ring(LinphoneCore *lc, const char *path);
 782 const char *linphone_core_get_ring(const LinphoneCore *lc);
 783 void linphone_core_set_ringback(LinphoneCore *lc, const char *path);
 784 const char * linphone_core_get_ringback(const LinphoneCore *lc);
 785
 786 void linphone_core_set_remote_ringback_tone(LinphoneCore *lc,const char *);
 787 const char *linphone_core_get_remote_ringback_tone(const LinphoneCore *lc);
 788
 789 int linphone_core_preview_ring(LinphoneCore *lc, const char *ring,LinphoneCoreCbFunc func,void * userdata);
 790 void linphone_core_enable_echo_cancellation(LinphoneCore *lc, bool_t val);
 791 bool_t linphone_core_echo_cancellation_enabled(LinphoneCore *lc);
 792
 793 void linphone_core_enable_echo_limiter(LinphoneCore *lc, bool_t val);
 794 bool_t linphone_core_echo_limiter_enabled(const LinphoneCore *lc);
 795
 796 void linphone_core_enable_agc(LinphoneCore *lc, bool_t val);
 797 bool_t linphone_core_agc_enabled(const LinphoneCore *lc);
 798
 799 void linphone_core_mute_mic(LinphoneCore *lc, bool_t muted);
 800 /**
 801  * return mic state.
 802  *
 803  * @ingroup media_parameters
 804 **/
 805 bool_t linphone_core_is_mic_muted(LinphoneCore *lc);
 806
 807 bool_t linphone_core_is_audio_muted(LinphoneCore *lc);
 808 bool_t linphone_core_is_rtp_muted(LinphoneCore *lc);
 809
 810 bool_t linphone_core_get_rtp_no_xmit_on_audio_mute(const LinphoneCore *lc);
 811 void linphone_core_set_rtp_no_xmit_on_audio_mute(LinphoneCore *lc, bool_t val);
 812
 813
 814 /* returns a list of LinphoneCallLog */
 815 const MSList * linphone_core_get_call_logs(LinphoneCore *lc);
 816 void linphone_core_clear_call_logs(LinphoneCore *lc);
 817
 818 /* video support */
 819 void linphone_core_enable_video(LinphoneCore *lc, bool_t vcap_enabled, bool_t display_enabled);
 820 bool_t linphone_core_video_enabled(LinphoneCore *lc);
 821
 822 typedef struct MSVideoSizeDef{
 823         MSVideoSize vsize;
 824         const char *name;
 825 }MSVideoSizeDef;
 826 /* returns a zero terminated table of MSVideoSizeDef*/
 827 const MSVideoSizeDef *linphone_core_get_supported_video_sizes(LinphoneCore *lc);
 828 void linphone_core_set_preferred_video_size(LinphoneCore *lc, MSVideoSize vsize);
 829 MSVideoSize linphone_core_get_preferred_video_size(LinphoneCore *lc);
 830 void linphone_core_set_preferred_video_size_by_name(LinphoneCore *lc, const char *name);
 831
 832 void linphone_core_enable_video_preview(LinphoneCore *lc, bool_t val);
 833 bool_t linphone_core_video_preview_enabled(const LinphoneCore *lc);
 834
 835 void linphone_core_enable_self_view(LinphoneCore *lc, bool_t val);
 836 bool_t linphone_core_self_view_enabled(const LinphoneCore *lc);
 837
 838
 839 /* returns a null terminated static array of string describing the webcams */
 840 const char**  linphone_core_get_video_devices(const LinphoneCore *lc);
 841 int linphone_core_set_video_device(LinphoneCore *lc, const char *id);
 842 const char *linphone_core_get_video_device(const LinphoneCore *lc);
 843
 844 /* Set static picture to be used when "Static picture" is the video device */
 845 int linphone_core_set_static_picture(LinphoneCore *lc, const char *path);
 846
 847 /* Set and get frame rate for static picture */
 848 int linphone_core_set_static_picture_fps(LinphoneCore *lc, float fps);
 849 float linphone_core_get_static_picture_fps(LinphoneCore *lc);
 850
 851 /*function to be used for eventually setting window decorations (icons, title...)*/
 852 unsigned long linphone_core_get_native_video_window_id(const LinphoneCore *lc);
 853 void linphone_core_set_native_video_window_id(LinphoneCore *lc, unsigned long id);
 854
 855 unsigned long linphone_core_get_native_preview_window_id(const LinphoneCore *lc);
 856 void linphone_core_set_native_preview_window_id(LinphoneCore *lc, unsigned long id);
 857
 858 void linphone_core_use_preview_window(LinphoneCore *lc, bool_t yesno);
 859
 860 /*play/record support: use files instead of soundcard*/
 861 void linphone_core_use_files(LinphoneCore *lc, bool_t yesno);
 862 void linphone_core_set_play_file(LinphoneCore *lc, const char *file);
 863 void linphone_core_set_record_file(LinphoneCore *lc, const char *file);
 864
 865 void linphone_core_play_dtmf(LinphoneCore *lc, char dtmf, int duration_ms);
 866 void linphone_core_stop_dtmf(LinphoneCore *lc);
 867
 868 int linphone_core_get_current_call_duration(const LinphoneCore *lc);
 869
 870
 871 int linphone_core_get_mtu(const LinphoneCore *lc);
 872 void linphone_core_set_mtu(LinphoneCore *lc, int mtu);
 873
 874 /**
 875  * This method is called by the application to notify the linphone core library when network is reachable.
 876  * Calling this method with true trigger linphone to initiate a registration process for all proxy
 877  * configuration with parameter register set to enable.
 878  * This method disable the automatic registration mode. It means you must call this method after each network state changes
 879  *
 880  */
 881 void linphone_core_set_network_reachable(LinphoneCore* lc,bool_t value);
 882 /**
 883  * return network state either as positioned by the application or by linphone
 884  */
 885 bool_t linphone_core_is_network_reachabled(LinphoneCore* lc);
 886
 887
 888 void *linphone_core_get_user_data(LinphoneCore *lc);
 889
 890 /* returns LpConfig object to read/write to the config file: usefull if you wish to extend
 891 the config file with your own sections */
 892 struct _LpConfig *linphone_core_get_config(LinphoneCore *lc);
 893
 894 /* attempts to wake up another linphone engine already running.
 895 The "show" callback is called for the other linphone, causing gui to show up.
 896 call_addr is an optional sip-uri to call immediately after waking up.
 897 The method returns 0 if an already running linphone was found*/
 898
 899 int linphone_core_wake_up_possible_already_running_instance(
 900     const char * config_file, const char * call_addr);
 901
 902 /*set a callback for some blocking operations, it takes you informed of the progress of the operation*/
 903 void linphone_core_set_waiting_callback(LinphoneCore *lc, LinphoneWaitingCallback cb, void *user_context);
 904
 905 /*returns the list of registered SipSetup (linphonecore plugins) */
 906 const MSList * linphone_core_get_sip_setups(LinphoneCore *lc);
 907
 908 void linphone_core_destroy(LinphoneCore *lc);
 909
 910 /*for advanced users:*/
 911 void linphone_core_set_audio_transports(LinphoneCore *lc, RtpTransport *rtp, RtpTransport *rtcp);
 912
 913 int linphone_core_get_current_call_stats(LinphoneCore *lc, rtp_stats_t *local, rtp_stats_t *remote);
 914
 915 const MSList *linphone_core_get_calls(LinphoneCore *lc);
 916
 917 LinphoneGlobalState linphone_core_get_global_state(const LinphoneCore *lc);
 918
 919 #ifdef __cplusplus
 920 }
 921 #endif
 922
 923
 924
 925 #endif