总览

本项目是一个单模块包，其结构如下图所示：

在大多数API里，定义为字符串型的输入参数皆可以是str或bytes对象。如果用户提供了一个str对象，则会根据当前文件系统推算转换到C++后的字码，参见PyUnicode_DecodeFSDefaultAndSize。如果提供的是bytes对象，那么它就会被直接转成std::string对象。因此，如果用户需要确保输入的字符串被编码成某种固定的格式，可以通过str_argu.encode('...')来代替直接使用str_argu。

类

该模块包含四个类:

类	说明
MpegDecoder	FFMpeg解码器。用以解析视频文件，并支持按帧或按GOP读取数据。
MpegEncoder	FFMpeg编码器，用以写入新的视频文件，数据以帧为单位，逐帧写入文件中。
MpegClient	FFMpeg客户端，用以解流、解码远程视频。该类维护了一个用来同步解码器和远端实时视频流的子线程。
MpegServer	FFMpeg服务端，用于编码、推流远程视频。数据以逐帧的方式推流。该类无法独立运行，需要一个可用的视频服务软件来协助推流。

函数

以下函数作用于模块全局。

函数	说明
setGlobal	用以进行模块级的全局设置。
readme	导读函数。调用本函数会展示一篇简短的说明书，和近期更新报告。