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.

Sign up for GitHub

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

Jump to bottom

Public API development #1

Open

Bulat-Ziganshin opened this issue May 6, 2017 · 0 comments

Owner

Bulat-Ziganshin commented May 6, 2017

This topic is dedicated to construction of public API that the library should provide.

I think, it should meet the following criteria, in the order of importance:

minimize memory usage
maximize speed
provide C-compatible, exception-free and alloc-free API, that can be delivered in dll/so
flexibility
easy of use

My initial proposal:

RS codec
- CreateEncoderContext/CreateDecoderContext(SrcBlocks,EccBlocks,BlockSize)
- AllocMemory(ctx), GetMemorySize(ctx), SetMemoryBuffer(ctx,buf), GetMemoryBuffer(ctx)
- Encode(ctx,srcdata,eccdata)
- Decode(ctx,alive_data,alive_indexes,wanted_data,wanted_indexes)
GF(p) <-> binary conversion
- int encode(size,srcdata,outdata), decode(size,srcdata,int,outdata)

Bulat-Ziganshin added a commit that referenced this issue


          Public API details moved into issue #1

9eafb8a

Bulat-Ziganshin mentioned this issue

Collaboration for a Python library #5

Open

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment