summaryrefslogtreecommitdiff
path: root/third_party/build/samplerate/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'third_party/build/samplerate/README.txt')
-rw-r--r--third_party/build/samplerate/README.txt74
1 files changed, 74 insertions, 0 deletions
diff --git a/third_party/build/samplerate/README.txt b/third_party/build/samplerate/README.txt
new file mode 100644
index 00000000..48832594
--- /dev/null
+++ b/third_party/build/samplerate/README.txt
@@ -0,0 +1,74 @@
+
+ HOW TO ACTIVATE LIBSAMPLERATE
+ (a.k.a SRC/Secret Rabbit Code)
+ AS PJMEDIA'S SAMPLE RATE CONVERSION BACKEND
+
+ by
+ Benny Prijono
+ PJSIP
+
+Background
+----------
+ Secret Rabbit Code (aka libsamplerate) is a sample rate conversion
+ library, available from http://www.mega-nerd.com/SRC/index.html.
+ It is licensed under dual license, GPL and proprietary.
+
+
+Supported Platforms
+-------------------
+ libsamplerate is available for Win32 with Visual Studio and the
+ Makefile based targets (such as Linux, MacOS X, *nix, etc.).
+
+ It's not supported for WinCE/Windows Mobile and Symbian since it is
+ a floating point based implementation.
+
+
+Installation
+------------
+ - Download libsamplerate from http://www.mega-nerd.com/SRC/index.html
+
+ - Untar libsamplerate-0.1.2.tar.gz into third_party directory
+ cd third_party
+ tar xzf libsamplerate-0.1.2.tar.gz
+
+ - Rename libsamplerate-0.1.2 directory name to libsamplerate
+ On Windows:
+ ren libsamplerate-0.1.2 libsamplerate
+
+ On Linux/Unix/MacOS X:
+ mv libsamplerate-0.1.2 libsamplerate
+
+
+Visual Studio Build
+-------------------
+ For Visual Studio projects, only static linkage is supported
+ by PJMEDIA build system. If dynamic linking is desired, edit
+ pjmedia/src/pjmedia/resample_libresample.c to prevent it from
+ linking with the static library, and configure your project
+ to link with libsamplerate DLL library.
+
+ To build libresample static library with Visual Studio:
+
+ - Open third_party/build/samplerate/libsamplerate_static.dsp
+ - Build the project for both Debug and Release build
+
+
+ libresample dynamic library can be produced by following the
+ instructions in libresample source directory.
+
+
+Makefile build
+--------------
+ libsamplerate build is integrated with PJSIP's build system.
+
+ TBD.
+
+
+Enabling libsamplerate for PJMEDIA's resample
+---------------------------------------------
+ Add this in config_site.h:
+
+ #define PJMEDIA_RESAMPLE_IMP PJMEDIA_RESAMPLE_LIBSAMPLERATE
+
+
+