Skip to content

Commit

Permalink
Add features and future works in README
Browse files Browse the repository at this point in the history
  • Loading branch information
mattia-lecci committed Apr 27, 2021
1 parent 874f3e5 commit b01f683
Showing 1 changed file with 28 additions and 3 deletions.
31 changes: 28 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 ###
Expand All @@ -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:
Expand Down Expand Up @@ -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)

0 comments on commit b01f683

Please sign in to comment.