Merge commit '227425b90e9a671118026689dd30967e127a1090' as 'external/toxcore/c-toxcore'
This commit is contained in:
147
external/toxcore/c-toxcore/toxav/msi.h
vendored
Normal file
147
external/toxcore/c-toxcore/toxav/msi.h
vendored
Normal file
@ -0,0 +1,147 @@
|
||||
/* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
* Copyright © 2016-2018 The TokTok team.
|
||||
* Copyright © 2013-2015 Tox project.
|
||||
*/
|
||||
#ifndef C_TOXCORE_TOXAV_MSI_H
|
||||
#define C_TOXCORE_TOXAV_MSI_H
|
||||
|
||||
#include <pthread.h>
|
||||
#include <stdint.h>
|
||||
|
||||
#include "audio.h"
|
||||
#include "video.h"
|
||||
|
||||
#include "../toxcore/Messenger.h"
|
||||
#include "../toxcore/logger.h"
|
||||
|
||||
/**
|
||||
* Error codes.
|
||||
*/
|
||||
typedef enum MSIError {
|
||||
MSI_E_NONE,
|
||||
MSI_E_INVALID_MESSAGE,
|
||||
MSI_E_INVALID_PARAM,
|
||||
MSI_E_INVALID_STATE,
|
||||
MSI_E_STRAY_MESSAGE,
|
||||
MSI_E_SYSTEM,
|
||||
MSI_E_HANDLE,
|
||||
MSI_E_UNDISCLOSED, /* NOTE: must be last enum otherwise parsing will not work */
|
||||
} MSIError;
|
||||
|
||||
/**
|
||||
* Supported capabilities
|
||||
*/
|
||||
typedef enum MSICapabilities {
|
||||
MSI_CAP_S_AUDIO = 4, /* sending audio */
|
||||
MSI_CAP_S_VIDEO = 8, /* sending video */
|
||||
MSI_CAP_R_AUDIO = 16, /* receiving audio */
|
||||
MSI_CAP_R_VIDEO = 32, /* receiving video */
|
||||
} MSICapabilities;
|
||||
|
||||
|
||||
/**
|
||||
* Call state identifiers.
|
||||
*/
|
||||
typedef enum MSICallState {
|
||||
MSI_CALL_INACTIVE, /* Default */
|
||||
MSI_CALL_ACTIVE,
|
||||
MSI_CALL_REQUESTING, /* when sending call invite */
|
||||
MSI_CALL_REQUESTED, /* when getting call invite */
|
||||
} MSICallState;
|
||||
|
||||
/**
|
||||
* Callbacks ids that handle the states
|
||||
*/
|
||||
typedef enum MSICallbackID {
|
||||
MSI_ON_INVITE, /* Incoming call */
|
||||
MSI_ON_START, /* Call (RTP transmission) started */
|
||||
MSI_ON_END, /* Call that was active ended */
|
||||
MSI_ON_ERROR, /* On protocol error */
|
||||
MSI_ON_PEERTIMEOUT, /* Peer timed out; stop the call */
|
||||
MSI_ON_CAPABILITIES, /* Peer requested capabilities change */
|
||||
} MSICallbackID;
|
||||
|
||||
/**
|
||||
* The call struct. Please do not modify outside msi.c
|
||||
*/
|
||||
typedef struct MSICall {
|
||||
struct MSISession *session; /* Session pointer */
|
||||
|
||||
MSICallState state;
|
||||
uint8_t peer_capabilities; /* Peer capabilities */
|
||||
uint8_t self_capabilities; /* Self capabilities */
|
||||
uint16_t peer_vfpsz; /* Video frame piece size */
|
||||
uint32_t friend_number; /* Index of this call in MSISession */
|
||||
MSIError error; /* Last error */
|
||||
|
||||
struct ToxAVCall *av_call; /* Pointer to av call handler */
|
||||
|
||||
struct MSICall *next;
|
||||
struct MSICall *prev;
|
||||
} MSICall;
|
||||
|
||||
|
||||
/**
|
||||
* Expected return on success is 0, if any other number is
|
||||
* returned the call is considered errored and will be handled
|
||||
* as such which means it will be terminated without any notice.
|
||||
*/
|
||||
typedef int msi_action_cb(void *av, MSICall *call);
|
||||
|
||||
/**
|
||||
* Control session struct. Please do not modify outside msi.c
|
||||
*/
|
||||
typedef struct MSISession {
|
||||
/* Call handlers */
|
||||
MSICall **calls;
|
||||
uint32_t calls_tail;
|
||||
uint32_t calls_head;
|
||||
|
||||
void *av;
|
||||
Messenger *messenger;
|
||||
|
||||
pthread_mutex_t mutex[1];
|
||||
|
||||
msi_action_cb *invite_callback;
|
||||
msi_action_cb *start_callback;
|
||||
msi_action_cb *end_callback;
|
||||
msi_action_cb *error_callback;
|
||||
msi_action_cb *peertimeout_callback;
|
||||
msi_action_cb *capabilities_callback;
|
||||
} MSISession;
|
||||
|
||||
/**
|
||||
* Start the control session.
|
||||
*/
|
||||
MSISession *msi_new(Messenger *m);
|
||||
/**
|
||||
* Terminate control session. NOTE: all calls will be freed
|
||||
*/
|
||||
int msi_kill(MSISession *session, const Logger *log);
|
||||
/**
|
||||
* Callback setters.
|
||||
*/
|
||||
void msi_callback_invite(MSISession *session, msi_action_cb *callback);
|
||||
void msi_callback_start(MSISession *session, msi_action_cb *callback);
|
||||
void msi_callback_end(MSISession *session, msi_action_cb *callback);
|
||||
void msi_callback_error(MSISession *session, msi_action_cb *callback);
|
||||
void msi_callback_peertimeout(MSISession *session, msi_action_cb *callback);
|
||||
void msi_callback_capabilities(MSISession *session, msi_action_cb *callback);
|
||||
/**
|
||||
* Send invite request to friend_number.
|
||||
*/
|
||||
int msi_invite(MSISession *session, MSICall **call, uint32_t friend_number, uint8_t capabilities);
|
||||
/**
|
||||
* Hangup call. NOTE: `call` will be freed
|
||||
*/
|
||||
int msi_hangup(MSICall *call);
|
||||
/**
|
||||
* Answer call request.
|
||||
*/
|
||||
int msi_answer(MSICall *call, uint8_t capabilities);
|
||||
/**
|
||||
* Change capabilities of the call.
|
||||
*/
|
||||
int msi_change_capabilities(MSICall *call, uint8_t capabilities);
|
||||
|
||||
#endif // C_TOXCORE_TOXAV_MSI_H
|
Reference in New Issue
Block a user