chan_iax2: Several media format fixes.

* Fixed the iax.conf bandwidth option.  This is the root cause of
ASTERISK-24150.

* Added checks in iax2_request() to ensure that there are actual formats
requested for the new channel to prevent any more fracks from issues like
ASTERISK-24150.  This is a consequence of the iax.conf bandwidth option
not working.

* Fixed struct iax2_codec_pref.order member size mismatch issue when
converting to and from the codec preference order list passed over the
wire.  In addition the values sent over the wire are now compatible with
previous Asterisk versions.

* Fixed several issues dealing with the struct iax2_codec_pref members.
Off-by-one, array limit errors, and the order/framing members always need
to be updated together.

* Made iax2_request() setup the channel's native format preference order
according to the user's wishes.  The new media format strategy needs the
order specified earler.

* Fixed usage of ast_format_compatibility_bitfield2format().  The function
can return NULL if the bitfield was not associated with a function.

* Deleted dead code iax2_codec_pref_getsize() and
iax2_codec_pref_setsize().

* Made iax2_parse_allow_disallow() and iax2_codec_pref_string() call
iax2_codec_pref_to_cap() instead of inlining it.

* Made IAX_CAPABILITY_MEDBANDWIDTH, IAX_CAPABILITY_LOWBANDWIDTH, and
IAX_CAPABILITY_LOWFREE constants again as they were in Asterisk v1.8.

* Renamed prefs to prefs_global so it won't get confused with the local
pref versions.

* Fixed too small buffer in handle_cli_iax2_show_peer().

* Fixed ast_cli() calls in handle_cli_iax2_show_peer() to output complete
lines.

* Changed struct create_addr_info.prefs to be struct iax2_codec_pref as an
optimization so iax2_request() and iax2_call() do less work.

* Fixed a potential deadlock in ast_iax2_new() on an off-nominal path when
the pbx could not get started.

* Made set_config() setup a local prefs list along side the local
capability format bitfield.  Once the config is loaded, then the local
copies are put into the global versions.

* Fix unininialized codec_buf in function_iaxpeer().

ASTERISK-24150 #close
Reported by: Scott Griepentrog

Review: https://reviewboard.asterisk.org/r/3890/


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@420364 65c4cc65-6c06-0410-ace0-fbb531ad65f3

2 files changed, 54 insertions, 17 deletions

diff --git a/channels/iax2/include/codec_pref.h b/channels/iax2/include/codec_pref.h
index bfb889164..2af3692d8 100644
--- a/channels/iax2/include/codec_pref.h
+++ b/channels/iax2/include/codec_pref.h
@@ -32,8 +32,8 @@ struct ast_format_cap;
 
 #define IAX2_CODEC_PREF_SIZE 64
 struct iax2_codec_pref {
-	/*! This array is ordered by preference and contains the codec bitfield. */
-	uint64_t order[IAX2_CODEC_PREF_SIZE];
+	/*! Array is ordered by preference.  Contains the iax2_supported_formats[] index + 1. */
+	char order[IAX2_CODEC_PREF_SIZE];
 	/*! Framing size of the codec */
 	unsigned int framing[IAX2_CODEC_PREF_SIZE];
 };
