ref: 7175d3c90e63d2c5adc87a92ed3625fcd5d5e1a4
parent: 24fb213d6e4e41e50af5955ab30275b1abddda8f
author: huashi <[email protected]>
date: Fri Nov 21 05:38:30 EST 2014
1.doxgen documentation format for comments in api/*.h 2. comments to wiki tools in openh264/docs/*
--- a/codec/api/svc/codec_api.h
+++ b/codec/api/svc/codec_api.h
@@ -1,4 +1,6 @@
/*!
+ *@page License
+ *
* \copy
* Copyright (c) 2013, Cisco Systems
* All rights reserved.
@@ -50,48 +52,298 @@
#define EXTAPI
#endif
+/**
+ * @file codec_api.h
+*/
+
+/**
+ * @page Overview
+ * * This page is for openh264 codec API usage.
+ * * For how to use the encoder,please refer to page UsageExampleForEncoder
+ * * For how to use the decoder,please refer to page UsageExampleForDecoder
+ * * For more detail about ISVEncoder,please refer to page ISVCEnoder
+ * * For more detail about ISVDecoder,please refer to page ISVCDecoder
+*/
+
+/**
+ * @page DecoderUsageExample
+ *
+ * @brief
+ * * An example for using the decoder
+ *
+ * Step 1:decoder declaration
+ * @code
+ *
+ * //decoder declaration
+ * ISVCDecoder *pSvcDecoder;
+ * //input: encoded bitstream start position; should include start code prefix
+ * unsigned char *pBuf =...;
+ * //input: encoded bit stream length; should include the size of start code prefix
+ * int iSize =...;
+ * //output: [0~2] for Y,U,V buffer
+ * unsigned char *pData[3] =...;
+ * //in-out: declare and initialize the output buffer info
+ * SBufferInfo sDstBufInfo;
+ * memset(&sDstBufInfo, 0, sizeof(SBufferInfo));
+ *
+ * @endcode
+ *
+ * Step 2:decoder creation
+ * @code
+ * CreateDecoder(pSvcDecoder);
+ * @endcode
+ *
+ * Step 3:declare required parameter
+ * @code
+ * SDecodingParam sDecParam = {0};+ * sDecParam.sVideoProperty.eVideoBsType = VIDEO_BITSTREAM_AVC;
+ * @endcode
+ *
+ * Step 4:initialize the parameter and decoder context, allocate memory
+ * @code
+ * Initialize(&sDecParam);
+ * @endcode
+ *
+ * Step 5:do actual decoding process in slice level;
+ * this can be done in a loop until data ends
+ * @code
+ * iRet = DecodeFrame2(pBuf, iSize, pData, &sDstBufInfo);
+ * //decode failed
+ * If (iRet != 0){+ * RequestIDR or something like that.
+ * }
+ * //pData can be used for render.
+ * if (sDstBufInfo.iBufferStatus==1){+ * output pData[0], pData[1], pData[2];
+ * }
+ * @endcode
+ *
+ * Step 6:uninitialize the decoder and memory free
+ * @code
+ * Uninitialize();
+ * @endcode
+ *
+ * Step 7:destroy the decoder
+ * @code
+ * DestroyDecoder();
+ * @endcode
+ *
+*/
+
+/**
+ * @page EncoderUsageExample1
+ *
+ * @brief
+ * * An example for using encoder with basic parameter
+ *
+ * Step1:setup encoder
+ * @code
+ * int rv = WelsCreateSVCEncoder (&encoder_);
+ * ASSERT_EQ (0, rv);
+ * ASSERT_TRUE (encoder_ != NULL);
+ * @endcode
+ *
+ * Step2:initilize with basic parameter
+ * @code
+ * SEncParamBase param;
+ * memset (¶m, 0, sizeof (SEncParamBase));
+ * param.iUsageType = usageType;
+ * param.fMaxFrameRate = frameRate;
+ * param.iPicWidth = width;
+ * param.iPicHeight = height;
+ * param.iTargetBitrate = 5000000;
+ * param.iInputCsp = videoFormatI420;
+ * encoder_->Initialize (¶m);
+ * @endcode
+ *
+ * Step3:set option, set option during encoding process
+ * @code
+ * encoder_->SetOption (ENCODER_OPTION_TRACE_LEVEL, &g_LevelSetting);
+ * @endcode
+ *
+ * Step4: encode and store ouput bistream
+ * @code
+ * int frameSize = width * height * 3 / 2;
+ * BufferedData buf;
+ * buf.SetLength (frameSize);
+ * ASSERT_TRUE (buf.Length() == (size_t)frameSize);
+ * SFrameBSInfo info;
+ * memset (&info, 0, sizeof (SFrameBSInfo));
+ * SSourcePicture pic;
+ * memset (&pic, 0, sizeof (SsourcePicture));
+ * pic.iPicWidth = width;
+ * pic.iPicHeight = height;
+ * pic.iColorFormat = videoFormatI420;
+ * pic.iStride[0] = pic.iPicWidth;
+ * pic.iStride[1] = pic.iStride[2] = pic.iPicWidth >> 1;
+ * pic.pData[0] = buf.data();
+ * pic.pData[1] = pic.pData[0] + width * height;
+ * pic.pData[2] = pic.pData[1] + (width * height >> 2);
+ * for(int num = 0;num<total_num;num++) {+ * //prepare input data
+ * rv = encoder_->EncodeFrame (&pic, &info);
+ * ASSERT_TRUE (rv == cmResultSuccess);
+ * if (info.eFrameType != videoFrameTypeSkip && cbk != NULL) {+ * //output bitstream
+ * }
+ * }
+ * @endcode
+ *
+ * Step5:teardown encoder
+ * @code
+ * if (encoder_) {+ * encoder_->Uninitialize();
+ * WelsDestroySVCEncoder (encoder_);
+ * }
+ * @endcode
+ *
+ */
+
+/**
+ * @page EncoderUsageExample2
+ *
+ * @brief
+ * * An example for using the encoder with extension parameter.
+ * * The same operation on Step 1,3,4,5 with Example-1
+ *
+ * Step 2:initialize with extension parameter
+ * @code
+ * SEncParamExt param;
+ * encoder->GetDefaultParams (¶m);
+ * param.iUsageType = usageType;
+ * param.fMaxFrameRate = frameRate;
+ * param.iPicWidth = width;
+ * param.iPicHeight = height;
+ * param.iTargetBitrate = 5000000;
+ * param.iInputCsp = videoFormatI420;
+ * param.bEnableDenoise = denoise;
+ * param.iSpatialLayerNum = layers;
+ * //SM_DYN_SLICE don't support multi-thread now
+ * if (sliceMode != SM_SINGLE_SLICE && sliceMode != SM_DYN_SLICE)
+ * param.iMultipleThreadIdc = 2;
+ *
+ * for (int i = 0; i < param.iSpatialLayerNum; i++) {+ * param.sSpatialLayers[i].iVideoWidth = width >> (param.iSpatialLayerNum - 1 - i);
+ * param.sSpatialLayers[i].iVideoHeight = height >> (param.iSpatialLayerNum - 1 - i);
+ * param.sSpatialLayers[i].fFrameRate = frameRate;
+ * param.sSpatialLayers[i].iSpatialBitrate = param.iTargetBitrate;
+ *
+ * param.sSpatialLayers[i].sSliceCfg.uiSliceMode = sliceMode;
+ * if (sliceMode == SM_DYN_SLICE) {+ * param.sSpatialLayers[i].sSliceCfg.sSliceArgument.uiSliceSizeConstraint = 600;
+ * param.uiMaxNalSize = 1500;
+ * }
+ * }
+ * param.iTargetBitrate *= param.iSpatialLayerNum;
+ * encoder_->InitializeExt (¶m);
+ *
+ * @endcode
+ */
+
+
+
+
#ifdef __cplusplus
+/**
+* @brief Endocder definition
+*/
class ISVCEncoder {public:
- /*
- * return: CM_RETURN: 0 - success; otherwise - failed;
- */
+ /**
+ * @brief Initialize the encoder
+ * @param pParam basic encoder parameter
+ * @return CM_RETURN: 0 - success; otherwise - failed;
+ */
virtual int EXTAPI Initialize (const SEncParamBase* pParam) = 0;
+
+ /**
+ * @brief Initilaize encoder by using extension parameters.
+ * @param pParam extension parameter for encoder
+ * @return CM_RETURN: 0 - success; otherwise - failed;
+ */
virtual int EXTAPI InitializeExt (const SEncParamExt* pParam) = 0;
+ /**
+ * @brief Get the default extension parameters.
+ * If you want to change some parameters of encoder, firstly you need to get the default encoding parameters,
+ * after that you can change part of parameters you want to.
+ * @param pParam extension parameter for encoder
+ * @return CM_RETURN: 0 - success; otherwise - failed;
+ * */
virtual int EXTAPI GetDefaultParams (SEncParamExt* pParam) = 0;
-
+ /// uninitialize the encoder
virtual int EXTAPI Uninitialize() = 0;
- /*
- * return: 0 - success; otherwise -failed;
- */
+ /**
+ * @brief Encode one frame
+ * @param kpSrcPic the pointer to the source luminance plane
+ * chrominance data:
+ * CbData = kpSrc + m_iMaxPicWidth * m_iMaxPicHeight;
+ * CrData = CbData + (m_iMaxPicWidth * m_iMaxPicHeight)/4;
+ * the application calling this interface needs to ensure the data validation between the location
+ * @param pBsInfo output bit stream
+ * @return 0 - success; otherwise -failed;
+ */
virtual int EXTAPI EncodeFrame (const SSourcePicture* kpSrcPic, SFrameBSInfo* pBsInfo) = 0;
- /*
- * return: 0 - success; otherwise - failed;
- */
+
+ /**
+ * @brief Encode the parameters from output bit stream
+ * @param pBsInfo output bit stream
+ * @return 0 - success; otherwise - failed;
+ */
virtual int EXTAPI EncodeParameterSets (SFrameBSInfo* pBsInfo) = 0;
- /*
- * return: 0 - success; otherwise - failed;
- */
+
+ /**
+ * @brief Force encoder to encoder frame as IDR if bIDR set as true
+ * @param bIDR true: force encoder to encode frame as IDR frame;false, return 1 and nothing to do
+ * @return 0 - success; otherwise - failed;
+ */
virtual int EXTAPI ForceIntraFrame (bool bIDR) = 0;
- /************************************************************************
- * InDataFormat, IDRInterval, SVC Encode Param, Frame Rate, Bitrate,..
- ************************************************************************/
- /*
- * return: CM_RETURN: 0 - success; otherwise - failed;
- */
+ /**
+ * @brief Set option for encoder, detail option type, please refer to enumurate ENCODER_OPTION.
+ * @param pOption option for encoder such as InDataFormat, IDRInterval, SVC Encode Param, Frame Rate, Bitrate,...
+ * @return CM_RETURN: 0 - success; otherwise - failed;
+ */
virtual int EXTAPI SetOption (ENCODER_OPTION eOptionId, void* pOption) = 0;
+
+ /**
+ * @brief Set option for encoder, detail option type, please refer to enumurate ENCODER_OPTION.
+ * @param pOption option for encoder such as InDataFormat, IDRInterval, SVC Encode Param, Frame Rate, Bitrate,...
+ * @return CM_RETURN: 0 - success; otherwise - failed;
+ */
virtual int EXTAPI GetOption (ENCODER_OPTION eOptionId, void* pOption) = 0;
virtual ~ISVCEncoder() {}};
+
+
+/**
+* @brief Decoder definition
+*/
class ISVCDecoder {public:
+
+ /**
+ * @brief Initilaize decoder
+ * @param pParam parameter for decoder
+ * @return 0 - success; otherwise - failed;
+ */
virtual long EXTAPI Initialize (const SDecodingParam* pParam) = 0;
+
+ /// Uninitialize the decoder
virtual long EXTAPI Uninitialize() = 0;
+ /**
+ * @brief Decode one frame
+ * @param pSrc the h264 stream to be decoded
+ * @param iSrcLen the length of h264 stream
+ * @param ppDst buffer pointer of decoded data (YUV)
+ * @param pStride output stride
+ * @param iWidth output width
+ * @param iHeight output height
+ * @return 0 - success; otherwise -failed;
+ */
virtual DECODING_STATE EXTAPI DecodeFrame (const unsigned char* pSrc,
const int iSrcLen,
unsigned char** ppDst,
@@ -98,25 +350,47 @@
int* pStride,
int& iWidth,
int& iHeight) = 0;
- /*
- * return: 0 - success; otherwise -failed;
- */
+
+ /**
+ * @brief For slice level DecodeFrame2() (4 parameters input),
+ * whatever the function return value is, the output data
+ * of I420 format will only be available when pDstInfo->iBufferStatus == 1,.
+ * (e.g., in multi-slice cases, only when the whole picture
+ * is completely reconstructed, this variable would be set equal to 1.)
+ * @param pSrc the h264 stream to be decoded
+ * @param iSrcLen the length of h264 stream
+ * @param ppDst buffer pointer of decoded data (YUV)
+ * @param pDstInfo information provided to API(width, height, etc.)
+ * @return 0 - success; otherwise -failed;
+ */
virtual DECODING_STATE EXTAPI DecodeFrame2 (const unsigned char* pSrc,
const int iSrcLen,
unsigned char** ppDst,
SBufferInfo* pDstInfo) = 0;
- /*
- * This function parse input bitstream only, and rewrite possible SVC syntax to AVC syntax
- * return: 0 - success; otherwise -failed;
- */
+ /**
+ * @brief This function parse input bitstream only, and rewrite possible SVC syntax to AVC syntax
+ * @param pSrc the h264 stream to be decoded
+ * @param iSrcLen the length of h264 stream
+ * @param pDstInfo bit stream info
+ * @return 0 - success; otherwise -failed;
+ */
virtual DECODING_STATE EXTAPI DecodeParser (const unsigned char* pSrc,
const int iSrcLen,
SParserBsInfo* pDstInfo) = 0;
- /*
- * this API does not work for now!! This is for future use to support non-I420 color format output.
- */
+ /**
+ * @brief This API does not work for now!! This is for future use to support non-I420 color format output.
+ * @param pSrc the h264 stream to be decoded
+ * @param iSrcLen the length of h264 stream
+ * @param pDst buffer pointer of decoded data (YUV)
+ * @param iDstStride output stride
+ * @param iDstLen bit stream info
+ * @param iWidth output width
+ * @param iHeight output height
+ * @param iColorFormat output color format
+ * @return to do ...
+ */
virtual DECODING_STATE EXTAPI DecodeFrameEx (const unsigned char* pSrc,
const int iSrcLen,
unsigned char* pDst,
@@ -126,10 +400,18 @@
int& iHeight,
int& iColorFormat) = 0;
- /*************************************************************************
- * OutDataFormat, Eos Flag, EC method, ...
- *************************************************************************/
+ /**
+ * @brief Set option for decoder, detail option type, please refer to enumurate DECODER_OPTION.
+ * @param pOption option for decoder such as OutDataFormat, Eos Flag, EC method, ...
+ * @return CM_RETURN: 0 - success; otherwise - failed;
+ */
virtual long EXTAPI SetOption (DECODER_OPTION eOptionId, void* pOption) = 0;
+
+ /**
+ * @brief Get option for decoder, detail option type, please refer to enumurate DECODER_OPTION.
+ * @param pOption option for decoder such as OutDataFormat, Eos Flag, EC method, ...
+ * @return CM_RETURN: 0 - success; otherwise - failed;
+ */
virtual long EXTAPI GetOption (DECODER_OPTION eOptionId, void* pOption) = 0;
virtual ~ISVCDecoder() {}};
@@ -197,11 +479,38 @@
typedef void (*WelsTraceCallback) (void* ctx, int level, const char* string);
+/** @brief Create encoder
+ * @param ppEncoder encoder
+ * @return 0 - success; otherwise - failed;
+*/
int WelsCreateSVCEncoder (ISVCEncoder** ppEncoder);
+
+
+/** @brief Destroy encoder
+* @param pEncoder encoder
+ * @return void
+*/
void WelsDestroySVCEncoder (ISVCEncoder* pEncoder);
+
+/** @brief Get the capability of decoder
+ * @param pDecCapability decoder capability
+ * @return 0 - success; otherwise - failed;
+*/
int WelsGetDecoderCapability (SDecoderCapability* pDecCapability);
+
+
+/** @brief Create decoder
+ * @param ppDecoder decoder
+ * @return 0 - success; otherwise - failed;
+*/
long WelsCreateDecoder (ISVCDecoder** ppDecoder);
+
+
+/** @brief Destroy decoder
+ * @param pDecoder decoder
+ * @return void
+*/
void WelsDestroyDecoder (ISVCDecoder* pDecoder);
#ifdef __cplusplus
--- a/codec/api/svc/codec_app_def.h
+++ b/codec/api/svc/codec_app_def.h
@@ -30,9 +30,15 @@
*
*/
+
+
#ifndef WELS_VIDEO_CODEC_APPLICATION_DEFINITION_H__
#define WELS_VIDEO_CODEC_APPLICATION_DEFINITION_H__
-////////////////Data and /or structures introduced in Cisco OpenH264 application////////////////
+/**
+ * @file codec_app_def.h
+ * @brief Data and /or structures introduced in Cisco OpenH264 application
+*/
+
#include "codec_def.h"
/* Constants */
#define MAX_TEMPORAL_LAYER_NUM 4
@@ -40,98 +46,113 @@
#define MAX_QUALITY_LAYER_NUM 4
#define MAX_LAYER_NUM_OF_FRAME 128
-#define MAX_NAL_UNITS_IN_LAYER 128 // predetermined here, adjust it later if need
+#define MAX_NAL_UNITS_IN_LAYER 128 ///< predetermined here, adjust it later if need
#define MAX_RTP_PAYLOAD_LEN 1000
#define AVERAGE_RTP_PAYLOAD_LEN 800
-#define SAVED_NALUNIT_NUM_TMP ( (MAX_SPATIAL_LAYER_NUM*MAX_QUALITY_LAYER_NUM) + 1 + MAX_SPATIAL_LAYER_NUM ) //SPS/PPS + SEI/SSEI + PADDING_NAL
+#define SAVED_NALUNIT_NUM_TMP ( (MAX_SPATIAL_LAYER_NUM*MAX_QUALITY_LAYER_NUM) + 1 + MAX_SPATIAL_LAYER_NUM ) ///< SPS/PPS + SEI/SSEI + PADDING_NAL
#define MAX_SLICES_NUM_TMP ( ( MAX_NAL_UNITS_IN_LAYER - SAVED_NALUNIT_NUM_TMP ) / 3 )
-#define AUTO_REF_PIC_COUNT -1 // encoder selects the number of reference frame automatically
-#define UNSPECIFIED_BIT_RATE 0 //
+#define AUTO_REF_PIC_COUNT -1 ///< encoder selects the number of reference frame automatically
+#define UNSPECIFIED_BIT_RATE 0 ///< to do: add detail comment
+
+/**
+* @brief Decoding status
+*/
typedef enum {- /* Errors derived from bitstream parsing */
- dsErrorFree = 0x00, /* Bitstream error-free */
- dsFramePending = 0x01, /* Need more throughput to generate a frame output, */
- dsRefLost = 0x02, /* layer lost at reference frame with temporal id 0 */
- dsBitstreamError = 0x04, /* Error bitstreams(maybe broken internal frame) the decoder cared */
- dsDepLayerLost = 0x08, /* Dependented layer is ever lost */
- dsNoParamSets = 0x10, /* No parameter set NALs involved */
- dsDataErrorConcealed = 0x20, /* current data Error concealed specified */
+ /**
+ * Errors derived from bitstream parsing
+ */
+ dsErrorFree = 0x00, ///< bit stream error-free
+ dsFramePending = 0x01, ///< need more throughput to generate a frame output,
+ dsRefLost = 0x02, ///< layer lost at reference frame with temporal id 0
+ dsBitstreamError = 0x04, ///< error bitstreams(maybe broken internal frame) the decoder cared
+ dsDepLayerLost = 0x08, ///< dependented layer is ever lost
+ dsNoParamSets = 0x10, ///< no parameter set NALs involved
+ dsDataErrorConcealed = 0x20, ///< current data error concealed specified
- /* Errors derived from logic level */
- dsInvalidArgument = 0x1000, /* Invalid argument specified */
- dsInitialOptExpected = 0x2000, /* Initializing operation is expected */
- dsOutOfMemory = 0x4000, /* Out of memory due to new request */
- /* ANY OTHERS? */
- dsDstBufNeedExpand = 0x8000 /* Actual picture size exceeds size of dst pBuffer feed in decoder, so need expand its size */
+ /**
+ * Errors derived from logic level
+ */
+ dsInvalidArgument = 0x1000, ///< invalid argument specified
+ dsInitialOptExpected = 0x2000, ///< initializing operation is expected
+ dsOutOfMemory = 0x4000, ///< out of memory due to new request
+ /**
+ * ANY OTHERS?
+ */
+ dsDstBufNeedExpan = 0x8000 ///< actual picture size exceeds size of dst pBuffer feed in decoder, so need expand its size
} DECODING_STATE;
-/* Option types introduced in SVC encoder application */
+/**
+* @brief Option types introduced in SVC encoder application
+*/
typedef enum {ENCODER_OPTION_DATAFORMAT = 0,
- ENCODER_OPTION_IDR_INTERVAL,
- ENCODER_OPTION_SVC_ENCODE_PARAM_BASE,
- ENCODER_OPTION_SVC_ENCODE_PARAM_EXT,
- ENCODER_OPTION_FRAME_RATE,
+ ENCODER_OPTION_IDR_INTERVAL, ///< IDR period,0/-1 means no Intra period (only the first frame); lager than 0 means the desired IDR period, must be multiple of (2^temporal_layer)
+ ENCODER_OPTION_SVC_ENCODE_PARAM_BASE, ///< structure of Base Param
+ ENCODER_OPTION_SVC_ENCODE_PARAM_EXT, ///< structure of Extension Param
+ ENCODER_OPTION_FRAME_RATE, ///< maximal input frame rate, current supported range: MAX_FRAME_RATE = 30,MIN_FRAME_RATE = 1
ENCODER_OPTION_BITRATE,
ENCODER_OPTION_MAX_BITRATE,
ENCODER_OPTION_INTER_SPATIAL_PRED,
ENCODER_OPTION_RC_MODE,
- ENCODER_PADDING_PADDING,
+ ENCODER_PADDING_PADDING, ///< 0:disable padding;1:padding
- ENCODER_OPTION_PROFILE,
- ENCODER_OPTION_LEVEL,
- ENCODER_OPTION_NUMBER_REF,
- ENCODER_OPTION_DELIVERY_STATUS,
+ ENCODER_OPTION_PROFILE, ///< assgin the profile for each layer
+ ENCODER_OPTION_LEVEL, ///< assgin the level for each layer
+ ENCODER_OPTION_NUMBER_REF, ///< the number of refererence frame
+ ENCODER_OPTION_DELIVERY_STATUS, ///< the delivery info which is a feedback from app level
ENCODER_LTR_RECOVERY_REQUEST,
ENCODER_LTR_MARKING_FEEDBACK,
ENCODER_LTR_MARKING_PERIOD,
- ENCODER_OPTION_LTR,
+ ENCODER_OPTION_LTR, ///< 0:disable LTR;larger than 0 enable LTR; LTR number is fixed to be 2 in current encoder
ENCODER_OPTION_COMPLEXITY,
- ENCODER_OPTION_ENABLE_SSEI, //enable SSEI: true--enable ssei; false--disable ssei
- ENCODER_OPTION_ENABLE_PREFIX_NAL_ADDING, //enable prefix: true--enable prefix; false--disable prefix
- ENCODER_OPTION_ENABLE_SPS_PPS_ID_ADDITION, //enable pSps/pPps id addition: true--enable pSps/pPps id; false--disable pSps/pPps id addistion
+ ENCODER_OPTION_ENABLE_SSEI, ///< enable SSEI: true--enable ssei; false--disable ssei
+ ENCODER_OPTION_ENABLE_PREFIX_NAL_ADDING, ///< enable prefix: true--enable prefix; false--disable prefix
+ ENCODER_OPTION_ENABLE_SPS_PPS_ID_ADDITION, ///< enable pSps/pPps id addition: true--enable pSps/pPps id; false--disable pSps/pPps id addistion
ENCODER_OPTION_CURRENT_PATH,
- ENCODER_OPTION_DUMP_FILE,
- ENCODER_OPTION_TRACE_LEVEL,
- ENCODER_OPTION_TRACE_CALLBACK, // a void (*)(void* context, int level, const char* message) function which receives log messages
- ENCODER_OPTION_TRACE_CALLBACK_CONTEXT,
+ ENCODER_OPTION_DUMP_FILE, ///< dump layer reconstruct frame to a specified file
+ ENCODER_OPTION_TRACE_LEVEL, ///< trace info based on the trace level
+ ENCODER_OPTION_TRACE_CALLBACK, ///< a void (*)(void* context, int level, const char* message) function which receives log messages
+ ENCODER_OPTION_TRACE_CALLBACK_CONTEXT, ///< context info of trace callback
- ENCODER_OPTION_GET_STATISTICS, //read only
- ENCODER_OPTION_STATISTICS_LOG_INTERVAL, // log interval in milliseconds
+ ENCODER_OPTION_GET_STATISTICS, ///< read only
+ ENCODER_OPTION_STATISTICS_LOG_INTERVAL, ///< log interval in millisecond
- // advanced algorithmetic settings
- ENCODER_OPTION_IS_LOSSLESS_LINK
+ ENCODER_OPTION_IS_LOSSLESS_LINK ///< advanced algorithmetic settings
} ENCODER_OPTION;
-/* Option types introduced in decoder application */
+/**
+* @brief Option types introduced in decoder application
+*/
typedef enum {- DECODER_OPTION_DATAFORMAT = 0, /* Set color space of decoding output frame */
- DECODER_OPTION_END_OF_STREAM, /* Indicate bitstream of the final frame to be decoded */
- DECODER_OPTION_VCL_NAL, //feedback whether or not have VCL NAL in current AU for application layer
- DECODER_OPTION_TEMPORAL_ID, //feedback temporal id for application layer
- DECODER_OPTION_FRAME_NUM, //feedback current decoded frame number
- DECODER_OPTION_IDR_PIC_ID, // feedback current frame belong to which IDR period
- DECODER_OPTION_LTR_MARKING_FLAG, // feedback wether current frame mark a LTR
- DECODER_OPTION_LTR_MARKED_FRAME_NUM, // feedback frame num marked by current Frame
- DECODER_OPTION_ERROR_CON_IDC, //not finished yet, indicate decoder error concealment status, in progress
+ DECODER_OPTION_DATAFORMAT = 0, ///< color format, now supports 23 only (I420)
+ DECODER_OPTION_END_OF_STREAM, ///< end of stream flag
+ DECODER_OPTION_VCL_NAL, ///< feedback whether or not have VCL NAL in current AU for application layer
+ DECODER_OPTION_TEMPORAL_ID, ///< feedback temporal id for application layer
+ DECODER_OPTION_FRAME_NUM, ///< feedback current decoded frame number
+ DECODER_OPTION_IDR_PIC_ID, ///< feedback current frame belong to which IDR period
+ DECODER_OPTION_LTR_MARKING_FLAG, ///< feedback wether current frame mark a LTR
+ DECODER_OPTION_LTR_MARKED_FRAME_NUM, ///< feedback frame num marked by current Frame
+ DECODER_OPTION_ERROR_CON_IDC, ///< not finished yet, indicate decoder error concealment status, in progress
DECODER_OPTION_TRACE_LEVEL,
- DECODER_OPTION_TRACE_CALLBACK, // a void (*)(void* context, int level, const char* message) function which receives log messages
- DECODER_OPTION_TRACE_CALLBACK_CONTEXT,
+ DECODER_OPTION_TRACE_CALLBACK, ///< a void (*)(void* context, int level, const char* message) function which receives log messages
+ DECODER_OPTION_TRACE_CALLBACK_CONTEXT,///< context info of trace callbac
DECODER_OPTION_GET_STATISTICS
} DECODER_OPTION;
-//enuerate the types of error concealment methods
+/**
+* @brief Enumerate the type of error concealment methods
+*/
typedef enum {ERROR_CON_DISABLE = 0,
ERROR_CON_FRAME_COPY,
@@ -140,19 +161,26 @@
ERROR_CON_SLICE_COPY_CROSS_IDR,
ERROR_CON_SLICE_COPY_CROSS_IDR_FREEZE_RES_CHANGE
} ERROR_CON_IDC;
-
-typedef enum { //feedback that whether or not have VCL NAL in current AU+/**
+* @brief Feedback that whether or not have VCL NAL in current AU
+*/
+typedef enum {FEEDBACK_NON_VCL_NAL = 0,
FEEDBACK_VCL_NAL,
FEEDBACK_UNKNOWN_NAL
} FEEDBACK_VCL_NAL_IN_AU;
-/* Type of layer being encoded */
+/**
+* @brief Type of layer being encoded
+*/
typedef enum {NON_VIDEO_CODING_LAYER = 0,
VIDEO_CODING_LAYER = 1
} LAYER_TYPE;
+/**
+* @brief Spatial layer num
+*/
typedef enum {SPATIAL_LAYER_0 = 0,
SPATIAL_LAYER_1 = 1,
@@ -161,7 +189,9 @@
SPATIAL_LAYER_ALL = 4
} LAYER_NUM;
-//enumerate the type of video bitstream which is provided to decoder
+/**
+* @brief Enumerate the type of video bitstream which is provided to decoder
+*/
typedef enum {VIDEO_BITSTREAM_AVC = 0,
VIDEO_BITSTREAM_SVC = 1,
@@ -168,6 +198,9 @@
VIDEO_BITSTREAM_DEFAULT = VIDEO_BITSTREAM_SVC
} VIDEO_BITSTREAM_TYPE;
+/**
+* @brief Enumerate the type of key frame request
+*/
typedef enum {NO_RECOVERY_REQUSET = 0,
LTR_RECOVERY_REQUEST = 1,
@@ -177,56 +210,78 @@
LTR_MARKING_FAILED = 5
} KEY_FRAME_REQUEST_TYPE;
+/**
+* @brief Structure for LTR recover request
+*/
typedef struct {- unsigned int uiFeedbackType; //IDR request or LTR recovery request
- unsigned int uiIDRPicId; // distinguish request from different IDR
- int iLastCorrectFrameNum;
- int iCurrentFrameNum; //specify current decoder frame_num.
+ unsigned int uiFeedbackType; ///< IDR request or LTR recovery request
+ unsigned int uiIDRPicId; ///< distinguish request from different IDR
+ int iLastCorrectFrameNum;
+ int iCurrentFrameNum; ///< specify current decoder frame_num.
} SLTRRecoverRequest;
+/**
+* @brief Structure for LTR marking feedback
+*/
typedef struct {- unsigned int uiFeedbackType; //mark failed or successful
- unsigned int uiIDRPicId; // distinguish request from different IDR
- int iLTRFrameNum; //specify current decoder frame_num
+ unsigned int uiFeedbackType; ///< mark failed or successful
+ unsigned int uiIDRPicId; ///< distinguish request from different IDR
+ int iLTRFrameNum; ///< specify current decoder frame_num
} SLTRMarkingFeedback;
+/**
+* @brief Structure for LTR configuration
+*/
typedef struct {- bool bEnableLongTermReference; // 1: on, 0: off
- int iLTRRefNum; //TODO: not supported to set it arbitrary yet
+ bool bEnableLongTermReference; ///< 1: on, 0: off
+ int iLTRRefNum; ///< TODO: not supported to set it arbitrary yet
} SLTRConfig;
+
+/**
+* @brief Structure for slice argument
+*/
typedef struct {unsigned int
- uiSliceMbNum[MAX_SLICES_NUM_TMP]; //here we use a tmp fixed value since MAX_SLICES_NUM is not defined here and its definition may be changed;
- unsigned int uiSliceNum;
- unsigned int uiSliceSizeConstraint;
-} SSliceArgument;//not all the elements in this argument will be used, how it will be used depends on uiSliceMode; see below
+ uiSliceMbNum[MAX_SLICES_NUM_TMP]; ///< only used when uiSliceMode=2;here we use a tmp fixed value since MAX_SLICES_NUM is not defined here and its definition may be changed;
+ unsigned int uiSliceNum; ///< only used when uiSliceMode=1
+ unsigned int uiSliceSizeConstraint; ///< only used when uiSliceMode=4
+} SSliceArgument; ///< not all the elements in this argument will be used, how it will be used depends on uiSliceMode; please refer to SliceModeEnum
+/**
+* @brief Enumerate the type of slice mode
+*/
typedef enum {- SM_SINGLE_SLICE = 0, // | SliceNum==1
- SM_FIXEDSLCNUM_SLICE = 1, // | according to SliceNum | Enabled dynamic slicing for multi-thread
- SM_RASTER_SLICE = 2, // | according to SlicesAssign | Need input of MB numbers each slice. In addition, if other constraint in SSliceArgument is presented, need to follow the constraints. Typically if MB num and slice size are both constrained, re-encoding may be involved.
- SM_ROWMB_SLICE = 3, // | according to PictureMBHeight | Typical of single row of mbs each slice?+ slice size constraint which including re-encoding
- SM_DYN_SLICE = 4, // | according to SliceSize | Dynamic slicing (have no idea about slice_nums until encoding current frame)
- SM_AUTO_SLICE = 5, // | according to thread number
+ SM_SINGLE_SLICE = 0, ///< | SliceNum==1
+ SM_FIXEDSLCNUM_SLICE = 1, ///< | according to SliceNum | enabled dynamic slicing for multi-thread
+ SM_RASTER_SLICE = 2, ///< | according to SlicesAssign | need input of MB numbers each slice. In addition, if other constraint in SSliceArgument is presented, need to follow the constraints. Typically if MB num and slice size are both constrained, re-encoding may be involved.
+ SM_ROWMB_SLICE = 3, ///< | according to PictureMBHeight | typical of single row of mbs each slice + slice size constraint which including re-encoding
+ SM_DYN_SLICE = 4, ///< | according to SliceSize | dynamic slicing (have no idea about slice_nums until encoding current frame)
+ SM_AUTO_SLICE = 5, ///< | according to thread number
SM_RESERVED = 6
} SliceModeEnum;
+/**
+* @brief Enumerate the type of rate control mode
+*/
typedef enum {- RC_QUALITY_MODE = 0, //Quality mode
- RC_BITRATE_MODE = 1, //Bitrate mode
- RC_BUFFERBASED_MODE = 2,//no bitrate control,only using buffer status,adjust the video quality
- RC_OFF_MODE = -1 // rate control off mode
+ RC_QUALITY_MODE = 0, ///< quality mode
+ RC_BITRATE_MODE = 1, ///< bitrate mode
+ RC_BUFFERBASED_MODE = 2, ///< no bitrate control,only using buffer status,adjust the video quality
+ RC_OFF_MODE = -1 ///< rate control off mode
} RC_MODES;
+/**
+* @brief Enumerate the type of profile id
+*/
typedef enum {- PRO_UNKNOWN = 0,
+ PRO_UNKNOWN = 0,
PRO_BASELINE = 66,
PRO_MAIN = 77,
PRO_EXTENDED = 88,
PRO_HIGH = 100,
- PRO_HIGH10 = 110,
- PRO_HIGH422 = 122,
- PRO_HIGH444 = 144,
+ PRO_HIGH10 = 110,
+ PRO_HIGH422 = 122,
+ PRO_HIGH444 = 144,
PRO_CAVLC444 = 244,
PRO_SCALABLE_BASELINE = 83,
@@ -233,6 +288,9 @@
PRO_SCALABLE_HIGH = 86
} EProfileIdc;
+/**
+* @brief Enumerate the type of level id
+*/
typedef enum {LEVEL_UNKNOWN,
LEVEL_1_0,
@@ -254,136 +312,158 @@
LEVEL_5_2
} ELevelIdc;
-
+/**
+* @brief Enumerate the type of wels log
+*/
enum {- WELS_LOG_QUIET = 0x00, // Quiet mode
- WELS_LOG_ERROR = 1 << 0, // Error log iLevel
- WELS_LOG_WARNING = 1 << 1, // Warning log iLevel
- WELS_LOG_INFO = 1 << 2, // Information log iLevel
- WELS_LOG_DEBUG = 1 << 3, // Debug log, critical algo log
- WELS_LOG_DETAIL = 1 << 4, // per packet/frame log
- WELS_LOG_RESV = 1 << 5, // Resversed log iLevel
+ WELS_LOG_QUIET = 0x00, ///< quiet mode
+ WELS_LOG_ERROR = 1 << 0, ///< error log iLevel
+ WELS_LOG_WARNING = 1 << 1, ///< Warning log iLevel
+ WELS_LOG_INFO = 1 << 2, ///< information log iLevel
+ WELS_LOG_DEBUG = 1 << 3, ///< debug log, critical algo log
+ WELS_LOG_DETAIL = 1 << 4, ///< per packet/frame log
+ WELS_LOG_RESV = 1 << 5, ///< resversed log iLevel
WELS_LOG_LEVEL_COUNT = 6,
- WELS_LOG_DEFAULT = WELS_LOG_DEBUG // Default log iLevel in Wels codec
+ WELS_LOG_DEFAULT = WELS_LOG_DEBUG ///< default log iLevel in Wels codec
};
+/**
+* @brief Structure for slice configuration
+*/
typedef struct {- SliceModeEnum uiSliceMode; //by default, uiSliceMode will be SM_SINGLE_SLICE
+ SliceModeEnum uiSliceMode; ///< by default, uiSliceMode will be SM_SINGLE_SLICE
SSliceArgument sSliceArgument;
} SSliceConfig;
-
+/**
+* @brief Structure for spatial layer configuration
+*/
typedef struct {- int iVideoWidth; // video size in cx specified for a layer
- int iVideoHeight; // video size in cy specified for a layer
- float fFrameRate; // frame rate specified for a layer
- int iSpatialBitrate; // target bitrate for a spatial layer
- int iMaxSpatialBitrate;
- EProfileIdc uiProfileIdc; // value of profile IDC (PRO_UNKNOWN for auto-detection)
- ELevelIdc uiLevelIdc;
- int iDLayerQp;
+ int iVideoWidth; ///< width of picture in luminance samples of a layer
+ int iVideoHeight; ///< height of picture in luminance samples of a layer
+ float fFrameRate; ///< frame rate specified for a layer
+ int iSpatialBitrate; ///< target bitrate for a spatial layer
+ int iMaxSpatialBitrate; ///< maximum bitrate for a spatial layer
+ EProfileIdc uiProfileIdc; ///< value of profile IDC (PRO_UNKNOWN for auto-detection)
+ ELevelIdc uiLevelIdc; ///< value of profile IDC (0 for auto-detection)
+ int iDLayerQp; ///< value of level IDC (0 for auto-detection)
- SSliceConfig sSliceCfg;
+ SSliceConfig sSliceCfg; ///< slice configuration for a layer
} SSpatialLayerConfig;
+/**
+* @brief Encoder usage type
+*/
typedef enum {- CAMERA_VIDEO_REAL_TIME, //camera video signal
- SCREEN_CONTENT_REAL_TIME //screen content signal
+ CAMERA_VIDEO_REAL_TIME, ///< camera video signal
+ SCREEN_CONTENT_REAL_TIME ///< screen content signal
} EUsageType;
+/**
+* @brief Enumulate the complexity mode
+*/
typedef enum {- LOW_COMPLEXITY, //the lowest compleixty,the fastest speed,
- MEDIUM_COMPLEXITY, //medium complexity, medium speed,medium quality
- HIGH_COMPLEXITY //high complexity, lowest speed, high quality
+ LOW_COMPLEXITY, ///< the lowest compleixty,the fastest speed,
+ MEDIUM_COMPLEXITY, ///< medium complexity, medium speed,medium quality
+ HIGH_COMPLEXITY ///< high complexity, lowest speed, high quality
} ECOMPLEXITY_MODE;
+
// TODO: Refine the parameters definition.
-// SVC Encoding Parameters
+/**
+* @brief SVC Encoding Parameters
+*/
typedef struct TagEncParamBase {EUsageType
- iUsageType; //application type;// CAMERA_VIDEO_REAL_TIME: //camera video signal; SCREEN_CONTENT_REAL_TIME: screen content signal;
+ iUsageType; ///< application type;1.CAMERA_VIDEO_REAL_TIME:camera video signal; 2.SCREEN_CONTENT_REAL_TIME:screen content signal;
- int iPicWidth; // width of picture in samples
- int iPicHeight; // height of picture in samples
- int iTargetBitrate; // target bitrate desired
- RC_MODES iRCMode; // RC mode
- float fMaxFrameRate; // input maximal frame rate
+ int iPicWidth; ///< width of picture in luminance samples (the maximum of all layers if multiple spatial layers presents)
+ int iPicHeight; ///< height of picture in luminance samples((the maximum of all layers if multiple spatial layers presents)
+ int iTargetBitrate; ///< target bitrate desired
+ RC_MODES iRCMode; ///< rate control mode
+ float fMaxFrameRate; ///< maximal input frame rate
} SEncParamBase, *PEncParamBase;
-
+/**
+* @brief SVC Encoding Parameters extention
+*/
typedef struct TagEncParamExt {EUsageType
- iUsageType; //application type;// CAMERA_VIDEO_REAL_TIME: //camera video signal; SCREEN_CONTENT_REAL_TIME: screen content signal;
+ iUsageType; ///< application type;1.CAMERA_VIDEO_REAL_TIME:camera video signal;2.SCREEN_CONTENT_REAL_TIME:screen content signal;
- int iPicWidth; // width of picture in samples
- int iPicHeight; // height of picture in samples
- int iTargetBitrate; // target bitrate desired
- RC_MODES iRCMode; // RC mode
- float fMaxFrameRate; // input maximal frame rate
+ int iPicWidth; ///< width of picture in luminance samples (the maximum of all layers if multiple spatial layers presents)
+ int iPicHeight; ///< height of picture in luminance samples((the maximum of all layers if multiple spatial layers presents)
+ int iTargetBitrate; ///< target bitrate desired
+ RC_MODES iRCMode; ///< rate control mode
+ float fMaxFrameRate; ///< maximal input frame rate
- int iTemporalLayerNum; // layer number at temporal level
- int iSpatialLayerNum; // layer number at spatial level
+ int iTemporalLayerNum; ///< temporal layer number, max temporal layer = 4
+ int iSpatialLayerNum; ///< spatial layer number,1<= iSpatialLayerNum <= MAX_SPATIAL_LAYER_NUM, MAX_SPATIAL_LAYER_NUM = 4
SSpatialLayerConfig sSpatialLayers[MAX_SPATIAL_LAYER_NUM];
ECOMPLEXITY_MODE iComplexityMode;
- unsigned int uiIntraPeriod; // period of Intra frame
- int iNumRefFrame; // number of reference frame used
- bool bEnableSpsPpsIdAddition;
- bool bPrefixNalAddingCtrl;
- bool bEnableSSEI;
- int iPaddingFlag; // 0:disable padding;1:padding
- int iEntropyCodingModeFlag;
+ unsigned int uiIntraPeriod; ///< period of Intra frame
+ int iNumRefFrame; ///< number of reference frame used
+ bool bEnableSpsPpsIdAddition; ///< false:not adjust ID in SPS/PPS; true: adjust ID in SPS/PPS
+ bool bPrefixNalAddingCtrl; ///< false:not use Prefix NAL; true: use Prefix NAL
+ bool bEnableSSEI; ///< false:not use SSEI; true: use SSEI
+ int iPaddingFlag; ///< 0:disable padding;1:padding
+ int iEntropyCodingModeFlag; ///< 0:CAVLC 1:CABAC.
/* rc control */
- bool bEnableFrameSkip; // allow skipping frames to keep the bitrate within limits
- int iMaxBitrate; // max bitrate desired
- int iMaxQp;
- int iMinQp;
- unsigned int uiMaxNalSize;
+ bool bEnableFrameSkip; ///< False: don't skip frame even if VBV buffer overflow.True: allow skipping frames to keep the bitrate within limits
+ int iMaxBitrate; ///< the maximum bitrate
+ int iMaxQp; ///< the maximum QP encoder supports
+ int iMinQp; ///< the minmum QP encoder supports
+ unsigned int uiMaxNalSize; ///< the maximum NAL size. This value should be not 0 for dynamic slice mode
/*LTR settings*/
- bool bEnableLongTermReference; // 1: on, 0: off
- int iLTRRefNum; //TODO: not supported to set it arbitrary yet
- unsigned int iLtrMarkPeriod;
-
+ bool bEnableLongTermReference; ///< 1: on, 0: off
+ int iLTRRefNum; ///< the number of LTR(long term reference),TODO: not supported to set it arbitrary yet
+ unsigned int iLtrMarkPeriod; ///< the LTR marked period that is used in feedback.
/* multi-thread settings*/
unsigned short
- iMultipleThreadIdc; // 1 # 0: auto(dynamic imp. internal encoder); 1: multiple threads imp. disabled; > 1: count number of threads;
+ iMultipleThreadIdc; ///< 1 # 0: auto(dynamic imp. internal encoder); 1: multiple threads imp. disabled; lager than 1: count number of threads;
/* Deblocking loop filter */
- int iLoopFilterDisableIdc; // 0: on, 1: off, 2: on except for slice boundaries
- int iLoopFilterAlphaC0Offset;// AlphaOffset: valid range [-6, 6], default 0
- int iLoopFilterBetaOffset; // BetaOffset: valid range [-6, 6], default 0
+ int iLoopFilterDisableIdc; ///< 0: on, 1: off, 2: on except for slice boundaries
+ int iLoopFilterAlphaC0Offset; ///< AlphaOffset: valid range [-6, 6], default 0
+ int iLoopFilterBetaOffset; ///< BetaOffset: valid range [-6, 6], default 0
/*pre-processing feature*/
- bool bEnableDenoise; // denoise control
- bool bEnableBackgroundDetection;// background detection control //VAA_BACKGROUND_DETECTION //BGD cmd
- bool bEnableAdaptiveQuant; // adaptive quantization control
- bool bEnableFrameCroppingFlag;// enable frame cropping flag: TRUE always in application
+ bool bEnableDenoise; ///< denoise control
+ bool bEnableBackgroundDetection; ///< background detection control //VAA_BACKGROUND_DETECTION //BGD cmd
+ bool bEnableAdaptiveQuant; ///< adaptive quantization control
+ bool bEnableFrameCroppingFlag; ///< enable frame cropping flag: TRUE always in application
bool bEnableSceneChangeDetect;
- /*LTR advanced setting*/
- bool bIsLosslessLink;
+ bool bIsLosslessLink; ///< LTR advanced setting
} SEncParamExt;
-//Define a new struct to show the property of video bitstream.
+/**
+* @brief Define a new struct to show the property of video bitstream.
+*/
typedef struct {- unsigned int size; //size of the struct
- VIDEO_BITSTREAM_TYPE eVideoBsType;
+ unsigned int size; ///< size of the struct
+ VIDEO_BITSTREAM_TYPE eVideoBsType; ///< video stream type (AVC/SVC)
} SVideoProperty;
-/* SVC Decoding Parameters, reserved here and potential applicable in the future */
+/**
+* @brief SVC Decoding Parameters, reserved here and potential applicable in the future
+*/
typedef struct TagSVCDecodingParam {- char* pFileNameRestructed; // File name of restructed frame used for PSNR calculation based debug
+ char* pFileNameRestructed; ///< file name of reconstructed frame used for PSNR calculation based debug
- EVideoFormatType eOutputColorFormat; // color space format to be outputed, EVideoFormatType specified in codec_def.h
- unsigned int uiCpuLoad; // CPU load
- unsigned char uiTargetDqLayer; // Setting target dq layer id
+ EVideoFormatType eOutputColorFormat; ///< color space format to be outputed, EVideoFormatType specified in codec_def.h
+ unsigned int uiCpuLoad; ///< CPU load
+ unsigned char uiTargetDqLayer; ///< setting target dq layer id
- ERROR_CON_IDC eEcActiveIdc; // Whether active error concealment feature in decoder
+ ERROR_CON_IDC eEcActiveIdc; ///< whether active error concealment feature in decoder
- SVideoProperty sVideoProperty;
+ SVideoProperty sVideoProperty; ///< video stream property
} SDecodingParam, *PDecodingParam;
-/* Bitstream inforamtion of a layer being encoded */
+/**
+* @brief Bitstream inforamtion of a layer being encoded
+*/
typedef struct {unsigned char uiTemporalId;
unsigned char uiSpatialId;
@@ -391,18 +471,23 @@
unsigned char uiLayerType;
- int iNalCount; // Count number of NAL coded already
- int* pNalLengthInByte; // Length of NAL size in byte from 0 to iNalCount-1
- unsigned char* pBsBuf; // Buffer of bitstream contained
+ int iNalCount; ///< count number of NAL coded already
+ int* pNalLengthInByte; ///< length of NAL size in byte from 0 to iNalCount-1
+ unsigned char* pBsBuf; ///< buffer of bitstream contained
} SLayerBSInfo, *PLayerBSInfo;
-
+/**
+* @brief Frame bit stream info
+*/
typedef struct {- int iTemporalId; // Temporal ID
- //The sub sequence layers are ordered hierarchically based on their dependency on each other so that any picture in a layer shall not be
- //predicted from any picture on any higher layer.
- int iSubSeqId; //refer to D.2.11 Sub-sequence information SEI message semantics
+ int iTemporalId; ///< temporal ID
+ /**
+ * The sub sequence layers are ordered hierarchically based on their dependency on each other so that any picture in a layer shall not be
+ * predicted from any picture on any higher layer.
+ */
+ int iSubSeqId; ///< refer to D.2.11 Sub-sequence information SEI message semantics
+
int iLayerNum;
SLayerBSInfo sLayerInfo[MAX_LAYER_NUM_OF_FRAME];
@@ -411,41 +496,63 @@
long long uiTimeStamp;
} SFrameBSInfo, *PFrameBSInfo;
+/**
+* @brief Structure for source picture
+*/
typedef struct Source_Picture_s {- int iColorFormat; // color space type
- int iStride[4]; // stride for each plane pData
- unsigned char* pData[4]; // plane pData
- int iPicWidth; // luma picture width in x coordinate
- int iPicHeight; // luma picture height in y coordinate
+ int iColorFormat; ///< color space type
+ int iStride[4]; ///< stride for each plane pData
+ unsigned char* pData[4]; ///< plane pData
+ int iPicWidth; ///< luma picture width in x coordinate
+ int iPicHeight; ///< luma picture height in y coordinate
long long uiTimeStamp;
} SSourcePicture;
-
+/**
+* @brief Structure for bit rate info
+*/
typedef struct TagBitrateInfo {LAYER_NUM iLayer;
- int iBitrate; //the maximum bitrate
+ int iBitrate; ///< the maximum bitrate
} SBitrateInfo;
+/**
+* @brief Structure for dump layer info
+*/
typedef struct TagDumpLayer {int iLayer;
char* pFileName;
} SDumpLayer;
+/**
+* @brief Structure for profile info in layer
+*
+*/
typedef struct TagProfileInfo {int iLayer;
- EProfileIdc uiProfileIdc; //the profile info
+ EProfileIdc uiProfileIdc; ///< the profile info
} SProfileInfo;
+/**
+* @brief Structure for level info in layer
+*
+*/
typedef struct TagLevelInfo {int iLayer;
- ELevelIdc uiLevelIdc; //the level info
+ ELevelIdc uiLevelIdc; ///< the level info
} SLevelInfo;
-
+/**
+* @brief Structure for dilivery status
+*
+*/
typedef struct TagDeliveryStatus {- bool bDeliveryFlag; //0: the previous frame isn't delivered,1: the previous frame is delivered
- int iDropFrameType; // the frame type that is dropped; reserved
- int iDropFrameSize; // the frame size that is dropped; reserved
+ bool bDeliveryFlag; ///< 0: the previous frame isn't delivered,1: the previous frame is delivered
+ int iDropFrameType; ///< the frame type that is dropped; reserved
+ int iDropFrameSize; ///< the frame size that is dropped; reserved
} SDeliveryStatus;
+/**
+* @brief The capability of decoder
+*/
typedef struct TagDecoderCapability {int iProfileIdc;
int iProfileIop;
@@ -458,46 +565,56 @@
bool bRedPicCap;
} SDecoderCapability;
+/**
+* @brief to do
+*/
typedef struct TagParserBsInfo {- int iNalNum; //total NAL number in current AU
- int iNalLenInByte [MAX_NAL_UNITS_IN_LAYER]; //each nal length
- unsigned char* pDstBuff; //outputted dst buffer for parsed bitstream
- int iSpsWidthInPixel; //required SPS width info
- int iSpsHeightInPixel; //required SPS height info
+ int iNalNum; ///< total NAL number in current AU
+ int iNalLenInByte [MAX_NAL_UNITS_IN_LAYER]; ///< each nal length
+ unsigned char* pDstBuff; ///< outputted dst buffer for parsed bitstream
+ int iSpsWidthInPixel; ///< required SPS width info
+ int iSpsHeightInPixel; ///< required SPS height info
} SParserBsInfo, PParserBsInfo;
+/**
+* @brief Structure for encoder statistics
+*/
typedef struct TagVideoEncoderStatistics {- unsigned int uiWidth; // the width of encoded frame
- unsigned int uiHeight; // the height of encoded frame
+ unsigned int uiWidth; ///< the width of encoded frame
+ unsigned int uiHeight; ///< the height of encoded frame
//following standard, will be 16x aligned, if there are multiple spatial, this is of the highest
- float fAverageFrameSpeedInMs; // Average_Encoding_Time
+ float fAverageFrameSpeedInMs; ///< average_Encoding_Time
// rate control related
- float fAverageFrameRate; // the average frame rate in, calculate since encoding starts, supposed that the input timestamp is in unit of ms
- float fLatestFrameRate; // the frame rate in, in the last second, supposed that the input timestamp is in unit of ms (? useful for checking BR, but is it easy to calculate?
- unsigned int uiBitRate; // sendrate in Bits per second, calculated within the set time-window
+ float fAverageFrameRate; ///< the average frame rate in, calculate since encoding starts, supposed that the input timestamp is in unit of ms
+ float fLatestFrameRate; ///< the frame rate in, in the last second, supposed that the input timestamp is in unit of ms (? useful for checking BR, but is it easy to calculate?
+ unsigned int uiBitRate; ///< sendrate in Bits per second, calculated within the set time-window
- unsigned int uiInputFrameCount; // number of frames
- unsigned int uiSkippedFrameCount; // number of frames
+ unsigned int uiInputFrameCount; ///< number of frames
+ unsigned int uiSkippedFrameCount; ///< number of frames
- unsigned int uiResolutionChangeTimes; // uiResolutionChangeTimes
- unsigned int uiIDRReqNum; // number of IDR requests
- unsigned int uiIDRSentNum; // number of actual IDRs sent
- unsigned int uiLTRSentNum; // number of LTR sent/marked
+ unsigned int uiResolutionChangeTimes; ///< uiResolutionChangeTimes
+ unsigned int uiIDRReqNum; ///< number of IDR requests
+ unsigned int uiIDRSentNum; ///< number of actual IDRs sent
+ unsigned int uiLTRSentNum; ///< number of LTR sent/marked
} SEncoderStatistics; // in building, coming soon
+/**
+* @brief Structure for decoder statistics
+*/
typedef struct TagVideoDecoderStatistics {- unsigned int uiWidth; // the width of encode/decode frame
- unsigned int uiHeight; // the height of encode/decode frame
- float fAverageFrameSpeedInMs; // Average_Decoding_Time
- unsigned int uiDecodedFrameCount; // number of frames
- unsigned int uiResolutionChangeTimes; // uiResolutionChangeTimes
- unsigned int uiIDRRecvNum; // number of actual IDR received
+ unsigned int uiWidth; ///< the width of encode/decode frame
+ unsigned int uiHeight; ///< the height of encode/decode frame
+ float fAverageFrameSpeedInMs; ///< average_Decoding_Time
+ unsigned int uiDecodedFrameCount; ///< number of frames
+ unsigned int uiResolutionChangeTimes; ///< uiResolutionChangeTimes
+ unsigned int uiIDRRecvNum; ///< number of actual IDR received
//EC on related
- unsigned int uiAvgEcRatio; // when EC is on, the average ratio of correct or EC areas, can be an indicator of reconstruction quality
- unsigned int uiEcIDRNum; // number of actual unintegrity IDR or not received but eced
- unsigned int uiEcFrameNum; //
- unsigned int uiIDRLostNum;//Decoder detect out the number of lost IDR lost
+ unsigned int
+ uiAvgEcRatio; ///< when EC is on, the average ratio of correct or EC areas, can be an indicator of reconstruction quality
+ unsigned int uiEcIDRNum; ///< number of actual unintegrity IDR or not received but eced
+ unsigned int uiEcFrameNum; ///<
+ unsigned int uiIDRLostNum; ///< decoder detect the number of lost IDR
} SDecoderStatistics; // in building, coming soon
#endif//WELS_VIDEO_CODEC_APPLICATION_DEFINITION_H__
--- a/codec/api/svc/codec_def.h
+++ b/codec/api/svc/codec_def.h
@@ -33,9 +33,15 @@
#ifndef WELS_VIDEO_CODEC_DEFINITION_H__
#define WELS_VIDEO_CODEC_DEFINITION_H__
+/**
+ * @file codec_def.h
+*/
+
+/**
+* @brief Enumerate the type of video format
+*/
typedef enum {- /*rgb color formats*/
- videoFormatRGB = 1,
+ videoFormatRGB = 1, ///< rgb color formats
videoFormatRGBA = 2,
videoFormatRGB555 = 3,
videoFormatRGB565 = 4,
@@ -44,51 +50,61 @@
videoFormatABGR = 7,
videoFormatARGB = 8,
- /*yuv color formats*/
- videoFormatYUY2 = 20,
+ videoFormatYUY2 = 20, ///< yuv color formats
videoFormatYVYU = 21,
videoFormatUYVY = 22,
- videoFormatI420 = 23, //same as IYUV
+ videoFormatI420 = 23, ///< the same as IYUV
videoFormatYV12 = 24,
- videoFormatInternal = 25, // Only Used for SVC decoder testbed
+ videoFormatInternal = 25, ///< only used in SVC decoder testbed
- videoFormatNV12 = 26, // new format for output by DXVA decoding
+ videoFormatNV12 = 26, ///< new format for output by DXVA decoding
videoFormatVFlip = 0x80000000
} EVideoFormatType;
+/**
+* @brief Enumerate video frame type
+*/
typedef enum {- videoFrameTypeInvalid, /* Encoder not ready or parameters are invalidate */
- videoFrameTypeIDR, /* This type is only available for H264 if this frame is key frame, then return this type */
- videoFrameTypeI, /* I frame type */
- videoFrameTypeP, /* P frame type */
- videoFrameTypeSkip, /* Skip the frame based encoder kernel */
- videoFrameTypeIPMixed /* Frame type introduced I and P slices are mixing */
+ videoFrameTypeInvalid, ///< encoder not ready or parameters are invalidate
+ videoFrameTypeIDR, ///< IDR frame in H.264
+ videoFrameTypeI, ///< I frame type
+ videoFrameTypeP, ///< P frame type
+ videoFrameTypeSkip, ///< skip the frame based encoder kernel
+ videoFrameTypeIPMixed ///< a frame where I and P slices are mixing, not supported yet
} EVideoFrameType;
+/**
+* @brief Enumerate return type
+*/
typedef enum {- cmResultSuccess,
- cmInitParaError, /*Parameters are invalid */
+ cmResultSuccess, ///< successful
+ cmInitParaError, ///< parameters are invalid
cmUnkonwReason,
- cmMallocMemeError, /*Malloc a memory error*/
- cmInitExpected, /*Initial action is expected*/
+ cmMallocMemeError, ///< malloc a memory error
+ cmInitExpected, ///< initial action is expected
cmUnsupportedData
} CM_RETURN;
-/* nal unit type */
+/**
+* @brief Enumulate the nal unit type
+*/
enum ENalUnitType {- NAL_UNKNOWN = 0,
- NAL_SLICE = 1,
+ NAL_UNKNOWN = 0,
+ NAL_SLICE = 1,
NAL_SLICE_DPA = 2,
NAL_SLICE_DPB = 3,
NAL_SLICE_DPC = 4,
- NAL_SLICE_IDR = 5, /* ref_idc != 0 */
- NAL_SEI = 6, /* ref_idc == 0 */
+ NAL_SLICE_IDR = 5, ///< ref_idc != 0
+ NAL_SEI = 6, ///< ref_idc == 0
NAL_SPS = 7,
NAL_PPS = 8
- /* ref_idc == 0 for 6,9,10,11,12 */
+ ///< ref_idc == 0 for 6,9,10,11,12
};
-/* NRI: eNalRefIdc */
+
+/**
+* @brief NRI: eNalRefIdc
+*/
enum ENalPriority {NAL_PRIORITY_DISPOSABLE = 0,
NAL_PRIORITY_LOW = 1,
@@ -107,31 +123,37 @@
/* Error Tools definition */
typedef unsigned short ERR_TOOL;
+
+/**
+ @brief to do
+*/
enum {- ET_NONE = 0x00, // NONE Error Tools
- ET_IP_SCALE = 0x01, // IP Scalable
- ET_FMO = 0x02, // Flexible Macroblock Ordering
- ET_IR_R1 = 0x04, // Intra Refresh in predifined 2% MB
- ET_IR_R2 = 0x08, // Intra Refresh in predifined 5% MB
- ET_IR_R3 = 0x10, // Intra Refresh in predifined 10% MB
- ET_FEC_HALF = 0x20, // Forward Error Correction in 50% redundency mode
- ET_FEC_FULL = 0x40, // Forward Error Correction in 100% redundency mode
- ET_RFS = 0x80 // Reference Frame Selection
+ ET_NONE = 0x00, ///< NONE Error Tools
+ ET_IP_SCALE = 0x01, ///< IP Scalable
+ ET_FMO = 0x02, ///< Flexible Macroblock Ordering
+ ET_IR_R1 = 0x04, ///< Intra Refresh in predifined 2% MB
+ ET_IR_R2 = 0x08, ///< Intra Refresh in predifined 5% MB
+ ET_IR_R3 = 0x10, ///< Intra Refresh in predifined 10% MB
+ ET_FEC_HALF = 0x20, ///< Forward Error Correction in 50% redundency mode
+ ET_FEC_FULL = 0x40, ///< Forward Error Correction in 100% redundency mode
+ ET_RFS = 0x80 ///< Reference Frame Selection
};
-/* information of coded Slice(=NAL)(s) */
+/**
+* @brief Information of coded Slice(=NAL)(s)
+*/
typedef struct SliceInformation {- unsigned char* pBufferOfSlices; // base buffer of coded slice(s)
- int iCodedSliceCount; // number of coded slices
- unsigned int* pLengthOfSlices; // array of slices length accordingly by number of slice
- int iFecType; // FEC type[0, 50%FEC, 100%FEC]
- unsigned char uiSliceIdx; // index of slice in frame [FMO: 0,..,uiSliceCount-1; No FMO: 0]
- unsigned char uiSliceCount; // count number of slice in frame [FMO: 2-8; No FMO: 1]
- char iFrameIndex; // index of frame[-1, .., idr_interval-1]
- unsigned char uiNalRefIdc; // NRI, priority level of slice(NAL)
- unsigned char uiNalType; // NAL type
+ unsigned char* pBufferOfSlices; ///< base buffer of coded slice(s)
+ int iCodedSliceCount; ///< number of coded slices
+ unsigned int* pLengthOfSlices; ///< array of slices length accordingly by number of slice
+ int iFecType; ///< FEC type[0, 50%FEC, 100%FEC]
+ unsigned char uiSliceIdx; ///< index of slice in frame [FMO: 0,..,uiSliceCount-1; No FMO: 0]
+ unsigned char uiSliceCount; ///< count number of slice in frame [FMO: 2-8; No FMO: 1]
+ char iFrameIndex; ///< index of frame[-1, .., idr_interval-1]
+ unsigned char uiNalRefIdc; ///< NRI, priority level of slice(NAL)
+ unsigned char uiNalType; ///< NAL type
unsigned char
- uiContainingFinalNal; // whether final NAL is involved in buffer of coded slices, flag used in Pause feature in T27
+ uiContainingFinalNal; ///< whether final NAL is involved in buffer of coded slices, flag used in Pause feature in T27
} SliceInfo, *PSliceInfo;
@@ -145,44 +167,57 @@
#define SQCIF_WIDTH 128
#define SQCIF_HEIGHT 96
-/* thresholds of the initial, maximal and minimal rate */
+/**
+* @brief thresholds of the initial, maximal and minimal rate
+*/
typedef struct {- int iWidth; // frame width
- int iHeight; // frame height
- int iThresholdOfInitRate; // threshold of initial rate
- int iThresholdOfMaxRate; // threshold of maximal rate
- int iThresholdOfMinRate; // threshold of minimal rate
- int iMinThresholdFrameRate; //min frame rate min
- int iSkipFrameRate; //skip to frame rate min
- int iSkipFrameStep; //how many frames to skip
+ int iWidth; ///< frame width
+ int iHeight; ///< frame height
+ int iThresholdOfInitRate; ///< threshold of initial rate
+ int iThresholdOfMaxRate; ///< threshold of maximal rate
+ int iThresholdOfMinRate; ///< threshold of minimal rate
+ int iMinThresholdFrameRate; ///< min frame rate min
+ int iSkipFrameRate; ///< skip to frame rate min
+ int iSkipFrameStep; ///< how many frames to skip
} SRateThresholds, *PRateThresholds;
+/**
+* @brief Structure for decoder memery
+*/
typedef struct TagSysMemBuffer {- int iWidth; //width of decoded pic for display
- int iHeight; //height of decoded pic for display
- int iFormat; // type is "EVideoFormatType"
- int iStride[2]; //stride of 2 component
+ int iWidth; ///< width of decoded pic for display
+ int iHeight; ///< height of decoded pic for display
+ int iFormat; ///< type is "EVideoFormatType"
+ int iStride[2]; ///< stride of 2 component
} SSysMEMBuffer;
+/**
+* @brief Buffer info
+*/
typedef struct TagBufferInfo {- int iBufferStatus; // 0: one frame data is not ready; 1: one frame data is ready
+ int iBufferStatus; ///< 0: one frame data is not ready; 1: one frame data is ready
+
union {- SSysMEMBuffer sSystemBuffer;
- } UsrData;
+ SSysMEMBuffer sSystemBuffer; ///< memory info for one picture
+ } UsrData; ///< output buffer info
} SBufferInfo;
-/* Constants related to transmission rate at various resolutions */
+/**
+* @brief Constants related to transmission rate at various resolutions
+*/
static const SRateThresholds ksRateThrMap[4] = {// initial-maximal-minimal
{CIF_WIDTH, CIF_HEIGHT, 225000, 384000, 96000, 3, 1, 1}, // CIF {QVGA_WIDTH, QVGA_HEIGHT, 192000, 320000, 80000, -1, -1, -1}, // QVGA- {QCIF_WIDTH, QCIF_HEIGHT, 150000, 256000, 64000, 8, 4, 2}, // QCIF+ {QCIF_WIDTH, QCIF_HEIGHT, 150000, 256000, 64000, 8, 4, 2}, // QCIF {SQCIF_WIDTH, SQCIF_HEIGHT, 120000, 192000, 48000, 5, 3, 1} // SQCIF};
-// In a GOP, multiple of the key frame number, derived from
-// the number of layers(index or array below)
+/**
+* @brief In a GOP, multiple of the key frame number, derived from
+* the number of layers(index or array below)
+*/
static const char kiKeyNumMultiple[] = {1, 1, 2, 4, 8, 16,
};
--- /dev/null
+++ b/docs/doxygen/Doxyfile
@@ -1,0 +1,1865 @@
+# Doxyfile 1.8.3
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project
+#
+# All text after a hash (#) is considered a comment and will be ignored
+# The format is:
+# TAG = value [value, ...]
+# For lists items can also be appended using:
+# TAG += value [value, ...]
+# Values that contain spaces should be placed between quotes (" ")+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+
+# This tag specifies the encoding used for all characters in the config file
+# that follow. The default is UTF-8 which is also the encoding used for all
+# text before the first occurrence of this tag. Doxygen uses libiconv (or the
+# iconv built into libc) for the transcoding. See
+# http://www.gnu.org/software/libiconv for the list of possible encodings.
+
+DOXYFILE_ENCODING = UTF-8
+
+# The PROJECT_NAME tag is a single word (or sequence of words) that should
+# identify the project. Note that if you do not use Doxywizard you need
+# to put quotes around the project name if it contains spaces.
+
+PROJECT_NAME = cppexample
+
+# The PROJECT_NUMBER tag can be used to enter a project or revision number.
+# This could be handy for archiving the generated documentation or
+# if some version control system is used.
+
+PROJECT_NUMBER =
+
+# Using the PROJECT_BRIEF tag one can provide an optional one line description
+# for a project that appears at the top of each page and should give viewer
+# a quick idea about the purpose of the project. Keep the description short.
+
+PROJECT_BRIEF = "Confluence-tool CPP Example"
+
+# With the PROJECT_LOGO tag one can specify an logo or icon that is
+# included in the documentation. The maximum height of the logo should not
+# exceed 55 pixels and the maximum width should not exceed 200 pixels.
+# Doxygen will copy the logo to the output directory.
+
+PROJECT_LOGO =
+
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
+# base path where the generated documentation will be put.
+# If a relative path is entered, it will be relative to the location
+# where doxygen was started. If left blank the current directory will be used.
+
+OUTPUT_DIRECTORY = _doxygen
+
+# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
+# 4096 sub-directories (in 2 levels) under the output directory of each output
+# format and will distribute the generated files over these directories.
+# Enabling this option can be useful when feeding doxygen a huge amount of
+# source files, where putting all generated files in the same directory would
+# otherwise cause performance problems for the file system.
+
+CREATE_SUBDIRS = NO
+
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all constant output in the proper language.
+# The default language is English, other supported languages are:
+# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
+# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
+# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
+# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
+# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
+# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
+
+OUTPUT_LANGUAGE = English
+
+# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
+# include brief member descriptions after the members that are listed in
+# the file and class documentation (similar to JavaDoc).
+# Set to NO to disable this.
+
+BRIEF_MEMBER_DESC = YES
+
+# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
+# the brief description of a member or function before the detailed description.
+# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
+# brief descriptions will be completely suppressed.
+
+REPEAT_BRIEF = YES
+
+# This tag implements a quasi-intelligent brief description abbreviator
+# that is used to form the text in various listings. Each string
+# in this list, if found as the leading text of the brief description, will be
+# stripped from the text and the result after processing the whole list, is
+# used as the annotated text. Otherwise, the brief description is used as-is.
+# If left blank, the following values are used ("$name" is automatically+# replaced with the name of the entity): "The $name class" "The $name widget"
+# "The $name file" "is" "provides" "specifies" "contains"
+# "represents" "a" "an" "the"
+
+ABBREVIATE_BRIEF = "The $name class" \
+ "The $name widget" \
+ "The $name file" \
+ is \
+ provides \
+ specifies \
+ contains \
+ represents \
+ a \
+ an \
+ the
+
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
+# Doxygen will generate a detailed section even if there is only a brief
+# description.
+
+ALWAYS_DETAILED_SEC = NO
+
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
+# inherited members of a class in the documentation of that class as if those
+# members were ordinary class members. Constructors, destructors and assignment
+# operators of the base classes will not be shown.
+
+INLINE_INHERITED_MEMB = NO
+
+# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
+# path before files name in the file list and in the header files. If set
+# to NO the shortest path that makes the file name unique will be used.
+
+FULL_PATH_NAMES = YES
+
+# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
+# can be used to strip a user-defined part of the path. Stripping is
+# only done if one of the specified strings matches the left-hand part of
+# the path. The tag can be used to show relative paths in the file list.
+# If left blank the directory from which doxygen is run is used as the
+# path to strip. Note that you specify absolute paths here, but also
+# relative paths, which will be relative from the directory where doxygen is
+# started.
+
+STRIP_FROM_PATH =
+
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
+# the path mentioned in the documentation of a class, which tells
+# the reader which header file to include in order to use a class.
+# If left blank only the name of the header file containing the class
+# definition is used. Otherwise one should specify the include paths that
+# are normally passed to the compiler using the -I flag.
+
+STRIP_FROM_INC_PATH =
+
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
+# (but less readable) file names. This can be useful if your file system
+# doesn't support long names like on DOS, Mac, or CD-ROM.
+
+SHORT_NAMES = NO
+
+# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
+# will interpret the first line (until the first dot) of a JavaDoc-style
+# comment as the brief description. If set to NO, the JavaDoc
+# comments will behave just like regular Qt-style comments
+# (thus requiring an explicit @brief command for a brief description.)
+
+JAVADOC_AUTOBRIEF = NO
+
+# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
+# interpret the first line (until the first dot) of a Qt-style
+# comment as the brief description. If set to NO, the comments
+# will behave just like regular Qt-style comments (thus requiring
+# an explicit \brief command for a brief description.)
+
+QT_AUTOBRIEF = NO
+
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
+# treat a multi-line C++ special comment block (i.e. a block of //! or ///
+# comments) as a brief description. This used to be the default behaviour.
+# The new default is to treat a multi-line C++ comment block as a detailed
+# description. Set this tag to YES if you prefer the old behaviour instead.
+
+MULTILINE_CPP_IS_BRIEF = NO
+
+# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
+# member inherits the documentation from any documented member that it
+# re-implements.
+
+INHERIT_DOCS = YES
+
+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
+# a new page for each member. If set to NO, the documentation of a member will
+# be part of the file/class/namespace that contains it.
+
+SEPARATE_MEMBER_PAGES = NO
+
+# The TAB_SIZE tag can be used to set the number of spaces in a tab.
+# Doxygen uses this value to replace tabs by spaces in code fragments.
+
+TAB_SIZE = 4
+
+# This tag can be used to specify a number of aliases that acts
+# as commands in the documentation. An alias has the form "name=value".
+# For example adding "sideeffect=\par Side Effects:\n" will allow you to
+# put the command \sideeffect (or @sideeffect) in the documentation, which
+# will result in a user-defined paragraph with heading "Side Effects:".
+# You can put \n's in the value part of an alias to insert newlines.
+
+ALIASES = "uml=\verbatim {plantuml}"+ALIASES += "enduml=\endverbatim"
+ALIASES += "ignore=\xmlonly {ignore} \endxmlonly"+
+# This tag can be used to specify a number of word-keyword mappings (TCL only).
+# A mapping has the form "name=value". For example adding
+# "class=itcl::class" will allow you to use the command class in the
+# itcl::class meaning.
+
+TCL_SUBST =
+
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
+# sources only. Doxygen will then generate output that is more tailored for C.
+# For instance, some of the names that are used will be different. The list
+# of all members will be omitted, etc.
+
+OPTIMIZE_OUTPUT_FOR_C = NO
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
+# sources only. Doxygen will then generate output that is more tailored for
+# Java. For instance, namespaces will be presented as packages, qualified
+# scopes will look different, etc.
+
+OPTIMIZE_OUTPUT_JAVA = NO
+
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
+# sources only. Doxygen will then generate output that is more tailored for
+# Fortran.
+
+OPTIMIZE_FOR_FORTRAN = NO
+
+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
+# sources. Doxygen will then generate output that is tailored for
+# VHDL.
+
+OPTIMIZE_OUTPUT_VHDL = NO
+
+# Doxygen selects the parser to use depending on the extension of the files it
+# parses. With this tag you can assign which parser to use for a given
+# extension. Doxygen has a built-in mapping, but you can override or extend it
+# using this tag. The format is ext=language, where ext is a file extension,
+# and language is one of the parsers supported by doxygen: IDL, Java,
+# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C,
+# C++. For instance to make doxygen treat .inc files as Fortran files (default
+# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note
+# that for custom extensions you also need to set FILE_PATTERNS otherwise the
+# files are not read by doxygen.
+
+EXTENSION_MAPPING =
+
+# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
+# comments according to the Markdown format, which allows for more readable
+# documentation. See http://daringfireball.net/projects/markdown/ for details.
+# The output of markdown processing is further processed by doxygen, so you
+# can mix doxygen, HTML, and XML commands with Markdown formatting.
+# Disable only in case of backward compatibilities issues.
+
+MARKDOWN_SUPPORT = YES
+
+# When enabled doxygen tries to link words that correspond to documented classes,
+# or namespaces to their corresponding documentation. Such a link can be
+# prevented in individual cases by by putting a % sign in front of the word or
+# globally by setting AUTOLINK_SUPPORT to NO.
+
+AUTOLINK_SUPPORT = YES
+
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
+# to include (a tag file for) the STL sources as input, then you should
+# set this tag to YES in order to let doxygen match functions declarations and
+# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
+# func(std::string) {}). This also makes the inheritance and collaboration+# diagrams that involve STL classes more complete and accurate.
+
+BUILTIN_STL_SUPPORT = NO
+
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
+# enable parsing support.
+
+CPP_CLI_SUPPORT = NO
+
+# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
+# Doxygen will parse them like normal C++ but will assume all classes use public
+# instead of private inheritance when no explicit protection keyword is present.
+
+SIP_SUPPORT = NO
+
+# For Microsoft's IDL there are propget and propput attributes to indicate
+# getter and setter methods for a property. Setting this option to YES (the
+# default) will make doxygen replace the get and set methods by a property in
+# the documentation. This will only work if the methods are indeed getting or
+# setting a simple type. If this is not the case, or you want to show the
+# methods anyway, you should set this option to NO.
+
+IDL_PROPERTY_SUPPORT = YES
+
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
+# tag is set to YES, then doxygen will reuse the documentation of the first
+# member in the group (if any) for the other members of the group. By default
+# all members of a group must be documented explicitly.
+
+DISTRIBUTE_GROUP_DOC = NO
+
+# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
+# the same type (for instance a group of public functions) to be put as a
+# subgroup of that type (e.g. under the Public Functions section). Set it to
+# NO to prevent subgrouping. Alternatively, this can be done per class using
+# the \nosubgrouping command.
+
+SUBGROUPING = YES
+
+# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
+# unions are shown inside the group in which they are included (e.g. using
+# @ingroup) instead of on a separate page (for HTML and Man pages) or
+# section (for LaTeX and RTF).
+
+INLINE_GROUPED_CLASSES = NO
+
+# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
+# unions with only public data fields will be shown inline in the documentation
+# of the scope in which they are defined (i.e. file, namespace, or group
+# documentation), provided this scope is documented. If set to NO (the default),
+# structs, classes, and unions are shown on a separate page (for HTML and Man
+# pages) or section (for LaTeX and RTF).
+
+INLINE_SIMPLE_STRUCTS = NO
+
+# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
+# is documented as struct, union, or enum with the name of the typedef. So
+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct+# with name TypeT. When disabled the typedef will appear as a member of a file,
+# namespace, or class. And the struct will be named TypeS. This can typically
+# be useful for C code in case the coding convention dictates that all compound
+# types are typedef'ed and only the typedef is referenced, never the tag name.
+
+TYPEDEF_HIDES_STRUCT = YES
+
+# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
+# determine which symbols to keep in memory and which to flush to disk.
+# When the cache is full, less often used symbols will be written to disk.
+# For small to medium size projects (<1000 input files) the default value is
+# probably good enough. For larger projects a too small cache size can cause
+# doxygen to be busy swapping symbols to and from disk most of the time
+# causing a significant performance penalty.
+# If the system has enough physical memory increasing the cache will improve the
+# performance by keeping more symbols in memory. Note that the value works on
+# a logarithmic scale so increasing the size by one will roughly double the
+# memory usage. The cache size is given by this formula:
+# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
+# corresponding to a cache size of 2^16 = 65536 symbols.
+
+SYMBOL_CACHE_SIZE = 0
+
+# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
+# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
+# their name and scope. Since this can be an expensive process and often the
+# same symbol appear multiple times in the code, doxygen keeps a cache of
+# pre-resolved symbols. If the cache is too small doxygen will become slower.
+# If the cache is too large, memory is wasted. The cache size is given by this
+# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
+# corresponding to a cache size of 2^16 = 65536 symbols.
+
+LOOKUP_CACHE_SIZE = 0
+
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+
+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
+# documentation are documented, even if no documentation was available.
+# Private class members and static file members will be hidden unless
+# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
+
+EXTRACT_ALL = NO
+
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
+# will be included in the documentation.
+
+EXTRACT_PRIVATE = NO
+
+# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
+# scope will be included in the documentation.
+
+EXTRACT_PACKAGE = NO
+
+# If the EXTRACT_STATIC tag is set to YES all static members of a file
+# will be included in the documentation.
+
+EXTRACT_STATIC = NO
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
+# defined locally in source files will be included in the documentation.
+# If set to NO only classes defined in header files are included.
+
+EXTRACT_LOCAL_CLASSES = YES
+
+# This flag is only useful for Objective-C code. When set to YES local
+# methods, which are defined in the implementation section but not in
+# the interface are included in the documentation.
+# If set to NO (the default) only methods in the interface are included.
+
+EXTRACT_LOCAL_METHODS = NO
+
+# If this flag is set to YES, the members of anonymous namespaces will be
+# extracted and appear in the documentation as a namespace called
+# 'anonymous_namespace{file}', where file will be replaced with the base+# name of the file that contains the anonymous namespace. By default
+# anonymous namespaces are hidden.
+
+EXTRACT_ANON_NSPACES = NO
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
+# undocumented members of documented classes, files or namespaces.
+# If set to NO (the default) these members will be included in the
+# various overviews, but no documentation section is generated.
+# This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_MEMBERS = NO
+
+# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
+# undocumented classes that are normally visible in the class hierarchy.
+# If set to NO (the default) these classes will be included in the various
+# overviews. This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_CLASSES = NO
+
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
+# friend (class|struct|union) declarations.
+# If set to NO (the default) these declarations will be included in the
+# documentation.
+
+HIDE_FRIEND_COMPOUNDS = NO
+
+# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
+# documentation blocks found inside the body of a function.
+# If set to NO (the default) these blocks will be appended to the
+# function's detailed documentation block.
+
+HIDE_IN_BODY_DOCS = NO
+
+# The INTERNAL_DOCS tag determines if documentation
+# that is typed after a \internal command is included. If the tag is set
+# to NO (the default) then the documentation will be excluded.
+# Set it to YES to include the internal documentation.
+
+INTERNAL_DOCS = NO
+
+# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
+# file names in lower-case letters. If set to YES upper-case letters are also
+# allowed. This is useful if you have classes or files whose names only differ
+# in case and if your file system supports case sensitive file names. Windows
+# and Mac users are advised to set this option to NO.
+
+CASE_SENSE_NAMES = NO
+
+# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
+# will show members with their full class and namespace scopes in the
+# documentation. If set to YES the scope will be hidden.
+
+HIDE_SCOPE_NAMES = NO
+
+# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
+# will put a list of the files that are included by a file in the documentation
+# of that file.
+
+SHOW_INCLUDE_FILES = YES
+
+# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
+# will list include files with double quotes in the documentation
+# rather than with sharp brackets.
+
+FORCE_LOCAL_INCLUDES = NO
+
+# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
+# is inserted in the documentation for inline members.
+
+INLINE_INFO = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
+# will sort the (detailed) documentation of file and class members
+# alphabetically by member name. If set to NO the members will appear in
+# declaration order.
+
+SORT_MEMBER_DOCS = YES
+
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
+# brief documentation of file, namespace and class members alphabetically
+# by member name. If set to NO (the default) the members will appear in
+# declaration order.
+
+SORT_BRIEF_DOCS = NO
+
+# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
+# will sort the (brief and detailed) documentation of class members so that
+# constructors and destructors are listed first. If set to NO (the default)
+# the constructors will appear in the respective orders defined by
+# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
+# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
+# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
+
+SORT_MEMBERS_CTORS_1ST = NO
+
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
+# hierarchy of group names into alphabetical order. If set to NO (the default)
+# the group names will appear in their defined order.
+
+SORT_GROUP_NAMES = NO
+
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
+# sorted by fully-qualified names, including namespaces. If set to
+# NO (the default), the class list will be sorted only by class name,
+# not including the namespace part.
+# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
+# Note: This option applies only to the class list, not to the
+# alphabetical list.
+
+SORT_BY_SCOPE_NAME = NO
+
+# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
+# do proper type resolution of all parameters of a function it will reject a
+# match between the prototype and the implementation of a member function even
+# if there is only one candidate or it is obvious which candidate to choose
+# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
+# will still accept a match between prototype and implementation in such cases.
+
+STRICT_PROTO_MATCHING = NO
+
+# The GENERATE_TODOLIST tag can be used to enable (YES) or
+# disable (NO) the todo list. This list is created by putting \todo
+# commands in the documentation.
+
+GENERATE_TODOLIST = YES
+
+# The GENERATE_TESTLIST tag can be used to enable (YES) or
+# disable (NO) the test list. This list is created by putting \test
+# commands in the documentation.
+
+GENERATE_TESTLIST = YES
+
+# The GENERATE_BUGLIST tag can be used to enable (YES) or
+# disable (NO) the bug list. This list is created by putting \bug
+# commands in the documentation.
+
+GENERATE_BUGLIST = YES
+
+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
+# disable (NO) the deprecated list. This list is created by putting
+# \deprecated commands in the documentation.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# The ENABLED_SECTIONS tag can be used to enable conditional
+# documentation sections, marked by \if section-label ... \endif
+# and \cond section-label ... \endcond blocks.
+
+ENABLED_SECTIONS =
+
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
+# the initial value of a variable or macro consists of for it to appear in
+# the documentation. If the initializer consists of more lines than specified
+# here it will be hidden. Use a value of 0 to hide initializers completely.
+# The appearance of the initializer of individual variables and macros in the
+# documentation can be controlled using \showinitializer or \hideinitializer
+# command in the documentation regardless of this setting.
+
+MAX_INITIALIZER_LINES = 30
+
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
+# at the bottom of the documentation of classes and structs. If set to YES the
+# list will mention the files that were used to generate the documentation.
+
+SHOW_USED_FILES = YES
+
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
+# This will remove the Files entry from the Quick Index and from the
+# Folder Tree View (if specified). The default is YES.
+
+SHOW_FILES = YES
+
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
+# Namespaces page. This will remove the Namespaces entry from the Quick Index
+# and from the Folder Tree View (if specified). The default is YES.
+
+SHOW_NAMESPACES = YES
+
+# The FILE_VERSION_FILTER tag can be used to specify a program or script that
+# doxygen should invoke to get the current version for each file (typically from
+# the version control system). Doxygen will invoke the program by executing (via
+# popen()) the command <command> <input-file>, where <command> is the value of
+# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
+# provided by doxygen. Whatever the program writes to standard output
+# is used as the file version. See the manual for examples.
+
+FILE_VERSION_FILTER =
+
+# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
+# by doxygen. The layout file controls the global structure of the generated
+# output files in an output format independent way. To create the layout file
+# that represents doxygen's defaults, run doxygen with the -l option.
+# You can optionally specify a file name after the option, if omitted
+# DoxygenLayout.xml will be used as the name of the layout file.
+
+LAYOUT_FILE =
+
+# The CITE_BIB_FILES tag can be used to specify one or more bib files
+# containing the references data. This must be a list of .bib files. The
+# .bib extension is automatically appended if omitted. Using this command
+# requires the bibtex tool to be installed. See also
+# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
+# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
+# feature you need bibtex and perl available in the search path. Do not use
+# file names with spaces, bibtex cannot handle them.
+
+CITE_BIB_FILES =
+
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+
+# The QUIET tag can be used to turn on/off the messages that are generated
+# by doxygen. Possible values are YES and NO. If left blank NO is used.
+
+QUIET = NO
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated by doxygen. Possible values are YES and NO. If left blank
+# NO is used.
+
+WARNINGS = YES
+
+# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
+# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
+# automatically be disabled.
+
+WARN_IF_UNDOCUMENTED = YES
+
+# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
+# potential errors in the documentation, such as not documenting some
+# parameters in a documented function, or documenting parameters that
+# don't exist or using markup commands wrongly.
+
+WARN_IF_DOC_ERROR = YES
+
+# The WARN_NO_PARAMDOC option can be enabled to get warnings for
+# functions that are documented, but have no documentation for their parameters
+# or return value. If set to NO (the default) doxygen will only warn about
+# wrong or incomplete parameter documentation, but not about the absence of
+# documentation.
+
+WARN_NO_PARAMDOC = NO
+
+# The WARN_FORMAT tag determines the format of the warning messages that
+# doxygen can produce. The string should contain the $file, $line, and $text
+# tags, which will be replaced by the file and line number from which the
+# warning originated and the warning text. Optionally the format may contain
+# $version, which will be replaced by the version of the file (if it could
+# be obtained via FILE_VERSION_FILTER)
+
+WARN_FORMAT = "$file:$line: $text"
+
+# The WARN_LOGFILE tag can be used to specify a file to which warning
+# and error messages should be written. If left blank the output is written
+# to stderr.
+
+WARN_LOGFILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag can be used to specify the files and/or directories that contain
+# documented source files. You may enter file names like "myfile.cpp" or
+# directories like "/usr/src/myproject". Separate the files or directories
+# with spaces.
+
+INPUT = ../../codec/api/svc/codec_api.h ../../codec/api/svc/codec_app_def.h ../../codec/api/svc/codec_def.h
+
+# This tag can be used to specify the character encoding of the source files
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
+# also the default input encoding. Doxygen uses libiconv (or the iconv built
+# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
+# the list of possible encodings.
+
+INPUT_ENCODING = UTF-8
+
+# If the value of the INPUT tag contains directories, you can use the
+# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank the following patterns are tested:
+# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
+# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
+# *.f90 *.f *.for *.vhd *.vhdl
+
+FILE_PATTERNS = *.h
+
+# The RECURSIVE tag can be used to turn specify whether or not subdirectories
+# should be searched for input files as well. Possible values are YES and NO.
+# If left blank NO is used.
+
+RECURSIVE = NO
+
+# The EXCLUDE tag can be used to specify files and/or directories that should be
+# excluded from the INPUT source files. This way you can easily exclude a
+# subdirectory from a directory tree whose root is specified with the INPUT tag.
+# Note that relative paths are relative to the directory from which doxygen is
+# run.
+
+EXCLUDE =
+
+# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
+# directories that are symbolic links (a Unix file system feature) are excluded
+# from the input.
+
+EXCLUDE_SYMLINKS = NO
+
+# If the value of the INPUT tag contains directories, you can use the
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
+# certain files from those directories. Note that the wildcards are matched
+# against the file with absolute path, so to exclude all test directories
+# for example use the pattern */test/*
+
+EXCLUDE_PATTERNS =
+
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
+# (namespaces, classes, functions, etc.) that should be excluded from the
+# output. The symbol name can be a fully qualified name, a word, or if the
+# wildcard * is used, a substring. Examples: ANamespace, AClass,
+# AClass::ANamespace, ANamespace::*Test
+
+EXCLUDE_SYMBOLS =
+
+# The EXAMPLE_PATH tag can be used to specify one or more files or
+# directories that contain example code fragments that are included (see
+# the \include command).
+
+EXAMPLE_PATH =
+
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank all files are included.
+
+EXAMPLE_PATTERNS = *
+
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
+# searched for input files to be used with the \include or \dontinclude
+# commands irrespective of the value of the RECURSIVE tag.
+# Possible values are YES and NO. If left blank NO is used.
+
+EXAMPLE_RECURSIVE = NO
+
+# The IMAGE_PATH tag can be used to specify one or more files or
+# directories that contain image that are included in the documentation (see
+# the \image command).
+
+IMAGE_PATH =
+
+# The INPUT_FILTER tag can be used to specify a program that doxygen should
+# invoke to filter for each input file. Doxygen will invoke the filter program
+# by executing (via popen()) the command <filter> <input-file>, where <filter>
+# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
+# input file. Doxygen will then use the output that the filter program writes
+# to standard output. If FILTER_PATTERNS is specified, this tag will be
+# ignored.
+
+INPUT_FILTER =
+
+# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
+# basis. Doxygen will compare the file name with each pattern and apply the
+# filter if there is a match. The filters are a list of the form:
+# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
+# info on how filters are used. If FILTER_PATTERNS is empty or if
+# non of the patterns match the file name, INPUT_FILTER is applied.
+
+FILTER_PATTERNS =
+
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# INPUT_FILTER) will be used to filter the input files when producing source
+# files to browse (i.e. when SOURCE_BROWSER is set to YES).
+
+FILTER_SOURCE_FILES = NO
+
+# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
+# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
+# and it is also possible to disable source filtering for a specific pattern
+# using *.ext= (so without naming a filter). This option only has effect when
+# FILTER_SOURCE_FILES is enabled.
+
+FILTER_SOURCE_PATTERNS =
+
+# If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that
+# is part of the input, its contents will be placed on the main page (index.html).
+# This can be useful if you have a project on for instance GitHub and want reuse
+# the introduction page also for the doxygen output.
+
+USE_MDFILE_AS_MAINPAGE =
+
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will
+# be generated. Documented entities will be cross-referenced with these sources.
+# Note: To get rid of all source code in the generated output, make sure also
+# VERBATIM_HEADERS is set to NO.
+
+SOURCE_BROWSER = YES
+
+# Setting the INLINE_SOURCES tag to YES will include the body
+# of functions and classes directly in the documentation.
+
+INLINE_SOURCES = NO
+
+# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
+# doxygen to hide any special comment blocks from generated source code
+# fragments. Normal C, C++ and Fortran comments will always remain visible.
+
+STRIP_CODE_COMMENTS = YES
+
+# If the REFERENCED_BY_RELATION tag is set to YES
+# then for each documented function all documented
+# functions referencing it will be listed.
+
+REFERENCED_BY_RELATION = NO
+
+# If the REFERENCES_RELATION tag is set to YES
+# then for each documented function all documented entities
+# called/used by that function will be listed.
+
+REFERENCES_RELATION = NO
+
+# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
+# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
+# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
+# link to the source code. Otherwise they will link to the documentation.
+
+REFERENCES_LINK_SOURCE = YES
+
+# If the USE_HTAGS tag is set to YES then the references to source code
+# will point to the HTML generated by the htags(1) tool instead of doxygen
+# built-in source browser. The htags tool is part of GNU's global source
+# tagging system (see http://www.gnu.org/software/global/global.html). You
+# will need version 4.8.6 or higher.
+
+USE_HTAGS = NO
+
+# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
+# will generate a verbatim copy of the header file for each class for
+# which an include is specified. Set to NO to disable this.
+
+VERBATIM_HEADERS = YES
+
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
+# of all compounds will be generated. Enable this if the project
+# contains a lot of classes, structs, unions or interfaces.
+
+ALPHABETICAL_INDEX = YES
+
+# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
+# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
+# in which this list will be split (can be a number in the range [1..20])
+
+COLS_IN_ALPHA_INDEX = 5
+
+# In case all classes in a project start with a common prefix, all
+# classes will be put under the same header in the alphabetical index.
+# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
+# should be ignored while generating the index headers.
+
+IGNORE_PREFIX =
+
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
+# generate HTML output.
+
+GENERATE_HTML = YES
+
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `html' will be used as the default path.
+
+HTML_OUTPUT = html
+
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
+# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
+# doxygen will generate files with .html extension.
+
+HTML_FILE_EXTENSION = .html
+
+# The HTML_HEADER tag can be used to specify a personal HTML header for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard header. Note that when using a custom header you are responsible
+# for the proper inclusion of any scripts and style sheets that doxygen
+# needs, which is dependent on the configuration options used.
+# It is advised to generate a default header using "doxygen -w html
+# header.html footer.html stylesheet.css YourConfigFile" and then modify
+# that header. Note that the header is subject to change so you typically
+# have to redo this when upgrading to a newer version of doxygen or when
+# changing the value of configuration settings such as GENERATE_TREEVIEW!
+
+HTML_HEADER =
+
+# The HTML_FOOTER tag can be used to specify a personal HTML footer for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard footer.
+
+HTML_FOOTER =
+
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
+# style sheet that is used by each HTML page. It can be used to
+# fine-tune the look of the HTML output. If left blank doxygen will
+# generate a default style sheet. Note that it is recommended to use
+# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this
+# tag will in the future become obsolete.
+
+HTML_STYLESHEET =
+
+# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional
+# user-defined cascading style sheet that is included after the standard
+# style sheets created by doxygen. Using this option one can overrule
+# certain style aspects. This is preferred over using HTML_STYLESHEET
+# since it does not replace the standard style sheet and is therefor more
+# robust against future updates. Doxygen will copy the style sheet file to
+# the output directory.
+
+HTML_EXTRA_STYLESHEET =
+
+# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the HTML output directory. Note
+# that these files will be copied to the base HTML output directory. Use the
+# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
+# files. In the HTML_STYLESHEET file, use the file name only. Also note that
+# the files will be copied as-is; there are no commands or markers available.
+
+HTML_EXTRA_FILES =
+
+# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
+# Doxygen will adjust the colors in the style sheet and background images
+# according to this color. Hue is specified as an angle on a colorwheel,
+# see http://en.wikipedia.org/wiki/Hue for more information.
+# For instance the value 0 represents red, 60 is yellow, 120 is green,
+# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
+# The allowed range is 0 to 359.
+
+HTML_COLORSTYLE_HUE = 220
+
+# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
+# the colors in the HTML output. For a value of 0 the output will use
+# grayscales only. A value of 255 will produce the most vivid colors.
+
+HTML_COLORSTYLE_SAT = 100
+
+# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
+# the luminance component of the colors in the HTML output. Values below
+# 100 gradually make the output lighter, whereas values above 100 make
+# the output darker. The value divided by 100 is the actual gamma applied,
+# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
+# and 100 does not change the gamma.
+
+HTML_COLORSTYLE_GAMMA = 80
+
+# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
+# page will contain the date and time when the page was generated. Setting
+# this to NO can help when comparing the output of multiple runs.
+
+HTML_TIMESTAMP = YES
+
+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
+# documentation will contain sections that can be hidden and shown after the
+# page has loaded.
+
+HTML_DYNAMIC_SECTIONS = NO
+
+# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
+# entries shown in the various tree structured indices initially; the user
+# can expand and collapse entries dynamically later on. Doxygen will expand
+# the tree to such a level that at most the specified number of entries are
+# visible (unless a fully collapsed tree already exceeds this amount).
+# So setting the number of entries 1 will produce a full collapsed tree by
+# default. 0 is a special value representing an infinite number of entries
+# and will result in a full expanded tree by default.
+
+HTML_INDEX_NUM_ENTRIES = 100
+
+# If the GENERATE_DOCSET tag is set to YES, additional index files
+# will be generated that can be used as input for Apple's Xcode 3
+# integrated development environment, introduced with OSX 10.5 (Leopard).
+# To create a documentation set, doxygen will generate a Makefile in the
+# HTML output directory. Running make will produce the docset in that
+# directory and running "make install" will install the docset in
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
+# it at startup.
+# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
+# for more information.
+
+GENERATE_DOCSET = NO
+
+# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
+# feed. A documentation feed provides an umbrella under which multiple
+# documentation sets from a single provider (such as a company or product suite)
+# can be grouped.
+
+DOCSET_FEEDNAME = "Doxygen generated docs"
+
+# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
+# should uniquely identify the documentation set bundle. This should be a
+# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
+# will append .docset to the name.
+
+DOCSET_BUNDLE_ID = org.doxygen.Project
+
+# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely
+# identify the documentation publisher. This should be a reverse domain-name
+# style string, e.g. com.mycompany.MyDocSet.documentation.
+
+DOCSET_PUBLISHER_ID = org.doxygen.Publisher
+
+# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
+
+DOCSET_PUBLISHER_NAME = Publisher
+
+# If the GENERATE_HTMLHELP tag is set to YES, additional index files
+# will be generated that can be used as input for tools like the
+# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
+# of the generated HTML documentation.
+
+GENERATE_HTMLHELP = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
+# be used to specify the file name of the resulting .chm file. You
+# can add a path in front of the file if the result should not be
+# written to the html output directory.
+
+CHM_FILE =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
+# be used to specify the location (absolute path including file name) of
+# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
+# the HTML help compiler on the generated index.hhp.
+
+HHC_LOCATION =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
+# controls if a separate .chi index file is generated (YES) or that
+# it should be included in the master .chm file (NO).
+
+GENERATE_CHI = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
+# is used to encode HtmlHelp index (hhk), content (hhc) and project file
+# content.
+
+CHM_INDEX_ENCODING =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
+# controls whether a binary table of contents is generated (YES) or a
+# normal table of contents (NO) in the .chm file.
+
+BINARY_TOC = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members
+# to the contents of the HTML help documentation and to the tree view.
+
+TOC_EXPAND = NO
+
+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
+# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
+# that can be used as input for Qt's qhelpgenerator to generate a
+# Qt Compressed Help (.qch) of the generated HTML documentation.
+
+GENERATE_QHP = NO
+
+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
+# be used to specify the file name of the resulting .qch file.
+# The path specified is relative to the HTML output folder.
+
+QCH_FILE =
+
+# The QHP_NAMESPACE tag specifies the namespace to use when generating
+# Qt Help Project output. For more information please see
+# http://doc.trolltech.com/qthelpproject.html#namespace
+
+QHP_NAMESPACE = org.doxygen.Project
+
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
+# Qt Help Project output. For more information please see
+# http://doc.trolltech.com/qthelpproject.html#virtual-folders
+
+QHP_VIRTUAL_FOLDER = doc
+
+# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
+# add. For more information please see
+# http://doc.trolltech.com/qthelpproject.html#custom-filters
+
+QHP_CUST_FILTER_NAME =
+
+# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
+# custom filter to add. For more information please see
+# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
+# Qt Help Project / Custom Filters</a>.
+
+QHP_CUST_FILTER_ATTRS =
+
+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
+# project's
+# filter section matches.
+# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
+# Qt Help Project / Filter Attributes</a>.
+
+QHP_SECT_FILTER_ATTRS =
+
+# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
+# be used to specify the location of Qt's qhelpgenerator.
+# If non-empty doxygen will try to run qhelpgenerator on the generated
+# .qhp file.
+
+QHG_LOCATION =
+
+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
+# will be generated, which together with the HTML files, form an Eclipse help
+# plugin. To install this plugin and make it available under the help contents
+# menu in Eclipse, the contents of the directory containing the HTML and XML
+# files needs to be copied into the plugins directory of eclipse. The name of
+# the directory within the plugins directory should be the same as
+# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
+# the help appears.
+
+GENERATE_ECLIPSEHELP = NO
+
+# A unique identifier for the eclipse help plugin. When installing the plugin
+# the directory name containing the HTML and XML files should also have
+# this name.
+
+ECLIPSE_DOC_ID = org.doxygen.Project
+
+# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
+# at top of each HTML page. The value NO (the default) enables the index and
+# the value YES disables it. Since the tabs have the same information as the
+# navigation tree you can set this option to NO if you already set
+# GENERATE_TREEVIEW to YES.
+
+DISABLE_INDEX = NO
+
+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
+# structure should be generated to display hierarchical information.
+# If the tag value is set to YES, a side panel will be generated
+# containing a tree-like index structure (just like the one that
+# is generated for HTML Help). For this to work a browser that supports
+# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
+# Windows users are probably better off using the HTML help feature.
+# Since the tree basically has the same information as the tab index you
+# could consider to set DISABLE_INDEX to NO when enabling this option.
+
+GENERATE_TREEVIEW = NO
+
+# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
+# (range [0,1..20]) that doxygen will group on one line in the generated HTML
+# documentation. Note that a value of 0 will completely suppress the enum
+# values from appearing in the overview section.
+
+ENUM_VALUES_PER_LINE = 0
+
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
+# used to set the initial width (in pixels) of the frame in which the tree
+# is shown.
+
+TREEVIEW_WIDTH = 250
+
+# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
+# links to external symbols imported via tag files in a separate window.
+
+EXT_LINKS_IN_WINDOW = NO
+
+# Use this tag to change the font size of Latex formulas included
+# as images in the HTML documentation. The default is 10. Note that
+# when you change the font size after a successful doxygen run you need
+# to manually remove any form_*.png images from the HTML output directory
+# to force them to be regenerated.
+
+FORMULA_FONTSIZE = 10
+
+# Use the FORMULA_TRANPARENT tag to determine whether or not the images
+# generated for formulas are transparent PNGs. Transparent PNGs are
+# not supported properly for IE 6.0, but are supported on all modern browsers.
+# Note that when changing this option you need to delete any form_*.png files
+# in the HTML output before the changes have effect.
+
+FORMULA_TRANSPARENT = YES
+
+# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
+# (see http://www.mathjax.org) which uses client side Javascript for the
+# rendering instead of using prerendered bitmaps. Use this if you do not
+# have LaTeX installed or if you want to formulas look prettier in the HTML
+# output. When enabled you may also need to install MathJax separately and
+# configure the path to it using the MATHJAX_RELPATH option.
+
+USE_MATHJAX = NO
+
+# When MathJax is enabled you can set the default output format to be used for
+# thA MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and
+# SVG. The default value is HTML-CSS, which is slower, but has the best
+# compatibility.
+
+MATHJAX_FORMAT = HTML-CSS
+
+# When MathJax is enabled you need to specify the location relative to the
+# HTML output directory using the MATHJAX_RELPATH option. The destination
+# directory should contain the MathJax.js script. For instance, if the mathjax
+# directory is located at the same level as the HTML output directory, then
+# MATHJAX_RELPATH should be ../mathjax. The default value points to
+# the MathJax Content Delivery Network so you can quickly see the result without
+# installing MathJax. However, it is strongly recommended to install a local
+# copy of MathJax from http://www.mathjax.org before deployment.
+
+MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
+
+# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
+# names that should be enabled during MathJax rendering.
+
+MATHJAX_EXTENSIONS =
+
+# When the SEARCHENGINE tag is enabled doxygen will generate a search box
+# for the HTML output. The underlying search engine uses javascript
+# and DHTML and should work on any modern browser. Note that when using
+# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
+# (GENERATE_DOCSET) there is already a search function so this one should
+# typically be disabled. For large projects the javascript based search engine
+# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
+
+SEARCHENGINE = YES
+
+# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
+# implemented using a web server instead of a web client using Javascript.
+# There are two flavours of web server based search depending on the
+# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
+# searching and an index file used by the script. When EXTERNAL_SEARCH is
+# enabled the indexing and searching needs to be provided by external tools.
+# See the manual for details.
+
+SERVER_BASED_SEARCH = NO
+
+# When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP
+# script for searching. Instead the search results are written to an XML file
+# which needs to be processed by an external indexer. Doxygen will invoke an
+# external search engine pointed to by the SEARCHENGINE_URL option to obtain
+# the search results. Doxygen ships with an example indexer (doxyindexer) and
+# search engine (doxysearch.cgi) which are based on the open source search engine
+# library Xapian. See the manual for configuration details.
+
+EXTERNAL_SEARCH = NO
+
+# The SEARCHENGINE_URL should point to a search engine hosted by a web server
+# which will returned the search results when EXTERNAL_SEARCH is enabled.
+# Doxygen ships with an example search engine (doxysearch) which is based on
+# the open source search engine library Xapian. See the manual for configuration
+# details.
+
+SEARCHENGINE_URL =
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
+# search data is written to a file for indexing by an external tool. With the
+# SEARCHDATA_FILE tag the name of this file can be specified.
+
+SEARCHDATA_FILE = searchdata.xml
+
+# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through other
+# doxygen projects that are not otherwise connected via tags files, but are
+# all added to the same search index. Each project needs to have a tag file set
+# via GENERATE_TAGFILE. The search mapping then maps the name of the tag file
+# to a relative location where the documentation can be found, similar to the
+# TAGFILES option but without actually processing the tag file.
+# The format is: EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
+
+EXTRA_SEARCH_MAPPINGS =
+
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
+# generate Latex output.
+
+GENERATE_LATEX = NO
+
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `latex' will be used as the default path.
+
+LATEX_OUTPUT = latex
+
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
+# invoked. If left blank `latex' will be used as the default command name.
+# Note that when enabling USE_PDFLATEX this option is only used for
+# generating bitmaps for formulas in the HTML output, but not in the
+# Makefile that is written to the output directory.
+
+LATEX_CMD_NAME = latex
+
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
+# generate index for LaTeX. If left blank `makeindex' will be used as the
+# default command name.
+
+MAKEINDEX_CMD_NAME = makeindex
+
+# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
+# LaTeX documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_LATEX = NO
+
+# The PAPER_TYPE tag can be used to set the paper type that is used
+# by the printer. Possible values are: a4, letter, legal and
+# executive. If left blank a4wide will be used.
+
+PAPER_TYPE = a4
+
+# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
+# packages that should be included in the LaTeX output.
+
+EXTRA_PACKAGES =
+
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
+# the generated latex document. The header should contain everything until
+# the first chapter. If it is left blank doxygen will generate a
+# standard header. Notice: only use this tag if you know what you are doing!
+
+LATEX_HEADER =
+
+# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
+# the generated latex document. The footer should contain everything after
+# the last chapter. If it is left blank doxygen will generate a
+# standard footer. Notice: only use this tag if you know what you are doing!
+
+LATEX_FOOTER =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
+# is prepared for conversion to pdf (using ps2pdf). The pdf file will
+# contain links (just like the HTML output) instead of page references
+# This makes the output suitable for online browsing using a pdf viewer.
+
+PDF_HYPERLINKS = YES
+
+# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
+# plain latex in the generated Makefile. Set this option to YES to get a
+# higher quality PDF documentation.
+
+USE_PDFLATEX = YES
+
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
+# command to the generated LaTeX files. This will instruct LaTeX to keep
+# running if errors occur, instead of asking the user for help.
+# This option is also used when generating formulas in HTML.
+
+LATEX_BATCHMODE = NO
+
+# If LATEX_HIDE_INDICES is set to YES then doxygen will not
+# include the index chapters (such as File Index, Compound Index, etc.)
+# in the output.
+
+LATEX_HIDE_INDICES = NO
+
+# If LATEX_SOURCE_CODE is set to YES then doxygen will include
+# source code with syntax highlighting in the LaTeX output.
+# Note that which sources are shown also depends on other settings
+# such as SOURCE_BROWSER.
+
+LATEX_SOURCE_CODE = NO
+
+# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
+# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
+# http://en.wikipedia.org/wiki/BibTeX for more info.
+
+LATEX_BIB_STYLE = plain
+
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
+# The RTF output is optimized for Word 97 and may not look very pretty with
+# other RTF readers or editors.
+
+GENERATE_RTF = NO
+
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `rtf' will be used as the default path.
+
+RTF_OUTPUT = rtf
+
+# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
+# RTF documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_RTF = NO
+
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
+# will contain hyperlink fields. The RTF file will
+# contain links (just like the HTML output) instead of page references.
+# This makes the output suitable for online browsing using WORD or other
+# programs which support those fields.
+# Note: wordpad (write) and others do not support links.
+
+RTF_HYPERLINKS = NO
+
+# Load style sheet definitions from file. Syntax is similar to doxygen's
+# config file, i.e. a series of assignments. You only have to provide
+# replacements, missing definitions are set to their default value.
+
+RTF_STYLESHEET_FILE =
+
+# Set optional variables used in the generation of an rtf document.
+# Syntax is similar to doxygen's config file.
+
+RTF_EXTENSIONS_FILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
+# generate man pages
+
+GENERATE_MAN = NO
+
+# The MAN_OUTPUT tag is used to specify where the man pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `man' will be used as the default path.
+
+MAN_OUTPUT = man
+
+# The MAN_EXTENSION tag determines the extension that is added to
+# the generated man pages (default is the subroutine's section .3)
+
+MAN_EXTENSION = .3
+
+# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
+# then it will generate one additional man file for each entity
+# documented in the real man page(s). These additional files
+# only source the real man page, but without them the man command
+# would be unable to find the correct page. The default is NO.
+
+MAN_LINKS = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_XML tag is set to YES Doxygen will
+# generate an XML file that captures the structure of
+# the code including all documentation.
+
+GENERATE_XML = YES
+
+# The XML_OUTPUT tag is used to specify where the XML pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `xml' will be used as the default path.
+
+XML_OUTPUT = xml
+
+# The XML_SCHEMA tag can be used to specify an XML schema,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_SCHEMA =
+
+# The XML_DTD tag can be used to specify an XML DTD,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_DTD =
+
+# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
+# dump the program listings (including syntax highlighting
+# and cross-referencing information) to the XML output. Note that
+# enabling this will significantly increase the size of the XML output.
+
+XML_PROGRAMLISTING = YES
+
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
+# generate an AutoGen Definitions (see autogen.sf.net) file
+# that captures the structure of the code including all
+# documentation. Note that this feature is still experimental
+# and incomplete at the moment.
+
+GENERATE_AUTOGEN_DEF = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_PERLMOD tag is set to YES Doxygen will
+# generate a Perl module file that captures the structure of
+# the code including all documentation. Note that this
+# feature is still experimental and incomplete at the
+# moment.
+
+GENERATE_PERLMOD = NO
+
+# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
+# the necessary Makefile rules, Perl scripts and LaTeX code to be able
+# to generate PDF and DVI output from the Perl module output.
+
+PERLMOD_LATEX = NO
+
+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
+# nicely formatted so it can be parsed by a human reader. This is useful
+# if you want to understand what is going on. On the other hand, if this
+# tag is set to NO the size of the Perl module output will be much smaller
+# and Perl will parse it just the same.
+
+PERLMOD_PRETTY = YES
+
+# The names of the make variables in the generated doxyrules.make file
+# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
+# This is useful so different doxyrules.make files included by the same
+# Makefile don't overwrite each other's variables.
+
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
+# evaluate all C-preprocessor directives found in the sources and include
+# files.
+
+ENABLE_PREPROCESSING = NO
+
+# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
+# names in the source code. If set to NO (the default) only conditional
+# compilation will be performed. Macro expansion can be done in a controlled
+# way by setting EXPAND_ONLY_PREDEF to YES.
+
+MACRO_EXPANSION = NO
+
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
+# then the macro expansion is limited to the macros specified with the
+# PREDEFINED and EXPAND_AS_DEFINED tags.
+
+EXPAND_ONLY_PREDEF = NO
+
+# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
+# pointed to by INCLUDE_PATH will be searched when a #include is found.
+
+SEARCH_INCLUDES = YES
+
+# The INCLUDE_PATH tag can be used to specify one or more directories that
+# contain include files that are not input files but should be processed by
+# the preprocessor.
+
+INCLUDE_PATH =
+
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
+# patterns (like *.h and *.hpp) to filter out the header-files in the
+# directories. If left blank, the patterns specified with FILE_PATTERNS will
+# be used.
+
+INCLUDE_FILE_PATTERNS =
+
+# The PREDEFINED tag can be used to specify one or more macro names that
+# are defined before the preprocessor is started (similar to the -D option of
+# gcc). The argument of the tag is a list of macros of the form: name
+# or name=definition (no spaces). If the definition and the = are
+# omitted =1 is assumed. To prevent a macro definition from being
+# undefined via #undef or recursively expanded use the := operator
+# instead of the = operator.
+
+PREDEFINED =
+
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
+# this tag can be used to specify a list of macro names that should be expanded.
+# The macro definition that is found in the sources will be used.
+# Use the PREDEFINED tag if you want to use a different macro definition that
+# overrules the definition found in the source code.
+
+EXPAND_AS_DEFINED =
+
+# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
+# doxygen's preprocessor will remove all references to function-like macros
+# that are alone on a line, have an all uppercase name, and do not end with a
+# semicolon, because these will confuse the parser if not removed.
+
+SKIP_FUNCTION_MACROS = YES
+
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references
+#---------------------------------------------------------------------------
+
+# The TAGFILES option can be used to specify one or more tagfiles. For each
+# tag file the location of the external documentation should be added. The
+# format of a tag file without this location is as follows:
+# TAGFILES = file1 file2 ...
+# Adding location for the tag files is done as follows:
+# TAGFILES = file1=loc1 "file2 = loc2" ...
+# where "loc1" and "loc2" can be relative or absolute paths
+# or URLs. Note that each tag file must have a unique name (where the name does
+# NOT include the path). If a tag file is not located in the directory in which
+# doxygen is run, you must also specify the path to the tagfile here.
+
+TAGFILES =
+
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create
+# a tag file that is based on the input files it reads.
+
+GENERATE_TAGFILE =
+
+# If the ALLEXTERNALS tag is set to YES all external classes will be listed
+# in the class index. If set to NO only the inherited external classes
+# will be listed.
+
+ALLEXTERNALS = NO
+
+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
+# in the modules index. If set to NO, only the current project's groups will
+# be listed.
+
+EXTERNAL_GROUPS = YES
+
+# The PERL_PATH should be the absolute path and name of the perl script
+# interpreter (i.e. the result of `which perl').
+
+PERL_PATH = /usr/bin/perl
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+
+# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
+# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
+# or super classes. Setting the tag to NO turns the diagrams off. Note that
+# this option also works with HAVE_DOT disabled, but it is recommended to
+# install and use dot, since it yields more powerful graphs.
+
+CLASS_DIAGRAMS = YES
+
+# You can define message sequence charts within doxygen comments using the \msc
+# command. Doxygen will then run the mscgen tool (see
+# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
+# documentation. The MSCGEN_PATH tag allows you to specify the directory where
+# the mscgen tool resides. If left empty the tool is assumed to be found in the
+# default search path.
+
+MSCGEN_PATH =
+
+# If set to YES, the inheritance and collaboration graphs will hide
+# inheritance and usage relations if the target is undocumented
+# or is not a class.
+
+HIDE_UNDOC_RELATIONS = YES
+
+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
+# available from the path. This tool is part of Graphviz, a graph visualization
+# toolkit from AT&T and Lucent Bell Labs. The other options in this section
+# have no effect if this option is set to NO (the default)
+
+HAVE_DOT = NO
+
+# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
+# allowed to run in parallel. When set to 0 (the default) doxygen will
+# base this on the number of processors available in the system. You can set it
+# explicitly to a value larger than 0 to get control over the balance
+# between CPU load and processing speed.
+
+DOT_NUM_THREADS = 0
+
+# By default doxygen will use the Helvetica font for all dot files that
+# doxygen generates. When you want a differently looking font you can specify
+# the font name using DOT_FONTNAME. You need to make sure dot is able to find
+# the font, which can be done by putting it in a standard location or by setting
+# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
+# directory containing the font.
+
+DOT_FONTNAME = Helvetica
+
+# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
+# The default size is 10pt.
+
+DOT_FONTSIZE = 10
+
+# By default doxygen will tell dot to use the Helvetica font.
+# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
+# set the path where dot can find it.
+
+DOT_FONTPATH =
+
+# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect inheritance relations. Setting this tag to YES will force the
+# CLASS_DIAGRAMS tag to NO.
+
+CLASS_GRAPH = YES
+
+# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect implementation dependencies (inheritance, containment, and
+# class references variables) of the class with other documented classes.
+
+COLLABORATION_GRAPH = YES
+
+# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for groups, showing the direct groups dependencies
+
+GROUP_GRAPHS = YES
+
+# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
+# collaboration diagrams in a style similar to the OMG's Unified Modeling
+# Language.
+
+UML_LOOK = NO
+
+# If the UML_LOOK tag is enabled, the fields and methods are shown inside
+# the class node. If there are many fields or methods and many nodes the
+# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
+# threshold limits the number of items for each type to make the size more
+# managable. Set this to 0 for no limit. Note that the threshold may be
+# exceeded by 50% before the limit is enforced.
+
+UML_LIMIT_NUM_FIELDS = 10
+
+# If set to YES, the inheritance and collaboration graphs will show the
+# relations between templates and their instances.
+
+TEMPLATE_RELATIONS = NO
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
+# tags are set to YES then doxygen will generate a graph for each documented
+# file showing the direct and indirect include dependencies of the file with
+# other documented files.
+
+INCLUDE_GRAPH = YES
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
+# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
+# documented header file showing the documented files that directly or
+# indirectly include this file.
+
+INCLUDED_BY_GRAPH = YES
+
+# If the CALL_GRAPH and HAVE_DOT options are set to YES then
+# doxygen will generate a call dependency graph for every global function
+# or class method. Note that enabling this option will significantly increase
+# the time of a run. So in most cases it will be better to enable call graphs
+# for selected functions only using the \callgraph command.
+
+CALL_GRAPH = YES
+
+# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
+# doxygen will generate a caller dependency graph for every global function
+# or class method. Note that enabling this option will significantly increase
+# the time of a run. So in most cases it will be better to enable caller
+# graphs for selected functions only using the \callergraph command.
+
+CALLER_GRAPH = YES
+
+# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
+# will generate a graphical hierarchy of all classes instead of a textual one.
+
+GRAPHICAL_HIERARCHY = YES
+
+# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
+# then doxygen will show the dependencies a directory has on other directories
+# in a graphical way. The dependency relations are determined by the #include
+# relations between the files in the directories.
+
+DIRECTORY_GRAPH = YES
+
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
+# generated by dot. Possible values are svg, png, jpg, or gif.
+# If left blank png will be used. If you choose svg you need to set
+# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
+# visible in IE 9+ (other browsers do not have this requirement).
+
+DOT_IMAGE_FORMAT = png
+
+# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
+# enable generation of interactive SVG images that allow zooming and panning.
+# Note that this requires a modern browser other than Internet Explorer.
+# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
+# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
+# visible. Older versions of IE do not have SVG support.
+
+INTERACTIVE_SVG = NO
+
+# The tag DOT_PATH can be used to specify the path where the dot tool can be
+# found. If left blank, it is assumed the dot tool can be found in the path.
+
+DOT_PATH =
+
+# The DOTFILE_DIRS tag can be used to specify one or more directories that
+# contain dot files that are included in the documentation (see the
+# \dotfile command).
+
+DOTFILE_DIRS =
+
+# The MSCFILE_DIRS tag can be used to specify one or more directories that
+# contain msc files that are included in the documentation (see the
+# \mscfile command).
+
+MSCFILE_DIRS =
+
+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
+# nodes that will be shown in the graph. If the number of nodes in a graph
+# becomes larger than this value, doxygen will truncate the graph, which is
+# visualized by representing a node as a red box. Note that doxygen if the
+# number of direct children of the root node in a graph is already larger than
+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
+# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
+
+DOT_GRAPH_MAX_NODES = 50
+
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
+# graphs generated by dot. A depth value of 3 means that only nodes reachable
+# from the root by following a path via at most 3 edges will be shown. Nodes
+# that lay further from the root node will be omitted. Note that setting this
+# option to 1 or 2 may greatly reduce the computation time needed for large
+# code bases. Also note that the size of a graph can be further restricted by
+# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
+
+MAX_DOT_GRAPH_DEPTH = 0
+
+# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
+# background. This is disabled by default, because dot on Windows does not
+# seem to support this out of the box. Warning: Depending on the platform used,
+# enabling this option may lead to badly anti-aliased labels on the edges of
+# a graph (i.e. they become hard to read).
+
+DOT_TRANSPARENT = NO
+
+# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
+# files in one run (i.e. multiple -o and -T options on the command line). This
+# makes dot run faster, but since only newer versions of dot (>1.8.10)
+# support this, this feature is disabled by default.
+
+DOT_MULTI_TARGETS = NO
+
+# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
+# generate a legend page explaining the meaning of the various boxes and
+# arrows in the dot generated graphs.
+
+GENERATE_LEGEND = YES
+
+# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
+# remove the intermediate dot files that are used to generate
+# the various graphs.
+
+DOT_CLEANUP = YES
--- /dev/null
+++ b/docs/doxygen/Home.rest
@@ -1,0 +1,25 @@
+.. contents::
+ :local:
+
+1. Overview
+---------------------
+<doxygen2rst page=Overview> Overview </doxygen2rst>
+
+2. Page index
+---------------------
+ - `ISVCEncoder <wiki/ISVCEncoder>`_
+ - `ISVCDecoder <wiki/ISVCDecoder>`_
+ - `Example code for encoder usage <wiki/UsageExampleForEncoder>`_
+ - `Example code for decoder usage <wiki/UsageExampleForDecoder>`_
+ - `How to update wiki page <wiki/API2Wiki>`_
+
+3. Classes
+---------------------
+
+ - `ISVCEncoder <wiki/ISVCEncoder>`_
+ - `ISVCDecoder <wiki/ISVCDecoder>`_
+ - `Types and Structures <wiki/TypesAndStructures>`_
+
+4. License
+---------------------
+<doxygen2rst page=License> License </doxygen2rst>
\ No newline at end of file
--- /dev/null
+++ b/docs/doxygen/ISVCDecoder.rest
@@ -1,0 +1,19 @@
+This file describes the interface of ISVCDecoder
+
+.. contents::
+ :local:
+ :depth: 2
+
+
+Methods(ISVCDecoder)
+============================
+<doxygen2rst class=ISVCDecoder> Class:ISVCDecoder </doxygen2rst>
+
+Global functions
+============================
+
+<doxygen2rst function=WelsGetDecoderCapability> function:WelsGetDecoderCapability </doxygen2rst>
+
+<doxygen2rst function=WelsCreateDecoder> function:WelsCreateDecoder </doxygen2rst>
+
+<doxygen2rst function=WelsDestroyDecoder> function:WelsDestroyDecoder </doxygen2rst>
\ No newline at end of file
--- /dev/null
+++ b/docs/doxygen/ISVCEncoder.rest
@@ -1,0 +1,16 @@
+This file describes the interface of ISVCEncoder
+
+.. contents::
+ :local:
+ :depth: 2
+
+
+Methods(ISVCEncoder)
+============================
+<doxygen2rst class=ISVCEncoder> Class:ISVCEncoder </doxygen2rst>
+
+Global functions
+===========================
+<doxygen2rst function=WelsCreateSVCEncoder> function:WelsCreateSVCEncoder </doxygen2rst>
+
+<doxygen2rst function=WelsDestroySVCEncoder> function:WelsDestroySVCEncoder </doxygen2rst>
\ No newline at end of file
--- /dev/null
+++ b/docs/doxygen/UsageExampleForDecoder.rest
@@ -1,0 +1,10 @@
+This page is about the example of decoder usage
+
+.. contents::
+ :local:
+ :depth: 2
+
+
+Decoder Usage Example(ISVCDecoder)
+=================================
+<doxygen2rst page=DecoderUsageExample> Decoder usage example </doxygen2rst>
\ No newline at end of file
--- /dev/null
+++ b/docs/doxygen/UsageExampleForEncoder.rest
@@ -1,0 +1,15 @@
+This page is about the example of encoder usage
+
+.. contents::
+ :local:
+ :depth: 2
+
+
+Encoder Usage Example-1
+============================
+<doxygen2rst page=EncoderUsageExample1> Encoder usage example 1 </doxygen2rst>
+
+Encoder Usage Example-2
+============================
+<doxygen2rst page=EncoderUsageExample2> Encoder usage example 2 </doxygen2rst>
+
--- /dev/null
+++ b/docs/doxygen2rst.py
@@ -1,0 +1,619 @@
+from __future__ import print_function
+import re, sys, os, time, glob, errno, tempfile, binascii, subprocess, shutil
+from lxml import etree
+from optparse import OptionParser
+import textwrap
+import string
+
+VERSION = '0.1'
+__all__ = ['DoxyGen2RST']
+LINE_BREAKER = "\n"
+MAX_COLUMN = 80
+
+def is_valid_uuid(uuid_string):
+ uuid4hex = re.compile('[0-9a-f]{32}\Z', re.I)+ return uuid4hex.match(uuid_string) != None
+
+def get_page(refid):
+ fields = refid.split("_")+ if(is_valid_uuid(fields[-1][-32:])):
+ return ["_".join(fields[0:-1]), fields[-1]]
+ return [refid, None]
+
+def mkdir_p(path):
+ try:
+ os.makedirs(path)
+ except OSError as exc: # Python >2.5
+ if exc.errno == errno.EEXIST and os.path.isdir(path):
+ pass
+ else:
+ raise
+
+def _glob(path, *exts):
+ path = os.path.join(path, "*") if os.path.isdir(path) else path + "*"
+ return [f for files in [glob.glob(path + ext) for ext in exts] for f in files]
+
+class DoxyGen2RST(object):
+ """
+ Customize the Doxygen XML output into RST format, then it can
+ be translated into all formats with the unified user interface.
+ The Doxygen output itself is too verbose and not hard to be
+ organized for a good documentation.
+ """
+
+ def __init__(self,
+ src,
+ dst,
+ missing_filename = "missing.rst",
+ is_github = False,
+ enable_uml = True,
+ github_ext = ""):
+ self.doxy_output_dir = os.path.join(src, "_doxygen", "xml")
+ self.output_dir = dst
+ self.rst_dir = src
+ self.enable_uml = enable_uml
+ mkdir_p(dst)
+ self.is_github = is_github
+ if(is_github):
+ self.page_ext = github_ext
+ self.anchor_prefix = "wiki-"
+ else:
+ self.anchor_prefix = ""
+ self.page_ext = ".html"
+ self.filter = ["*.rst", "*.rest"]
+ self.re_doxy = "<doxygen2rst\s(\S*)=(\S*)>(.*?)</doxygen2rst>"
+ self.index_root = etree.parse(os.path.join(self.doxy_output_dir, "index.xml")).getroot()
+ self.references = {}+ self.missed_types_structs = {}+ self.name_refid_map = {}+ self.build_references()
+ self.page_references = {}+ self.missing_filename = missing_filename
+ self.temp_uml_path = os.path.join(tempfile.gettempdir(), "uml_" + binascii.b2a_hex(os.urandom(15)))
+ if os.path.exists(self.temp_uml_path):
+ shutil.rmtree(self.temp_uml_path)
+ os.mkdir(self.temp_uml_path)
+
+ def _find_ref_id(self, kind, name):
+ #print("_find_ref_id, %s - %s" %(kind, name))+ if(kind == "function"):
+ for comp in self.index_root.iter("member"):+ if(comp.attrib["kind"].lower() == kind.lower() and
+ comp.findtext("name").lower() == name.lower()):+ return (comp.attrib["refid"])
+ pass
+ else:
+ for comp in self.index_root.iter("compound"):+ if(comp.attrib["kind"].lower() == kind.lower() and
+ comp.findtext("name").lower() == name.lower()):+ return comp.attrib["refid"]
+ return None
+
+ def strip_title_ref(self, text):
+ table = string.maketrans("","")+ retstr = text.translate(table, string.punctuation)
+ words = retstr.split()
+ retstr = "-".join(words)
+ return retstr.lower()
+
+ def build_references(self):
+ for file in _glob(self.rst_dir, *self.filter):
+ filename = os.path.basename(file)
+ fin = open(file,'r')
+ content = fin.read()
+ it = re.finditer(self.re_doxy, content, re.DOTALL)
+ for m in it:
+ ref_id = self._find_ref_id(m.groups()[0], m.groups()[1])
+ if(ref_id is None):
+ #print("Reference is NOT found for: %s=%s" % (m.groups()[0], m.groups()[1]))+ continue
+ page_name = os.path.splitext(filename)[0]
+ title_ref = self.strip_title_ref(m.groups()[2])
+ self.references[ref_id] = [m.groups()[0], m.groups()[1], page_name, filename, title_ref]
+ self.name_refid_map[m.groups()[1]] = ref_id
+ fin.close()
+ #print(self.references)
+
+ def call_plantuml(self):
+ if(not self.enable_uml):
+ return
+
+ java_bin = os.path.join(os.environ['JAVA_HOME'], "bin", "java")
+ output_path = os.path.abspath(os.path.join(self.output_dir, "images"))
+ cmds = ["\"" + java_bin + "\"", "-jar", "plantuml.jar", self.temp_uml_path + "/", "-o", output_path]
+ print(" ".join(cmds))+ os.system(" ".join(cmds))+ shutil.rmtree(self.temp_uml_path)
+
+ def _build_uml(self, uml_name, content):
+ uml_path = os.path.join(self.temp_uml_path, uml_name + ".txt")
+ fuml = open(uml_path, "w+")
+ fuml.write("@startuml\n")+ fuml.write(content)
+ fuml.write("\n@enduml\n")+ fuml.close()
+ return ".. image:: images/" + uml_name + ".png" + LINE_BREAKER
+
+ def _build(self, m):
+ retstr = ""
+ if(m.groups()[0] == "uml"):
+ retstr = self._build_uml(m.groups()[1], m.groups()[2])
+ elif(m.groups()[0] == "link"):
+ link = m.groups()[1] + self.page_ext
+ retstr = ("`%s <%s>`_" % (m.groups()[2], link))+ else:
+ if(m.groups()[0] != "function"):
+ retstr += self._build_title(m.groups()[2])
+ retstr += self.convert_doxy(m.groups()[0], m.groups()[1])
+
+ return retstr
+
+ def generate(self):
+ for file in _glob(self.rst_dir, *self.filter):
+ filename = os.path.basename(file)
+ fin = open(file,'r')
+ input_txt = fin.read()
+ fin.close()
+
+ output_txt = re.sub(self.re_doxy, self._build, input_txt, 0, re.DOTALL)
+ output_txt += self._build_page_ref_notes()
+
+ fout = open(os.path.join(self.output_dir, filename), 'w+')
+ fout.write(output_txt)
+ fout.close()
+ #print("%s --- %s" %( file, os.path.join(self.output_dir, filename)))+
+ self._build_missed_types_and_structs()
+ self.call_plantuml()
+
+ def make_para_title(self, title, indent = 4):
+ retstr = LINE_BREAKER
+ if(title):
+ retstr += "".ljust(indent, " ") + "| **" + title + "**" + LINE_BREAKER
+ return retstr
+
+ def _build_title(self, title, flag = '=', ref = None):
+ retstr = LINE_BREAKER
+ if(ref):
+ retstr += ".. _ref-" + ref + ":" + LINE_BREAKER + LINE_BREAKER
+ retstr += title + LINE_BREAKER
+ retstr += "".ljust(20, flag) + LINE_BREAKER
+ retstr += LINE_BREAKER
+ return retstr
+
+ def _build_ref(self, node):
+ text = node.text.strip()
+ retstr = ""
+ target = '`' + text + '`'
+ retstr += target + "_ "
+ if target in self.page_references:
+ reflink = self.page_references[target]
+ print("Link already added: %s == %s" % (reflink[0], node.attrib["refid"]))+ assert(reflink[0] == node.attrib["refid"])
+ pass
+ else:
+ self.page_references[target] = (node.attrib["refid"], node.attrib["kindref"], text)
+
+ return retstr
+
+ def _build_code_block(self, node):
+ retstr = "::" + LINE_BREAKER + LINE_BREAKER
+ for codeline in node.iter("codeline"):+ retstr += " "
+ for phrases in codeline.iter("highlight"):+ if(phrases.text):
+ retstr += phrases.text.strip()
+ for child in phrases:
+ if(child.text):
+ retstr += child.text.strip()
+ if(child.tag == "sp"):
+ retstr += " "
+ if(child.tag == "ref" and child.text):
+ #escape the reference in the code block
+ retstr += "" # self._build_ref(child)
+ if(child.tail):
+ retstr += child.tail.strip()
+ retstr += LINE_BREAKER
+ return retstr
+
+ def _build_itemlist(self, node):
+ retstr = ""
+ for para in node:
+ if(para.tag != "para"):
+ continue
+ if(para.text):
+ retstr += para.text.strip()
+ for child in para:
+ if(child.tag == "ref" and child.text):
+ retstr += self._build_ref(child)
+ if(child.tail):
+ retstr += child.tail.strip()
+
+ return retstr
+
+ def _build_itemizedlist(self, node):
+ retstr = LINE_BREAKER
+ if(node == None):
+ return ""
+ for item in node:
+ if(item.tag != "listitem"):
+ continue
+ retstr += " - " + self._build_itemlist(item)
+ retstr += LINE_BREAKER
+ return retstr
+
+ def _build_verbatim(self, node):
+ retstr = LINE_BREAKER
+ if(node.text):
+ lines = node.text.splitlines()
+ print(lines[0])
+ m = re.search("{plantuml}\s(\S*)", lines[0])+ if(m):
+ uml_name = "uml_" + m.groups()[0]
+ retstr += self._build_uml(uml_name, "\n".join(lines[1:]))
+ else:
+ retstr += "::" + LINE_BREAKER + LINE_BREAKER
+ retstr += node.text
+
+ return retstr
+
+ def _build_para(self, para):
+ retstr = ""
+ no_new_line = False
+ if(para.text):
+ retstr += textwrap.fill(para.text.strip(), MAX_COLUMN) + LINE_BREAKER + LINE_BREAKER
+ for child in para:
+ no_new_line = False
+ if(child.tag == "simplesect"):
+ for child_para in child:
+ if(child.attrib["kind"] == "return"):
+ return_str = self._build_para(child_para)
+ retstr += "".ljust(4, " ") + "| Return:" + LINE_BREAKER
+ for line in return_str.splitlines():
+ retstr += "".ljust(4, " ") + "| " + line + LINE_BREAKER
+ elif(child_para.tag == "title" and child_para.text):
+ lf.make_para_title(child_para.text.strip(), 4)
+ elif(child_para.tag == "para"): #for @see
+ retstr += self._build_para(child_para)
+ elif(child_para.text):
+ retstr += "".ljust(4, " ") + "| " + child_para.text.strip() + LINE_BREAKER
+ if(child.tag == "preformatted"):
+ retstr += "::" + LINE_BREAKER + LINE_BREAKER
+ if(child.text):
+ for line in child.text.splitlines():
+ retstr += " " + line + LINE_BREAKER
+ if(child.tag == "ref" and child.text):
+ retstr = retstr.rstrip('\n')+ retstr += " " + self._build_ref(child)
+ no_new_line = True
+ if(child.tag == "programlisting"):
+ retstr += self._build_code_block(child)
+ if(child.tag == "itemizedlist"):
+ retstr += self._build_itemizedlist(child)
+ if(child.tag == "verbatim"):
+ retstr += self._build_verbatim(child)
+ if(not no_new_line):
+ retstr += LINE_BREAKER
+ if(child.tail):
+ retstr += textwrap.fill(child.tail.strip(), MAX_COLUMN) + LINE_BREAKER + LINE_BREAKER
+ return retstr
+
+ def get_text(self, node):
+ retstr = ""
+ if(node == None):
+ return ""
+ for para in node:
+ if(para.tag != "para"):
+ continue
+ retstr += self._build_para(para)
+
+ return retstr
+
+ def _find_text_ref(self, node):
+ retstr = ""
+ if(node.text):
+ retstr += node.text.strip()
+ for child in node:
+ if(child.tag == "ref"):
+ retstr += " " + self._build_ref(child) + " "
+ if(child.tail):
+ retstr += child.tail.strip()
+ return retstr
+
+ def _build_row_breaker(self, columns):
+ retstr = "+"
+ for column in columns:
+ retstr += "".ljust(column, "-") + "+"
+ return retstr + LINE_BREAKER
+
+ def _wrap_cell(self, text, length = 30):
+ newlines = []
+ for line in text.splitlines():
+ newlines.extend(textwrap.wrap(line, length))
+ return newlines
+
+ def _build_row(self, row, columns):
+ retstr = ""
+ row_lines = []
+ max_line = 0
+ for i in range(3):
+ row_lines.append(row[i].splitlines())
+ if(max_line < len(row_lines[i])):
+ max_line = len(row_lines[i])
+
+ for i in range(max_line):
+ for j in range(3):
+ retstr += "|"
+ if(len(row_lines[j]) > i):
+ retstr += row_lines[j][i]
+ retstr += "".ljust(columns[j] - len(row_lines[j][i]), " ")
+ else:
+ retstr += "".ljust(columns[j], " ")
+ retstr += "|" + LINE_BREAKER
+ return retstr
+
+ def _build_table(self, rows):
+ retstr = ""
+ columns = [0, 0, 0]
+ for row in rows:
+ for i in range(3):
+ for rowline in row[i].splitlines():
+ if(columns[i] < len(rowline) + 2):
+ columns[i] = len(rowline) + 2
+
+ #columns[0] = 40 if(columns[0] > 40) else columns[0]
+ #columns[1] = 40 if(columns[1] > 40) else columns[1]
+ #columns[2] = MAX_COLUMN - columns[0] - columns[1]
+
+ retstr += self._build_row_breaker(columns)
+ for row in rows:
+ retstr += self._build_row(row, columns)
+ retstr += self._build_row_breaker(columns)
+ return retstr;
+
+ def build_param_list(self, params, paramdescs):
+ retstr = ""
+ param_descriptions = []
+ for desc in paramdescs:
+ param_descriptions.append(desc)
+
+ rows = []
+ rows.append(("Name", "Type", "Descritpion"))+ for param in params:
+ declname = param.findtext("declname")+ paramdesc = None
+ for desc in param_descriptions:
+ paramname = desc.findtext("parameternamelist/parametername")+ if(paramname.lower() == declname.lower()):
+ paramdesc = desc.find("parameterdescription")+ break
+ decltype = self._find_text_ref(param.find("type"))+ rows.append((declname, decltype, self.get_text(paramdesc)))
+
+ if(len(rows) > 1):
+ retstr += self._build_table(rows)
+ return retstr
+
+ def _build_enum(self, member):
+ enum_id = member.attrib["id"]
+ file, tag = get_page(enum_id)
+ retstr = self._build_title(member.findtext("name"), ref = tag)+ detail_node = self.get_desc_node(member)
+ if(detail_node is not None):
+ retstr += LINE_BREAKER
+ retstr += self.get_text(detail_node)
+
+ rows = []
+ rows.append(("Name", "Initializer", "Descritpion"))+ for enumvalue in member.iter("enumvalue"):+ name = enumvalue.findtext("name")+ initializer = enumvalue.findtext("initializer")+ if(not initializer):
+ initializer = ""
+ desc = self.get_text(enumvalue.find("briefdescription"))+ desc += self.get_text(enumvalue.find("detaileddescription"))+ if(not desc):
+ desc = ""
+ rows.append((name, initializer, desc))
+
+ if(len(rows) > 1):
+ retstr += self._build_table(rows)
+ return retstr
+
+
+ def _build_struct(self, node):
+ retstr = ""
+ detail_node = self.get_desc_node(node)
+ if(detail_node is not None):
+ retstr += self.get_text(detail_node) + LINE_BREAKER
+ rows = []
+ rows.append(("Name", "Type", "Descritpion"))+ for member in node.iter("memberdef"):+ if(member.attrib["kind"] == "variable"):
+ name = member.findtext("name")+ type = self._find_text_ref(member.find("type"))+ desc = self.get_text(member.find("briefdescription"))+ desc += self.get_text(member.find("detaileddescription"))+ desc += self.get_text(member.find("inbodydescription"))+ if(not desc):
+ desc = ""
+ rows.append((name, type, desc))
+
+ if(len(rows) > 1):
+ retstr += self._build_table(rows)
+ return retstr
+
+ def _build_class(self, node):
+ retstr = ""
+
+ for member in node.iter("memberdef"):+ if(member.attrib["kind"] == "function"):
+ retstr += self.build_function(member)
+ return retstr
+
+ def get_desc_node(self, member):
+ detail_node = member.find("detaileddescription")+ brief_node = member.find("briefdescription")+ detail_txt = ""
+ if(detail_node == None and brief_node == None):
+ return None
+
+ if(detail_node is not None):
+ detail_txt = detail_node.findtext("para")+
+ if(not detail_txt and brief_node != None):
+ detail_txt = brief_node.findtext("para")+ detail_node = brief_node
+
+ return detail_node
+
+ def build_function(self, member):
+ retstr = ""
+
+ desc_node = self.get_desc_node(member)
+ if(desc_node is None):
+ return ""
+ detail_txt = desc_node.findtext("para")+ if(not detail_txt or detail_txt.strip() == "{ignore}"):+ return ""
+
+ func_id = member.attrib["id"]
+ page_id, ref_id = get_page(func_id)
+ retstr += self._build_title(member.findtext("name"), '-', ref = ref_id)+ retstr += self.get_text(desc_node)
+ retstr += LINE_BREAKER
+ detail_node = member.find("detaileddescription")+ if(desc_node != detail_node):
+ retstr += self.get_text(detail_node)
+ retstr += self.build_param_list(member.iter("param"), detail_node.iter("parameteritem"))+ return retstr
+
+ def _build_missed_types_and_structs(self):
+ fout = open(os.path.join(self.output_dir, self.missing_filename), 'w+')
+ fout.write(".. contents:: " + LINE_BREAKER)+ fout.write(" :local:" + LINE_BREAKER)+ fout.write(" :depth: 2" + LINE_BREAKER + LINE_BREAKER)+
+ footnote = ""
+ while (len(self.missed_types_structs) > 0):
+ for key, value in self.missed_types_structs.iteritems():
+ fout.write(self.covert_item(value[0], key, value[1]))
+ #print(value)
+ self.missed_types_structs = {}+ footnote += self._build_page_ref_notes()
+
+ fout.write(footnote)
+
+ fout.close()
+
+ def _build_page_ref_notes(self):
+ retstr = LINE_BREAKER
+ #TODO
+ for key, value in self.page_references.iteritems():
+ page, tag = get_page(value[0])
+ m = re.search("_8h_", page)+ if(m):
+ continue;
+
+ rstname = None
+ anchor = value[2].lower()
+ if not page in self.references:
+ self.missed_types_structs[value[0]] = (page, tag)
+ rstname = os.path.splitext(self.missing_filename)[0]
+ else:
+ rstname = self.references[page][2]
+ anchor = self.references[page][4]
+ #if(tag and not self.is_github):
+ # anchor = self.anchor_prefix + "ref-" + tag
+ retstr += ".. _" + key + ": " + rstname + self.page_ext + "#" + anchor
+ retstr += LINE_BREAKER + LINE_BREAKER
+ self.page_references = {}+ return retstr
+
+ def _build_item_by_id(self, node, id):
+ retstr = ""
+ for member in node.iter("memberdef"):+ if(member.attrib["id"] != id):
+ continue
+ if(member.attrib["kind"] == "enum"):
+ retstr += self._build_enum(member)
+ return retstr
+
+ def covert_item(self, compound, id, tag):
+ xml_path = os.path.join(self.doxy_output_dir, "%s.xml" % compound)
+ print("covert_item: id=%s, name=%s" % (id, xml_path))+ obj_root = etree.parse(xml_path).getroot()
+ retstr = ""
+ compound = obj_root.find("compounddef")+ compound_kind = compound.attrib["kind"]
+ if(not tag):
+ retstr += self._build_title(compound.findtext("compoundname"))+ if(compound_kind == "class"):
+ retstr += self._build_class(compound)
+ elif(compound_kind == "struct"):
+ retstr += self._build_struct(compound)
+ else:
+ retstr += self._build_item_by_id(compound, id)
+
+ return retstr
+
+ def _build_page(self, compound):
+ retstr = ""
+ retstr += self.get_text(compound.find("detaileddescription"))+ return retstr
+
+ def _build_file(self, compound, type, ref_id, name):
+ retstr = ""
+ for member in compound.iter("memberdef"):+ if(member.attrib["kind"] == "function" and member.attrib["id"] == ref_id):
+ retstr += self.build_function(member)
+ return retstr
+
+ def convert_doxy(self, type, name):
+ #print(name)
+ file = ref_id = self.name_refid_map[name]
+ dst_kind = type
+ if(type == "function"):
+ file, tag = get_page(ref_id)
+ dst_kind = "file"
+ xml_path = os.path.join(self.doxy_output_dir, "%s.xml" % file)
+ print("convert_doxy: type=%s, name=%s" % (type, xml_path))+ obj_root = etree.parse(xml_path).getroot()
+ compound = obj_root.find("compounddef")+ compound_kind = compound.attrib["kind"]
+ assert(dst_kind == compound_kind)
+ retstr = ""
+ if(compound_kind == "class"):
+ retstr += self._build_class(compound)
+ elif(compound_kind == "struct"):
+ retstr += self._build_struct(compound)
+ elif(compound_kind == "page"):
+ retstr += self._build_page(compound)
+ elif(compound_kind == "group"):
+ retstr += self._build_page(compound)
+ elif(compound_kind == "file"):
+ retstr += self._build_file(compound, type, ref_id, name)
+ return retstr
+
+
+if __name__ == '__main__':
+ import argparse
+ parser = argparse.ArgumentParser()
+ parser.add_argument("-g", "--github", action="store_true", help="Render the link in format of github wiki.")+ parser.add_argument("-e", "--ext", default="", help="extension for github wiki")+ parser.add_argument("-i", "--input", default="doxygen", help="Input file path of doxygen output and source rst file.")+ parser.add_argument("-o", "--output", default="wikipage", help="Output converted restructured text files to path.")+ parser.add_argument("-s", "--struct", default="TypesAndStructures.rest", help="Output of auto generated enum and structures.")+ parser.add_argument("-u", "--uml", action="store_true", help="Enable UML, you need to download plantuml.jar from Plantuml and put it to here. http://plantuml.sourceforge.net/")+
+ args = parser.parse_args()
+ ext = ""
+ if(len(args.ext) > 0):
+ ext = ("." + args.ext)+ agent = DoxyGen2RST(args.input,
+ args.output,
+ args.struct,
+ is_github = True,
+ enable_uml = args.uml,
+ github_ext = ext)
+ agent.generate()