From b01f683e6e275eb6c065a7853ed88861725ed347 Mon Sep 17 00:00:00 2001 From: Mattia Lecci Date: Tue, 27 Apr 2021 18:06:53 +0200 Subject: [PATCH] Add features and future works in README --- README.md | 31 ++++++++++++++++++++++++++++--- 1 file changed, 28 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a95ea3020..3b518c5eb 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,30 @@ VR traffic model for ns-3 ========================= -**NOTE:** You can find more information about this work in the following paper: - -_**Mattia Lecci, Andrea Zanella, Michele Zorzi, "An ns-3 Implementation of a Bursty Traffic Framework for Virtual Reality Sources," accepted to Workshop on ns-3 (WNS3), Jun. 2021, Virtual Event, USA, Pre-print available: [arXiv:2103.04609](https://arxiv.org/abs/2103.04609)**_ +**NOTE:** You can find detailed information about this module in the referenced papers below. Examples of usage for the newly introduced features can be found in the ``examples/`` folder. +## Features + +This module comprises the following features: + +* Adds `BurstyApplication` and `BurstSink` as ns-3 applications: they allow to model complex applications sending large data packets over UDP sockets, fragmenting them into bursts of smaller packets, and reassembling the packets at the receiver, if possible +* A tracing system allows to obtain burst-level and fragment-level information at both the transmitter and receiver side +* Models a Virtual Reality traffic source +* 10 of the acquired VR traffic traces can be found in this repository and can be used directly in a simulation, using the `TraceFileBurstGenerator` +* Additional traffic models can be implemented by simply extending the `BurstGenerator` interface + +Future releases will aim to: +* Improve, add, and diversify the real VR traffic traces +* Model second-order statistics for VR traffic +* Include a head-rotation model, coupled with the VR traffic generator +* Optionally include sound traffic in the VR traffic generator, other than video traffic +* Optionally include uplink/downlink control packets for the VR traffic model +* Improve `BurstSink` to also include some form of forward error correction + +More information can be found in the reference paper(s). + ## Install ### Prerequisites ### @@ -19,6 +37,8 @@ Required dependencies include git and a build environment. Please refer to [the ns-3 wiki](https://www.nsnam.org/wiki/Installation) for instructions on how to set up your system to install ns-3. +Please check the [releases](https://github.com/signetlabdei/ns-3-vr-app/releases) for further information about dependencies. + #### Downloading ##### First, clone the main ns-3 repository: @@ -56,3 +76,8 @@ Compiling standalone documentation: 1. Run in your terminal, in the ns-3 root folder, `make -C contrib/vr-app/doc html` 1. Open with your browser the file `contrib/vr-app/doc/models/build/html/bursty-framework.html` to visualize the documentation of the model + + +## Reference paper + +Mattia Lecci, Andrea Zanella, Michele Zorzi, "An ns-3 Implementation of a Bursty Traffic Framework for Virtual Reality Sources," accepted to Workshop on ns-3 (WNS3), Jun. 2021, Virtual Event, USA, Pre-print available: [arXiv:2103.04609](https://arxiv.org/abs/2103.04609) \ No newline at end of file