@@ -45,7 +45,7 @@ struct iax2_codec_pref {
  *
  * \return the bitfield value of the order_value format
  */
-uint64_t iax2_codec_pref_order_value_to_format_bitfield(uint64_t order_value);
+uint64_t iax2_codec_pref_order_value_to_format_bitfield(int order_value);
 
 /*!
  * \brief Convert a format bitfield into an iax2_codec_pref order value
@@ -59,7 +59,7 @@ uint64_t iax2_codec_pref_order_value_to_format_bitfield(uint64_t order_value);
  *  It will work with multiformat bitfields, but it can only return the
  *  index of the most significant one if that is the case.
  */
-uint64_t iax2_codec_pref_format_bitfield_to_order_value(uint64_t bitfield);
+int iax2_codec_pref_format_bitfield_to_order_value(uint64_t bitfield);
 
 /*!
  * \brief Codec located at a particular place in the preference index.
@@ -70,8 +70,32 @@ uint64_t iax2_codec_pref_format_bitfield_to_order_value(uint64_t bitfield);
 */
 struct ast_format *iax2_codec_pref_index(struct iax2_codec_pref *pref, int index, struct ast_format **result);
 
-/*! \brief Convert a preference structure to a capabilities structure */
-void iax2_codec_pref_to_cap(struct iax2_codec_pref *pref, struct ast_format_cap *cap);
+/*!
+ * \brief Convert a preference structure to a capabilities structure.
+ *
+ * \param pref Formats in preference order to build the capabilities.
+ * \param cap Capabilities structure to place formats into
+ *
+ * \retval 0 on success.
+ * \retval -1 on error.
+ *
+ * \note If failure occurs the capabilities structure may contain a partial set of formats
+ */
+int iax2_codec_pref_to_cap(struct iax2_codec_pref *pref, struct ast_format_cap *cap);
+
+/*!
+ * \brief Convert a bitfield to a format capabilities structure in the "best" order.
+ *
+ * \param bitfield The bitfield for the media formats
+ * \param prefs Format preference order to use as a guide. (May be NULL)
+ * \param cap Capabilities structure to place formats into
+ *
+ * \retval 0 on success.
+ * \retval -1 on error.
+ *
+ * \note If failure occurs the capabilities structure may contain a partial set of formats
+ */
+int iax2_codec_pref_best_bitfield2cap(uint64_t bitfield, struct iax2_codec_pref *prefs, struct ast_format_cap *cap);
 
 /*! \brief Removes format from the pref list that aren't in the bitfield */
 void iax2_codec_pref_remove_missing(struct iax2_codec_pref *pref, uint64_t bitfield);
@@ -94,21 +118,13 @@ int iax2_codec_pref_string(struct iax2_codec_pref *pref, char *buf, size_t size)
 
 /*! \brief Append a audio codec to a preference list, removing it first if it was already there
 */
-int iax2_codec_pref_append(struct iax2_codec_pref *pref, struct ast_format *format, unsigned int framing);
+void iax2_codec_pref_append(struct iax2_codec_pref *pref, struct ast_format *format, unsigned int framing);
 
 /*! \brief Prepend an audio codec to a preference list, removing it first if it was already there
 */
 void iax2_codec_pref_prepend(struct iax2_codec_pref *pref, struct ast_format *format, unsigned int framing,
 	int only_if_existing);
 
-/*! \brief Get packet size for codec
-*/
-unsigned int iax2_codec_pref_getsize(struct iax2_codec_pref *pref, int index);
-
-/*! \brief Set packet size for codec
-*/
-int iax2_codec_pref_setsize(struct iax2_codec_pref *pref, struct ast_format *format, int framems);
-
 /*! \brief Shift an audio codec preference list up or down 65 bytes so that it becomes an ASCII string
  * \note Due to a misunderstanding in how codec preferences are stored, this
  * list starts at 'B', not 'A'.  For backwards compatibility reasons, this
@@ -120,4 +136,15 @@ int iax2_codec_pref_setsize(struct iax2_codec_pref *pref, struct ast_format *for
  */
 void iax2_codec_pref_convert(struct iax2_codec_pref *pref, char *buf, size_t size, int right);
 
+/*!
+ * \brief Create codec preference list from the given bitfield formats.
+ * \since 13.0.0
+ *
+ * \param pref Codec preference list to setup from the given bitfield.
+ * \param bitfield Format bitfield to guide preference list creation.
+ *
+ * \return Updated bitfield with any bits not mapped to a format cleared.
+ */
+uint64_t iax2_codec_pref_from_bitfield(struct iax2_codec_pref *pref, uint64_t bitfield);
+
 #endif /* _IAX2_CODEC_PREF_H_ */
diff --git a/channels/iax2/include/format_compatibility.h b/channels/iax2/include/format_compatibility.h
index aa29cfa2c..e3839fcda 100644
--- a/channels/iax2/include/format_compatibility.h
+++ b/channels/iax2/include/format_compatibility.h
@@ -45,11 +45,21 @@ uint64_t iax2_format_compatibility_cap2bitfield(const struct ast_format_cap *cap
  * \param bitfield The bitfield for the media formats
  * \param cap Capabilities structure to place formats into
  *
- * \retval non-NULL success
- * \retval NULL failure
+ * \retval 0 on success.
+ * \retval -1 on error.
  *
  * \note If failure occurs the capabilities structure may contain a partial set of formats
  */
 int iax2_format_compatibility_bitfield2cap(uint64_t bitfield, struct ast_format_cap *cap);
 
+/*!
+ * \brief Pick the best format from the given bitfield formats.
+ *
+ * \param formats The bitfield for the media formats
+ *
+ * \retval non-zero Best format out of the given formats.
+ * \retval zero No formats present or no formats considered best.
+ */
+uint64_t iax2_format_compatibility_best(uint64_t formats);
+
 #endif /* _IAX2_FORMAT_COMPATIBILITY_H */