bitgapp/eqMac
1
1
Fork 0
mirror of https://github.com/bitgapp/eqMac.git synced 2024-11-25 01:54:43 +03:00
Code Issues Projects Releases Wiki Activity
macOS System-wide Audio Equalizer & Volume Mixer 🎧
571 Commits 3 Branches 51 Tags 86 MiB
SCSS 50.4%
Swift 26.1%
TypeScript 19.6%
HTML 3.7%
Ruby 0.1%
fc370dc4a8
Go to file
Nodeful fc370dc4a8 updated Angular to latest and that fixed UI build
2021-09-29 17:27:10 +03:00
.github Update issue templates 2020-04-19 18:35:45 +01:00
assets changes 2021-08-29 01:17:22 +03:00
modules/components moved component module changes from the Pro repo 2021-09-28 23:17:12 +03:00
native driver device is shown at first to register with system sounds, then automatically hides after 5 seconds. Also if eqMac app quits without changing the device, the driver hides automatically 2021-09-29 16:32:48 +03:00
ui changes 2021-09-29 17:21:05 +03:00
.eslintignore added eslint to the monorepo and fixed UI linting errors 2021-03-24 16:42:45 +02:00
.eslintrc.js tcopied eqm components into a separate module, trying to package 2021-04-08 02:37:17 +03:00
.gitattributes Update .gitattributes 2021-08-29 01:54:56 +03:00
.gitignore not tracking yarn.lock and changes to package.json 2021-09-28 23:45:08 +03:00
.nvmrc hoisting all angular modules to the root manually 2021-06-18 19:16:52 +03:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2020-06-10 23:28:46 +01:00
CONTRIBUTING.md Update CONTRIBUTING.md 2021-05-08 15:24:55 +03:00
LICENSE rewrote driver 2021-07-10 15:35:04 +03:00
package.json updated Angular to latest and that fixed UI build 2021-09-29 17:27:10 +03:00
README.md Update README.md 2021-08-27 17:57:19 +03:00
SECURITY.md Update SECURITY.md 2020-04-25 14:30:47 +01:00

README.md

discord chat

Features

Current

  • System audio source
  • Volume Booster
  • HDMI Volume Support
  • Volume Balance support for all devices (including HDMI)
  • Basic EQ - Bass, Mids, Treble control
  • Advanced EQ - Fixed 10 bands
  • Expert EQ* - Unlimited bands, fully customizable (Filter Type, Frequency, Gain, Bandwidth)
  • Spectrum analyzer*
  • AutoEQ Integration*
  • Reverb* - Spatial audio enhancement

*Not Open Sourced

Roadmap

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

  • Volume Mixer - Apply different volume levels per each application
  • Separate L/R Channel EQ - Fix hearing impairements
  • 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
  • Fully customizable UI
  • and more...

Vote on the Features you want to see sooner

User support

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, I'm there all the time and I like to chat with people.

Technology

eqMac was built using these technologies:

  • Driver - System Audio loopback/passthrough device based on Apple's Null Audio Server Driver Plug-in example. One of the first Examples of a macOS System Capture drivers written in Swift. The driver grabs the system audio stream and sends it to the input channels (similar to BlackHole). eqMac can grab this stream, process it and send to the appropriate audio device. The driver runs in User space instead of Kernel like the previous drivers (i.e SoundFlower), 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. Built with Angular + TypeScript and is cached for offline availability.

Contribution

At the moment eqMac is going through a major rewrite and it's hard to coordinate the development of big features. But bug fixes, performance optimizations and refactoring PR's are welcomed! 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/

Native app + driver

Prerequisites

  1. Download Xcode
  2. Install CocoaPods by sudo gem install cocoapods

Building and running the App

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

Web User Interface

You don't need to run the UI code locally to debug just the Swift side of the app, unless you want to debug the UI code :) 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

Install Yarn v1 globally: npm i -g yarn (this is needed because the project uses Yarn Workspaces)

Building and running the Web UI

  1. Run yarn from the root directory of the Monorepo
  2. Go into the ui/ directory by cd ui/
  3. Start local development server with yarn start

Credits

@nodeful - Creator and Developer of eqMac

Apple Inc. - For open sourcing this HAL Driver Example

@titanicbobo - For the Big Sur icon design

Max Heim - For his research and work on creating the first Swift based Audio Server Plug-in Driver - Pancake