Add support for consumption reporting fields clientEndpointAddress and serverEndpointAddress as defined in TS 26512 17.7.0 (#24)

Author: dsilhavy

app/src/main/java/com/fivegmag/a5gmscommonlibrary/consumptionReporting/ConsumptionReport.kt

@@ -30,7 +30,8 @@ data class ConsumptionReport(
 @JsonFilter("consumptionReportingUnitFilter")
 data class ConsumptionReportingUnit(
     val mediaConsumed: String,
-    var mediaEndpointAddress: EndpointAddress? = null,
+    var clientEndpointAddress: EndpointAddress? = null,
+    var serverEndpointAddress: EndpointAddress? = null,
     val startTime: String,
     var duration: Int,
     var locations: ArrayList<TypedLocation>? = ArrayList(),

app/src/main/java/com/fivegmag/a5gmscommonlibrary/eventbus/MediaStreamHandlerMessageEvents.kt

@@ -1,19 +1,26 @@
 package com.fivegmag.a5gmscommonlibrary.eventbus
 
 import android.telephony.CellInfo
-import androidx.media3.exoplayer.analytics.AnalyticsListener
+import androidx.media3.exoplayer.analytics.AnalyticsListener.EventTime
+import androidx.media3.exoplayer.source.LoadEventInfo
 import androidx.media3.exoplayer.source.MediaLoadData
 
 class DownstreamFormatChangedEvent(
-    val eventTime: AnalyticsListener.EventTime,
+    val eventTime: EventTime,
     val mediaLoadData: MediaLoadData
 )
 
 class PlaybackStateChangedEvent(
-    val eventTime: AnalyticsListener.EventTime,
+    val eventTime: EventTime,
     val playbackState: String
 )
 
+class LoadStartedEvent(
+    val eventTime: EventTime,
+    val loadEventInfo: LoadEventInfo,
+    val mediaLoadData: MediaLoadData
+)
+
 class CellInfoUpdatedEvent(
     val cellInfoList: MutableList<CellInfo>
 )

app/src/main/java/com/fivegmag/a5gmscommonlibrary/helpers/Utils.kt

@@ -1,12 +1,17 @@
 package com.fivegmag.a5gmscommonlibrary.helpers
 
+import com.fivegmag.a5gmscommonlibrary.models.EndpointAddress
 import java.text.SimpleDateFormat
 import java.time.Duration
 import java.util.Date
 import java.util.Random
 import java.util.TimeZone
 import okhttp3.Headers
+import java.net.Inet6Address
+import java.net.InetAddress
 import java.net.NetworkInterface
+import java.net.URI
+import java.net.URL
 import java.time.Instant
 import java.util.Locale
 import java.util.UUID
@@ -110,9 +115,9 @@ class Utils {
             while (addresses.hasMoreElements()) {
                 val address = addresses.nextElement()
                 if (!address.isLoopbackAddress && address.isSiteLocalAddress) {
-                    if ((ipVer == 4 && address.hostAddress.contains("."))||
+                    if ((ipVer == 4 && address.hostAddress.contains(".")) ||
                         (ipVer == 6 && address.hostAddress.contains(":"))
-                    ){
+                    ) {
                         return address.hostAddress.toString()
                     }
                 }
@@ -122,4 +127,66 @@ class Utils {
         return null
     }
 
+    fun getDomainName(url: String): String? {
+        return try {
+            val uri = URI(url)
+            val domain = uri.host
+            domain?.removePrefix("www.")
+        } catch (e: Exception) {
+            null
+        }
+    }
+
+    fun getPort(url: String): Int? {
+        try {
+            val url = URL(url)
+            val port = url.port
+            if (port == -1) {
+                return url.defaultPort
+            }
+
+            return port
+        } catch (e: Exception) {
+            return null
+        }
+    }
+
+    /**
+     * Network operations are not allowed on the main thread.
+     * Perform the IP lookup in a different thread and then call a callback function
+     *
+     * @param requestUrl
+     * @param callback
+     */
+    fun getEndpointAddressByRequestUrl(
+        requestUrl: String,
+        callback: (EndpointAddress?) -> Unit
+    ) {
+        Thread {
+            try {
+                val domainName = getDomainName(requestUrl)
+                val port = getPort(requestUrl)
+                var ipv4Addr: String? = null
+                var ipv6Addr: String? = null
+                val inetAddresses = InetAddress.getAllByName(domainName)
+                for (inetAddress in inetAddresses) {
+                    val ipAddress = inetAddress.hostAddress
+                    if (inetAddress is Inet6Address) {
+                        ipv6Addr = ipAddress
+                    } else {
+                        ipv4Addr = ipAddress
+                    }
+                }
+                if (port != null) {
+                    callback(EndpointAddress(domainName, ipv4Addr, ipv6Addr, port))
+                }
+
+                callback(null)
+
+            } catch (e: Exception) {
+                callback(null)
+            }
+        }.start()
+    }
+
 }

app/src/main/java/com/fivegmag/a5gmscommonlibrary/models/SharedDataTypes.kt

@@ -23,7 +23,7 @@ data class EndpointAddress(
     val domainName: String? = null,
     val ipv4Addr: String? = null,
     val ipv6Addr: String? = null,
-    val portNumber: UInt
+    val portNumber: Int
 ) : Parcelable
 
 @Parcelize

app/src/test/java/com/fivegmag/a5gmscommonlibrary/UtilsUnitTest.kt

@@ -0,0 +1,54 @@
+package com.fivegmag.a5gmscommonlibrary
+
+import com.fivegmag.a5gmscommonlibrary.helpers.Utils
+import com.fivegmag.a5gmscommonlibrary.models.EndpointAddress
+import kotlinx.coroutines.CompletableDeferred
+import kotlinx.coroutines.runBlocking
+import org.junit.Test
+import org.junit.Assert.*
+
+class UtilsUnitTest {
+
+    @Test
+    fun getHttpsPort() {
+        val url = "https://dash.akamaized.net/akamai/bbb_30fps/bbb_30fps.mpd"
+        val utils = Utils()
+        val port = utils.getPort(url)
+
+        assertEquals(443, port)
+    }
+
+    @Test
+    fun getHttpPort() {
+        val url = "http://dash.akamaized.net/akamai/bbb_30fps/bbb_30fps.mpd"
+        val utils = Utils()
+        val port = utils.getPort(url)
+
+        assertEquals(80, port)
+    }
+
+    @Test
+    fun getDomainName() {
+        val url = "http://dash.akamaized.net/akamai/bbb_30fps/bbb_30fps.mpd"
+        val utils = Utils()
+        val domainName = utils.getDomainName(url)
+
+        assertEquals("dash.akamaized.net", domainName)
+    }
+
+    @Test
+    fun getEndpointAddressByRequestUrl() = runBlocking {
+        val url = "https://livesim.dashif.org/livesim2/testpic_2s/V300/852746919.m4s"
+        val utils = Utils()
+        val deferredEndpointAddress = CompletableDeferred<EndpointAddress?>()
+        utils.getEndpointAddressByRequestUrl(url) {endpointAddress ->
+            deferredEndpointAddress.complete(endpointAddress)
+        }
+        val endpointAddress = deferredEndpointAddress.await()
+        if (endpointAddress != null) {
+            assertEquals("livesim.dashif.org", endpointAddress.domainName)
+            assertEquals(443, endpointAddress.portNumber)
+            assertNotNull(endpointAddress.ipv4Addr)
+        }
+    }
+}