Skip to main content

Compress osu replay lzma bytestrings

Project description

PyPI version

WTC

WTC is an extension of the lzma compression format, specifically designed to make osu!std replays smaller before storing them. It reduces the size of certain datatypes in the original .osr format, achieving ~40% lossy compression ratios.

Part Original lzma datatype WTC datatype
w (ms since preivous frame) Long (8 bytes) 24bit Integer (3 bytes)
x (x-cord) Float (4 bytes) Short (2 bytes)
y (y-cord) Float (4 bytes) Short (2 bytes)
z (bit combination of keypresses) Integer (4 bytes) Char (1 byte)

This compresses the original 20 byte frame to an 8 byte frame, but not without losses. Precision is lost on w, x, and y, but not z, because the keypressed bit combination will never go above 4 bits for osu!standard. Though it may be larger for other gamemodes such as 7k mania, this compressor is explicitly for osu!standard.

WTC compression achieves an average of 40% ±5 compression (Not a formally calculated number - simply based on experience).

Installation:

$ pip install git+git://github.com/osu-anticheat/wtc-lzma-compressor

Usage:

import wtc

# to compress an lzma bytestring
wtc_bytestring = wtc.compress(lzma_bytestring)

# to decompress a wtc bytestring into an lzma bytestring
lzma_bytestring = wtc.decompress(wtc_bytestring)

# compress and decompress are (almost) inverse operations, so lzma_bytestring ≈ wtc.decompress(wtc.compress(lzma_bytestring)).
# some precision is lost, so the strings are not identical.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wtc-1.2.1.tar.gz (4.0 kB view details)

Uploaded Source

Built Distribution

wtc-1.2.1-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

Details for the file wtc-1.2.1.tar.gz.

File metadata

  • Download URL: wtc-1.2.1.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.2

File hashes

Hashes for wtc-1.2.1.tar.gz
Algorithm Hash digest
SHA256 2c3ba44acf2967f3af01f690cbfcf6338f35596c590b17a0e41fc5f8188368d4
MD5 3a95fb9e9eabd0d4158f824a5f9ae3de
BLAKE2b-256 d5ef58ef78870331571390dd32517e74858b2c458266f55fcb8d9ccff3ee9b16

See more details on using hashes here.

File details

Details for the file wtc-1.2.1-py3-none-any.whl.

File metadata

  • Download URL: wtc-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 5.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.2

File hashes

Hashes for wtc-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e011d6a880b4454d34b52ce15fdddbdae81b0acbc48d35c3e9da208266bc4fff
MD5 f3fbb4443dc1b330c85e0f421ee2cd0c
BLAKE2b-256 96cb9bdc1e73da3a436d8bdd7daa443a73332f126fddf783474cb7104e6020bc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page