media_index.c: Refactored so it doesn't cache the index

Testing revealed that the cache added no benefit but that it could
consume excessive memory.

Two new index related functions were created:
ast_sounds_get_index_for_file() and ast_media_index_update_for_file()
which restrict index updating to specific sound files.

The original ast_sounds_get_index() and ast_media_index_update()
calls are still available but since they no longer cache the results
internally, developers should re-use an index they may already have
instead of calling ast_sounds_get_index() repeatedly.  If information
for only a single file is needed, ast_sounds_get_index_for_file()
should be called instead of ast_sounds_get_index().

The media_index directory scan code was elimininated in favor of
using the existing ast_file_read_dirs() function.

Since there's no more cache, ast_sounds_index_init now only
registers the sounds cli commands instead of generating the
initial index and subscribing to stasis format register/unregister
messages.

"sounds" is no longer a valid target for the "module reload"
command.

Both the sounds cli commands and the sounds ari resources were
refactored to only call ast_sounds_get_index() once per invocation
and to use ast_sounds_get_index_for_file() when a specific sound
file is requested.

Change-Id: I1cef327ba1b0648d85d218b70ce469ad07f4aa8d
This commit is contained in:
George Joseph
2019-01-22 08:02:06 -07:00
parent 6118b65a5a
commit 7071e9d64c
6 changed files with 277 additions and 212 deletions

View File

@@ -90,6 +90,25 @@ struct ao2_container *ast_media_get_variants(struct ast_media_index *index, cons
*/
struct ao2_container *ast_media_get_media(struct ast_media_index *index);
/*!
* \brief Update a media index for a specific sound file
*
* \since 13.25.0
* \since 16.2.0
*
* \param index Media index in which to query information
* \param variant Media variant for which to get the description
* \param filename Sound file name without extension
*
* \note If filename is NULL, this function will act as
* \ref ast_media_index_update and add all sound files to the index.
*
* \retval non-zero on error
* \return zero on success
*/
int ast_media_index_update_for_file(struct ast_media_index *index,
const char *variant, const char *filename);
/*!
* \brief Update a media index
*
@@ -99,8 +118,9 @@ struct ao2_container *ast_media_get_media(struct ast_media_index *index);
* \retval non-zero on error
* \return zero on success
*/
int ast_media_index_update(struct ast_media_index *index,
const char *variant);
#define ast_media_index_update(index, variant) \
ast_media_index_update_for_file(index, variant, NULL)
#if defined(__cplusplus) || defined(c_plusplus)
}
#endif

View File

@@ -40,6 +40,19 @@ struct ast_media_index;
*/
struct ast_media_index *ast_sounds_get_index(void);
/*!
* \brief Get the index for a specific sound file
* \since 13.25.0
* \since 16.2.0
*
* \param filename Sound file name without extension
*
* \retval sounds index (must be ao2_cleanup()'ed)
* \retval NULL on failure
*/
struct ast_media_index *ast_sounds_get_index_for_file(const char *filename);
#if defined(__cplusplus) || defined(c_plusplus)
}
#endif