Changes between Version 2 and Version 3 of Audio_Dev_API

Timestamp:

Feb 20, 2009 10:15:15 AM (15 years ago)

Author:

bennylp

Comment:

--

Audio_Dev_API

@@ -27 +27 @@
  Some audio devices such as Nokia/Symbian Audio Proxy Server (APS) and Nokia VoIP Audio Services (VAS) support built-in hardware audio codecs (e.g. G.729, iLBC, and AMR), and this feature is supported by the new audio device API.
 
+ '''Multiple backends:''' ::
+ The new API supports multiple audio backends (may be called ''factories'' or ''drivers'' in the code) to be active simultaneously, and audio backends may be added or removed during run-time.
 
+
+== Migration Path ==
+
+=== Common Tasks ===
+
+ 1. The Audio Device API is implemented as a new (static) library called '''pjmedia-audiodev''', under '''pjmedia''' directory. Please add this library into link specifications of your application.
+
+=== Ported Devices ===
+
+The following audio device backends have been ported to the new API:
+ - !PortAudio (previously pasound.c)
+ - WMME (previously wmme_sound.c)
+ - Null implementation (previously nullsound.c)
+ - APS (previously symbian_sound_aps.cpp)
+
+=== Compatibility settings ===
+
+The following compile time settings/macros have introduced to manage compatibility between old and new API and to assist migration of application and/or sound device implementation to the new API.
+
+ '''Setting 1) {{{PJMEDIA_AUDIO_API = PJMEDIA_AUDIO_API_NEW_ONLY}}}''' ::
+This setting will completely deprecate the use of old API, and inclusion of {{{<pjmedia/sound.h>}}} in the code will raise compilation error. 
+
+Use this setting if:
+  - you are accessing sound devices which have been implemented using the '''new''' API
+  - you have completely ported your application to use the new API
+
+ '''Setting 2) {{{PJMEDIA_AUDIO_API = PJMEDIA_AUDIO_API_OLD_ONLY}}}''' ::
+With this setting, only old sound API is supported. This is useful for applications that implement their own sound device abstraction and wishes to continue to use old API to access the sound device.
+
+Use this setting if:
+ - you have your own sound device implementation, using the old API
+ - you have application which uses the old API to access the sound device
+
+ '''Setting 3) {{{PJMEDIA_AUDIO_API = PJMEDIA_AUDIO_API_HAS_OLD_API}}}''' ::
+With this setting (this is the default setting), application can use the old sound device API to access audio devices provided by the new audio device API.
+
+Use this setting if:
+ - you are accessing sound devices which have been implemented using new API
+ - you want to access the sound device using '''both''' old or new API's.
+
+ '''Setting 4) {{{PJMEDIA_AUDIO_API = PJMEDIA_AUDIO_API_HAS_OLD_DEVICE}}}''' ::
+This setting enables old sound device implementation to be accessed via '''both''' old and new API's.
+
+Use this setting if:
+ - you have your own sound device implementation, using the old API
+ - you want to access the sound device using '''both''' old or new API's.
+