mirror of
https://github.com/irungentoo/toxcore.git
synced 2024-03-22 13:30:51 +08:00
04d894e7cc
* Don't use anonymous enums (`typedef enum { ... } Name;`).
* Don't use macros to generate structs (too magical, hard to grep).
* Assign output parameter once, and don't access it a lot in the
function body.
* Don't pass type names as parameters to macros (this is C, we don't have
templates, sorry).
* All function-like macros must be do-while(0).
* `++i` instead of `i++`.
* No assignment-expressions.
* No void-casts.
152 lines
4.1 KiB
C
152 lines
4.1 KiB
C
/*
|
|
* Copyright © 2016-2017 The TokTok team.
|
|
* Copyright © 2013-2015 Tox project.
|
|
*
|
|
* This file is part of Tox, the free peer to peer instant messenger.
|
|
*
|
|
* 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 MSI_H
|
|
#define MSI_H
|
|
|
|
#include "audio.h"
|
|
#include "video.h"
|
|
|
|
#include "../toxcore/Messenger.h"
|
|
#include "../toxcore/logger.h"
|
|
|
|
#include <inttypes.h>
|
|
#include <pthread.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_s {
|
|
struct MSISession_s *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_s *av_call; /* Pointer to av call handler */
|
|
|
|
struct MSICall_s *next;
|
|
struct MSICall_s *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_s {
|
|
/* Call handlers */
|
|
MSICall **calls;
|
|
uint32_t calls_tail;
|
|
uint32_t calls_head;
|
|
|
|
void *av;
|
|
Messenger *messenger;
|
|
|
|
pthread_mutex_t mutex[1];
|
|
msi_action_cb *callbacks[7];
|
|
} 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 setter.
|
|
*/
|
|
void msi_register_callback(MSISession *session, msi_action_cb *callback, MSICallbackID id);
|
|
/**
|
|
* 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 /* MSI_H */
|