toxcore/toxav/msi.h

234 lines
5.5 KiB
C
Raw Normal View History

/** toxmsi.h
2014-02-17 09:01:30 +08:00
*
* Copyright (C) 2013 Tox project All Rights Reserved.
*
* This file is part of Tox.
*
* Tox is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Tox is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Tox. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef __TOXMSI
#define __TOXMSI
#include <inttypes.h>
#include <pthread.h>
2014-02-16 03:44:33 +08:00
#include "../toxcore/Messenger.h"
/* define size for call_id */
#define CALL_ID_LEN 12
2014-05-17 01:56:40 +08:00
typedef void ( *MSICallback ) ( int32_t, void *arg );
/**
* @brief Call type identifier. Also used as rtp callback prefix.
*/
typedef enum {
type_audio = 192,
2014-02-01 19:52:48 +08:00
type_video
} MSICallType;
/**
* @brief Call state identifiers.
*/
typedef enum {
call_inviting, /* when sending call invite */
call_starting, /* when getting call invite */
call_active,
call_hold,
call_hanged_up
} MSICallState;
/**
* @brief The call struct.
2014-02-17 09:01:30 +08:00
*
*/
2014-04-28 01:21:26 +08:00
typedef struct _MSICall { /* Call info structure */
struct _MSISession *session; /* Session pointer */
2014-04-28 01:21:26 +08:00
MSICallState state;
2014-04-28 01:21:26 +08:00
MSICallType type_local; /* Type of payload user is ending */
MSICallType *type_peer; /* Type of payload others are sending */
2014-04-28 01:21:26 +08:00
uint8_t id[CALL_ID_LEN]; /* Random value identifying the call */
2014-04-28 01:21:26 +08:00
int ringing_tout_ms; /* Ringing timeout in ms */
2014-04-28 01:21:26 +08:00
int request_timer_id; /* Timer id for outgoing request/action */
int ringing_timer_id; /* Timer id for ringing timeout */
2014-02-17 09:01:30 +08:00
2014-05-24 22:02:01 +08:00
pthread_mutex_t mutex; /* */
2014-05-20 06:27:02 +08:00
uint32_t *peers;
2014-04-28 01:21:26 +08:00
uint16_t peer_count;
2014-02-17 09:01:30 +08:00
2014-05-17 01:56:40 +08:00
int32_t call_idx; /* Index of this call in MSISession */
} MSICall;
/**
* @brief Control session struct
2014-02-17 09:01:30 +08:00
*
*/
typedef struct _MSISession {
2014-04-28 01:21:26 +08:00
/* Call handlers */
struct _MSICall **calls;
2014-05-17 01:56:40 +08:00
int32_t max_calls;
int last_error_id; /* Determine the last error */
2014-02-17 09:01:30 +08:00
const uint8_t *last_error_str;
void *agent_handler; /* Pointer to an object that is handling msi */
Messenger *messenger_handle;
uint32_t frequ;
uint32_t call_timeout; /* Time of the timeout for some action to end; 0 if infinite */
2014-02-17 09:01:30 +08:00
2014-05-24 22:02:01 +08:00
pthread_mutex_t mutex;
} MSISession;
2014-02-17 09:01:30 +08:00
/**
* @brief Callbacks ids that handle the states
*/
typedef enum {
/* Requests */
MSI_OnInvite,
MSI_OnStart,
MSI_OnCancel,
MSI_OnReject,
MSI_OnEnd,
/* Responses */
MSI_OnRinging,
MSI_OnStarting,
MSI_OnEnding,
/* Protocol */
MSI_OnError,
2014-03-15 06:10:10 +08:00
MSI_OnRequestTimeout,
MSI_OnPeerTimeout
} MSICallbackID;
/**
* @brief Callback setter.
2014-02-17 09:01:30 +08:00
*
* @param callback The callback.
* @param id The id.
* @return void
*/
void msi_register_callback(MSICallback callback, MSICallbackID id, void *userdata);
/**
* @brief Start the control session.
2014-02-17 09:01:30 +08:00
*
* @param messenger Tox* object.
2014-04-28 01:21:26 +08:00
* @param max_calls Amount of calls possible
* @return MSISession* The created session.
2014-04-17 00:08:44 +08:00
* @retval NULL Error occurred.
*/
2014-05-17 01:56:40 +08:00
MSISession *msi_init_session ( Messenger *messenger, int32_t max_calls );
/**
* @brief Terminate control session.
2014-02-17 09:01:30 +08:00
*
* @param session The session
* @return int
*/
2014-02-17 09:01:30 +08:00
int msi_terminate_session ( MSISession *session );
/**
* @brief Send invite request to friend_id.
2014-02-17 09:01:30 +08:00
*
* @param session Control session.
2014-04-28 01:21:26 +08:00
* @param call_index Set to new call index.
* @param call_type Type of the call. Audio or Video(both audio and video)
* @param rngsec Ringing timeout.
* @param friend_id The friend.
* @return int
*/
int msi_invite ( MSISession *session, int32_t *call_index, MSICallType call_type, uint32_t rngsec, uint32_t friend_id );
/**
* @brief Hangup active call.
2014-02-17 09:01:30 +08:00
*
* @param session Control session.
2014-04-28 01:21:26 +08:00
* @param call_index To which call is this action handled.
2014-02-17 09:01:30 +08:00
* @return int
2014-04-17 00:08:44 +08:00
* @retval -1 Error occurred.
* @retval 0 Success.
*/
2014-05-17 01:56:40 +08:00
int msi_hangup ( MSISession *session, int32_t call_index );
/**
* @brief Answer active call request.
2014-02-17 09:01:30 +08:00
*
* @param session Control session.
2014-04-28 01:21:26 +08:00
* @param call_index To which call is this action handled.
* @param call_type Answer with Audio or Video(both).
* @return int
*/
2014-05-17 01:56:40 +08:00
int msi_answer ( MSISession *session, int32_t call_index, MSICallType call_type );
/**
* @brief Cancel request.
2014-02-17 09:01:30 +08:00
*
* @param session Control session.
2014-04-28 01:21:26 +08:00
* @param call_index To which call is this action handled.
2014-02-10 06:06:44 +08:00
* @param peer To which peer.
* @param reason Set optional reason header. Pass NULL if none.
* @return int
*/
int msi_cancel ( MSISession *session, int32_t call_index, uint32_t peer, const char *reason );
/**
* @brief Reject request.
2014-02-17 09:01:30 +08:00
*
* @param session Control session.
2014-04-28 01:21:26 +08:00
* @param call_index To which call is this action handled.
* @param reason Set optional reason header. Pass NULL if none.
* @return int
*/
2014-05-17 01:56:40 +08:00
int msi_reject ( MSISession *session, int32_t call_index, const uint8_t *reason );
/**
* @brief Terminate the current call.
2014-02-17 09:01:30 +08:00
*
* @param session Control session.
2014-04-28 01:21:26 +08:00
* @param call_index To which call is this action handled.
* @return int
*/
2014-05-17 01:56:40 +08:00
int msi_stopcall ( MSISession *session, int32_t call_index );
#endif /* __TOXMSI */