Intel® ST 2110 Media Streaming Library v0.7.0 release

Signed-off-by: Frank Du <[email protected]>

Author: frankdjx

.clang-format

@@ -0,0 +1,5 @@
+# SPDX-License-Identifier: GPL-2.0
+---
+BasedOnStyle:  Google
+DerivePointerAlignment: false
+ColumnLimit: 90

.gitignore

@@ -0,0 +1,63 @@
+# Prerequisites
+*.d
+
+# Object files
+*.o
+*.ko
+*.obj
+*.elf
+
+# Linker output
+*.ilk
+*.map
+*.exp
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Libraries
+*.lib
+*.a
+*.la
+*.lo
+
+# Shared objects (inc. Windows DLLs)
+*.dll
+*.so
+*.so.*
+*.dylib
+
+# Executables
+*.exe
+*.out
+*.app
+*.i*86
+*.x86_64
+*.hex
+
+# Debug files
+*.dSYM/
+*.su
+*.idb
+*.pdb
+
+# Kernel Module Compile Results
+*.mod*
+*.cmd
+.tmp_versions/
+modules.order
+Module.symvers
+Mkfile.old
+dkms.conf
+
+# Ours
+.*
+*.log
+*.patch
+*.diff
+html/
+test.*
+build/
+core*
+assets/

README.md

@@ -0,0 +1,22 @@
+# dpdk.st.kahawai
+
+## 1. Overview:
+The Intel Media Streaming Library is a solution based on DPDK prepared for transmitting and receiving high quality video with low latency. It is compliant to the SMPTE ST 2110 Professional Media Over Managed IP Networks suite of standards.
+
+#### 1.1 Features:
+* ST2110-20, ST2110-30, ST2110-40, ST2110-22
+* 1080p, 720p, 4k
+* FPS59.94, FPS50, FPS29
+* YUV 4:2:2 10bit
+
+## 2. Build:
+Please refer to [build guide](doc/build.md) for how to build DPDK, ST Kahawai library and the sample app.
+
+## 3. Run:
+Please refer to [run guide](doc/run.md) for how to setup and run the sample app.
+
+## 4. Coding style:
+Run below command before opening a PR.
+```bash
+./format-coding.sh
+```

app/meson.build

@@ -0,0 +1,98 @@
+# Copyright (C) 2021 Intel Corporation.
+#
+# This software and the related documents are Intel copyrighted materials,
+# and your use of them is governed by the express license under which they
+# were provided to you ("License").
+# Unless the License provides otherwise, you may not use, modify, copy,
+# publish, distribute, disclose or transmit this software or the related
+# documents without Intel's prior written permission.
+#
+# This software and the related documents are provided as is, with no
+# express or implied warranties, other than those that are expressly stated
+# in the License.
+
+project('Intel(R) ST DPDK sample app', 'c', default_options: ['c_std=gnu11', 'buildtype=release'], version: '0.1',)
+exec_env = host_machine.system()
+set_variable('is_windows', exec_env == 'windows')
+#allow experimental api
+add_global_arguments('-DALLOW_EXPERIMENTAL_API', language : 'c')
+
+libst_dpdk = dependency('libst_dpdk', required : true)
+libjson_c = dependency('json-c', required : true)
+if not is_windows
+libpcap = dependency('pcap', required:true)
+endif
+libsdl2 = dependency('sdl2', required:true)
+
+#add source file
+subdir('src')
+subdir('tools')
+subdir('sample')
+
+app_c_args = []
+
+#enable warning as error
+app_c_args += ['-Werror']
+app_c_args += ['-Wall']
+if is_windows
+libpcap =[]
+mingw_root_dir = 'c:\mingw64'
+dpdk_root_dir = 'c:\dpdk'
+app_c_args += ['-DWINDOWSENV']
+app_c_args += ['-Wformat=0']
+app_c_args += ['-D__USE_MINGW_ANSI_STDIO']
+mingw_include_dir = mingw_root_dir + '''\include'''
+windows_include_dir = '..\..\lib\windows'
+dpdk_include_dir = dpdk_root_dir + '''\lib\eal\windows\include'''
+app_c_args += ['-I' + dpdk_include_dir]
+app_c_args += ['-I' + mingw_include_dir]
+app_c_args += ['-I' + windows_include_dir]
+
+libdpdkcflags = run_command('pkg-config', '--cflags', 'libdpdk')
+libjsonccflags = run_command('pkg-config', '--cflags', 'json-c')
+libsdl2cflags = run_command('pkg-config', '--cflags', 'sdl2')
+libdpdklinkflags = run_command('pkg-config', '--static', '--libs', 'libdpdk')
+
+app_c_args += [libdpdkcflags.stdout().strip().split()]
+app_c_args += [libjsonccflags.stdout().strip().split()]
+app_c_args += [libsdl2cflags.stdout().strip().split()]
+endif
+
+#simd build option, enable sse4.2 default, todo: do we need AVX2/AVX512 for app ?
+app_c_args += ['-msse4.2']
+
+app_ld_args = []
+
+app_ld_args += ['-pthread']
+
+if is_windows
+app_ld_args += ['-lmingw32','-lws2_32','-lDbghelp','-lSetupapi','-ldinput8', '-ldxguid', '-ldxerr8', '-lwinmm', '-limm32','-lversion','-lwpcap','-lPacket','-lSDL2','-lSDL2Main','-lmman','-ljson-c']
+app_ld_args += ['-Wl,--whole-archive']
+app_ld_args += [libdpdklinkflags.stdout().strip().split()]
+app_ld_args += ['-Wl,--no-whole-archive']
+endif
+
+#build executable
+executable('RxTxApp', sources,
+  c_args : app_c_args,
+  link_args: app_ld_args,
+  dependencies: [libst_dpdk, libjson_c, libpcap, libsdl2]
+)
+
+executable('ConvApp', conv_sources,
+  c_args : app_c_args,
+  link_args: app_ld_args,
+)
+
+executable('TxVideoApp', video_tx_sources,
+  c_args : app_c_args,
+  link_args: app_ld_args,
+  dependencies: [libst_dpdk]
+)
+
+executable('RxVideoApp', video_rx_sources,
+  c_args : app_c_args,
+  link_args: app_ld_args,
+  dependencies: [libst_dpdk]
+)
+

