diff --git a/_config.yml b/_config.yml index a8cfed32..4867bc23 100644 --- a/_config.yml +++ b/_config.yml @@ -26,11 +26,13 @@ baseurl: "" # the subpath of your site, e.g. /blog url: "" # the base hostname & protocol for your site, e.g. http://example.com twitter_username: dsilhavy github_username: dsilhavy -logo: "/assets/images/5g-mag-logo-with-text.png" +logo: "/assets/images/5g-mag-reference-tools.png" aux_links: "5G-MAG Reference Tools on GitHub": - - "//github.com/5G-MAG" + - "//github.com/5G-MAG/Getting-Started" + "5G-MAG Website": + - "https://www.5g-mag.com" # Build settings theme: just-the-docs diff --git a/assets/images/5g-mag-reference-tools.png b/assets/images/5g-mag-reference-tools.png new file mode 100644 index 00000000..ed6257fe Binary files /dev/null and b/assets/images/5g-mag-reference-tools.png differ diff --git a/index.md b/index.md index 4ca72ffa..ed5e72de 100644 --- a/index.md +++ b/index.md @@ -2,12 +2,33 @@ layout: default title: Home nav_order: 0 +has_children: true --- -5g-mag +5g-mag # Overview This website serves as an umbrella for documentation, practical guidelines and examples of applications that can be -built with the software packages and also in combination with other platforms. +built with the software packages available as 5G-MAG Reference Tools and also in combination with other platforms. +A summary about what we do can be found below. + + + +## Practical information +The repositories related to the **5G-MAG REFERENCE TOOLS** are usually starting with **rt-**. Some repositories are also allocating dependencies and auxiliary tools. In the case of third party branches, you will find such repositories with its original name from source. + +For additional details about the 5G-MAG Reference Tools development programme please visit the following links: + +* Developer Space ([developer.5g-mag.com](https://developer.5g-mag.com/)). +* Meet the developer community, participate, contribute, join the public calls: [https://www.5g-mag.com/community](https://www.5g-mag.com/community) +* Learn about the License Model for contributors: [https://www.5g-mag.com/license](https://www.5g-mag.com/license) +* Download installation packages: [https://www.5g-mag.com/install](https://www.5g-mag.com/install) +* Request early access for private repositories: [https://www.5g-mag.com/early-access](https://www.5g-mag.com/early-access) +* Get additional resources for members: [https://www.5g-mag.com/extras](https://www.5g-mag.com/extras) + +## Join the open communities +* Join [Slack](https://5g-mag.slack.com/) for discussion +* Join the [Google Group](https://groups.google.com/g/5g-mag-reference-tools) mailing list +* If you have questions that cannot be shared publicly, reach out to us via email: [reference-tools@5g-mag.com](mailto:reference-tools@5g-mag.com) diff --git a/pages/5g-core-network-components/features.md b/pages/5g-core-network-components/features.md new file mode 100644 index 00000000..315660b2 --- /dev/null +++ b/pages/5g-core-network-components/features.md @@ -0,0 +1,9 @@ +--- +layout: default +title: Features +parent: 5G Core Network Components +has_children: false +nav_order: 1 +--- + +# List of features under implementation diff --git a/pages/5g-core-network-components/index.md b/pages/5g-core-network-components/index.md index 1fa443cc..f1cae425 100644 --- a/pages/5g-core-network-components/index.md +++ b/pages/5g-core-network-components/index.md @@ -2,30 +2,8 @@ layout: default title: 5G Core Network Components has_children: true +nav_order: 2 --- - -# Implementing 5G Core Network components +# 5G Core Network components These are a series of implementations that may be used in combination with other systems. -*** -## 📑 Specifications and architecture -* High-level architectures can be found [here](https://www.5g-mag.com/repositories#5gcore) -*** - -## 🚧 On-going projects -Check the [Projects](https://github.com/5G-MAG/Getting-Started/wiki/5G-Core-Network-Projects) under development for 5G Core Network components -*** - -## ▶️ Using the tools -Check the [TUTORIALS & DEVELOPER XCHANGES](https://www.5g-mag.com/tutorials) and check the wikis below for more information -* Developers are working on it... stay tuned for news. -*** - -## ⭐ Related repositories -* Check the Repositories relevant to 5G Core Network components: Code, releases, packages, dockers, guidelines,... -### UE Data Collection Application Function: [rt-5gc-data-collection-application-function](https://github.com/5G-MAG/rt-5gc-data-collection-application-function) - -### 5G Core Service Consumers: [rt-5gc-service-consumers](https://github.com/5G-MAG/rt-5gc-service-consumers) -* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-5gc-service-consumers#readme) -* [Guidelines, development and testing](https://github.com/5G-MAG/rt-5gc-service-consumers/wiki) -* [Releases](https://github.com/5G-MAG/rt-5gc-service-consumers/releases) -* [Projects](https://github.com/5G-MAG/rt-5gc-service-consumers/projects?query=is%3Aopen) + diff --git a/pages/5g-core-network-components/projects.md b/pages/5g-core-network-components/projects.md new file mode 100644 index 00000000..67065774 --- /dev/null +++ b/pages/5g-core-network-components/projects.md @@ -0,0 +1,11 @@ +--- +layout: default +title: Projects +parent: 5G Core Network Components +has_children: false +nav_order: 2 +--- +# 🚧 Related projects +## 5GMS: Network Assistance and Dynamic Policies features +Addition of Network Assistance and Dynamic Policies features to the 5GMS components, including integration with the BSF and PCF via new, reusable service consumer libraries. +* [Kanban board](https://github.com/orgs/5G-MAG/projects/11) diff --git a/pages/5g-core-network-components/repositories.md b/pages/5g-core-network-components/repositories.md new file mode 100644 index 00000000..eaafa27e --- /dev/null +++ b/pages/5g-core-network-components/repositories.md @@ -0,0 +1,15 @@ +--- +layout: default +title: Repositories +parent: 5G Core Network Components +has_children: false +nav_order: 3 +--- +# ⭐ Related repositories +## UE Data Collection Application Function: [rt-5gc-data-collection-application-function](https://github.com/5G-MAG/rt-5gc-data-collection-application-function) + +## 5G Core Service Consumers: [rt-5gc-service-consumers](https://github.com/5G-MAG/rt-5gc-service-consumers) +* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-5gc-service-consumers#readme) +* [Guidelines, development and testing](https://github.com/5G-MAG/rt-5gc-service-consumers/wiki) +* [Releases](https://github.com/5G-MAG/rt-5gc-service-consumers/releases) +* [Projects](https://github.com/5G-MAG/rt-5gc-service-consumers/projects?query=is%3Aopen) diff --git a/pages/5g-core-network-components/specifications.md b/pages/5g-core-network-components/specifications.md new file mode 100644 index 00000000..8e3066d8 --- /dev/null +++ b/pages/5g-core-network-components/specifications.md @@ -0,0 +1,8 @@ +--- +layout: default +title: Specifications +parent: 5G Core Network Components +has_children: false +nav_order: 0 +--- +# 📑 Specifications and relevant references diff --git a/pages/5g-core-network-components/tutorials.md b/pages/5g-core-network-components/tutorials.md new file mode 100644 index 00000000..3d969873 --- /dev/null +++ b/pages/5g-core-network-components/tutorials.md @@ -0,0 +1,10 @@ +--- +layout: default +title: Tutorials +parent: 5G Core Network Components +has_children: true +nav_order: 4 +--- +# ▶️ Using the tools +Check the [TUTORIALS & DEVELOPER XCHANGES](https://www.5g-mag.com/tutorials) in the 5G-MAG website and the information below. +* We are working on it... diff --git a/pages/5g-media-streaming/Tutorial_1.md b/pages/5g-media-streaming/Tutorial_1.md new file mode 100644 index 00000000..a3bf04a0 --- /dev/null +++ b/pages/5g-media-streaming/Tutorial_1.md @@ -0,0 +1,341 @@ +--- +layout: default +title: 5G MSd Basic End-to-End Setup +parent: Tutorials +grand_parent: 5G Downlink Media Streaming +has_children: false +nav_order: 0 +--- + +# Tutorial - 5G MSd: Basic End-to-End Setup +This guide describes how to setup and configure the 5G-MAG Reference Tools - 5G Downlink Media Streaming components to create an end to end setup as depicted in the illustration below. + +Bildschirm­foto 2023-04-06 um 09 35 46 + +# Versions +This guide requires the following versions: + +| Component | Minimum Version | +| ------------- | ------------- | +| Application Function | `1.3.0` | +| Application Server | `1.2.0` | +| 5GMSd Aware Application | `1.0.0` | +| Media Session Handler | `1.0.0` | +| Media Stream Handler | `1.0.0` | +| Common Android Library | `1.0.0` | + +# Server-side setup +In some cases, you might want to work with a reduced setup to develop new functionality on the client-side. For that reason, the server-side setup guide is divided into two sections the [Option 1: Common server-side setup](#option-1-common-server-side-setup) and [Option 2: Server-side development setup](#option-2-server-side-development-setup). + +## Option 1: Common server-side setup + +### 1. Installing the Application Function +The first component that we need to install is the **5GMSd Application Function (AF)**. The AF is a network function that forms part of the 5G Media Streaming framework as defined in TS 26.501. AF is a logical function which embodies control plane aspects such as provisioning, configuration, and reporting, among others. Such functions can be provisioned by the 5GMSd Application Provider using a RESTful HTTP-based API (M1d). Another RESTful HTTP-based configuration and reporting API (M5d) is exposed to 5GMSd Clients. + +The detailed installation guide for the AF can be found in the corresponding [Github repository](https://github.com/5G-MAG/rt-5gms-application-function). Note that for this tutorial we are following the [installation guide](https://github.com/5G-MAG/rt-5gms-application-function/wiki/Testing-as-a-Local-User#running) to run the AF as a local user. + +### 2. Installing the Application Server +Next, we need to install the **5GMSd Application Server (AS)**. The AS provides 5G Media Streaming services to a population of 5GMSd Clients. This logical function embodies the data plane aspects that deal with media content (for instance, a Content Delivery Network). The content is ingested (both HTTP push- or pull-based are supported) from 5GMSd Application Providers at reference point `M2d`. The content is distributed to 5GMSd Clients at reference point `M4d`, which supports standard pull-based content retrieval protocols (e.g. DASH). + +The detailed installation guide for the AS can be found in the corresponding [Github repository](https://github.com/5G-MAG/rt-5gms-application-server). + +### 3. Running the Application Server + +Now start the AS +```` +sudo 5gms-application-server +```` + +For additional options, refer to the [Wiki documentation](https://github.com/5G-MAG/rt-5gms-application-server/blob/main/docs/README.md#running-the-example-without-building). Pay attention to the port configuration of the AS as it requires root permission to run on the standard ports (80 & 443). + +### 4. Running the Application Function +Now that we installed the AF and the AS we can configure the AF. A detailed configuration guide is available in the [Wiki documentation](https://github.com/5G-MAG/rt-5gms-application-function/wiki/Configuring-the-Application-Function) of the AF. + +#### Configuration of the AF +For this demo, we will run AF and AS on the same machine. As we want to access the `ServiceAccessInformation` via the `M5d` interface from our Media Session Handler running on an Android device we need to slightly modify the configuration. The goal is to expose the `M5d` interface via the IP address of our machine but have it running on a different port to not interfere with the default port of the `M3`interface on the AS (`Port 7777`). + +1. Open `~/rt-5gms-application-function/install/etc/open5gs/msaf.yaml` +2. Find the settings for `msaf:m5` +3. Replace the `addr` field with `0.0.0.0` and choose a different `port`. For instance: +```` +msaf: + m5: + - addr: 0.0.0.0 + - port: 7778 +```` + + +#### Starting the AF + +As we installed the AF as a local user, we start it with the following command: +```` +~/rt-5gms-application-function/install/bin/open5gs-msafd +```` +#### Creating a content hosting configuration + +There is a guide on how to test the AS with the AF in the [AS Wiki](https://github.com/5G-MAG/rt-5gms-application-server/blob/main/docs/README.md#testing-with-the-application-function). We are following a slightly different approach as we use the `msaf-configuration` tool that ships with version `1.3.0` of the Application Function. The `msaf-configuration` tool creates a `provisioningSession` and a `contentHostingConfiguration` based on a JSON input file. Moreover, it automatically generates the required `M8` information for us that we will later need on the client-side. + +First we create a configuration file to be used by the `msaf-configuration` tool: + +```` +[af-sync] +m5_authority = : +#docroot = /var/cache/rt-5gms/as/docroots +#default_docroot = /usr/share/nginx/html +```` + +Replace `` with the IP address of your machine and `` with the port that the `M5` interface is running on. For instance: + +```` +[af-sync] +m5_authority = 192.168.178.55:7778 +#docroot = /var/cache/rt-5gms/as/docroots +#default_docroot = /usr/share/nginx/html +```` + +Place this file in `/etc/rt-5gms/af-sync.conf` + +Now we define a JSON file with the streams: + +````json +{ + "aspId": "5GMAG", + "appId": "5G-MAG_Reference_Tools", + "streams": { + "vod": { + "name": "BBC R&D Demo Streams", + "ingestURL": "https://rdmedia.bbc.co.uk/", + "distributionConfigurations": [ + {"domainNameAlias": ""} + ], + "consumptionReporting": { + "reportingInterval": 30, + "samplePercentage": 50.00, + "locationReporting": true, + "accessReporting": true + } + } + }, + "vodMedia": [ + { + "name": "VoD: Elephant's Dream", + "stream": "vod", + "entryPoints": [ + { + "relativePath": "elephants_dream/1/client_manifest-all.mpd", + "contentType": "application/dash+xml", + "profiles": ["urn:mpeg:dash:profile:isoff-live:2011"] + } + ] + }, + { + "name": "VoD: Big Buck Bunny", + "stream": "vod", + "entryPoints": [ + { + "relativePath": "bbb/2/client_manifest-common_init.mpd", + "contentType": "application/dash+xml", + "profiles": ["urn:mpeg:dash:profile:isoff-live:2011"] + } + ] + }, + { + "name": "VoD: Testcard", + "stream": "vod", + "entryPoints": [ + { + "relativePath": "testcard/vod/manifests/avc-full.mpd", + "contentType": "application/dash+xml", + "profiles": ["urn:mpeg:dash:profile:isoff-live:2011"] + }, + { + "relativePath": "testcard/vod/manifests/avc-full.m3u8", + "contentType": "application/x-mpegURL" + } + ] + } + ] +} +```` + +Again, replace `` with the IP address of your machine. + +Place this file in `/etc/rt-5gms/streams.json` + +Now execute the `msaf-configuration` tool: + +```` +sudo ~/rt-5gms-application-function/install/bin/msaf-configuration +```` + +You should see a message like this: +```` +INFO:__main__:Publishing M8 info to: /usr/share/nginx/html, /var/cache/rt-5gms/as/docroots/192.168.178.55 +```` + +You can check the response of the `m8` request by opening `http://localhost/m8.json` in your browser. It should look like this: + +```` +{ + "m5BaseUrl": "http://192.168.178.55:7778/3gpp-m5/v2/", + "serviceList": [ + { + "provisioningSessionId": "872a0eb2-e40a-41ed-bf2a-03b8343221a7", + "name": "VoD: Llama Drama", + "entryPoints": [ + { + "locator": "http://192.168.178.55/m4d/provisioning-session-872a0eb2-e40a-41ed-bf2a-03b8343221a7/634cd01c-6822-4630-8444-8dd6279f94c6/CaminandesLlamaDrama4K.ism/manifest(format=mpd-time-csf)", + "contentType": "application/dash+xml", + "profiles": [ + "urn:mpeg:dash:profile:isoff-live:2011" + ] + }, + { + "locator": "http://192.168.178.55/m4d/provisioning-session-872a0eb2-e40a-41ed-bf2a-03b8343221a7/634cd01c-6822-4630-8444-8dd6279f94c6/CaminandesLlamaDrama4K.ism/manifest(format=m3u8-aapl-v3)", + "contentType": "application/vnd.apple.mpegurl" + } + ] + } + ] +} +```` + +In our Android application we will use this endpoint later to derive the required information to populate our stream selection drowdown and to query the Application Function via `M5`. + +#### Optional: Creating a server certificate + +Optionally, you can now also [create server certificate](https://github.com/5G-MAG/rt-5gms-application-function/wiki/Testing-the-M1-Interface#server-certificates). For plain `http` based playback we can omit this step. + +#### Optional: Checking the M5 interface +The complete documentation on how to test the M5 interface for AF versions 1.2.0 and above can be found [here](https://github.com/5G-MAG/rt-5gms-application-function/wiki/Testing-the-M5-Interface-on-v1.2.0) + +What we will need on the client side later is the `ServiceAccessInformation`. This will be requested via `M5d` by our MediaSessionHandler. Since retrieving this information is done via a simple HTTP GET request, we can access the information directly in the browser. For that reason, call the following URL and replace `{provisioningSessionId}` with the corresponding value. For instance, + +* `http://${msaf.m5.addr}:${msaf.m5.port}/3gpp-m5/v2/service-access-information/${provisioningSessionId}` + +becomes + +* `http://192.168.178.55:7778/3gpp-m5/v2/service-access-information/a0b5a258-d5da-41ed-b62f-cdd2806778b0` + +The output should look like the following: + +```` +{ + "provisioningSessionId": "a0b5a258-d5da-41ed-b62f-cdd2806778b0", + "provisioningSessionType": "DOWNLINK", + "streamingAccess": { + "mediaPlayerEntry": "http://192.168.178.55/m4d/provisioning-session-a0b5a258-d5da-41ed-b62f-cdd2806778b0/BigBuckBunny_4s_onDemand_2014_05_09.mpd" + } +} +```` + +## Option 2: Server-side development setup +For development purposes, it can be useful to mock the functionality of the AF and the AS. For that reason, 5G-MAG provides a [simple static webserver](https://github.com/5G-MAG/rt-5gms-examples/tree/main/express-mock-af). The server basically contains two endpoints to query `M8` information and the corresponding `ServiceAccessInformation`. The assets that are linked on the webserver are pointing to third-party CDNs. However, it would also be possible to add media content to the webserver in the `public` folder and thereby simulate a local Application Server. + +### 1. Configure the webserver +Open `/express-mock-af/routes/m8.js` and adjust the `m5BaseUrl` to point to your machine. + +Install the dependencies: + +```` +cd express-mock-af +npm install +```` + +### 2. Starting the webserver + +Navigate to the root folder of the server and start it: + +```` +cd express-mock-af +npm start +```` + +# Client-side setup +Not that we have the server-side setup in place we can focus on the client side. We need to install four components (two libraries, two Android applications) for the end-to-end setup. + +## 1. Installing the 5GMSd Common Android Library +The [5GMSd Common Android Library](https://github.com/5G-MAG/rt-5gms-common-android-library) is an Android library that includes models and helper classes used within the different client-side Android applications such as the 5GMSd-Aware Application, 5GMSd Media Stream Handler and the 5GMSd Media Session Handler. + +The installation guide can be found in the [Readme](https://github.com/5G-MAG/rt-5gms-common-android-library#readme) of the project. Note that you need to publish the library to a local maven repository as described in the installation guide. + +## 2. Installing the 5GMSd Media Stream Handler +The [5GMSd Media Stream Handler](https://github.com/5G-MAG/rt-5gms-media-stream-handler) is an Android library that includes the [ExoPlayer](https://github.com/google/ExoPlayer) as a dependency. The 5GMSd Media Stream Handler implements an adapter around the ExoPlayer APIs to expose TS.26.512 M7d interface functionality. Moreover, a MediaSessionHandlerAdapter establishes a Messenger connection to the [Media Session Handler](https://github.com/5G-MAG/rt-5gms-media-session-handler). The 5GMSd Media Stream Handler is included as an Android library by 5GMSd Aware Application. + +The installation guide can be found in the [Readme](https://github.com/5G-MAG/rt-5gms-media-stream-handler#readme) of the project. Note that you need to publish the library to a local maven repository as described in the installation guide. + +## 3. Installing the 5GMSd Media Session Handler +The [5GMSd Media Session Handler](https://github.com/5G-MAG/rt-5gms-media-session-handler) is an Android application that implements functionality for 5G Media Streaming media session handling. It is implemented as an Android Messenger Service that communicates via Inter Process Communication (IPC) with other Android libraries and applications such as the Media Stream Handler and the 5GMSd Aware Application. + +The Media Session Handler communicates with the 5GMSd Application Function via interface M5 to establish and control the delivery of a streaming media session in the downlink direction. In addition, the Media Session Handler exposes APIs via M6 to the 5GMSd-Aware Application and to the Media Player (for downlink streaming). + +The installation guide can be found in the [Readme](https://github.com/5G-MAG/rt-5gms-media-session-handler#readme) of the project. + +## 4. Configuring and installing the 5GMSd-Aware Application +The 5GMSd-Aware Application is an Android application that serves as a reference implementation for 5GMSd. It uses the [Media Stream Handler](https://github.com/5G-MAG/rt-5gms-media-stream-handle) for playback and communication with the [Media Session Handler](https://github.com/5G-MAG/rt-5gms-media-session-handler). + +The 5GMSd Aware Application is an application in the UE, provided by the 5GMSd Application Provider, that contains the service logic of the 5GMSd application service, and interacts with other 5GMSd Client and Network functions via the interfaces and APIs defined in the 5GMSd architecture. + +### 4.a Common Configuration +The 5GMSd-Aware Application supports `m8` input via REST endpoints or local files. For that reason, a configuration file located in `app/src/main/assets/config.properties.xml` is used. It contains a list of the possible `m8` endpoints. Per default, a single 5G-MAG hosted endpoint is linked: + +```` + + + https://rt.5g-mag.com/ + +```` + +For our local AS and AF setup we only need to extend this list with the `M8` endpoint we created previously: + +```` + + + m8/config_local_af.json + http:/// + +```` + +Replace `` with the IP of the machine that is running the AF and the AS, for instance: +```` + + + m8/config_local_af.json + http://192.168.178.55/ + +```` + + +### 4.a Alternative: Development Configuration +If you are using the development web server instead of the common AF and AS installation, simply open `app/src/main/assets/config.properties.xml` and uncomment the following two lines. These two local `.json` files correspond to the default configuration on the static webserver. + +```` + + + m8/config_single_media.json + m8/config_multi_media.json + +```` + +Navigate to `app/src/main/assets/m8` and adjust the IP address of the `m5BaseUrl` in `config_single_media.json` and `config_multi_media.json` to point to your local webserver. + +As an alternative, you can also use the `M8` endpoint of the development web server. For that reason, uncomment the following line and replace the IP address with the IP address of your machine. + +```` + + + http://192.168.178.55:3003/m8/ + +```` + +### 4.b Installation +The installation guide for the 5GMSd-Aware Application can be found in the [Readme](https://github.com/5G-MAG/rt-5gms-application/tree/development/fivegmag_5GMSdAwareApplication) of the project. + + +## 5. Running the application +Now that we have performed all the required setup and configuration, we can finally start our client-side applications. Unlock your Android phone and start the `MediaSessionHandler` if it is not already running. Afterwards start the `5GMSd-Aware Application`. Select an `M8` entry from the dropdown and then select one of the available stream URLs. Next, click on _Start Playback_. The output should look like this: + +Bildschirm­foto 2023-04-26 um 09 43 13 + + + diff --git a/pages/5g-media-streaming/5G-Downlink-Media-Streaming-Projects.md b/pages/5g-media-streaming/features.md similarity index 81% rename from pages/5g-media-streaming/5G-Downlink-Media-Streaming-Projects.md rename to pages/5g-media-streaming/features.md index 211539f5..2b26f6f7 100644 --- a/pages/5g-media-streaming/5G-Downlink-Media-Streaming-Projects.md +++ b/pages/5g-media-streaming/features.md @@ -1,45 +1,12 @@ -This wiki contains the on-going projects and supported features for 5G Downlink Media Streaming. - -# On-going Projects - -## 5GMS: Basic Media stream handling (MVP#1) -The main objective for MVP#1 is to implement a starting point for 5G Media Streaming with DASH-based media streaming using 5GMS formats and protocols as the basis. This includes a basic Media Player talking to a simple 5GMS Application Server. -* [Kanban board](https://github.com/orgs/5G-MAG/projects/3) - -## 5GMS: Media session handling (MVP#2) -The 5GMSd Media Session Handler retrieves Service Access Information from a 5GMSd Application Function (5GMSd AF) via reference point M5d. -* [Kanban board](https://github.com/orgs/5G-MAG/projects/4) - -## 5GMS: M1d Provisioning -Implementation of 5GMSd Provisioning (M1d) APIs -* [Kanban board](https://github.com/orgs/5G-MAG/projects/8) - -## 5GMS: M3 Link (AF to AS RESTful OpenAPI) -Configuration of the 5GMS Application Server by the 5GMS Application Function via an RESTful OpenAPI interface. -* [Kanban board](https://github.com/orgs/5G-MAG/projects/6) - -## 5GMS: Network Assistance and Dynamic Policies features -Addition of Network Assistance and Dynamic Policies features to the 5GMS components, including integration with the BSF and PCF via new, reusable service consumer libraries. -* [Kanban board](https://github.com/orgs/5G-MAG/projects/11) - -## 5GMS: QoE metrics collection and reporting feature -Everything required for the provisioning of QoE metrics collection and reporting in the 5GMS AF as well as the collection of QoE by the 5GMS Client and the reporting of QoE metrics by the Media Session Handler to the 5GMS AF. -* [Kanban board](https://github.com/orgs/5G-MAG/projects/12) - -## 5GMS: Consumption collection and reporting feature -Everything required for the provisioning of media consumption collection and reporting in the 5GMS AF as well as the collection of consumption reports by the 5GMS Client and the reporting by the Media Session Handler to the 5GMS AF. -* [Kanban board](https://github.com/orgs/5G-MAG/projects/16) - -## 5GMS: TS 26.512 V17.5.0 uplift -* [Kanban board](https://github.com/orgs/5G-MAG/projects/18) - -## 5GMS: Cloud infrastructure -* [Kanban board](https://github.com/orgs/5G-MAG/projects/21) - -## 5GMS: DVB-I Service using 5G Media Streaming -* [Kanban board](https://github.com/orgs/5G-MAG/projects/23) - -# List of 5G Downlink Media Streaming Features +--- +layout: default +title: Features +parent: 5G Downlink Media Streaming +has_children: false +nav_order: 1 +--- + +# List of features under implementation The following describes the features of the Application Function that have been implemented, due to be implemented or not planned yet. diff --git a/pages/5g-media-streaming/index.md b/pages/5g-media-streaming/index.md index f220b4d8..2c69d25f 100644 --- a/pages/5g-media-streaming/index.md +++ b/pages/5g-media-streaming/index.md @@ -2,67 +2,8 @@ layout: default title: 5G Downlink Media Streaming has_children: true -toc: false +nav_order: 1 --- -# Implementing 5G Downlink Media Streaming (5GMSd) -Information about 5G Downlink Media Streaming can be found at www.5g-mag.com/streaming -*** -## 📑 Specifications and architecture -* Information about relevant specifications can be found at the [Standards Wiki](https://github.com/5G-MAG/Standards/wiki/5G-Downlink-Media-Streaming-Architecture-(5GMSd):-Relevant-Specifications) -* High-level architectures can be found [here](https://www.5g-mag.com/repositories#media-streaming) -*** - -## 🚧 On-going projects -Check the [Projects](5G-Downlink-Media-Streaming-Projects) under development for 5GMSd -*** - -## ▶️ Using the tools -Check the [TUTORIALS & DEVELOPER XCHANGES](https://www.5g-mag.com/tutorials) and check the wikis below for more information -* [End to End Setup for 5G Downlink Media Streaming (Android)](https://github.com/5G-MAG/Getting-Started/wiki/Use-Case:-5G-Downlink-Media-Streaming-End-to-End-Setup) -*** - -## ⭐ Related repositories -* Check the Repositories relevant to 5GMSd: Code, releases, packages, dockers, guidelines,... - -Please note that 5G Media Streaming makes use of other generic 5G Core Network components: https://github.com/5G-MAG/Getting-Started/wiki/5G-Core-Network - -### 5GMSd Application Function: [rt-5gms-application-function](https://github.com/5G-MAG/rt-5gms-application-function) -* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-5gms-application-function#readme) -* [Guidelines, development and testing](https://github.com/5G-MAG/rt-5gms-application-function/wiki) -* [Releases](https://github.com/5G-MAG/rt-5gms-application-function/releases) -* [Projects](https://github.com/5G-MAG/rt-5gms-application-function/projects?query=is%3Aopen) - -### 5GMSd Application Server: [rt-5gms-application-server](https://github.com/5G-MAG/rt-5gms-application-server) -* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-5gms-application-server#readme) -* [Guidelines, development and testing](https://github.com/5G-MAG/rt-5gms-application-server/wiki) -* [Releases](https://github.com/5G-MAG/rt-5gms-application-server/releases) -* [Projects](https://github.com/5G-MAG/rt-5gms-application-server/projects?query=is%3Aopen) - -### 5GMSd Media Session Handler: [rt-5gms-media-session-handler](https://github.com/5G-MAG/rt-5gms-media-session-handler) -* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-5gms-media-session-handler#readme) -* [Releases](https://github.com/5G-MAG/rt-5gms-media-session-handler/releases) - -### 5GMSd Media Stream Handler: [rt-5gms-media-stream-handler](https://github.com/5G-MAG/rt-5gms-media-stream-handler) -* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-5gms-media-stream-handler#readme) -* [Releases](https://github.com/5G-MAG/rt-5gms-media-stream-handler/releases) -* [Packages](https://github.com/orgs/5G-MAG/packages?repo_name=rt-5gms-media-stream-handler) - -### 5GMSd-Aware Applications: [rt-5gms-application](https://github.com/5G-MAG/rt-5gms-application) -* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-5gms-application#readme) -* [Releases](https://github.com/5G-MAG/rt-5gms-application/releases) - -## Auxiliary repositories - -### 5GMSd Common Android Library: [rt-5gms-common-android-library](https://github.com/5G-MAG/rt-5gms-common-android-library) -* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-5gms-common-android-library#readme) -* [Releases](https://github.com/5G-MAG/rt-5gms-common-android-library/releases) -* [Packages](https://github.com/orgs/5G-MAG/packages?repo_name=rt-5gms-common-android-library) - -### 5GMSd Examples: [rt-5gms-examples](https://github.com/5G-MAG/rt-5gms-examples) -* [Information](https://github.com/5G-MAG/rt-5gms-examples#readme) -* [Releases](https://github.com/5G-MAG/rt-5gms-examples/releases) - -### Tools common to various projects: [rt-common-shared](https://github.com/5G-MAG/rt-common-shared) -* [Information](https://github.com/5G-MAG/rt-common-shared#readme) -*** +# 5G Downlink Media Streaming (5GMSd) + diff --git a/pages/5g-media-streaming/projects.md b/pages/5g-media-streaming/projects.md new file mode 100644 index 00000000..2518a640 --- /dev/null +++ b/pages/5g-media-streaming/projects.md @@ -0,0 +1,46 @@ +--- +layout: default +title: Projects +parent: 5G Downlink Media Streaming +has_children: false +nav_order: 2 +--- + +# 🚧 Related projects + +## 5GMS: Basic Media stream handling (MVP#1) +The main objective for MVP#1 is to implement a starting point for 5G Media Streaming with DASH-based media streaming using 5GMS formats and protocols as the basis. This includes a basic Media Player talking to a simple 5GMS Application Server. +* [Kanban board](https://github.com/orgs/5G-MAG/projects/3) + +## 5GMS: Media session handling (MVP#2) +The 5GMSd Media Session Handler retrieves Service Access Information from a 5GMSd Application Function (5GMSd AF) via reference point M5d. +* [Kanban board](https://github.com/orgs/5G-MAG/projects/4) + +## 5GMS: M1d Provisioning +Implementation of 5GMSd Provisioning (M1d) APIs +* [Kanban board](https://github.com/orgs/5G-MAG/projects/8) + +## 5GMS: M3 Link (AF to AS RESTful OpenAPI) +Configuration of the 5GMS Application Server by the 5GMS Application Function via an RESTful OpenAPI interface. +* [Kanban board](https://github.com/orgs/5G-MAG/projects/6) + +## 5GMS: Network Assistance and Dynamic Policies features +Addition of Network Assistance and Dynamic Policies features to the 5GMS components, including integration with the BSF and PCF via new, reusable service consumer libraries. +* [Kanban board](https://github.com/orgs/5G-MAG/projects/11) + +## 5GMS: QoE metrics collection and reporting feature +Everything required for the provisioning of QoE metrics collection and reporting in the 5GMS AF as well as the collection of QoE by the 5GMS Client and the reporting of QoE metrics by the Media Session Handler to the 5GMS AF. +* [Kanban board](https://github.com/orgs/5G-MAG/projects/12) + +## 5GMS: Consumption collection and reporting feature +Everything required for the provisioning of media consumption collection and reporting in the 5GMS AF as well as the collection of consumption reports by the 5GMS Client and the reporting by the Media Session Handler to the 5GMS AF. +* [Kanban board](https://github.com/orgs/5G-MAG/projects/16) + +## 5GMS: TS 26.512 V17.5.0 uplift +* [Kanban board](https://github.com/orgs/5G-MAG/projects/18) + +## 5GMS: Cloud infrastructure +* [Kanban board](https://github.com/orgs/5G-MAG/projects/21) + +## 5GMS: DVB-I Service using 5G Media Streaming +* [Kanban board](https://github.com/orgs/5G-MAG/projects/23) diff --git a/pages/5g-media-streaming/repositories.md b/pages/5g-media-streaming/repositories.md new file mode 100644 index 00000000..11ae8bf9 --- /dev/null +++ b/pages/5g-media-streaming/repositories.md @@ -0,0 +1,49 @@ +--- +layout: default +title: Repositories +parent: 5G Downlink Media Streaming +has_children: false +nav_order: 3 +--- + +# ⭐ Related repositories +Please note that 5G Media Streaming makes use of other generic [5G Core Network components](https://jordijoangimenez.github.io/Getting-Started/pages/5g-core-network-components/) + +## 5GMSd Application Function: [rt-5gms-application-function](https://github.com/5G-MAG/rt-5gms-application-function) +* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-5gms-application-function#readme) +* [Guidelines, development and testing](https://github.com/5G-MAG/rt-5gms-application-function/wiki) +* [Releases](https://github.com/5G-MAG/rt-5gms-application-function/releases) +* [Projects](https://github.com/5G-MAG/rt-5gms-application-function/projects?query=is%3Aopen) + +## 5GMSd Application Server: [rt-5gms-application-server](https://github.com/5G-MAG/rt-5gms-application-server) +* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-5gms-application-server#readme) +* [Guidelines, development and testing](https://github.com/5G-MAG/rt-5gms-application-server/wiki) +* [Releases](https://github.com/5G-MAG/rt-5gms-application-server/releases) +* [Projects](https://github.com/5G-MAG/rt-5gms-application-server/projects?query=is%3Aopen) + +## 5GMSd Media Session Handler: [rt-5gms-media-session-handler](https://github.com/5G-MAG/rt-5gms-media-session-handler) +* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-5gms-media-session-handler#readme) +* [Releases](https://github.com/5G-MAG/rt-5gms-media-session-handler/releases) + +## 5GMSd Media Stream Handler: [rt-5gms-media-stream-handler](https://github.com/5G-MAG/rt-5gms-media-stream-handler) +* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-5gms-media-stream-handler#readme) +* [Releases](https://github.com/5G-MAG/rt-5gms-media-stream-handler/releases) +* [Packages](https://github.com/orgs/5G-MAG/packages?repo_name=rt-5gms-media-stream-handler) + +## 5GMSd-Aware Applications: [rt-5gms-application](https://github.com/5G-MAG/rt-5gms-application) +* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-5gms-application#readme) +* [Releases](https://github.com/5G-MAG/rt-5gms-application/releases) + +# Auxiliary repositories + +## 5GMSd Common Android Library: [rt-5gms-common-android-library](https://github.com/5G-MAG/rt-5gms-common-android-library) +* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-5gms-common-android-library#readme) +* [Releases](https://github.com/5G-MAG/rt-5gms-common-android-library/releases) +* [Packages](https://github.com/orgs/5G-MAG/packages?repo_name=rt-5gms-common-android-library) + +## 5GMSd Examples: [rt-5gms-examples](https://github.com/5G-MAG/rt-5gms-examples) +* [Information](https://github.com/5G-MAG/rt-5gms-examples#readme) +* [Releases](https://github.com/5G-MAG/rt-5gms-examples/releases) + +## Tools common to various projects: [rt-common-shared](https://github.com/5G-MAG/rt-common-shared) +* [Information](https://github.com/5G-MAG/rt-common-shared#readme) diff --git a/pages/5g-media-streaming/specifications.md b/pages/5g-media-streaming/specifications.md new file mode 100644 index 00000000..787d2172 --- /dev/null +++ b/pages/5g-media-streaming/specifications.md @@ -0,0 +1,11 @@ +--- +layout: default +title: Specifications +parent: 5G Downlink Media Streaming +has_children: false +nav_order: 0 +--- + +# 📑 Specifications and relevant references +* Information about relevant specifications can be found at the [Standards Wiki](https://github.com/5G-MAG/Standards/wiki/5G-Downlink-Media-Streaming-Architecture-(5GMSd):-Relevant-Specifications) +* A list of relevant 3GPP Work Items can be found at [Standards Wiki](https://github.com/5G-MAG/Standards/wiki/5G-Downlink-Media-Streaming-Architecture-(5GMSd):-Relevant-Work-Items) diff --git a/pages/5g-media-streaming/standards.md b/pages/5g-media-streaming/standards.md deleted file mode 100644 index e95ad701..00000000 --- a/pages/5g-media-streaming/standards.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -layout: default -title: 5GMS Standards -parent: 5G Downlink Media Streaming ---- - -# 5G Downlink Media Streaming Architecture (5GMSd): Relevant Specifications - -This is a list of specifications in the scope of 5G Downlink Media Streaming. - -## Main specifications -* [ETSI TS 126 501](https://portal.etsi.org/webapp/workprogram/Report_WorkItem.asp?WKI_ID=67203) - 5G Media Streaming ( - 5GMS): General description and architecture (3GPP TS 26.501 version 17.3.0 Release 17) -* [ETSI TS 126 512](https://portal.etsi.org/webapp/workprogram/Report_WorkItem.asp?WKI_ID=67679) - 5G Media Streaming ( - 5GMS): Protocols (3GPP TS 26.512 version 17.3.0 Release 17) - - diff --git a/pages/5g-media-streaming/tutorials.md b/pages/5g-media-streaming/tutorials.md new file mode 100644 index 00000000..24a9c219 --- /dev/null +++ b/pages/5g-media-streaming/tutorials.md @@ -0,0 +1,10 @@ +--- +layout: default +title: Tutorials +parent: 5G Downlink Media Streaming +has_children: true +nav_order: 4 +--- + +# ▶️ Using the tools +Check the [TUTORIALS & DEVELOPER XCHANGES](https://www.5g-mag.com/tutorials) in the 5G-MAG website and the information below. diff --git a/pages/5g-multicast-broadcast-services/features.md b/pages/5g-multicast-broadcast-services/features.md new file mode 100644 index 00000000..7e6f48db --- /dev/null +++ b/pages/5g-multicast-broadcast-services/features.md @@ -0,0 +1,9 @@ +--- +layout: default +title: Features +parent: 5G Multicast Broadcast Services +has_children: false +nav_order: 1 +--- + +# List of features under implementation diff --git a/pages/5g-multicast-broadcast-services/index.md b/pages/5g-multicast-broadcast-services/index.md index 2c7c4d37..03e23aab 100644 --- a/pages/5g-multicast-broadcast-services/index.md +++ b/pages/5g-multicast-broadcast-services/index.md @@ -2,24 +2,8 @@ layout: default title: 5G Multicast Broadcast Services has_children: true +nav_order: 5 --- -# Implementing 5MBS: 5G Multicast and Broadcast Services -Information about 5G Multicast and Broadcast Services can be found at www.5g-mag.com/multicast-broadcast -*** -## 📑 Specifications and architecture -* Information about relevant specifications can be found at the [Standards Wiki](https://github.com/5G-MAG/Standards/wiki/5G-Multicast-Broadcast-Services-(5MBS):-Relevant-Specifications) -* High-level architectures can be found [here](https://www.5g-mag.com/repositories#multicast-broadcast) -*** - -## 🚧 On-going projects -Check the [Projects](https://github.com/5G-MAG/Getting-Started/wiki/5G-Multicast-Broadcast-Services-Projects) under development for 5G Multicast and Broadcast Services -*** - -## ▶️ Using the tools -Check the [TUTORIALS & DEVELOPER XCHANGES](https://www.5g-mag.com/tutorials) and check the wikis below for more information -*Developers are working on it... stay tuned for news. -*** - -## ⭐ Related repositories -* Check the Repositories relevant to 5G Multicast and Broadcast Services: Code, releases, packages, dockers, guidelines,... +# 5G Multicast and Broadcast Services (5MBS) + diff --git a/pages/5g-multicast-broadcast-services/projects.md b/pages/5g-multicast-broadcast-services/projects.md new file mode 100644 index 00000000..e15d7d1e --- /dev/null +++ b/pages/5g-multicast-broadcast-services/projects.md @@ -0,0 +1,14 @@ +--- +layout: default +title: Projects +parent: 5G Multicast Broadcast Services +has_children: false +nav_order: 2 +--- + +# 🚧 Related projects + +## 5MBS: 5G Core functions + +Initial implementation of MB-SMF, MB-UPF, AMF and basic multicast support in the 5G Core +* [Kanban board](https://github.com/orgs/5G-MAG/projects/19) diff --git a/pages/5g-multicast-broadcast-services/repositories.md b/pages/5g-multicast-broadcast-services/repositories.md new file mode 100644 index 00000000..59a59cb2 --- /dev/null +++ b/pages/5g-multicast-broadcast-services/repositories.md @@ -0,0 +1,9 @@ +--- +layout: default +title: Repositories +parent: 5G Multicast Broadcast Services +has_children: false +nav_order: 3 +--- + +# ⭐ Related repositories diff --git a/pages/5g-multicast-broadcast-services/specifications.md b/pages/5g-multicast-broadcast-services/specifications.md new file mode 100644 index 00000000..306c816c --- /dev/null +++ b/pages/5g-multicast-broadcast-services/specifications.md @@ -0,0 +1,10 @@ +--- +layout: default +title: Specifications +parent: 5G Multicast Broadcast Services +has_children: false +nav_order: 0 +--- +# 📑 Specifications and relevant references +* Information about relevant specifications can be found at the [Standards Wiki](https://github.com/5G-MAG/Standards/wiki/5G-Multicast-Broadcast-Services-(5MBS):-Relevant-Specifications) +* A list of relevant 3GPP Work Items can be found at [Standards Wiki](https://github.com/5G-MAG/Standards/wiki/5G-Multicast-Broadcast-Services-(5MBS):-Relevant-Work-Items) diff --git a/pages/5g-multicast-broadcast-services/tutorials.md b/pages/5g-multicast-broadcast-services/tutorials.md new file mode 100644 index 00000000..3ed1d6ce --- /dev/null +++ b/pages/5g-multicast-broadcast-services/tutorials.md @@ -0,0 +1,11 @@ +--- +layout: default +title: Tutorials +parent: 5G Multicast Broadcast Services +has_children: true +nav_order: 4 +--- + +# ▶️ Using the tools +Check the [TUTORIALS & DEVELOPER XCHANGES](https://www.5g-mag.com/tutorials) in the 5G-MAG website and the information below. +* We are working on it... diff --git a/pages/ai-ml-evaluation-framework/features.md b/pages/ai-ml-evaluation-framework/features.md new file mode 100644 index 00000000..05762443 --- /dev/null +++ b/pages/ai-ml-evaluation-framework/features.md @@ -0,0 +1,9 @@ +--- +layout: default +title: Features +parent: AI / ML Evaluation Framework +has_children: false +nav_order: 1 +--- + +# List of features under implementation diff --git a/pages/ai-ml-evaluation-framework/index.md b/pages/ai-ml-evaluation-framework/index.md index 4b7e0d11..9790d527 100644 --- a/pages/ai-ml-evaluation-framework/index.md +++ b/pages/ai-ml-evaluation-framework/index.md @@ -2,27 +2,8 @@ layout: default title: AI / ML Evaluation Framework has_children: true +nav_order: 8 --- -# Implementing Artificial Intelligence and Machine Learning Evaluation Framework -TBC -*** -## 📑 Specifications and architecture -* High-level architectures can be found [here](https://www.5g-mag.com/repositories#ai-ml-evaluation) -*** - -## 🚧 On-going projects -Check the [Projects](https://github.com/5G-MAG/Getting-Started/wiki/AI-ML-Evaluation-Framework-Projects) under development for Artificial Intelligence and Machine Learning -*** - -## ▶️ Using the tools -Check the [TUTORIALS & DEVELOPER XCHANGES](https://www.5g-mag.com/tutorials) and check the wikis below for more information -*Developers are working on it... stay tuned for news. -*** - -## ⭐ Related repositories -* Check the Repositories relevant to Artificial Intelligence and Machine Learning Evaluation Framework: Code, releases, packages, dockers, guidelines,... - Note that these repositories are currently private and under testing. Early access can be requested at: https://www.5g-mag.com/early-access - -### AI/ML Evaluation Framework: [rt-ai-ml-evaluation-framework](https://github.com/5G-MAG/rt-ai-ml-evaluation-framework) -* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-ai-ml-evaluation-framework#readme) +# Artificial Intelligence and Machine Learning Evaluation Framework + diff --git a/pages/ai-ml-evaluation-framework/projects.md b/pages/ai-ml-evaluation-framework/projects.md new file mode 100644 index 00000000..d674b907 --- /dev/null +++ b/pages/ai-ml-evaluation-framework/projects.md @@ -0,0 +1,9 @@ +--- +layout: default +title: Projects +parent: AI / ML Evaluation Framework +has_children: false +nav_order: 2 +--- + +# 🚧 Related projects diff --git a/pages/ai-ml-evaluation-framework/repositories.md b/pages/ai-ml-evaluation-framework/repositories.md new file mode 100644 index 00000000..0ca5a0a3 --- /dev/null +++ b/pages/ai-ml-evaluation-framework/repositories.md @@ -0,0 +1,13 @@ +--- +layout: default +title: Repositories +parent: AI / ML Evaluation Framework +has_children: false +nav_order: 3 +--- + +# ⭐ Related repositories +Note that these repositories are currently private and under testing. Early access can be requested at: https://www.5g-mag.com/early-access + +## AI/ML Evaluation Framework: [rt-ai-ml-evaluation-framework](https://github.com/5G-MAG/rt-ai-ml-evaluation-framework) +* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-ai-ml-evaluation-framework#readme) diff --git a/pages/ai-ml-evaluation-framework/specifications.md b/pages/ai-ml-evaluation-framework/specifications.md new file mode 100644 index 00000000..5e112160 --- /dev/null +++ b/pages/ai-ml-evaluation-framework/specifications.md @@ -0,0 +1,8 @@ +--- +layout: default +title: Specifications +parent: AI / ML Evaluation Framework +has_children: false +nav_order: 0 +--- +# 📑 Specifications and relevant references diff --git a/pages/ai-ml-evaluation-framework/tutorials.md b/pages/ai-ml-evaluation-framework/tutorials.md new file mode 100644 index 00000000..569573e4 --- /dev/null +++ b/pages/ai-ml-evaluation-framework/tutorials.md @@ -0,0 +1,11 @@ +--- +layout: default +title: Tutorials +parent: AI / ML Evaluation Framework +has_children: true +nav_order: 4 +--- + +# ▶️ Using the tools +Check the [TUTORIALS & DEVELOPER XCHANGES](https://www.5g-mag.com/tutorials) in the 5G-MAG website and the information below. +* We are working on it... diff --git a/pages/emergency-alerts/features.md b/pages/emergency-alerts/features.md new file mode 100644 index 00000000..31f24598 --- /dev/null +++ b/pages/emergency-alerts/features.md @@ -0,0 +1,9 @@ +--- +layout: default +title: Features +parent: Emergency Alerts over 5G Broadcast +has_children: false +nav_order: 1 +--- + +# List of features under implementation diff --git a/pages/emergency-alerts/index.md b/pages/emergency-alerts/index.md index c11335ee..e1154147 100644 --- a/pages/emergency-alerts/index.md +++ b/pages/emergency-alerts/index.md @@ -1,24 +1,9 @@ --- layout: default -title: Emergency Alerts +title: Emergency Alerts over 5G Broadcast has_children: true +nav_order: 6 --- -# Implementing Emergency Alerts over 5G Broadcast -Information about LTE-based 5G Broadcast can be found at www.5g-mag.com/5gbroadcast -*** -## 📑 Specifications and architecture -* Information about relevant specifications can be found at the [Standards Wiki](https://github.com/5G-MAG/Standards/wiki/MBMS-&-LTE-based-5G-Broadcast:-Relevant-Specifications) -* High-level architectures can be found [here](https://www.5g-mag.com/repositories#emergency5gbroadcast) -*** - -## 🚧 On-going projects -Check the [Projects](Emergency-Alerts-5G-Broadcast-Projects) under development for Emergency Alerts over 5G Broadcast -*** - -## ▶️ Using the tools -* Developers are working on it... stay tuned for news. -*** - -## ⭐ Related repositories -* Check the Repositories relevant to MBMS & LTE-based 5G Broadcast: Code, releases, packages, dockers, guidelines,... +# Emergency Alerts over 5G Broadcast + diff --git a/pages/emergency-alerts/projects.md b/pages/emergency-alerts/projects.md new file mode 100644 index 00000000..03f8fb94 --- /dev/null +++ b/pages/emergency-alerts/projects.md @@ -0,0 +1,13 @@ +--- +layout: default +title: Projects +parent: Emergency Alerts over 5G Broadcast +has_children: false +nav_order: 2 +--- + +# 🚧 Related projects + +## MBMS: Public Warning System +Issues and required functionality around support for a Public Warning System as defined in ETSI 103 720. +* [Kanban board](https://github.com/orgs/5G-MAG/projects/20) diff --git a/pages/emergency-alerts/repositories.md b/pages/emergency-alerts/repositories.md new file mode 100644 index 00000000..4f622e8e --- /dev/null +++ b/pages/emergency-alerts/repositories.md @@ -0,0 +1,9 @@ +--- +layout: default +title: Repositories +parent: Emergency Alerts over 5G Broadcast +has_children: false +nav_order: 3 +--- + +# ⭐ Related repositories diff --git a/pages/emergency-alerts/specifications.md b/pages/emergency-alerts/specifications.md new file mode 100644 index 00000000..aac0e553 --- /dev/null +++ b/pages/emergency-alerts/specifications.md @@ -0,0 +1,8 @@ +--- +layout: default +title: Specifications +parent: Emergency Alerts over 5G Broadcast +has_children: false +nav_order: 0 +--- +# 📑 Specifications and relevant references diff --git a/pages/emergency-alerts/tutorials.md b/pages/emergency-alerts/tutorials.md new file mode 100644 index 00000000..305b6736 --- /dev/null +++ b/pages/emergency-alerts/tutorials.md @@ -0,0 +1,11 @@ +--- +layout: default +title: Tutorials +parent: Emergency Alerts over 5G Broadcast +has_children: true +nav_order: 4 +--- + +# ▶️ Using the tools +Check the [TUTORIALS & DEVELOPER XCHANGES](https://www.5g-mag.com/tutorials) in the 5G-MAG website and the information below. +* We are working on it... diff --git a/pages/guidelines-contributors.md b/pages/guidelines-contributors.md new file mode 100644 index 00000000..2555b8d2 --- /dev/null +++ b/pages/guidelines-contributors.md @@ -0,0 +1,104 @@ +--- +layout: default +title: Guidelines for Contributors +parent: Home +--- + +# Guidelines for Contributors + +If you wish to contribute code to the projects then you will first need **sign the Contributor License Agreement (CLA)**. Only +individuals and/or companies with a signed CLA can contribute code. Please visit and for more details and to download the CLA form. + +## Raising Issues + +Anyone can raise issues against projects, you do not need to have signed the Contributor License Agreement (CLA) to do so. + + +## Releases + +### Release Process + +**TODO: Details of the release process** +- Tagging for release candidates +- Period of RC testing (see [Testing release candidates](#testing-release-candidates)) +- If there are blocking issues + - Fix blockers + - Create new release candidate +- ... otherwise + - Package up the release + - Announce the release on Slack and Google Groups + +### Testing release candidates + +**TODO: How releases are tested** + +## Git Branching strategy +We are using a slightly modified version of Gitflow as a branching model. A detailed introduction to Gitflow can be found [here](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow). + +#### Main branch +The _main_ branch stores the official release history. The current version of the _main_ branch always stores the latest release. + +#### Development branch +The _development_ branch serves as the integration branch for new feature and bugfix branches. It reflects the latest stable changes in the current development cycle. + +#### Feature branches +Each new feature is implemented in a separate _feature_ branch. Feature branches use _development_ as their parent branch. When a feature is completed the respective branch gets merged back into development. + +A feature branch is created the following way: +```` +git checkout development +git checkout -b feature/newfeature +```` + +#### Release branches +Once the _development_ branch has acquired enough features and bugfixes for a release, a release candidate branch is created based on the current version of the _development_ branch. For details on the release procedure please refer to the [release procedure](https://github.com/Dash-Industry-Forum/DASH-IF-Conformance/wiki/Release-Procedure) documentation. + +The release candidate always includes a version number and is created in the following way: + +```` +git checkout develop +git checkout -b RC-1.2.0 +```` + +Once a release candidate is approved the respective branch is merged into the _main_ branch. + +#### Bugfix branches +Similar to _feature_ branches, the _bugfix_ branches are created directly from _development_. In contrast to hotfixes, bugfixes are not considered criticial and do not require a fast new release. _Bugfix_ branches are created the following way: + +```` +git checkout development +git checkout -b bugfix/newbugfix +```` + +#### Hotfix branches +_Hotfix_ branches are used to quickly patch production releases in case of critical errors. _Hotfix_ branches are created directly from _main_ and merged back into _main_ and _development_ as soon as they are completed. Once the hotfix is applied a new release shall be created. + +```` +git checkout main +git checkout -b hotfix/newhotfix +```` + +#### Cloning a repository with a specific branch +It is also possible to clone a repository and specify the target branch directly: + +`git clone -b ` + +## Forking the project +To work on a new feature or a bugfix you first need to fork the repository that you want to work on. A detailed guide how to fork a repository can be found [here](https://docs.github.com/en/get-started/quickstart/fork-a-repo). + +## Pull requests +Once a feature or a hotfix branch is completed a new pull request against the _development_ (in case of _feature_ branches) or the _main_ branch (in case of _hotfix_ branches) is created: + +1. Navigate to the list of available branches. Depending on the concrete setup the new branch is available directly on the main repository or on your fork of the main repository. + +Bildschirmfoto 2022-03-22 um 14 30 29 + +2. Click on "New pull request" +Bildschirmfoto 2022-03-22 um 14 38 22 + +3. Select the target (base) branch: + * For `feature` branches select the `development` branch + * For `hotfix` branches select the `main` branch +4. Provide a summary of your changes in the textfield +5. Click on "Create pull request" + diff --git a/pages/lte-based-5g-broadcast/Tutorial_1.md b/pages/lte-based-5g-broadcast/Tutorial_1.md new file mode 100644 index 00000000..2405e428 --- /dev/null +++ b/pages/lte-based-5g-broadcast/Tutorial_1.md @@ -0,0 +1,200 @@ +--- +layout: default +title: HLS playback over 5G Broadcast +parent: Tutorials +grand_parent: MBMS and LTE-based 5G Broadcast +has_children: false +nav_order: 4 +--- + +# Tutorial - HLS playback over 5G Broadcast + +## Introduction + +The goal of this documentation is to provide a use-case oriented information, i.e., the required steps to setup the 5G-MAG Reference Tools to playback a HLS video which was received via 5G Broadcast [1] can be viewed by using the 5G-MAG Reference Tools. The final outcome is also illustrated in a short demo video that can be found [here](https://github.com/5G-MAG/Documentation-and-Architecture#5g-mag-reference-tools---demo-video---overview). + +## Background + +### HTTP Live Streaming (HLS) + +HTTP Live Streaming (HLS) is an HTTP-based adaptive bitrate streaming communications protocol developed by +Apple Inc. and released in 2009 [2]. +HLS is based on master and media playlists (m3u8 files). The master playlist links to media playlists with the media +playlists describing the content. HLS is mainly used on Apple platforms due to native support. HLS typically uses the +Transport Stream (TS) media container, but also offers support for f-mp4/CMAF. + +More information can be found in the IETF HLS specification: + +* [RFC 8216 - HTTP Live Streaming](https://datatracker.ietf.org/doc/html/rfc8216) + +### Multimedia Broadcast/Multicast Service (MBMS) + +MBMS is a point-to-multipoint service in which data is transmitted from a single source entity to multiple recipients. +The MBMS bearer service offers two modes, namely broadcast mode and multicast mode. This use-case focus on the broadcast reception mode (5G Broadcast). + +More information about MBMS and the related interfaces and components can be found in the corresponding 3GPP and ETSI +specifications: + +* [23.246 - Multimedia Broadcast/Multicast Service (MBMS); Architecture and functional description(Release 16)](https://www.3gpp.org/ftp/Specs/archive/23_series/23.246/) +* [26.347 - Multimedia Broadcast/Multicast Service (MBMS); Application Programming Interface and URL (Release 16)](https://www.3gpp.org/ftp/Specs/archive/26_series/26.347/) +* [26.346 - Multimedia Broadcast/Multicast Service (MBMS); Protocols and codecs(Release 16)](https://www.3gpp.org/ftp/Specs/archive/26_series/26.346) +* [29.116 - Representational state transfer over xMB reference point between content provider and BM-SC](https://www.3gpp.org/ftp/Specs/archive/29_series/29.116) +* [ETSI TS 123 246 - Multimedia Broadcast/Multicast Service (MBMS); Architecture and functional description ](https://www.etsi.org/deliver/etsi_ts/123200_123299/123246/) + +### 5G-MAG Reference Tools + +Detailed information about the architecture of the 5G-MAG Reference Tools and how the MBMS broadcast mode is implemented can +be found on the Wiki pages of the different projects: + +* [MBMS Modem](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/MBMS-Modem) +* [MBMS Middleware](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/MBMS-Middleware) +* [Webinterface](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/Webinterface) + +## Requirements + +In order to be able to play an HLS video which is received by 5G Broadcast, we need to install and run the following components of the 5G-MAG Reference Tools (make sure you have the suggested [hardware](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/Hardware-Requirements#hardware-requirements) and [OS](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/Hardware-Requirements#os) ready): + + +| Component | Required/Optional | Min version | Description | +| ------------- | ------------- | ------------- | ------------- | +| [MBMS Modem](https://github.com/5G-MAG/rt-mbms-modem) | Required | v1.1.1 | The MBMS Modem builds the lower part of the 5G-MAG Reference Tools. Its main task is to convert a 5G BC input signal (received either as live I/Q raw data from the SDR or as prerecorded SDR sample file) to multicast IP packets on the output. The MBMS Modem can run as background process or can be started/stopped manually. | +| [MBMS Middleware](https://github.com/5G-MAG/rt-mbms-mw) | Required | v0.9.1 | The MBMS Middleware presents the heart of the 5G-MAG Reference Tools. Its main task is to provide the best available content to the (internal or external) application at any time. If available, it combines content from (mobile) broadband, WiFi with the 5G broadcast content from the MBMS Modem using an advanced decision logic. The content is presented to the applications in the form of an intelligent edge cache ready for pickup via http(s). Internally, the MBMS Middleware uses the [5G-MAG Reference Tools FLUTE library](https://github.com/5G-MAG/rt-libflute) to decode FLUTE encoded manifest files and media segments. | +| [RT Webinterace](https://github.com/5G-MAG/rt-wui)| Optional | v0.0.10 | The 5G-MAG Reference Tools WebUserInterface (rt-wui)provides an optional graphical webinterface with a control display for each 5G-MAG Reference Tools process (MBMS Modem, MBMS Middleware). Its main purpose is to collect and display useful information from the MBMS Modem and the MBMS Middleware. The webinterface provides basic browser-based HLS playback of the HLS manifest and segments provided by the MBMS Middlware using [hls.js](https://github.com/video-dev/hls.js/). | +| [HLS sample recording](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/Sample-Files#hls-payload) | Optional (setup requires either a sample recoding or a an SDR) | / | In order to support application developers as well as 5G-MAG contributors for testing their improvements, ORS captured sample files ("raw data" = digitized I/Q data at LimeSDR Mini output) directly from a 5G BC transmitter. +| Software Defined Radio (SDR) | Optional (setup requires either a sample recoding or a an SDR) | / | In case you are able to receive 5G Broadcast live signals, you need a Software Defined Radio (SDR) to convert the radio signal to an digitized I/Q data to feed the MBMS modem. A list of working SDRs can be found [here](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/Hardware-Requirements#supported-sdr) + + +## Basic workflow + +As described in [Requirements](#Requirements) we need the MBMS Modem, the MBMS Middleware and a media player in order to +enable playback of HLS content in broadcast mode using the 5G-MAG Reference Tools. The basic interaction and output of +these components is illustrated in the Figure below: + +![Architecture](https://github.com/5G-MAG/Documentation-and-Architecture/blob/main/media/architecture/5G-MAG%20RT%20Architecture%20simplified.drawio.png) + +The output of the SDR or the sample file serves as the input for the MBMS Modem. The MBMS Modem converts the input data +to a UDP multicast. The UDP multicast serves as the input for the MBMS Middleware. The FLUTE encoded content is decoded +in the MBMS Middleware using the [5G-MAG Reference Tools FLUTE library](https://github.com/5G-MAG/rt-libflute). Once the +manifest files and media segments are FLUTE decoded they are cached in the middleware and made available to the media +player via an Nginx proxy. The media player itself is not aware that the content is provided via broadcast. + +Note that in +the illustration the media player is depicted as a separate component and not part of the web interface. + +## Installation + +Detailed installation instructions can be found in the respective Wiki documentation of the different projects. In order +to enable HLS playback via MBMS the following steps are required: + +1. [Install the MBMS Modem](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/MBMS-Modem#Installation) +2. [Install the MBMS Middleware](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/MBMS-Middleware#Installation) +3. [Install the Webinterface](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/Webinterface#Installation) +4. [Download an HLS sample file](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/Sample-Files) or setup an HLS live stream on your transmitting infrastructure + +## Running the components + +Once all the required components have been installed, we need to sequentially start all of them. Depending on the +concrete use case (either a live SDR input or a prerecorded sample file) the concrete calls are slightly different. + +### Using a prerecorded sample file +This Section provides information on how to run the 5G-MAG Reference Tools using a prerecorded HLS sample file. + +#### MBMS Modem +1. Follow the detailed instructions on how to configure multicast routing provided [here](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/mbms-modem#run-the-mbms-modem). +2. Stop and start the MBMS Modem as a service in order to generate or update the required configurations files. Note that this step might be required again after a reboot. + - `systemctl stop 5gmag-rt-modem` + - `systemctl start 5gmag-rt-modem` +3. Since we don't want to run the MBMS Modem as a service in the background but instead provide a prerecorded sample file, we need to make sure that the service is not running. Calling `systemctl stop 5g-mag-rt-modem` stops the service. +4. Start the MBMS Modem with a sample as specified [here](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/mbms-modem#run-a-sample-file). It is important to provide the right bandwidth to the MBMS Modem. Consequently, for a 5 MHz bandwidth sample file, the command looks like this: `./modem -f "PathToSample/samplefile.raw" -b 5`. + +The final output on the terminal should now look like similar to the output below: +```` +modem[7891]: 5g-mag-rt modem v1.1.1 starting up +modem[7891]: Initialising SDR +modem[7891]: Launching phy thread with realtime scheduling priority 10 +modem[7891]: Launching phy thread with realtime scheduling priority 10 +modem[7891]: Launching phy thread with realtime scheduling priority 10 +modem[7891]: Launching phy thread with realtime scheduling priority 10 +modem[7891]: Launching phy thread with realtime scheduling priority 10 +modem[7891]: Raising main thread to realtime scheduling priority 20 +modem[7891]: GPS data stream started +modem[7891]: TUN file descriptor 6 +modem[7891]: Starting RESTful API handler at http://0.0.0.0:3010/modem-api/ +modem[7891]: Phy: PSS/SSS detected: Mode FDD, PCI 333, CFO 0.18315084 KHz, CP Extended +modem[7891]: Phy: MIB Decoded. Mode FDD, PCI 333, PRB 25, Ports 1, CFO 0.18315084 KHz, SFN 0 +modem[7891]: Decoded MIB at target sample rate, TTI is 120. Subframe synchronized. +modem[7891]: CINR 16.13 dB +modem[7891]: PDSCH: MCS 5, BLER 0.0, BER 0.0 +modem[7891]: MCCH: MCS 2, BLER 0.0, BER 0.0 +modem[7891]: MCH 0: MCS 16, BLER 0.0, BER 0.05661512027491409 +modem[7891]: MTCH 0: LCID 1, TMGI 0x00000009f165, 238.1.1.95:40085 +modem[7891]: MTCH 1: LCID 2, TMGI 0x00001009f165, 238.1.1.111:40101 +modem[7891]: ----- +```` + +#### MBMS Middleware +Now that the MBMS Modem is running and exposes the FLUTE encoded content via UDP multicast to the MBMS Middleware we can start the latter as well. The MBMS Middleware listens to the local tun interface. Received multicast packets from the Receive Process are FLUTE decoded and the files are stored in the cache. + +In this example, we start the MBMS Middleware right from the build folder. That way potential debug output is directly logged to the terminal. + +Note: Depending on the format of the Service Announcement file you need to adjust the configuration in `/etc/5gmag-rt.conf`. Detailed information can be found [here](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/MBMS-Service-Announcement-Files). + +1. Navigate to the build folder of the MBMS Middleware, for instance: `cd /home/user/rt-mbms-mw/build` +2. Start the middleware: `./mw` + +The output should look like this: + +```` +mw[6611]: 5g-mag-rt mw v0.9.0 starting up +```` + + +#### Webinterface + +For the purpose of this documentation we use the Webinterface to monitor the MBMS Modem and the MBMS Middleware. Moreover, we use the hls.js integration in the Webinterface to playback the final HLS stream. In order run the Webinterface perform the steps describe [here](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/Webinterface#run-the-webinterface). + +The Webinterface can also be started directly from its root folder: +1. cd `/home/user/rt-wui` +2. `node app.js` + +### Using an SDR card + +Todo + +## Playback +The final playback is similar for both use cases _"Using an SDR card"_ and _"Using a prerecorded sample file"_. + +### Webinterface +In order to use the webinterface for playback perform the following steps: + +1. Navigate to `http://localhost` in your browser +2. Click `Middleware v.0.9.1` on the top right corner +3. Click on the play button below the stream information +4. An instance of hls.js is initialized playing the HLS stream + +The output for step 3 and step 4 should look similar to this: + + + + + +### VLC +It is also possible to use other players like VLC. Simply paste the url to the `index.m3u8` into the VLC player. As an example the URL can look the following: `http://localhost/f/00001009f165/index.m3u8`. Replace the `localhost` part with the IP of the machine that is running the MBMS Middleware in order to access the stream from other machines in the same network. + + +## Troubleshooting + +### I/O errors in the MBMS Modem +If you encounter I/O errors in the MBMS Modem there are a few things to try: + +1. Verify that the correct network interface is used to output the UDP multicast. See https://github.com/5G-MAG/Documentation-and-Architecture/wiki/mbms-modem#multicast-routing +2. Make sure to start/stop the MBMS Modem as a service before launching it from the `build` folder: + - `systemctl start 5g-mag-rt-modem` + - `systemctl stop 5g-mag-rt-modem` +3. Try starting the MBMS Modem with sudo rights: `sudo ./modem -f "PathToSample/samplefile.raw" -b 5 + + +## References + +[1] [LTE-based 5G Terrestrial Broadcast](https://github.com/5G-MAG/Documentation-and-Architecture#lte-based-5g-terrestrial-broadcast)
+[2] [https://en.wikipedia.org/wiki/HTTP_Live_Streaming](https://en.wikipedia.org/wiki/HTTP_Live_Streaming) diff --git a/pages/lte-based-5g-broadcast/Tutorial_2.md b/pages/lte-based-5g-broadcast/Tutorial_2.md new file mode 100644 index 00000000..56d23c50 --- /dev/null +++ b/pages/lte-based-5g-broadcast/Tutorial_2.md @@ -0,0 +1,176 @@ +--- +layout: default +title: RTP Playback over 5G Broadcast +parent: Tutorials +grand_parent: MBMS and LTE-based 5G Broadcast +has_children: false +nav_order: 5 +--- + +# Tutorial - RTP Playback over 5G Broadcast + +## Introduction + +The goal of this documentation is to provide a use-case oriented information, i.e., the required steps to setup the 5G-MAG Reference Tools to use an RTP stream which was received via 5G Broadcast [1], processed by the [MBMS Modem](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/MBMS-Modem) and played in a third-party media player such as ffplay or VLC. + +## Background + +### Real-Time Transport Protocol (RTP) +The Real-Time Transport Protocol (RTP) is a network protocol for delivering audio and video data via unicast or multicast over IP-based networks. + +More information can be found in the IETF RTP specification: + +* [RTP: A Transport Protocol for Real-Time Applications](https://datatracker.ietf.org/doc/html/rfc3550) + +### Multimedia Broadcast/Multicast Service (MBMS) + +MBMS is a point-to-multipoint service in which data is transmitted from a single source entity to multiple recipients. +The MBMS bearer service offers two modes, namely broadcast mode and multicast mode. This use-case focus on the broadcast reception mode (5G Broadcast). + +More information about MBMS and the related interfaces and components can be found in the corresponding 3GPP and ETSI +specifications: + +* [23.246 - Multimedia Broadcast/Multicast Service (MBMS); Architecture and functional description(Release 16)](https://www.3gpp.org/ftp/Specs/archive/23_series/23.246/) +* [26.347 - Multimedia Broadcast/Multicast Service (MBMS); Application Programming Interface and URL (Release 16)](https://www.3gpp.org/ftp/Specs/archive/26_series/26.347/) +* [26.346 - Multimedia Broadcast/Multicast Service (MBMS); Protocols and codecs(Release 16)](https://www.3gpp.org/ftp/Specs/archive/26_series/26.346) +* [29.116 - Representational state transfer over xMB reference point between content provider and BM-SC](https://www.3gpp.org/ftp/Specs/archive/29_series/29.116) +* [ETSI TS 123 246 - Multimedia Broadcast/Multicast Service (MBMS); Architecture and functional description ](https://www.etsi.org/deliver/etsi_ts/123200_123299/123246/) + +### 5G-MAG Reference Tools + +Detailed information about the architecture of the 5G-MAG Reference Tools and how the MBMS broadcast mode is implemented can +be found on the Wiki pages of the different projects: + +* [MBMS Modem](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/MBMS-Modem) +* [Webinterface](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/Webinterface) + +## Requirements + +In order to be able to play an RTP stream which is received by 5G Broadcast, we need to install and run the following components of the 5G-MAG Reference Tools (make sure you have the suggested [hardware](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/Hardware-Requirements#hardware-requirements) and [OS](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/Hardware-Requirements#os) ready): + + +| Component | Required/Optional | Min version | Description | +| ------------- | ------------- | ------------- | ------------- | +| [MBMS Modem](https://github.com/5G-MAG/rt-mbms-modem) | Required | v1.1.1 | The MBMS Modem builds the lower part of the 5G-MAG Reference Tools. Its main task is to convert a 5G BC input signal (received either as live I/Q raw data from the SDR or as prerecorded SDR sample file) to multicast IP packets on the output. The MBMS Modem can run as a background process or can be started/stopped manually. | +| [RTP sample recording](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/Sample-Files#rtp-payload) | Optional (setup requires either a sample recording or a SDR) | / | In order to support application developers as well as 5G-MAG contributors for testing their improvements, ORS captured sample files ("raw data" = digitized I/Q data at LimeSDR Mini output) directly from a 5G BC transmitter. +| Software Defined Radio (SDR) | Optional (setup requires either a sample recoding or a SDR) | / | In case you are able to receive 5G Broadcast live signals, you need a Software Defined Radio (SDR) to convert the radio signal to a digitized I/Q data to feed the MBMS modem. A list of working SDRs can be found [here](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/Hardware-Requirements#supported-sdr) +| Video Player | Required | / | For playback of the UDP multicast that is exposed by the MBMS modem we need a player that can handle UDP multicast inputs. As part of this tutorial, we will demonstrate playback in the [VLC Media Player](https://www.videolan.org/vlc/) and [ffplay](https://ffmpeg.org/download.html) + + +## Basic workflow + +As described in [Requirements](#Requirements) we need the MBMS Modem, the MBMS Middleware and a media player in order to +enable playback of HLS content in broadcast mode using the 5G-MAG Reference Tools. The basic interaction and output of +these components are illustrated in the Figure below: + +![Architecture](https://github.com/5G-MAG/Documentation-and-Architecture/blob/main/media/architecture/5G-MAG%20RT%20Architecture%20RTP%20example.drawio.png) + +The output of the SDR or the sample file serves as the input for the MBMS Modem. The MBMS Modem converts the input data +to a UDP multicast. The UDP multicast can be played directly in ffplay or VLC. + +## Installation + +Detailed installation instructions can be found in the respective Wiki documentation of the different projects. In order +to enable RTP playback via MBMS the following steps are required: + +1. [Install the MBMS Modem](https://github.com/5G-MAG/rt-mbms-modem#readme) +2. Install at least one of the following media players: + - [Install VLC](https://www.videolan.org/vlc/#download) + - [Install ffplay](https://linuxize.com/post/how-to-install-ffmpeg-on-ubuntu-20-04/) +3. [Download an RTP sample file](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/Sample-Files#rtp-payload) or setup an RTP live stream on your transmitting infrastructure. + +## Running the components + +Once all the required components have been installed, we need to sequentially start all of them. Depending on the +concrete use case (either a live SDR input or a prerecorded sample file) the concrete calls are slightly different. + +### Using a prerecorded sample file +This Section provides information on how to run the 5G-MAG Reference Tools using a prerecorded HLS sample file. + +#### MBMS Modem +1. Follow the detailed instructions on how to configure multicast routing provided [here](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/mbms-modem#run-the-mbms-modem). +2. Stop and start the MBMS Modem as a service in order to generate or update the required configurations files. Note that this step might be required again after a reboot. + - `systemctl stop 5gmag-rt-modem` + - `systemctl start 5gmag-rt-modem` +3. Since we don't want to run the MBMS Modem as a service in the background but instead provide a prerecorded sample file, we need to make sure that the service is not running. Calling `systemctl stop 5g-mag-rt-modem` stops the service. +4. Start the MBMS Modem with a sample as specified [here](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/mbms-modem#run-a-sample-file). It is important to provide the right bandwidth to the MBMS Modem. Consequently, for a 5 MHz bandwidth sample file, the command looks like this: `sudo ./modem -f "PathToSample/5MHz_MCS16_1kHz25_RTP_3.5.raw" -b 5`. + +The final output on the terminal should now look similar to the output below: +```` +modem[10498]: Phy: PSS/SSS detected: Mode FDD, PCI 333, CFO 0.20108362 KHz, CP Extended +modem[10498]: Phy: MIB Decoded. Mode FDD, PCI 333, PRB 25, Ports 1, CFO 0.20108362 KHz, SFN 528 +modem[10498]: Decoded MIB at target sample rate, TTI is 5360. Subframe synchronized. +modem[10498]: CINR 20.82 dB +modem[10498]: PDSCH: MCS 5, BLER 0.0, BER 0.0 +modem[10498]: MCCH: MCS 2, BLER 0.0, BER 0.0 +modem[10498]: MCH 0: MCS 16, BLER 0.0, BER 0.05661512027491409 +modem[10498]: MTCH 0: LCID 1, TMGI 0x00000309f165, 238.1.1.95:40085 +modem[10498]: MTCH 1: LCID 2, TMGI 0x00001009f165, 239.11.4.10:5520 +modem[10498]: ----- +modem[10498]: CINR 18.12 dB +modem[10498]: PDSCH: MCS 5, BLER 0.0, BER 0.0 +modem[10498]: MCCH: MCS 2, BLER 0.0, BER 0.0 +modem[10498]: MCH 0: MCS 16, BLER 0.0, BER 0.04579037800687285 +modem[10498]: MTCH 0: LCID 1, TMGI 0x00000309f165, 238.1.1.95:40085 +modem[10498]: MTCH 1: LCID 2, TMGI 0x00001009f165, 239.11.4.10:5520 +modem[10498]: ----- +```` + +### Using an SDR card + +Todo + +## Playback +The final playback is similar for both use cases _"Using an SDR card"_ and _"Using a prerecorded sample file"_. + +### Playback url +To identify the correct multicast address for playback, navigate to the terminal in which the modem process is running and check the log output. Next to the `TMGI` information, the multicast addresses are listed: + +```` +modem[10498]: CINR 20.38 dB +modem[10498]: PDSCH: MCS 5, BLER 0.0, BER 0.0 +modem[10498]: MCCH: MCS 2, BLER 0.0, BER 0.0 +modem[10498]: MCH 0: MCS 16, BLER 0.0, BER 0.0468213058419244 +modem[10498]: MTCH 0: LCID 1, TMGI 0x00000309f165, **238.1.1.95:40085** +modem[10498]: MTCH 1: LCID 2, TMGI 0x00001009f165, **239.11.4.10:5520** +modem[10498]: ----- +```` +In this case, we see two addresses, `238.1.1.95:40085` and `239.11.4.10:5520`. + +### ffplay +To play the stream in ffplay run the following steps + +1. Open a new terminal +2. Start ffplay specifying the address to the multicast stream: `ffplay udp://239.11.4.10:5520` + +The output should look like this: + + + +### VLC +It is also possible to use VLC for playback: + +1. Open VLC +2. Navigate to `Media > Open Network Stream` +3. Enter the stream url `rtp://@239.11.4.10:5520` +4. Press play + +The output should look like this: + + + +## Troubleshooting + +### I/O errors in the MBMS Modem +If you encounter I/O errors in the MBMS Modem, there are a few things to try: + +1. Verify that the correct network interface is used to output the UDP multicast. See https://github.com/5G-MAG/Documentation-and-Architecture/wiki/mbms-modem#multicast-routing +2. Make sure to start/stop the MBMS Modem as a service before launching it from the `build` folder: + - `systemctl start 5g-mag-rt-modem` + - `systemctl stop 5g-mag-rt-modem` +3. Try starting the MBMS Modem with sudo rights: `sudo ./modem -f "PathToSample/samplefile.raw" -b 5 + + +## References + +[1] [LTE-based 5G Terrestrial Broadcast](https://github.com/5G-MAG/Documentation-and-Architecture#lte-based-5g-terrestrial-broadcast)
diff --git a/pages/lte-based-5g-broadcast/Tutorial_3.md b/pages/lte-based-5g-broadcast/Tutorial_3.md new file mode 100644 index 00000000..a07ec2ab --- /dev/null +++ b/pages/lte-based-5g-broadcast/Tutorial_3.md @@ -0,0 +1,214 @@ +--- +layout: default +title: Seamless switching +parent: Tutorials +grand_parent: MBMS and LTE-based 5G Broadcast +has_children: false +nav_order: 6 +--- + +# Tutorial - Seamless switching +## Introduction + +The goal of this documentation is to provide detailed information, the required steps and the resulting output by the 5G-MAG Reference Tools for seamless switching between content delivered via broadcast and via unicast. Note: By the time this documentation is written the 5G-MAG Reference Tools support a dynamic switch for content packaged in the HLS format. The support DASH content is work in progres. The final outcome is also illustrated in a short demo video that can be found [here](https://www.youtube.com/watch?v=Jbir8B-gC4c). + + +## Background + +### HTTP Live Streaming (HLS) + +HTTP Live Streaming (HLS) is an HTTP-based adaptive bitrate streaming communications protocol developed by +Apple Inc. and released in 2009 [1]. +HLS is based on master and media playlists (m3u8 files). The master playlist links to media playlists with the media +playlists describing the content. HLS is mainly used on Apple platforms due to native support. HLS typically uses the +Transport Stream (TS) media container, but also offers support for f-mp4/CMAF. + +More information can be found in the IETF HLS specification: + +* [RFC 8216 - HTTP Live Streaming](https://datatracker.ietf.org/doc/html/rfc8216) + +### Unicast Delivery +Unicast delivery typically refers to delivery of media segments and manifest files using a one-to-one connection between the client and the Content Delivery Network (CDN). In contrast to the delivery of media files via multicast and broadcast each client is requesting and receiving the files individually. Classic DASH and HLS based unicast streaming is often referred to as Over-the-Top (OTT) streaming. + +### Multimedia Broadcast/Multicast Service (MBMS) + +MBMS is a point-to-multipoint service in which data is transmitted from a single source entity to multiple recipients. +The MBMS bearer service offers two modes, namely broadcast mode and multicast mode. In the scope of the 5G-MAG Reference +Tools we focus on the broadcast mode. + +More information about MBMS and the related interfaces and components can be found in the corresponding 3GPP and ETSI +specifications: + +* [23.246 - Multimedia Broadcast/Multicast Service (MBMS); Architecture and functional description(Release 16)](https://www.3gpp.org/ftp/Specs/archive/23_series/23.246/) +* [26.347 - Multimedia Broadcast/Multicast Service (MBMS); Application Programming Interface and URL (Release 16)](https://www.3gpp.org/ftp/Specs/archive/26_series/26.347/) +* [26.346 - Multimedia Broadcast/Multicast Service (MBMS); Protocols and codecs(Release 16)](https://www.3gpp.org/ftp/Specs/archive/26_series/26.346) +* [29.116 - Representational state transfer over xMB reference point between content provider and BM-SC](https://www.3gpp.org/ftp/Specs/archive/29_series/29.116) +* [ETSI TS 123 246 - Multimedia Broadcast/Multicast Service (MBMS); Architecture and functional description ](https://www.etsi.org/deliver/etsi_ts/123200_123299/123246/) + +### 5G-MAG Reference Tools + +Detailed information about the architecture of the 5G-MAG Reference Tools can be found on the Wiki pages of the different projects: + +* [MBMS Modem](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/MBMS-Modem) +* [MBMS Middleware](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/MBMS-Middleware) +* [Webinterface](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/Webinterface) + +## Requirements + +In order to enable dynamic with the 5G-MAG Reference Tools, we need to install and run the following components of the +5G-MAG Reference Tools: + +* [MBMS Modem](https://github.com/5G-MAG/rt-mbms-modem) (**required, minimum version tbd**): The MBMS Modem builds the lower part of the 5G-MAG + Reference Tools. Its main task is to convert a 5G BC input signal (received either as live I/Q raw data from the SDR + or as prerecorded SDR sample file) to multicast IP packets on the output. The MBMS Modem can run as background process + or can be started/stopped manually. +* [MBMS Middleware](https://github.com/5G-MAG/rt-mbms-mw) (**required, minimum version tbd**): The MBMS Middleware presents the heart of the + 5G-MAG Reference Tools. Its main task is to provide the best available content to the (internal or external) + application at any time. If available, it combines content from (mobile) broadband, WiFi with the 5G broadcast content + from the MBMS Modem using an advanced decision logic. The content is presented to the applications in the form of an + intelligent edge cache ready for pickup via http(s). Internally, the MBMS Middleware uses + the [5G-MAG Reference Tools FLUTE library](https://github.com/5G-MAG/rt-libflute) to decode FLUTE encoded manifest + files and media segments. +* [RT Webinterace](https://github.com/5G-MAG/rt-wui) (optional): The 5G-MAG Reference Tools Webinterface (rt-wui) + provides an optional graphical webinterface with a control display for each 5G-MAG Reference Tools process (MBMS + Modem, MBMS Middleware). Its main purpose is to collect and display useful information from the MBMS Modem and the + MBMS Middleware. The webinterface provides basic browser-based HLS playback of the HLS manifest and segments provided + by the MBMS Middleare using [hls.js](https://github.com/video-dev/hls.js/). +* [HLS sample recording](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/Sample-Files#hls-payload) (optional): In + order to support application developers as well as 5G-MAG contributors for testing their improvements, ORS captured + sample files ("raw data" = digitized I/Q data at LimeSDR Mini output) directly from a 5G BC transmitter. + +## Basic workflow + +As described in [Requirements](#Requirements) we need the MBMS Modem, the MBMS Middleware and a media player in order to +enable playback of HLS content in unicast and broadcast mode using the 5G-MAG Reference Tools. The basic interaction and output of +these components is illustrated in the Figure below: + +![Architecture](https://github.com/5G-MAG/Documentation-and-Architecture/blob/main/media/architecture/5G-MAG%20RT%20Architecture%20Seamless%20Switching%20v8.drawio.png) + +The output of the SDR or the sample file serves as the input for the MBMS Modem. The MBMS Modem converts the input data +to a UDP multicast. The UDP multicast serves as the input for the MBMS Middleware. The FLUTE encoded content is decoded +in the MBMS Middleware using the [5G-MAG Reference Tools FLUTE library](https://github.com/5G-MAG/rt-libflute). Once the +manifest files and media segments are FLUTE decoded they are cached in the middleware and made available to the media +player via an Nginx proxy. + +TBD: Unicast part + +The media player itself is not aware that the content is provided via broadcast. + +Note that in the illustration the media player is depicted as a separate component and not part of the web interface. + +## Installation + +Detailed installation instructions can be found in the respective Wiki documentation of the different projects. In order +to enable HLS playback via MBMS the following steps are required: + +1. [Install the MBMS Modem (minimum version tbd)](https://github.com/5G-MAG/rt-mbms-modem#readme) +2. [Install the MBMS Middleware (minimum version tbd)](https://github.com/5G-MAG/rt-mbms-mw#readme) +3. [Install the Webinterface](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/Webinterface#installation) +4. [Download an HLS sample file](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/Sample-Files) + +## Running the components + +Once all the required components have been installed, we need to sequentially start all of them. Depending on the +concrete use case (either a live SDR input or a prerecorded sample file) the concrete calls are slightly different. + +### Using a prerecorded sample file +This Section provides information on how to run the 5G-MAG Reference Tools using a prerecorded HLS sample file. + +#### MBMS Modem +1. Follow the detailed instructions on how to configure multicast routing provided [here](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/mbms-modem#run-the-mbms-modem). +2. Stop and start the MBMS Modem as a service in order to generate or update the required configurations files. Note that this step might be required again after a reboot. + - `systemctl stop 5g-mag-rt-modem` + - `systemctl start 5g-mag-rt-modem` +3. Since we don't want to run the MBMS Modem as a service in the background but instead provide a prerecorded sample file, we need to make sure that the service is not running. Calling `systemctl stop 5g-mag-rt-modem` stops the service. +4. Start the MBMS Modem with a sample as specified [here](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/mbms-modem#run-a-sample-file). It is important to provide the right bandwidth to the MBMS Modem. Consequently, for a 5 MHz bandwidth sample file, the command looks like this: `./modem -f "PathToSample/samplefile.raw" -b 5`. + +The final output on the terminal should now look like similar to the output below: +```` +modem[7891]: 5g-mag-rt modem v1.1.1 starting up +modem[7891]: Initialising SDR +modem[7891]: Launching phy thread with realtime scheduling priority 10 +modem[7891]: Launching phy thread with realtime scheduling priority 10 +modem[7891]: Launching phy thread with realtime scheduling priority 10 +modem[7891]: Launching phy thread with realtime scheduling priority 10 +modem[7891]: Launching phy thread with realtime scheduling priority 10 +modem[7891]: Raising main thread to realtime scheduling priority 20 +modem[7891]: GPS data stream started +modem[7891]: TUN file descriptor 6 +modem[7891]: Starting RESTful API handler at http://0.0.0.0:3010/modem-api/ +modem[7891]: Phy: PSS/SSS detected: Mode FDD, PCI 333, CFO 0.18315084 KHz, CP Extended +modem[7891]: Phy: MIB Decoded. Mode FDD, PCI 333, PRB 25, Ports 1, CFO 0.18315084 KHz, SFN 0 +modem[7891]: Decoded MIB at target sample rate, TTI is 120. Subframe synchronized. +modem[7891]: CINR 16.13 dB +modem[7891]: PDSCH: MCS 5, BLER 0.0, BER 0.0 +modem[7891]: MCCH: MCS 2, BLER 0.0, BER 0.0 +modem[7891]: MCH 0: MCS 16, BLER 0.0, BER 0.05661512027491409 +modem[7891]: MTCH 0: LCID 1, TMGI 0x00000009f165, 238.1.1.95:40085 +modem[7891]: MTCH 1: LCID 2, TMGI 0x00001009f165, 238.1.1.111:40101 +modem[7891]: ----- +```` + +#### MBMS Middleware +Now that the MBMS Modem is running and exposes the FLUTE encoded content via UDP multicast to the MBMS Middleware we can start the latter as well. The MBMS Middleware listens to the local tun interface. Received multicast packets from the Receive Process are FLUTE decoded and the files are stored in the cache. + +In this example, we start the MBMS Middleware right from the build folder. That way potential debug output is directly logged to the terminal. + +1. Navigate to the build folder of the MBMS Middleware, for instance: `cd /home/user/rt-mbms-mw/build` +2. Start the middleware: `./mw` + +The output should look like this: + +```` +mw[6611]: 5g-mag-rt mw v0.9.0 starting up +```` + + +#### Webinterface + +For the purpose of this documentation we use the Webinterface to monitor the MBMS Modem and the MBMS Middleware. Moreover, we use the hls.js integration in the Webinterface to playback the final HLS stream. In order run the Webinterface perform the steps describe [here](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/Webinterface#run-the-webinterface). + +The Webinterface can also be started directly from its root folder: +1. cd `/home/user/rt-wui` +2. `node app.js` + +### Using an SDR card + +Todo + +## Playback +The final playback is similar for both use cases _"Using an SDR card"_ and _"Using a prerecorded sample file"_. + +### Webinterface +In order to use the webinterface for playback perform the following steps: + +1. Navigate to `http://localhost` in your browser +2. Click `Middleware v.0.9.1` on the top right corner +3. Click on the play button below the stream information +4. An instance of hls.js is initialized playing the HLS stream + +The output for step 3 and step 4 should look similar to this: + + + + + +### VLC +It is also possible to use other players like VLC. Simply paste the url to the `index.m3u8` into the VLC player. As an example the URL can look the following: `http://localhost/f/00001009f165/index.m3u8`. Replace the `localhost` part with the IP of the machine that is running the MBMS Middleware in order to access the stream from other machines in the same network. + + +## Troubleshooting + +### I/O errors in the MBMS Modem +If you encounter I/O errors in the MBMS Modem there are a few things to try: + +1. Verify that the correct network interface is used to output the UDP multicast. See https://github.com/5G-MAG/Documentation-and-Architecture/wiki/mbms-modem#multicast-routing +2. Make sure to start/stop the MBMS Modem as a service before launching it from the `build` folder: + - `systemctl start 5g-mag-rt-modem` + - `systemctl stop 5g-mag-rt-modem` +3. Try starting the MBMS Modem with sudo rights: `sudo ./modem -f "PathToSample/samplefile.raw" -b 5 + + +## References + +[1] [https://en.wikipedia.org/wiki/HTTP_Live_Streaming](https://en.wikipedia.org/wiki/HTTP_Live_Streaming) diff --git a/pages/lte-based-5g-broadcast/docker-implementation.md b/pages/lte-based-5g-broadcast/docker-implementation.md new file mode 100644 index 00000000..6a5a2da9 --- /dev/null +++ b/pages/lte-based-5g-broadcast/docker-implementation.md @@ -0,0 +1,105 @@ +--- +layout: default +title: Docker implementation +parent: Tutorials +grand_parent: MBMS and LTE-based 5G Broadcast +has_children: false +nav_order: 3 +--- + +# Docker Implementation for rt-mbms client side + +## Introduction + +The repository contains the implementation of rt-mbms processes (5G broadcast receiver) in docker containers. The [documentation](https://github.com/5G-MAG/Documentation-and-Architecture/wiki) is followed to create the containers. Modem, mbms-mw, wui and nginx are run in individual containers which interact each other using the native docker network. + +## Pre-requisites + +### Table of content + +* [Hardware requirements](https://github.com/5G-MAG/rt-mbms-docker#hardware-requirements) +* [Supported SDR](https://github.com/5G-MAG/rt-mbms-docker#supported-sdr) +* [OS](https://github.com/5G-MAG/rt-mbms-docker#os) +* [Reference setups](https://github.com/5G-MAG/rt-mbms-docker#reference-setups) + +### Hardware requirements +It is hard to define system requirements because these depend e.g. on bandwidth (e.g., 5, 8, 10 MHz), modulation coding scheme and other parameters. Generally, a CPU with 4 cores and 8 threads, 16 GB RAM and - in case a SDR and not just sample files are used - an USB 3.0 port is necessary. Furthermore, HDMI, Wifi, LAN and sufficient SSD space (for sample files,...) is recommended. + +### Supported SDR +To use the rt-mbms processes in a live setup a SDR (software defined radio) is required. +[MBMS Modem](https://github.com/5G-MAG/Documentation-and-Architecture/wiki/MBMS-Modem) supports [SoapyAPI](https://github.com/pothosware/SoapySDR/wiki), thus any supported SDR should work with the 5G-MAG Reference Tools (please keep in mind that not every SDR hardware is sufficient for receiving an 5G Broadcast signal (e.g. bandwidth, sample rate...)). + +We recommend using a LimeSDR or USRP n210 as in the current reference. + +### OS +We recommend to use [Ubuntu 20.04 LTS (64 bit)](https://ubuntu.com/) + +### Reference setups + +#### Specs + +* Intel NUC [Intel Provo Canyon BKNUC8V7PNH](https://www.amazon.de/gp/product/B08CNLFM1N/ref=ppx_yo_dt_b_asin_title_o06_s00?ie=UTF8&psc=1) +* RAM [Crucial RAM CT16G4SFRA266 16GB DDR4 2666 MHz CL19](https://www.amazon.de/gp/product/B08C4VKYFG/ref=ppx_yo_dt_b_asin_title_o00_s01?ie=UTF8&psc=1) +* SSD [SanDisk Extreme PRO M.2 NVMe 3D SSD 500 GB interne SSD](https://www.amazon.de/gp/product/B07BSSFB4N/ref=ppx_yo_dt_b_asin_title_o00_s00?ie=UTF8&psc=1) +* Power cord [LINDY 30406 - Power cord for notebooks (Schuko) 3m](https://www.amazon.de/gp/product/B00K65JGUY/ref=ppx_yo_dt_b_asin_title_o09_s00?ie=UTF8&psc=1) + +The full specification of the Intel NUC can be found [here](https://ark.intel.com/content/www/us/en/ark/products/199110/intel-nuc-8-pro-kit-nuc8v7pnh.html). + + +Testcase +The 5G-MAG Reference Tools system was tested live, with sample files, with bandwidths 3, 5, 6, 7, 8 and 10 MHz, SCS 1.25 and 7.5 kHz with multiple services (RTP, HLS). + + +## Step by step installation of rt-mbms-process in docker: + +* Install the docker engine. +* Build the Docker Images +* Running Containers +* Execute the Containers + + +### Installing Docker + +[Dockerhub](https://docs.docker.com/engine/install/ubuntu/) hosts the docker engine repos which can be easiy installed locally to start working with docker. + +**Alternatively**, easy to use shell script can be found [here](https://github.com/5G-MAG/rt-mbms-modem/blob/development/dockerPrereq.sh)! + +### Build Images +The files for docker implementation are contained in [modem](https://github.com/5G-MAG/rt-mbms-modem/tree/development/modem), [middleware](https://github.com/5G-MAG/rt-mbms-mw/tree/development/middleware), [wui](https://github.com/5G-MAG/rt-wui/tree/development/wui) and [nginx](https://github.com/5G-MAG/rt-wui/tree/development/nginx). + +The Dockerfile helps to create a docker image, which can be used to run the containers. +The command `docker build` uses by default the Dockerfile to create the image. For custom docker files go with +`docker build -f /path/to/Dockerfile -t target_image_name /location/of/Dockerfile` +There is a build.sh script on each folder for easy access. +**PS:** Please edit the appropriate path to the sample files in the last line of [startup](https://github.com/5G-MAG/rt-mbms-modem/tree/development/modem/scripts) script for modem process before building the container. + +### Running the containers + +The modem, middleware, wui and nginx containers can be run using the run.sh script in their respective folders. + +The run.sh script contains the `docker logs` command which helps the user to have an idea on what is happening inside the containers. + +**PS:** Please build docker images and run the containers in the order of modem, mbms-mw, wui, nginx respectively, so that the IP addresses of the containers are + + Modem - 172.17.0.2 + mbms-mw - 172.17.0.3 + wui - 172.17.0.4 + nginx - 172.17.0.5 + + `sudo docker inspect container_name | grep IPAddress` gives the ip of the container. + + If you have different IPs please configure the corresponding IPs in 5gmag-rt.conf , wui and nginx config files. + +### Executing the Containers + +The docker exec commands helps you to get into the container. +`docker exec -it container_name /bin/bash` + +The list of the containers (running or exited) can be viewed using : +`docker ps -a ` . The staus column shows the staus of each container. + +A running container can be stopped using: +`docker stop container_name` + +An exited or obsolete container can be removed using : +`docker rm container_name` diff --git a/pages/lte-based-5g-broadcast/features.md b/pages/lte-based-5g-broadcast/features.md new file mode 100644 index 00000000..4fc43efa --- /dev/null +++ b/pages/lte-based-5g-broadcast/features.md @@ -0,0 +1,9 @@ +--- +layout: default +title: Features +parent: MBMS and LTE-based 5G Broadcast +has_children: false +nav_order: 1 +--- + +# List of features under implementation diff --git a/pages/lte-based-5g-broadcast/hardware-requirements.md b/pages/lte-based-5g-broadcast/hardware-requirements.md new file mode 100644 index 00000000..aba88f8c --- /dev/null +++ b/pages/lte-based-5g-broadcast/hardware-requirements.md @@ -0,0 +1,94 @@ +--- +layout: default +title: Hardware requirements +parent: Tutorials +grand_parent: MBMS and LTE-based 5G Broadcast +has_children: false +nav_order: 1 +--- + +# Hardware requirements +## Table of content +* Hardware requirements +* Supported SDR +* OS +* Reference setups + +## Hardware requirements + +It is hard to define system requirements because these depend e.g. on bandwidth (e.g., 5, 8, 10 MHz), modulation coding +scheme and other parameters. Generally, a CPU with 4 cores and 8 threads, 16 GB RAM and - in case a SDR and not just +sample files are used - an USB 3.0 port is necessary. Furthermore, HDMI, Wifi, LAN and sufficient SSD space (for sample +files,...) is recommended. + +If you want to be sure that everything is working, we recommend to use our reference system. +> **Note** We would appreciate if you let us know about your setup to list it below. Drop us a mail [reference-tools@5g-mag.com](mailto:reference-tools@5g-mag.com). + +## Supported SDR + +To use the 5G-MAG Reference Tools in a live setup a SDR (software defined radio) is required. + +5G-MAG Reference Tools *[MBMS Modem](MBMS-Modem)* supports [SoapyAPI](https://github.com/pothosware/SoapySDR/wiki), thus any +supported SDR should work with the 5G-MAG Reference Tools (please keep in mind that not every SDR hardware is sufficient for receiving an 5G +Broadcast signal (e.g. bandwidth, sample rate...)). + +We recommend using a [LimeSDR Mini](https://limemicro.com/products/boards/limesdr-mini/) +or [BladeRF 2.0 Micro XA4](https://www.nuand.com/product/bladeRF-xA4). A [HackRF One](https://greatscottgadgets.com/hackrf/one/) can also be used. +Each has to be connected via USB to the computer and to your antenna via SMA connector. + +* LimeSDR Mini can be ordered e.g. at [CrowdSupply](https://www.crowdsupply.com/lime-micro/limesdr-mini/) for around + 160 EUR +* BladeRF can be ordered e.g. at [nuand](https://www.nuand.com/product/bladeRF-xA4) for around 480 EUR. +* HackRF One are widely available. Please see [their website](https://greatscottgadgets.com/hackrf/one/) for availability, typically around 250 EUR. +* Ettus USRP N310 +* Ettus USRP B210 + +> **Note** If you are using another SDR, please let us know that we can update the list above. Drop us a mail [reference-tools@5g-mag.com](mailto:reference-tools@5g-mag.com). + +> **Note** If you only want to test with sample files, a SDR is NOT required. + +## OS + +We recommend to use [Ubuntu 20.04 LTS (64 bit)](https://ubuntu.com/), but if you build everything from source, also +other OS should work (e.g., Ubuntu 18, Debian, Raspbian...) +> **Note** We would appreciate if you let us know about your setup to list it below. Drop us a mail [reference-tools@5g-mag.com](mailto:reference-tools@5g-mag.com). + +## Reference setups + +### 5G-MAG Reference Tools system + +#### Specs + +

+ +| Component | Part | Approx. price (EUR) | +| ------------- |-------------|-------------| +| Intel NUC | Intel Provo Canyon BKNUC8V7PNH | 600 | +| RAM | Crucial RAM CT16G4SFRA266 16GB DDR4 2666 MHz CL19 | 60 | +| SSD| SanDisk Extreme PRO M.2 NVMe 3D SSD 500 GB interne SSD | 70 | +| Power cord| LINDY 30406 - Power cord for notebooks (Schuko) 3m | 10 | +| _Optional:_ | +| _ +Display_| Capacitive display 7" IPS 1024x600 | 70 | + +The full specification of the Intel NUC can be +found [here](https://ark.intel.com/content/www/us/en/ark/products/199110/intel-nuc-8-pro-kit-nuc8v7pnh.html). + +If you want to fully integrate the SDR into the NUC as seen on the picture +above: [5G-MAG Reference Tools casing](https://github.com/johannmika/obeca-ors-casing) + +#### Testcases + +The 5G-MAG Reference Tools system was tested live, with sample files, with bandwidths 3, 5, 6, 7, 8 and 10 MHz, SCS 1.25 and 7.5 kHz and +modulation coding schemes (MCS) 1-26 with multiple services (RTP, HLS). Max CPU (2 services, 10 MHz, MCS26) was below +60%. + +### VM + +#### Specs + +Ubuntu 20 with Hyper-V on Windows 10. + +#### Testcases + +We tested the build process and sample files (1 RTP service, 5 MHz). diff --git a/pages/lte-based-5g-broadcast/index.md b/pages/lte-based-5g-broadcast/index.md index d54fc6b1..151af9fe 100644 --- a/pages/lte-based-5g-broadcast/index.md +++ b/pages/lte-based-5g-broadcast/index.md @@ -1,68 +1,9 @@ --- layout: default -title: MBMS and LTE based 5G Broadcast +title: MBMS and LTE-based 5G Broadcast has_children: true +nav_order: 4 --- -# Implementing MBMS: LTE-based 5G Broadcast -Information about LTE-based 5G Broadcast can be found at www.5g-mag.com/5gbroadcast -*** -## 📑 Specifications and architecture -* Information about relevant specifications can be found at the [Standards Wiki](https://github.com/5G-MAG/Standards/wiki/MBMS-&-LTE-based-5G-Broadcast:-Relevant-Specifications) -* High-level architectures can be found [here](https://www.5g-mag.com/repositories#5gbroadcast) -* 5G Broadcast Overview Slides by Bitstem can be found [here](https://drive.google.com/file/d/1zkoNpFfhRE91OjFILs7K_t1CJzGoGQLA/view?usp=drive_link) -*** - -## 🚧 On-going projects -Check the [Projects](MBMS-&-LTE-based-5G-Broadcast-Projects) under development for MBMS & LTE-based 5G Broadcast -*** - -## ▶️ Using the tools -Check the [TUTORIALS & DEVELOPER XCHANGES](https://www.5g-mag.com/tutorials) and check the wikis below for more information -* [Quick Start Guide](https://github.com/5G-MAG/Getting-Started/wiki/Configuration-Quick-Start-Guide) -* [HLS playback over 5G Broadcast](https://github.com/5G-MAG/Getting-Started/wiki/Use-Case:-HLS-playback-over-5G-Broadcast) -* [RTP playback over 5G Broadcast](https://github.com/5G-MAG/Getting-Started/wiki/Use-Case:-RTP-Playback-over-5G-Broadcast) -* [Contanerised rt-mbms setup](https://github.com/5G-MAG/Getting-Started/wiki/5G-MAG-Reference-Tools:-Docker-Implementation-of-RT-MBMS-processes) -* [Seamless switching between unicast and 5G Broadcast](https://github.com/5G-MAG/Getting-Started/wiki/Use-Case:-Seamless-switching) -*** - -## ⭐ Related repositories -* Check the Repositories relevant to MBMS & LTE-based 5G Broadcast: Code, releases, packages, dockers, guidelines,... - -### 5G Broadcast Transmitter for MBMS-dedicated cells and basic MBMS gateway: [rt-mbms-tx](https://github.com/5G-MAG/rt-mbms-tx) -* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-mbms-tx#readme) -* [Releases](https://github.com/5G-MAG/rt-mbms-tx/releases) - -### 5G Broadcast Transmitter for QRD (Qualcomm Reference Design) and CRD (Commercial Research Device): [rt-mbms-tx-for-qrd-and-crd](https://github.com/5G-MAG/rt-mbms-tx-for-qrd-and-crd) -* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-mbms-tx-for-qrd-and-crd#readme) - -### MBMS Modem: [rt-mbms-modem](https://github.com/5G-MAG/rt-mbms-modem) -* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-mbms-modem#readme) -* [Releases](https://github.com/5G-MAG/rt-mbms-modem/releases) -* [Docker](https://github.com/5G-MAG/rt-mbms-modem/tree/development/modem) - -### MBMS Middleware: [rt-mbms-mw](https://github.com/5G-MAG/rt-mbms-mw) -* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-mbms-mw#readme) -* [Releases](https://github.com/5G-MAG/rt-mbms-mw/releases) -* [Docker](https://github.com/5G-MAG/rt-mbms-mw/tree/development/middleware) - -### Tools common to various projects: [rt-common-shared](https://github.com/5G-MAG/rt-common-shared) -* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-common-shared#readme) - -## Repositories related to Multicast IP delivery -### File Delivery over Unidirectional Transport (FLUTE): [rt-libflute](https://github.com/5G-MAG/rt-libflute) -* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-libflute#readme) -* [Releases](https://github.com/5G-MAG/rt-libflute/releases) - -## Repositories with dependencies related to LTE -* [srsRAN](https://github.com/5G-MAG/srsRAN) - -## Auxiliary repositories: -### MBMS Web User Interface: [rt-wui](https://github.com/5G-MAG/rt-wui) -* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-wui#readme) -* [Releases](https://github.com/5G-MAG/rt-wui/releases) -* [Docker](https://github.com/5G-MAG/rt-wui/tree/development/wui) - -### MBMS Examples: [rt-mbms-examples](https://github.com/5G-MAG/rt-mbms-examples) -* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-mbms-examples#readme) -* [Releases](https://github.com/5G-MAG/rt-mbms-examples/releases) +# MBMS & LTE-based 5G Broadcast + diff --git a/pages/lte-based-5g-broadcast/projects.md b/pages/lte-based-5g-broadcast/projects.md new file mode 100644 index 00000000..10c16704 --- /dev/null +++ b/pages/lte-based-5g-broadcast/projects.md @@ -0,0 +1,25 @@ +--- +layout: default +title: Projects +parent: MBMS and LTE-based 5G Broadcast +has_children: false +nav_order: 2 +--- + +# 🚧 Related projects + +## MBMS: Seamless switching between broadcast and unicast +Seamless switching between LTE-based 5G Broadcast and OTT unicast +* [Kanban board](https://github.com/orgs/5G-MAG/projects/7) + +## MBMS: MBMS Modem - Rel 17 Support +The required issues and features requests to make the MBMS Model Rel 17 compliant +* [Kanban board](https://github.com/orgs/5G-MAG/projects/24) + +## MBMS: 5G Broadcast Transmitters +Project for any improvements to the rt-mbms-tx and rt-mbms-tx-for-qrd-and-crd. +* [Kanban board](https://github.com/orgs/5G-MAG/projects/29) + +## MBMS: Web User Interface +Project for any improvements to the rt-mbms-wui +* [Kanban board](https://github.com/orgs/5G-MAG/projects/28) diff --git a/pages/lte-based-5g-broadcast/quick-start-guide.md b/pages/lte-based-5g-broadcast/quick-start-guide.md new file mode 100644 index 00000000..ccf08c0a --- /dev/null +++ b/pages/lte-based-5g-broadcast/quick-start-guide.md @@ -0,0 +1,258 @@ +--- +layout: default +title: Quick start guide +parent: Tutorials +grand_parent: MBMS and LTE-based 5G Broadcast +has_children: false +nav_order: 0 +--- + +# Quick start guide +## Setup Resources +* [Hardware, OS & SDR Requirements](hardware-requirements.md) +* [Sample Files](sample-files.md) +* [Service Announcement Formats](https://github.com/5G-MAG/rt-common-shared/wiki/MBMS-Service-Announcement-Files) + +## Preparation +After each reboot of your machine run: + +1. `sudo systemctl start 5gmag-rt-modem` +2. `sudo systemctl stop 5gmag-rt-modem` + +Make sure that you have the latest nginx config enabled in `/etc/nginx/sites-enabled/5gmag-rt-wui`. Compare it to the config that is provided here: https://github.com/5G-MAG/rt-common-shared/blob/feature/mbms/mbms/common-config/5gmag-rt-wui + +## Different SA formats +The 5G-MAG Reference Tools support three different service announcement formats. In the examples below we either use the `5gmag_legacy` format for the recordings or the `default` format for seamless switching. To use the seamless switching format that was agreed in 5G-MAG you have to use `5gmag_bc_uc`. The corresponding service announcement example file is labeled `bootstrap.multipart.seamlessswitching.hls.5gmag`. More details can be found here: https://github.com/5G-MAG/rt-common-shared/wiki/MBMS-Service-Announcement-Files + +## Playback of 5GBC together with the MBMS Modem + +Set the target configuration in `etc/5gmag-rt-conf`: + +```` + seamless_switching: { + enabled: ; + truncate_cdn_playlist_segments: 3 + } + bootstrap_format: ; + local_service: { + enabled: false + } +```` + +## Playback of legacy recordings + +Set the configuration in `etc/5gmag-rt-conf` to use the legacy format: + +```` + seamless_switching: { + enabled: false; + } + bootstrap_format: "5gmag_legacy"; + local_service: { + enabled: false; + } +```` + +If you want to play the recorded content in a loop consider increasing the cache values to avoid segments with the same url being deleted immediately: + +```` + cache: { + max_segments_per_stream: 30; + max_file_age: 1200; /* seconds */ + max_total_size: 128; /* megabyte */ + } +```` + +## FLUTE ffmpeg watchfolder with signaling server + +### HLS seamless switching +Set the config file for the rt-mbms-examples project in `flute-ffmpeg\config\default.cfg` to: + +```` +general : { + multicast_ip = "238.1.1.111"; + multicast_port = 40101; + mtu = 1500; + rate_limit = 1200000; + watchfolder_path = ""; + path_to_transmit = "" + stream_type = "hls"; + transmit_service_announcement = true; + dash: { + number_of_init_segments = 3; + resend_init_in_sec = 30; + service_announcement = "../supporting_files/mbms/bootstrap_examples/bootstrap.multipart.legacy.dash"; + }; + hls: { + service_announcement = "../supporting_files/mbms/bootstrap_examples/bootstrap.multipart.seamlessswitching.hls"; + media_playlists_to_ignore_in_multicast = [] + } + webserver_port: 3010; +} +```` + +Note: For seamless switching to work the `watchfolder_path` needs to point to a webserver that hosts the segments. + +Enable seamless switching in the `etc/5gmag-rt-conf` file: + +```` + seamless_switching: { + enabled: true; + truncate_cdn_playlist_segments: 3 + } +```` + +### DASH BC + +Disable seamless switching and set the right SA format in the `etc/5gmag-rt-conf` file: + +```` + seamless_switching: { + enabled: false; + truncate_cdn_playlist_segments: 3 + }, +bootstrap_format: "5gmag_legacy"; + +```` + +Adjust the config for flute-ffmpeg: + +```` +general : { + multicast_ip = "238.1.1.111"; + multicast_port = 40101; + mtu = 1500; + rate_limit = 1200000; + watchfolder_path = "/home/dsi/5G-MAG/simple-express-server/public/watchfolder/dash"; + path_to_transmit = "" + stream_type = "dash"; + transmit_service_announcement = true; + dash: { + number_of_init_segments = 3; + resend_init_in_sec = 30; + service_announcement = "../supporting_files/mbms/bootstrap_examples/bootstrap.multipart.legacy.dash"; + }; + hls: { + service_announcement = "../supporting_files/mbms/bootstrap_examples/bootstrap.multipart.seamlessswitching.hls"; + media_playlists_to_ignore_in_multicast = [] + } + webserver_port: 3010; +} +```` + +### HLS BC + +Disable seamless switching and set the right SA format in the `etc/5gmag-rt-conf` file: + +```` + seamless_switching: { + enabled: false; + truncate_cdn_playlist_segments: 3 + }, +bootstrap_format: "5gmag_legacy"; + +```` + +Adjust the config for flute-ffmpeg: + +```` +general : { + multicast_ip = "238.1.1.111"; + multicast_port = 40101; + mtu = 1500; + rate_limit = 1200000; + watchfolder_path = "/home/dsi/5G-MAG/simple-express-server/public/watchfolder/hls"; + path_to_transmit = "watchfolder/hls/" + stream_type = "hls"; + transmit_service_announcement = true; + dash: { + number_of_init_segments = 3; + resend_init_in_sec = 30; + service_announcement = "../supporting_files/mbms/bootstrap_examples/bootstrap.multipart.legacy.dash"; + }; + hls: { + service_announcement = "../supporting_files/mbms/bootstrap_examples/bootstrap.multipart.legacy.hls"; + media_playlists_to_ignore_in_multicast = [] + } + webserver_port: 3010; +} +```` + +## FLUTE ffmpeg with local SA + +In this example we dont need the http server that signals the `mch_info.json`. Instead, we start the MBMS Middleware directly with a local service announcement file + +### General +Enable the local service in the `etc/5gmag-rt-conf` file: +```` + local_service: { + enabled: true; + } +```` + +Disable `transmit_service_announcement` in the flute-ffmpeg `default.cfg` file: + +```` +transmit_service_announcement = false; +```` + +### HLS seamless switching + +Point to a local service announcement file with seamless switching support in the `etc/5gmag-rt-conf` file e.g.: + +```` + local_service: { + bootstrap_file: "/home/dsi/5G-MAG/rt-common-shared/mbms/bootstrap_examples/bootstrap.multipart.seamlessswitching.hls"; + } +```` + +Enable seamless switching in the `etc/5gmag-rt-conf` file: + +```` + seamless_switching: { + enabled: true; + truncate_cdn_playlist_segments: 3 + }, +bootstrap_format: ""; + +```` + +### HLS BC + +Point to a local service announcement in the `etc/5gmag-rt-conf` file e.g.: +```` + local_service: { + bootstrap_file: "/home/dsi/5G-MAG/rt-common-shared/mbms/bootstrap_examples/bootstrap.multipart.legacy.hls"; + } +```` + +Disable seamless switching and set the right SA format in the `etc/5gmag-rt-conf` file: + +```` + seamless_switching: { + enabled: false; + truncate_cdn_playlist_segments: 3 + }, +bootstrap_format: "5gmag_legacy"; + +```` + +### DASH BC + +Point to a local service announcement in the `etc/5gmag-rt-conf` file e.g.: +```` + local_service: { + bootstrap_file: "/home/dsi/5G-MAG/rt-common-shared/mbms/bootstrap_examples/bootstrap.multipart.legacy.dash"; + } +```` + +Disable seamless switching and set the right SA format in the `etc/5gmag-rt-conf` file: + +```` + seamless_switching: { + enabled: false; + truncate_cdn_playlist_segments: 3 + }, +bootstrap_format: "5gmag_legacy"; + +```` diff --git a/pages/lte-based-5g-broadcast/repositories.md b/pages/lte-based-5g-broadcast/repositories.md new file mode 100644 index 00000000..302f23b3 --- /dev/null +++ b/pages/lte-based-5g-broadcast/repositories.md @@ -0,0 +1,46 @@ +--- +layout: default +title: Repositories +parent: MBMS and LTE-based 5G Broadcast +has_children: false +nav_order: 3 +--- + +# ⭐ Related repositories +## 5G Broadcast Transmitter for MBMS-dedicated cells and basic MBMS gateway: [rt-mbms-tx](https://github.com/5G-MAG/rt-mbms-tx) +* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-mbms-tx#readme) +* [Releases](https://github.com/5G-MAG/rt-mbms-tx/releases) + +## 5G Broadcast Transmitter for QRD (Qualcomm Reference Design) and CRD (Commercial Research Device): [rt-mbms-tx-for-qrd-and-crd](https://github.com/5G-MAG/rt-mbms-tx-for-qrd-and-crd) +* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-mbms-tx-for-qrd-and-crd#readme) + +## MBMS Modem: [rt-mbms-modem](https://github.com/5G-MAG/rt-mbms-modem) +* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-mbms-modem#readme) +* [Releases](https://github.com/5G-MAG/rt-mbms-modem/releases) +* [Docker](https://github.com/5G-MAG/rt-mbms-modem/tree/development/modem) + +## MBMS Middleware: [rt-mbms-mw](https://github.com/5G-MAG/rt-mbms-mw) +* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-mbms-mw#readme) +* [Releases](https://github.com/5G-MAG/rt-mbms-mw/releases) +* [Docker](https://github.com/5G-MAG/rt-mbms-mw/tree/development/middleware) + +## Tools common to various projects: [rt-common-shared](https://github.com/5G-MAG/rt-common-shared) +* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-common-shared#readme) + +# Repositories related to Multicast IP delivery +## File Delivery over Unidirectional Transport (FLUTE): [rt-libflute](https://github.com/5G-MAG/rt-libflute) +* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-libflute#readme) +* [Releases](https://github.com/5G-MAG/rt-libflute/releases) + +# Repositories with dependencies related to LTE +* [srsRAN](https://github.com/5G-MAG/srsRAN) + +# Auxiliary repositories: +## MBMS Web User Interface: [rt-wui](https://github.com/5G-MAG/rt-wui) +* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-wui#readme) +* [Releases](https://github.com/5G-MAG/rt-wui/releases) +* [Docker](https://github.com/5G-MAG/rt-wui/tree/development/wui) + +## MBMS Examples: [rt-mbms-examples](https://github.com/5G-MAG/rt-mbms-examples) +* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-mbms-examples#readme) +* [Releases](https://github.com/5G-MAG/rt-mbms-examples/releases) diff --git a/pages/lte-based-5g-broadcast/sample-files.md b/pages/lte-based-5g-broadcast/sample-files.md new file mode 100644 index 00000000..b147bc71 --- /dev/null +++ b/pages/lte-based-5g-broadcast/sample-files.md @@ -0,0 +1,59 @@ +--- +layout: default +title: Sample files +parent: Tutorials +grand_parent: MBMS and LTE-based 5G Broadcast +has_children: false +nav_order: 2 +--- + +# Sample files +In order to support application developers as well as 5G-MAG contributors for testing their improvements, ORS captured sample files ("raw data" = digitized I/Q data at [LimeSDR Mini](https://www.crowdsupply.com/lime-micro/limesdr-mini/) output) directly from a 5G BC transmitter. You can also capture sample files using the [capture command of the Receive Process](https://github.com/5G-MAG/rt-mbms-modem#capture-and-running-of-sample-files). + +#### RTP payload: +3 MHz bandwidth, subcarrier spacing 1.25 kHz, Modulation Coding Scheme 16 (16QAM) with Payload 3.5 Mbit RTP: +* [3MHz_MCS16_1kHz25_RTP_3.5.raw](https://obeca-testdaten.s3.eu-central-1.amazonaws.com/3MHz_MCS16_1kHz25_RTP_3.5.raw) (7.9 GB) + +5 MHz bandwidth, subcarrier spacing 1.25 kHz or 7.5 kHz, Modulation Coding Scheme 16 (16QAM) with Payload 3.5 Mbit RTP: +* [5MHz_MCS16_1kHz25_RTP_3.5.raw](https://obeca-testdaten.s3.eu-central-1.amazonaws.com/5MHz_MCS16_1kHz25_RTP_3.5.raw) (14.5 GB) +* [5MHz_MCS16_7kHz5_RTP_3.5.raw](https://obeca-testdaten.s3.eu-central-1.amazonaws.com/5MHz_MCS16_7kHz5_RTP_3.5.raw) (11.4 GB) + +6 MHz bandwidth, subcarrier spacing 1.25 kHz, Modulation Coding Scheme 16 (16QAM) with Payload 3.5 Mbit RTP: +* [6MHz_MCS16_1kHz25_RTP_3.5.raw](https://obeca-testdaten.s3.eu-central-1.amazonaws.com/6MHz_MCS16_1kHz25_RTP_3.5.raw) (33.7 GB) + +7 MHz bandwidth, subcarrier spacing 1.25 kHz, Modulation Coding Scheme 16 (16QAM) with Payload 3.5 Mbit RTP: +* [7MHz_MCS16_1kHz25_RTP_3.5.raw](https://obeca-testdaten.s3.eu-central-1.amazonaws.com/7MHz_MCS16_1kHz25_RTP_3.5.raw) (23.6 GB) + +8 MHz bandwidth, subcarrier spacing 1.25 kHz, Modulation Coding Scheme 16 (16QAM) with Payload 3.5 Mbit RTP: +* [8MHz_MCS16_1kHz25_RTP_3.5.raw](https://obeca-testdaten.s3.eu-central-1.amazonaws.com/8MHz_MCS16_1kHz25_RTP_3.5.raw) (23.5 GB) + +10 MHz bandwidth, subcarrier spacing 1.25 kHz, Modulation Coding Scheme 16 (16QAM) with Payload 3.5 Mbit RTP: +* [10MHz_MCS16_1kHz25_RTP_3.5.raw](https://obeca-testdaten.s3.eu-central-1.amazonaws.com/10MHz_MCS16_1kHz25_RTP_3.5.raw) (21.6 GB) + +#### HLS payload: + +3 MHz bandwidth, subcarrier spacing 1.25 kHz, Modulation Coding Scheme 16 (16QAM) with Payload HLS: +* [3MHz_MCS16_1kHz25_HLS_q6a.raw](https://obeca-testdaten.s3.eu-central-1.amazonaws.com/3MHz_MCS16_1kHz25_HLS_q6a.raw) (5.9 GB) + +5 MHz bandwidth, subcarrier spacing 1.25 kHz, Modulation Coding Scheme 16 (16QAM) with Payload HLS: +* [5MHz_MCS16_1kHz25_HLS_q6a.raw](https://obeca-testdaten.s3.eu-central-1.amazonaws.com/5MHz_MCS16_1kHz25_HLS_q6a.raw) (12.2 GB) + +8 MHz bandwidth, subcarrier spacing 1.25 kHz, Modulation Coding Scheme 16 (16QAM) with Payload HLS: +* [8MHz_MCS16_1kHz25_HLS_q6a.raw](https://obeca-testdaten.s3.eu-central-1.amazonaws.com/8MHz_MCS16_1kHz25_HLS_q6a.raw) (25.4 GB) + +10 MHz bandwidth, subcarrier spacing 1.25 kHz, Modulation Coding Scheme 16 (16QAM) with Payload HLS: +* [10MHz_MCS16_1kHz25_HLS_q6a.raw](https://obeca-testdaten.s3.eu-central-1.amazonaws.com/10MHz_MCS16_1kHz25_HLS_q6a.raw) (17.6 GB) + +#### DASH payload: +5 MHz bandwidth, subcarrier spacing 1.25 kHz, Modulation Coding Scheme 16 (16QAM) with Payload DASH: +* [5MHz_MCS16_1kHz25_DASH_q6a.raw](https://obeca-testdaten.s3.eu-central-1.amazonaws.com/5MHz_MCS16_1kHz25_DASH_q6a.raw) (10.4 GB) + +#### Sample files for rt-mbms-modem development Rel14/Rel16 only: +* Rel.14 CAS [5MHz_MCS16_1kHz25_HLS_q4a_Rel14.raw](https://obeca-testdaten.s3.eu-central-1.amazonaws.com/5MHz_MCS16_1kHz25_HLS_q4a_Rel14.raw) (5.4 GB) +* Rel.16 CAS [5MHz_MCS16_1kHz25_HLS_q4a_Rel16.raw](https://obeca-testdaten.s3.eu-central-1.amazonaws.com/5MHz_MCS16_1kHz25_HLS_q4a_Rel16.raw) (5.1 GB) (PBCH Repetition, Aggregation Level 16, CFI-Indicator in MIB-MBMS) + * **Note**: Release 16 is currently not supported in the rt-mbms-modem. This stream can be used for development purposes. +* Rel.16 CAS [8MHz_MCS16_1kHz25_Rel16.raw](https://obeca-testdaten.s3.eu-central-1.amazonaws.com/8MHz_MCS16_1kHz25_Rel16.raw) (13.4 GB) (PBCH Repetition, Aggregation Level 16, CFI-Indicator in MIB-MBMS) + * **Note**: Release 16 is currently not supported in the rt-mbms-modem. This stream can be used for development purposes. +> Note: The sample files were captured in Nov 2021. An mp4 file of the movie [Big Buck Bunny](https://www.bigbuckbunny.org) (published under the [Creative Commons Attribution 3.0 license](https://creativecommons.org/licenses/by/3.0/), (c) copyright 2008, Blender Foundation / [www.bigbuckbunny.org](https://www.bigbuckbunny.org)) was looped to create RTP and HLS streams. Play duration of each sample file is 3-5 minutes. + +If you need any further sample files, please get in contact with us **[reference-tools@5g-mag.com](mailto:reference-tools@5g-mag.com)**. diff --git a/pages/lte-based-5g-broadcast/specifications.md b/pages/lte-based-5g-broadcast/specifications.md new file mode 100644 index 00000000..b4ea0397 --- /dev/null +++ b/pages/lte-based-5g-broadcast/specifications.md @@ -0,0 +1,10 @@ +--- +layout: default +title: Specifications +parent: MBMS and LTE-based 5G Broadcast +has_children: false +nav_order: 0 +--- +# 📑 Specifications and relevant references +* Information about relevant specifications can be found at the [Standards Wiki](https://github.com/5G-MAG/Standards/wiki/MBMS-&-LTE-based-5G-Broadcast:-Relevant-Specifications) +* A list of relevant 3GPP Work Items can be found at [Standards Wiki](https://github.com/5G-MAG/Standards/wiki/MBMS-&-LTE-based-5G-Broadcast:-Relevant-Work-Items) diff --git a/pages/lte-based-5g-broadcast/tutorials.md b/pages/lte-based-5g-broadcast/tutorials.md new file mode 100644 index 00000000..9e8aa70a --- /dev/null +++ b/pages/lte-based-5g-broadcast/tutorials.md @@ -0,0 +1,11 @@ +--- +layout: default +title: Tutorials +parent: MBMS and LTE-based 5G Broadcast +has_children: true +nav_order: 4 +--- + +# ▶️ Using the tools +Check the [TUTORIALS & DEVELOPER XCHANGES](https://www.5g-mag.com/tutorials) in the 5G-MAG website and the information below. +* We are working on it... diff --git a/pages/multimedia-content-delivery/features.md b/pages/multimedia-content-delivery/features.md new file mode 100644 index 00000000..0eeeb71c --- /dev/null +++ b/pages/multimedia-content-delivery/features.md @@ -0,0 +1,9 @@ +--- +layout: default +title: Features +parent: Multimedia Content Delivery +has_children: false +nav_order: 1 +--- + +# List of features under implementation diff --git a/pages/multimedia-content-delivery/index.md b/pages/multimedia-content-delivery/index.md index 890c13d1..053dcda4 100644 --- a/pages/multimedia-content-delivery/index.md +++ b/pages/multimedia-content-delivery/index.md @@ -2,32 +2,8 @@ layout: default title: Multimedia Content Delivery has_children: true +nav_order: 3 --- -# Implementing multimedia content delivery protocols -These are a series of implementations that may be used in combination with other systems. -*** -## 📑 Specifications and architecture -* Information about relevant specifications can be found at the [Standards Wiki](https://github.com/5G-MAG/Standards/wiki/Multimedia-content-delivery:-Relevant-Specifications) -* High-level architectures can be found [here](https://www.5g-mag.com/repositories#multimedia-protocols) -*** - -## 🚧 On-going projects -Check the [Projects](https://github.com/5G-MAG/Getting-Started/wiki/Multimedia-content-delivery-Projects) under development for multimedia content delivery protocols. -*** - -## ▶️ Using the tools -Check the [TUTORIALS & DEVELOPER XCHANGES](https://www.5g-mag.com/tutorials) and check the wikis below for more information -* Developers are working on it... stay tuned for news. -*** - -## ⭐ Related repositories -* Check the Repositories relevant to multimedia content delivery protocols: Code, releases, packages, dockers, guidelines,... - -## Repositories related to Multicast IP delivery -### File Delivery over Unidirectional Transport (FLUTE): [rt-libflute](https://github.com/5G-MAG/rt-libflute) -* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-libflute#readme) -* [Releases](https://github.com/5G-MAG/rt-libflute/releases) - -### Real-time Object delivery over Unidirectional Transport (ROUTE), integrated within MBMS Middleware: [rt-mbms-mw / route-gpac](https://github.com/5G-MAG/rt-mbms-mw/tree/route-gpac) -* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-mbms-mw/tree/route-gpac#readme) +# Multimedia content delivery protocols + diff --git a/pages/multimedia-content-delivery/projects.md b/pages/multimedia-content-delivery/projects.md new file mode 100644 index 00000000..ac268681 --- /dev/null +++ b/pages/multimedia-content-delivery/projects.md @@ -0,0 +1,16 @@ +--- +layout: default +title: Projects +parent: Multimedia Content Delivery +has_children: false +nav_order: 2 +--- + +# 🚧 Related projects +## MBMS: Support for ROUTE +All issues and functionality around ROUTE support for the 5G Broadcast components +* [Kanban board](https://github.com/orgs/5G-MAG/projects/15) + +## MBMS: Support for FLUTE +All issues and functionality around FLUTE support for the 5G Broadcast components. Includes functionality like Forward Error Correction (FEC). +* [Kanban board](https://github.com/orgs/5G-MAG/projects/14) diff --git a/pages/multimedia-content-delivery/repositories.md b/pages/multimedia-content-delivery/repositories.md new file mode 100644 index 00000000..9779d980 --- /dev/null +++ b/pages/multimedia-content-delivery/repositories.md @@ -0,0 +1,18 @@ +--- +layout: default +title: Repositories +parent: Multimedia Content Delivery +has_children: false +nav_order: 3 +--- + +# ⭐ Related repositories + +## Repositories related to Multicast IP delivery + +### File Delivery over Unidirectional Transport (FLUTE): [rt-libflute](https://github.com/5G-MAG/rt-libflute) +* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-libflute#readme) +* [Releases](https://github.com/5G-MAG/rt-libflute/releases) + +### Real-time Object delivery over Unidirectional Transport (ROUTE), integrated within MBMS Middleware: [rt-mbms-mw / route-gpac](https://github.com/5G-MAG/rt-mbms-mw/tree/route-gpac) +* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-mbms-mw/tree/route-gpac#readme) diff --git a/pages/multimedia-content-delivery/specifications.md b/pages/multimedia-content-delivery/specifications.md new file mode 100644 index 00000000..e6174d87 --- /dev/null +++ b/pages/multimedia-content-delivery/specifications.md @@ -0,0 +1,9 @@ +--- +layout: default +title: Specifications +parent: Multimedia Content Delivery +has_children: false +nav_order: 0 +--- +# 📑 Specifications and relevant references +* Information about relevant specifications can be found at the [Standards Wiki](https://github.com/5G-MAG/Standards/wiki/Multimedia-content-delivery:-Relevant-Specifications) diff --git a/pages/multimedia-content-delivery/tutorials.md b/pages/multimedia-content-delivery/tutorials.md new file mode 100644 index 00000000..1b60e5d1 --- /dev/null +++ b/pages/multimedia-content-delivery/tutorials.md @@ -0,0 +1,11 @@ +--- +layout: default +title: Tutorials +parent: Multimedia Content Delivery +has_children: true +nav_order: 4 +--- + +# ▶️ Using the tools +Check the [TUTORIALS & DEVELOPER XCHANGES](https://www.5g-mag.com/tutorials) in the 5G-MAG website and the information below. +* We are working on it... diff --git a/pages/xr-media-integration-in-5g/features.md b/pages/xr-media-integration-in-5g/features.md new file mode 100644 index 00000000..b8cedb9f --- /dev/null +++ b/pages/xr-media-integration-in-5g/features.md @@ -0,0 +1,9 @@ +--- +layout: default +title: Features +parent: XR Media Integration in 5G +has_children: false +nav_order: 1 +--- + +# List of features under implementation diff --git a/pages/xr-media-integration-in-5g/index.md b/pages/xr-media-integration-in-5g/index.md index 320d7901..aaf705f3 100644 --- a/pages/xr-media-integration-in-5g/index.md +++ b/pages/xr-media-integration-in-5g/index.md @@ -2,44 +2,8 @@ layout: default title: XR Media Integration in 5G has_children: true +nav_order: 7 --- -# Implementing XR Media integration in 5G -Information about 3XR Media integration in 5G can be found at www.5g-mag.com/immersive -*** -## 📑 Specifications and architecture -* High-level architectures can be found [here](https://www.5g-mag.com/repositories#xr-media-5g) -*** - -## 🚧 On-going projects -Check the [Projects](https://github.com/5G-MAG/Getting-Started/wiki/XR-Media-integration-in-5G-Projects) under development for XR and Immersive Media -*** - -## ▶️ Using the tools -Check the [TUTORIALS & DEVELOPER XCHANGES](https://www.5g-mag.com/tutorials) and check the wikis below for more information -*Developers are working on it... stay tuned for news. -*** - -## ⭐ Related repositories -* Check the Repositories relevant to XR Media integration in 5G: Code, releases, packages, dockers, guidelines,... - Note that these repositories are currently private and under testing. Early access can be requested at: https://www.5g-mag.com/early-access - -### XR Unity Player: [rt-xr-unity-player](https://github.com/5G-MAG/rt-xr-unity-player) -* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-xr-unity-player#readme) -* [Releases](https://github.com/5G-MAG/rt-xr-unity-player/releases) - -### XR Blender Exporter: [rt-xr-blender-exporter](https://github.com/5G-MAG/rt-xr-blender-exporter) -* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-xr-blender-exporter#readme) -* [Releases](https://github.com/5G-MAG/rt-xr-blender-exporter/releases) - -### Efficient glTF 3D import / export package for Unity: [rt-xr-gITFast](https://github.com/5G-MAG/rt-xr-gITFast) -* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-xr-gITFast#readme) -* [Releases](https://github.com/5G-MAG/rt-xr-gITFast/releases) - -### XR MAF Plugin: [rt-xr-maf-plugin](https://github.com/5G-MAG/rt-xr-maf-plugin) -* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-xr-maf-plugin#readme) -* [Releases](https://github.com/5G-MAG/rt-xr-maf-plugin/releases) - -### XR MAF Native: [rt-xr-maf-native](https://github.com/5G-MAG/rt-xr-maf-native) -* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-xr-maf-native#readme) -* [Releases](https://github.com/5G-MAG/rt-xr-maf-native/releases) +# XR Media integration in 5G + diff --git a/pages/xr-media-integration-in-5g/projects.md b/pages/xr-media-integration-in-5g/projects.md new file mode 100644 index 00000000..a20929ea --- /dev/null +++ b/pages/xr-media-integration-in-5g/projects.md @@ -0,0 +1,12 @@ +--- +layout: default +title: Projects +parent: XR Media Integration in 5G +has_children: false +nav_order: 2 +--- + +# 🚧 Related projects +## XR: Repositories with ISO/IEC 23090-14:2023 functionalities - Release 1.0.0 +All issues related to the release of version 1.0.0 of the XR repositories dealing with functionalities defined in ISO/IEC 23090-14 +* [Kanban board](https://github.com/orgs/5G-MAG/projects/22) diff --git a/pages/xr-media-integration-in-5g/repositories.md b/pages/xr-media-integration-in-5g/repositories.md new file mode 100644 index 00000000..e56e958c --- /dev/null +++ b/pages/xr-media-integration-in-5g/repositories.md @@ -0,0 +1,30 @@ +--- +layout: default +title: Repositories +parent: XR Media Integration in 5G +has_children: false +nav_order: 3 +--- + +# ⭐ Related repositories +Note that these repositories are currently private and under testing. Early access can be requested at: https://www.5g-mag.com/early-access + +## XR Unity Player: [rt-xr-unity-player](https://github.com/5G-MAG/rt-xr-unity-player) +* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-xr-unity-player#readme) +* [Releases](https://github.com/5G-MAG/rt-xr-unity-player/releases) + +## XR Blender Exporter: [rt-xr-blender-exporter](https://github.com/5G-MAG/rt-xr-blender-exporter) +* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-xr-blender-exporter#readme) +* [Releases](https://github.com/5G-MAG/rt-xr-blender-exporter/releases) + +## Efficient glTF 3D import / export package for Unity: [rt-xr-gITFast](https://github.com/5G-MAG/rt-xr-gITFast) +* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-xr-gITFast#readme) +* [Releases](https://github.com/5G-MAG/rt-xr-gITFast/releases) + +## XR MAF Plugin: [rt-xr-maf-plugin](https://github.com/5G-MAG/rt-xr-maf-plugin) +* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-xr-maf-plugin#readme) +* [Releases](https://github.com/5G-MAG/rt-xr-maf-plugin/releases) + +## XR MAF Native: [rt-xr-maf-native](https://github.com/5G-MAG/rt-xr-maf-native) +* [Information and how to download, build, install and run](https://github.com/5G-MAG/rt-xr-maf-native#readme) +* [Releases](https://github.com/5G-MAG/rt-xr-maf-native/releases) diff --git a/pages/xr-media-integration-in-5g/specifications.md b/pages/xr-media-integration-in-5g/specifications.md new file mode 100644 index 00000000..b8a5631c --- /dev/null +++ b/pages/xr-media-integration-in-5g/specifications.md @@ -0,0 +1,8 @@ +--- +layout: default +title: Specifications +parent: XR Media Integration in 5G +has_children: false +nav_order: 0 +--- +# 📑 Specifications and relevant references diff --git a/pages/xr-media-integration-in-5g/tutorials.md b/pages/xr-media-integration-in-5g/tutorials.md new file mode 100644 index 00000000..fbc7473f --- /dev/null +++ b/pages/xr-media-integration-in-5g/tutorials.md @@ -0,0 +1,11 @@ +--- +layout: default +title: Tutorials +parent: XR Media Integration in 5G +has_children: true +nav_order: 4 +--- + +# ▶️ Using the tools +Check the [TUTORIALS & DEVELOPER XCHANGES](https://www.5g-mag.com/tutorials) in the 5G-MAG website and the information below. +* We are working on it...