Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #927

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 41 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,44 @@
AppleALC
========
# AppleALC

[![Build Status](https://github.com/acidanthera/AppleALC/workflows/CI/badge.svg?branch=master)](https://github.com/acidanthera/AppleALC/actions) [![Scan Status](https://scan.coverity.com/projects/16166/badge.svg?flat=1)](https://scan.coverity.com/projects/16166)

An open source kernel extension enabling native macOS HD audio for not officially supported codecs without any filesystem modifications. AppleALCU can be used for systems with digital-only audio.

English (Current)
[简体中文](https://github.com/acidanthera/AppleALC/blob/master/README_CN.md)

#### Features
- Digital and analog audio support starting from the OS installation
- Recovery HD/macOS Installer audio support
- Automated codec detection
- Unsupported audio controller enabling (internal and external)
- Arbitrary kext patching
- Custom platform/layout injection
- Works with SIP / El Capitan+
- Currently compatible with 10.4-14

#### Credits
- [Apple](https://www.apple.com) for macOS
- [Onyx The Black Cat](https://github.com/gdbinit/onyx-the-black-cat) by [fG!](https://reverse.put.as) for the base of the kernel patcher
- [capstone](https://github.com/aquynh/capstone) by [Nguyen Anh Quynh](https://github.com/aquynh) for the disassembler module
- [toleda](https://github.com/toleda), [Mirone](https://github.com/Mirone) and certain others for audio patches and layouts
- [Pike R. Alpha](https://github.com/Piker-Alpha) for [lzvn](https://github.com/Piker-Alpha/LZVN) decompression and certain HDMI patches
- [07151129](https://github.com/07151129) for some code parts and suggestions
- [roddy20](https://github.com/roddy20) for training and research dumps to a patching of codecs
- [vit9696](https://github.com/vit9696) for writing the software and maintaining it
- [Andrey1970AppleLife](https://github.com/Andrey1970AppleLife), [vandroiy2013](https://github.com/vandroiy2013) for maintaining the codec database

#### Installation
The minimal instruction is available on the [wiki](https://github.com/acidanthera/AppleALC/wiki).
The prebuilt binaries are available on [releases](https://github.com/acidanthera/AppleALC/releases) page.

#### Contribution
To support more audio codecs in the binary packages you are asked to submit your configurations. Please read the [wiki](https://github.com/acidanthera/AppleALC/wiki) for more details. For the contributors with programming skills the headers are filled with AppleDOC comments.

#### Support and discussion
[InsanelyMac topic](http://www.insanelymac.com/forum/topic/311293-applealc-—-dynamic-applehda-patching/) in English
[AppleLife topic](https://applelife.ru/threads/applealc-dinamicheskij-patching-applehda.1171672/) in Russian

#### Donations
Writing and supporting code is fun but it takes time. If you want to thank the author for his work consider contributing, bugreporting, or providing the support to other users.
AppleALC is an open-source kernel extension that enables native macOS HD audio for unsupported codecs without requiring any filesystem modifications. AppleALC can also be used for systems with digital-only audio.

Available languages:
- English (Current)
- [简体中文](https://github.com/acidanthera/AppleALC/blob/master/README_CN.md)

## Features
- **Digital and analog audio support** from the OS installation.
- **Recovery HD/macOS Installer audio support.**
- **Automated codec detection.**
- **Enabling of unsupported audio controllers**, both internal and external.
- **Arbitrary kext patching.**
- **Custom platform/layout injection.**
- **Compatibility with SIP/El Capitan+.**
- **Works with macOS versions** from 10.4 to 14.

## Credits
- **[Apple](https://www.apple.com)** for macOS.
- **[Onyx The Black Cat](https://github.com/gdbinit/onyx-the-black-cat)** by [fG!](https://reverse.put.as) for the kernel patcher base.
- **[capstone](https://github.com/aquynh/capstone)** by [Nguyen Anh Quynh](https://github.com/aquynh) for the disassembler module.
- **[toleda](https://github.com/toleda)**, **[Mirone](https://github.com/Mirone)**, and others for audio patches and layouts.
- **[Pike R. Alpha](https://github.com/Piker-Alpha)** for [lzvn](https://github.com/Piker-Alpha/LZVN) decompression and HDMI patches.
- **[07151129](https://github.com/07151129)** for code contributions and suggestions.
- **[roddy20](https://github.com/roddy20)** for training and research on codec patching.
- **[vit9696](https://github.com/vit9696)** for writing and maintaining the software.
- **[Andrey1970AppleLife](https://github.com/Andrey1970AppleLife)** and **[vandroiy2013](https://github.com/vandroiy2013)** for maintaining the codec database.

## Installation
Detailed installation instructions are available on the [wiki](https://github.com/acidanthera/AppleALC/wiki).
Prebuilt binaries can be found on the [releases](https://github.com/acidanthera/AppleALC/releases) page.

## Contribution
To support additional audio codecs in the binary packages, we encourage you to submit your configurations. For more details, please refer to the [wiki](https://github.com/acidanthera/AppleALC/wiki). Contributors with programming skills will find headers filled with AppleDOC comments.

## Support and Discussion
- [InsanelyMac topic](http://www.insanelymac.com/forum/topic/311293-applealc-—-dynamic-applehda-patching/) (English)
- [AppleLife topic](https://applelife.ru/threads/applealc-dinamicheskij-patching-applehda.1171672/) (Russian)

## Donations
Writing and maintaining code is rewarding but time-consuming. If you appreciate the work, consider contributing, reporting bugs, or providing support to other users.