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

codecs: Fix ABI incompatibility created by adding format_name to ast_codec

Browse Source 
Adding format_name even to the end of ast_codec caused issued with
binary codec modules because the pointer would be garbage in asterisk
when they registered.  So, the ast_codec structure was reverted and an
internal_ast_codec structure was created just for use in codec.c.  A new
internal-only API was also added (__ast_codec_register_with_format) so
that codec_builtin could register codecs with the format_name in a
separate parameter rather than in the ast_codec structure.

ASTERISK-26144 #close
Reported-by: Alexei Gradinari

Change-Id: I6df1b08f6a6ae089db23adfe1ebc8636330265ba
This commit is contained in:
George Joseph
2016-06-28 08:00:32 -06:00
parent 541f038694
commit 4045e6d8ba
3 changed files with 52 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
include/asterisk/codec.h
View File

@@ -77,8 +77,6 @@ struct ast_codec {
unsigned int smooth; unsigned int smooth;
/*! \brief The module that registered this codec */ /*! \brief The module that registered this codec */
struct ast_module *mod; struct ast_module *mod;
/*! \brief A format name for a default sane format using this codec */
const char *format_name;
}; };
/*! /*!

62
main/codec.c
View File

@@ -49,6 +49,32 @@ static int codec_id = 1;
/*! \brief Registered codecs */ /*! \brief Registered codecs */
static struct ao2_container *codecs; static struct ao2_container *codecs;
/*!
* \internal
* \brief Internal codec structure
*
* External codecs won't know about the format_name field so the public
* ast_codec structure has to leave it out. This structure will be used
* for the internal codecs.
*
*/
struct internal_ast_codec {
/*! \brief Public codec structure. Must remain first. */
struct ast_codec external;
/*! \brief A format name for a default sane format using this codec */
const char *format_name;
};
/*!
* \internal
* \brief Internal function for registration with format name
*
* This function is only used by codec.c and codec_builtin.c and
* will be removed in Asterisk 14
*/
int __ast_codec_register_with_format(struct ast_codec *codec, const char *format_name,
struct ast_module *mod);
static int codec_hash(const void *obj, int flags) static int codec_hash(const void *obj, int flags)
{ {
const struct ast_codec *codec; const struct ast_codec *codec;
@@ -113,7 +139,7 @@ static int codec_cmp(void *obj, void *arg, int flags)
static char *show_codecs(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a) static char *show_codecs(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
{ {
struct ao2_iterator i; struct ao2_iterator i;
struct ast_codec *codec; struct internal_ast_codec *codec;
switch (cmd) { switch (cmd) {
case CLI_INIT: case CLI_INIT:
@@ -144,19 +170,19 @@ static char *show_codecs(struct ast_cli_entry *e, int cmd, struct ast_cli_args *
for (; (codec = ao2_iterator_next(&i)); ao2_ref(codec, -1)) { for (; (codec = ao2_iterator_next(&i)); ao2_ref(codec, -1)) {
if (a->argc == 4) { if (a->argc == 4) {
if (!strcasecmp(a->argv[3], "audio")) { if (!strcasecmp(a->argv[3], "audio")) {
if (codec->type != AST_MEDIA_TYPE_AUDIO) { if (codec->external.type != AST_MEDIA_TYPE_AUDIO) {
continue; continue;
} }
} else if (!strcasecmp(a->argv[3], "video")) { } else if (!strcasecmp(a->argv[3], "video")) {
if (codec->type != AST_MEDIA_TYPE_VIDEO) { if (codec->external.type != AST_MEDIA_TYPE_VIDEO) {
continue; continue;
} }
} else if (!strcasecmp(a->argv[3], "image")) { } else if (!strcasecmp(a->argv[3], "image")) {
if (codec->type != AST_MEDIA_TYPE_IMAGE) { if (codec->external.type != AST_MEDIA_TYPE_IMAGE) {
continue; continue;
} }
} else if (!strcasecmp(a->argv[3], "text")) { } else if (!strcasecmp(a->argv[3], "text")) {
if (codec->type != AST_MEDIA_TYPE_TEXT) { if (codec->external.type != AST_MEDIA_TYPE_TEXT) {
continue; continue;
} }
} else { } else {
@@ -165,11 +191,11 @@ static char *show_codecs(struct ast_cli_entry *e, int cmd, struct ast_cli_args *
} }
ast_cli(a->fd, "%8u %-5s %-12s %-16s (%s)\n", ast_cli(a->fd, "%8u %-5s %-12s %-16s (%s)\n",
codec->id, codec->external.id,
ast_codec_media_type2str(codec->type), ast_codec_media_type2str(codec->external.type),
codec->name, codec->external.name,
S_OR(codec->format_name, "no cached format"), S_OR(codec->format_name, "no cached format"),
codec->description); codec->external.description);
} }
ao2_iterator_destroy(&i); ao2_iterator_destroy(&i);
@@ -190,7 +216,7 @@ static int codec_id_cmp(void *obj, void *arg, int flags)
static char *show_codec(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a) static char *show_codec(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
{ {
int type_punned_codec; int type_punned_codec;
struct ast_codec *codec; struct internal_ast_codec *codec;
switch (cmd) { switch (cmd) {
case CLI_INIT: case CLI_INIT:
@@ -217,7 +243,7 @@ static char *show_codec(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a
return CLI_SUCCESS; return CLI_SUCCESS;
} }
ast_cli(a->fd, "%11u %s (%s)\n", (unsigned int) codec->id, codec->description, ast_cli(a->fd, "%11u %s (%s)\n", (unsigned int) codec->external.id, codec->external.description,
S_OR(codec->format_name, "no format")); S_OR(codec->format_name, "no format"));
ao2_ref(codec, -1); ao2_ref(codec, -1);
@@ -262,9 +288,14 @@ static void codec_dtor(void *obj)
} }
int __ast_codec_register(struct ast_codec *codec, struct ast_module *mod) int __ast_codec_register(struct ast_codec *codec, struct ast_module *mod)
{
return __ast_codec_register_with_format(codec, NULL, mod);
}
int __ast_codec_register_with_format(struct ast_codec *codec, const char *format_name, struct ast_module *mod)
{ {
SCOPED_AO2WRLOCK(lock, codecs); SCOPED_AO2WRLOCK(lock, codecs);
struct ast_codec *codec_new; struct internal_ast_codec *codec_new;
/* Some types have specific requirements */ /* Some types have specific requirements */
if (codec->type == AST_MEDIA_TYPE_UNKNOWN) { if (codec->type == AST_MEDIA_TYPE_UNKNOWN) {
@@ -293,8 +324,9 @@ int __ast_codec_register(struct ast_codec *codec, struct ast_module *mod)
codec->name, ast_codec_media_type2str(codec->type), codec->sample_rate); codec->name, ast_codec_media_type2str(codec->type), codec->sample_rate);
return -1; return -1;
} }
*codec_new = *codec; codec_new->external = *codec;
codec_new->id = codec_id++; codec_new->format_name = format_name;
codec_new->external.id = codec_id++;
ao2_link_flags(codecs, codec_new, OBJ_NOLOCK); ao2_link_flags(codecs, codec_new, OBJ_NOLOCK);
@@ -302,7 +334,7 @@ int __ast_codec_register(struct ast_codec *codec, struct ast_module *mod)
ast_module_shutdown_ref(mod); ast_module_shutdown_ref(mod);
ast_verb(2, "Registered '%s' codec '%s' at sample rate '%u' with id '%u'\n", ast_verb(2, "Registered '%s' codec '%s' at sample rate '%u' with id '%u'\n",
ast_codec_media_type2str(codec->type), codec->name, codec->sample_rate, codec_new->id); ast_codec_media_type2str(codec->type), codec->name, codec->sample_rate, codec_new->external.id);
ao2_ref(codec_new, -1); ao2_ref(codec_new, -1);

9
main/codec_builtin.c
View File

@@ -38,6 +38,9 @@ ASTERISK_REGISTER_FILE()
#include "asterisk/format_cache.h" #include "asterisk/format_cache.h"
#include "asterisk/frame.h" #include "asterisk/frame.h"
int __ast_codec_register_with_format(struct ast_codec *codec, const char *format_name,
struct ast_module *mod);
enum frame_type { enum frame_type {
TYPE_HIGH, /* 0x0 */ TYPE_HIGH, /* 0x0 */
TYPE_LOW, /* 0x1 */ TYPE_LOW, /* 0x1 */
@@ -774,8 +777,7 @@ static struct ast_codec t140 = {
int __res_ ## __LINE__ = 0; \ int __res_ ## __LINE__ = 0; \
struct ast_format *__fmt_ ## __LINE__; \ struct ast_format *__fmt_ ## __LINE__; \
struct ast_codec *__codec_ ## __LINE__; \ struct ast_codec *__codec_ ## __LINE__; \
codec.format_name = (codec).name; \ res |= __ast_codec_register_with_format(&(codec), (codec).name, NULL); \
res |= __ast_codec_register(&(codec), NULL); \
__codec_ ## __LINE__ = ast_codec_get((codec).name, (codec).type, (codec).sample_rate); \ __codec_ ## __LINE__ = ast_codec_get((codec).name, (codec).type, (codec).sample_rate); \
__fmt_ ## __LINE__ = __codec_ ## __LINE__ ? ast_format_create(__codec_ ## __LINE__) : NULL; \ __fmt_ ## __LINE__ = __codec_ ## __LINE__ ? ast_format_create(__codec_ ## __LINE__) : NULL; \
res |= ast_format_cache_set(__fmt_ ## __LINE__); \ res |= ast_format_cache_set(__fmt_ ## __LINE__); \
@@ -789,8 +791,7 @@ static struct ast_codec t140 = {
int __res_ ## __LINE__ = 0; \ int __res_ ## __LINE__ = 0; \
struct ast_format *__fmt_ ## __LINE__; \ struct ast_format *__fmt_ ## __LINE__; \
struct ast_codec *__codec_ ## __LINE__; \ struct ast_codec *__codec_ ## __LINE__; \
codec.format_name = fmt_name; \ res |= __ast_codec_register_with_format(&(codec), fmt_name, NULL); \
res |= __ast_codec_register(&(codec), NULL); \
__codec_ ## __LINE__ = ast_codec_get((codec).name, (codec).type, (codec).sample_rate); \ __codec_ ## __LINE__ = ast_codec_get((codec).name, (codec).type, (codec).sample_rate); \
__fmt_ ## __LINE__ = ast_format_create_named((fmt_name), __codec_ ## __LINE__); \ __fmt_ ## __LINE__ = ast_format_create_named((fmt_name), __codec_ ## __LINE__); \
res |= ast_format_cache_set(__fmt_ ## __LINE__); \ res |= ast_format_cache_set(__fmt_ ## __LINE__); \