Skip to content

boosts mac's default max volume (part of maxnmastered

Notifications You must be signed in to change notification settings

lyndskg/volume-vault

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
 
 

Repository files navigation

volume-vault

a macOS app for boosting max audio output

Table of Contents
  1. Project Overview
  2. Technologies and Programming Languages
  3. Roadmap
  4. Getting Started
  5. Basic Workflow
  6. Basic I/O Details
  7. Usage
  8. Key Features
  9. How to Contribute
  10. Future Enhancements
  11. License
  12. Contact
  13. Acknowledgments

Unleash the Audio Amplification Adventure


Project Overview

volume_vault is a macOS application that breaks through Apple's pre-set maximum audio playback volume restrictions, enabling users to boost and amplify their favorite audio media content by up to 2000%.

This entertaining project features a simple and minimalistic user interface, offering users the choice to use it as a Mac menu bar drop-down widget or a standalone application for an enjoyable audio amplification experience.

Objectives

The main objective of volume_vault is to provide macOS users with a playful solution to amplify their audio volume beyond the limitations imposed by Apple.

By offering a user-friendly interface and a humorous touch, volume_vault aims to enhance the audio experience for users who desire louder sound without compromising on quality.

(back to top)


Technologies and Programming Languages

Recommended:

For the front-end and UI development, the following technologies and programming languages are recommended:

  • Swift: As the primary language for macOS app development.
  • SwiftUI: To create a modern and visually appealing minimalistic user interface.

For the back-end and audio processing, the following library can be considered:

  • Core Audio: For audio manipulation and volume boosting.

 

Built With:

Put Shit Here

Development Environment:

  • Operating System: macOS Ventura (version 14.3.1)
  • Architecture: Apple arm64

(back to top)


Roadmap

Put Shit Here

Timeline:

Started: Not yet
Completed On: Idk

Time Estimate:

The time required for completing volume_vault can vary based on the developer's expertise and the desired level of polish.

  • For a basic version with the primary features, it may take around 2-4 weeks.
  • For a more refined version with additional features and thorough testing, it may take up to 6-8 weeks or more.

 

To-Do List:

  • Create a New macOS SwiftUI Project
  • Pseudocode
  • Add Additional Templates w/ Examples

Put Shit Here

 

  1. UI Design:
    • Design a simple and visually appealing user interface, considering both the menu bar widget and standalone application.
  2. Implement Volume Boosting:
    • Integrate Core Audio to enable volume boosting beyond Apple's pre-set maximum volume.
  3. Configure UI Controls:
    • Add sliders, buttons, or other controls to allow users to adjust the volume and enable/disable the volume boost.
  4. Menu Bar Integration:
    • Implement the functionality to run the application as a menu bar widget with a dropdown interface.
  5. Standalone Application:
    • Create a separate standalone application with the same functionality and minimal UI.
  6. User Preferences:
    • Allow users to customize settings, such as preferred volume levels or startup behavior.
  7. Testing:
    • Perform rigorous testing to ensure smooth functionality and handle potential edge cases.
  8. Code Optimization:
    • Refine the codebase and optimize performance for a seamless user experience.
  9. Deployment:
    • Prepare the application for distribution on the Mac App Store.

(back to top)


Getting Started

Version 1: XCode in SwiftUI

  • 1. Install XCode:

Download and install XCode, the integrated development environment for macOS app development, from the Mac App Store.

  • 2. Create a New macOS SwiftUI Project:

Set up a new project and define the basic UI elements and application structure.

Version 2: CLion in C++

  • 1. Create a New C++ Project:

In CLion, create a new C++ project, and define the basic structure for the VolumeVault application.

  • 2. Choose a Cross-Platform Framework (Optional):

To ensure cross-platform compatibility, consider using a cross-platform C++ framework, such as Qt or wxWidgets, for the front-end development.
These frameworks will allow you to create a user-friendly interface that works seamlessly on macOS and other platforms.

  • 3. Integrate Core Audio (macOS-specific):

To enable volume boosting on macOS, you'll need to use the Core Audio framework.
While Core Audio is macOS-specific, you can use preprocessor directives to handle platform-specific code and ensure the application compiles correctly on macOS.

  • 4. Implement Minimalistic UI:

Using your preferred C++ framework or native macOS APIs, create a simple and intuitive user interface for volume_vault.
Keep the UI minimalistic to achieve a clean and user-friendly design.

  • 5. Handle macOS Permissions:

When using Core Audio to intercept audio output, ensure your application handles macOS permissions gracefully.
In some cases, additional permissions may be required from the user to manipulate audio output.

  • 6. Code and Test:

Write the logic for volume boosting and user interface interactions.
Test the application thoroughly, especially on macOS, to ensure it functions as expected.

  • 7. Project Build:

Set up build configurations for macOS in CLion to generate a macOS executable.
For cross-platform compatibility, you can also set up build configurations for other target platforms, if applicable.

  • 8. Optional XCode or VSCode Integration:

