media formats: re-architect handling of media for performance improvements

In the old times media formats were represented using a bit field. This was
fast but had a few limitations.
 1. Asterisk was limited in how many formats it could handle.
 2. Formats, being a bit field, could not include any attribute information.
    A format was strictly its type, e.g., "this is ulaw".
This was changed in Asterisk 10 (see
https://wiki.asterisk.org/wiki/display/AST/Media+Architecture+Proposal for
notes on that work) which led to the creation of the ast_format structure.
This structure allowed Asterisk to handle attributes and bundle information
with a format.

Additionally, ast_format_cap was created to act as a container for multiple
formats that, together, formed the capability of some entity. Another
mechanism was added to allow logic to be registered which performed format
attribute negotiation. Everywhere throughout the codebase Asterisk was
changed to use this strategy.

Unfortunately, in software, there is no free lunch. These new capabilities
came at a cost.

Performance analysis and profiling showed that we spend an inordinate
amount of time comparing, copying, and generally manipulating formats and
their related structures. Basic prototyping has shown that a reasonably
large performance improvement could be made in this area. This patch is the
result of that project, which overhauled the media format architecture
and its usage in Asterisk to improve performance.

Generally, the new philosophy for handling formats is as follows:
 * The ast_format structure is reference counted. This removed a large amount
   of the memory allocations and copying that was done in prior versions.
 * In order to prevent race conditions while keeping things performant, the
   ast_format structure is immutable by convention and lock-free. Violate this
   tenet at your peril!
 * Because formats are reference counted, codecs are also reference counted.
   The Asterisk core generally provides built-in codecs and caches the
   ast_format structures created to represent them. Generally, to prevent
   inordinate amounts of module reference bumping, codecs and formats can be
   added at run-time but cannot be removed.
 * All compatibility with the bit field representation of codecs/formats has
   been moved to a compatibility API. The primary user of this representation
   is chan_iax2, which must continue to maintain its bit-field usage of formats
   for interoperability concerns.
 * When a format is negotiated with attributes, or when a format cannot be
   represented by one of the cached formats, a new format object is created or
   cloned from an existing format. That format may have the same codec
   underlying it, but is a different format than a version of the format with
   different attributes or without attributes.
 * While formats are reference counted objects, the reference count maintained
   on the format should be manipulated with care. Formats are generally cached
   and will persist for the lifetime of Asterisk and do not explicitly need
   to have their lifetime modified. An exception to this is when the user of a
   format does not know where the format came from *and* the user may outlive
   the provider of the format. This occurs, for example, when a format is read
   from a channel: the channel may have a format with attributes (hence,
   non-cached) and the user of the format may last longer than the channel (if
   the reference to the channel is released prior to the format's reference).

For more information on this work, see the API design notes:
  https://wiki.asterisk.org/wiki/display/AST/Media+Format+Rewrite

Finally, this work was the culmination of a large number of developer's
efforts. Extra thanks goes to Corey Farrell, who took on a large amount of the
work in the Asterisk core, chan_sip, and was an invaluable resource in peer
reviews throughout this project.

There were a substantial number of patches contributed during this work; the
following issues/patch names simply reflect some of the work (and will cause
the release scripts to give attribution to the individuals who work on them).

Reviews:
 https://reviewboard.asterisk.org/r/3814
 https://reviewboard.asterisk.org/r/3808
 https://reviewboard.asterisk.org/r/3805
 https://reviewboard.asterisk.org/r/3803
 https://reviewboard.asterisk.org/r/3801
 https://reviewboard.asterisk.org/r/3798
 https://reviewboard.asterisk.org/r/3800
 https://reviewboard.asterisk.org/r/3794
 https://reviewboard.asterisk.org/r/3793
 https://reviewboard.asterisk.org/r/3792
 https://reviewboard.asterisk.org/r/3791
 https://reviewboard.asterisk.org/r/3790
 https://reviewboard.asterisk.org/r/3789
 https://reviewboard.asterisk.org/r/3788
 https://reviewboard.asterisk.org/r/3787
 https://reviewboard.asterisk.org/r/3786
 https://reviewboard.asterisk.org/r/3784
 https://reviewboard.asterisk.org/r/3783
 https://reviewboard.asterisk.org/r/3778
 https://reviewboard.asterisk.org/r/3774
 https://reviewboard.asterisk.org/r/3775
 https://reviewboard.asterisk.org/r/3772
 https://reviewboard.asterisk.org/r/3761
 https://reviewboard.asterisk.org/r/3754
 https://reviewboard.asterisk.org/r/3753
 https://reviewboard.asterisk.org/r/3751
 https://reviewboard.asterisk.org/r/3750
 https://reviewboard.asterisk.org/r/3748
 https://reviewboard.asterisk.org/r/3747
 https://reviewboard.asterisk.org/r/3746
 https://reviewboard.asterisk.org/r/3742
 https://reviewboard.asterisk.org/r/3740
 https://reviewboard.asterisk.org/r/3739
 https://reviewboard.asterisk.org/r/3738
 https://reviewboard.asterisk.org/r/3737
 https://reviewboard.asterisk.org/r/3736
 https://reviewboard.asterisk.org/r/3734
 https://reviewboard.asterisk.org/r/3722
 https://reviewboard.asterisk.org/r/3713
 https://reviewboard.asterisk.org/r/3703
 https://reviewboard.asterisk.org/r/3689
 https://reviewboard.asterisk.org/r/3687
 https://reviewboard.asterisk.org/r/3674
 https://reviewboard.asterisk.org/r/3671
 https://reviewboard.asterisk.org/r/3667
 https://reviewboard.asterisk.org/r/3665
 https://reviewboard.asterisk.org/r/3625
 https://reviewboard.asterisk.org/r/3602
 https://reviewboard.asterisk.org/r/3519
 https://reviewboard.asterisk.org/r/3518
 https://reviewboard.asterisk.org/r/3516
 https://reviewboard.asterisk.org/r/3515
 https://reviewboard.asterisk.org/r/3512
 https://reviewboard.asterisk.org/r/3506
 https://reviewboard.asterisk.org/r/3413
 https://reviewboard.asterisk.org/r/3410
 https://reviewboard.asterisk.org/r/3387
 https://reviewboard.asterisk.org/r/3388
 https://reviewboard.asterisk.org/r/3389
 https://reviewboard.asterisk.org/r/3390
 https://reviewboard.asterisk.org/r/3321
 https://reviewboard.asterisk.org/r/3320
 https://reviewboard.asterisk.org/r/3319
 https://reviewboard.asterisk.org/r/3318
 https://reviewboard.asterisk.org/r/3266
 https://reviewboard.asterisk.org/r/3265
 https://reviewboard.asterisk.org/r/3234
 https://reviewboard.asterisk.org/r/3178

ASTERISK-23114 #close
Reported by: mjordan
  media_formats_translation_core.diff uploaded by kharwell (License 6464)
  rb3506.diff uploaded by mjordan (License 6283)
  media_format_app_file.diff uploaded by kharwell (License 6464) 
  misc-2.diff uploaded by file (License 5000)
  chan_mild-3.diff uploaded by file (License 5000) 
  chan_obscure.diff uploaded by file (License 5000) 
  jingle.diff uploaded by file (License 5000) 
  funcs.diff uploaded by file (License 5000) 
  formats.diff uploaded by file (License 5000) 
  core.diff uploaded by file (License 5000) 
  bridges.diff uploaded by file (License 5000) 
  mf-codecs-2.diff uploaded by file (License 5000) 
  mf-app_fax.diff uploaded by file (License 5000) 
  mf-apps-3.diff uploaded by file (License 5000) 
  media-formats-3.diff uploaded by file (License 5000) 

ASTERISK-23715
  rb3713.patch uploaded by coreyfarrell (License 5909)
  rb3689.patch uploaded by mjordan (License 6283)
  
ASTERISK-23957
  rb3722.patch uploaded by mjordan (License 6283) 
  mf-attributes-3.diff uploaded by file (License 5000) 

ASTERISK-23958
Tested by: jrose
  rb3822.patch uploaded by coreyfarrell (License 5909) 
  rb3800.patch uploaded by jrose (License 6182)
  chan_sip.diff uploaded by mjordan (License 6283) 
  rb3747.patch uploaded by jrose (License 6182)

ASTERISK-23959 #close
Tested by: sgriepentrog, mjordan, coreyfarrell
  sip_cleanup.diff uploaded by opticron (License 6273)
  chan_sip_caps.diff uploaded by mjordan (License 6283) 
  rb3751.patch uploaded by coreyfarrell (License 5909) 
  chan_sip-3.diff uploaded by file (License 5000) 

ASTERISK-23960 #close
Tested by: opticron
  direct_media.diff uploaded by opticron (License 6273) 
  pjsip-direct-media.diff uploaded by file (License 5000) 
  format_cap_remove.diff uploaded by opticron (License 6273) 
  media_format_fixes.diff uploaded by opticron (License 6273) 
  chan_pjsip-2.diff uploaded by file (License 5000) 

ASTERISK-23966 #close
Tested by: rmudgett
  rb3803.patch uploaded by rmudgetti (License 5621)
  chan_dahdi.diff uploaded by file (License 5000) 
  
ASTERISK-24064 #close
Tested by: coreyfarrell, mjordan, opticron, file, rmudgett, sgriepentrog, jrose
  rb3814.patch uploaded by rmudgett (License 5621) 
  moh_cleanup.diff uploaded by opticron (License 6273) 
  bridge_leak.diff uploaded by opticron (License 6273) 
  translate.diff uploaded by file (License 5000) 
  rb3795.patch uploaded by rmudgett (License 5621) 
  tls_fix.diff uploaded by mjordan (License 6283) 
  fax-mf-fix-2.diff uploaded by file (License 5000) 
  rtp_transfer_stuff uploaded by mjordan (License 6283) 
  rb3787.patch uploaded by rmudgett (License 5621) 
  media-formats-explicit-translate-format-3.diff uploaded by file (License 5000) 
  format_cache_case_fix.diff uploaded by opticron (License 6273) 
  rb3774.patch uploaded by rmudgett (License 5621) 
  rb3775.patch uploaded by rmudgett (License 5621) 
  rtp_engine_fix.diff uploaded by opticron (License 6273) 
  rtp_crash_fix.diff uploaded by opticron (License 6273) 
  rb3753.patch uploaded by mjordan (License 6283) 
  rb3750.patch uploaded by mjordan (License 6283) 
  rb3748.patch uploaded by rmudgett (License 5621) 
  media_format_fixes.diff uploaded by opticron (License 6273) 
  rb3740.patch uploaded by mjordan (License 6283) 
  rb3739.patch uploaded by mjordan (License 6283) 
  rb3734.patch uploaded by mjordan (License 6283) 
  rb3689.patch uploaded by mjordan (License 6283) 
  rb3674.patch uploaded by coreyfarrell (License 5909) 
  rb3671.patch uploaded by coreyfarrell (License 5909) 
  rb3667.patch uploaded by coreyfarrell (License 5909) 
  rb3665.patch uploaded by mjordan (License 6283) 
  rb3625.patch uploaded by coreyfarrell (License 5909) 
  rb3602.patch uploaded by coreyfarrell (License 5909) 
  format_compatibility-2.diff uploaded by file (License 5000) 
  core.diff uploaded by file (License 5000) 
  


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

1 files changed, 369 insertions, 0 deletions

diff --git a/tests/test_core_codec.c b/tests/test_core_codec.c
new file mode 100644
index 000000000..499e633df
--- /dev/null
+++ b/tests/test_core_codec.c
@@ -0,0 +1,369 @@
+/*
+ * Asterisk -- An open source telephony toolkit.
+ *
+ * Copyright (C) 2014, Digium, Inc.
+ *
+ * Joshua Colp <jcolp@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 Core Codec API Unit Tests
+ *
+ * \author Joshua Colp <jcolp@digium.com>
+ *
+ */
+
+/*** MODULEINFO
+	<depend>TEST_FRAMEWORK</depend>
+	<support_level>core</support_level>
+ ***/
+
+#include "asterisk.h"
+
+ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
+
+#include "asterisk/test.h"
+#include "asterisk/module.h"
+#include "asterisk/codec.h"
+
+static struct ast_codec known_unknown = {
+	.name = "unit_test",
+	.description = "Unit test codec",
+	.type = AST_MEDIA_TYPE_AUDIO,
+	.sample_rate = 8000,
+	.minimum_ms = 10,
+	.maximum_ms = 150,
+	.default_ms = 20,
+};
+
+static struct ast_codec doubly = {
+	.name = "unit_test_double",
+	.description = "Unit test codec",
+	.type = AST_MEDIA_TYPE_AUDIO,
+	.sample_rate = 8000,
+	.minimum_ms = 10,
+	.maximum_ms = 150,
+	.default_ms = 20,
+};
+
+static struct ast_codec unknown = {
+	.name = "unit_test_unknown",
+	.description = "Unit test codec",
+	.type = AST_MEDIA_TYPE_UNKNOWN,
+	.sample_rate = 8000,
+	.minimum_ms = 10,
+	.maximum_ms = 150,
+	.default_ms = 20,
+};
+
+static struct ast_codec audio_without_rate = {
+	.name = "unit_test_audio_without_rate",
+	.description = "Unit test codec",
+	.type = AST_MEDIA_TYPE_AUDIO,
+	.minimum_ms = 10,
+	.maximum_ms = 150,
+	.default_ms = 20,
+};
+
+static struct ast_codec audio_get = {
+	.name = "unit_test_audio_get",
+	.description = "Unit test codec",
+	.type = AST_MEDIA_TYPE_AUDIO,
+	.sample_rate = 8000,
+	.minimum_ms = 10,
+	.maximum_ms = 150,
+	.default_ms = 20,
+};
+
+static struct ast_codec audio_get_unknown = {
+	.name = "unit_test_audio_get_unknown",
+	.description = "Unit test codec",
+	.type = AST_MEDIA_TYPE_AUDIO,
+	.sample_rate = 8000,
+	.minimum_ms = 10,
+	.maximum_ms = 150,
+	.default_ms = 20,
+};
+
+static struct ast_codec audio_get_id = {
+	.name = "unit_test_audio_get_id",
+	.description = "Unit test codec",
+	.type = AST_MEDIA_TYPE_AUDIO,
+	.sample_rate = 8000,
+	.minimum_ms = 10,
+	.maximum_ms = 150,
+	.default_ms = 20,
+};
+
+AST_TEST_DEFINE(codec_register)
+{
+	switch (cmd) {
+	case TEST_INIT:
+		info->name = "codec_register";
+		info->category = "/main/core_codec/";
+		info->summary = "codec registration unit test";
+		info->description =
+			"Test registration of a core codec that is known to be unknown";
+		return AST_TEST_NOT_RUN;
+	case TEST_EXECUTE:
+		break;
+	}
+
+	if (ast_codec_register(&known_unknown)) {
+		ast_test_status_update(test, "Unsuccessfully registered a codec that is known to be unknown\n");
+		return AST_TEST_FAIL;
+	}
+
+	return AST_TEST_PASS;
+}
+
+AST_TEST_DEFINE(codec_register_twice)
+{
+	switch (cmd) {
+	case TEST_INIT:
+		info->name = "codec_register_twice";
+		info->category = "/main/core_codec/";
+		info->summary = "codec registration unit test";
+		info->description =
+			"Test double registration of a core codec to confirm it fails";
+		return AST_TEST_NOT_RUN;
+	case TEST_EXECUTE:
+		break;
+	}
+
+	if (ast_codec_register(&doubly)) {
+		ast_test_status_update(test, "Unsuccessfully registered a codec that is known to be unknown\n");
+		return AST_TEST_FAIL;
+	}
+
+	if (!ast_codec_register(&doubly)) {
+		ast_test_status_update(test, "Successfully registered a codec twice\n");
+		return AST_TEST_FAIL;
+	}
+
+	return AST_TEST_PASS;
+}
+
+AST_TEST_DEFINE(codec_register_unknown)
+{
+	switch (cmd) {
+	case TEST_INIT:
+		info->name = "codec_register_unknown";
+		info->category = "/main/core_codec/";
+		info->summary = "codec registration unit test";
+		info->description =
+			"Test that registration of an unknown codec type fails";
+		return AST_TEST_NOT_RUN;
+	case TEST_EXECUTE:
+		break;
+	}
+
+	if (!ast_codec_register(&unknown)) {
+		ast_test_status_update(test, "Successfully registered a codec with an unknown media type\n");
+		return AST_TEST_FAIL;
+	}
+
+	return AST_TEST_PASS;
+}
+
+AST_TEST_DEFINE(codec_register_audio_no_sample_rate)
+{
+	switch (cmd) {
+	case TEST_INIT:
+		info->name = "codec_register_audio_no_sample_rate";
+		info->category = "/main/core_codec/";
+		info->summary = "codec registration unit test";
+		info->description =
+			"Test that registration of an audio codec without sample rate fails";
+		return AST_TEST_NOT_RUN;
+	case TEST_EXECUTE:
+		break;
+	}
+
+	if (!ast_codec_register(&audio_without_rate)) {
+		ast_test_status_update(test, "Successfully registered an audio codec without a sample rate\n");
+		return AST_TEST_FAIL;
+	}
+
+	return AST_TEST_PASS;
+}
+
+AST_TEST_DEFINE(codec_get)
+{
+	RAII_VAR(struct ast_codec *, codec, NULL, ao2_cleanup);
+
+	switch (cmd) {
+	case TEST_INIT:
+		info->name = "codec_get";
+		info->category = "/main/core_codec/";
+		info->summary = "codec get unit test";
+		info->description =
+			"Test that getting of a known codec succeeds";
+		return AST_TEST_NOT_RUN;
+	case TEST_EXECUTE:
+		break;
+	}
+
+	if (ast_codec_register(&audio_get)) {
+		ast_test_status_update(test, "Unsucessfully registered a codec for getting\n");
+		return AST_TEST_FAIL;
+	}
+
+	codec = ast_codec_get("unit_test_audio_get", AST_MEDIA_TYPE_AUDIO, 8000);
+	if (!codec) {
+		ast_test_status_update(test, "Unsuccessfully retrieved a codec we just registered\n");
+		return AST_TEST_FAIL;
+	} else if (strcmp(codec->name, audio_get.name)) {
+		ast_test_status_update(test, "Name of retrieved codec does not match registered codec\n");
+		return AST_TEST_FAIL;
+	} else if (codec->type != audio_get.type) {
+		ast_test_status_update(test, "Type of retrieved codec does not match registered codec\n");
+		return AST_TEST_FAIL;
+	} else if (codec->sample_rate != audio_get.sample_rate) {
+		ast_test_status_update(test, "Sample rate of retrieved codec does not match registered codec\n");
+		return AST_TEST_FAIL;
+	}
+
+	return AST_TEST_PASS;
+}
+
+AST_TEST_DEFINE(codec_get_unregistered)
+{
+	RAII_VAR(struct ast_codec *, codec, NULL, ao2_cleanup);
+
+	switch (cmd) {
+	case TEST_INIT:
+		info->name = "codec_get_unregistered";
+		info->category = "/main/core_codec/";
+		info->summary = "codec get unit test";
+		info->description =
+			"Test that getting of a codec that is not registered fails";
+		return AST_TEST_NOT_RUN;
+	case TEST_EXECUTE:
+		break;
+	}
+
+	codec = ast_codec_get("goats", AST_MEDIA_TYPE_AUDIO, 8000);
+	if (codec) {
+		ast_test_status_update(test, "Successfully got a codec named '%s' when getting a codec named 'goats'\n",
+			codec->name);
+		return AST_TEST_FAIL;
+	}
+
+	return AST_TEST_PASS;
+}
+
+AST_TEST_DEFINE(codec_get_unknown)
+{
+	RAII_VAR(struct ast_codec *, codec, NULL, ao2_cleanup);
+
+	switch (cmd) {
+	case TEST_INIT:
+		info->name = "codec_get_unknown";
+		info->category = "/main/core_codec/";
+		info->summary = "codec get unit test";
+		info->description =
+			"Test that getting of a known codec using name and unknown type succeeds";
+		return AST_TEST_NOT_RUN;
+	case TEST_EXECUTE:
+		break;
+	}
+
+	if (ast_codec_register(&audio_get_unknown)) {
+		ast_test_status_update(test, "Unsucessfully registered a codec for getting\n");
+		return AST_TEST_FAIL;
+	}
+
+	codec = ast_codec_get("unit_test_audio_get_unknown", AST_MEDIA_TYPE_UNKNOWN, 8000);
+	if (!codec) {
+		ast_test_status_update(test, "Unsuccessfully retrieved a codec we just registered\n");
+		return AST_TEST_FAIL;
+	} else if (strcmp(codec->name, audio_get_unknown.name)) {
+		ast_test_status_update(test, "Name of retrieved codec does not match registered codec\n");
+		return AST_TEST_FAIL;
+	} else if (codec->type != audio_get_unknown.type) {
+		ast_test_status_update(test, "Type of retrieved codec does not match registered codec\n");
+		return AST_TEST_FAIL;
+	} else if (codec->sample_rate != audio_get_unknown.sample_rate) {
+		ast_test_status_update(test, "Sample rate of retrieved codec does not match registered codec\n");
+		return AST_TEST_FAIL;
+	}
+
+	return AST_TEST_PASS;
+}
+
+AST_TEST_DEFINE(codec_get_id)
+{
+	RAII_VAR(struct ast_codec *, named, NULL, ao2_cleanup);
+	RAII_VAR(struct ast_codec *, codec, NULL, ao2_cleanup);
+
+	switch (cmd) {
+	case TEST_INIT:
+		info->name = "codec_get_unknown";
+		info->category = "/main/core_codec/";
+		info->summary = "codec get unit test";
+		info->description =
+			"Test that getting of a known codec using name and unknown type succeeds";
+		return AST_TEST_NOT_RUN;
+	case TEST_EXECUTE:
+		break;
+	}
+
+	if (ast_codec_register(&audio_get_id)) {
+		ast_test_status_update(test, "Unsucessfully registered a codec for getting\n");
+		return AST_TEST_FAIL;
+	}
+
+	named = ast_codec_get("unit_test_audio_get_id", AST_MEDIA_TYPE_AUDIO, 8000);
+	if (!named) {
+		ast_test_status_update(test, "Unsuccessfully retrieved a codec we just registered\n");
+		return AST_TEST_FAIL;
+	}
+
+	codec = ast_codec_get_by_id(named->id);
+	if (!codec) {
+		ast_test_status_update(test, "Unsuccessfully retrieved a codec using id of a named codec we just got\n");
+		return AST_TEST_FAIL;
+	}
+
+	return AST_TEST_PASS;
+}
+
+static int unload_module(void)
+{
+	AST_TEST_UNREGISTER(codec_register);
+	AST_TEST_UNREGISTER(codec_register_twice);
+	AST_TEST_UNREGISTER(codec_register_unknown);
+	AST_TEST_UNREGISTER(codec_register_audio_no_sample_rate);
+	AST_TEST_UNREGISTER(codec_get);
+	AST_TEST_UNREGISTER(codec_get_unregistered);
+	AST_TEST_UNREGISTER(codec_get_unknown);
+	AST_TEST_UNREGISTER(codec_get_id);
+	return 0;
+}
+
+static int load_module(void)
+{
+	AST_TEST_REGISTER(codec_register);
+	AST_TEST_REGISTER(codec_register_twice);
+	AST_TEST_REGISTER(codec_register_unknown);
+	AST_TEST_REGISTER(codec_register_audio_no_sample_rate);
+	AST_TEST_REGISTER(codec_get);
+	AST_TEST_REGISTER(codec_get_unregistered);
+	AST_TEST_REGISTER(codec_get_unknown);
+	AST_TEST_REGISTER(codec_get_id);
+	return AST_MODULE_LOAD_SUCCESS;
+}
+
+AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Core codec API test module");