From: Tilghman Lesher Date: Wed, 1 Dec 2010 17:01:00 +0000 (+0000) Subject: Merged revisions 296990 via svnmerge from X-Git-Tag: 1.6.2.16-rc1~17 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1ff4cc9dc7d89e9e6e7ac9c2a4e89d0ab777491a;p=thirdparty%2Fasterisk.git Merged revisions 296990 via svnmerge from https://origsvn.digium.com/svn/asterisk/branches/1.4 ........ r296990 | tilghman | 2010-12-01 10:59:26 -0600 (Wed, 01 Dec 2010) | 5 lines Clarify documentation on how we store codec preference lists. (closes issue #18397) Reported by: birgita ........ git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/1.6.2@296991 65c4cc65-6c06-0410-ace0-fbb531ad65f3 --- diff --git a/include/asterisk/frame.h b/include/asterisk/frame.h index e1270eec3a..2adb883105 100644 --- a/include/asterisk/frame.h +++ b/include/asterisk/frame.h @@ -647,7 +647,15 @@ int ast_parse_allow_disallow(struct ast_codec_pref *pref, int *mask, const char /*! \brief Dump audio codec preference list into a string */ int ast_codec_pref_string(struct ast_codec_pref *pref, char *buf, size_t size); -/*! \brief Shift an audio codec preference list up or down 65 bytes so that it becomes an ASCII string */ +/*! \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 + * cannot change. + * \param pref A codec preference list structure + * \param buf A string denoting codec preference, appropriate for use in line transmission + * \param size Size of \a buf + * \param right Boolean: if 0, convert from \a buf to \a pref; if 1, convert from \a pref to \a buf. + */ void ast_codec_pref_convert(struct ast_codec_pref *pref, char *buf, size_t size, int right); /*! \brief Returns the number of samples contained in the frame */