README.md 2.87 KB
Newer Older
Erwan Croze's avatar
Erwan Croze committed
1 2
[![pipeline status](https://gitlab.linphone.org/BC/public/bcg729/badges/master/pipeline.svg)](https://gitlab.linphone.org/BC/public/bcg729/commits/master)

François Grisez's avatar
François Grisez committed
3 4 5 6 7
Bcg729
======

About bcg729
------------
8 9 10 11 12 13 14

Bcg729 is an opensource implementation of both encoder and decoder of the ITU G729 Annex A/B speech codec. 

The library written in C 99 is fully portable and can be executed on many platforms including both ARM and x86 processors. 
libbcg729 supports concurrent channels encoding/decoding for multi call application such as conferencing. 
This project was initially developed as part of Mediastreamer2, the Linphone's media processing engine.
This is why it also contains the glue to be integrated in Linphone/Mediastreamer2.
jehan's avatar
jehan committed
15
 
François Grisez's avatar
François Grisez committed
16 17
Licensing
---------
18 19 20

The source code is licensed under GPLv2. ITU G729 Annex A/B were offically released October/November 1996 (https://www.itu.int/rec/T-REC-G.729),
hence all patents covering these specifications shall have expired in November 2016.
François Grisez's avatar
François Grisez committed
21
Patent pool administrator confirmed most licensed patents under the G.729 Consortium have expired (<http://www.sipro.com/G729.html>).
22

François Grisez's avatar
François Grisez committed
23 24
Compilation
-----------
johan's avatar
johan committed
25

François Grisez's avatar
François Grisez committed
26
### Dependencies
johan's avatar
johan committed
27

28
No dependency is requested.
François Grisez's avatar
François Grisez committed
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57


### Build procedure

Building by Autotools way is deprecated. Use [CMake][cmake-website] to configure the source code.

	cmake . -DCMAKE_INSTALL_PREFIX=<prefix> -DCMAKE_PREFIX_PATH=<search_prefixes>
	
	make
	make install


### Supported build options

* `CMAKE_INSTALL_PREFIX=<string>` : install prefix
* `CMAKE_PREFIX_PATH=<string>`    : column-separated list of prefixes where to look for dependencies
* `ENABLE_SHARED=NO`              : do not build the shared library
* `ENABLE_STATIC=NO`              : do not build the static library
* `ENABLE_TESTS=NO`               : do not build non-regression tests


### Note for packagers

Our CMake scripts may automatically add some paths into research paths of generated binaries.
To ensure that the installed binaries are striped of any rpath, use `-DCMAKE_SKIP_INSTALL_RPATH=ON`
while you invoke cmake.

Tests suite
-----------
58

johan's avatar
johan committed
59
- Tests are defined for each functional bloc (more or less matching a source file)
François Grisez's avatar
François Grisez committed
60
  and for global encoding/decoding
johan's avatar
johan committed
61

jehan's avatar
jehan committed
62
- Use `-DENABLE_TESTS=YES` to compile with tests To run all tests available in the test directory, run testCampaignAll from test directory
johan's avatar
johan committed
63 64

- Input tests pattern have been generated by ITU code using ITU tests patterns.
François Grisez's avatar
François Grisez committed
65 66 67 68 69 70 71 72 73 74
  The test patterns are not part of this repository but can be downloaded [here][bcg729-patern]. However, the first
  run of `make check` will get them for you.

- To run partial test, use perl executable `testCampaign` in the test directory.
  `./testCampaign <functional bloc name>`
  You must first download the tests patterns using `make check` or manually


---------------------------------------

johan's avatar
johan committed
75

Simon Morlat's avatar
Simon Morlat committed
76
[bcg729-patern]: http://www.belledonne-communications.com/bc-downloads/bcg729-patterns.zip
François Grisez's avatar
François Grisez committed
77
[cmake-website]: https://cmake.org/