If you prefer, you can use XCode or VSCode for specific tasks, such as advanced debugging, profiling, or specific macOS-related development.
You can import your C++ project from JetBrains CLion into XCode or VSCode when necessary.

Version 3: CLion in Swift

  • 1. Swift Support:

By default, JetBrains CLion doesn't provide built-in support for Swift.
However, you can enable Swift support using the Swift Plugin.\

To do this, go to "Settings" (or "Preferences" on macOS) > "Plugins" > "Marketplace," search for "Swift," and install the Swift plugin.

  • 2. Create a New Swift Project:

After enabling the Swift plugin, you can create a new Swift project in JetBrains CLion.
Choose the appropriate project template for a macOS application.

  • 3. Minimalistic UI:

Design a simple and user-friendly interface for VolumeVault.
SwiftUI, a modern UI framework for Swift, can be used for creating a minimalistic UI that integrates seamlessly with macOS.

  • 4. Core Audio Integration (macOS-specific):

To enable volume boosting on macOS, you'll need to integrate Core Audio.
Core Audio is macOS-specific, so you may need to handle platform-specific code using preprocessor directives, ensuring the application compiles correctly on macOS.

  • 5. Handle macOS Permissions:

When using Core Audio to intercept audio output, ensure your application handles macOS permissions gracefully.
In some cases, additional permissions may be required from the user to manipulate audio output.

  • 6. Code and Test:

Write the logic for volume boosting and user interface interactions in Swift.
Test the application thoroughly, especially on macOS, to ensure it functions as expected.

  • 7. Project Build:

Set up build configurations for macOS in CLion to generate a macOS executable.
Ensure that the build settings include Swift support.

  • 8. Optional XCode or VSCode Integration:

If you prefer, you can use XCode or VSCode for specific tasks, such as advanced debugging, profiling, or specific macOS-related development.
You can import your Swift project from JetBrains CLion into XCode or VSCode when necessary.

(back to top)


Basic Workflow Guide

  1. Upon launching volume_vault, the user is presented with a clean and straightforward UI, either as a menu bar widget or a standalone application.
  2. The user can toggle the volume boost feature on/off using a button or checkbox.
  3. A slider allows the user to adjust the level of volume boost they desire, ranging from 0% to 2000%.
  4. The application utilizes Core Audio to intercept audio output and apply the desired volume boost.
  5. The boosted audio is then sent to the system's audio output for playback.
  6. The user can control the volume directly from the application or the menu bar widget.

(back to top)


Basic I/O Details

Input:

  • User interaction with the application's sliders and buttons to control volume boost and other settings.

Output:

  • Boosted audio output to the system's audio playback.

 

System/User Permissions and Requirements:

To manipulate audio output, volume_vault will need appropriate permissions to access the user's audio settings and intercept audio playback.

Users will need to grant the necessary permissions during the application's first run.
volume_vault should adhere to macOS security guidelines and handle permissions gracefully.

Put Shit Here

(back to top)


Usage

Potential Use Cases and Applications:

  • Media Playback:
    • Enhance audio volume when watching movies, videos, or listening to music.
  • Video Conferencing:
    • Improve audio clarity during online meetings and conferences.
  • Accessibility:
    • Assist users with hearing impairments by increasing the volume as needed.
  • Noisy Environments:
    • Allow users to boost volume in loud or noisy surroundings.

Put Shit Here

Prerequisites:

Put Shit Here

Installation:

Put Shit Here

(back to top)


Key Features

  • Volume Boosting:
    • Amplify audio playback volume by up to 2000% beyond Apple's default limits.
  • Minimalistic UI:
    • A simple and user-friendly interface with essential controls.
  • Menu Bar Widget:
    • Run the application as a convenient menu bar drop-down widget.
  • Standalone Application:
    • Offer the option to use volume_vault as a standalone application for easy access.
  • Customizability:
    • Allow users to fine-tune the volume boost level according to their preferences.

Put Shit Here

(back to top)


How and Why to Contribute

  • Contribution Guidelines: Provide clear guidelines on how developers can contribute to volume_vault.
  • Open Source: Consider making volume_vault an open-source project to foster community contributions.
  • Bug Reports and Feature Requests: Encourage users to submit bug reports and suggest new features to improve the application.

Put Shit Here

(back to top)


Potential Enhancements

  1. Equalizer:

Implement an audio equalizer to provide users with further control over audio frequencies.

  1. Presets:

Include preset configurations for different scenarios (e.g., movies, music, gaming) for quick adjustments.

  1. Audio Effects:

Integrate audio effects like spatial audio or surround sound to enrich the audio experience.

  1. Dark Mode:

Add support for macOS dark mode to enhance visual appeal and consistency with macOS aesthetics.

Put Shit Here

(back to top)


License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)


Contact

Your Name - @lyndskg - [email protected]

Project Link: https://github.com/your_username/repo_name

(back to top)


Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

Put Shit Here

(back to top)

About

boosts mac's default max volume (part of maxnmastered

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published