Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

A pure-python Reed Solomon encoder/decoder

branch: master
README.rst

Reed Solomon

A pure-python Reed Solomon encoder/decoder, based on the wonderful tutorial at wikiversity, written by "Bobmath".

I only consolidated the code a little and added exceptions and a simple API. To my understanding, the algorithm can correct up to nsym/2 of the errors in the message, where nsym is the number of bytes in the error correction code (ECC). The code should work on pretty much any reasonable version of python (2.4-3.2), but I'm only testing on 2.6-3.2.

Note

I claim no authorship of the code, and take no responsibility for the correctness of the algorithm. It's way too much finite-field algebra for me :)

I've released this package as I needed an ECC codec for another project I'm working on, and I couldn't find anything on the web (that still works).

The algorithm itself can handle messages up to 255 bytes, including the ECC bytes. The RSCodec class will split longer messages into chunks and encode/decode them separately; it shouldn't make a difference from an API perspective.

>>> rs = RSCodec(10)
>>> rs.encode([1,2,3,4])
b'\x01\x02\x03\x04,\x9d\x1c+=\xf8h\xfa\x98M'
>>> rs.encode(b'hello world')
b'hello world\xed%T\xc4\xfd\xfd\x89\xf3\xa8\xaa'
>>> rs.decode(b'hello world\xed%T\xc4\xfd\xfd\x89\xf3\xa8\xaa')
b'hello world'
>>> rs.decode(b'heXlo worXd\xed%T\xc4\xfdX\x89\xf3\xa8\xaa')     # 3 errors
b'hello world'
>>> rs.decode(b'hXXXo worXd\xed%T\xc4\xfdX\x89\xf3\xa8\xaa')     # 5 errors
b'hello world'
>>> rs.decode(b'hXXXo worXd\xed%T\xc4\xfdXX\xf3\xa8\xaa')        # 6 errors - fail
Traceback (most recent call last):
  ...
ReedSolomonError: Could not locate error

>>> rs = RSCodec(12)
>>> rs.encode(b'hello world')
b'hello world?Ay\xb2\xbc\xdc\x01q\xb9\xe3\xe2='
>>> rs.decode(b'hello worXXXXy\xb2XX\x01q\xb9\xe3\xe2=')         # 6 errors - ok
b'hello world'
Something went wrong with that request. Please try again.