# ChannelRED

**Repository Path**: OpenSoup/channel-red

## Basic Information

- **Project Name**: ChannelRED
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-09
- **Last Updated**: 2025-12-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ChannelRED

ChannelRED 是一个用于读取项目 ChannelREC 生成的 CSV 文件，并通过读取的数据生成通道变化演示视频。

[English](README.md) | [简体中文](README_zh.md)

## 功能特点

- 解析 ChannelREC 录制的 CSV 数据，并生成视频
- 支持自定义通道数量和展示方式

## 安装说明

1. 在该项目的 `Releases` 中根据自己的操作系统下载对应版本的可执行文件
2. 在环境变量中添加可执行文件所在的文件夹(可选)

## 使用方法

输入如下命令对视频进行生成：
```
chanred path/to/your/file.chanrec path/to/your/outputvideo.mp4 [args]
```

更多参数说明：

- `chanrec_file`: ChannelREC录制文件路径（CSV格式）
- `output_video`: 输出视频文件路径
- `-c, --channels CHANNELS`: 指定JSON格式的通道配置文件
- `--fps FPS`: 设置输出视频的帧率
- `--width WIDTH`: 设置输出视频宽度
- `--height HEIGHT`: 设置输出视频高度

## 配置文件说明

配置文件采用 JSON 格式，用于定义视频中通道的显示方式和位置。

### 基本介绍

配置文件是一个 JSON 数组，数组中的每个元素代表一个控件。每个控件可以是二维控制或一维控制。

### 二维控制说明及示例

二维控制用于同时显示两个通道的数据，通常用于摇杆类数据的显示。

示例：
```json
{
    "type": "2d",
    "x_channel": "rud",
    "y_channel": "thr",
    "x": 128, "y": 128,
    "width": 256, "height": 256
}
```

字段说明：
- `type`: 控件类型，此处为 "2d"
- `x_channel`: X轴对应的通道名称
- `y_channel`: Y轴对应的通道名称
- `x`: 控件左上角的X坐标
- `y`: 控件左上角的Y坐标
- `width`: 控件宽度
- `height`: 控件高度

### 一维控制说明及示例

一维控制用于显示单个通道的数据，通常用于开关、旋钮等单一数值的显示。

示例：
```json
{
    "type": "1d",
    "channel": "ch5",
    "x": 128, "y": 512,
    "toward": 0,
    "width": 256,
    "height": 32
}
```

字段说明：
- `type`: 控件类型，此处为 "1d"
- `channel`: 对应的通道名称
- `x`: 控件左上角的X坐标
- `y`: 控件左上角的Y坐标
- `toward`: 填充方向（0=右，1=上，3=左，4=下）
- `width`: 控件宽度
- `height`: 控件高度

### 各字段具体含义和用法

- 所有坐标和尺寸单位都是像素
- 屏幕坐标系原点在左上角，X轴向右为正，Y轴向下为正
- 通道值范围为 [-1024, 1024]
- 二维控制会自动将通道值映射到控件区域内，并以白球形式显示当前位置
- 一维控制会根据通道值填充相应比例的区域，填充方向由 `toward` 参数决定