Documentation: 5GMS - Generation of M8 Information

[dsilhavy]

Description

For playback of 5GMS content on the client-side, information provided via the M8 interface is required. Our current implementation relies on an m8.json file with the following structure:

{
  "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"
        }
      ]
    }
  ]
}

Problem Description

Currently, only the msaf-configuration tool is capable of creating the m8.json file automatically. If the configuration of the AF is done via Postman, curl or any other REST client, the M8 information needs to be created manually and placed on a webserver for the 5GMS Aware Application to download.

Feature Request

Document how to create an m8.json file based on the configuration of the AF. Moreover, we should discuss if we can provide an endpoint to create the m8.json automatically similar to what the msaf-configuration tool is doing today.

[dsilhavy]

@jordijoangimenez @rjb1000 @davidjwbbc : Only added you as observers here in case you have a comment especially on:

Moreover, we should discuss if we can provide an endpoint to create the m8.json automatically similar to what the msaf-configuration tool is doing today

[jordijoangimenez]

There are a few things to clarify going into the direction of automating the setup or at least providing some clear steps what to do.

• When launching the AF with open5gs-msafd we need an msaf.yaml - check if there's anything to configure here that could be part of the Application-Provider?
• We need to create the af-sync and streams.json that will be used by msaf-configuration to publish m8.json
• We need to point to m8.json in the 5GMS-Aware Application

Another thing to check is that the m8.json should be created with all the information and parameters needed for the consumptions reports, QoE metrics, services, etc.

[rjb1000]

In an ideal world, we would ditch the m8.json file altogether in favour of a DVB-I Service List that is automatically generated by a simple service management system that also provisions the 5GMSd AF.

On the client side, this would drive the user experience of a DVB-I Client that would then initiate downlink media streaming sessions by means of a 5GMS Service URL embedded in the DVB-I Service List metadata.