mirror of
https://github.com/asterisk/asterisk.git
synced 2025-09-25 15:08:53 +00:00
163efbd724
This commit adds support for [AudioSocket]( https://wiki.asterisk.org/wiki/display/AST/AudioSocket), a very simple bidirectional audio streaming protocol. There are both channel and application interfaces. A description of the protocol can be found on the above referenced GitHub page. A short talk about the reasons and implementation can be found on [YouTube](https://www.youtube.com/watch?v=tjduXbZZEgI), from CommCon 2019. ARI support has also been added via the existing "externalMedia" ARI functionality. The UUID is specified using the arbitrary "data" field. ASTERISK-28484 #close Change-Id: Ie866e6c4fa13178ec76f2a6971ad3590a3a588b5
88 lines
2.4 KiB
C
88 lines
2.4 KiB
C
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (C) 2019, CyCore Systems, Inc
|
|
*
|
|
* Seán C McCord <scm@cycoresys.com
|
|
*
|
|
* See http://www.asterisk.org for more information about
|
|
* the Asterisk project. Please do not directly contact
|
|
* any of the maintainers of this project for assistance;
|
|
* the project provides a web site, mailing lists and IRC
|
|
* channels for your use.
|
|
*
|
|
* This program is free software, distributed under the terms of
|
|
* the GNU General Public License Version 2. See the LICENSE file
|
|
* at the top of the source tree.
|
|
*/
|
|
|
|
/*!
|
|
* \file
|
|
* \brief AudioSocket support functions
|
|
*
|
|
* \author Seán C McCord <scm@cycoresys.com>
|
|
*
|
|
*/
|
|
|
|
#ifndef _ASTERISK_RES_AUDIOSOCKET_H
|
|
#define _ASTERISK_RES_AUDIOSOCKET_H
|
|
|
|
#if defined(__cplusplus) || defined(c_plusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include <uuid/uuid.h>
|
|
|
|
#include "asterisk/frame.h"
|
|
#include "asterisk/uuid.h"
|
|
|
|
/*!
|
|
* \brief Send the initial message to an AudioSocket server
|
|
*
|
|
* \param server The server address, including port.
|
|
* \param chan An optional channel which will be put into autoservice during
|
|
* the connection period. If there is no channel to be autoserviced, pass NULL
|
|
* instead.
|
|
*
|
|
* \retval socket file descriptor for AudioSocket on success
|
|
* \retval -1 on error
|
|
*/
|
|
const int ast_audiosocket_connect(const char *server, struct ast_channel *chan);
|
|
|
|
/*!
|
|
* \brief Send the initial message to an AudioSocket server
|
|
*
|
|
* \param svc The file descriptor of the network socket to the AudioSocket server.
|
|
* \param id The UUID to send to the AudioSocket server to uniquely identify this connection.
|
|
*
|
|
* \retval 0 on success
|
|
* \retval -1 on error
|
|
*/
|
|
const int ast_audiosocket_init(const int svc, const char *id);
|
|
|
|
/*!
|
|
* \brief Send an Asterisk audio frame to an AudioSocket server
|
|
*
|
|
* \param svc The file descriptor of the network socket to the AudioSocket server.
|
|
* \param f The Asterisk audio frame to send.
|
|
*
|
|
* \retval 0 on success
|
|
* \retval -1 on error
|
|
*/
|
|
const int ast_audiosocket_send_frame(const int svc, const struct ast_frame *f);
|
|
|
|
/*!
|
|
* \brief Receive an Asterisk frame from an AudioSocket server
|
|
*
|
|
* This returned object is a pointer to an Asterisk frame which must be
|
|
* manually freed by the caller.
|
|
*
|
|
* \param svc The file descriptor of the network socket to the AudioSocket server.
|
|
*
|
|
* \retval A \ref ast_frame on success
|
|
* \retval NULL on error
|
|
*/
|
|
struct ast_frame *ast_audiosocket_receive_frame(const int svc);
|
|
|
|
#endif /* _ASTERISK_RES_AUDIOSOCKET_H */
|