bosecorp / detour-android-audio-engine Goto Github PK

Superpowered Audio Engine for Games, Music and Interactive Audio Apps on Android, iOS and OSX.

Low Latency Audio. Cross Platform. Free.


What is it?
-----------

The Superpowered Audio SDK is a software development kit based on Superpowered IncÕs digital signal processing (DSP) technology. 

Superpowered technology allows developers to build computationally intensive audio apps and embedded applications that process more quickly and use less power than other comparable solutions. 

Superpowered DSP is designed and optimized, from scratch, to run on low-power mobile processors. Specifically, any device running ARM with the NEON extension (which covers 99% of all mobile devices manufactured). Intel CPU is supported too.

PLEASE NOTE: all example codes working with the Superpowered features are cross-platform, can be used under iOS and Android.


Folders
-------

/Superpowered
The SDK itself (static libraries and headers).


docs
The documentation. Start with index.html.


/SuperpoweredCrossExample (iOS)
A fully-functional DJ app project example. Shows how to:

- Set up two players.
- Sync them together.
- Apply some effects on the master mix.
- Use Objective-C++.


/SuperpoweredFrequencies (iOS)
Simple 8-band frequency analyzer. Shows how to:

- Mix Swift and Objective-C++ in a project.
- Use the SuperpoweredBandpassFilterbank.


/SuperpoweredFrequencyDomain (iOS)
Simple time domain to frequency domain transformation with buffering and windowing. Shows how to:

- Use the SuperpoweredFrequencyDomain class.
- Process the magnitudes and phases of the audio input.


/SuperpoweredHLSExample (iOS)
HTTP Live Streaming example project.


/SuperpoweredOfflineProcessingExample (iOS)
Advanced example. Decodes an audio file, applies an effect or time stretching and saves the result in WAV. Shows how to:

- Set up the SuperpoweredDecoder.
- Apply a simple effect.
- Use the time stretcher with an efficient dynamic memory pool.
- Save the result in WAV.
- Directly read from the iPod music library.


/SuperpoweredPerformance (iOS)
It compares several Superpowered features to Core Audio.

- Shows the differences between Superpowered and Core Audio.
- Syncs effects to the playerÕs bpm.
- Shows how to use Objective-C++ in an Objective-C project.

Swift note:
We have also tried creating this project in Swift, but itÕs not complete for audio and several features were impossible to implement (such as proper performance measurement). Swift is not designed for real-time audio. Fortunately, Objective-C++ files work great in Swift projects.


/Android/CrossExample (Android)
- Android NDK sample project, similar to SuperpoweredCrossExample.
- Also shows how to use SuperpoweredAndroidAudioIO for output only.


/Android/FrequencyDomain (Android)
- Android NDK sample project, similar to SuperpoweredFrequencyDomain.
- Shows how to use SuperpoweredAndroidAudioIO for audio input and output.


/Android/HLSExample (Android)
HTTP Live Streaming example project.



Android Studio
--------------

NDK integration with static libraries is still incomplete in Android Studio. Before running the example, please set up the following:

- Open local.properties. Set ndk.dir to your ndk folder.
- Open Android.mk in the src/main/jni folder. Check and correct SUPERPOWERED_PATH if needed (should be OK if you leave the folder structure intact).


How to create a Superpowered project with Android Studio
--------------------------------------------------------

Prerequisites: latest Android SDK, Android NDK, Android Studio installed
Steps:
1. create a new project in Android Studio
2. create the jni folder inside the projectÕs folder: app/src/main/jni
3. open local.properties, set ndk.dir= to your NDK folder (for example: ndk.dir=/android/ndk)
4. open build.gradle (module: app), add sourceSets.main, task ndkBuild and tasks.withType like this:

    defaultConfig {
        applicationId "com.superpowered.crossexample"
        minSdkVersion 11
        targetSdkVersion 21
        versionCode 1
        versionName "1.0"

        sourceSets.main {
            jniLibs.srcDir 'src/main/libs'
            jni.srcDirs = []
        }
    }

    task ndkBuild(type: Exec) {
        Properties properties = new Properties()
        properties.load(project.rootProject.file('local.properties').newDataInputStream())
        def ndkDir = properties.getProperty('ndk.dir')
        commandLine "$ndkDir/ndk-build", '-B', '-C', file('src/main/jni').absolutePath
        // Windows users: commandLine "$ndkDir\\ndk-build.cmd", '-B', '-C', file('src/main/jni').absolutePath
    }

    tasks.withType(JavaCompile) {
        compileTask -> compileTask.dependsOn ndkBuild
    }
5. copy Android.mk, Application.mk and the libSuperpoweredXXX.a files into the jni folder you created at step 2, from a similar folder in one of our example projects
6. check the correct SUPERPOWERED_PATH in Android.mk
7. create your custom .cpp and .h files, then donÕt forget to properly set LOCAL_MODULE and LOCAL_SRC_FILES in Android.mk


The Latest Version 
------------------

Details of the latest version can be found at http://superpowered.com/superpowered-audio-sdk/


Pricing and licensing
---------
The Superpowered Audio SDK is free for software applications, except HLS playback. Please see the included license pdf.

Superpowered FFT benefits from ideas in Construction of a High-Performance FFT by Eric Postpischil (http://edp.org/resume.htm).

The Superpowered MP3 and AAC decoder benefits from optimizations by Ken Cooke.


Contacts
--------

If you want to be informed about new code releases, bug fixes, general news and information about Superpowered, please email [email protected].