基于RK3576的BASE64编解码

1. BASE64编解码简介

       Base64是网络上最常见的用于传输8Bit字节码的编码方式之一，Base64就是一种基于64个可打印字符来表示二进制数据的方法。EASY EAI api封装了BASE64编解码工具，方便用户对数据进行BASE64封装。

2. 快速上手

       如果您初次阅读此文档，请阅读：《入门指南/源码管理及编程介绍/源码工程管理》，按需管理自己工程源码（注：此文档必看，并建议采用【远程挂载管理】方式，否则有代码丢失风险！！！）。

2.1  源码工程下载

       先在PC虚拟机定位到nfs服务目录，再在目录中创建存放源码仓库的管理目录：

 

cd ~/nfsroot
mkdir GitHub
cd GitHub

 

       再通过git工具，在管理目录内克隆远程仓库（需要设备能对外网进行访问）

 

git clone https://github.com/EASY-EAI/EASY-EAI-Toolkit-3576.git

 

  注：

* 此处可能会因网络原因造成卡顿，请耐心等待。

* 如果实在要在gitHub网页上下载，也要把整个仓库下载下来，不能单独下载本实例对应的目录。

2.2  开发环境搭建

       通过adb shell进入板卡开发环境，如下图所示。

       通过以下命令，把nfs目录挂载上nfs服务器。

 

mount -t nfs -o nolock < nfs server ip >:< nfs path in server > /home/orin-nano/Desktop/nfs/

 

2.3  例程编译

       然后定位到nfs的挂载目录，再在目录中创建存放源码仓库的管理目录：

 

cd /home/orin-nano/Desktop/nfs/GitHub

 

        进入到对应的例程目录执行编译操作，具体命令如下所示：

 

cd EASY-EAI-Toolkit-3576/Demos/common-base64/
./build.sh

 

2.4  例程运行及效果

       执行下方命令，运行示例程序：

 

./Release/test-base64

 

       执行效果如下所示。

        API的详细说明，以及API的调用（本例程源码），详细信息见下方说明。

3. BASE64编解码API说明

3.1  引用方式

       EASY EAI api库位于本仓库的easyeai-api目录中。为方便客户在本地工程中直接调用我们的EASY EAI api库，此处列出工程中需要链接的库以及头文件等，方便用户直接添加。

描述	CMake写法	Makefile写法
api.cmake	${common_root}/base64/api.cmake	无
头文件目录	${BASE64_INCLUDE_DIRS}	-I ../../easyeai-api/common/base64
源文件目录	${BASE64_SOURCE_DIRS}	../../easyeai-api/common/base64
库文件目录	无	无
库链接参数	${BASE64_LIBS}	无

       API源代码路径为EASY-EAI-Toolkit-3576/easyeai-api/common/base64/。用户可通过源代码了解接口实现，甚至可对源码进行修改。

3.2  BASE64编码操作

       编码函数原型如下所示。

 

int32_t base64_encode(char *out_data, const char* in_data, unsigned int in_len);

 

       具体介绍如下所示。

函数名base64_encode()
头文件	easyeai-api/common/base64/base64.h
输入参数	out_data：被编码后的base64数据
	in_data：编码前的源数据
	in_len：需要对源数据进行编码部分的长度
返回值	编码后，生成的base64字符串长度
注意事项	一般编码后的数据，比编码前的数据至少要多1/3，具体大小为输入数据大小以3对齐后的4/3

3.3  BASE64解码操作

       解码函数原型如下所示。

 

int32_t base64_decode(char *out_data, unsigned int out_len, const char* encoded_string);

 

       具体介绍如下所示。

函数名base64_decode()
头文件	easyeai-api/common/base64/base64.h
输入参数	out_data：解码后的数据
	out_len：用于存放解码后数据内存的总长度
	encoded_string：待解码数据
返回值	编码后所得数据的长度
注意事项	无

4. BASE64操作API案例

       示例代码路径为EASY-EAI-Toolkit-3576/Demos/common-base64/test-base64.c。

       示例一，对字符串进行BASE64编码，然后将得出的编码数据再解码。

 

char *cStr = "my name is hao";
char base64_data[1024] = {0};
char src_string[1024] = {0};

memset(base64_data, 0, sizeof(base64_data));
base64_encode(base64_data, cStr, strlen(cStr));
printf("encode data : %sn", base64_data);
base64_decode(src_string, sizeof(src_string), base64_data);
printf("source string : %sn", src_string)

 

       示例二，验证数据中有0x00，还原出来的数据不会在0x00处断开。

 

char num_data[8] = {0x67, 0x88, 0x70, '', 'r', 'n', 0x73, 0x73};
char decode_data[8] = {0};
memset(base64_data, 0, sizeof(base64_data));
base64_encode(base64_data, num_data, sizeof(num_data));
printf("encode data : %sn", base64_data);
base64_decode(decode_data, sizeof(decode_data), base64_data);
printf("source string : 0x%02x 0x%02x 0x%02x 0x%02x 0x%02x 0x%02x 0x%02x 0x%02xn", 
	decode_data[0], decode_data[1], decode_data[2], decode_data[3],
	decode_data[4], decode_data[5], decode_data[6], decode_data[7]);

审核编辑 黄宇