# xplay 专为树莓派(Raspberry Pi)设计的多媒体播放器且支持(Windows、Linux、Android)系统 --- 支持(视频、音频、流媒体、图片、摄像头、动画、文本、滚动字幕、日期时间、二维码)   --- ***需要在（Raspberry Pi OS (Legacy) with desktop）系统中使用（xplay）多媒体播放器，因为（Legacy）系统支持（VideoCore IV）。*** ***基于云发布的多媒体播放器（ [Github](https://github.com/nulijiabei/uplay) / [Gitee](https://gitee.com/nljb/uplay) ），可以云端集中管理（Win、Linux、ARM）设备上的多媒体播放器 ...*** --- [支持硬件](#支持硬件) [支持系统](#支持系统) [目录结构](#目录结构) [支持功能](#支持功能) [安装方法](#安装方法) [常见问题](#常见问题) [播放控制](#播放控制) [命令行工具](#命令行工具) [控制指令](#控制指令) [许可信息](#许可信息) --- ### 支持硬件 | 硬件 | 模式 | 分辨率 | FPS | 测试 | | --- | --- | --- | --- | --- | | Raspberry Pi Zero | OMX (推荐) / DRM | 1080p/v720p | 30 | 已测试 | | Raspberry Pi Zero 2 | OMX (推荐) / DRM | 1080p/v720p | 30 | 已测试 | | Raspberry Pi 2 Model B | OMX (推荐) / DRM | 1080p/v720p | 30 | 已测试 | | Raspberry Pi 3 Model B | OMX (推荐) / DRM | 1080p/v720p | 30 | 已测试 | | Raspberry Pi 3 Model A+ | OMX (推荐) / DRM | 1080p/v720p | 30 | 已测试 | | Raspberry Pi 3 Model B+ | OMX (推荐) / DRM | 1080p/v720p | 30 | 已测试 | | Raspberry Pi 4 Model B | DRM (推荐) / X11 | 1080p/[【双】](https://gitee.com/nljb/xplay/issues/I1HPLH) | 30 | 已测试 | | Android 系统 | DRM | - | - | 可定制 | | Linux 系统 | DRM / X11 | [github](https://github.com/nulijiabei/ubuntu-xplay) / [gitee](https://gitee.com/nljb/ubuntu-xplay) | - | 已测试 | | Windows 系统 | Microsoft Direct3D | [github](https://github.com/nulijiabei/winxplay) / [gitee](https://gitee.com/nljb/winxplay) | - | 已测试 | ***理论上支持所有树莓派，但是经过测试的树莓派只有上面几款*** --- ### 支持系统 | 系统版本 | 发布日期 | 安装程序 | 测试版本 | 测试状态 | | --- | --- | --- | --- | --- | | Raspberry Pi OS (Legacy) with desktop | 2024-03-12 | raspios/ | v1.0.22.v20220406 | 待测试 | | Raspberry Pi OS (Legacy) with desktop | 2023-12-05 | raspios/ | ↓ | 已测试 | | Raspberry Pi OS (Legacy) with desktop | 2023-10-10 | raspios/ | ↓ | 已测试 | | Raspberry Pi OS with desktop | 2023-10-10 | raspios/ | ↓ | 不支持 | | Raspberry Pi OS (Legacy) with desktop | 2023-05-03 | raspios-legacy/ | ↓ | 待测试 | | Raspberry Pi OS with desktop | 2023-05-03 | raspios/ | ↓ | 待测试 | | Raspberry Pi OS (Legacy) with desktop | 2023-02-21 | raspios-legacy/ | ↓ | 待测试 | | Raspberry Pi OS with desktop | 2023-02-21 | raspios/ | ↓ | 待测试 | | Raspberry Pi OS (Legacy) with desktop | 2022-09-22 | raspios-legacy/ | v1.0.22.v20220406 | 已测试 | | Raspberry Pi OS with desktop | 2022-09-22 | raspios/ | v1.0.22.v20220406 | 已测试 | | Raspberry Pi OS (Legacy) with desktop | 2022-09-06 | raspios-legacy/ | ↑ | 已测试 | | Raspberry Pi OS with desktop | 2022-09-06 | raspios/ | ↑ | 已测试 | | Raspberry Pi OS (Legacy) with desktop | 2022-04-04 | raspios-legacy/ | ↑ | 已测试 | | Raspberry Pi OS with desktop | 2022-04-04 | raspios/ | ↑ | 已测试 | | Raspberry Pi OS (Legacy) with desktop | 2022-01-28 | raspios-legacy/ | ↑ | 已测试 | | Raspberry Pi OS with desktop | 2022-01-28 | raspios/ | ↑ | 已测试 | | Raspberry Pi OS (Legacy) with desktop | 2021-12-02 | raspios-legacy/ | ↑ | 已测试 | | Raspberry Pi OS with desktop | 2021-10-30 | raspios/ | ↑ | 已测试 | | Raspberry Pi OS with Lite | 2021-10-30 | → | → | 不兼容 | | Raspberry Pi OS with desktop | 2021-05-07 | buster/ | v1.0.21.v20210806 | 已测试 | | Raspberry Pi OS with Lite | 2021-05-07 | buster-lite/ | v1.0.21.v20210806 | 已测试 | | Raspberry Pi OS with desktop | 2021-03-04 | buster/ | ↑ | 已测试 | | Raspberry Pi OS with Lite | 2021-03-04 | buster-lite/ | ↑ | 已测试 | | Raspberry Pi OS with desktop | 2021-01-11 | buster/ | ↑ | 已测试 | | Raspberry Pi OS with Lite | 2021-01-11 | buster-lite/ | ↑ | 已测试 | | Raspberry Pi OS with desktop | 2020-12-02 | buster/ | ↑ | 已测试 | | Raspberry Pi OS with Lite | 2020-12-02 | buster-lite/ | ↑ | 已测试 | | Raspberry Pi OS with desktop | 2020-08-20 | buster/ | ↑ | 已测试 | | Raspberry Pi OS with Lite | 2020-08-20 | buster-lite/ | ↑ | 已测试 | | Raspberry Pi OS with desktop | 2020-05-27 | buster/ | ↑ | 已测试 | | Raspberry Pi OS with Lite | 2020-05-27 | buster-lite/ | ↑ | 已测试 | | Raspbian Buster with desktop | 2020-02-13 | buster/ | ↑ | 已测试 | | Raspbian Buster Lite | 2020-02-13 | buster-lite/ | ↑ | 已测试 | | Raspbian Buster with desktop | 2019-09-26 | buster/ | v1.0.1.v20191105 | 已测试 | | Raspbian Buster Lite | 2019-09-26 | buster-lite/ | v1.0.1.v20191105 | 已测试 | --- ### 目录结构 ``` /usr/bin/xplayrun 启动脚本(可配置启动参数) /usr/bin/xplay 主程序 /usr/bin/xplayctl 命令行工具 /etc/xplay/log4qt.properties 日志配置文件 /etc/xplay/simsun.ttc 默认字体文件 /etc/xplay/xplay.pid 运行时进程ID /etc/ld.so.conf.d/00-xplay.conf 关联库文件指向 /usr/local/lib/... 关联库文件目录 ``` --- ### 支持功能 1. 支持自定义播放器分辨率、帧率(FPS)，支持音频采样率(Sample Rate)自适应 2. 支持使用(TCP)连接播放器发送指令控制(播放、覆盖、停止、移动、等) 3. 支持(视频、音频、流媒体、图片、摄像头、动画、文本、滚动字幕、日期时间、二维码)素材播放 4. 支持(视频)多种格式(例如：MP4、AVI、MOV、等)、音频(AAC) 5. 支持(流媒体)RTMP、RTSP、HTTP、H264/H265(YUV420P/YUVJ420P) 6. 支持(图片)JPG与PNG格式 7. 支持(动画)GIF格式 8. 支持(视频)硬解播放(MMAL、VAAPI、VDPAU、QSV、MediaCodec、RKMPP、NVDEC)、(H264) 9. 支持(视频)预加载 10. 支持(视频)单线程解码与多线程解码双模式 11. 支持(摄像头)设备(Raspberry Pi Camera V2) 12. 支持(视频、图片)无黑场切换播放 13. 支持(视频、图片)序列播放 14. 支持(视频)音频同步(视频帧时间戳与音轨帧时间戳)播放 15. 支持(视频)时钟同步(视频帧时间戳与时钟时间戳)播放 16. 支持(视频、流媒体、图片、摄像头、动画、文本、滚动字幕、日期时间、二维码)多层(Overlay)播放 17. 支持(文本)自定义(字体大小、字体颜色、背景颜色、透明度、对齐方式、风格样式、多行段落) 18. 支持(滚动字幕)自定义(字体大小、字体颜色、背景颜色、透明度、风格样式、移动速度、移动方向) 19. 支持(信息提示框)自定义提示文本及多种状态标识(notice、success、warning、error) 20. 支持(日期时间)自定义(字体大小、字体颜色、背景颜色、透明度、对齐方式、风格样式) 21. 支持(字体)自定义(可以通过自定义指定TTC字体来实现不同效果的文本样式) 22. 支持自定义布局(通过多层功能可以实现多种自定义布局) 23. 支持自定义(视频)是否循环播放(视频在播放到结尾时是否停留在最后一帧) 24. 支持自定义素材尺寸(width，height)，任意拉伸缩放素材尺寸播放 25. 支持自定义素材位置(x，y)播放，任意定义素材播放位置 26. 支持自定义移动素材位置(x，y)及改变素材尺寸(width，height) 27. 支持自定义素材横竖屏旋转(横屏角度：0、180，竖屏角度：90、270) 28. 支持自定义素材开始播放时间(多个播放器间可以实现同步播放) 29. 支持实时屏幕快照(截屏) 30. 支持静音播放 --- ### 安装方法 ***1. 安装程序 ([安装教程](https://gitee.com/nljb/xplay/issues/I4KL5W))*** > 注意：请您在(ROOT)用户下进行安装, 安装完成后请重启您的树莓派后再运行 ... > 下载 ``` git clone https://github.com/nulijiabei/xplay.git # (Master分支最新版本) git clone https://github.com/nulijiabei/xplay.git -b v1.0.22.v20220406 # (最新发布版请查看标签) 或 git clone https://gitee.com/nljb/xplay.git # (Master分支最新版本) git clone https://gitee.com/nljb/xplay.git -b v1.0.22.v20220406 # (最新发布版请查看标签) ``` > 安装 | 安装 | 框架 | 硬件 | 系统 | 备注 | | --- | --- | --- | --- | --- | | raspios/rpi_drm_install.sh | DRM | Raspberry Pi 34 | Raspberry Pi OS with desktop | 仅命令行可运行(全屏推荐) | | raspios/rpi_x11_install.sh | X11 | Raspberry Pi 4 | Raspberry Pi OS with desktop | 仅桌面可运行(可窗口化) | ``` cd xplay/raspios/ sh -x rpi_drm_install.sh 或 sh -x rpi_x11_install.sh ``` ***2. 运行程序*** | 参数 | 默认 | 说明 | | --- | --- | --- | | -R x,y,width,height | 0,0,1920,1080 | 分辨率设置 | | -fps n | 30 | 帧率设置 | | -noloop | 无 | 播放到结尾时是否停留在最后一帧 | | -buflen | 16 | 缓冲区长度 | | -mute | 无 | 静音设置 | | -nosync | 无 | 关闭全部同步 | | -nasync | 无 | 关闭音频同步(统一时钟同步) | | -version | 无 | 版本号 | | -cpuid | 无 | CPUID | | -playing | 无 | 播放测试 | | -welcome | 无 | 自定义欢迎页 | > 注意：建议您使用(ROOT)用户或(ROOT)权限用户来运行, 否则相关状态文件无法生成 ... ``` // 分辨率 1920x1080 【默认】 // 帧率 30fps 【默认】 export LD_LIBRARY_PATH=/usr/local/lib/ /usr/bin/xplay // 分辨率设置 1920x1080 // 帧率 30fps // 【未设置则使用默认设置】 export LD_LIBRARY_PATH=/usr/local/lib/ /usr/bin/xplay -R 0,0,1920,1080 -fps 30 ``` ***3. 播放测试*** ``` // 测试素材 cp autotest/yiyezi.mp4 /root/yiyezi.mp4 // 播放测试 export LD_LIBRARY_PATH=/usr/local/lib/ /usr/bin/xplay -playing /root/yiyezi.mp4 ``` ***4. 查看日志*** ``` tail -n 100 /dev/shm/xplay.log ``` --- ### 常见问题 ***1. 显存报错*** ``` // 该报错说明显存不足，请适当增加显存 mmal: mmal_vc_port_enable: failed to enable port vc.ril.video_decode:out:0(I420): ENOMEM mmal: mmal_port_enable: failed to enable port vc.ril.video_decode:out:0(I420)(0xca5070) (ENOMEM) mmal: mmal_port_disable: port vc.ril.video_decode:out:0(I420)(0xca5070) is not enabled ``` > 安装脚本默认已经为您设置了显存，安装完成后请重启您的树莓派 | 文件 | 设置 | 说明 | | --- | --- | --- | | /boot/config.txt | gpu_mem=256 (显存内存分配不能少于192M) | 重启生效 | > 说明：经测试在720P视频轮播时显存不低于192M，1080P视频不低于256M，或更高 !!! ***2. 音频设置*** > 配置文件（/etc/asound.conf）指定音频输出模式 ``` // 0:3.5MM | 1:HDMI defaults.pcm.card 0 defaults.pcm.device 0 defaults.ctl.card 0 ``` > 如果在使用中出现音频杂音问题可以尝试以下方案 1. 更新系统到最新版本 ``` sudo apt update sudo apt upgrade sudo reboot ``` 2. 配置混音输出模式（/etc/asound.conf） ``` pcm.!default { type plug slave.pcm "dmixer" } pcm.dmixer { type dmix ipc_key 1024 slave { pcm "hw:0,0" period_time 0 period_size 4096 buffer_size 8192 rate 48000 } bindings { 0 0 1 1 } } ctl.dmixer { type hw card 0 } ``` --- ### 播放控制 * 通过Socket接口与播放器建立TCP连接，向播放器发送指令，从播放器接收返回 * 可以通过多种支持Socket连接语言开发控制程序(java、python、C++、golang、等 ...) * 注：运行样例之前请先启动xplay主程序(/usr/bin/xplay) [Golang 控制样例](example/example.go) [Python 控制样例](example/example.py) [Java 控制样例](example/XplayCtl.java) --- ### 命令行工具 [xplayctl 命令行工具](example/xplayctl.go) [example_x1_xplayctl.sh 基于命令行工具](example/example_x1_xplayctl.sh) [example_x4_xplayctl.sh 基于命令行工具](example/example_x4_xplayctl.sh) >请参考[控制指令](#控制指令)来使用以下命令行参数 | 命令行参数(base) | 默认值 | 说明 | | --- | --- | --- | | -addr | 127.0.0.1:8700 | 网络地址及端口 | | 命令行参数(type) | 说明 | | --- | --- | | -play | 播放指令 | | -stop | 停止指令 | | -move | 移动指令 | | -snap | 截屏指令 | | -query | 查询指令 | | -change | 改变指令 | | 命令行参数(query) | 说明 | | --- | --- | | -all | 查询全部层 | | 命令行参数(stop) | 默认值 | 可选参数 | 说明 | | --- | --- | --- | --- | | -start | -1 | 无 | 停止时间(ms) | | -all | 无 | 无 | 停止全部层 | | -ids | 无 | 无 | 停止指定层 | | 命令行参数(move) | 默认值 | 可选参数 | 说明 | | --- | --- | --- | --- | | -zIndex | 10 | 0 - 999 | 层 | | -rect | 0,0,1920,1080 | left,top,width,height | 素材显示尺寸与位置 | | 命令行参数(change) | 默认值 | 可选参数 | 说明 | | --- | --- | --- | --- | | -zIndex | 10 | 0 - 999 | 层 | | -newIndex | 0 | 0 - 999 | 层 | | 命令行参数(snap) | 默认值 | 说明 | | --- | --- | --- | | -path | snap.jpg | 截屏保存路径 | | 命令行参数(play) | 默认值 | 可选参数 | 说明 | | --- | --- | --- | --- | | -start | -1 | 无 | 开始时间(ms) | | -libName | 无 | video、pic、sequence、gif、qrcode、camera、text、scroll、datetime、toast | 素材类型 | | 命令行参数(sequence) | 默认值 | 可选参数 | 说明 | | --- | --- | --- | --- | | -zIndex | 10 | 0 - 999 | 层 | | -rect | 0,0,1920,1080 | left,top,width,height | 素材显示尺寸与位置 | | -screen_mode | landscape | landscape、portrait | 横竖屏模式 | | -screen_rotate | 0 | 0、180、90、270 | 旋转角度 | | -path | 无 | 素材路径1,素材路径2,素材路径3,... | 多个素材路径通过逗号(,)分隔 | | -duration | 5 | 无 | 非视频素材所播放的时间(s) | | 命令行参数(video) | 默认值 | 可选参数 | 说明 | | --- | --- | --- | --- | | -zIndex | 10 | 0 - 999 | 层 | | -rect | 0,0,1920,1080 | left,top,width,height | 素材显示尺寸与位置 | | -screen_mode | landscape | landscape、portrait | 横竖屏模式 | | -screen_rotate | 0 | 0、180、90、270 | 旋转角度 | | -path | 无 | 无 | 素材路径 | | -offset | -1 | 无 | 偏移量(ms) | | -timeout | -1 | 无 | 断流超时(ms) | | 命令行参数(pic、gif) | 默认值 | 可选参数 | 说明 | | --- | --- | --- | --- | | -zIndex | 10 | 0 - 999 | 层 | | -rect | 0,0,1920,1080 | left,top,width,height | 素材显示尺寸与位置 | | -screen_mode | landscape | landscape、portrait | 横竖屏模式 | | -screen_rotate | 0 | 0、180、90、270 | 旋转角度 | | -path | 无 | 无 | 素材路径 | | 命令行参数(qrcode) | 默认值 | 可选参数 | 说明 | | --- | --- | --- | --- | | -zIndex | 10 | 0 - 999 | 层 | | -rect | 0,0,1920,1080 | left,top,width,height | 素材显示尺寸与位置 | | -screen_mode | landscape | landscape、portrait | 横竖屏模式 | | -screen_rotate | 0 | 0、180、90、270 | 旋转角度 | | -content | 无 | 无 | 文本内容 | | 命令行参数(camera) | 默认值 | 可选参数 | 说明 | | --- | --- | --- | --- | | -zIndex | 10 | 0 - 999 | 层 | | -rect | 0,0,1920,1080 | left,top,width,height | 素材显示尺寸与位置 | | -screen_mode | landscape | landscape、portrait | 横竖屏模式 | | -screen_rotate | 0 | 0、180、90、270 | 旋转角度 | | -device | /dev/video0 | 无 | 设备地址 | | -camera_width | 1280 | 无 | 摄像头 video_size 宽 | | -camera_height | 720 | 无 | 摄像头 video_size 高 | | 命令行参数(text) | 默认值 | 可选参数 | 说明 | | --- | --- | --- | --- | | -zIndex | 10 | 0 - 999 | 层 | | -rect | 0,0,1920,1080 | left,top,width,height | 素材显示尺寸与位置 | | -screen_mode | landscape | landscape、portrait | 横竖屏模式 | | -screen_rotate | 0 | 0、180、90、270 | 旋转角度 | | -content | 无 | 无 | 文本内容 | | -font_ttf | 无 | 无 | 指定字体 | | -font_size | 18 | 12 - 72 | 字体大小 | | -color | rgba(0,128,0,100) | 无 | 文本颜色及透明度 | | -bgcolor | rgba(0,0,0,20) | 无 | 背景颜色及透明度 | | -align | center | center、right、left | 对齐方式 | | -style | normal | normal、bold、italic、underline、strikethrough | 文本样式 | | 命令行参数(scroll) | 默认值 | 可选参数 | 说明 | | --- | --- | --- | --- | | -zIndex | 10 | 0 - 999 | 层 | | -rect | 0,0,1920,1080 | left,top,width,height | 素材显示尺寸与位置 | | -screen_mode | landscape | landscape、portrait | 横竖屏模式 | | -screen_rotate | 0 | 0、180、90、270 | 旋转角度 | | -content | 无 | 无 | 文本内容 | | -font_ttf | 无 | 无 | 指定字体 | | -font_size | 18 | 12 - 72 | 字体大小 | | -color | rgba(0,128,0,100) | 无 | 文本颜色及透明度 | | -bgcolor | rgba(0,0,0,20) | 无 | 背景颜色及透明度 | | -style | normal | normal、bold、italic、underline、strikethrough | 文本样式 | | -orientation | horizontal | horizontal、vertical | 移动方向 | | -speed | 1 | 每帧向前移动像素 | 移动速度 | | 命令行参数(datetime) | 默认值 | 可选参数 | 说明 | | --- | --- | --- | --- | | -zIndex | 10 | 0 - 999 | 层 | | -rect | 0,0,1920,1080 | left,top,width,height | 素材显示尺寸与位置 | | -screen_mode | landscape | landscape、portrait | 横竖屏模式 | | -screen_rotate | 0 | 0、180、90、270 | 旋转角度 | | -font_ttf | 无 | 无 | 指定字体 | | -font_size | 18 | 12 - 72 | 字体大小 | | -color | rgba(0,128,0,100) | 无 | 文本颜色及透明度 | | -bgcolor | rgba(0,0,0,20) | 无 | 背景颜色及透明度 | | -align | center | center、right、left | 对齐方式 | | -style | normal | normal、bold、italic、underline、strikethrough | 文本样式 | | 命令行参数(toast) | 默认值 | 可选参数 | 说明 | | --- | --- | --- | --- | | -zIndex | 10 | 0 - 999 | 层 | | -screen_mode | landscape | landscape、portrait | 横竖屏模式 | | -screen_rotate | 0 | 0、180、90、270 | 旋转角度 | | -content | 无 | 无 | 文本内容 | | -toast_type | notice | notice、success、warning、error | 消息类型 | | -duration | 0 | 无 | 持续时间(s) 超时关闭 永不超时(0) | ``` /usr/bin/xplayctl -h # 帮助 /usr/bin/xplayctl -stop -all # 停止全部层 /usr/bin/xplayctl -query -all # 查询全部层 /usr/bin/xplayctl -stop -ids "10,11,12" # 停止指定层 /usr/bin/xplayctl -snap -path "/dev/shm/snap.jpg" # 截屏 /usr/bin/xplayctl -change -zIndex 10 -newIndex 11 # 改变层(切换层) /usr/bin/xplayctl -move -zIndex 10 -rect 100,100,500,500 # 移动与改变 /usr/bin/xplayctl -play -libName pic -path "/root/sample.jpg" # 显示图片 /usr/bin/xplayctl -play -libName gif -path "/root/sample.gif" # 显示动画 /usr/bin/xplayctl -play -libName video -path "/root/sample.mp4" # 显示视频 /usr/bin/xplayctl -play -libName video -zIndex 10 -path "/root/sample.mp4" # 显示视频 /usr/bin/xplayctl -play -libName qrcode -zIndex 5 -content "www.danoonetworks.com" # 显示二维码 /usr/bin/xplayctl -play -libName datetime -zIndex 9 -rect "0,0,500,50" -font_size 30 -align center # 显示日期时间 /usr/bin/xplayctl -play -libName toast -zIndex 3 -content "安装成功" -toast_type success -duration 5 # 显示信息提示框 /usr/bin/xplayctl -play -libName text -zIndex 9 -rect "0,0,1920,50" -content "专为树莓派设计的多媒体播放器" # 显示文本 /usr/bin/xplayctl -play -libName scroll -zIndex 9 -rect "0,0,-1,50" -content "专为树莓派设计的多媒体播放器" # 显示滚动字幕 ``` ``` /usr/bin/xplayctl -play -libName scroll -zIndex 9 -rect "0,0,-1,50" \ -content "专为树莓派设计的多媒体播放器" \ -speed 2 \ -orientation horizontal /usr/bin/xplayctl -play -libName scroll -zIndex 9 -rect "0,0,500,-1" \ -content "专为树莓派设计的多媒体播放器" \ -speed 2 \ -orientation vertical /usr/bin/xplayctl -play -libName text -zIndex 9 -rect "0,0,1920,50" \ -content "专为树莓派设计的多媒体播放器" \ -color "rgba(0,128,0,100)" \ -bgcolor "rgba(0,0,0,20)" \ -font_size 14 \ -align center \ -style bold /usr/bin/xplayctl -play -libName sequence -zIndex 10 -rect "0,0,1920,1080" \ -path "/root/a1.mp4,/root/b1.jpg,/root/a2.mp4" \ -duration 5 ``` ``` # 路径补全(xplay 与 xplayctl 在同一台设备时) cd /root/ ; /usr/bin/xplayctl -play -libName video -path ./sample.mp4 # 等同于 /usr/bin/xplayctl -play -libName video -path /root/sample.mp4 ``` ``` # 远端推流(xplay 与 xplayctl 在不同设备时) cd /root/ ; /usr/bin/xplayctl -addr 192.168.1.11:8700 -play -libName video -path ./sample.mp4 # 等同于 /usr/bin/xplayctl -addr 192.168.1.11:8700 -play -libName video -path http://192.168.1.11:8711/xplay/sample.mp4 ``` --- ### 控制指令 | 指令类型(type) | 说明 | | --- | --- | | play | 播放 | | stop | 停止 | | move | 移动 | | snap | 截屏 | | query | 查询 | | change | 改变 | | 素材类型(libName) | 说明 | | --- | --- | | video | 视频/流媒体 | | toast | 信息提示框 | | camera | 摄像头 | | pic | 图片 | | gif | 动画 | | qrcode | 二维码 | | text | 文本 | | scroll | 滚动字幕 | | datetime | 日期时间 | | sequence | 序列播放 | ``` // 指令说明 { "id": "Z10_Play_1557737960000", // 唯一标记(自定义唯一标识)【非必填】 "type": "play", // 指令类型【必填】 "start": -1, // 开始时间(默认：-1，立即播放，本地毫秒时间戳)【非必填】 "libName": "video", // 素材类型(video、pic、sequence、camera、gif、qrcode、text、scroll ...）【必填】 "params": { // 参数集合【必填】 "zIndex": 10, // 层(支持多层播放，层数越小画面越靠前)【必填】 "path": "/root/sample.mp4", // 素材路径【必填】 "left": 0, // 距左像素(X轴)【非必填】 "top": 0, // 距顶像素(Y轴)【非必填】 "width": 1920, // 宽(素材显示的宽，非素材原始尺寸，支持缩放拉伸)【必填】 "height": 1080, // 高(素材显示的高，非素材原始尺寸，支持缩放拉伸)【必填】 "screen_mode": "landscape", // 屏幕模式(横屏：landscape，竖屏：portrait，默认横屏)【非必填】 "screen_rotate": 0 // 旋转角度(横屏角度：0、180，竖屏角度：90、270，默认横屏)【非必填】 } } #End // 指令结束【必填】 ``` ``` // 指令结果说明 { "ok" : false, // 指令执行失败 【必返回】 "data" : "错误信息" // 指令失败信息 【非必返回】 } #End ``` ``` // 指令结果说明 { "ok" : true, // 指令执行成功 【必返回】 "data" : ... // 指令对应格式 【非必返回】(例如：查询指令结果时此处返回查询结果) } #End ``` | 视频播放(video) | 说明 | | --- | --- | | offset | 偏移量(ms) | ``` // 视频播放 { "id":"Z10_Play_1557737960000", "type":"play", "start":-1, "libName":"video", "params":{ "zIndex":10, "path":"/root/sample.mp4", "offset":5000, "left":0, "top":0, "width":1920, "height":1080, "screen_mode":"landscape", "screen_rotate":0 } } #End ``` | 流媒体播放(video) | 说明 | | --- | --- | | timeout | 断流超时(ms) | >断流超时：在视频流超时未获取数据包时，会结束当前解码器，可以通过 query 查询解码器状态 ``` // 流媒体播放 { "id":"Z10_Play_1557737960000", "libName":"video", "start":-1, "type":"play", "params":{ "path":"http://ivi.bupt.edu.cn/hls/cctv1hd.m3u8", "timeout":5000, "height":1080, "width":1920, "left":0, "top":0, "screen_mode":"landscape", "screen_rotate":0, "zIndex":10 } } ``` ``` // 显示图片 { "id":"Z10_Play_1556637960000", "type":"play", "start":-1, "libName":"pic", "params":{ "zIndex":10, "path":"/root/cat.jpg", "top":0, "left":0, "height":1080, "width":1920, "screen_mode":"landscape", "screen_rotate":0 } } #End ``` | 序列播放(sequence) | 说明 | | --- | --- | | path | 多个素材路径通过逗号(,)分隔 | | duration | 非视频素材所播放的时间(s) | ``` // 序列播放(格式一) { "type":"play", "id":"PLAY_Z10_1582276422", "libName":"sequence", "start":-1, "params":{ "zIndex":10, "path":"/root/a1.mp4,/root/b1.jpg,/root/a2.mp4,/root/b2.jpg", "duration":10, "top":0, "left":0, "width":1920, "height":1080, "screen_mode":"landscape", "screen_rotate":0 } } #End ``` | 序列播放(sequence) | 说明 | | --- | --- | | deps[] | 序列数据 | | deps[].path | 素材路径 | | deps[].type | 素材对应的 libName(video、pic) | | deps[].duration | 非视频素材所播放的时间(s) | ``` // 序列播放(格式二) { "type":"play", "id":"PLAY_Z10_1582276422", "libName":"sequence", "start":-1, "params":{ "zIndex":10, "top":0, "left":0, "width":1920, "height":1080, "screen_mode":"landscape", "screen_rotate":0 }, "deps":[ { "duration":-1, "path":"/root/a1.mp4", "type":"video" }, { "duration":10, "path":"/root/b1.jpg", "type":"pic" }, { "duration":-1, "path":"/root/a2.mp4", "type":"video" }, { "duration":10, "path":"/root/b2.jpg", "type":"pic" } ] } #End ``` | 信息提示框(toast) | 值 | 说明 | | --- | --- | --- | | toast_type | notice、success、warning、error | 消息类型 | | duration | 0(永不超时) | 持续时间(s) 超时关闭 | ``` // 显示信息提示框 { "type":"play", "id":"Z3_Play_1572344489512", "libName":"toast", "start":-1, "params":{ "zIndex":3, "screen_rotate":0, "screen_mode":"landscape", "content":"ABCDEFGHIJKLMNOPQRSTUVWXYZ", "toast_type":"notice", "duration":5 } } #End ``` | 摄像头(camera) | 值 | 说明 | | --- | --- | --- | | device | /dev/video0 | 设备地址 | | camera_width | 1280 | 摄像头 video_size 宽 | | camera_height | 720 | 摄像头 video_size 高 | >启用摄像头 raspi-config > Interfacing Options > P1 Camera ``` // 显示摄像头 { "id":"Z9_Play_1558837960000", "type":"play", "start":-1, "libName":"camera", "params":{ "zIndex":9, "device":"/dev/video0", "camera_width":1280, "camera_height":720, "top":0, "left":0, "width":1920, "height":1080, "screen_mode":"landscape", "screen_rotate":0 } } #End ``` | 文本(text) | 值 | 说明 | | --- | --- | --- | | color | rgba(0, 128, 0, 100) | 文本颜色及透明度 | | bgcolor | rgba(0, 0, 0, 0) | 背景颜色及透明度 | | font_ttf | /etc/xplay/simsun.ttc | 指定字体 | | font_size | 14 | 字体大小 | | align | center、right、left | 对齐方式 | | style | normal、bold、italic、underline、strikethrough | 文本样式 | | content | \t\t123,456,789\n987,654,321 | 文本内容 | | 内容(content) | 例 | 说明 | | --- | --- | --- | | \t | \t\tABC | 强制缩进 | | \n | ABC\nBCD | 强制换行 | | 空格 | ABCDEF ABCDEF ABCDEF | 超过宽度时在空格处换行 | ``` // 显示文本 { "type":"play", "id":"Z9_Play_1572344489512", "libName":"text", "start":-1, "params":{ "top":0, "left":0, "width":1280, "height":50, "zIndex":9, "screen_rotate":0, "screen_mode":"landscape", "content":"ABCDEFGHIJKLMNOPQRSTUVWXYZ", "color":"rgba(255, 0, 0, 100)", "bgcolor":"rgba(0, 0, 0, 0)", "font_size":30, "align":"center", "style":"bold" } } #End ``` | 滚动字幕(scroll) | 值 | 说明 | | --- | --- | --- | | color | rgba(0, 128, 0, 100) | 文本颜色及透明度 | | bgcolor | rgba(0, 0, 0, 0) | 背景颜色及透明度 | | font_ttf | /etc/xplay/simsun.ttc | 指定字体 | | font_size | 14 | 字体大小 | | style | normal、bold、italic、underline、strikethrough | 文本样式 | | speed | 1(每帧向前移动N像素) | 移动速度 | | content | ABCDEFGHIJKLMNOPQRSTUVWXYZ | 文本内容 | | orientation | horizontal、vertical | 移动方向 | | 参数有效性(scroll) | 值 | 说明 | | --- | --- | --- | | width | vertical 有效 / horizontal 无效 = screen.width | 宽有效性 | | height | horizontal 有效 / vertical 无效 = screen.height | 高有效性 | | left | vertical 有效 / horizontal 无效 = 0 | 距左有效性 | | top | horizontal 有效 / vertical 无效 = 0 | 距顶有效性 | ``` // 显示滚动字幕 { "type":"play", "id":"Z9_Play_1572344489512", "libName":"scroll", "start":-1, "params":{ "top":0, "left":0, "width":150, "height":50, "zIndex":5, "screen_rotate":0, "screen_mode":"landscape", "content":"ABCDEFGHIJKLMNOPQRSTUVWXYZ", "color":"rgba(255, 0, 0, 100)", "bgcolor":"rgba(0,128,0,80)", "font_size":30, "style":"bold", "orientation":"horizontal", "speed":1 } } #End ``` | 日期时间(datetime) | 值 | 说明 | | --- | --- | --- | | color | rgba(0, 128, 0, 100) | 文本颜色及透明度 | | bgcolor | rgba(0, 0, 0, 0) | 背景颜色及透明度 | | font_ttf | /etc/xplay/simsun.ttc | 指定字体 | | font_size | 30 | 字体大小 | | align | center、right、left | 对齐方式 | | style | normal、bold、italic、underline、strikethrough | 文本样式 | ``` // 显示日期时间 { "type":"play", "id":"Z9_Play_1572344489512", "libName":"datetime", "start":-1, "params":{ "top":0, "left":0, "width":500, "height":50, "zIndex":9, "screen_rotate":0, "screen_mode":"landscape", "color":"rgba(0, 128, 0, 100)", "bgcolor":"rgba(0, 0, 0, 20)", "font_size":30, "align":"center", "style":"bold" } } #End ``` >如果动画显示不正常, 您可以使用Photoshop重新存储一下 ``` // 显示动画 { "id":"Z9_Play_1554437960000", "type":"play", "start":-1, "libName":"gif", "params":{ "zIndex":9, "path":"/root/aaa.gif", "top":0, "left":0, "height":100, "width":100, "screen_mode":"landscape", "screen_rotate":0 } } #End ``` ``` // 显示二维码 { "id":"Z9_Play_1558837960000", "type":"play", "start":-1, "libName":"qrcode", "params":{ "zIndex":9, "content":"http://www.danoonetwork.com", "top":0, "left":0, "height":100, "width":100, "screen_mode":"landscape", "screen_rotate":0 } } #End ``` ``` // 停止全部层 { "id":"Stop_1558837960000", "type":"stop", "start": -1, "params":{ "all":true } } #End ``` ``` // 停止指定层 { "id":"Stop_1558837960000", "type":"stop", "start": -1, "params":{ "ids":[ "10", "11", "12" ] } } #End ``` ``` // 移动位置 { "type":"move", "params":{ "zIndex":10, "left":100, "top":100, "height":500, "width":500 } } #End ``` | 改变(change) | 值 | 说明 | | --- | --- | --- | | zIndex | 0 - 999 | 层 | | newIndex | 0 - 999 | 层 | >当目标层存在时原始层会与目标层互换 >当目标层不存在时原始层改变到目标层 ``` // 改变层 { "type":"change", "params":{ "zIndex":10, "newIndex":11 } } #End ``` ``` // 截屏 { "type":"snap", "params":{ "path":"/dev/shm/snap.jpg" } } #End ``` ``` // 查询全部层 { "type":"query", "params":{ "all":true } } #End | 查询全部层(query) | 说明 | | --- | --- | | decoder | 解码器是否运行 | // 返回结果 { "data":[ { "id":"PLAY_Z9_PIC_1591330423", "libName":"pic", "params":{ "height":600, "left":100, "path":":/welcome.jpg", "screen_mode":"portrait", "screen_rotate":270, "top":100, "width":800, "zIndex":9 } }, { "id":"PLAY_Z10_VIDEO_1591330410", "libName":"video", "params":{ "height":1080, "left":0, "path":"/root/yiyezi.mp4", "screen_mode":"landscape", "screen_rotate":180, "top":0, "width":1920, "zIndex":10, "decoder":true } } ], "ok":true } #End ``` --- ### 许可信息 >Qt 使用 LGPL 许可 https://www.qt.io/licensing/ 和 https://www.qt.io/features#js-6-3 >通过LGPLv3许可证选项，您可以使用基本库和Qt的某些附加库。 >只要满足LGPLv3的所有要求，LGPLv3即可保持您的应用程序源代码关闭。 >该程序所涉及 Qt Core 满足 LGPL 要求 >LOG4QT 使用 APACHE LICENSE VERSION 2.0 https://www.apache.org/licenses/LICENSE-2.0.html >SDL 与 SDL_ttf 和 SDL_image(libjpeg、libpng、zlib1) 和 SDL_net 使用许可 https://www.zlib.net/zlib_license.html >授予任何人出于任何目的使用此软件的权限，包括商业应用，并对其进行更改和重新分发 >jsoncpp 使用 MIT License >被授权人有权利使用、复制、修改、合并、出版发行、散布、再授权及贩售软件及软件的副本。 >FFmpeg 使用 GNU较小通用公共许可证(LGPL) 许可 http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html >FFmpeg License and Legal Considerations http://ffmpeg.org/legal.html >FFmpeg 在 Windows 系统许可 https://ffmpeg.zeranoe.com/builds/ >FFmpeg is the leading multimedia framework to decode, encode, transcode, mux, demux, stream, filter and play. All builds require at least Windows 7 or Mac OS X 10.10. Nightly git builds are licensed as GPL 3.0, and release build are licensed as GPL 3.0 and LGPL 3.0. LGPL 3.0 release builds can be found using the "All Builds" links. ---