toxcore/toxav/msi.h

155 lines
4.1 KiB
C
Raw Normal View History

/** msi.h
2014-02-17 09:01:30 +08:00
*
* Copyright (C) 2013-2015 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 MSI_H
#define MSI_H
#include <inttypes.h>
#include <pthread.h>
2015-04-21 08:31:12 +08:00
#include "audio.h"
#include "video.h"
2014-02-16 03:44:33 +08:00
#include "../toxcore/Messenger.h"
/** Preconfigured value for video splitting */
2015-04-13 07:45:53 +08:00
#define VIDEOFRAME_PIECE_SIZE 500
/**
* Error codes.
*/
typedef enum {
2015-03-02 01:45:04 +08:00
msi_ENone,
msi_EInvalidMessage,
msi_EInvalidParam,
msi_EInvalidState,
msi_EStrayMessage,
msi_ESystem,
msi_EHandle,
2015-04-13 07:45:53 +08:00
msi_EUndisclosed, /* NOTE: must be last enum otherwise parsing will not work */
} MSIError;
/**
* Supported capabilities
*/
typedef enum {
2015-05-23 05:22:31 +08:00
msi_CapSAudio = 4, /* sending audio */
msi_CapSVideo = 8, /* sending video */
msi_CapRAudio = 16, /* receiving audio */
msi_CapRVideo = 32, /* receiving video */
} MSICapabilities;
/**
2014-11-18 07:46:46 +08:00
* Call state identifiers.
*/
typedef enum {
msi_CallInactive, /* Default */
msi_CallActive,
2015-01-25 06:29:54 +08:00
msi_CallRequesting, /* when sending call invite */
msi_CallRequested, /* when getting call invite */
} MSICallState;
/**
2014-11-18 07:46:46 +08:00
* Callbacks ids that handle the states
*/
typedef enum {
2014-11-29 20:42:19 +08:00
msi_OnInvite, /* Incoming call */
msi_OnStart, /* Call (RTP transmission) started */
msi_OnEnd, /* Call that was active ended */
msi_OnError, /* On protocol error */
2014-11-29 20:42:19 +08:00
msi_OnPeerTimeout, /* Peer timed out; stop the call */
msi_OnCapabilities, /* 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 */
2015-01-18 01:22:20 +08:00
MSICallState state;
uint8_t peer_capabilities; /* Peer capabilities */
uint8_t self_capabilities; /* Self capabilities */
uint16_t peer_vfpsz; /* Video frame piece size */
2015-04-29 07:01:25 +08:00
uint32_t friend_number; /* Index of this call in MSISession */
MSIError error; /* Last error */
void* av_call; /* Pointer to av call handler */
struct MSICall_s* next;
struct MSICall_s* prev;
} MSICall;
/**
2015-02-21 08:07:22 +08:00
* 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.
*/
2015-04-29 07:01:25 +08:00
typedef int msi_action_cb ( void *av, MSICall* call);
/**
* Control session struct. Please do not modify outside msi.c
*/
2015-01-18 01:22:20 +08:00
typedef struct MSISession_s {
2014-04-28 01:21:26 +08:00
/* Call handlers */
MSICall **calls;
uint32_t calls_tail;
uint32_t calls_head;
void *av;
Messenger *messenger;
2014-02-17 09:01:30 +08:00
2014-11-29 20:42:19 +08:00
pthread_mutex_t mutex[1];
2015-04-29 07:01:25 +08:00
msi_action_cb* callbacks[7];
} MSISession;
/**
2014-11-18 07:46:46 +08:00
* Start the control session.
*/
2015-04-29 07:01:25 +08:00
MSISession *msi_new ( Messenger *m );
/**
* Terminate control session. NOTE: all calls will be freed
*/
2014-11-18 07:46:46 +08:00
int msi_kill ( MSISession *session );
/**
2014-11-18 07:46:46 +08:00
* Callback setter.
*/
2015-04-29 07:01:25 +08:00
void msi_register_callback(MSISession *session, msi_action_cb* callback, MSICallbackID id);
/**
2015-04-29 07:01:25 +08:00
* Send invite request to friend_number.
*/
2015-04-29 07:01:25 +08:00
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 */