mirror of
https://github.com/asterisk/asterisk.git
synced 2025-10-12 07:35:18 +00:00
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
This commit is contained in:
Matthew Jordan
186
include/asterisk/codec.h
Normal file
186
include/asterisk/codec.h
Normal file
@@ -0,0 +1,186 @@
|
||||
/*
|
||||
* 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 Codec API
|
||||
*
|
||||
* \author Joshua Colp <jcolp@digium.com>
|
||||
*/
|
||||
|
||||
#ifndef _AST_CODEC_H_
|
||||
#define _AST_CODEC_H_
|
||||
|
||||
/*! \brief Types of media */
|
||||
enum ast_media_type {
|
||||
AST_MEDIA_TYPE_UNKNOWN = 0,
|
||||
AST_MEDIA_TYPE_AUDIO,
|
||||
AST_MEDIA_TYPE_VIDEO,
|
||||
AST_MEDIA_TYPE_IMAGE,
|
||||
AST_MEDIA_TYPE_TEXT,
|
||||
};
|
||||
|
||||
struct ast_module;
|
||||
|
||||
/*! \brief Represents a media codec within Asterisk. */
|
||||
struct ast_codec {
|
||||
/*! \brief Internal unique identifier for this codec, set at registration time (starts at 1) */
|
||||
unsigned int id;
|
||||
/*! \brief Name for this codec */
|
||||
const char *name;
|
||||
/*! \brief Brief description */
|
||||
const char *description;
|
||||
/*! \brief Type of media this codec contains */
|
||||
enum ast_media_type type;
|
||||
/*! \brief Sample rate (number of samples carried in a second) */
|
||||
unsigned int sample_rate;
|
||||
/*! \brief Minimum length of media that can be carried (in milliseconds) in a frame */
|
||||
unsigned int minimum_ms;
|
||||
/*! \brief Maximum length of media that can be carried (in milliseconds) in a frame */
|
||||
unsigned int maximum_ms;
|
||||
/*! \brief Default length of media carried (in milliseconds) in a frame */
|
||||
unsigned int default_ms;
|
||||
/*! \brief Length in bytes of the data payload of a minimum_ms frame */
|
||||
unsigned int minimum_bytes;
|
||||
/*!
|
||||
* \brief Retrieve the number of samples in a frame
|
||||
*
|
||||
* \param frame The frame to examine
|
||||
*
|
||||
* \return the number of samples
|
||||
*/
|
||||
int (*samples_count)(struct ast_frame *frame);
|
||||
/*!
|
||||
* \brief Retrieve the length of media from number of samples
|
||||
*
|
||||
* \param samples The number of samples
|
||||
*
|
||||
* \return The length of media in milliseconds
|
||||
*/
|
||||
int (*get_length)(unsigned int samples);
|
||||
/*! \brief Whether the media can be smoothed or not */
|
||||
unsigned int smooth;
|
||||
/*! \brief The module that registered this codec */
|
||||
struct ast_module *mod;
|
||||
};
|
||||
|
||||
/*!
|
||||
* \brief Initialize codec support within the core.
|
||||
*
|
||||
* \retval 0 success
|
||||
* \retval -1 failure
|
||||
*/
|
||||
int ast_codec_init(void);
|
||||
|
||||
/*!
|
||||
* \brief Initialize built-in codecs within the core.
|
||||
*
|
||||
* \retval 0 success
|
||||
* \retval -1 failure
|
||||
*/
|
||||
int ast_codec_builtin_init(void);
|
||||
|
||||
/*!
|
||||
* \brief This function is used to register a codec with the Asterisk core. Registering
|
||||
* allows it to be passed through in frames and configured in channel drivers.
|
||||
*
|
||||
* \param codec to register
|
||||
* \param mod the module this codec is provided by
|
||||
*
|
||||
* \retval 0 success
|
||||
* \retval -1 failure
|
||||
*/
|
||||
int __ast_codec_register(struct ast_codec *codec, struct ast_module *mod);
|
||||
|
||||
/*!
|
||||
* \brief This function is used to register a codec with the Asterisk core. Registering
|
||||
* allows it to be passed through in frames and configured in channel drivers.
|
||||
*
|
||||
* \param codec to register
|
||||
*
|
||||
* \retval 0 success
|
||||
* \retval -1 failure
|
||||
*/
|
||||
#define ast_codec_register(codec) __ast_codec_register(codec, ast_module_info->self)
|
||||
|
||||
/*!
|
||||
* \brief Retrieve a codec given a name, type, and sample rate
|
||||
*
|
||||
* \param name The name of the codec
|
||||
* \param type The type of the codec
|
||||
* \param sample_rate Optional sample rate, may not be applicable for some types
|
||||
*
|
||||
* \retval non-NULL success
|
||||
* \retval NULL failure
|
||||
*
|
||||
* \note The returned codec is reference counted and ao2_ref or ao2_cleanup
|
||||
* must be used to release the reference.
|
||||
*/
|
||||
struct ast_codec *ast_codec_get(const char *name, enum ast_media_type type, unsigned int sample_rate);
|
||||
|
||||
/*!
|
||||
* \brief Retrieve a codec given the unique identifier
|
||||
*
|
||||
* \param id The unique identifier
|
||||
*
|
||||
* \retval non-NULL success
|
||||
* \retval NULL failure
|
||||
*
|
||||
* \note Identifiers start at 1 so if iterating don't start at 0.
|
||||
*
|
||||
* \note The returned codec is reference counted and ao2_ref or ao2_cleanup
|
||||
* must be used to release the reference.
|
||||
*/
|
||||
struct ast_codec *ast_codec_get_by_id(int id);
|
||||
|
||||
/*!
|
||||
* \brief Retrieve the current maximum identifier for codec iteration
|
||||
*
|
||||
* \return Maximum codec identifier
|
||||
*/
|
||||
int ast_codec_get_max(void);
|
||||
|
||||
/*!
|
||||
* \brief Conversion function to take a media type and turn it into a string
|
||||
*
|
||||
* \param type The media type
|
||||
*
|
||||
* \retval string representation of the media type
|
||||
*/
|
||||
const char *ast_codec_media_type2str(enum ast_media_type type);
|
||||
|
||||
/*!
|
||||
* \brief Get the number of samples contained within a frame
|
||||
*
|
||||
* \param frame The frame itself
|
||||
*
|
||||
* \retval number of samples in the frame
|
||||
*/
|
||||
unsigned int ast_codec_samples_count(struct ast_frame *frame);
|
||||
|
||||
/*!
|
||||
* \brief Get the length of media (in milliseconds) given a number of samples
|
||||
*
|
||||
* \param codec The codec itself
|
||||
* \param samples The number of samples
|
||||
*
|
||||
* \retval length of media (in milliseconds)
|
||||
*/
|
||||
unsigned int ast_codec_determine_length(const struct ast_codec *codec, unsigned int samples);
|
||||
|
||||
#endif /* _AST_CODEC_H */
|
||||
Reference in New Issue
Block a user