Update README.md and LICENSE.md

This commit is contained in:
Michael Pfaff 2019-12-05 12:06:18 -05:00
parent 4a3ff8bfce
commit b55277b638
3 changed files with 57 additions and 57 deletions

21
LICENSE
View File

@ -1,21 +0,0 @@
==================
audio-visualizer-python is licensed under the MIT License
==================
Copyright (c) 2015 Martin Kaistra
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.

22
LICENSE.md Normal file
View File

@ -0,0 +1,22 @@
MIT License
Copyright for portions of PyAudViz are held by [Martin Kaistra, 2015] as part of [audio-visualizer-python](https://github.com/djfun/audio-visualizer-python/). All other copyright for PyAudViz are held by [Michael Pfaff, 2019].
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.

View File

@ -1,61 +1,60 @@
audio-visualizer-python # PyAudViz (Python Audio Visualizer)
=======================
This is a little GUI tool which creates an audio visualization video from an input audio. This is a little GUI tool using Qt5 which creates an audio visualization video from an input audio.
You can also give it a background image and set a title text. You can also give it a background image and set a title text.
I have tested the program on Linux (Ubuntu 16.04) and Windows (Windows 7), it should also work on Mac OS X. If you encounter problems I have tested the program on macOS (10.14.6 Mojave), although it should also work on Linux and Windows. If you encounter problems or find bugs running it or have features suggestions, please [file an issue](https://github.com/pfaffdev/pyaudviz/issues/new).
running it or have other bug reports or features, that you wish to see implemented, please fork the project and send me a pull request and/or file an issue on this project.
I also need a good name that is not as generic as "audio-visualizer-python"!
Dependencies ## Dependencies
------------
You need Python 3, PyQt4, PIL (or Pillow), numpy and the program ffmpeg, which is used to read the audio and render the video. You need Python 3, PySide2, PIL (or Pillow), numpy and the program ffmpeg, which is used to read the audio and render the video.
## Installation
Installation
------------
### Manual installation on Ubuntu ### Manual installation on Ubuntu
* Get all the python stuff: `sudo apt install python3 python3-pyqt4 python3-pil python3-numpy`
* If you have PyQt5 installed, get pillow (at least version 3.3.0) from pip: `apt install python3-pip; pip3 install pillow`
* Get ffmpeg/avconv:
You can either use `avconv` from the standard repositories (package `libav-tools`) or get `ffmpeg` from the [website](http://ffmpeg.org/) or from a PPA (e.g. [https://launchpad.net/~jon-severinsson/+archive/ubuntu/ffmpeg](https://launchpad.net/~jon-severinsson/+archive/ubuntu/ffmpeg). The program does automatically detect if you don't have the ffmpeg binary and tries to use avconv instead.
Download audio-visualizer-python from this repository and run it with `python3 main.py`. - Get all the python stuff: `sudo apt install python3 python3-pyqt4 python3-pil python3-numpy`
- If you have PySide2 installed, get pillow (at least version 3.3.0) from pip: `pip3 install pillow`
- Get ffmpeg/avconv: You can either use `avconv` from the standard repositories (package `libav-tools`) or get `ffmpeg` from the [website](http://ffmpeg.org/) or from a PPA (e.g. [https://launchpad.net/~jon-severinsson/+archive/ubuntu/ffmpeg](https://launchpad.net/~jon-severinsson/+archive/ubuntu/ffmpeg). The program does automatically detect if you don't have the ffmpeg binary and tries to use avconv instead.
Clone this repository and run PyAudViz with `python3 main.py`.
### Manual installation on Windows ### Manual installation on Windows
* Download and install Python 3.4 from [https://www.python.org/downloads/windows/](https://www.python.org/downloads/windows/)
* Download and install PyQt4 for Python 3.4 and Qt4 from [http://www.riverbankcomputing.co.uk/software/pyqt/download](http://www.riverbankcomputing.co.uk/software/pyqt/download)
* Download and install numpy from [http://www.scipy.org/scipylib/download.html](http://www.scipy.org/scipylib/download.html). There is an installer available, make sure to get the one for Python 3.4
* Download and install Pillow from [https://pypi.python.org/pypi/Pillow/3.3.0](https://pypi.python.org/pypi/Pillow/3.3.0)
* Download and install ffmpeg from [https://www.ffmpeg.org/download.html](https://www.ffmpeg.org/download.html). You can use the static builds.
* Add ffmpeg to your system PATH environment variable.
Download audio-visualizer-python from this repository and run it from the command line with `C:\Python34\python.exe main.py`. - Download and install Python 3.4 from [https://www.python.org/downloads/windows/](https://www.python.org/downloads/windows/)
- Download and install PyQt4 for Python 3.4 and Qt4 from [http://www.riverbankcomputing.co.uk/software/pyqt/download](http://www.riverbankcomputing.co.uk/software/pyqt/download)
- Download and install numpy from [http://www.scipy.org/scipylib/download.html](http://www.scipy.org/scipylib/download.html). There is an installer available, make sure to get the one for Python 3.4
- Download and install Pillow from [https://pypi.python.org/pypi/Pillow/3.3.0](https://pypi.python.org/pypi/Pillow/3.3.0)
- Download and install ffmpeg from [https://www.ffmpeg.org/download.html](https://www.ffmpeg.org/download.html). You can use the static builds.
- Add ffmpeg to your system PATH environment variable.
Clone this repository and run PyAudViz from the command line with `C:\Python34\python.exe main.py`.
### Manual installation on macOS ### Manual installation on macOS
* Install [Homebrew](http://brew.sh/) - Install [Homebrew](http://brew.sh/)
* Use the following commands to install the needed dependencies: - Use the following commands to install the needed dependencies:
**NOTE:** If you already have `ffmpeg`, `sip` or `pyqt` installed, you will probably need to replace `install` with `reinstall`.
``` ```
brew install python3 brew install python3
brew install ffmpeg --with-fdk-aac --with-ffplay --with-freetype --with-libass --with-libquvi --with-libvorbis --with-libvpx --with-opus --with-x265 brew install -- ffmpeg --with-fdk-aac --with-ffplay --with-freetype --with-libass --with-libquvi --with-libvorbis --with-libvpx --with-opus --with-x265
brew install qt brew install qt
brew install sip --with-python3 brew install -- sip --with-python3
brew install pyqt --with-python3 brew install -- pyqt --with-python3
pip3 install --upgrade pip pip3 install --upgrade pip
pip3 install pillow pip3 install pillow
pip3 install numpy pip3 install numpy
``` ```
Download audio-visualizer-python from this repository and run it with `python3 main.py`. Clone this repository and run PyAudViz with `python3 main.py`.
Example
-------
You can find an example video here:
[Youtube: A day in spring](https://www.youtube.com/watch?v=-M3jR1NuJHM)
License ## License
-------
audio-visualizer-python is licensed under the MIT license. PyAudViz is licensed under the MIT license.