summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorKinsey Moore <kmoore@digium.com>2013-06-24 13:49:20 +0000
committerKinsey Moore <kmoore@digium.com>2013-06-24 13:49:20 +0000
commita0b7a49a4a238207a2fe0a49fdc3b65994baa1a5 (patch)
tree04bb2ee790a186b6d0865fd9aabc2817a9715f94 /include
parentcc29957a6f3339667f02a7386416c7374122d403 (diff)
Index installed sounds and implement ARI sounds queries
This adds support for stasis/sounds and stasis/sounds/{ID} queries via the Asterisk RESTful Interface (ARI, formerly Stasis-HTTP). The following changes have been made to accomplish this: * A modular indexer was created for local media. * A new function to get an ast_format associated with a file extension was added. * Modifications were made to the built-in HTTP server so that URI decoding could be deferred to the URI handler when necessary. * The Stasis-HTTP sounds JSON documentation was modified to handle cases where multiple languages are installed in different formats. * Register and Unregister events for formats were added to the system topic. (closes issue ASTERISK-21584) (closes issue ASTERISK-21585) Review: https://reviewboard.asterisk.org/r/2507/ git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@392700 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'include')
-rw-r--r--include/asterisk/_private.h3
-rw-r--r--include/asterisk/file.h11
-rw-r--r--include/asterisk/format.h18
-rw-r--r--include/asterisk/http.h2
-rw-r--r--include/asterisk/media_index.h108
-rw-r--r--include/asterisk/sounds_index.h55
6 files changed, 197 insertions, 0 deletions
diff --git a/include/asterisk/_private.h b/include/asterisk/_private.h
index c58c51e4f..942747357 100644
--- a/include/asterisk/_private.h
+++ b/include/asterisk/_private.h
@@ -140,4 +140,7 @@ int ast_rtp_engine_init(void);
* \since 12.0.0
*/
int ast_parking_stasis_init(void);
+
+/*! \brief initialize the sounds index */
+int ast_sounds_index_init(void);
#endif /* _ASTERISK__PRIVATE_H */
diff --git a/include/asterisk/file.h b/include/asterisk/file.h
index 0b2f913ad..844b43429 100644
--- a/include/asterisk/file.h
+++ b/include/asterisk/file.h
@@ -376,6 +376,17 @@ int ast_file_init(void);
*/
char *ast_format_str_reduce(char *fmts);
+/*!
+ * \brief Get the ast_format associated with the given file extension
+ * \since 12
+ *
+ * \param file_ext The file extension for which to find the format
+ *
+ * \retval NULL if not found
+ * \retval A pointer to the ast_format associated with this file extension
+ */
+const struct ast_format *ast_get_format_for_file_ext(const char *file_ext);
+
#if defined(__cplusplus) || defined(c_plusplus)
}
#endif
diff --git a/include/asterisk/format.h b/include/asterisk/format.h
index bdf786dc3..ab7d8eefb 100644
--- a/include/asterisk/format.h
+++ b/include/asterisk/format.h
@@ -471,4 +471,22 @@ int ast_format_is_slinear(const struct ast_format *format);
* \brief Get the best slinear format id for a given sample rate
*/
enum ast_format_id ast_format_slin_by_rate(unsigned int rate);
+
+/*!
+ * \since 12
+ * \brief Get the message type used for signaling a format registration
+ *
+ * \retval Stasis message type for format registration
+ * \retval NULL on error
+ */
+struct stasis_message_type *ast_format_register_type(void);
+
+/*!
+ * \since 12
+ * \brief Get the message type used for signaling a format unregistration
+ *
+ * \retval Stasis message type for format unregistration
+ * \retval NULL on error
+ */
+struct stasis_message_type *ast_format_unregister_type(void);
#endif /* _AST_FORMAT_H */
diff --git a/include/asterisk/http.h b/include/asterisk/http.h
index db424d3d3..9efcad7f7 100644
--- a/include/asterisk/http.h
+++ b/include/asterisk/http.h
@@ -101,6 +101,8 @@ struct ast_http_uri {
unsigned int mallocd:1;
/*! Data structure is malloc'd */
unsigned int dmallocd:1;
+ /*! Don't automatically decode URI before passing it to the callback */
+ unsigned int no_decode_uri:1;
/*! Data to bind to the uri if needed */
void *data;
/*! Key to be used for unlinking if multiple URIs registered */
diff --git a/include/asterisk/media_index.h b/include/asterisk/media_index.h
new file mode 100644
index 000000000..40fb72102
--- /dev/null
+++ b/include/asterisk/media_index.h
@@ -0,0 +1,108 @@
+/*
+ * Asterisk -- An open source telephony toolkit.
+ *
+ * Copyright (C) 2013, Digium, Inc.
+ *
+ * Kinsey Moore <kmoore@digium.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 Media file format and description indexing engine.
+ */
+
+#ifndef _ASTERISK_MEDIA_INDEX_H
+#define _ASTERISK_MEDIA_INDEX_H
+
+#if defined(__cplusplus) || defined(c_plusplus)
+extern "C" {
+#endif
+
+struct ast_format_cap;
+
+/*!
+ * \brief Object representing a media index
+ */
+struct ast_media_index;
+
+/*!
+ * \brief Creates a new media index
+ *
+ * \param base_dir Base directory for indexing
+ *
+ * \retval NULL on error
+ * \retval A new AO2 refcounted media index
+ */
+struct ast_media_index *ast_media_index_create(
+ const char *base_dir);
+
+/*!
+ * \brief Get the description for a media file
+ *
+ * \param index Media index in which to query information
+ * \param filename Name of the file for which to get the description
+ * \param variant Media variant for which to get the description
+ *
+ * \retval NULL if not found
+ * \return The description requested (must be copied to be kept)
+ */
+const char *ast_media_get_description(struct ast_media_index *index, const char *filename, const char *variant);
+
+/*!
+ * \brief Get the ast_format_cap for a media file
+ *
+ * \param index Media index in which to query information
+ * \param filename Name of the file for which to get the description
+ * \param variant Media variant for which to get the description
+ *
+ * \retval NULL if not found
+ * \return a copy of the format capabilities (must be destroyed with ast_format_cap_destroy)
+ */
+struct ast_format_cap *ast_media_get_format_cap(struct ast_media_index *index, const char *filename, const char *variant);
+
+/*!
+ * \brief Get the languages in which a media file is available
+ *
+ * \param index Media index in which to query information
+ * \param filename Name of the file for which to get available languages
+ *
+ * \retval NULL on error
+ * \return an ast_str_container filled with language strings
+ */
+struct ao2_container *ast_media_get_variants(struct ast_media_index *index, const char *filename);
+
+/*!
+ * \brief Get the a container of all media available on the system
+ *
+ * \param index Media index in which to query information
+ *
+ * \retval NULL on error
+ * \return an ast_str_container filled with media file name strings
+ */
+struct ao2_container *ast_media_get_media(struct ast_media_index *index);
+
+/*!
+ * \brief Update a media index
+ *
+ * \param index Media index in which to query information
+ * \param variant Media variant for which to get the description
+ *
+ * \retval non-zero on error
+ * \return zero on success
+ */
+int ast_media_index_update(struct ast_media_index *index,
+ const char *variant);
+#if defined(__cplusplus) || defined(c_plusplus)
+}
+#endif
+
+#endif /* _ASTERISK_MEDIA_INDEX_H */
diff --git a/include/asterisk/sounds_index.h b/include/asterisk/sounds_index.h
new file mode 100644
index 000000000..d7eb05332
--- /dev/null
+++ b/include/asterisk/sounds_index.h
@@ -0,0 +1,55 @@
+/*
+ * Asterisk -- An open source telephony toolkit.
+ *
+ * Copyright (C) 2013, Digium, Inc.
+ *
+ * Kinsey Moore <kmoore@digium.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 Sound file format and description indexer.
+ */
+
+#ifndef _ASTERISK_SOUNDS_INDEX_H
+#define _ASTERISK_SOUNDS_INDEX_H
+
+#if defined(__cplusplus) || defined(c_plusplus)
+extern "C" {
+#endif
+
+/*!
+ * \brief Object representing a media index
+ */
+struct ast_media_index;
+
+/*!
+ * \brief Reload the sounds index
+ *
+ * \retval zero on success
+ * \retval non-zero on failure
+ */
+int ast_sounds_reindex(void);
+
+/*!
+ * \brief Get the sounds index
+ *
+ * \retval sounds index (must be ao2_cleanup()'ed)
+ * \retval NULL on failure
+ */
+struct ast_media_index *ast_sounds_get_index(void);
+
+#if defined(__cplusplus) || defined(c_plusplus)
+}
+#endif
+
+#endif /* _ASTERISK_SOUNDS_INDEX_H */