mirror of
https://github.com/signalwire/freeswitch.git
synced 2026-10-09 21:14:02 +00:00
FS-6450 [unimrcp] Update library
[apr] Backport APR_RING_FOREACH and APR_RING_FOREACH_SAFE macros to APR for unimrcp compatibility. [unimrcp] configure.gnu - need full path, not relative path for library paths [unimrcp] added uni_revision.h - couldn't get it to autogenerate from build [mod_unimrcp] add better logging and error checking on module load. Currently dumps core on MRCPv1 TTS attempt [mod_unimrcp] don't configure MRCPv1 session with a connection agent- causes crash
This commit is contained in:
@@ -1,92 +1,71 @@
|
||||
/**
|
||||
@mainpage UniMRCP
|
||||
@mainpage UniMRCP API Reference
|
||||
|
||||
<br>
|
||||
@section Introduction
|
||||
|
||||
UniMRCP is an open source cross-platform MRCP project, which provides everything required for MRCP client and server side deployment.
|
||||
<br>
|
||||
UniMRCP encapsulates SIP/MRCPv2, RTSP, SDP and RTP/RTCP stacks inside and provides MRCP version independent user level interface for the integration.
|
||||
UniMRCP is an open source project compliant with the IETF RFC6787 (MRCPv2) and RFC4463 (MRCPv1) specifications.
|
||||
The project encapsulates SIP, RTSP, SDP, MRCPv2, and RTP/RTCP stacks and provides integrators with a protocol version consistent interface.
|
||||
|
||||
- Compliance: MRCPv1, MRCPv2 (client and server)
|
||||
- Resources: Synthesizer (TTS), Recognizer (ASR), Verifier (SVI), Recorder
|
||||
- License: Apache 2.0
|
||||
- OS: Cross-platform (Windows, Linux, ...)
|
||||
- Language: C, C++
|
||||
<br>
|
||||
<br>
|
||||
@section Source Tree Structure
|
||||
@section _ Source Tree Structure
|
||||
|
||||
<br>
|
||||
Libraries
|
||||
|
||||
* apr-toolkit - set of utilities built on top of APR and APR-Util libraries (task abstraction, logging, etc)
|
||||
<br>
|
||||
* mpf - media processing framework
|
||||
<br>
|
||||
* mrcp - implementation of MRCP basics (message, parser, resources)
|
||||
<br>
|
||||
* mrcpv2-transport - implementation of MRCPv2 transport layer
|
||||
<br>
|
||||
* mrcp-signaling - abstract MRCP signaling (session management) interface
|
||||
<br>
|
||||
* mrcp-engine - abstract resource engine interface
|
||||
<br>
|
||||
* mrcp-client - implementation of MRCP client stack based on abstract signaling interface
|
||||
<br>
|
||||
* mrcp-server - implementation of MRCP server stack based on abstract signaling and engine interfaces
|
||||
<br>
|
||||
* uni-rtsp - implementation of minimal RTSP stack required for MRCPv1
|
||||
@subsection Libraries
|
||||
|
||||
- apr-toolkit - Set of utilities built on top of the APR and APR-util libraries (task abstraction, logging, etc).
|
||||
- mpf - Media processing framework.
|
||||
- mrcp - Implementation of MRCP basics (message, parser, resources).
|
||||
- mrcpv2-transport - Implementation of the MRCPv2 transport layer.
|
||||
- mrcp-signaling - Abstract MRCP signaling (session management) interface.
|
||||
- mrcp-engine - Abstract resource engine interface.
|
||||
- mrcp-client - Implementation of an MRCP client stack based on the abstract signaling interface.
|
||||
- mrcp-server - Implementation of an MRCP server stack based on the abstract signaling and engine interfaces.
|
||||
- uni-rtsp - Implementation of a minimal RTSP stack required for MRCPv1.
|
||||
|
||||
<br>
|
||||
Modules
|
||||
|
||||
* mrcp-sofiasip - implementation of abstract signaling interface using SofiaSIP library
|
||||
<br>
|
||||
* mrcp-unirtsp - implementation of abstract signaling interface using UniRTSP library
|
||||
<br>
|
||||
@subsection Modules
|
||||
|
||||
- mrcp-sofiasip - Implementation of the abstract signaling interface using the SofiaSIP library.
|
||||
- mrcp-unirtsp - Implementation of the abstract signaling interface using the UniRTSP library.
|
||||
|
||||
<br>
|
||||
Plugins
|
||||
@subsection Plugins
|
||||
|
||||
* demo-synth - simulation of actual synthesizer engine
|
||||
<br>
|
||||
* demo-recog - simulation of actual recognizer engine
|
||||
<br>
|
||||
* mrcp-recorder - implementation of recorder resource
|
||||
<br>
|
||||
* mrcp-flite - implementation of synthesizer resource using open source Flite engine
|
||||
<br>
|
||||
* mrcp-pocketsphinx - implementation of recognizer resource using open source PocketSphinx engine
|
||||
- demo-synth - Implementation of a TTS plugin which simulates synthesis.
|
||||
- demo-recog - Implementation of an ASR plugin which simulates recognition.
|
||||
- demo-verif - Implementation of an SVI plugin which simulates speaker verification.
|
||||
- mrcp-recorder - Implementation of a recorder plugin.
|
||||
|
||||
<br>
|
||||
Platforms
|
||||
@subsection Platforms
|
||||
|
||||
* libunimrcpclient - unimrcp client stack based on libraries and modules above
|
||||
<br>
|
||||
* libunimrcpserver - unimrcp server stack based on libraries, modules and plugins above
|
||||
<br>
|
||||
* unimrcpclient - sample C application based on unimrcp client stack
|
||||
<br>
|
||||
* umc - sample C++ application based on unimrcp client stack
|
||||
<br>
|
||||
* unimrcpserver - final unimrcp server application
|
||||
- libunimrcpclient - The UniMRCP client stack built on top of the underlying mrcp-client library using the mrcp-sofiasip and mrcp-unirtsp modules.
|
||||
- libunimrcpserver - The UniMRCP server stack based on top of the underlying mrcp-server library using the mrcp-sofiasip and mrcp-unirtsp modules.
|
||||
- unimrcpclient - Sample C application based on the UniMRCP client stack.
|
||||
- umc - Sample C++ application based on the UniMRCP client stack.
|
||||
- unimrcpserver - The UniMRCP server application.
|
||||
|
||||
<br>
|
||||
@section Dependencies
|
||||
|
||||
<a href="http://apr.apache.org"> APR - Apache Portable Runtime </a>
|
||||
<br>
|
||||
<a href="http://sofia-sip.sourceforge.net"> Sofia-SIP - SIP User Agent Library </a>
|
||||
- <a href="http://apr.apache.org"> APR - Apache Portable Runtime Library </a>
|
||||
- <a href="http://sofia-sip.sourceforge.net"> Sofia-SIP - SIP User Agent Library </a>
|
||||
|
||||
<br>
|
||||
@section Project Links
|
||||
|
||||
<a href="http://www.unimrcp.org"> Website </a>
|
||||
<br>
|
||||
<a href="http://code.google.com/p/unimrcp/downloads/list"> Downloads </a>
|
||||
<br>
|
||||
<a href="http://code.google.com/p/unimrcp/w/list"> Wiki </a>
|
||||
<br>
|
||||
<a href="http://code.google.com/p/unimrcp/issues/list"> Issue Tracker </a>
|
||||
<br>
|
||||
<a href="http://groups.google.com/group/unimrcp"> Discussion Group </a>
|
||||
- <a href="http://www.unimrcp.org"> Website </a>
|
||||
- <a href="http://www.unimrcp.org/downloads"> Downloads </a>
|
||||
- <a href="http://www.unimrcp.org/documentation"> Documentation </a>
|
||||
- <a href="http://code.google.com/p/unimrcp/issues/list"> Issue Tracker </a>
|
||||
- <a href="http://groups.google.com/group/unimrcp"> Discussion Group </a>
|
||||
<br>
|
||||
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user