Documentation

Author: Warren S

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 Warren S.
+Copyright (c) 2018 Warren S & Ralph Quinto
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Presentation.pdf

@@ -1 +1,30 @@
-# PythonAudioEffects
+# PythonAudioEffects
+
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/nextseto/PythonAudioEffects/master/LICENSE)
+
+Many movies have special effects added to the visuals and the audio to set the tone for various scenes. In movies, editors use audio processing to apply effects to voice actors to make them seem more dramatic or to better fit the overall storyline. 
+
+**PythonAudioEffects** is a python library that can manipulate audio files (Mono WAV) and apply: darth vader, echo, radio, robotic, and ghost effects onto audio. In addition to applying pre-built custom audio effects, the library also provides DSP operations to build even more effects!!
+
+## Installation
+
+### Requirements
+
+  * Python 2.7 or 3.x
+  * macOS or Linux (Windows not officially supported, but might work)
+  * numpy: `pip install numpy`
+  * scipy: `pip install scipy`
+
+**Note:** [macOS users may need to setup using virtualenv.](https://gist.github.com/pandafulmanda/730a9355e088a9970b18275cb9eadef3)
+
+## How to use
+
+1. Clone the repository
+2. Look at: `tests/effects.py` for processing a WAV file and generating different premade effects
+3. Look at `tests/processing.py` to learn how to use the DSP operations for manipulating audio
+
+
+## License
+
+All **source code** in this repository is released under the MIT license. See LICENSE for details.
+

README.md

@@ -1,7 +1,15 @@
+'''
+    Usage  : python effects.py
+    
+    Input  : An input WAV file for processing
+    Output : Five processed WAV audio samples
+    
+    Note   : Please change the code below to fit your needs.
+'''
 
 from AudioLib import AudioEffect
 
-input_file_path = 'input2.wav'
+input_file_path = 'input.wav'
 output_filename = 'output'
 
 AudioEffect.ghost(input_file_path, output_filename + '_ghost.wav')

input.wav examples_samples/example1/input.wav

@@ -0,0 +1,19 @@
+'''
+    Usage  : python processing.py
+    
+    Input  : An input WAV file for processing
+    Output : A processed WAV audio sample
+    
+    Note   : Please change the code below to fit your needs.
+'''
+
+from AudioLib.AudioProcessing import AudioProcessing
+
+sound1 = AudioProcessing('input.wav')
+
+sound1.set_audio_speed(0.5)
+sound1.set_audio_pitch(2)
+sound1.set_reverse()
+sound1.set_echo(1)
+
+sound1.save_to_file('output.wav')