Giter VIP home page Giter VIP logo

superbinary-parser's Introduction

superbinary-parser

Provides a few tools to manipulate a SuperBinary.

This tool permits you to extract the various UARP (Universal Accessory Restore Protocol) payload types within SuperBinaries. SuperBinaries are used in various Apple accessories, including the AirPods Pro (2nd generation), Beats devices with a MediaTek chip and MagSafe accessories. On Beats devices with a MediaTek chip, it can also extract the FOTA (MediaTek OTA) in a SuperBinary container.

Note

This tool aims to maintain compatability with the latest version of SuperBinary available.

For example, with AirPods Pro (2nd generation), the version of SuperBinary increased from 2 to 3 in version 6.0. If parsing fails with a version 3 SuperBinary in the future, please file an issue!

Installation

As this package depends on a secondary repository (LZMAAlone) for custom LZMA decoding, it's recommended to install this package within a virtual environment.

You'll need appropriate build tools for your system. If you are installing on a Windows system, first download Microsoft Visual C++ 14.0 or greater.

Assuming a UNIX operating system, execute similar to the following:

git clone https://github.com/spotlightishere/superbinary-parser
python3 -m venv venv
source venv/bin/activate
pip3 install -r requirements.txt

Usage

You can then python3 main.py:

> python3 main.py
usage: main.py [-h] [--extract-payloads | --no-extract-payloads] [--decompress-fota | --no-decompress-fota] [--extract-rofs | --no-extract-rofs] [--decompress-payload-contents | --no-decompress-payload-contents] source output_dir
main.py: error: the following arguments are required: source, output_dir

If you are parsing a device that does not have an FOTA, you can split the SuperBinary and its plist using this syntax:

> python3 main.py --extract-payloads source output_dir

On Beats devices with a MediaTek chip and an FOTA container (like the Beats Studio Buds), it is also possible to extract the firmware sounds from the Read Only File System (ROFS) using this syntax:

> python3 main.py --extract-payloads --decompress-fota --extract-rofs FirmwareUpdate.uarp output_dir

The script will then extract all assets, such as sounds, to the output direction.

superbinary-parser's People

Contributors

happymac3920 avatar spotlightishere avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

happymac3920

superbinary-parser's Issues

No sound extraction

When running main.py input output --extract-rofs, it expects one argument and fails to extract the firmware sounds.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.