asterisk/contrib
George Joseph c948ce9651 sorcery/res_pjsip: Refactor for realtime performance
There were a number of places in the res_pjsip stack that were getting
all endpoints or all aors, and then filtering them locally.

A good example is pjsip_options which, on startup, retrieves all
endpoints, then the aors for those endpoints, then tests the aors to see
if the qualify_frequency is > 0.  One issue was that it never did
anything with the endpoints other than retrieve the aors so we probably
could have skipped a step and just retrieved all aors. But nevermind.

This worked reasonably well with local config files but with a realtime
backend and thousands of objects, this was a nightmare.  The issue
really boiled down to the fact that while realtime supports predicates
that are passed to the database engine, the non-realtime sorcery
backends didn't.

They do now.

The realtime engines have a scheme for doing simple comparisons. They
take in an ast_variable (or list) for matching, and the name of each
variable can contain an operator.  For instance, a name of
"qualify_frequency >" and a value of "0" would create a SQL predicate
that looks like "where qualify_frequency > '0'".  If there's no operator
after the name, the engines add an '=' so a simple name of
"qualify_frequency" and a value of "10" would return exact matches.

The non-realtime backends decide whether to include an object in a
result set by calling ast_sorcery_changeset_create on every object in
the internal container.  However, ast_sorcery_changeset_create only does
exact string matches though so a name of "qualify_frequency >" and a
value of "0" returns nothing because the literal "qualify_frequency >"
doesn't match any name in the objset set.

So, the real task was to create a generic string matcher that can take a
left value, operator and a right value and perform the match. To that
end, strings.c has a new ast_strings_match(left, operator, right)
function.  Left and right are the strings to operate on and the operator
can be a string containing any of the following: = (or NULL or ""), !=,
>, >=, <, <=, like or regex.  If the operator is like or regex, the
right string should be a %-pattern or a regex expression.  If both left
and right can be converted to float, then a numeric comparison is
performed, otherwise a string comparison is performed.

To use this new function on ast_variables, 2 new functions were added to
config.c.  One that compares 2 ast_variables, and one that compares 2
ast_variable lists.  The former is useful when you want to compare 2
ast_variables that happen to be in a list but don't want to traverse the
list.  The latter will traverse the right list and return true if all
the variables in it match the left list.

Now, the backends' fields_cmp functions call ast_variable_lists_match
instead of ast_sorcery_changeset_create and they can now process the
same syntax as the realtime engines.  The realtime backend just passes
the variable list unaltered to the engine.  The only gotcha is that
there's no common realtime engine support for regex so that's been noted
in the api docs for ast_sorcery_retrieve_by_fields.

Only one more change to sorcery was done...  A new config flag
"allow_unqualified_fetch" was added to reg_sorcery_realtime.
"no": ignore fetches if no predicate fields were supplied.
"error": same as no but emit an error. (good for testing)
"yes": allow (the default);
"warn": allow but emit a warning. (good for testing)

Now on to res_pjsip...

pjsip_options was modified to retrieve aors with qualify_frequency > 0
rather than all endpoints then all aors.  Not only was this a big
improvement in realtime retrieval but even for config files there's an
improvement because we're not going through endpoints anymore.

res_pjsip_mwi was modified to retieve only endpoints with something in
the mailboxes field instead of all endpoints then testing mailboxes.

res_pjsip_registrar_expire was completely refactored.  It was retrieving
all contacts then setting up scheduler entries to check for expiration.
Now, it's a single thread (like keepalive) that periodically retrieves
only contacts whose expiration time is < now and deletes them.  A new
contact_expiration_check_interval was added to global with a default of
30 seconds.

Ross Beer reports that with this patch, his Asterisk startup time dropped
from around an hour to under 30 seconds.

There are still objects that can't be filtered at the database like
identifies, transports, and registrations.  These are not going to be
anywhere near as numerous as endpoints, aors, auths, contacts however.

Back to allow_unqualified_fetch.  If this is set to yes and you have a
very large number of objects in the database, the pjsip CLI commands
will attempt to retrive ALL of them if not qualified with a LIKE.
Worse, if you type "pjsip show endpoint <tab>" guess what's going to
happen? :)  Having a cache helps but all the objects will have to be
retrieved at least once to fill the cache.  Setting
allow_unqualified_fetch=no prevents the mass retrieve and should be used
on endpoints, auths, aors, and contacts.  It should NOT be used for
identifies, registrations and transports since these MUST be
retrieved in bulk.

Example sorcery.conf:

[res_pjsip]
endpoint=config,pjsip.conf,criteria=type=endpoint
endpoint=realtime,ps_endpoints,allow_unqualified_fetch=error