app/sample/meson.build

@@ -0,0 +1,15 @@
+# Copyright (C) 2021 Intel Corporation.
+#
+# This software and the related documents are Intel copyrighted materials,
+# and your use of them is governed by the express license under which they
+# were provided to you ("License").
+# Unless the License provides otherwise, you may not use, modify, copy,
+# publish, distribute, disclose or transmit this software or the related
+# documents without Intel's prior written permission.
+#
+# This software and the related documents are provided as is, with no
+# express or implied warranties, other than those that are expressly stated
+# in the License.
+
+video_tx_sources = files('tx_video_sample.c')
+video_rx_sources = files('rx_video_sample.c')

app/sample/rx_video_sample.c

@@ -0,0 +1,182 @@
+/*
+ * Copyright (C) 2021 Intel Corporation.
+ *
+ * This software and the related documents are Intel copyrighted materials,
+ * and your use of them is governed by the express license under which they
+ * were provided to you ("License").
+ * Unless the License provides otherwise, you may not use, modify, copy,
+ * publish, distribute, disclose or transmit this software or the related
+ * documents without Intel's prior written permission.
+ *
+ * This software and the related documents are provided as is, with no
+ * express or implied warranties, other than those that are expressly stated
+ * in the License.
+ *
+ */
+
+#include <pthread.h>
+#include <st_dpdk_api.h>
+#include <stdbool.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <unistd.h>
+
+struct app_context {
+  int idx;
+  int16_t ready_frame_idx;
+  int16_t consumer_frame_idx;
+  int fb_rec;
+  void* frame_rec[3];
+  void* handle;
+  bool stop;
+  pthread_t app_thread;
+  pthread_cond_t wake_cond;
+  pthread_mutex_t wake_mutex;
+};
+
+static int rx_frame_ready(void* priv, void* frame) {
+  struct app_context* s = (struct app_context*)priv;
+  pthread_mutex_lock(&s->wake_mutex);
+  // restore the returned frame ptr, since rx_frame_ready callback should be non-blocked.
+  // the frame should be handled in app thread
+  s->frame_rec[s->ready_frame_idx] = frame;
+  s->ready_frame_idx = (s->ready_frame_idx + 1) % 3;
+  pthread_cond_signal(&s->wake_cond);
+  pthread_mutex_unlock(&s->wake_mutex);
+  s->fb_rec++;
+  return 0;
+}
+
+static void* app_rx_video_frame_thread(void* arg) {
+  struct app_context* s = arg;
+  int consumer_idx;
+  void* frame;
+
+  while (!s->stop) {
+    consumer_idx = s->consumer_frame_idx;
+    consumer_idx++;
+    if (consumer_idx >= 3) consumer_idx = 0;
+    if (consumer_idx == s->ready_frame_idx) {
+      /* no buffer */
+      pthread_mutex_lock(&s->wake_mutex);
+      if (!s->stop) pthread_cond_wait(&s->wake_cond, &s->wake_mutex);
+      pthread_mutex_unlock(&s->wake_mutex);
+      continue;
+    }
+
+    frame = s->frame_rec[consumer_idx];
+    // put your handle of frame ptr here, it contains pixels data format in st2110-20
+    // aligned with the TX transfer pg format
+    st20_rx_put_framebuff(s->handle, frame);
+    s->consumer_frame_idx = consumer_idx;
+  }
+
+  return NULL;
+}
+
+int main() {
+  struct st_init_params param;
+  memset(&param, 0, sizeof(param));
+  int session_num = 1;
+  param.num_ports = 1;
+  strncpy(param.port[ST_PORT_P], "0000:af:00.0", ST_PORT_MAX_LEN);
+  uint8_t ip[4] = {192, 168, 0, 1};
+  memcpy(param.sip_addr[ST_PORT_P], ip, ST_IP_ADDR_LEN);
+  param.flags = ST_FLAG_BIND_NUMA;      // default bind to numa
+  param.log_level = ST_LOG_LEVEL_INFO;  // log level. ERROR, INFO, WARNING
+  param.priv = NULL;                    // usr ctx pointer
+  param.ptp_get_time_fn =
+      NULL;  // user regist ptp func, if not regist, the internal pt p will be used
+  param.tx_sessions_cnt_max = 0;
+  param.rx_sessions_cnt_max = session_num;
+  param.lcores = NULL;
+  st_handle dev_handle = st_init(&param);
+  if (!dev_handle) {
+    printf("st_init fail\n");
+    return -1;
+  }
+  st20_rx_handle rx_handle[session_num];
+  struct app_context* app[session_num];
+  int ret;
+
+  // create and register rx session
+  for (int i = 0; i < session_num; i++) {
+    app[i] = (struct app_context*)malloc(sizeof(struct app_context));
+    if (!app[i]) {
+      printf(" app struct is not correctly malloc");
+      return -1;
+    }
+    app[i]->idx = i;
+    struct st20_rx_ops ops_rx;
+    ops_rx.name = "st20_test";
+    ops_rx.priv = app[i];  // app handle register to lib
+    ops_rx.num_port = 1;
+    uint8_t sip[4] = {239, 168, 0, 1};
+    memcpy(ops_rx.sip_addr[ST_PORT_P], sip, ST_IP_ADDR_LEN);  // tx src ip like 239.0.0.1
+    strncpy(ops_rx.port[ST_PORT_P], "0000:af:00.0",
+            ST_PORT_MAX_LEN);  // send port interface like 0000:af:00.0
+    ops_rx.udp_port[ST_PORT_P] =
+        10000 + i;  // user could config the udp port in this interface.
+    ops_rx.pacing = ST21_PACING_NARROW;
+    ops_rx.type = ST20_TYPE_FRAME_LEVEL;
+    ops_rx.width = 1920;
+    ops_rx.height = 1080;
+    ops_rx.fps = ST_FPS_P59_94;
+    ops_rx.fmt = ST20_FMT_YUV_422_10BIT;
+    ops_rx.framebuff_cnt =
+        3;  // aligned with frame_rec[3] in app_context, framebuf pool size is 3 in lib.
+    ops_rx.notify_frame_ready =
+        rx_frame_ready;  // app regist non-block func, app could get a frame ready
+                         // notification info by this callback
+    rx_handle[i] = st20_rx_create(dev_handle, &ops_rx);
+    if (!rx_handle[i]) {
+      printf(" rx_session is not correctly created");
+      free(app[i]);
+      return -1;
+    }
+    app[i]->handle = rx_handle[i];
+    app[i]->consumer_frame_idx = -1;
+    app[i]->ready_frame_idx = 0;
+    app[i]->stop = false;
+    pthread_mutex_init(&app[i]->wake_mutex, NULL);
+    pthread_cond_init(&app[i]->wake_cond, NULL);
+    ret = pthread_create(&app[i]->app_thread, NULL, app_rx_video_frame_thread, app[i]);
+    if (ret < 0) {
+      printf("%s(%d), app_thread create fail %d\n", __func__, ret, i);
+      ret = st20_rx_free(rx_handle[i]);
+      if (ret) {
+        printf("session free failed\n");
+      }
+      free(app[i]);
+      return -1;
+    }
+  }
+  // start rx
+  ret = st_start(dev_handle);
+  // rx run 120s
+  sleep(120);
+  // stop app thread
+  for (int i = 0; i < session_num; i++) {
+    app[i]->stop = true;
+    pthread_join(app[i]->app_thread, NULL);
+  }
+
+  // stop rx
+  ret = st_stop(dev_handle);
+
+  // release session
+  for (int i = 0; i < session_num; i++) {
+    ret = st20_rx_free(rx_handle[i]);
+    if (ret) {
+      printf("session free failed\n");
+    }
+    pthread_mutex_destroy(&app[i]->wake_mutex);
+    pthread_cond_destroy(&app[i]->wake_cond);
+    free(app[i]);
+  }
+
+  // destroy device
+  st_uninit(dev_handle);
+  return 0;
+}