K230 CanMV VDEC 模块API手册#
版权所有©2023北京嘉楠捷思信息技术有限公司
免责声明#
您购买的产品、服务或特性等应受北京嘉楠捷思信息技术有限公司（“本公司”，下同）及其关联公司的商业合同和条款的约束，本文档中描述的全部或部分产品、服务或特性可能不在您的购买或使用范围之内。除非合同另有约定，本公司不对本文档的任何陈述、信息、内容的正确性、可靠性、完整性、适销性、符合特定目的和不侵权提供任何明示或默示的声明或保证。除非另有约定，本文档仅作为使用指导参考。
由于产品版本升级或其他原因，本文档内容将可能在未经任何通知的情况下，不定期进行更新或修改。
商标声明#
、“嘉楠”和其他嘉楠商标均为北京嘉楠捷思信息技术有限公司及其关联公司的商标。本文档可能提及的其他所有商标或注册商标，由各自的所有人拥有。
版权所有 © 2023北京嘉楠捷思信息技术有限公司。保留一切权利。 非经本公司书面许可，任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部，并不得以任何形式传播。
目录#
[TOC]
前言#
概述#
本文档主要介绍K230_CanMV VDEC模块API的使用。
读者对象#
本文档（本指南）主要适用于以下人员：
技术支持工程师
软件开发工程师
缩略词定义#
简称 |
说明 |
|---|---|
VDEC |
Video Decoder |
修订记录#
文档版本号 |
修改说明 |
修改者 |
日期 |
|---|---|---|---|
V1.0 |
初版 |
孙小朋 |
2023-10-27 |
1. 概述#
此文档介绍K230_CanMV VDEC模块API，可支持264,265解码，并于vo模块绑定，将解码数据输出到vo显示。
2. API描述#
提供Decoder类，该类提供如下方法：
Decoder.__init__#
【描述】
构造函数
【语法】
decoder = Decoder(K_PT_H264)
【参数】
参数名称 |
描述 |
输入/输出 |
|---|---|---|
type |
编码类型 |
输入 |
【返回值】
返回值 |
描述 |
|---|---|
0 |
成功 |
非 0 |
失败 |
【注意】
VDEC最多支持4路解码
【举例】
无
【相关主题】
无
Decoder.Create#
【描述】
创建解码器
【语法】
decoder = Decoder(K_PT_H264)
decoder.create()
【参数】
无
【返回值】
返回值 |
描述 |
|---|---|
0 |
成功 |
非 0 |
失败 |
【举例】
无
【相关主题】
无
Decoder.destroy#
【描述】
销毁解码器
【语法】
decoder = Decoder(K_PT_H264)
decoder.destroy()
【参数】
无
【返回值】
返回值 |
描述 |
|---|---|
0 |
成功 |
非0 |
失败 |
【注意】
无
【举例】
无
Decoder.Start#
【描述】
开始编码
【语法】
decoder = Decoder(K_PT_H264)
decoder.Start()
【参数】
【返回值】
返回值 |
描述 |
|---|---|
0 |
成功 |
非0 |
失败 |
【注意】
无
【举例】
无
Decoder.decode#
【描述】
解码一帧数据
【语法】
decoder = Decoder(K_PT_H264)
decoder.decode(stream_data)
【参数】
参数名称 |
描述 |
输入/输出 |
|---|---|---|
stream_data |
编码数据 |
输入 |
【返回值】
返回值 |
描述 |
|---|---|
0 |
成功 |
非0 |
失败 |
【注意】
无
【举例】
无
Decoder.stop#
【描述】
释放一帧码流buffer
【语法】
decoder = Decoder(K_PT_H264)
decoder.stop()
【参数】
无
【返回值】
返回值 |
描述 |
|---|---|
0 |
成功 |
非0 |
失败 |
【注意】
无
【举例】
无
3. 数据结构描述#
StreamData#
【说明】
码流结构体
【定义】
class StreamData:
def __init__(self):
self.data
self.pts
【成员】
成员名称 |
描述 |
|---|---|
data |
码流数据 |
pts |
时间戳 |
【注意事项】
无
4. 示例程序#
例程1#
from media.media import *
from mpp.payload_struct import *
import media.vdecoder as vdecoder
from media.display import *
def vdec_vo_test():
#init display
display.init(LT9611_1920X1080_30FPS)
display.set_plane(400, 200, 1280, 720, PIXEL_FORMAT_YVU_PLANAR_420, DISPLAY_MIRROR_NONE, DISPLAY_CHN_VIDEO1)
#init vdec
vdec = vdecoder.Decoder(K_PT_H265)
ret = media.buffer_init()
if ret:
print("buffer_init failed")
vdec.create()
vdec.start()
#bind vdec -> vo
meida_source = media_device(VIDEO_DECODE_MOD_ID, VDEC_DEV_ID, VDEC_CHN_ID_0)
meida_sink = media_device(DISPLAY_MOD_ID, DISPLAY_DEV_ID, DISPLAY_CHN_VIDEO1)
media.create_link(meida_source, meida_sink)
#show vdec data
stream_data = StreamData()
while(1):
stream_data.data = get_one_frame_data()#get one frame
vdec.decode(stream_data)
#deinit
vdec.stop()
media.destroy_link(meida_source, meida_sink)
vdec.destroy()
time.sleep(1)
display.deinit()
vdec_vo_test()