ffmpeg(一):doc文档到底该怎么读

最近公司项目要做一些音视频直播之类的东西，开始研究ffmpeg。

下载源码后打算从ReadMe和doc开始入手。

发现readme下东西不多，只对各个库和工具做了一句话的描述。

打开doc发现下面东西蛮多，有很多的.texi后缀结尾的文件

网上查了一下，发现.texi是用的一种叫texinfo的开源文档系统，具体有什么好处，我就不瞎bb了。

要想有比较好的阅读体验，可以从网上下载一个texi2html的应用。

我是mac环境下，所以我下载下来源码后，直接./configure  -> make -> make install

就安装完成了。

接下来进入doc目录下，可以使用texi2html 文件名.texi来对单个文件进行转换，讲texi文件转为html。

由于文件比较多，为了避免一个一个文件来转换，我就写了个脚本，相当简单。贴出来，有用的上的可以参考。

filelist=`ls ~/Library/ffmpeg/doc/`for file in $filelistdo if [[ $file == *.texi ]] then        texi2html $file else        echo "ignore $file" fidone

#### 以下为最近2016年12月21日，冬至的时候发现的事情

今天又在研究ffmpeg，从官网下下来了一个windows下面的dev包和shared包 ffmpeg-3.2.2-win32-dev以及ffmpeg-3.2.2-win32-shared。

下载下来后发现里面同样有doc的目录，并且文件内容和源码目录master下的doc中是极其相似的，因此我敢大胆猜测，dev以及shared下面的doc就是根据master下的那些texi文件生成的。

也就是大概这么个情况，ffmpeg的开发人员用了一种文档编写工具（texinfo），写出来了众多的文档，放在源码目录下的doc中，也就是我们在master中所看到众多texi文件，随着开发完成，版本发布的时候，这些大神们便可以使用该texinfo工具，来很方便的将这些texi文件转成各种方便阅读的文档，例如我们看到的在dev以及shared下面的html格式。

结论就是，源码目录下的texi根本就不是给人看的，要想看ffmpeg的doc，还得移步下载各个编译好的版本（eg. dev/shared/）。

而且貌似这些文档里面讲的就是对于他的软件使用说明，并不会涉及到代码调用，感觉用处不大啊。

读到一篇叫做developer documentation的时候，我一看名字，感觉就这玩意了，结果第一行，人家就告诉我：“this document is mostly useful for internal ffmpeg developers. External developers who need to use the API in their application should refer to the API doxygen documentation in the public headers, and check the examples in doc/examples and in the source code to see how the public API is employed”。

大概就是说，本文是针对开发ffmpeg本身的文档，想要看ffmpeg的调用文档可以去看doxygen文档，以及通过doc/examples里面的例子来结合使用。

这句话果然还是有点用处，希望doxygen的文档会不辜负我的期望，等下次看完了，再回来这里补上感想。