1librem README 2============= 3 4 5librem is a Audio and video processing media library 6Copyright (C) 2010 - 2018 Creytiv.com 7 8[![Build Status](https://travis-ci.org/creytiv/rem.svg?branch=master)](https://travis-ci.org/creytiv/rem) 9 10 11## Features 12 13* Audio buffer 14* Audio sample format conversion 15* Audio file reader/writer 16* Audio mixer 17* Audio resampler 18* Audio tone generator 19* Audio codec (G.711) 20* DTMF decoder 21* Video mixer 22* Video pixel converter 23* FIR-filter 24 25 26## Building 27 28librem is using GNU makefiles, and [libre](https://github.com/creytiv/re) 29must be installed before building. 30 31 32### Build with default options 33 34``` 35$ make 36$ sudo make install 37$ sudo ldconfig 38``` 39 40 41## Documentation 42 43The online documentation generated with doxygen is available in 44the main [website](http://creytiv.com/doxygen/rem-dox/html/) 45 46 47## License 48 49The librem project is using the BSD license. 50 51 52## Contributing 53 54Patches can sent via Github 55[Pull-Requests](https://github.com/creytiv/rem/pulls) or to the RE devel 56[mailing-list](http://lists.creytiv.com/mailman/listinfo/re-devel). 57Currently we only accept small patches. 58Please send private feedback to libre [at] creytiv.com 59 60 61## Modules 62``` 63Audio Modules: 64 65 name: status: description: 66 67* au testing Base audio types 68* aubuf testing Audio buffer 69* auconv unstable Audio sample format conversion 70* aufile testing Audio file reader/writer 71* aumix unstable Audio mixer 72* auresamp unstable Audio resampler 73* autone testing Tone/DTMF generator 74* dtmf unstable DTMF decoder 75* g711 stable G.711 audio codec 76 77 78 79 80Video Modules: 81 82 name: status: description: 83 84* vid testing Base video types 85* vidconv testing Colorspace conversion and scaling 86* vidmix unstable Video mixer 87 88 89 90 91Generic modules: 92 93* dsp testing DSP routines 94* fir unstable FIR (Finite Impulse Response) filter 95* goertzel unstable Goertzel Algorithm 96``` 97 98 99 100 101## Specifications: 102 103* ITU-T G.711 Appendix I and Appendix II 104 105 106## Supported platforms 107 108Same as [libre](https://github.com/creytiv/re) 109 110 111## Related projects 112 113* [libre](https://github.com/creytiv/re) 114* [retest](https://github.com/creytiv/retest) 115* [baresip](https://github.com/alfredh/baresip) 116 117 118 119## References 120 121http://creytiv.com/rem.html 122 123https://github.com/creytiv/rem 124 125http://lists.creytiv.com/mailman/listinfo/re-devel 126