ASTERISK-25826 #close
Reported-by: Ross Beer
Tested-by: Ross Beer

Change-Id: Id2691e447db90892890036e663aaf907b2dc1c67
2016-03-27 22:43:27 -05:00
..
ast-db-manage sorcery/res_pjsip: Refactor for realtime performance 2016-03-27 22:43:27 -05:00
docker Add initial support to build Docker images 2016-03-17 09:53:57 -05:00
editors contrib/editors: Fix vim syntax highlighting of comments in config files 2015-05-07 19:37:42 +00:00
init.d Update init.d scripts to handle stderr; readd splash screen for remote consoles 2013-01-21 20:41:12 +00:00
scripts install_prereq: Add packages for bundled pjproject 2016-03-05 17:46:15 -06:00
thirdparty remove extraneous svn:executable properties 2005-11-29 18:24:39 +00:00
unistimLang Add French translation for chan_unistim phones on-screen menus. 2012-07-16 07:34:12 +00:00
upstart Change all refererences to 1.6.3 to be 1.8, since that will be the next feature release 2009-12-21 18:51:17 +00:00
utils Fix typo's (retrieve, specified, address). 2015-01-23 15:13:08 +00:00
Makefile Astobj2: Allow reference debugging to be enabled/disabled by config. 2015-04-27 18:37:26 -04:00
README.festival remove extraneous svn:executable properties 2005-11-29 18:24:39 +00:00
asterisk-doxygen-header remove extraneous svn:executable properties 2005-11-29 18:24:39 +00:00
asterisk-ices.xml remove extraneous svn:executable properties 2005-11-29 18:24:39 +00:00
dictionary.digium Add support for logging CDR recrods to a radius server (issue #6639, phsultan) 2006-05-20 22:30:05 +00:00
festival-1.4.1-diff remove extraneous svn:executable properties 2005-11-29 18:24:39 +00:00
festival-1.4.2.diff remove extraneous svn:executable properties 2005-11-29 18:24:39 +00:00
festival-1.4.3.diff remove extraneous svn:executable properties 2005-11-29 18:24:39 +00:00
festival-1.95.diff remove extraneous svn:executable properties 2005-11-29 18:24:39 +00:00
i18n.testsuite.conf Merged revisions 170671 via svnmerge from 2009-01-23 20:23:00 +00:00
valgrind-RedHat-8.0.supp remove extraneous svn:executable properties 2005-11-29 18:24:39 +00:00
valgrind.supp Line 24 missed in compatibility fix in revision 233577 2010-04-26 19:05:47 +00:00

README.festival

app_festival is an application that allows one to send text-to-speech commands
to a background festival server, and to obtain the resulting waveform which
gets sent down to the respective channel. app_festival also employs a waveform 
cache, so invariant text-to-speech strings ("Please press 1 for instructions") 
do not need to be dynamically generated all the time. 

You need : 

1) festival, patched to produce 8khz waveforms on output. Patch for Festival
1.4.2 RELEASE are included. The patch adds a new command to festival 
(asterisk_tts). 

It is possible to run Festival without patches in the source-code. Just
add this to your /etc/festival.scm or /usr/share/festival/festival/scm:

    (define (tts_textasterisk string mode)
    "(tts_textasterisk STRING MODE)
    Apply tts to STRING. This function is specifically designed for
    use in server mode so a single function call may synthesize the string.
    This function name may be added to the server safe functions."
    (let ((wholeutt (utt.synth (eval (list 'Utterance 'Text string)))))
    (utt.wave.resample wholeutt 8000)
    (utt.wave.rescale wholeutt 5)
    (utt.send.wave.client wholeutt)))

[See the comment with subject "Using Debian
 festival >= 1.4.3-15 (no recompiling needed!)" on
 http://www.voip-info.org/wiki-Asterisk+festival+installation for the
 original mentioning of it]

2) You may wish to obtain and install the asterisk-perl
module by James Golovich <james@gnuinter.net>, from 
either CPAN, or his site: http://asterisk.gnuinter.net,
as this contains a good example of how variable text
can be tts'd via asterisk, namely the examples/tts-*.agi
files there. It has been noted that the current expression
evaluation capabilities of asterisk are not best suited
for the generation and manipulation of text. AGI scripting
can be ideal for these sorts of needs. For simpler usage,
fixed, pre-recorded messages may be more amenable for your
purposes.

3) Before running asterisk, you have to run festival-server with a command 
like : 

/usr/local/festival/bin/festival --server > /dev/null 2>&1 &