nxcodec 用户指南

[English | 简体中文]

一、概述

nxcodec 是一个命令行测试工具，用于验证 V4L2 (Video4Linux2) M2M (Memory-to-Memory) Codec 驱动的功能。它支持对视频流进行编码 (Encode) 和解码 (Decode) 操作。

二、准备工作

在运行 nxcodec 测试前，您需要完成系统配置并准备好测试文件。

1、构建配置

您必须在 menuconfig 中启用 nxcodec 及其依赖项。

启用 nxcodec 工具：

在 menuconfig 中，使能以下选项：
```
CONFIG_SYSTEM_NXCODEC=y
```

确保依赖项已启用：

nxcodec 依赖 V4L2 框架和相关的驱动。请确保以下核心配置已启用：

# V4L2 核心支持
CONFIG_VIDEO=y
CONFIG_DRIVERS_VIDEO=y
CONFIG_VIDEO_STREAM=y

# 示例 Codec 驱动 (可按需替换为您的硬件驱动)
CONFIG_SIM_VIDEO_DECODER=y
CONFIG_SIM_VIDEO_ENCODER=y

# Codec 算法库
CONFIG_VIDEOUTILS_OPENH264=y
CONFIG_VIDEOUTILS_LIBX264=y

启用主机文件系统 (可选)：

当您在模拟器 (sim) 环境中测试时，为了方便地访问宿主机上的测试文件，请启用 hostfs：
```
CONFIG_FS_HOSTFS=y
```

2、准备文件系统 (可选)

如果在模拟器环境中运行，请使用以下命令将宿主机存放测试文件的目录挂载到 openvela 的文件系统中。

# 将宿主机的/path/from/your/host/machine目录挂载到openvela的/stream目录
nsh> mount -t hostfs -o fs=/path/from/your/host/machine /stream

三、命令参考

1、命令格式

nxcodec 的基本命令格式如下：

nsh> nxcodec -d <device> -s <wxh> -f <in_format> -i <infile> -f <out_format> -o <outfile>

# 请求帮助信息
ap> nxcodec -h
NxCodec Version: 1.00
Usage: nxcodec -d <devname> [options] -i <infile> [options] -o <outfile>

Options:
  -d | --device    Video device name
  -s | --size      Size of stream
  -f | --format    Format of stream
  -i | --infile    Input filename for M2M devices
  -o | --outfile   Outputs stream to filename
  -h | --help      Print this help message

2、参数说明

短命令	长命令	描述
`-d`	`--device`	指定 V4L2 Codec 设备节点路径，例如 `/dev/video1`。
`-s`	`--size`	指定视频流的分辨率，格式为 `宽x高`，例如 `256x144`。
`-f`	`--format`	[重要] 指定输入或输出流的格式。此参数的位置决定其作用域：它定义了紧随其后的 `-i` (输入) 或 `-o` (输出) 文件的格式。
`-i`	`--infile`	指定输入文件的路径。
`-o`	`--outfile`	指定输出文件的路径。
`-h`	`--help`	显示帮助信息并退出。

四、测试示例

以下示例演示如何使用 nxcodec 执行解码和编码操作。

1、解码测试 (H.264 -> YUV)

此操作使用解码器设备 (/dev/video1) 将一个 H.264 编码的视频文件解码为原始的 YUV 格式文件。

解码命令：

nsh> nxcodec -d /dev/video1 -s 256x144 -f H264 -i /stream/256x144.h264 -f YU12 -o /stream/256x144-yuv420p-out.yuv

命令解析：

-d /dev/video1：指定解码器设备路径为 /dev/video1。
-s 256x144：指定输出视频流的分辨率为 256x144。
-f H264：指定输入视频流的编码格式为 H.264。
-i /stream/256x144.h264：指定输入视频流的文件路径为 /stream/256x144.h264。
-f YU12：指定输出视频流的 pixformat 格式为 YU12。
-o /stream/256x144-yuv420p-out.yuv：指定输出 YUV 文件路径为 /stream/256x144-yuv420p-out.yuv。

简化命令: 如果驱动程序支持自动识别输入流的格式和分辨率，您可以省略 -f (输入格式) 和 -s 参数。

nsh> nxcodec -d /dev/video1 -i /stream/256x144.h264 -o /stream/256x144-yuv420p-out.yuv

2、编码测试 (YUV -> H.264)

此操作使用编码器设备 (/dev/video2) 将一个原始的 YUV 格式视频文件编码为 H.264 码流文件。

mount host文件系统（可选项，在 simulator 环境下需要）：

nsh> mount -t hostfs -o fs=/path/from/ /stream

编码命令：

nsh> nxcodec -d /dev/video2 -s 256x144 -f YU12 -i /stream/256x144-yuv420p.yuv -f H264 -o /stream/256x144-out.h264

这个命令的作用是使用 nxcodec 工具对输入的视频流YUV文件进行编码，并将编码后的视频流输出到指定的文件中。

具体参数的含义如下：

-d /dev/video2：指定输入视频流的设备文件路径。
-s 256x144：指定输入视频流的分辨率为 256x144。
-f YU12：指定输入视频流的像素格式为 YU12。
-i /stream/256x144-yuv420p.yuv：指定输入视频流的文件路径。
-f H264：指定输出视频流的编码格式为 H264。
-o /stream/256x144-out.h264：指定输出视频流的文件路径。