Skip to content

Commit 2bdf596

Browse files
authored
cosmetic(Readme): Update readme with new features for 0.12 release
1 parent 00f8d43 commit 2bdf596

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

README.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,13 @@ Currently Kvazzup has the following features:
1111
- Initiating call through *Session Initiation Protocol (SIP)* proxy with authentication
1212
- Alternatively, initiating call peer-to-peer (firewall needs to have incoming TCP port 5060 open)
1313
- Peer-to-peer media delivery with NAT traversal using *Interactive Connectivity Protocol (ICE)*
14+
- Media delivery encryption using *Secure Real-time Transport Protocol (SRTP)* and *Zimmermann RTP (ZRTP)*
1415
- Contacts list
15-
- Enable/disable audio and video
16+
- Enable/disable audio and video, including at the other end with Re-INVITE
1617
- Screen sharing
1718
- Media settings which are saved to the disk
18-
- Automatic selection of best media settings with option for manual adjustment
19-
- Live media setting adjustment
19+
- Automatic selection of best media settings with option for live manual adjustment
2020
- A statistics window for monitoring call quality
21-
- Media delivery encryption
2221

2322
## Compile Kvazzup
2423

@@ -28,7 +27,7 @@ Kvazzup requires the following external libraries to operate:
2827
- [Opus](http://opus-codec.org/) for audio coding
2928
- [uvgRTP](https://github.com/ultravideo/uvgRTP) for media delivery
3029
- [Speex DSP](https://www.speex.org/) for audio processing
31-
- [Crypto++](https://cryptopp.com/) for delivery encryption
30+
- [Crypto++](https://cryptopp.com/) for delivery encryption (optional)
3231

3332
Qt Creator is the recommended tool for compiling Kvazzup. Make sure you use the same compiler and bit version for all the dependencies and for Kvazzup. It is possible, although not recommended to use Kvazzup without Crypto++.
3433

@@ -50,7 +49,7 @@ The following Kvazzup dependencies are available as packages: `libopus-dev libsp
5049

5150
If you have trouble with Qt creator code highlights, but not compilation, make sure you have the correct version of Clang installed. When testing, the Ubuntu had clang-10 installed when Qt depended on clang-8. Installing `clang-8` may solve this issue.
5251

53-
Note: We have not been able to get the changing of the camera formats, resolutions or frame rates to work on Linux. It is possible that we didn't have all the necessary packets installed or that there is some sort of bug in qt multimedia/multimediawidgets on Ubuntu. Any information on this would be greatly appreciated.
52+
Note: We have not been able to get the changing of the camera formats, resolutions or frame rates to work on Linux. It is possible that we didn't have all the necessary packets installed or that there is some sort of bug in Qt Multimedia/Qt Multimediawidgets.
5453

5554
### Windows (MinGW)
5655

@@ -78,13 +77,24 @@ In Kvazzup, please make sure `DEFINES += PIC` is included in Kvazzup.pro file. I
7877

7978
Please uncomment: `DEFINES += KVZ_STATIC_LIB` in Kvazzup.pro file and remove `DEFINES += PIC`.
8079

81-
## Paper
80+
## Papers
81+
82+
If you are using Kvazzup in your research, please cite one of the following papers: <br>
83+
84+
[Kvazzup: open software for HEVC video calls](https://urn.fi/URN:NBN:fi:tty-201908262019)
8285

83-
If you are using Kvazzup in your research, please refer to the following [paper](https://ieeexplore.ieee.org/abstract/document/8241673): <br>
8486
`J. Räsänen, M. Viitanen, J. Vanne, and T. D. Hämäläinen, “Kvazzup: open software for HEVC video calls,” in Proc. IEEE Int. Symp. Multimedia, Taichung, Taiwan, Dec. 2017. `
8587

88+
[Live Demonstration: Kvazzup 4K HEVC Video Call](https://urn.fi/URN:NBN:fi:tty-201908231999)
89+
90+
`J. Räsänen, M. Viitanen, J. Vanne, and T. D. Hämäläinen, “Live Demonstration: Kvazzup 4K HEVC Video Call,” in Proc. IEEE Int. Symp. Multimedia, Taichung, Taiwan, Dec. 2018. `
91+
92+
[Live Demonstration : Interactive Quality of Experience Evaluation in Kvazzup Video Call](https://urn.fi/URN:NBN:fi:tuni-202102041923)
93+
94+
`J. Räsänen, A. Altonen, A. Mercat, and J. Vanne, “Live Demonstration : Interactive Quality of Experience Evaluation in Kvazzup Video Call,” in Proc. IEEE Int. Symp. Multimedia, Naples, Italy, Dec. 2020. `
95+
8696
## Planned features
8797

8898
- Contact presence monitoring
8999
- Multiparty video conferences
90-
- TLS Encryption
100+
- TLS Encryption for SIP

0 commit comments

Comments
 (0)