kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-11-19 00:00:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

streams: Add string metadata capability

Browse Source 
Replaces the never used opaque data array.

Updated stream tests to include get/set metadata and
stream clone with metadata.

Added stream metadata dump to "core show channel"

Change-Id: Id7473aa4b374d7ab53046c20e321037ba9a56863
This commit is contained in:
George Joseph
2018-04-13 14:14:47 -06:00
parent f7e7ce6ba2
commit f79a372941
6 changed files with 293 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

78
include/asterisk/stream.h
View File

@@ -77,20 +77,6 @@ enum ast_stream_state {
AST_STREAM_STATE_INACTIVE,
};
/*!
* \brief Stream data slots
*/
enum ast_stream_data_slot {
/*!
* \brief Data slot for RTP instance
*/
AST_STREAM_DATA_RTP_CODECS = 0,
/*!
* \brief Controls the size of the data pointer array
*/
AST_STREAM_DATA_SLOT_MAX
};
/*!
* \brief Create a new media stream representation
*
@@ -239,32 +225,47 @@ const char *ast_stream_state2str(enum ast_stream_state state);
enum ast_stream_state ast_stream_str2state(const char *str);
/*!
* \brief Get the opaque stream data
* \brief Get a stream metadata value
*
* \param stream The media stream
* \param slot The data slot to retrieve
* \param m_key An arbitrary metadata key
*
* \retval non-NULL success
* \retval NULL failure
* \retval non-NULL metadata value
* \retval NULL failure or not found
*
* \since 15
* \since 15.5
*/
void *ast_stream_get_data(struct ast_stream *stream, enum ast_stream_data_slot slot);
const char *ast_stream_get_metadata(const struct ast_stream *stream,
const char *m_key);
/*!
* \brief Set the opaque stream data
* \brief Get all stream metadata keys
*
* \param stream The media stream
* \param slot The data slot to set
* \param data Opaque data
* \param data_free_fn Callback to free data when stream is freed. May be NULL for no action.
*
* \return data
* \retval An ast_variable list of the metadata key/value pairs.
* \retval NULL if error or no variables are set.
*
* \since 15
* When you're finished with the list, you must call
* ast_variables_destroy(list);
*
* \since 15.5
*/
void *ast_stream_set_data(struct ast_stream *stream, enum ast_stream_data_slot slot,
void *data, ast_stream_data_free_fn data_free_fn);
struct ast_variable *ast_stream_get_metadata_list(const struct ast_stream *stream);
/*!
* \brief Set a stream metadata value
*
* \param stream The media stream
* \param m_key An arbitrary metadata key
* \param value String metadata value or NULL to remove existing value
*
* \retval -1 failure
* \retval 0 success
*
* \since 15.5
*/
int ast_stream_set_metadata(struct ast_stream *stream, const char *m_key, const char *value);
/*!
* \brief Get the position of the stream in the topology
@@ -277,6 +278,27 @@ void *ast_stream_set_data(struct ast_stream *stream, enum ast_stream_data_slot s
*/
int ast_stream_get_position(const struct ast_stream *stream);
/*!
* \brief Get rtp_codecs associated with the stream
*
* \param stream The media stream
*
* \return The rtp_codecs
*
* \since 15.5
*/
struct ast_rtp_codecs *ast_stream_get_rtp_codecs(const struct ast_stream *stream);
/*!
* \brief Set rtp_codecs associated with the stream
*
* \param stream The media stream
* \param rtp_codecs The rtp_codecs
*
* \since 15.5
*/
void ast_stream_set_rtp_codecs(struct ast_stream *stream, struct ast_rtp_codecs *rtp_codecs);
/*!
* \brief Create a stream topology
*