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 struct SalOp;
  43
  44 struct _LpConfig;
  45
  46
  47 struct _LCSipTransports{
  48         int udp_port;
  49         int tcp_port;
  50         int dtls_port;
  51         int tls_port;
  52 };
  53
  54 typedef struct _LCSipTransports LCSipTransports;
  55
  56 /**
  57  * Object that represents a SIP address.
  58  *
  59  * The LinphoneAddress is an opaque object to represents SIP addresses, ie
  60  * the content of SIP's 'from' and 'to' headers.
  61  * A SIP address is made of display name, username, domain name, port, and various
  62  * uri headers (such as tags). It looks like 'Alice <sip:alice@example.net>'.
  63  * The LinphoneAddress has methods to extract and manipulate all parts of the address.
  64  * When some part of the address (for example the username) is empty, the accessor methods
  65  * return NULL.
  66  *
  67  * @ingroup linphone_address
  68  * @var LinphoneAddress
  69  */
  70 typedef struct SalAddress LinphoneAddress;
  71
  72 LinphoneAddress * linphone_address_new(const char *uri);
  73 LinphoneAddress * linphone_address_clone(const LinphoneAddress *uri);
  74 const char *linphone_address_get_scheme(const LinphoneAddress *u);
  75 const char *linphone_address_get_display_name(const LinphoneAddress* u);
  76 const char *linphone_address_get_username(const LinphoneAddress *u);
  77 const char *linphone_address_get_domain(const LinphoneAddress *u);
  78 /**
  79  * Get port number as an integer value.
  80  *
  81  */
  82 int linphone_address_get_port_int(const LinphoneAddress *u);
  83 /**
  84  * Get port number, null if not present.
  85  */
  86 const char* linphone_address_get_port(const LinphoneAddress *u);
  87 void linphone_address_set_display_name(LinphoneAddress *u, const char *display_name);
  88 void linphone_address_set_username(LinphoneAddress *uri, const char *username);
  89 void linphone_address_set_domain(LinphoneAddress *uri, const char *host);
  90 void linphone_address_set_port(LinphoneAddress *uri, const char *port);
  91 void linphone_address_set_port_int(LinphoneAddress *uri, int port);
  92 /*remove tags, params etc... so that it is displayable to the user*/
  93 void linphone_address_clean(LinphoneAddress *uri);
  94 char *linphone_address_as_string(const LinphoneAddress *u);
  95 char *linphone_address_as_string_uri_only(const LinphoneAddress *u);
  96 void linphone_address_destroy(LinphoneAddress *u);
  97
  98 struct _SipSetupContext;
  99
 100
 101 /**
 102  * Enum representing the direction of a call.
 103  * @ingroup call_logs
 104 **/
 105 enum _LinphoneCallDir {
 106         LinphoneCallOutgoing, /**< outgoing calls*/
 107         LinphoneCallIncoming  /**< incoming calls*/
 108 };
 109
 110 /**
 111  * Typedef for enum
 112  * @ingroup call_logs
 113 **/
 114 typedef enum _LinphoneCallDir LinphoneCallDir;
 115
 116 /**
 117  * Enum representing the status of a call
 118  * @ingroup call_logs
 119 **/
 120 typedef enum _LinphoneCallStatus {
 121         LinphoneCallSuccess, /**< The call was sucessful*/
 122         LinphoneCallAborted, /**< The call was aborted */
 123         LinphoneCallMissed /**< The call was missed (unanswered)*/
 124 } LinphoneCallStatus;
 125
 126 /**
 127  * Structure representing a call log.
 128  *
 129  * @ingroup call_logs
 130  *
 131 **/
 132 typedef struct _LinphoneCallLog{
 133         LinphoneCallDir dir; /**< The direction of the call*/
 134         LinphoneCallStatus status; /**< The status of the call*/
 135         LinphoneAddress *from; /**<Originator of the call as a LinphoneAddress object*/
 136         LinphoneAddress *to; /**<Destination of the call as a LinphoneAddress object*/
 137         char start_date[128]; /**<Human readable string containg the start date*/
 138         int duration; /**<Duration of the call in seconds*/
 139         char *refkey;
 140         void *user_pointer;
 141         rtp_stats_t local_stats;
 142         rtp_stats_t remote_stats;
 143         struct _LinphoneCore *lc;
 144 } LinphoneCallLog;
 145
 146
 147
 148 /*public: */
 149 void linphone_call_log_set_user_pointer(LinphoneCallLog *cl, void *up);
 150 void *linphone_call_log_get_user_pointer(const LinphoneCallLog *cl);
 151 void linphone_call_log_set_ref_key(LinphoneCallLog *cl, const char *refkey);
 152 const char *linphone_call_log_get_ref_key(const LinphoneCallLog *cl);
 153 const rtp_stats_t *linphone_call_log_get_local_stats(const LinphoneCallLog *cl);
 154 const rtp_stats_t *linphone_call_log_get_remote_stats(const LinphoneCallLog *cl);
 155 char * linphone_call_log_to_str(LinphoneCallLog *cl);
 156
 157
 158 /**
 159  * The LinphoneCall object represents a call issued or received by the LinphoneCore
 160 **/
 161 struct _LinphoneCall;
 162 typedef struct _LinphoneCall LinphoneCall;
 163
 164 typedef enum _LinphoneCallState{
 165         LinphoneCallInit,
 166         LinphoneCallPreEstablishing,
 167         LinphoneCallRinging,
 168         LinphoneCallAVRunning,
 169         LinphoneCallPaused,
 170         LinphoneCallTerminated
 171 }LinphoneCallState;
 172
 173 LinphoneCallState linphone_call_get_state(const LinphoneCall *call);
 174 bool_t linphone_call_asked_to_autoanswer(LinphoneCall *call);
 175 bool_t linphone_call_paused(LinphoneCall *call);
 176 const LinphoneAddress * linphone_core_get_current_call_remote_address(struct _LinphoneCore *lc);
 177 const LinphoneAddress * linphone_call_get_remote_address(const LinphoneCall *call);
 178 char *linphone_call_get_remote_address_as_string(const LinphoneCall *call);
 179 void linphone_call_ref(LinphoneCall *call);
 180 void linphone_call_unref(LinphoneCall *call);
 181 LinphoneCallLog *linphone_call_get_call_log(const LinphoneCall *call);
 182 void *linphone_call_get_user_pointer(LinphoneCall *call);
 183 void linphone_call_set_user_pointer(LinphoneCall *call, void *user_pointer);
 184
 185 typedef enum{
 186         LinphoneSPWait,
 187         LinphoneSPDeny,
 188         LinphoneSPAccept
 189 }LinphoneSubscribePolicy;
 190
 191 typedef enum _LinphoneOnlineStatus{
 192         LINPHONE_STATUS_OFFLINE,
 193         LINPHONE_STATUS_ONLINE,
 194         LINPHONE_STATUS_BUSY,
 195         LINPHONE_STATUS_BERIGHTBACK,
 196         LINPHONE_STATUS_AWAY,
 197         LINPHONE_STATUS_ONTHEPHONE,
 198         LINPHONE_STATUS_OUTTOLUNCH,
 199         LINPHONE_STATUS_NOT_DISTURB,
 200         LINPHONE_STATUS_MOVED,
 201         LINPHONE_STATUS_ALT_SERVICE,
 202         LINPHONE_STATUS_PENDING,
 203         LINPHONE_STATUS_END
 204 }LinphoneOnlineStatus;
 205
 206 const char *linphone_online_status_to_string(LinphoneOnlineStatus ss);
 207
 208 struct _LinphoneFriend;
 209
 210 typedef struct _LinphoneFriend LinphoneFriend;
 211
 212 LinphoneFriend * linphone_friend_new();
 213 LinphoneFriend *linphone_friend_new_with_addr(const char *addr);
 214 int linphone_friend_set_sip_addr(LinphoneFriend *fr, const char *uri);
 215 int linphone_friend_set_name(LinphoneFriend *fr, const char *name);
 216 int linphone_friend_send_subscribe(LinphoneFriend *fr, bool_t val);
 217 int linphone_friend_set_inc_subscribe_policy(LinphoneFriend *fr, LinphoneSubscribePolicy pol);
 218 void linphone_friend_edit(LinphoneFriend *fr);
 219 void linphone_friend_done(LinphoneFriend *fr);
 220 void linphone_friend_destroy(LinphoneFriend *lf);
 221 const LinphoneAddress *linphone_friend_get_address(const LinphoneFriend *lf);
 222 bool_t linphone_friend_get_send_subscribe(const LinphoneFriend *lf);
 223 LinphoneSubscribePolicy linphone_friend_get_inc_subscribe_policy(const LinphoneFriend *lf);
 224 LinphoneOnlineStatus linphone_friend_get_status(const LinphoneFriend *lf);
 225 BuddyInfo * linphone_friend_get_info(const LinphoneFriend *lf);
 226 void linphone_friend_set_ref_key(LinphoneFriend *lf, const char *key);
 227 const char *linphone_friend_get_ref_key(const LinphoneFriend *lf);
 228 bool_t linphone_friend_in_list(const LinphoneFriend *lf);
 229
 230 #define linphone_friend_url(lf) ((lf)->url)
 231
 232
 233 /**
 234  * @addtogroup proxies
 235  * @{
 236 **/
 237 /**
 238  * The LinphoneProxyConfig object represents a proxy configuration to be used
 239  * by the LinphoneCore object.
 240  * Its fields must not be used directly in favour of the accessors methods.
 241  * Once created and filled properly the LinphoneProxyConfig can be given to
 242  * LinphoneCore with linphone_core_add_proxy_config().
 243  * This will automatically triggers the registration, if enabled.
 244  *
 245  * The proxy configuration are persistent to restarts because they are saved
 246  * in the configuration file. As a consequence, after linphone_core_new() there
 247  * might already be a list of configured proxy that can be examined with
 248  * linphone_core_get_proxy_config_list().
 249  *
 250  * The default proxy (see linphone_core_set_default_proxy() ) is the one of the list
 251  * that is used by default for calls.
 252 **/
 253 typedef struct _LinphoneProxyConfig LinphoneProxyConfig;
 254
 255 LinphoneProxyConfig *linphone_proxy_config_new(void);
 256 int linphone_proxy_config_set_server_addr(LinphoneProxyConfig *obj, const char *server_addr);
 257 int linphone_proxy_config_set_identity(LinphoneProxyConfig *obj, const char *identity);
 258 int linphone_proxy_config_set_route(LinphoneProxyConfig *obj, const char *route);
 259 void linphone_proxy_config_expires(LinphoneProxyConfig *obj, int expires);
 260 void linphone_proxy_config_enable_register(LinphoneProxyConfig *obj, bool_t val);
 261 #define linphone_proxy_config_enableregister linphone_proxy_config_enable_register
 262 void linphone_proxy_config_edit(LinphoneProxyConfig *obj);
 263 int linphone_proxy_config_done(LinphoneProxyConfig *obj);
 264 void linphone_proxy_config_enable_publish(LinphoneProxyConfig *obj, bool_t val);
 265 void linphone_proxy_config_set_dial_escape_plus(LinphoneProxyConfig *cfg, bool_t val);
 266 void linphone_proxy_config_set_dial_prefix(LinphoneProxyConfig *cfg, const char *prefix);
 267
 268 bool_t linphone_proxy_config_is_registered(const LinphoneProxyConfig *obj);
 269 const char *linphone_proxy_config_get_domain(const LinphoneProxyConfig *cfg);
 270
 271 const char *linphone_proxy_config_get_route(const LinphoneProxyConfig *obj);
 272 const char *linphone_proxy_config_get_identity(const LinphoneProxyConfig *obj);
 273 bool_t linphone_proxy_config_publish_enabled(const LinphoneProxyConfig *obj);
 274 const char *linphone_proxy_config_get_addr(const LinphoneProxyConfig *obj);
 275 int linphone_proxy_config_get_expires(const LinphoneProxyConfig *obj);
 276 bool_t linphone_proxy_config_register_enabled(const LinphoneProxyConfig *obj);
 277 struct _LinphoneCore * linphone_proxy_config_get_core(const LinphoneProxyConfig *obj);
 278
 279 bool_t linphone_proxy_config_get_dial_escape_plus(const LinphoneProxyConfig *cfg);
 280 const char * linphone_proxy_config_get_dial_prefix(const LinphoneProxyConfig *cfg);
 281
 282 /* destruction is called automatically when removing the proxy config */
 283 void linphone_proxy_config_destroy(LinphoneProxyConfig *cfg);
 284 void linphone_proxy_config_set_sip_setup(LinphoneProxyConfig *cfg, const char *type);
 285 SipSetupContext *linphone_proxy_config_get_sip_setup_context(LinphoneProxyConfig *cfg);
 286 SipSetup *linphone_proxy_config_get_sip_setup(LinphoneProxyConfig *cfg);
 287 /**
 288  * normalize a human readable phone number into a basic string. 888-444-222 becomes 888444222
 289  */
 290 int linphone_proxy_config_normalize_number(LinphoneProxyConfig *proxy, const char *username, char *result, size_t result_len);
 291 /*
 292  *  attached a user data to a proxy config
 293  */
 294 void linphone_proxy_config_set_user_data(LinphoneProxyConfig *cr, void * ud);
 295 /*
 296  *  get user data to a proxy config. return null if any
 297  */
 298 void * linphone_proxy_config_get_user_data(LinphoneProxyConfig *cr);
 299
 300 /**
 301  * @}
 302 **/
 303
 304 typedef struct _LinphoneAccountCreator{
 305         struct _LinphoneCore *lc;
 306         struct _SipSetupContext *ssctx;
 307         char *username;
 308         char *password;
 309         char *domain;
 310         bool_t succeeded;
 311 }LinphoneAccountCreator;
 312
 313 LinphoneAccountCreator *linphone_account_creator_new(struct _LinphoneCore *core, const char *type);
 314 void linphone_account_creator_set_username(LinphoneAccountCreator *obj, const char *username);
 315 void linphone_account_creator_set_password(LinphoneAccountCreator *obj, const char *password);
 316 void linphone_account_creator_set_domain(LinphoneAccountCreator *obj, const char *domain);
 317 const char * linphone_account_creator_get_username(LinphoneAccountCreator *obj);
 318 const char * linphone_account_creator_get_domain(LinphoneAccountCreator *obj);
 319 int linphone_account_creator_test_existence(LinphoneAccountCreator *obj);
 320 LinphoneProxyConfig * linphone_account_creator_validate(LinphoneAccountCreator *obj);
 321 void linphone_account_creator_destroy(LinphoneAccountCreator *obj);
 322
 323 struct _LinphoneAuthInfo;
 324
 325 /**
 326  * @ingroup authentication
 327  * Object holding authentication information.
 328  *
 329  * @note The object's fields should not be accessed directly. Prefer using
 330  * the accessor methods.
 331  *
 332  * In most case, authentication information consists of a username and password.
 333  * Sometimes, a userid is required by proxy, and realm can be useful to discriminate
 334  * different SIP domains.
 335  *
 336  * Once created and filled, a LinphoneAuthInfo must be added to the LinphoneCore in
 337  * order to become known and used automatically when needed.
 338  * Use linphone_core_add_auth_info() for that purpose.
 339  *
 340  * The LinphoneCore object can take the initiative to request authentication information
 341  * when needed to the application through the auth_info_requested callback of the
 342  * LinphoneCoreVTable structure.
 343  *
 344  * The application can respond to this information request later using
 345  * linphone_core_add_auth_info(). This will unblock all pending authentication
 346  * transactions and retry them with authentication headers.
 347  *
 348 **/
 349 typedef struct _LinphoneAuthInfo LinphoneAuthInfo;
 350
 351 LinphoneAuthInfo *linphone_auth_info_new(const char *username, const char *userid,
 352                 const char *passwd, const char *ha1,const char *realm);
 353 void linphone_auth_info_set_passwd(LinphoneAuthInfo *info, const char *passwd);
 354 void linphone_auth_info_set_username(LinphoneAuthInfo *info, const char *username);
 355 void linphone_auth_info_set_userid(LinphoneAuthInfo *info, const char *userid);
 356
 357 const char *linphone_auth_info_get_username(const LinphoneAuthInfo *i);
 358 const char *linphone_auth_info_get_passwd(const LinphoneAuthInfo *i);
 359 const char *linphone_auth_info_get_userid(const LinphoneAuthInfo *i);
 360
 361 /* you don't need those function*/
 362 void linphone_auth_info_destroy(LinphoneAuthInfo *info);
 363 LinphoneAuthInfo * linphone_auth_info_new_from_config_file(struct _LpConfig *config, int pos);
 364
 365 struct _LinphoneChatRoom;
 366 typedef struct _LinphoneChatRoom LinphoneChatRoom;
 367
 368 LinphoneChatRoom * linphone_core_create_chat_room(struct _LinphoneCore *lc, const char *to);
 369 void linphone_chat_room_send_message(LinphoneChatRoom *cr, const char *msg);
 370 void linphone_chat_room_destroy(LinphoneChatRoom *cr);
 371 void linphone_chat_room_set_user_data(LinphoneChatRoom *cr, void * ud);
 372 void * linphone_chat_room_get_user_data(LinphoneChatRoom *cr);
 373
 374 /* describes the different groups of states */
 375 typedef enum _gstate_group {
 376   GSTATE_GROUP_POWER,
 377   GSTATE_GROUP_REG,
 378   GSTATE_GROUP_CALL
 379 } gstate_group_t;
 380
 381 typedef enum _gstate {
 382         /* states for GSTATE_GROUP_POWER */
 383         GSTATE_POWER_OFF = 0,        /* initial state */
 384         GSTATE_POWER_STARTUP,
 385         GSTATE_POWER_ON,
 386         GSTATE_POWER_SHUTDOWN,
 387         /* states for GSTATE_GROUP_REG */
 388         GSTATE_REG_NONE = 10,       /* initial state */
 389         GSTATE_REG_OK,
 390         GSTATE_REG_FAILED,
 391         GSTATE_REG_PENDING, /* a registration request is ongoing*/
 392         /* states for GSTATE_GROUP_CALL */
 393         GSTATE_CALL_IDLE = 20,      /* initial state */
 394         GSTATE_CALL_OUT_INVITE,
 395         GSTATE_CALL_OUT_CONNECTED,
 396         GSTATE_CALL_IN_INVITE,
 397         GSTATE_CALL_IN_CONNECTED,
 398         GSTATE_CALL_END,
 399         GSTATE_CALL_ERROR,
 400         GSTATE_CALL_OUT_RINGING, /*remote ringing*/
 401         GSTATE_CALL_PAUSED,
 402         GSTATE_CALL_RESUMED,
 403         GSTATE_INVALID
 404 } gstate_t;
 405
 406 struct _LinphoneGeneralState {
 407   gstate_t old_state;
 408   gstate_t new_state;
 409   gstate_group_t group;
 410   const char *message;
 411 };
 412 typedef struct _LinphoneGeneralState LinphoneGeneralState;
 413
 414
 415 typedef union _LinphoneGeneralStateContext{
 416         LinphoneCall *call;
 417         LinphoneProxyConfig *proxy;
 418 }LinphoneGeneralStateContext;
 419
 420 /**
 421  * @addtogroup initializing
 422  * @{
 423 **/
 424
 425 /** Callback prototype */
 426 typedef void (*ShowInterfaceCb)(struct _LinphoneCore *lc);
 427 /** Callback prototype */
 428 typedef void (*InviteReceivedCb)(struct _LinphoneCore *lc, LinphoneCall *call);
 429 /** Callback prototype */
 430 typedef void (*ByeReceivedCb)(struct _LinphoneCore *lc, LinphoneCall *call);
 431 /** Callback prototype */
 432 typedef void (*RingingReceivedCb)(struct _LinphoneCore *lc, LinphoneCall *call);
 433 /** Callback prototype */
 434 typedef void (*ConnectedReceivedCb)(struct _LinphoneCore *lc, LinphoneCall *call);
 435 /** Callback prototype */
 436 typedef void (*FailureReceivedCb)(struct _LinphoneCore *lc, LinphoneCall *call, int error_code);
 437 /** Callback prototype */
 438 typedef void (*PausedReceivedCb)(struct _LinphoneCore *lc, LinphoneCall *call);
 439 /** Callback prototype */
 440 typedef void (*ResumedReceivedCb)(struct _LinphoneCore *lc, LinphoneCall *call);
 441 /** Callback prototype */
 442 typedef void (*AckPausedReceivedCb)(struct _LinphoneCore *lc, LinphoneCall *call);
 443 /** Callback prototype */
 444 typedef void (*AckResumedReceivedCb)(struct _LinphoneCore *lc, LinphoneCall *call);
 445 /** Callback prototype */
 446 typedef void (*DisplayStatusCb)(struct _LinphoneCore *lc, const char *message);
 447 /** Callback prototype */
 448 typedef void (*DisplayMessageCb)(struct _LinphoneCore *lc, const char *message);
 449 /** Callback prototype */
 450 typedef void (*DisplayUrlCb)(struct _LinphoneCore *lc, const char *message, const char *url);
 451 /** Callback prototype */
 452 typedef void (*DisplayQuestionCb)(struct _LinphoneCore *lc, const char *message);
 453 /** Callback prototype */
 454 typedef void (*LinphoneCoreCbFunc)(struct _LinphoneCore *lc,void * user_data);
 455 /** Callback prototype */
 456 typedef void (*NotifyReceivedCb)(struct _LinphoneCore *lc, const char *from, const char *msg);
 457 /** Callback prototype */
 458 typedef void (*NotifyPresenceReceivedCb)(struct _LinphoneCore *lc, LinphoneFriend * fid);
 459 /** Callback prototype */
 460 typedef void (*NewUnknownSubscriberCb)(struct _LinphoneCore *lc, LinphoneFriend *lf, const char *url);
 461 /** Callback prototype */
 462 typedef void (*AuthInfoRequested)(struct _LinphoneCore *lc, const char *realm, const char *username);
 463 /** Callback prototype */
 464 typedef void (*CallLogUpdated)(struct _LinphoneCore *lc, struct _LinphoneCallLog *newcl);
 465 /** Callback prototype */
 466 typedef void (*TextMessageReceived)(struct _LinphoneCore *lc, LinphoneChatRoom *room, const char *from, const char *message);
 467 /** Callback prototype */
 468 typedef void (*GeneralStateChange)(struct _LinphoneCore *lc, LinphoneGeneralState *gstate, LinphoneGeneralStateContext ctx);
 469 /** Callback prototype */
 470 typedef void (*DtmfReceived)(struct _LinphoneCore* lc, LinphoneCall *call, int dtmf);
 471 /** Callback prototype */
 472 typedef void (*ReferReceived)(struct _LinphoneCore *lc, LinphoneCall *call, const char *refer_to);
 473 /** Callback prototype */
 474 typedef void (*BuddyInfoUpdated)(struct _LinphoneCore *lc, LinphoneFriend *lf);
 475
 476 /**
 477  * This structure holds all callbacks that the application should implement.
 478  *
 479 **/
 480 typedef struct _LinphoneVTable
 481 {
 482         InviteReceivedCb inv_recv; /**< Notifies incoming calls */
 483         ByeReceivedCb bye_recv; /**< Notify calls terminated by far end*/
 484         RingingReceivedCb ringing_recv; /**< Notify that the distant phone is ringing*/
 485         ConnectedReceivedCb connected_recv; /**< Notify that the distant phone answered the call*/
 486         FailureReceivedCb failure_recv; /**< Notify that the call failed*/
 487         PausedReceivedCb paused_recv; /**< Notify that the call has been paused*/
 488         ResumedReceivedCb resumed_recv; /**< Notify that the call has been resumed*/
 489         AckPausedReceivedCb ack_paused_recv;/**< Notify that the previous command pause sent to the call has been acknowledge*/
 490         AckResumedReceivedCb ack_resumed_recv;/**< Notify that the previous command resumed sent to the call has been acknowledge*/
 491         GeneralStateChange general_state; /**< State notification callback */
 492         NotifyPresenceReceivedCb notify_presence_recv; /**< Notify received presence events*/
 493         NewUnknownSubscriberCb new_unknown_subscriber; /**< Notify about unknown subscriber */
 494         AuthInfoRequested auth_info_requested; /**< Ask the application some authentication information */
 495         CallLogUpdated call_log_updated; /**< Notifies that call log list has been updated */
 496         TextMessageReceived text_received; /**< A text message has been received */
 497         DtmfReceived dtmf_received; /**< A dtmf has been received received */
 498         ReferReceived refer_received; /**< A refer was received */
 499         BuddyInfoUpdated buddy_info_updated; /**< a LinphoneFriend's BuddyInfo has changed*/
 500         NotifyReceivedCb notify_recv; /**< Other notifications*/
 501         DisplayStatusCb display_status; /**< Callback that notifies various events with human readable text.*/
 502         DisplayMessageCb display_message;/**< Callback to display a message to the user */
 503         DisplayMessageCb display_warning;/** Callback to display a warning to the user */
 504         DisplayUrlCb display_url;
 505         ShowInterfaceCb show; /**< Notifies the application that it should show up*/
 506 } LinphoneCoreVTable;
 507
 508 /**
 509  * @}
 510 **/
 511
 512 typedef struct _LCCallbackObj
 513 {
 514   LinphoneCoreCbFunc _func;
 515   void * _user_data;
 516 }LCCallbackObj;
 517
 518
 519
 520 typedef enum _LinphoneFirewallPolicy{
 521         LINPHONE_POLICY_NO_FIREWALL,
 522         LINPHONE_POLICY_USE_NAT_ADDRESS,
 523         LINPHONE_POLICY_USE_STUN
 524 } LinphoneFirewallPolicy;
 525
 526 typedef enum _LinphoneWaitingState{
 527         LinphoneWaitingStart,
 528         LinphoneWaitingProgress,
 529         LinphoneWaitingFinished
 530 } LinphoneWaitingState;
 531 typedef void * (*LinphoneWaitingCallback)(struct _LinphoneCore *lc, void *context, LinphoneWaitingState ws, const char *purpose, float progress);
 532
 533 typedef struct _LinphoneCore LinphoneCore;
 534
 535 /* THE main API */
 536
 537 void linphone_core_enable_logs(FILE *file);
 538 void linphone_core_enable_logs_with_cb(OrtpLogFunc logfunc);
 539 void linphone_core_disable_logs(void);
 540 /*sets the user-agent string in sip messages, must be set before linphone_core_new() or linphone_core_init() */
 541 void linphone_core_set_user_agent(const char *ua_name, const char *version);
 542 const char *linphone_core_get_version(void);
 543
 544 LinphoneCore *linphone_core_new(const LinphoneCoreVTable *vtable,
 545                                                 const char *config_path, const char *factory_config, void* userdata);
 546
 547 /* function to be periodically called in a main loop */
 548 void linphone_core_iterate(LinphoneCore *lc);
 549
 550 LinphoneAddress * linphone_core_interpret_url(LinphoneCore *lc, const char *url);
 551
 552 LinphoneCall * linphone_core_invite(LinphoneCore *lc, const char *url);
 553
 554 LinphoneCall * linphone_core_invite_address(LinphoneCore *lc, const LinphoneAddress *addr);
 555
 556 int linphone_core_refer(LinphoneCore *lc, LinphoneCall *call, const char *url);
 557
 558 bool_t linphone_core_inc_invite_pending(LinphoneCore*lc);
 559
 560 bool_t linphone_core_in_call(const LinphoneCore *lc);
 561
 562 LinphoneCall *linphone_core_get_current_call(LinphoneCore *lc);
 563
 564 int linphone_core_accept_call(LinphoneCore *lc, LinphoneCall *call);
 565
 566 int linphone_core_terminate_call(LinphoneCore *lc, LinphoneCall *call);
 567
 568 int linphone_core_terminate_all_calls(LinphoneCore *lc);
 569
 570 int linphone_core_pause_call(LinphoneCore *lc, LinphoneCall *call);
 571
 572 int linphone_core_resume_call(LinphoneCore *lc, LinphoneCall *call);
 573
 574 LinphoneCall *linphone_core_get_call_by_remote_address(LinphoneCore *lc, const char *remote_address);
 575
 576 void linphone_core_send_dtmf(LinphoneCore *lc,char dtmf);
 577
 578 int linphone_core_set_primary_contact(LinphoneCore *lc, const char *contact);
 579
 580 const char *linphone_core_get_primary_contact(LinphoneCore *lc);
 581
 582 void linphone_core_set_guess_hostname(LinphoneCore *lc, bool_t val);
 583 bool_t linphone_core_get_guess_hostname(LinphoneCore *lc);
 584
 585 bool_t linphone_core_ipv6_enabled(LinphoneCore *lc);
 586 void linphone_core_enable_ipv6(LinphoneCore *lc, bool_t val);
 587
 588 LinphoneAddress *linphone_core_get_primary_contact_parsed(LinphoneCore *lc);
 589
 590 /*0= no bandwidth limit*/
 591 void linphone_core_set_download_bandwidth(LinphoneCore *lc, int bw);
 592 void linphone_core_set_upload_bandwidth(LinphoneCore *lc, int bw);
 593
 594 int linphone_core_get_download_bandwidth(const LinphoneCore *lc);
 595 int linphone_core_get_upload_bandwidth(const LinphoneCore *lc);
 596 /**
 597  * set audio packetization time linphone expect to received from peer
 598  * @ingroup media_parameters
 599  *
 600  */
 601 void linphone_core_set_download_ptime(LinphoneCore *lc, int ptime);
 602 /**
 603  * get audio packetization time linphone expect to received from peer, 0 means unspecified
 604  * @ingroup media_parameters
 605  */
 606 int  linphone_core_get_download_ptime(LinphoneCore *lc);
 607
 608 #ifdef VINCENT_MAURY_RSVP
 609 /* QoS functions */
 610 int linphone_core_set_rpc_mode(LinphoneCore *lc, int on); /* on = 1 (RPC_ENABLE = 1) */
 611 int linphone_core_set_rsvp_mode(LinphoneCore *lc, int on); /* on = 1 (RSVP_ENABLE = 1) */
 612 int linphone_core_change_qos(LinphoneCore *lc, int answer); /* answer = 1 for yes, 0 for no */
 613 #endif
 614
 615 /* returns a MSList of PayloadType */
 616 const MSList *linphone_core_get_audio_codecs(const LinphoneCore *lc);
 617
 618 int linphone_core_set_audio_codecs(LinphoneCore *lc, MSList *codecs);
 619 /* returns a MSList of PayloadType */
 620 const MSList *linphone_core_get_video_codecs(const LinphoneCore *lc);
 621
 622 int linphone_core_set_video_codecs(LinphoneCore *lc, MSList *codecs);
 623
 624 bool_t linphone_core_payload_type_enabled(LinphoneCore *lc, PayloadType *pt);
 625
 626 int linphone_core_enable_payload_type(LinphoneCore *lc, PayloadType *pt, bool_t enable);
 627
 628 /*
 629  * get payload type  from mime type an clock rate
 630  * @ingroup media_parameters
 631  * iterates both audio an video
 632  * return NULL if not found
 633  */
 634 PayloadType* linphone_core_find_payload_type(LinphoneCore* lc, const char* type, int rate) ;
 635
 636 const char *linphone_core_get_payload_type_description(LinphoneCore *lc, PayloadType *pt);
 637
 638 bool_t linphone_core_check_payload_type_usability(LinphoneCore *lc, PayloadType *pt);
 639
 640 int linphone_core_add_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
 641
 642 void linphone_core_clear_proxy_config(LinphoneCore *lc);
 643
 644 void linphone_core_remove_proxy_config(LinphoneCore *lc, LinphoneProxyConfig *config);
 645
 646 const MSList *linphone_core_get_proxy_config_list(const LinphoneCore *lc);
 647
 648 void linphone_core_set_default_proxy(LinphoneCore *lc, LinphoneProxyConfig *config);
 649
 650 void linphone_core_set_default_proxy_index(LinphoneCore *lc, int index);
 651
 652 int linphone_core_get_default_proxy(LinphoneCore *lc, LinphoneProxyConfig **config);
 653
 654 void linphone_core_add_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
 655
 656 void linphone_core_remove_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
 657
 658 const MSList *linphone_core_get_auth_info_list(const LinphoneCore *lc);
 659
 660 const LinphoneAuthInfo *linphone_core_find_auth_info(LinphoneCore *lc, const char *realm, const char *username);
 661
 662 void linphone_core_abort_authentication(LinphoneCore *lc,  LinphoneAuthInfo *info);
 663
 664 void linphone_core_clear_all_auth_info(LinphoneCore *lc);
 665
 666 int linphone_core_get_audio_jittcomp(LinphoneCore *lc);
 667
 668 void linphone_core_set_audio_jittcomp(LinphoneCore *lc, int value);
 669
 670 int linphone_core_get_audio_port(const LinphoneCore *lc);
 671
 672 int linphone_core_get_video_port(const LinphoneCore *lc);
 673
 674 int linphone_core_get_nortp_timeout(const LinphoneCore *lc);
 675
 676 void linphone_core_set_audio_port(LinphoneCore *lc, int port);
 677
 678 void linphone_core_set_video_port(LinphoneCore *lc, int port);
 679
 680 void linphone_core_set_nortp_timeout(LinphoneCore *lc, int port);
 681
 682 void linphone_core_set_use_info_for_dtmf(LinphoneCore *lc, bool_t use_info);
 683
 684 bool_t linphone_core_get_use_info_for_dtmf(LinphoneCore *lc);
 685
 686 void linphone_core_set_use_rfc2833_for_dtmf(LinphoneCore *lc,bool_t use_rfc2833);
 687
 688 bool_t linphone_core_get_use_rfc2833_for_dtmf(LinphoneCore *lc);
 689
 690 void linphone_core_set_sip_port(LinphoneCore *lc, int port);
 691
 692 int linphone_core_get_sip_port(LinphoneCore *lc);
 693
 694 int linphone_core_set_sip_transports(LinphoneCore *lc, const LCSipTransports *transports);
 695
 696 int linphone_core_get_sip_transports(LinphoneCore *lc, LCSipTransports *transports);
 697
 698 ortp_socket_t linphone_core_get_sip_socket(LinphoneCore *lc);
 699
 700 void linphone_core_set_inc_timeout(LinphoneCore *lc, int seconds);
 701
 702 int linphone_core_get_inc_timeout(LinphoneCore *lc);
 703
 704 void linphone_core_set_stun_server(LinphoneCore *lc, const char *server);
 705
 706 const char * linphone_core_get_stun_server(const LinphoneCore *lc);
 707
 708 void linphone_core_set_nat_address(LinphoneCore *lc, const char *addr);
 709
 710 const char *linphone_core_get_nat_address(const LinphoneCore *lc);
 711
 712 void linphone_core_set_firewall_policy(LinphoneCore *lc, LinphoneFirewallPolicy pol);
 713
 714 LinphoneFirewallPolicy linphone_core_get_firewall_policy(const LinphoneCore *lc);
 715
 716 const char * linphone_core_get_relay_addr(const LinphoneCore *lc);
 717
 718 int linphone_core_set_relay_addr(LinphoneCore *lc, const char *addr);
 719
 720 /* sound functions */
 721 /* returns a null terminated static array of string describing the sound devices */
 722 const char**  linphone_core_get_sound_devices(LinphoneCore *lc);
 723 bool_t linphone_core_sound_device_can_capture(LinphoneCore *lc, const char *device);
 724 bool_t linphone_core_sound_device_can_playback(LinphoneCore *lc, const char *device);
 725 int linphone_core_get_ring_level(LinphoneCore *lc);
 726 int linphone_core_get_play_level(LinphoneCore *lc);
 727 int linphone_core_get_rec_level(LinphoneCore *lc);
 728 void linphone_core_set_ring_level(LinphoneCore *lc, int level);
 729 void linphone_core_set_play_level(LinphoneCore *lc, int level);
 730
 731 void linphone_core_set_playback_gain_db(LinphoneCore *lc, float level);
 732
 733 float linphone_core_get_playback_gain_db(LinphoneCore *lc);
 734 void linphone_core_set_rec_level(LinphoneCore *lc, int level);
 735 const char * linphone_core_get_ringer_device(LinphoneCore *lc);
 736 const char * linphone_core_get_playback_device(LinphoneCore *lc);
 737 const char * linphone_core_get_capture_device(LinphoneCore *lc);
 738 int linphone_core_set_ringer_device(LinphoneCore *lc, const char * devid);
 739 int linphone_core_set_playback_device(LinphoneCore *lc, const char * devid);
 740 int linphone_core_set_capture_device(LinphoneCore *lc, const char * devid);
 741 char linphone_core_get_sound_source(LinphoneCore *lc);
 742 void linphone_core_set_sound_source(LinphoneCore *lc, char source);
 743 void linphone_core_set_ring(LinphoneCore *lc, const char *path);
 744 const char *linphone_core_get_ring(const LinphoneCore *lc);
 745 void linphone_core_set_ringback(LinphoneCore *lc, const char *path);
 746 const char * linphone_core_get_ringback(const LinphoneCore *lc);
 747 int linphone_core_preview_ring(LinphoneCore *lc, const char *ring,LinphoneCoreCbFunc func,void * userdata);
 748 void linphone_core_enable_echo_cancellation(LinphoneCore *lc, bool_t val);
 749 bool_t linphone_core_echo_cancellation_enabled(LinphoneCore *lc);
 750
 751 void linphone_core_enable_echo_limiter(LinphoneCore *lc, bool_t val);
 752 bool_t linphone_core_echo_limiter_enabled(const LinphoneCore *lc);
 753
 754 void linphone_core_enable_agc(LinphoneCore *lc, bool_t val);
 755 bool_t linphone_core_agc_enabled(const LinphoneCore *lc);
 756
 757 void linphone_core_mute_mic(LinphoneCore *lc, bool_t muted);
 758 /**
 759  * return mic state.
 760  *
 761  * @ingroup media_parameters
 762 **/
 763 bool_t linphone_core_is_mic_muted(LinphoneCore *lc);
 764
 765 bool_t linphone_core_is_audio_muted(LinphoneCore *lc);
 766 bool_t linphone_core_is_rtp_muted(LinphoneCore *lc);
 767
 768 bool_t linphone_core_get_rtp_no_xmit_on_audio_mute(const LinphoneCore *lc);
 769 void linphone_core_set_rtp_no_xmit_on_audio_mute(LinphoneCore *lc, bool_t val);
 770
 771 void linphone_core_set_presence_info(LinphoneCore *lc,int minutes_away,const char *contact,LinphoneOnlineStatus os);
 772
 773 LinphoneOnlineStatus linphone_core_get_presence_info(const LinphoneCore *lc);
 774
 775 void linphone_core_interpret_friend_uri(LinphoneCore *lc, const char *uri, char **result);
 776 void linphone_core_add_friend(LinphoneCore *lc, LinphoneFriend *fr);
 777 void linphone_core_remove_friend(LinphoneCore *lc, LinphoneFriend *fr);
 778 void linphone_core_reject_subscriber(LinphoneCore *lc, LinphoneFriend *lf);
 779 /* a list of LinphoneFriend */
 780 const MSList * linphone_core_get_friend_list(const LinphoneCore *lc);
 781 /* notify all friends that have subscribed */
 782 void linphone_core_notify_all_friends(LinphoneCore *lc, LinphoneOnlineStatus os);
 783 LinphoneFriend *linphone_core_get_friend_by_address(const LinphoneCore *lc, const char *addr);
 784 LinphoneFriend *linphone_core_get_friend_by_ref_key(const LinphoneCore *lc, const char *key);
 785
 786 /* returns a list of LinphoneCallLog */
 787 const MSList * linphone_core_get_call_logs(LinphoneCore *lc);
 788 void linphone_core_clear_call_logs(LinphoneCore *lc);
 789
 790 /* video support */
 791 void linphone_core_enable_video(LinphoneCore *lc, bool_t vcap_enabled, bool_t display_enabled);
 792 bool_t linphone_core_video_enabled(LinphoneCore *lc);
 793
 794 typedef struct MSVideoSizeDef{
 795         MSVideoSize vsize;
 796         const char *name;
 797 }MSVideoSizeDef;
 798 /* returns a zero terminated table of MSVideoSizeDef*/
 799 const MSVideoSizeDef *linphone_core_get_supported_video_sizes(LinphoneCore *lc);
 800 void linphone_core_set_preferred_video_size(LinphoneCore *lc, MSVideoSize vsize);
 801 MSVideoSize linphone_core_get_preferred_video_size(LinphoneCore *lc);
 802 void linphone_core_set_preferred_video_size_by_name(LinphoneCore *lc, const char *name);
 803
 804 void linphone_core_enable_video_preview(LinphoneCore *lc, bool_t val);
 805 bool_t linphone_core_video_preview_enabled(const LinphoneCore *lc);
 806
 807 void linphone_core_enable_self_view(LinphoneCore *lc, bool_t val);
 808 bool_t linphone_core_self_view_enabled(const LinphoneCore *lc);
 809
 810
 811 /* returns a null terminated static array of string describing the webcams */
 812 const char**  linphone_core_get_video_devices(const LinphoneCore *lc);
 813 int linphone_core_set_video_device(LinphoneCore *lc, const char *id);
 814 const char *linphone_core_get_video_device(const LinphoneCore *lc);
 815
 816 /* Set static picture to be used when "Static picture" is the video device */
 817 int linphone_core_set_static_picture(LinphoneCore *lc, const char *path);
 818
 819 /*function to be used for eventually setting window decorations (icons, title...)*/
 820 unsigned long linphone_core_get_native_video_window_id(const LinphoneCore *lc);
 821
 822
 823 /*play/record support: use files instead of soundcard*/
 824 void linphone_core_use_files(LinphoneCore *lc, bool_t yesno);
 825 void linphone_core_set_play_file(LinphoneCore *lc, const char *file);
 826 void linphone_core_set_record_file(LinphoneCore *lc, const char *file);
 827
 828 gstate_t linphone_core_get_state(const LinphoneCore *lc, gstate_group_t group);
 829 int linphone_core_get_current_call_duration(const LinphoneCore *lc);
 830 const LinphoneAddress *linphone_core_get_remote_address(LinphoneCore *lc);
 831
 832 int linphone_core_get_mtu(const LinphoneCore *lc);
 833 void linphone_core_set_mtu(LinphoneCore *lc, int mtu);
 834
 835 /**
 836  * This method is called by the application to notify the linphone core library when network is reachable.
 837  * Calling this method with true trigger linphone to initiate a registration process for all proxy
 838  * configuration with parameter register set to enable.
 839  * This method disable the automatic registration mode. It means you must call this method after each network state changes
 840  *
 841  */
 842 void linphone_core_set_network_reachable(LinphoneCore* lc,bool_t value);
 843 /**
 844  * return network state either as positioned by the application or by linphone
 845  */
 846 bool_t linphone_core_is_network_reachabled(LinphoneCore* lc);
 847
 848
 849 void *linphone_core_get_user_data(LinphoneCore *lc);
 850
 851 /* returns LpConfig object to read/write to the config file: usefull if you wish to extend
 852 the config file with your own sections */
 853 struct _LpConfig *linphone_core_get_config(LinphoneCore *lc);
 854
 855 /* attempts to wake up another linphone engine already running.
 856 The "show" callback is called for the other linphone, causing gui to show up.
 857 call_addr is an optional sip-uri to call immediately after waking up.
 858 The method returns 0 if an already running linphone was found*/
 859
 860 int linphone_core_wake_up_possible_already_running_instance(
 861     const char * config_file, const char * call_addr);
 862
 863 /*set a callback for some blocking operations, it takes you informed of the progress of the operation*/
 864 void linphone_core_set_waiting_callback(LinphoneCore *lc, LinphoneWaitingCallback cb, void *user_context);
 865
 866 /*returns the list of registered SipSetup (linphonecore plugins) */
 867 const MSList * linphone_core_get_sip_setups(LinphoneCore *lc);
 868
 869 void linphone_core_destroy(LinphoneCore *lc);
 870
 871 /*for advanced users:*/
 872 void linphone_core_set_audio_transports(LinphoneCore *lc, RtpTransport *rtp, RtpTransport *rtcp);
 873
 874 int linphone_core_get_current_call_stats(LinphoneCore *lc, rtp_stats_t *local, rtp_stats_t *remote);
 875
 876 #ifdef __cplusplus
 877 }
 878 #endif
 879 MSList *linphone_core_get_calls(LinphoneCore *lc);
 880
 881
 882 #endif