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.0.tar.gz (4.0 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: wtc-1.2.0.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.0.tar.gz
Algorithm Hash digest
SHA256 9d5dafb14a690c124e00198655ec4754111317163e4a7c64daa53a8bcbda463b
MD5 f34e990b918d80c3b095b24bfceaa93d
BLAKE2b-256 0fcc40c6b6944926c744cc5f593c08d24343795f712512e35fd2ef5d99bdfd01

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wtc-1.2.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b931e81789c170329c41e6ebcda5243b993d9f822220705e07b85105acefaabc
MD5 38aebe0a1edac3372b55000c549303ba
BLAKE2b-256 4e06fc0ceb008240206240336b77e77d8abb64937abaaba44b575ca7f3990fc0

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