AudibleT 0.0.1
A real-time A/B/X audio testing tool for subjective assessment of various audio parameters, compatible for general purpose computer as well as embedded systems.
|
AudibleT is a real-time embedded application for interactive A/B/X testing, used for subjective testing on various audio parameters. It focuses on developing a subjective assessment of audio parameters through Just Noticeable Difference (JND) testing.
Before building this project, ensure you have the following installed:
This project uses CMake for building.
If you want to build only the main application (and not the tests or benchmarks), you can use the following steps:
If you want to build the entire project, including the tests and benchmarks, use the following steps:
The project includes both unit tests and benchmarks. After building the project, you can run these tests with the following commands:
The project uses Doxygen for documentation generation. It will require the doxyen be installed on your computer. Visit Doxygen to learn more.
To generate the documentation run following commands from repo root diretory:
Copyright (c) 2023 Priyonto M Rahman
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.
We welcome contributions to AudibleT and appreciate your help! Here are some guidelines on how to contribute:
Make your changes: Add, edit, or delete files as needed to implement your feature or fix an issue. Try to keep your changes focused and cohesive; avoid including multiple unrelated changes in the same branch.
Push your changes: Push your changes to your fork on GitHub.
Create a pull request: Once your changes are ready to be reviewed, go to your forked repository on GitHub and create a new pull request. Link any relevant issues or other related contributions to the pull request. Before creating a pull request, please make sure your changes do not break any existing functionality and they match the coding style used in this project.
If you're not sure how to contribute or have any other questions, please don't hesitate to ask! We're here to help. You can open an issue on GitHub to get help or clarification.