1
1
mirror of https://github.com/bitgapp/eqMac.git synced 2024-11-30 03:35:04 +03:00
macOS System-wide Audio Equalizer & Volume Mixer 🎧
Go to file
2020-06-28 23:41:20 +01:00
.github Update issue templates 2020-04-19 18:35:45 +01:00
assets updated modules 2020-04-24 22:52:52 +01:00
native implemented more secure hiding showing of the driver 2020-06-28 23:41:20 +01:00
site Bump websocket-extensions from 0.1.3 to 0.1.4 in /site 2020-06-09 23:16:58 +01:00
ui implemented more secure hiding showing of the driver 2020-06-28 23:41:20 +01:00
.gitattributes Update .gitattributes 2020-04-15 13:11:44 +01:00
.gitignore added gitignore for xcode workspace 2020-04-18 16:36:10 +01:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2020-06-10 23:28:46 +01:00
CONTRIBUTING.md Create CONTRIBUTING.md 2020-06-10 23:29:43 +01:00
LICENSE Create LICENSE 2020-04-05 01:10:10 +01:00
README.md Update README.md 2020-06-10 23:13:19 +01:00
SECURITY.md Update SECURITY.md 2020-04-25 14:30:47 +01:00

Features

Current

  • System-wide audio source
  • Volume Booster
  • Volume Balance support for all devices
  • Basic EQ - 3 band (Bass, Mids, Treble)
  • Advanced EQ - 10 bands

Roadmap

Idea is to become the ultimate Audio toolbox for macOS (some features might not be open sourced)

  • Expert EQ - Ultimited bands + Spectrum analyzer
  • Reverb - Spatial audio enchancement
  • Volume mixer - Apply different volume levels per each application
  • Input audio source - Apply effects to any device: guitar, microphone etc.
  • Recorder - save any audio playback (System, Input device, File)
  • File playback and rendering - Apply effects to audio files and instantly render them
  • Remote control from your phone
  • Hide unused effects / elements of the UI
  • and more...

User support

I'm notoriously known for lacking in communication with users due to lack of time in my busy life. This project is heavily reliant on the whole community helping each other out. If you have an issue with eqMac please go through Issues to see if it's already being discussed, if not create a new one. Also you can join our Discord. Please no stupid questions like "How to bass?" - those will be completely ignored.

Technology

eqMac was built using these technologies:

  • Driver - System Audio loopback/passthrough device based on BackgroundMusic project. The driver grabs the system audio stream and sends it to the input channels. eqMac can grab this stream, process it and send to the appropriate audio device. Still very low level C++ code although the driver runs in User space instead of Kernel like the previous drivers, which means it's much more secure and stable.
  • App - Native backend to the whole app. Responsible for audio processing, filesystem access, window management, API and general lifecycle of eqMac. Written in Swift and uses Apple's more modern AVAudioEngine API, unlike the previous version that used a deprecated AUGraph API.
  • UI - Web based user interface that is hosted remotely and thus allows for over the air updates & bug fixes. Written in Angular 8 and uses is cached for offline availability.
  • Site - Source code for https://eqmac.app website. Written in Angular 8 and server side rendered using Angular Universal

Contribution

At the moment eqMac is going through a major rewrite and it's hard to coordinate the development of big features, but I'm open to try anyway. Please create an issue on GitHub (please check if your issue is already being discussed) or join our Discord to discuss. Once a piece of work has been agreed - fork, build, debug, fix, merge and create a Pull Request to get your work merged in :) Check the documentation below to understand how to start eqMac debug process from Xcode

Development

Fork the repository, then run these commands in Terminal.app:

git clone https://github.com/YOUR_USERNAME/eqMac.git
cd eqMac/

Web User Interface

If you want to run the web based User Interface locally then you need to follow these steps to make that happen:

Prerequisites

Install Node.js LTS version preferrably using NVM

Building and running the Web UI

  1. Go into the ui/ directory by cd ui/
  2. Install Node dependencies with npm install
  3. Start local development server with npm start

Native app + driver

Prerequisites

  1. Download Xcode
  2. Install CocoaPods by sudo gem install cocoapods
  3. Install Carthage by brew update && brew install carthage

Building and running the App

  1. Go into the native/app directory from root of the repo by: cd native/app/
  2. Install Cocoapod dependencies: pod install
  3. Install Carthage dependencies: carthage update
  4. Go back to the native/ directory: cd ../
  5. Open the Xcode workspace: open eqMac.xcworkspace
  6. Launch eqMac in debug mode by running the App - Debug Scheme: