Giter Club home page Giter Club logo

exisoundvis's Introduction

Note: The image above is an animated GIF, so there's some quality lost. Please see the YouTube video for higher quality visualization of Disclosure's You and Me.

This is an Unreal Engine 4 plugin that loads .ogg files at runtime and analyzes them to get the frequency spectrum to control gameplay, visualization and more.

Feature list and pictures of available nodes:

  • Load .ogg file from HDD
  • Load sound names and file paths from HDD to display list of sound
  • Get frequency spectrum of a loaded Sound
  • Get specific frequency values by using the calculated frequency spectrum
  • Start/Pause/Resume/Stop your Sound and Frequency Calculation through the build in Player

Installation

Unzip the package into the Plugins directory of your game. To add it as an engine plugin you will need to unzip the module into the plugin directory under where you installed UE4.

1. Download the ZIP file.

2. Create a Plugins folder in your game or engine directory and extract the plugin into it. It should look something like this:

3. Open your project (and/or regenerate the Visual Studio files to have the plugin in your solution) and enable it in the plugin section:

4. To use the Plugin, add the SoundVisComponent to the Actor of your choice, which comes with the plugin:

5. Load a sound via its ABSOLUTE path (only .ogg files). The Component has a Delegate | OnFileLoadCompleted, which gets called and passes the complete USoundWave Reference, once the process is over (ASYNC)!:

5.1 NEVER CLOSE THE PROJECT WHILE LOADING A SOUND!

6. Use the Calculate Frequency Spectrum function after you loaded a sound to get an Array of Frequency Values, which represents the Frequencies from 0 to ~22000hz:

6.1 THIS ONLY WORKS WITH LOADED AND DECOMPRESSED .ogg FILES!

7. Since this only analyzes one small segment of the Sound and we don't want ugly Delay-Loops, use these functions to Start/Pause/Resume/Stop the whole sound (will also play it!)

7.1 The analyzed Frequency Spectrum will be returned via a second Delegate | OnFrequencySpectrumCalculated, which also comes with the Component.

8. Now you can use the different frequency functions to get the values (for example if you want to get the values for bass, use 20 to 60 for SubBass and 60 to 250 for Bass. You can look up more on the internet.

11. You can find all functions available by going to the SoundVis category. They are explained in the SoundVisComponent.h if you don't know how to use them:

When cooking, make sure to add the plugin to your projects dependencies!

Example project

4.12 Sound Test Map: Hit me!

License

By using this plugin you accept the CC-BY 4.0 license and

The MIT License (MIT)

Copyright (c) 2015 Cedric Neukirchen

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Contact

If you have any Questions, Comments, Bug reports or feature requests for this plugin, or you wish to contact me you can:

email me - [email protected]

contact me on the forum - Username: eXi

contact me on the Slack Chat - Username: cedric_exi

Credits

n00854180t - Helping a lot to get the loading of the .ogg file running

moss - Helping to understand wave files

exisoundvis's People

Contributors

exifrexi avatar leereilly avatar siggig avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.