Public | Automated Build

Last pushed: 2 years ago
Short Description
Short description is empty for this repo.
Full Description

#Jitsi-Hammer

A traffic generator for Jitsi Videobridge.

Jitsi-Hammer is a program that connects to a Jitsi-Meet conference, creates fake users, and generates RTP traffic for these fake users.
This means that you need to run the program after using Jitsi-Meet : Jitsi-Hammer needs an initiator that will manage the video conference and Jingle protocol,
because without one, Jitsi-Hammer will wait for Jingle session-initiate that will never come

##How to use
First you need to compile the project. You can do that using ant :
ant make

After that, you can run the program by using the jitsi-hammer.sh script:

./jitsi-hammer.sh <MANDATORY_OPTIONS> [OPTIONAL_OPTIONS]

The MANDATORY_OPTIONS are :

-XMPPdomain <domain name used by the XMPP server>
-XMPPhost <hostname of the XMPP server>
-MUCdomain <domain name used for the MUC>

The OPTIONAL_OPTIONS are :

-help <display the usage and help of the program>
-room <name of the MUC room (default : TestHammer)>
-port <port number of the XMPP server (default: 5222)>
-users <number of fake users to create (default: 1)>
-length <length of the run in seconds (default: 0)>
-ivf <path to an ivf file for the video streams>
-videortpdump <path to a rtpdump file containing VP8 RTP packets for the video streams>
-audiortpdump <path to a rtpdump file containing Opus RTP packets for the video streams>
-overallstats <enable the logging of the overall stats at the end of the run>
-allstats <enable the logging of all the stats collected during the run>
-summarystats <enable the logging of the summary stats(min,max,mean,standard deviation) from the stats collected during the run>
-statspolling <time (in seconds) between two polling of stats (default: 5sec)>
-credentials <filepath to a file containing users credentials>
-interval <time in milliseconds between adding of users (default: 2sec)>
-nostats <disable all stats (default: stats are enabled)>

When the option -credentials is used, instead of loging in anonymously to the XMPP server, Jitsi-Hammer will login with the credentials contained in the file.
The file must be encoded in UTF-8, and should be a list of "username:password" (the password and username are separeted by a ":") separated by newlines.

You must know that when -length N is given, if N <= 0, the run will never stop.

For the audio streams, if -audiortpdump file is not given, Jitsi-Hammer will generate silence.

For the video streams, if neither `-ivf file nor -videortpdump file are given, Jitsi-Hammer will generate a fading from white to black to white...

##What is IVF, and how to create IVF files
IVF is a simple video format described here (not official source). An IVF file basically just contains VP8 frames, with a fixed header for each.

IVF is more or less a toy format, generally used to test and debug VP8/VP9. But its simplicity makes it great to read.

You can create IVF from a webm file by usingmkvextract :

mkvextract tracks input_file.webm ID:output_file.ivf

with ID being the id of the VP8 track (generally 0, you can get its value by using mkvinfo input_file.webm.

Or you can also use ffmpeg :

ffmpeg -i file_input.webm -vcodec copy file_output.ivf

##What is rtpdump, and how to create rtpdump files
rtpdump file is a binary file format, described here and here, used to record/dump and save RTP packets of a RTP stream.

Wireshark can create rtpdump files from RTP streams (if you decode them as RTP).
To do that, you first need to record with Wireshark an RTP stream, decode it as RTP, and then do the following :

  1. go the the Telephony menu
  2. go in the RTP submenu
  3. clic on Show All Streams
  4. select the stream you want to record
  5. clic on Save As and save the stream as a rtpdump file.

##Resources available
In the resources directory, you can find :

  • an ivf file big-buck-bunny_trailer_track1_eng.ivf, extracted from the webm with the same name, that can be used with -ivf
  • the rtpdump file called rtp_opus.rtpdump containing Opus RTP packets (recorded from the silence generated by Jitsi-Hammer) that can be used with -audiortpdump
  • hammer-opus.rtpdump -- Bob Marley's "Hammer", recorded in a Jitsi call, with an opus target bitrate of 32kbps.
  • the rtpdump file called rtp_vp8 containing VP8 RTP packets (recorded from the video stream generated by Jitsi-Hammer with big-buck-bunny_trailer_track1_eng.ivf) that can be used with -videortpdump.

You can also find dtls10-cipher-suites-only.diff : it's a diff file used to patch older version of libjitsi to enable dtls. You don't need it.

##Statistics files
Jitsi-Hammer can log all the streams stats that it can gets from the class MediaStreamStats. You can generate 3 types of stats :

  • All the stats : with -allstats you will log the stats of ALL the streams at each turn of loop.
  • The summary stats : with -summarystats you will log the summary stats like min/max/mean/standard deviation from all the stream stats at each turn of loop.
  • The overall stats : with -overallstats you will log the overall stats of the stream for the entire run (not just at each turn of loop).

The stats will be saved in JSON in a directory depending of your system :

  • in Linux it's in /path/to/your/home/.Jitsi-Hammer/stats/date_of_the_run
  • In Win7 it's in /path/to/your/user/directory/AppData/Roaming/stats/date_of_the_run

##Java log
You can adjust the logging configuration of the JVM with the file ./lib/logging.properties .

For now it is set to only display at a WARNING level, but you can set "org.jitsi.hammer.level" to INFO if you want to print the INFO log of Jitsi-Hammer (but not libjitsi).

##Various information

  • Because Jitsi-Hammer uses libjitsi, it depends on an audio driver (even though it will never use a sound card for the audio streams). If your GNU/Linux install doesn't have one already installed, you need to install the alsa-core package (alsa-core does the trick, but other audio driver like pulseaudio could also work), and start the service ALSA.
Docker Pull Command
Owner
jmartine
Source Repository

Comments (0)