diff options
| author | 2015-06-24 07:36:50 +0200 | |
|---|---|---|
| committer | 2015-06-24 07:36:50 +0200 | |
| commit | d1583b9850d9fb45470648a515eb734e05fd926f (patch) | |
| tree | 33a4d9934bd2ff6c41526abe0ba06c1d1ea73eb6 /src/lib/util | |
| parent | 03a5bfa56fa4af400f6b9fb07a5e1333aa8fa52f (diff) | |
Cleanups and version bumpmame0163
Diffstat (limited to 'src/lib/util')
34 files changed, 1949 insertions, 1950 deletions
diff --git a/src/lib/util/avhuff.c b/src/lib/util/avhuff.c index cb00ab23336..d9fdecb46cc 100644 --- a/src/lib/util/avhuff.c +++ b/src/lib/util/avhuff.c @@ -174,11 +174,11 @@ inline UINT32 avhuff_decoder::deltarle_decoder::decode_one(bitstream_in &bitbuf) //************************************************************************** /** - * @fn avhuff_encoder::avhuff_encoder() + * @fn avhuff_encoder::avhuff_encoder() * - * @brief ------------------------------------------------- - * avhuff_encoder - constructor - * -------------------------------------------------. + * @brief ------------------------------------------------- + * avhuff_encoder - constructor + * -------------------------------------------------. */ avhuff_encoder::avhuff_encoder() @@ -189,17 +189,17 @@ m_flac_encoder.set_strip_metadata(true); } /** - * @fn avhuff_error avhuff_encoder::encode_data(const UINT8 *source, UINT8 *dest, UINT32 &complength) + * @fn avhuff_error avhuff_encoder::encode_data(const UINT8 *source, UINT8 *dest, UINT32 &complength) * - * @brief ------------------------------------------------- - * encode_data - encode a block of data into a compressed data stream - * -------------------------------------------------. + * @brief ------------------------------------------------- + * encode_data - encode a block of data into a compressed data stream + * -------------------------------------------------. * - * @param source Source for the. - * @param [in,out] dest If non-null, destination for the. - * @param [in,out] complength The complength. + * @param source Source for the. + * @param [in,out] dest If non-null, destination for the. + * @param [in,out] complength The complength. * - * @return An avhuff_error. + * @return An avhuff_error. */ avhuff_error avhuff_encoder::encode_data(const UINT8 *source, UINT8 *dest, UINT32 &complength) @@ -278,15 +278,15 @@ avhuff_error avhuff_encoder::encode_data(const UINT8 *source, UINT8 *dest, UINT3 } /** - * @fn UINT32 avhuff_encoder::raw_data_size(const UINT8 *data) + * @fn UINT32 avhuff_encoder::raw_data_size(const UINT8 *data) * - * @brief ------------------------------------------------- - * raw_data_size - return the raw data size of a raw stream based on the header - * -------------------------------------------------. + * @brief ------------------------------------------------- + * raw_data_size - return the raw data size of a raw stream based on the header + * -------------------------------------------------. * - * @param data The data. + * @param data The data. * - * @return An UINT32. + * @return An UINT32. */ UINT32 avhuff_encoder::raw_data_size(const UINT8 *data) @@ -308,21 +308,21 @@ UINT32 avhuff_encoder::raw_data_size(const UINT8 *data) } /** - * @fn avhuff_error avhuff_encoder::assemble_data(dynamic_buffer &buffer, bitmap_yuy16 &bitmap, UINT8 channels, UINT32 numsamples, INT16 **samples, UINT8 *metadata, UINT32 metadatasize) + * @fn avhuff_error avhuff_encoder::assemble_data(dynamic_buffer &buffer, bitmap_yuy16 &bitmap, UINT8 channels, UINT32 numsamples, INT16 **samples, UINT8 *metadata, UINT32 metadatasize) * - * @brief ------------------------------------------------- - * assemble_data - assemble a datastream from raw bits - * -------------------------------------------------. + * @brief ------------------------------------------------- + * assemble_data - assemble a datastream from raw bits + * -------------------------------------------------. * - * @param [in,out] buffer The buffer. - * @param [in,out] bitmap The bitmap. - * @param channels The channels. - * @param numsamples The numsamples. - * @param [in,out] samples If non-null, the samples. - * @param [in,out] metadata If non-null, the metadata. - * @param metadatasize The metadatasize. + * @param [in,out] buffer The buffer. + * @param [in,out] bitmap The bitmap. + * @param channels The channels. + * @param numsamples The numsamples. + * @param [in,out] samples If non-null, the samples. + * @param [in,out] metadata If non-null, the metadata. + * @param metadatasize The metadatasize. * - * @return An avhuff_error. + * @return An avhuff_error. */ avhuff_error avhuff_encoder::assemble_data(dynamic_buffer &buffer, bitmap_yuy16 &bitmap, UINT8 channels, UINT32 numsamples, INT16 **samples, UINT8 *metadata, UINT32 metadatasize) @@ -378,19 +378,19 @@ avhuff_error avhuff_encoder::assemble_data(dynamic_buffer &buffer, bitmap_yuy16 } /** - * @fn avhuff_error avhuff_encoder::encode_audio(const UINT8 *source, int channels, int samples, UINT8 *dest, UINT8 *sizes) + * @fn avhuff_error avhuff_encoder::encode_audio(const UINT8 *source, int channels, int samples, UINT8 *dest, UINT8 *sizes) * - * @brief ------------------------------------------------- - * encode_audio - encode raw audio data to the destination - * -------------------------------------------------. + * @brief ------------------------------------------------- + * encode_audio - encode raw audio data to the destination + * -------------------------------------------------. * - * @param source Source for the. - * @param channels The channels. - * @param samples The samples. - * @param [in,out] dest If non-null, destination for the. - * @param [in,out] sizes If non-null, the sizes. + * @param source Source for the. + * @param channels The channels. + * @param samples The samples. + * @param [in,out] dest If non-null, destination for the. + * @param [in,out] sizes If non-null, the sizes. * - * @return An avhuff_error. + * @return An avhuff_error. */ avhuff_error avhuff_encoder::encode_audio(const UINT8 *source, int channels, int samples, UINT8 *dest, UINT8 *sizes) @@ -511,19 +511,19 @@ avhuff_error avhuff_encoder::encode_audio(const UINT8 *source, int channels, int } /** - * @fn avhuff_error avhuff_encoder::encode_video(const UINT8 *source, int width, int height, UINT8 *dest, UINT32 &complength) + * @fn avhuff_error avhuff_encoder::encode_video(const UINT8 *source, int width, int height, UINT8 *dest, UINT32 &complength) * - * @brief ------------------------------------------------- - * encode_video - encode raw video data to the destination - * -------------------------------------------------. + * @brief ------------------------------------------------- + * encode_video - encode raw video data to the destination + * -------------------------------------------------. * - * @param source Source for the. - * @param width The width. - * @param height The height. - * @param [in,out] dest If non-null, destination for the. - * @param [in,out] complength The complength. + * @param source Source for the. + * @param width The width. + * @param height The height. + * @param [in,out] dest If non-null, destination for the. + * @param [in,out] complength The complength. * - * @return An avhuff_error. + * @return An avhuff_error. */ avhuff_error avhuff_encoder::encode_video(const UINT8 *source, int width, int height, UINT8 *dest, UINT32 &complength) @@ -533,20 +533,20 @@ avhuff_error avhuff_encoder::encode_video(const UINT8 *source, int width, int he } /** - * @fn avhuff_error avhuff_encoder::encode_video_lossless(const UINT8 *source, int width, int height, UINT8 *dest, UINT32 &complength) + * @fn avhuff_error avhuff_encoder::encode_video_lossless(const UINT8 *source, int width, int height, UINT8 *dest, UINT32 &complength) * - * @brief ------------------------------------------------- - * encode_video_lossless - do a lossless video encoding using deltas and huffman - * encoding - * -------------------------------------------------. + * @brief ------------------------------------------------- + * encode_video_lossless - do a lossless video encoding using deltas and huffman + * encoding + * -------------------------------------------------. * - * @param source Source for the. - * @param width The width. - * @param height The height. - * @param [in,out] dest If non-null, destination for the. - * @param [in,out] complength The complength. + * @param source Source for the. + * @param width The width. + * @param height The height. + * @param [in,out] dest If non-null, destination for the. + * @param [in,out] complength The complength. * - * @return An avhuff_error. + * @return An avhuff_error. */ avhuff_error avhuff_encoder::encode_video_lossless(const UINT8 *source, int width, int height, UINT8 *dest, UINT32 &complength) @@ -601,18 +601,18 @@ avhuff_error avhuff_encoder::encode_video_lossless(const UINT8 *source, int widt //************************************************************************** /** - * @fn UINT16 *avhuff_encoder::deltarle_encoder::rle_and_histo_bitmap(const UINT8 *source, UINT32 items_per_row, UINT32 item_advance, UINT32 row_count) + * @fn UINT16 *avhuff_encoder::deltarle_encoder::rle_and_histo_bitmap(const UINT8 *source, UINT32 items_per_row, UINT32 item_advance, UINT32 row_count) * - * @brief ------------------------------------------------- - * rle_and_histo_bitmap - RLE compress and histogram a bitmap's worth of data - * -------------------------------------------------. + * @brief ------------------------------------------------- + * rle_and_histo_bitmap - RLE compress and histogram a bitmap's worth of data + * -------------------------------------------------. * - * @param source Source for the. - * @param items_per_row The items per row. - * @param item_advance The item advance. - * @param row_count Number of rows. + * @param source Source for the. + * @param items_per_row The items per row. + * @param item_advance The item advance. + * @param row_count Number of rows. * - * @return null if it fails, else an UINT16*. + * @return null if it fails, else an UINT16*. */ UINT16 *avhuff_encoder::deltarle_encoder::rle_and_histo_bitmap(const UINT8 *source, UINT32 items_per_row, UINT32 item_advance, UINT32 row_count) @@ -679,11 +679,11 @@ UINT16 *avhuff_encoder::deltarle_encoder::rle_and_histo_bitmap(const UINT8 *sour //************************************************************************** /** - * @fn avhuff_decoder::avhuff_decoder() + * @fn avhuff_decoder::avhuff_decoder() * - * @brief ------------------------------------------------- - * avhuff_decoder - constructor - * -------------------------------------------------. + * @brief ------------------------------------------------- + * avhuff_decoder - constructor + * -------------------------------------------------. */ avhuff_decoder::avhuff_decoder() @@ -691,13 +691,13 @@ avhuff_decoder::avhuff_decoder() } /** - * @fn void avhuff_decoder::configure(const avhuff_decompress_config &config) + * @fn void avhuff_decoder::configure(const avhuff_decompress_config &config) * - * @brief ------------------------------------------------- - * configure - configure decompression parameters - * -------------------------------------------------. + * @brief ------------------------------------------------- + * configure - configure decompression parameters + * -------------------------------------------------. * - * @param config The configuration. + * @param config The configuration. */ void avhuff_decoder::configure(const avhuff_decompress_config &config) @@ -712,17 +712,17 @@ void avhuff_decoder::configure(const avhuff_decompress_config &config) } /** - * @fn avhuff_error avhuff_decoder::decode_data(const UINT8 *source, UINT32 complength, UINT8 *dest) + * @fn avhuff_error avhuff_decoder::decode_data(const UINT8 *source, UINT32 complength, UINT8 *dest) * - * @brief ------------------------------------------------- - * decode_data - decode both audio and video from a raw data stream - * -------------------------------------------------. + * @brief ------------------------------------------------- + * decode_data - decode both audio and video from a raw data stream + * -------------------------------------------------. * - * @param source Source for the. - * @param complength The complength. - * @param [in,out] dest If non-null, destination for the. + * @param source Source for the. + * @param complength The complength. + * @param [in,out] dest If non-null, destination for the. * - * @return An avhuff_error. + * @return An avhuff_error. */ avhuff_error avhuff_decoder::decode_data(const UINT8 *source, UINT32 complength, UINT8 *dest) @@ -853,23 +853,23 @@ avhuff_error avhuff_decoder::decode_data(const UINT8 *source, UINT32 complength, } /** - * @fn avhuff_error avhuff_decoder::decode_audio(int channels, int samples, const UINT8 *source, UINT8 **dest, UINT32 dxor, const UINT8 *sizes) + * @fn avhuff_error avhuff_decoder::decode_audio(int channels, int samples, const UINT8 *source, UINT8 **dest, UINT32 dxor, const UINT8 *sizes) * - * @brief ------------------------------------------------- - * decode_audio - decode audio from a compressed data stream - * -------------------------------------------------. + * @brief ------------------------------------------------- + * decode_audio - decode audio from a compressed data stream + * -------------------------------------------------. * - * @exception CHDERR_DECOMPRESSION_ERROR Thrown when a chderr decompression error error - * condition occurs. + * @exception CHDERR_DECOMPRESSION_ERROR Thrown when a chderr decompression error error + * condition occurs. * - * @param channels The channels. - * @param samples The samples. - * @param source Source for the. - * @param [in,out] dest If non-null, destination for the. - * @param dxor The dxor. - * @param sizes The sizes. + * @param channels The channels. + * @param samples The samples. + * @param source Source for the. + * @param [in,out] dest If non-null, destination for the. + * @param dxor The dxor. + * @param sizes The sizes. * - * @return An avhuff_error. + * @return An avhuff_error. */ avhuff_error avhuff_decoder::decode_audio(int channels, int samples, const UINT8 *source, UINT8 **dest, UINT32 dxor, const UINT8 *sizes) @@ -991,21 +991,21 @@ avhuff_error avhuff_decoder::decode_audio(int channels, int samples, const UINT8 } /** - * @fn avhuff_error avhuff_decoder::decode_video(int width, int height, const UINT8 *source, UINT32 complength, UINT8 *dest, UINT32 dstride, UINT32 dxor) + * @fn avhuff_error avhuff_decoder::decode_video(int width, int height, const UINT8 *source, UINT32 complength, UINT8 *dest, UINT32 dstride, UINT32 dxor) * - * @brief ------------------------------------------------- - * decode_video - decode video from a compressed data stream - * -------------------------------------------------. + * @brief ------------------------------------------------- + * decode_video - decode video from a compressed data stream + * -------------------------------------------------. * - * @param width The width. - * @param height The height. - * @param source Source for the. - * @param complength The complength. - * @param [in,out] dest If non-null, destination for the. - * @param dstride The dstride. - * @param dxor The dxor. + * @param width The width. + * @param height The height. + * @param source Source for the. + * @param complength The complength. + * @param [in,out] dest If non-null, destination for the. + * @param dstride The dstride. + * @param dxor The dxor. * - * @return An avhuff_error. + * @return An avhuff_error. */ avhuff_error avhuff_decoder::decode_video(int width, int height, const UINT8 *source, UINT32 complength, UINT8 *dest, UINT32 dstride, UINT32 dxor) @@ -1018,22 +1018,22 @@ avhuff_error avhuff_decoder::decode_video(int width, int height, const UINT8 *so } /** - * @fn avhuff_error avhuff_decoder::decode_video_lossless(int width, int height, const UINT8 *source, UINT32 complength, UINT8 *dest, UINT32 dstride, UINT32 dxor) + * @fn avhuff_error avhuff_decoder::decode_video_lossless(int width, int height, const UINT8 *source, UINT32 complength, UINT8 *dest, UINT32 dstride, UINT32 dxor) * - * @brief ------------------------------------------------- - * decode_video_lossless - do a lossless video decoding using deltas and huffman - * encoding - * -------------------------------------------------. + * @brief ------------------------------------------------- + * decode_video_lossless - do a lossless video decoding using deltas and huffman + * encoding + * -------------------------------------------------. * - * @param width The width. - * @param height The height. - * @param source Source for the. - * @param complength The complength. - * @param [in,out] dest If non-null, destination for the. - * @param dstride The dstride. - * @param dxor The dxor. + * @param width The width. + * @param height The height. + * @param source Source for the. + * @param complength The complength. + * @param [in,out] dest If non-null, destination for the. + * @param dstride The dstride. + * @param dxor The dxor. * - * @return An avhuff_error. + * @return An avhuff_error. */ avhuff_error avhuff_decoder::decode_video_lossless(int width, int height, const UINT8 *source, UINT32 complength, UINT8 *dest, UINT32 dstride, UINT32 dxor) diff --git a/src/lib/util/aviio.c b/src/lib/util/aviio.c index dcc14428716..06b603e0e31 100644 --- a/src/lib/util/aviio.c +++ b/src/lib/util/aviio.c @@ -19,136 +19,136 @@ ***************************************************************************/ /** - * @def FILETYPE_READ + * @def FILETYPE_READ * - * @brief A macro that defines filetype read. + * @brief A macro that defines filetype read. */ #define FILETYPE_READ 1 /** - * @def FILETYPE_CREATE + * @def FILETYPE_CREATE * - * @brief A macro that defines filetype create. + * @brief A macro that defines filetype create. */ #define FILETYPE_CREATE 2 -/** @brief Size of the maximum riff. */ +/** @brief Size of the maximum riff. */ #define MAX_RIFF_SIZE (2UL * 1024 * 1024 * 1024 - 1024) /* just under 2GB */ -/** @brief The maximum avi size in gigabytes. */ +/** @brief The maximum avi size in gigabytes. */ #define MAX_AVI_SIZE_IN_GB (256) /** - * @def FOUR_GB + * @def FOUR_GB * - * @brief A macro that defines four gigabytes. + * @brief A macro that defines four gigabytes. */ #define FOUR_GB ((UINT64)1 << 32) /** - * @def MAX_SOUND_CHANNELS + * @def MAX_SOUND_CHANNELS * - * @brief A macro that defines maximum sound channels. + * @brief A macro that defines maximum sound channels. */ #define MAX_SOUND_CHANNELS 2 /** - * @def SOUND_BUFFER_MSEC + * @def SOUND_BUFFER_MSEC * - * @brief A macro that defines sound buffer msec. + * @brief A macro that defines sound buffer msec. */ #define SOUND_BUFFER_MSEC 2000 /* milliseconds of sound buffering */ -/** @brief The chunktype riff. */ +/** @brief The chunktype riff. */ #define CHUNKTYPE_RIFF AVI_FOURCC('R','I','F','F') -/** @brief List of chunktypes. */ +/** @brief List of chunktypes. */ #define CHUNKTYPE_LIST AVI_FOURCC('L','I','S','T') -/** @brief The chunktype junk. */ +/** @brief The chunktype junk. */ #define CHUNKTYPE_JUNK AVI_FOURCC('J','U','N','K') -/** @brief The chunktype avih. */ +/** @brief The chunktype avih. */ #define CHUNKTYPE_AVIH AVI_FOURCC('a','v','i','h') -/** @brief The chunktype strh. */ +/** @brief The chunktype strh. */ #define CHUNKTYPE_STRH AVI_FOURCC('s','t','r','h') -/** @brief The chunktype strf. */ +/** @brief The chunktype strf. */ #define CHUNKTYPE_STRF AVI_FOURCC('s','t','r','f') -/** @brief The first chunktype index. */ +/** @brief The first chunktype index. */ #define CHUNKTYPE_IDX1 AVI_FOURCC('i','d','x','1') -/** @brief The chunktype indx. */ +/** @brief The chunktype indx. */ #define CHUNKTYPE_INDX AVI_FOURCC('i','n','d','x') -/** @brief The chunktype xxdb. */ +/** @brief The chunktype xxdb. */ #define CHUNKTYPE_XXDB AVI_FOURCC(0x00,0x00,'d','b') -/** @brief The chunktype xxdc. */ +/** @brief The chunktype xxdc. */ #define CHUNKTYPE_XXDC AVI_FOURCC(0x00,0x00,'d','c') -/** @brief The chunktype xxwb. */ +/** @brief The chunktype xxwb. */ #define CHUNKTYPE_XXWB AVI_FOURCC(0x00,0x00,'w','b') -/** @brief The chunktype ixxx. */ +/** @brief The chunktype ixxx. */ #define CHUNKTYPE_IXXX AVI_FOURCC('i','x',0x00,0x00) -/** @brief The chunktype xx mask. */ +/** @brief The chunktype xx mask. */ #define CHUNKTYPE_XX_MASK AVI_FOURCC(0x00,0x00,0xff,0xff) -/** @brief The listtype avi. */ +/** @brief The listtype avi. */ #define LISTTYPE_AVI AVI_FOURCC('A','V','I',' ') -/** @brief The listtype avix. */ +/** @brief The listtype avix. */ #define LISTTYPE_AVIX AVI_FOURCC('A','V','I','X') -/** @brief The listtype hdrl. */ +/** @brief The listtype hdrl. */ #define LISTTYPE_HDRL AVI_FOURCC('h','d','r','l') -/** @brief The listtype strl. */ +/** @brief The listtype strl. */ #define LISTTYPE_STRL AVI_FOURCC('s','t','r','l') -/** @brief The listtype movi. */ +/** @brief The listtype movi. */ #define LISTTYPE_MOVI AVI_FOURCC('m','o','v','i') -/** @brief The streamtype vids. */ +/** @brief The streamtype vids. */ #define STREAMTYPE_VIDS AVI_FOURCC('v','i','d','s') -/** @brief The streamtype auds. */ +/** @brief The streamtype auds. */ #define STREAMTYPE_AUDS AVI_FOURCC('a','u','d','s') -/** @brief The handler bitmap. */ +/** @brief The handler bitmap. */ #define HANDLER_DIB AVI_FOURCC('D','I','B',' ') -/** @brief The handler hfyu. */ +/** @brief The handler hfyu. */ #define HANDLER_HFYU AVI_FOURCC('h','f','y','u') /* main AVI header files */ /** - * @def AVIF_HASINDEX + * @def AVIF_HASINDEX * - * @brief A macro that defines avif hasindex. + * @brief A macro that defines avif hasindex. */ #define AVIF_HASINDEX 0x00000010 /** - * @def AVIF_MUSTUSEINDEX + * @def AVIF_MUSTUSEINDEX * - * @brief A macro that defines avif mustuseindex. + * @brief A macro that defines avif mustuseindex. */ #define AVIF_MUSTUSEINDEX 0x00000020 /** - * @def AVIF_ISINTERLEAVED + * @def AVIF_ISINTERLEAVED * - * @brief A macro that defines avif isinterleaved. + * @brief A macro that defines avif isinterleaved. */ #define AVIF_ISINTERLEAVED 0x00000100 /** - * @def AVIF_COPYRIGHTED + * @def AVIF_COPYRIGHTED * - * @brief A macro that defines avif copyrighted. + * @brief A macro that defines avif copyrighted. */ #define AVIF_COPYRIGHTED 0x00010000 /** - * @def AVIF_WASCAPTUREFILE + * @def AVIF_WASCAPTUREFILE * - * @brief A macro that defines avif wascapturefile. + * @brief A macro that defines avif wascapturefile. */ #define AVIF_WASCAPTUREFILE 0x00020000 @@ -156,33 +156,33 @@ /* index definitions */ /** - * @def AVI_INDEX_OF_INDEXES + * @def AVI_INDEX_OF_INDEXES * - * @brief A macro that defines avi index of indexes. + * @brief A macro that defines avi index of indexes. */ #define AVI_INDEX_OF_INDEXES 0x00 /** - * @def AVI_INDEX_OF_CHUNKS + * @def AVI_INDEX_OF_CHUNKS * - * @brief A macro that defines avi index of chunks. + * @brief A macro that defines avi index of chunks. */ #define AVI_INDEX_OF_CHUNKS 0x01 /** - * @def AVI_INDEX_IS_DATA + * @def AVI_INDEX_IS_DATA * - * @brief A macro that defines avi index is data. + * @brief A macro that defines avi index is data. */ #define AVI_INDEX_IS_DATA 0x80 /** - * @def AVI_INDEX_2FIELD + * @def AVI_INDEX_2FIELD * - * @brief A macro that defines avi index 2 field. + * @brief A macro that defines avi index 2 field. */ #define AVI_INDEX_2FIELD 0x01 @@ -190,33 +190,33 @@ /* HuffYUV definitions */ /** - * @def HUFFYUV_PREDICT_LEFT + * @def HUFFYUV_PREDICT_LEFT * - * @brief A macro that defines huffyuv predict left. + * @brief A macro that defines huffyuv predict left. */ #define HUFFYUV_PREDICT_LEFT 0 /** - * @def HUFFYUV_PREDICT_GRADIENT + * @def HUFFYUV_PREDICT_GRADIENT * - * @brief A macro that defines huffyuv predict gradient. + * @brief A macro that defines huffyuv predict gradient. */ #define HUFFYUV_PREDICT_GRADIENT 1 /** - * @def HUFFYUV_PREDICT_MEDIAN + * @def HUFFYUV_PREDICT_MEDIAN * - * @brief A macro that defines huffyuv predict median. + * @brief A macro that defines huffyuv predict median. */ #define HUFFYUV_PREDICT_MEDIAN 2 /** - * @def HUFFYUV_PREDICT_DECORR + * @def HUFFYUV_PREDICT_DECORR * - * @brief A macro that defines huffyuv predict decorr. + * @brief A macro that defines huffyuv predict decorr. */ #define HUFFYUV_PREDICT_DECORR 0x40 @@ -228,176 +228,176 @@ ***************************************************************************/ /** - * @struct avi_chunk + * @struct avi_chunk * - * @brief An avi chunk. + * @brief An avi chunk. */ struct avi_chunk { - /** @brief The offset. */ + /** @brief The offset. */ UINT64 offset; /* file offset of chunk header */ - /** @brief The size. */ + /** @brief The size. */ UINT64 size; /* size of this chunk */ - /** @brief The type. */ + /** @brief The type. */ UINT32 type; /* type of this chunk */ - /** @brief The listtype. */ + /** @brief The listtype. */ UINT32 listtype; /* type of this list (if we are a list) */ }; /** - * @struct avi_chunk_list + * @struct avi_chunk_list * - * @brief List of avi chunks. + * @brief List of avi chunks. */ struct avi_chunk_list { - /** @brief The offset. */ + /** @brief The offset. */ UINT64 offset; /* offset in the file of header */ - /** @brief The length. */ + /** @brief The length. */ UINT32 length; /* length of the chunk including header */ }; /** - * @struct huffyuv_table + * @struct huffyuv_table * - * @brief A huffyuv table. + * @brief A huffyuv table. */ struct huffyuv_table { - /** @brief The shift[ 256]. */ + /** @brief The shift[ 256]. */ UINT8 shift[256]; /* bit shift amounts */ - /** @brief The bits[ 256]. */ + /** @brief The bits[ 256]. */ UINT32 bits[256]; /* bit match values */ - /** @brief The mask[ 256]. */ + /** @brief The mask[ 256]. */ UINT32 mask[256]; /* bit mask values */ - /** @brief The baselookup[ 65536]. */ + /** @brief The baselookup[ 65536]. */ UINT16 baselookup[65536]; /* base lookup table */ - /** @brief The extralookup. */ + /** @brief The extralookup. */ UINT16 * extralookup; /* extra lookup tables */ }; /** - * @struct huffyuv_data + * @struct huffyuv_data * - * @brief A huffyuv data. + * @brief A huffyuv data. */ struct huffyuv_data { - /** @brief The predictor. */ + /** @brief The predictor. */ UINT8 predictor; /* predictor */ - /** @brief The table[ 3]. */ + /** @brief The table[ 3]. */ huffyuv_table table[3]; /* array of tables */ }; /** - * @struct avi_stream + * @struct avi_stream * - * @brief An avi stream. + * @brief An avi stream. */ struct avi_stream { - /** @brief The type. */ + /** @brief The type. */ UINT32 type; /* subtype of stream */ - /** @brief Describes the format to use. */ + /** @brief Describes the format to use. */ UINT32 format; /* format of stream data */ - /** @brief The rate. */ + /** @brief The rate. */ UINT32 rate; /* timescale for stream */ - /** @brief The scale. */ + /** @brief The scale. */ UINT32 scale; /* duration of one sample in the stream */ - /** @brief The samples. */ + /** @brief The samples. */ UINT32 samples; /* number of samples */ - /** @brief The chunk. */ + /** @brief The chunk. */ avi_chunk_list * chunk; /* list of chunks */ - /** @brief The chunks. */ + /** @brief The chunks. */ UINT32 chunks; /* chunks currently known */ - /** @brief The chunksalloc. */ + /** @brief The chunksalloc. */ UINT32 chunksalloc; /* number of chunks allocated */ - /** @brief The width. */ + /** @brief The width. */ UINT32 width; /* width of video */ - /** @brief The height. */ + /** @brief The height. */ UINT32 height; /* height of video */ - /** @brief The depth. */ + /** @brief The depth. */ UINT32 depth; /* depth of video */ - /** @brief The interlace. */ + /** @brief The interlace. */ UINT8 interlace; /* interlace parameters */ - /** @brief The huffyuv. */ + /** @brief The huffyuv. */ huffyuv_data * huffyuv; /* huffyuv decompression data */ - /** @brief The channels. */ + /** @brief The channels. */ UINT16 channels; /* audio channels */ - /** @brief The samplebits. */ + /** @brief The samplebits. */ UINT16 samplebits; /* audio bits per sample */ - /** @brief The samplerate. */ + /** @brief The samplerate. */ UINT32 samplerate; /* audio sample rate */ /* only used when creating */ - /** @brief The saved strh offset. */ + /** @brief The saved strh offset. */ UINT64 saved_strh_offset; /* writeoffset of strh chunk */ - /** @brief The saved indx offset. */ + /** @brief The saved indx offset. */ UINT64 saved_indx_offset; /* writeoffset of indx chunk */ }; /** - * @struct avi_file + * @struct avi_file * - * @brief An avi file. + * @brief An avi file. */ struct avi_file { /* shared data */ - /** @brief The file. */ + /** @brief The file. */ osd_file * file; /* pointer to open file */ - /** @brief The type. */ + /** @brief The type. */ int type; /* type of access (read/create) */ - /** @brief The information. */ + /** @brief The information. */ avi_movie_info info; /* movie info structure */ - /** @brief The tempbuffer. */ + /** @brief The tempbuffer. */ UINT8 * tempbuffer; /* temporary buffer */ - /** @brief The tempbuffersize. */ + /** @brief The tempbuffersize. */ UINT32 tempbuffersize; /* size of the temporary buffer */ /* only used when reading */ - /** @brief The streams. */ + /** @brief The streams. */ int streams; /* number of streams */ - /** @brief The stream. */ + /** @brief The stream. */ avi_stream * stream; /* allocated array of stream information */ - /** @brief The rootchunk. */ + /** @brief The rootchunk. */ avi_chunk rootchunk; /* dummy root chunk that wraps the whole file */ /* only used when creating */ - /** @brief The writeoffs. */ + /** @brief The writeoffs. */ UINT64 writeoffs; /* current file write offset */ - /** @brief The riffbase. */ + /** @brief The riffbase. */ UINT64 riffbase; /* base of the current RIFF */ - /** @brief The chunkstack[ 8]. */ + /** @brief The chunkstack[ 8]. */ avi_chunk chunkstack[8]; /* stack of chunks we are writing */ - /** @brief The chunksp. */ + /** @brief The chunksp. */ int chunksp; /* stack pointer for the current chunk */ - /** @brief The saved movi offset. */ + /** @brief The saved movi offset. */ UINT64 saved_movi_offset; /* writeoffset of movi list */ - /** @brief The saved avih offset. */ + /** @brief The saved avih offset. */ UINT64 saved_avih_offset; /* writeoffset of avih chunk */ - /** @brief The soundbuf. */ + /** @brief The soundbuf. */ INT16 * soundbuf; /* buffer for sound data */ - /** @brief The soundbuf samples. */ + /** @brief The soundbuf samples. */ UINT32 soundbuf_samples; /* length of sound buffer in samples */ - /** @brief The soundbuf chansamples[ maximum sound channels]. */ + /** @brief The soundbuf chansamples[ maximum sound channels]. */ UINT32 soundbuf_chansamples[MAX_SOUND_CHANNELS]; /* samples in buffer for each channel */ - /** @brief The soundbuf chunks. */ + /** @brief The soundbuf chunks. */ UINT32 soundbuf_chunks; /* number of chunks completed so far */ - /** @brief The soundbuf frames. */ + /** @brief The soundbuf frames. */ UINT32 soundbuf_frames; /* number of frames ahead of the video */ }; @@ -471,13 +471,13 @@ static void printf_chunk_recursive(avi_file *file, avi_chunk *chunk, int indent) -------------------------------------------------*/ /** - * @fn INLINE UINT16 fetch_16bits(const UINT8 *data) + * @fn INLINE UINT16 fetch_16bits(const UINT8 *data) * - * @brief Fetches the 16bits. + * @brief Fetches the 16bits. * - * @param data The data. + * @param data The data. * - * @return The 16bits. + * @return The 16bits. */ INLINE UINT16 fetch_16bits(const UINT8 *data) @@ -492,13 +492,13 @@ INLINE UINT16 fetch_16bits(const UINT8 *data) -------------------------------------------------*/ /** - * @fn INLINE UINT32 fetch_32bits(const UINT8 *data) + * @fn INLINE UINT32 fetch_32bits(const UINT8 *data) * - * @brief Fetches the 32bits. + * @brief Fetches the 32bits. * - * @param data The data. + * @param data The data. * - * @return The 32bits. + * @return The 32bits. */ INLINE UINT32 fetch_32bits(const UINT8 *data) @@ -513,13 +513,13 @@ INLINE UINT32 fetch_32bits(const UINT8 *data) -------------------------------------------------*/ /** - * @fn INLINE UINT64 fetch_64bits(const UINT8 *data) + * @fn INLINE UINT64 fetch_64bits(const UINT8 *data) * - * @brief Fetches the 64bits. + * @brief Fetches the 64bits. * - * @param data The data. + * @param data The data. * - * @return The 64bits. + * @return The 64bits. */ INLINE UINT64 fetch_64bits(const UINT8 *data) @@ -537,12 +537,12 @@ INLINE UINT64 fetch_64bits(const UINT8 *data) -------------------------------------------------*/ /** - * @fn INLINE void put_16bits(UINT8 *data, UINT16 value) + * @fn INLINE void put_16bits(UINT8 *data, UINT16 value) * - * @brief Puts the 16bits. + * @brief Puts the 16bits. * - * @param [in,out] data If non-null, the data. - * @param value The value. + * @param [in,out] data If non-null, the data. + * @param value The value. */ INLINE void put_16bits(UINT8 *data, UINT16 value) @@ -558,12 +558,12 @@ INLINE void put_16bits(UINT8 *data, UINT16 value) -------------------------------------------------*/ /** - * @fn INLINE void put_32bits(UINT8 *data, UINT32 value) + * @fn INLINE void put_32bits(UINT8 *data, UINT32 value) * - * @brief Puts the 32bits. + * @brief Puts the 32bits. * - * @param [in,out] data If non-null, the data. - * @param value The value. + * @param [in,out] data If non-null, the data. + * @param value The value. */ INLINE void put_32bits(UINT8 *data, UINT32 value) @@ -581,12 +581,12 @@ INLINE void put_32bits(UINT8 *data, UINT32 value) -------------------------------------------------*/ /** - * @fn INLINE void put_64bits(UINT8 *data, UINT64 value) + * @fn INLINE void put_64bits(UINT8 *data, UINT64 value) * - * @brief Puts the 64bits. + * @brief Puts the 64bits. * - * @param [in,out] data If non-null, the data. - * @param value The value. + * @param [in,out] data If non-null, the data. + * @param value The value. */ INLINE void put_64bits(UINT8 *data, UINT64 value) @@ -608,13 +608,13 @@ INLINE void put_64bits(UINT8 *data, UINT64 value) -------------------------------------------------*/ /** - * @fn INLINE avi_stream *get_video_stream(avi_file *file) + * @fn INLINE avi_stream *get_video_stream(avi_file *file) * - * @brief Gets video stream. + * @brief Gets video stream. * - * @param [in,out] file If non-null, the file. + * @param [in,out] file If non-null, the file. * - * @return null if it fails, else the video stream. + * @return null if it fails, else the video stream. */ INLINE avi_stream *get_video_stream(avi_file *file) @@ -636,15 +636,15 @@ INLINE avi_stream *get_video_stream(avi_file *file) -------------------------------------------------*/ /** - * @fn INLINE avi_stream *get_audio_stream(avi_file *file, int channel, int *offset) + * @fn INLINE avi_stream *get_audio_stream(avi_file *file, int channel, int *offset) * - * @brief Gets audio stream. + * @brief Gets audio stream. * - * @param [in,out] file If non-null, the file. - * @param channel The channel. - * @param [in,out] offset If non-null, the offset. + * @param [in,out] file If non-null, the file. + * @param channel The channel. + * @param [in,out] offset If non-null, the offset. * - * @return null if it fails, else the audio stream. + * @return null if it fails, else the audio stream. */ INLINE avi_stream *get_audio_stream(avi_file *file, int channel, int *offset) @@ -674,16 +674,16 @@ INLINE avi_stream *get_audio_stream(avi_file *file, int channel, int *offset) -------------------------------------------------*/ /** - * @fn INLINE avi_error set_stream_chunk_info(avi_stream *stream, UINT32 index, UINT64 offset, UINT32 length) + * @fn INLINE avi_error set_stream_chunk_info(avi_stream *stream, UINT32 index, UINT64 offset, UINT32 length) * - * @brief Sets stream chunk information. + * @brief Sets stream chunk information. * - * @param [in,out] stream If non-null, the stream. - * @param index Zero-based index of the. - * @param offset The offset. - * @param length The length. + * @param [in,out] stream If non-null, the stream. + * @param index Zero-based index of the. + * @param offset The offset. + * @param length The length. * - * @return An avi_error. + * @return An avi_error. */ INLINE avi_error set_stream_chunk_info(avi_stream *stream, UINT32 index, UINT64 offset, UINT32 length) @@ -720,13 +720,13 @@ INLINE avi_error set_stream_chunk_info(avi_stream *stream, UINT32 index, UINT64 -------------------------------------------------*/ /** - * @fn INLINE UINT32 compute_idx1_size(avi_file *file) + * @fn INLINE UINT32 compute_idx1_size(avi_file *file) * - * @brief Calculates the index 1 size. + * @brief Calculates the index 1 size. * - * @param [in,out] file If non-null, the file. + * @param [in,out] file If non-null, the file. * - * @return The calculated index 1 size. + * @return The calculated index 1 size. */ INLINE UINT32 compute_idx1_size(avi_file *file) @@ -748,14 +748,14 @@ INLINE UINT32 compute_idx1_size(avi_file *file) -------------------------------------------------*/ /** - * @fn INLINE UINT32 get_chunkid_for_stream(avi_file *file, avi_stream *stream) + * @fn INLINE UINT32 get_chunkid_for_stream(avi_file *file, avi_stream *stream) * - * @brief Gets chunkid for stream. + * @brief Gets chunkid for stream. * - * @param [in,out] file If non-null, the file. - * @param [in,out] stream If non-null, the stream. + * @param [in,out] file If non-null, the file. + * @param [in,out] stream If non-null, the stream. * - * @return The chunkid for stream. + * @return The chunkid for stream. */ INLINE UINT32 get_chunkid_for_stream(avi_file *file, avi_stream *stream) @@ -778,14 +778,14 @@ INLINE UINT32 get_chunkid_for_stream(avi_file *file, avi_stream *stream) -------------------------------------------------*/ /** - * @fn INLINE UINT32 framenum_to_samplenum(avi_file *file, UINT32 framenum) + * @fn INLINE UINT32 framenum_to_samplenum(avi_file *file, UINT32 framenum) * - * @brief Framenum to samplenum. + * @brief Framenum to samplenum. * - * @param [in,out] file If non-null, the file. - * @param framenum The framenum. + * @param [in,out] file If non-null, the file. + * @param framenum The framenum. * - * @return An UINT32. + * @return An UINT32. */ INLINE UINT32 framenum_to_samplenum(avi_file *file, UINT32 framenum) @@ -801,14 +801,14 @@ INLINE UINT32 framenum_to_samplenum(avi_file *file, UINT32 framenum) -------------------------------------------------*/ /** - * @fn INLINE avi_error expand_tempbuffer(avi_file *file, UINT32 length) + * @fn INLINE avi_error expand_tempbuffer(avi_file *file, UINT32 length) * - * @brief Expand tempbuffer. + * @brief Expand tempbuffer. * - * @param [in,out] file If non-null, the file. - * @param length The length. + * @param [in,out] file If non-null, the file. + * @param length The length. * - * @return An avi_error. + * @return An avi_error. */ INLINE avi_error expand_tempbuffer(avi_file *file, UINT32 length) @@ -838,14 +838,14 @@ INLINE avi_error expand_tempbuffer(avi_file *file, UINT32 length) -------------------------------------------------*/ /** - * @fn avi_error avi_open(const char *filename, avi_file **file) + * @fn avi_error avi_open(const char *filename, avi_file **file) * - * @brief Queries if a given avi open. + * @brief Queries if a given avi open. * - * @param filename Filename of the file. - * @param [in,out] file If non-null, the file. + * @param filename Filename of the file. + * @param [in,out] file If non-null, the file. * - * @return An avi_error. + * @return An avi_error. */ avi_error avi_open(const char *filename, avi_file **file) @@ -901,15 +901,15 @@ error: -------------------------------------------------*/ /** - * @fn avi_error avi_create(const char *filename, const avi_movie_info *info, avi_file **file) + * @fn avi_error avi_create(const char *filename, const avi_movie_info *info, avi_file **file) * - * @brief Avi create. + * @brief Avi create. * - * @param filename Filename of the file. - * @param info The information. - * @param [in,out] file If non-null, the file. + * @param filename Filename of the file. + * @param info The information. + * @param [in,out] file If non-null, the file. * - * @return An avi_error. + * @return An avi_error. */ avi_error avi_create(const char *filename, const avi_movie_info *info, avi_file **file) @@ -1020,13 +1020,13 @@ error: -------------------------------------------------*/ /** - * @fn avi_error avi_close(avi_file *file) + * @fn avi_error avi_close(avi_file *file) * - * @brief Avi close. + * @brief Avi close. * - * @param [in,out] file If non-null, the file. + * @param [in,out] file If non-null, the file. * - * @return An avi_error. + * @return An avi_error. */ avi_error avi_close(avi_file *file) @@ -1104,11 +1104,11 @@ avi_error avi_close(avi_file *file) -------------------------------------------------*/ /** - * @fn void avi_printf_chunks(avi_file *file) + * @fn void avi_printf_chunks(avi_file *file) * - * @brief Avi printf chunks. + * @brief Avi printf chunks. * - * @param [in,out] file If non-null, the file. + * @param [in,out] file If non-null, the file. */ void avi_printf_chunks(avi_file *file) @@ -1123,13 +1123,13 @@ void avi_printf_chunks(avi_file *file) -------------------------------------------------*/ /** - * @fn const char *avi_error_string(avi_error err) + * @fn const char *avi_error_string(avi_error err) * - * @brief Avi error string. + * @brief Avi error string. * - * @param err The error. + * @param err The error. * - * @return null if it fails, else a char*. + * @return null if it fails, else a char*. */ const char *avi_error_string(avi_error err) @@ -1164,13 +1164,13 @@ const char *avi_error_string(avi_error err) -------------------------------------------------*/ /** - * @fn const avi_movie_info *avi_get_movie_info(avi_file *file) + * @fn const avi_movie_info *avi_get_movie_info(avi_file *file) * - * @brief Avi get movie information. + * @brief Avi get movie information. * - * @param [in,out] file If non-null, the file. + * @param [in,out] file If non-null, the file. * - * @return null if it fails, else an avi_movie_info*. + * @return null if it fails, else an avi_movie_info*. */ const avi_movie_info *avi_get_movie_info(avi_file *file) @@ -1185,14 +1185,14 @@ const avi_movie_info *avi_get_movie_info(avi_file *file) -------------------------------------------------*/ /** - * @fn UINT32 avi_first_sample_in_frame(avi_file *file, UINT32 framenum) + * @fn UINT32 avi_first_sample_in_frame(avi_file *file, UINT32 framenum) * - * @brief Avi first sample in frame. + * @brief Avi first sample in frame. * - * @param [in,out] file If non-null, the file. - * @param framenum The framenum. + * @param [in,out] file If non-null, the file. + * @param framenum The framenum. * - * @return An UINT32. + * @return An UINT32. */ UINT32 avi_first_sample_in_frame(avi_file *file, UINT32 framenum) @@ -1208,15 +1208,15 @@ UINT32 avi_first_sample_in_frame(avi_file *file, UINT32 framenum) -------------------------------------------------*/ /** - * @fn avi_error avi_read_video_frame(avi_file *file, UINT32 framenum, bitmap_yuy16 &bitmap) + * @fn avi_error avi_read_video_frame(avi_file *file, UINT32 framenum, bitmap_yuy16 &bitmap) * - * @brief Avi read video frame. + * @brief Avi read video frame. * - * @param [in,out] file If non-null, the file. - * @param framenum The framenum. - * @param [in,out] bitmap The bitmap. + * @param [in,out] file If non-null, the file. + * @param framenum The framenum. + * @param [in,out] bitmap The bitmap. * - * @return An avi_error. + * @return An avi_error. */ avi_error avi_read_video_frame(avi_file *file, UINT32 framenum, bitmap_yuy16 &bitmap) @@ -1278,17 +1278,17 @@ avi_error avi_read_video_frame(avi_file *file, UINT32 framenum, bitmap_yuy16 &bi -------------------------------------------------*/ /** - * @fn avi_error avi_read_sound_samples(avi_file *file, int channel, UINT32 firstsample, UINT32 numsamples, INT16 *output) + * @fn avi_error avi_read_sound_samples(avi_file *file, int channel, UINT32 firstsample, UINT32 numsamples, INT16 *output) * - * @brief Avi read sound samples. + * @brief Avi read sound samples. * - * @param [in,out] file If non-null, the file. - * @param channel The channel. - * @param firstsample The firstsample. - * @param numsamples The numsamples. - * @param [in,out] output If non-null, the output. + * @param [in,out] file If non-null, the file. + * @param channel The channel. + * @param firstsample The firstsample. + * @param numsamples The numsamples. + * @param [in,out] output If non-null, the output. * - * @return An avi_error. + * @return An avi_error. */ avi_error avi_read_sound_samples(avi_file *file, int channel, UINT32 firstsample, UINT32 numsamples, INT16 *output) @@ -1398,14 +1398,14 @@ avi_error avi_read_sound_samples(avi_file *file, int channel, UINT32 firstsample -------------------------------------------------*/ /** - * @fn avi_error avi_append_video_frame(avi_file *file, bitmap_yuy16 &bitmap) + * @fn avi_error avi_append_video_frame(avi_file *file, bitmap_yuy16 &bitmap) * - * @brief Avi append video frame. + * @brief Avi append video frame. * - * @param [in,out] file If non-null, the file. - * @param [in,out] bitmap The bitmap. + * @param [in,out] file If non-null, the file. + * @param [in,out] bitmap The bitmap. * - * @return An avi_error. + * @return An avi_error. */ avi_error avi_append_video_frame(avi_file *file, bitmap_yuy16 &bitmap) @@ -1456,14 +1456,14 @@ avi_error avi_append_video_frame(avi_file *file, bitmap_yuy16 &bitmap) -------------------------------------------------*/ /** - * @fn avi_error avi_append_video_frame(avi_file *file, bitmap_rgb32 &bitmap) + * @fn avi_error avi_append_video_frame(avi_file *file, bitmap_rgb32 &bitmap) * - * @brief Avi append video frame. + * @brief Avi append video frame. * - * @param [in,out] file If non-null, the file. - * @param [in,out] bitmap The bitmap. + * @param [in,out] file If non-null, the file. + * @param [in,out] bitmap The bitmap. * - * @return An avi_error. + * @return An avi_error. */ avi_error avi_append_video_frame(avi_file *file, bitmap_rgb32 &bitmap) @@ -1518,17 +1518,17 @@ avi_error avi_append_video_frame(avi_file *file, bitmap_rgb32 &bitmap) -------------------------------------------------*/ /** - * @fn avi_error avi_append_sound_samples(avi_file *file, int channel, const INT16 *samples, UINT32 numsamples, UINT32 sampleskip) + * @fn avi_error avi_append_sound_samples(avi_file *file, int channel, const INT16 *samples, UINT32 numsamples, UINT32 sampleskip) * - * @brief Avi append sound samples. + * @brief Avi append sound samples. * - * @param [in,out] file If non-null, the file. - * @param channel The channel. - * @param samples The samples. - * @param numsamples The numsamples. - * @param sampleskip The sampleskip. + * @param [in,out] file If non-null, the file. + * @param channel The channel. + * @param samples The samples. + * @param numsamples The numsamples. + * @param sampleskip The sampleskip. * - * @return An avi_error. + * @return An avi_error. */ avi_error avi_append_sound_samples(avi_file *file, int channel, const INT16 *samples, UINT32 numsamples, UINT32 sampleskip) @@ -1561,15 +1561,15 @@ avi_error avi_append_sound_samples(avi_file *file, int channel, const INT16 *sam -------------------------------------------------*/ /** - * @fn static avi_error read_chunk_data(avi_file *file, const avi_chunk *chunk, UINT8 **buffer) + * @fn static avi_error read_chunk_data(avi_file *file, const avi_chunk *chunk, UINT8 **buffer) * - * @brief Reads chunk data. + * @brief Reads chunk data. * - * @param [in,out] file If non-null, the file. - * @param chunk The chunk. - * @param [in,out] buffer If non-null, the buffer. + * @param [in,out] file If non-null, the file. + * @param chunk The chunk. + * @param [in,out] buffer If non-null, the buffer. * - * @return The chunk data. + * @return The chunk data. */ static avi_error read_chunk_data(avi_file *file, const avi_chunk *chunk, UINT8 **buffer) @@ -1601,15 +1601,15 @@ static avi_error read_chunk_data(avi_file *file, const avi_chunk *chunk, UINT8 * -------------------------------------------------*/ /** - * @fn static avi_error get_first_chunk(avi_file *file, const avi_chunk *parent, avi_chunk *newchunk) + * @fn static avi_error get_first_chunk(avi_file *file, const avi_chunk *parent, avi_chunk *newchunk) * - * @brief Gets the first chunk. + * @brief Gets the first chunk. * - * @param [in,out] file If non-null, the file. - * @param parent The parent. - * @param [in,out] newchunk If non-null, the newchunk. + * @param [in,out] file If non-null, the file. + * @param parent The parent. + * @param [in,out] newchunk If non-null, the newchunk. * - * @return The first chunk. + * @return The first chunk. */ static avi_error get_first_chunk(avi_file *file, const avi_chunk *parent, avi_chunk *newchunk) @@ -1627,15 +1627,15 @@ static avi_error get_first_chunk(avi_file *file, const avi_chunk *parent, avi_ch -------------------------------------------------*/ /** - * @fn static avi_error get_next_chunk(avi_file *file, const avi_chunk *parent, avi_chunk *newchunk) + * @fn static avi_error get_next_chunk(avi_file *file, const avi_chunk *parent, avi_chunk *newchunk) * - * @brief Gets the next chunk. + * @brief Gets the next chunk. * - * @param [in,out] file If non-null, the file. - * @param parent The parent. - * @param [in,out] newchunk If non-null, the newchunk. + * @param [in,out] file If non-null, the file. + * @param parent The parent. + * @param [in,out] newchunk If non-null, the newchunk. * - * @return The next chunk. + * @return The next chunk. */ static avi_error get_next_chunk(avi_file *file, const avi_chunk *parent, avi_chunk *newchunk) @@ -1651,16 +1651,16 @@ static avi_error get_next_chunk(avi_file *file, const avi_chunk *parent, avi_chu -------------------------------------------------*/ /** - * @fn static avi_error find_first_chunk(avi_file *file, UINT32 findme, const avi_chunk *container, avi_chunk *result) + * @fn static avi_error find_first_chunk(avi_file *file, UINT32 findme, const avi_chunk *container, avi_chunk *result) * - * @brief Searches for the first chunk. + * @brief Searches for the first chunk. * - * @param [in,out] file If non-null, the file. - * @param findme The findme. - * @param container The container. - * @param [out] result If non-null, the result. + * @param [in,out] file If non-null, the file. + * @param findme The findme. + * @param container The container. + * @param [out] result If non-null, the result. * - * @return The found chunk. + * @return The found chunk. */ static avi_error find_first_chunk(avi_file *file, UINT32 findme, const avi_chunk *container, avi_chunk *result) @@ -1681,16 +1681,16 @@ static avi_error find_first_chunk(avi_file *file, UINT32 findme, const avi_chunk -------------------------------------------------*/ /** - * @fn static avi_error find_next_chunk(avi_file *file, UINT32 findme, const avi_chunk *container, avi_chunk *result) + * @fn static avi_error find_next_chunk(avi_file *file, UINT32 findme, const avi_chunk *container, avi_chunk *result) * - * @brief Searches for the next chunk. + * @brief Searches for the next chunk. * - * @param [in,out] file If non-null, the file. - * @param findme The findme. - * @param container The container. - * @param [out] result If non-null, the result. + * @param [in,out] file If non-null, the file. + * @param findme The findme. + * @param container The container. + * @param [out] result If non-null, the result. * - * @return The found chunk. + * @return The found chunk. */ static avi_error find_next_chunk(avi_file *file, UINT32 findme, const avi_chunk *container, avi_chunk *result) @@ -1711,16 +1711,16 @@ static avi_error find_next_chunk(avi_file *file, UINT32 findme, const avi_chunk -------------------------------------------------*/ /** - * @fn static avi_error find_first_list(avi_file *file, UINT32 findme, const avi_chunk *container, avi_chunk *result) + * @fn static avi_error find_first_list(avi_file *file, UINT32 findme, const avi_chunk *container, avi_chunk *result) * - * @brief Searches for the first list. + * @brief Searches for the first list. * - * @param [in,out] file If non-null, the file. - * @param findme The findme. - * @param container The container. - * @param [out] result If non-null, the result. + * @param [in,out] file If non-null, the file. + * @param findme The findme. + * @param container The container. + * @param [out] result If non-null, the result. * - * @return The found list. + * @return The found list. */ static avi_error find_first_list(avi_file *file, UINT32 findme, const avi_chunk *container, avi_chunk *result) @@ -1741,16 +1741,16 @@ static avi_error find_first_list(avi_file *file, UINT32 findme, const avi_chunk -------------------------------------------------*/ /** - * @fn static avi_error find_next_list(avi_file *file, UINT32 findme, const avi_chunk *container, avi_chunk *result) + * @fn static avi_error find_next_list(avi_file *file, UINT32 findme, const avi_chunk *container, avi_chunk *result) * - * @brief Searches for the next list. + * @brief Searches for the next list. * - * @param [in,out] file If non-null, the file. - * @param findme The findme. - * @param container The container. - * @param [out] result If non-null, the result. + * @param [in,out] file If non-null, the file. + * @param findme The findme. + * @param container The container. + * @param [out] result If non-null, the result. * - * @return The found list. + * @return The found list. */ static avi_error find_next_list(avi_file *file, UINT32 findme, const avi_chunk *container, avi_chunk *result) @@ -1771,16 +1771,16 @@ static avi_error find_next_list(avi_file *file, UINT32 findme, const avi_chunk * -------------------------------------------------*/ /** - * @fn static avi_error get_next_chunk_internal(avi_file *file, const avi_chunk *parent, avi_chunk *newchunk, UINT64 offset) + * @fn static avi_error get_next_chunk_internal(avi_file *file, const avi_chunk *parent, avi_chunk *newchunk, UINT64 offset) * - * @brief Gets the next chunk internal. + * @brief Gets the next chunk internal. * - * @param [in,out] file If non-null, the file. - * @param parent The parent. - * @param [in,out] newchunk If non-null, the newchunk. - * @param offset The offset. + * @param [in,out] file If non-null, the file. + * @param parent The parent. + * @param [in,out] newchunk If non-null, the newchunk. + * @param offset The offset. * - * @return The next chunk internal. + * @return The next chunk internal. */ static avi_error get_next_chunk_internal(avi_file *file, const avi_chunk *parent, avi_chunk *newchunk, UINT64 offset) @@ -1827,13 +1827,13 @@ static avi_error get_next_chunk_internal(avi_file *file, const avi_chunk *parent -------------------------------------------------*/ /** - * @fn static avi_error read_movie_data(avi_file *file) + * @fn static avi_error read_movie_data(avi_file *file) * - * @brief Reads movie data. + * @brief Reads movie data. * - * @param [in,out] file If non-null, the file. + * @param [in,out] file If non-null, the file. * - * @return The movie data. + * @return The movie data. */ static avi_error read_movie_data(avi_file *file) @@ -1938,13 +1938,13 @@ error: -------------------------------------------------*/ /** - * @fn static avi_error extract_movie_info(avi_file *file) + * @fn static avi_error extract_movie_info(avi_file *file) * - * @brief Extracts the movie information described by file. + * @brief Extracts the movie information described by file. * - * @param [in,out] file If non-null, the file. + * @param [in,out] file If non-null, the file. * - * @return The extracted movie information. + * @return The extracted movie information. */ static avi_error extract_movie_info(avi_file *file) @@ -2009,14 +2009,14 @@ static avi_error extract_movie_info(avi_file *file) -------------------------------------------------*/ /** - * @fn static avi_error parse_avih_chunk(avi_file *file, avi_chunk *avih) + * @fn static avi_error parse_avih_chunk(avi_file *file, avi_chunk *avih) * - * @brief Parse avih chunk. + * @brief Parse avih chunk. * - * @param [in,out] file If non-null, the file. - * @param [in,out] avih If non-null, the avih. + * @param [in,out] file If non-null, the file. + * @param [in,out] avih If non-null, the avih. * - * @return An avi_error. + * @return An avi_error. */ static avi_error parse_avih_chunk(avi_file *file, avi_chunk *avih) @@ -2051,15 +2051,15 @@ error: -------------------------------------------------*/ /** - * @fn static avi_error parse_strh_chunk(avi_file *file, avi_stream *stream, avi_chunk *strh) + * @fn static avi_error parse_strh_chunk(avi_file *file, avi_stream *stream, avi_chunk *strh) * - * @brief Parse strh chunk. + * @brief Parse strh chunk. * - * @param [in,out] file If non-null, the file. - * @param [in,out] stream If non-null, the stream. - * @param [in,out] strh If non-null, the strh. + * @param [in,out] file If non-null, the file. + * @param [in,out] stream If non-null, the stream. + * @param [in,out] strh If non-null, the strh. * - * @return An avi_error. + * @return An avi_error. */ static avi_error parse_strh_chunk(avi_file *file, avi_stream *stream, avi_chunk *strh) @@ -2091,15 +2091,15 @@ error: -------------------------------------------------*/ /** - * @fn static avi_error parse_strf_chunk(avi_file *file, avi_stream *stream, avi_chunk *strf) + * @fn static avi_error parse_strf_chunk(avi_file *file, avi_stream *stream, avi_chunk *strf) * - * @brief Parse strf chunk. + * @brief Parse strf chunk. * - * @param [in,out] file If non-null, the file. - * @param [in,out] stream If non-null, the stream. - * @param [in,out] strf If non-null, the strf. + * @param [in,out] file If non-null, the file. + * @param [in,out] stream If non-null, the stream. + * @param [in,out] strf If non-null, the strf. * - * @return An avi_error. + * @return An avi_error. */ static avi_error parse_strf_chunk(avi_file *file, avi_stream *stream, avi_chunk *strf) @@ -2147,15 +2147,15 @@ error: -------------------------------------------------*/ /** - * @fn static avi_error parse_indx_chunk(avi_file *file, avi_stream *stream, avi_chunk *strf) + * @fn static avi_error parse_indx_chunk(avi_file *file, avi_stream *stream, avi_chunk *strf) * - * @brief Parse indx chunk. + * @brief Parse indx chunk. * - * @param [in,out] file If non-null, the file. - * @param [in,out] stream If non-null, the stream. - * @param [in,out] strf If non-null, the strf. + * @param [in,out] file If non-null, the file. + * @param [in,out] stream If non-null, the stream. + * @param [in,out] strf If non-null, the strf. * - * @return An avi_error. + * @return An avi_error. */ static avi_error parse_indx_chunk(avi_file *file, avi_stream *stream, avi_chunk *strf) @@ -2249,15 +2249,15 @@ error: -------------------------------------------------*/ /** - * @fn static avi_error parse_idx1_chunk(avi_file *file, UINT64 baseoffset, avi_chunk *idx1) + * @fn static avi_error parse_idx1_chunk(avi_file *file, UINT64 baseoffset, avi_chunk *idx1) * - * @brief Parse index 1 chunk. + * @brief Parse index 1 chunk. * - * @param [in,out] file If non-null, the file. - * @param baseoffset The baseoffset. - * @param [in,out] idx1 If non-null, the first index. + * @param [in,out] file If non-null, the file. + * @param baseoffset The baseoffset. + * @param [in,out] idx1 If non-null, the first index. * - * @return An avi_error. + * @return An avi_error. */ static avi_error parse_idx1_chunk(avi_file *file, UINT64 baseoffset, avi_chunk *idx1) @@ -2311,16 +2311,16 @@ error: -------------------------------------------------*/ /** - * @fn static avi_error chunk_open(avi_file *file, UINT32 type, UINT32 listtype, UINT32 estlength) + * @fn static avi_error chunk_open(avi_file *file, UINT32 type, UINT32 listtype, UINT32 estlength) * - * @brief Queries if a given chunk open. + * @brief Queries if a given chunk open. * - * @param [in,out] file If non-null, the file. - * @param type The type. - * @param listtype The listtype. - * @param estlength The estlength. + * @param [in,out] file If non-null, the file. + * @param type The type. + * @param listtype The listtype. + * @param estlength The estlength. * - * @return An avi_error. + * @return An avi_error. */ static avi_error chunk_open(avi_file *file, UINT32 type, UINT32 listtype, UINT32 estlength) @@ -2382,13 +2382,13 @@ static avi_error chunk_open(avi_file *file, UINT32 type, UINT32 listtype, UINT32 -------------------------------------------------*/ /** - * @fn static avi_error chunk_close(avi_file *file) + * @fn static avi_error chunk_close(avi_file *file) * - * @brief Chunk close. + * @brief Chunk close. * - * @param [in,out] file If non-null, the file. + * @param [in,out] file If non-null, the file. * - * @return An avi_error. + * @return An avi_error. */ static avi_error chunk_close(avi_file *file) @@ -2425,16 +2425,16 @@ static avi_error chunk_close(avi_file *file) -------------------------------------------------*/ /** - * @fn static avi_error chunk_write(avi_file *file, UINT32 type, const void *data, UINT32 length) + * @fn static avi_error chunk_write(avi_file *file, UINT32 type, const void *data, UINT32 length) * - * @brief Chunk write. + * @brief Chunk write. * - * @param [in,out] file If non-null, the file. - * @param type The type. - * @param data The data. - * @param length The length. + * @param [in,out] file If non-null, the file. + * @param type The type. + * @param data The data. + * @param length The length. * - * @return An avi_error. + * @return An avi_error. */ static avi_error chunk_write(avi_file *file, UINT32 type, const void *data, UINT32 length) @@ -2509,18 +2509,18 @@ static avi_error chunk_write(avi_file *file, UINT32 type, const void *data, UINT -------------------------------------------------*/ /** - * @fn static avi_error chunk_overwrite(avi_file *file, UINT32 type, const void *data, UINT32 length, UINT64 *offset, int initial_write) + * @fn static avi_error chunk_overwrite(avi_file *file, UINT32 type, const void *data, UINT32 length, UINT64 *offset, int initial_write) * - * @brief Chunk overwrite. + * @brief Chunk overwrite. * - * @param [in,out] file If non-null, the file. - * @param type The type. - * @param data The data. - * @param length The length. - * @param [in,out] offset If non-null, the offset. - * @param initial_write The initial write. + * @param [in,out] file If non-null, the file. + * @param type The type. + * @param data The data. + * @param length The length. + * @param [in,out] offset If non-null, the offset. + * @param initial_write The initial write. * - * @return An avi_error. + * @return An avi_error. */ static avi_error chunk_overwrite(avi_file *file, UINT32 type, const void *data, UINT32 length, UINT64 *offset, int initial_write) @@ -2556,13 +2556,13 @@ static avi_error chunk_overwrite(avi_file *file, UINT32 type, const void *data, -------------------------------------------------*/ /** - * @fn static avi_error write_initial_headers(avi_file *file) + * @fn static avi_error write_initial_headers(avi_file *file) * - * @brief Writes an initial headers. + * @brief Writes an initial headers. * - * @param [in,out] file If non-null, the file. + * @param [in,out] file If non-null, the file. * - * @return An avi_error. + * @return An avi_error. */ static avi_error write_initial_headers(avi_file *file) @@ -2638,14 +2638,14 @@ static avi_error write_initial_headers(avi_file *file) -------------------------------------------------*/ /** - * @fn static avi_error write_avih_chunk(avi_file *file, int initial_write) + * @fn static avi_error write_avih_chunk(avi_file *file, int initial_write) * - * @brief Writes an avih chunk. + * @brief Writes an avih chunk. * - * @param [in,out] file If non-null, the file. - * @param initial_write The initial write. + * @param [in,out] file If non-null, the file. + * @param initial_write The initial write. * - * @return An avi_error. + * @return An avi_error. */ static avi_error write_avih_chunk(avi_file *file, int initial_write) @@ -2674,15 +2674,15 @@ static avi_error write_avih_chunk(avi_file *file, int initial_write) -------------------------------------------------*/ /** - * @fn static avi_error write_strh_chunk(avi_file *file, avi_stream *stream, int initial_write) + * @fn static avi_error write_strh_chunk(avi_file *file, avi_stream *stream, int initial_write) * - * @brief Writes a strh chunk. + * @brief Writes a strh chunk. * - * @param [in,out] file If non-null, the file. - * @param [in,out] stream If non-null, the stream. - * @param initial_write The initial write. + * @param [in,out] file If non-null, the file. + * @param [in,out] stream If non-null, the stream. + * @param initial_write The initial write. * - * @return An avi_error. + * @return An avi_error. */ static avi_error write_strh_chunk(avi_file *file, avi_stream *stream, int initial_write) @@ -2729,14 +2729,14 @@ static avi_error write_strh_chunk(avi_file *file, avi_stream *stream, int initia -------------------------------------------------*/ /** - * @fn static avi_error write_strf_chunk(avi_file *file, avi_stream *stream) + * @fn static avi_error write_strf_chunk(avi_file *file, avi_stream *stream) * - * @brief Writes a strf chunk. + * @brief Writes a strf chunk. * - * @param [in,out] file If non-null, the file. - * @param [in,out] stream If non-null, the stream. + * @param [in,out] file If non-null, the file. + * @param [in,out] stream If non-null, the stream. * - * @return An avi_error. + * @return An avi_error. */ static avi_error write_strf_chunk(avi_file *file, avi_stream *stream) @@ -2793,15 +2793,15 @@ static avi_error write_strf_chunk(avi_file *file, avi_stream *stream) -------------------------------------------------*/ /** - * @fn static avi_error write_indx_chunk(avi_file *file, avi_stream *stream, int initial_write) + * @fn static avi_error write_indx_chunk(avi_file *file, avi_stream *stream, int initial_write) * - * @brief Writes an indx chunk. + * @brief Writes an indx chunk. * - * @param [in,out] file If non-null, the file. - * @param [in,out] stream If non-null, the stream. - * @param initial_write The initial write. + * @param [in,out] file If non-null, the file. + * @param [in,out] stream If non-null, the stream. + * @param initial_write The initial write. * - * @return An avi_error. + * @return An avi_error. */ static avi_error write_indx_chunk(avi_file *file, avi_stream *stream, int initial_write) @@ -2901,13 +2901,13 @@ static avi_error write_indx_chunk(avi_file *file, avi_stream *stream, int initia -------------------------------------------------*/ /** - * @fn static avi_error write_idx1_chunk(avi_file *file) + * @fn static avi_error write_idx1_chunk(avi_file *file) * - * @brief Writes an index 1 chunk. + * @brief Writes an index 1 chunk. * - * @param [in,out] file If non-null, the file. + * @param [in,out] file If non-null, the file. * - * @return An avi_error. + * @return An avi_error. */ static avi_error write_idx1_chunk(avi_file *file) @@ -2960,13 +2960,13 @@ static avi_error write_idx1_chunk(avi_file *file) -------------------------------------------------*/ /** - * @fn static avi_error soundbuf_initialize(avi_file *file) + * @fn static avi_error soundbuf_initialize(avi_file *file) * - * @brief Soundbuf initialize. + * @brief Soundbuf initialize. * - * @param [in,out] file If non-null, the file. + * @param [in,out] file If non-null, the file. * - * @return An avi_error. + * @return An avi_error. */ static avi_error soundbuf_initialize(avi_file *file) @@ -3003,14 +3003,14 @@ static avi_error soundbuf_initialize(avi_file *file) -------------------------------------------------*/ /** - * @fn static avi_error soundbuf_write_chunk(avi_file *file, UINT32 framenum) + * @fn static avi_error soundbuf_write_chunk(avi_file *file, UINT32 framenum) * - * @brief Soundbuf write chunk. + * @brief Soundbuf write chunk. * - * @param [in,out] file If non-null, the file. - * @param framenum The framenum. + * @param [in,out] file If non-null, the file. + * @param framenum The framenum. * - * @return An avi_error. + * @return An avi_error. */ static avi_error soundbuf_write_chunk(avi_file *file, UINT32 framenum) @@ -3046,14 +3046,14 @@ static avi_error soundbuf_write_chunk(avi_file *file, UINT32 framenum) -------------------------------------------------*/ /** - * @fn static avi_error soundbuf_flush(avi_file *file, int only_flush_full) + * @fn static avi_error soundbuf_flush(avi_file *file, int only_flush_full) * - * @brief Soundbuf flush. + * @brief Soundbuf flush. * - * @param [in,out] file If non-null, the file. - * @param only_flush_full The only flush full. + * @param [in,out] file If non-null, the file. + * @param only_flush_full The only flush full. * - * @return An avi_error. + * @return An avi_error. */ static avi_error soundbuf_flush(avi_file *file, int only_flush_full) @@ -3150,16 +3150,16 @@ static avi_error soundbuf_flush(avi_file *file, int only_flush_full) -------------------------------------------------*/ /** - * @fn static avi_error rgb32_compress_to_rgb(avi_stream *stream, const bitmap_rgb32 &bitmap, UINT8 *data, UINT32 numbytes) + * @fn static avi_error rgb32_compress_to_rgb(avi_stream *stream, const bitmap_rgb32 &bitmap, UINT8 *data, UINT32 numbytes) * - * @brief RGB 32 compress to RGB. + * @brief RGB 32 compress to RGB. * - * @param [in,out] stream If non-null, the stream. - * @param bitmap The bitmap. - * @param [in,out] data If non-null, the data. - * @param numbytes The numbytes. + * @param [in,out] stream If non-null, the stream. + * @param bitmap The bitmap. + * @param [in,out] data If non-null, the data. + * @param numbytes The numbytes. * - * @return An avi_error. + * @return An avi_error. */ static avi_error rgb32_compress_to_rgb(avi_stream *stream, const bitmap_rgb32 &bitmap, UINT8 *data, UINT32 numbytes) @@ -3214,16 +3214,16 @@ static avi_error rgb32_compress_to_rgb(avi_stream *stream, const bitmap_rgb32 &b -------------------------------------------------*/ /** - * @fn static avi_error yuv_decompress_to_yuy16(avi_stream *stream, const UINT8 *data, UINT32 numbytes, bitmap_yuy16 &bitmap) + * @fn static avi_error yuv_decompress_to_yuy16(avi_stream *stream, const UINT8 *data, UINT32 numbytes, bitmap_yuy16 &bitmap) * - * @brief Yuv decompress to yuy 16. + * @brief Yuv decompress to yuy 16. * - * @param [in,out] stream If non-null, the stream. - * @param data The data. - * @param numbytes The numbytes. - * @param [in,out] bitmap The bitmap. + * @param [in,out] stream If non-null, the stream. + * @param data The data. + * @param numbytes The numbytes. + * @param [in,out] bitmap The bitmap. * - * @return An avi_error. + * @return An avi_error. */ static avi_error yuv_decompress_to_yuy16(avi_stream *stream, const UINT8 *data, UINT32 numbytes, bitmap_yuy16 &bitmap) @@ -3266,16 +3266,16 @@ static avi_error yuv_decompress_to_yuy16(avi_stream *stream, const UINT8 *data, -------------------------------------------------*/ /** - * @fn static avi_error yuy16_compress_to_yuy(avi_stream *stream, const bitmap_yuy16 &bitmap, UINT8 *data, UINT32 numbytes) + * @fn static avi_error yuy16_compress_to_yuy(avi_stream *stream, const bitmap_yuy16 &bitmap, UINT8 *data, UINT32 numbytes) * - * @brief Yuy 16 compress to yuy. + * @brief Yuy 16 compress to yuy. * - * @param [in,out] stream If non-null, the stream. - * @param bitmap The bitmap. - * @param [in,out] data If non-null, the data. - * @param numbytes The numbytes. + * @param [in,out] stream If non-null, the stream. + * @param bitmap The bitmap. + * @param [in,out] data If non-null, the data. + * @param numbytes The numbytes. * - * @return An avi_error. + * @return An avi_error. */ static avi_error yuy16_compress_to_yuy(avi_stream *stream, const bitmap_yuy16 &bitmap, UINT8 *data, UINT32 numbytes) @@ -3318,15 +3318,15 @@ static avi_error yuy16_compress_to_yuy(avi_stream *stream, const bitmap_yuy16 &b -------------------------------------------------*/ /** - * @fn static avi_error huffyuv_extract_tables(avi_stream *stream, const UINT8 *chunkdata, UINT32 size) + * @fn static avi_error huffyuv_extract_tables(avi_stream *stream, const UINT8 *chunkdata, UINT32 size) * - * @brief Huffyuv extract tables. + * @brief Huffyuv extract tables. * - * @param [in,out] stream If non-null, the stream. - * @param chunkdata The chunkdata. - * @param size The size. + * @param [in,out] stream If non-null, the stream. + * @param chunkdata The chunkdata. + * @param size The size. * - * @return An avi_error. + * @return An avi_error. */ static avi_error huffyuv_extract_tables(avi_stream *stream, const UINT8 *chunkdata, UINT32 size) @@ -3469,16 +3469,16 @@ error: -------------------------------------------------*/ /** - * @fn static avi_error huffyuv_decompress_to_yuy16(avi_stream *stream, const UINT8 *data, UINT32 numbytes, bitmap_yuy16 &bitmap) + * @fn static avi_error huffyuv_decompress_to_yuy16(avi_stream *stream, const UINT8 *data, UINT32 numbytes, bitmap_yuy16 &bitmap) * - * @brief Huffyuv decompress to yuy 16. + * @brief Huffyuv decompress to yuy 16. * - * @param [in,out] stream If non-null, the stream. - * @param data The data. - * @param numbytes The numbytes. - * @param [in,out] bitmap The bitmap. + * @param [in,out] stream If non-null, the stream. + * @param data The data. + * @param numbytes The numbytes. + * @param [in,out] bitmap The bitmap. * - * @return An avi_error. + * @return An avi_error. */ static avi_error huffyuv_decompress_to_yuy16(avi_stream *stream, const UINT8 *data, UINT32 numbytes, bitmap_yuy16 &bitmap) @@ -3685,12 +3685,12 @@ static avi_error huffyuv_decompress_to_yuy16(avi_stream *stream, const UINT8 *da } /** - * @fn static void u64toa(UINT64 val, char *output) + * @fn static void u64toa(UINT64 val, char *output) * - * @brief 64toas. + * @brief 64toas. * - * @param val The value. - * @param [in,out] output If non-null, the output. + * @param val The value. + * @param [in,out] output If non-null, the output. */ static void u64toa(UINT64 val, char *output) @@ -3710,13 +3710,13 @@ static void u64toa(UINT64 val, char *output) -------------------------------------------------*/ /** - * @fn static void printf_chunk_recursive(avi_file *file, avi_chunk *container, int indent) + * @fn static void printf_chunk_recursive(avi_file *file, avi_chunk *container, int indent) * - * @brief Printf chunk recursive. + * @brief Printf chunk recursive. * - * @param [in,out] file If non-null, the file. - * @param [in,out] container If non-null, the container. - * @param indent The indent. + * @param [in,out] file If non-null, the file. + * @param [in,out] container If non-null, the container. + * @param indent The indent. */ static void printf_chunk_recursive(avi_file *file, avi_chunk *container, int indent) diff --git a/src/lib/util/bitmap.c b/src/lib/util/bitmap.c index e9e941f3fc5..aeb9852ca1c 100644 --- a/src/lib/util/bitmap.c +++ b/src/lib/util/bitmap.c @@ -20,9 +20,9 @@ // CONSTANTS //************************************************************************** -/** @brief alignment values; 128 bytes is the largest cache line on typical architectures today. */ +/** @brief alignment values; 128 bytes is the largest cache line on typical architectures today. */ const UINT32 BITMAP_OVERALL_ALIGN = 128; -/** @brief The bitmap rowbytes align. */ +/** @brief The bitmap rowbytes align. */ const UINT32 BITMAP_ROWBYTES_ALIGN = 128; @@ -62,18 +62,18 @@ inline void bitmap_t::compute_base(int xslop, int yslop) //************************************************************************** /** - * @fn bitmap_t::bitmap_t(bitmap_format format, int bpp, int width, int height, int xslop, int yslop) + * @fn bitmap_t::bitmap_t(bitmap_format format, int bpp, int width, int height, int xslop, int yslop) * - * @brief ------------------------------------------------- - * bitmap_t - basic constructor - * -------------------------------------------------. + * @brief ------------------------------------------------- + * bitmap_t - basic constructor + * -------------------------------------------------. * - * @param format Describes the format to use. - * @param bpp The bits per pixel. - * @param width The width. - * @param height The height. - * @param xslop The xslop. - * @param yslop The yslop. + * @param format Describes the format to use. + * @param bpp The bits per pixel. + * @param width The width. + * @param height The height. + * @param xslop The xslop. + * @param yslop The yslop. */ bitmap_t::bitmap_t(bitmap_format format, int bpp, int width, int height, int xslop, int yslop) @@ -88,16 +88,16 @@ bitmap_t::bitmap_t(bitmap_format format, int bpp, int width, int height, int xsl } /** - * @fn bitmap_t::bitmap_t(bitmap_format format, int bpp, void *base, int width, int height, int rowpixels) + * @fn bitmap_t::bitmap_t(bitmap_format format, int bpp, void *base, int width, int height, int rowpixels) * - * @brief Constructor. + * @brief Constructor. * - * @param format Describes the format to use. - * @param bpp The bits per pixel. - * @param [in,out] base If non-null, the base. - * @param width The width. - * @param height The height. - * @param rowpixels The rowpixels. + * @param format Describes the format to use. + * @param bpp The bits per pixel. + * @param [in,out] base If non-null, the base. + * @param width The width. + * @param height The height. + * @param rowpixels The rowpixels. */ bitmap_t::bitmap_t(bitmap_format format, int bpp, void *base, int width, int height, int rowpixels) @@ -115,14 +115,14 @@ bitmap_t::bitmap_t(bitmap_format format, int bpp, void *base, int width, int hei } /** - * @fn bitmap_t::bitmap_t(bitmap_format format, int bpp, bitmap_t &source, const rectangle &subrect) + * @fn bitmap_t::bitmap_t(bitmap_format format, int bpp, bitmap_t &source, const rectangle &subrect) * - * @brief Constructor. + * @brief Constructor. * - * @param format Describes the format to use. - * @param bpp The bits per pixel. - * @param [in,out] source Source for the. - * @param subrect The subrect. + * @param format Describes the format to use. + * @param bpp The bits per pixel. + * @param [in,out] source Source for the. + * @param subrect The subrect. */ bitmap_t::bitmap_t(bitmap_format format, int bpp, bitmap_t &source, const rectangle &subrect) @@ -143,11 +143,11 @@ bitmap_t::bitmap_t(bitmap_format format, int bpp, bitmap_t &source, const rectan } /** - * @fn bitmap_t::~bitmap_t() + * @fn bitmap_t::~bitmap_t() * - * @brief ------------------------------------------------- - * ~bitmap_t - basic destructor - * -------------------------------------------------. + * @brief ------------------------------------------------- + * ~bitmap_t - basic destructor + * -------------------------------------------------. */ bitmap_t::~bitmap_t() @@ -157,17 +157,17 @@ bitmap_t::~bitmap_t() } /** - * @fn void bitmap_t::allocate(int width, int height, int xslop, int yslop) + * @fn void bitmap_t::allocate(int width, int height, int xslop, int yslop) * - * @brief ------------------------------------------------- - * allocate -- (re)allocate memory for the bitmap at the given size, destroying - * anything that already exists - * -------------------------------------------------. + * @brief ------------------------------------------------- + * allocate -- (re)allocate memory for the bitmap at the given size, destroying + * anything that already exists + * -------------------------------------------------. * - * @param width The width. - * @param height The height. - * @param xslop The xslop. - * @param yslop The yslop. + * @param width The width. + * @param height The height. + * @param xslop The xslop. + * @param yslop The yslop. */ void bitmap_t::allocate(int width, int height, int xslop, int yslop) @@ -201,17 +201,17 @@ void bitmap_t::allocate(int width, int height, int xslop, int yslop) } /** - * @fn void bitmap_t::resize(int width, int height, int xslop, int yslop) + * @fn void bitmap_t::resize(int width, int height, int xslop, int yslop) * - * @brief ------------------------------------------------- - * resize -- resize a bitmap, reusing existing memory if the new size is smaller than - * the current size - * -------------------------------------------------. + * @brief ------------------------------------------------- + * resize -- resize a bitmap, reusing existing memory if the new size is smaller than + * the current size + * -------------------------------------------------. * - * @param width The width. - * @param height The height. - * @param xslop The xslop. - * @param yslop The yslop. + * @param width The width. + * @param height The height. + * @param xslop The xslop. + * @param yslop The yslop. */ void bitmap_t::resize(int width, int height, int xslop, int yslop) @@ -248,11 +248,11 @@ void bitmap_t::resize(int width, int height, int xslop, int yslop) } /** - * @fn void bitmap_t::reset() + * @fn void bitmap_t::reset() * - * @brief ------------------------------------------------- - * reset -- reset to an invalid bitmap, deleting all allocated stuff - * -------------------------------------------------. + * @brief ------------------------------------------------- + * reset -- reset to an invalid bitmap, deleting all allocated stuff + * -------------------------------------------------. */ void bitmap_t::reset() @@ -271,16 +271,16 @@ void bitmap_t::reset() } /** - * @fn void bitmap_t::wrap(void *base, int width, int height, int rowpixels) + * @fn void bitmap_t::wrap(void *base, int width, int height, int rowpixels) * - * @brief ------------------------------------------------- - * wrap -- wrap an array of memory; the target bitmap does not own the memory - * -------------------------------------------------. + * @brief ------------------------------------------------- + * wrap -- wrap an array of memory; the target bitmap does not own the memory + * -------------------------------------------------. * - * @param [in,out] base If non-null, the base. - * @param width The width. - * @param height The height. - * @param rowpixels The rowpixels. + * @param [in,out] base If non-null, the base. + * @param width The width. + * @param height The height. + * @param rowpixels The rowpixels. */ void bitmap_t::wrap(void *base, int width, int height, int rowpixels) @@ -297,15 +297,15 @@ void bitmap_t::wrap(void *base, int width, int height, int rowpixels) } /** - * @fn void bitmap_t::wrap(const bitmap_t &source, const rectangle &subrect) + * @fn void bitmap_t::wrap(const bitmap_t &source, const rectangle &subrect) * - * @brief ------------------------------------------------- - * wrap -- wrap a subrectangle of an existing bitmap by copying its fields; the target - * bitmap does not own the memory - * -------------------------------------------------. + * @brief ------------------------------------------------- + * wrap -- wrap a subrectangle of an existing bitmap by copying its fields; the target + * bitmap does not own the memory + * -------------------------------------------------. * - * @param source Source for the. - * @param subrect The subrect. + * @param source Source for the. + * @param subrect The subrect. */ void bitmap_t::wrap(const bitmap_t &source, const rectangle &subrect) @@ -327,13 +327,13 @@ void bitmap_t::wrap(const bitmap_t &source, const rectangle &subrect) } /** - * @fn void bitmap_t::set_palette(palette_t *palette) + * @fn void bitmap_t::set_palette(palette_t *palette) * - * @brief ------------------------------------------------- - * set_palette -- associate a palette with a bitmap - * -------------------------------------------------. + * @brief ------------------------------------------------- + * set_palette -- associate a palette with a bitmap + * -------------------------------------------------. * - * @param [in,out] palette If non-null, the palette. + * @param [in,out] palette If non-null, the palette. */ void bitmap_t::set_palette(palette_t *palette) @@ -354,14 +354,14 @@ void bitmap_t::set_palette(palette_t *palette) } /** - * @fn void bitmap_t::fill(UINT32 color, const rectangle &cliprect) + * @fn void bitmap_t::fill(UINT32 color, const rectangle &cliprect) * - * @brief ------------------------------------------------- - * fill -- fill a bitmap with a solid color - * -------------------------------------------------. + * @brief ------------------------------------------------- + * fill -- fill a bitmap with a solid color + * -------------------------------------------------. * - * @param color The color. - * @param cliprect The cliprect. + * @param color The color. + * @param cliprect The cliprect. */ void bitmap_t::fill(UINT32 color, const rectangle &cliprect) diff --git a/src/lib/util/cdrom.c b/src/lib/util/cdrom.c index 40f3caf4190..e3cb14e8f0c 100644 --- a/src/lib/util/cdrom.c +++ b/src/lib/util/cdrom.c @@ -28,39 +28,39 @@ DEBUGGING ***************************************************************************/ -/** @brief The verbose. */ +/** @brief The verbose. */ #define VERBOSE (0) #if VERBOSE /** - * @def LOG(x) do + * @def LOG(x) do * - * @brief A macro that defines log. + * @brief A macro that defines log. * - * @param x The void to process. + * @param x The void to process. */ #define LOG(x) do { if (VERBOSE) logerror x; } while (0) /** - * @fn void CLIB_DECL logerror(const char *text, ...) ATTR_PRINTF(1,2); + * @fn void CLIB_DECL logerror(const char *text, ...) ATTR_PRINTF(1,2); * - * @brief Logerrors the given text. + * @brief Logerrors the given text. * - * @param text The text. + * @param text The text. * - * @return A CLIB_DECL. + * @return A CLIB_DECL. */ void CLIB_DECL logerror(const char *text, ...) ATTR_PRINTF(1,2); #else /** - * @def LOG(x); + * @def LOG(x); * - * @brief A macro that defines log. + * @brief A macro that defines log. * - * @param x The void to process. + * @param x The void to process. */ #define LOG(x) @@ -72,26 +72,26 @@ void CLIB_DECL logerror(const char *text, ...) ATTR_PRINTF(1,2); CONSTANTS ***************************************************************************/ -/** @brief offset within sector. */ +/** @brief offset within sector. */ const int SYNC_OFFSET = 0x000; -/** @brief 12 bytes. */ +/** @brief 12 bytes. */ const int SYNC_NUM_BYTES = 12; -/** @brief offset within sector. */ +/** @brief offset within sector. */ const int MODE_OFFSET = 0x00f; -/** @brief offset within sector. */ +/** @brief offset within sector. */ const int ECC_P_OFFSET = 0x81c; -/** @brief 2 lots of 86. */ +/** @brief 2 lots of 86. */ const int ECC_P_NUM_BYTES = 86; -/** @brief 24 bytes each. */ +/** @brief 24 bytes each. */ const int ECC_P_COMP = 24; -/** @brief The ECC q offset. */ +/** @brief The ECC q offset. */ const int ECC_Q_OFFSET = ECC_P_OFFSET + 2 * ECC_P_NUM_BYTES; -/** @brief 2 lots of 52. */ +/** @brief 2 lots of 52. */ const int ECC_Q_NUM_BYTES = 52; -/** @brief 43 bytes each. */ +/** @brief 43 bytes each. */ const int ECC_Q_COMP = 43; @@ -101,20 +101,20 @@ const int ECC_Q_COMP = 43; ***************************************************************************/ /** - * @struct cdrom_file + * @struct cdrom_file * - * @brief A cdrom file. + * @brief A cdrom file. */ struct cdrom_file { - /** @brief The chd. */ + /** @brief The chd. */ chd_file * chd; /* CHD file */ - /** @brief The cdtoc. */ + /** @brief The cdtoc. */ cdrom_toc cdtoc; /* TOC for the CD */ - /** @brief Information describing the track. */ + /** @brief Information describing the track. */ chdcd_track_input_info track_info; /* track info */ - /** @brief The fhandle[ CD maximum tracks]. */ + /** @brief The fhandle[ CD maximum tracks]. */ core_file * fhandle[CD_MAX_TRACKS];/* file handle */ }; @@ -130,15 +130,15 @@ struct cdrom_file -------------------------------------------------*/ /** - * @fn INLINE UINT32 physical_to_chd_lba(cdrom_file *file, UINT32 physlba, UINT32 &tracknum) + * @fn INLINE UINT32 physical_to_chd_lba(cdrom_file *file, UINT32 physlba, UINT32 &tracknum) * - * @brief Physical to chd lba. + * @brief Physical to chd lba. * - * @param [in,out] file If non-null, the file. - * @param physlba The physlba. - * @param [in,out] tracknum The tracknum. + * @param [in,out] file If non-null, the file. + * @param physlba The physlba. + * @param [in,out] tracknum The tracknum. * - * @return An UINT32. + * @return An UINT32. */ INLINE UINT32 physical_to_chd_lba(cdrom_file *file, UINT32 physlba, UINT32 &tracknum) @@ -164,15 +164,15 @@ INLINE UINT32 physical_to_chd_lba(cdrom_file *file, UINT32 physlba, UINT32 &trac -------------------------------------------------*/ /** - * @fn INLINE UINT32 logical_to_chd_lba(cdrom_file *file, UINT32 loglba, UINT32 &tracknum) + * @fn INLINE UINT32 logical_to_chd_lba(cdrom_file *file, UINT32 loglba, UINT32 &tracknum) * - * @brief Logical to chd lba. + * @brief Logical to chd lba. * - * @param [in,out] file If non-null, the file. - * @param loglba The loglba. - * @param [in,out] tracknum The tracknum. + * @param [in,out] file If non-null, the file. + * @param loglba The loglba. + * @param [in,out] tracknum The tracknum. * - * @return An UINT32. + * @return An UINT32. */ INLINE UINT32 logical_to_chd_lba(cdrom_file *file, UINT32 loglba, UINT32 &tracknum) @@ -208,13 +208,13 @@ INLINE UINT32 logical_to_chd_lba(cdrom_file *file, UINT32 loglba, UINT32 &trackn ***************************************************************************/ /** - * @fn cdrom_file *cdrom_open(const char *inputfile) + * @fn cdrom_file *cdrom_open(const char *inputfile) * - * @brief Queries if a given cdrom open. + * @brief Queries if a given cdrom open. * - * @param inputfile The inputfile. + * @param inputfile The inputfile. * - * @return null if it fails, else a cdrom_file*. + * @return null if it fails, else a cdrom_file*. */ cdrom_file *cdrom_open(const char *inputfile) @@ -304,13 +304,13 @@ cdrom_file *cdrom_open(const char *inputfile) -------------------------------------------------*/ /** - * @fn cdrom_file *cdrom_open(chd_file *chd) + * @fn cdrom_file *cdrom_open(chd_file *chd) * - * @brief Queries if a given cdrom open. + * @brief Queries if a given cdrom open. * - * @param [in,out] chd If non-null, the chd. + * @param [in,out] chd If non-null, the chd. * - * @return null if it fails, else a cdrom_file*. + * @return null if it fails, else a cdrom_file*. */ cdrom_file *cdrom_open(chd_file *chd) @@ -402,11 +402,11 @@ cdrom_file *cdrom_open(chd_file *chd) -------------------------------------------------*/ /** - * @fn void cdrom_close(cdrom_file *file) + * @fn void cdrom_close(cdrom_file *file) * - * @brief Cdrom close. + * @brief Cdrom close. * - * @param [in,out] file If non-null, the file. + * @param [in,out] file If non-null, the file. */ void cdrom_close(cdrom_file *file) @@ -432,19 +432,19 @@ void cdrom_close(cdrom_file *file) ***************************************************************************/ /** - * @fn chd_error read_partial_sector(cdrom_file *file, void *dest, UINT32 lbasector, UINT32 chdsector, UINT32 tracknum, UINT32 startoffs, UINT32 length) + * @fn chd_error read_partial_sector(cdrom_file *file, void *dest, UINT32 lbasector, UINT32 chdsector, UINT32 tracknum, UINT32 startoffs, UINT32 length) * - * @brief Reads partial sector. + * @brief Reads partial sector. * - * @param [in,out] file If non-null, the file. - * @param [in,out] dest If non-null, destination for the. - * @param lbasector The lbasector. - * @param chdsector The chdsector. - * @param tracknum The tracknum. - * @param startoffs The startoffs. - * @param length The length. + * @param [in,out] file If non-null, the file. + * @param [in,out] dest If non-null, destination for the. + * @param lbasector The lbasector. + * @param chdsector The chdsector. + * @param tracknum The tracknum. + * @param startoffs The startoffs. + * @param length The length. * - * @return The partial sector. + * @return The partial sector. */ chd_error read_partial_sector(cdrom_file *file, void *dest, UINT32 lbasector, UINT32 chdsector, UINT32 tracknum, UINT32 startoffs, UINT32 length) @@ -506,17 +506,17 @@ chd_error read_partial_sector(cdrom_file *file, void *dest, UINT32 lbasector, UI -------------------------------------------------*/ /** - * @fn UINT32 cdrom_read_data(cdrom_file *file, UINT32 lbasector, void *buffer, UINT32 datatype, bool phys) + * @fn UINT32 cdrom_read_data(cdrom_file *file, UINT32 lbasector, void *buffer, UINT32 datatype, bool phys) * - * @brief Cdrom read data. + * @brief Cdrom read data. * - * @param [in,out] file If non-null, the file. - * @param lbasector The lbasector. - * @param [in,out] buffer If non-null, the buffer. - * @param datatype The datatype. - * @param phys true to physical. + * @param [in,out] file If non-null, the file. + * @param lbasector The lbasector. + * @param [in,out] buffer If non-null, the buffer. + * @param datatype The datatype. + * @param phys true to physical. * - * @return An UINT32. + * @return An UINT32. */ UINT32 cdrom_read_data(cdrom_file *file, UINT32 lbasector, void *buffer, UINT32 datatype, bool phys) @@ -592,16 +592,16 @@ UINT32 cdrom_read_data(cdrom_file *file, UINT32 lbasector, void *buffer, UINT32 -------------------------------------------------*/ /** - * @fn UINT32 cdrom_read_subcode(cdrom_file *file, UINT32 lbasector, void *buffer, bool phys) + * @fn UINT32 cdrom_read_subcode(cdrom_file *file, UINT32 lbasector, void *buffer, bool phys) * - * @brief Cdrom read subcode. + * @brief Cdrom read subcode. * - * @param [in,out] file If non-null, the file. - * @param lbasector The lbasector. - * @param [in,out] buffer If non-null, the buffer. - * @param phys true to physical. + * @param [in,out] file If non-null, the file. + * @param lbasector The lbasector. + * @param [in,out] buffer If non-null, the buffer. + * @param phys true to physical. * - * @return An UINT32. + * @return An UINT32. */ UINT32 cdrom_read_subcode(cdrom_file *file, UINT32 lbasector, void *buffer, bool phys) @@ -642,14 +642,14 @@ UINT32 cdrom_read_subcode(cdrom_file *file, UINT32 lbasector, void *buffer, bool -------------------------------------------------*/ /** - * @fn UINT32 cdrom_get_track(cdrom_file *file, UINT32 frame) + * @fn UINT32 cdrom_get_track(cdrom_file *file, UINT32 frame) * - * @brief Cdrom get track. + * @brief Cdrom get track. * - * @param [in,out] file If non-null, the file. - * @param frame The frame. + * @param [in,out] file If non-null, the file. + * @param frame The frame. * - * @return An UINT32. + * @return An UINT32. */ UINT32 cdrom_get_track(cdrom_file *file, UINT32 frame) @@ -672,14 +672,14 @@ UINT32 cdrom_get_track(cdrom_file *file, UINT32 frame) -------------------------------------------------*/ /** - * @fn UINT32 cdrom_get_track_start(cdrom_file *file, UINT32 track) + * @fn UINT32 cdrom_get_track_start(cdrom_file *file, UINT32 track) * - * @brief Cdrom get track start. + * @brief Cdrom get track start. * - * @param [in,out] file If non-null, the file. - * @param track The track. + * @param [in,out] file If non-null, the file. + * @param track The track. * - * @return An UINT32. + * @return An UINT32. */ UINT32 cdrom_get_track_start(cdrom_file *file, UINT32 track) @@ -700,14 +700,14 @@ UINT32 cdrom_get_track_start(cdrom_file *file, UINT32 track) -------------------------------------------------*/ /** - * @fn UINT32 cdrom_get_track_start_phys(cdrom_file *file, UINT32 track) + * @fn UINT32 cdrom_get_track_start_phys(cdrom_file *file, UINT32 track) * - * @brief Cdrom get track start physical. + * @brief Cdrom get track start physical. * - * @param [in,out] file If non-null, the file. - * @param track The track. + * @param [in,out] file If non-null, the file. + * @param track The track. * - * @return An UINT32. + * @return An UINT32. */ UINT32 cdrom_get_track_start_phys(cdrom_file *file, UINT32 track) @@ -732,13 +732,13 @@ UINT32 cdrom_get_track_start_phys(cdrom_file *file, UINT32 track) -------------------------------------------------*/ /** - * @fn int cdrom_get_last_track(cdrom_file *file) + * @fn int cdrom_get_last_track(cdrom_file *file) * - * @brief Cdrom get last track. + * @brief Cdrom get last track. * - * @param [in,out] file If non-null, the file. + * @param [in,out] file If non-null, the file. * - * @return An int. + * @return An int. */ int cdrom_get_last_track(cdrom_file *file) @@ -756,14 +756,14 @@ int cdrom_get_last_track(cdrom_file *file) -------------------------------------------------*/ /** - * @fn int cdrom_get_adr_control(cdrom_file *file, int track) + * @fn int cdrom_get_adr_control(cdrom_file *file, int track) * - * @brief Cdrom get address control. + * @brief Cdrom get address control. * - * @param [in,out] file If non-null, the file. - * @param track The track. + * @param [in,out] file If non-null, the file. + * @param track The track. * - * @return An int. + * @return An int. */ int cdrom_get_adr_control(cdrom_file *file, int track) @@ -785,14 +785,14 @@ int cdrom_get_adr_control(cdrom_file *file, int track) -------------------------------------------------*/ /** - * @fn int cdrom_get_track_type(cdrom_file *file, int track) + * @fn int cdrom_get_track_type(cdrom_file *file, int track) * - * @brief Cdrom get track type. + * @brief Cdrom get track type. * - * @param [in,out] file If non-null, the file. - * @param track The track. + * @param [in,out] file If non-null, the file. + * @param track The track. * - * @return An int. + * @return An int. */ int cdrom_get_track_type(cdrom_file *file, int track) @@ -810,13 +810,13 @@ int cdrom_get_track_type(cdrom_file *file, int track) -------------------------------------------------*/ /** - * @fn const cdrom_toc *cdrom_get_toc(cdrom_file *file) + * @fn const cdrom_toc *cdrom_get_toc(cdrom_file *file) * - * @brief Cdrom get TOC. + * @brief Cdrom get TOC. * - * @param [in,out] file If non-null, the file. + * @param [in,out] file If non-null, the file. * - * @return null if it fails, else a cdrom_toc*. + * @return null if it fails, else a cdrom_toc*. */ const cdrom_toc *cdrom_get_toc(cdrom_file *file) @@ -840,13 +840,13 @@ const cdrom_toc *cdrom_get_toc(cdrom_file *file) -------------------------------------------------*/ /** - * @fn static void cdrom_get_info_from_type_string(const char *typestring, UINT32 *trktype, UINT32 *datasize) + * @fn static void cdrom_get_info_from_type_string(const char *typestring, UINT32 *trktype, UINT32 *datasize) * - * @brief Cdrom get information from type string. + * @brief Cdrom get information from type string. * - * @param typestring The typestring. - * @param [in,out] trktype If non-null, the trktype. - * @param [in,out] datasize If non-null, the datasize. + * @param typestring The typestring. + * @param [in,out] trktype If non-null, the trktype. + * @param [in,out] datasize If non-null, the datasize. */ static void cdrom_get_info_from_type_string(const char *typestring, UINT32 *trktype, UINT32 *datasize) @@ -935,12 +935,12 @@ static void cdrom_get_info_from_type_string(const char *typestring, UINT32 *trkt -------------------------------------------------*/ /** - * @fn void cdrom_convert_type_string_to_track_info(const char *typestring, cdrom_track_info *info) + * @fn void cdrom_convert_type_string_to_track_info(const char *typestring, cdrom_track_info *info) * - * @brief Cdrom convert type string to track information. + * @brief Cdrom convert type string to track information. * - * @param typestring The typestring. - * @param [in,out] info If non-null, the information. + * @param typestring The typestring. + * @param [in,out] info If non-null, the information. */ void cdrom_convert_type_string_to_track_info(const char *typestring, cdrom_track_info *info) @@ -955,12 +955,12 @@ void cdrom_convert_type_string_to_track_info(const char *typestring, cdrom_track -------------------------------------------------*/ /** - * @fn void cdrom_convert_type_string_to_pregap_info(const char *typestring, cdrom_track_info *info) + * @fn void cdrom_convert_type_string_to_pregap_info(const char *typestring, cdrom_track_info *info) * - * @brief Cdrom convert type string to pregap information. + * @brief Cdrom convert type string to pregap information. * - * @param typestring The typestring. - * @param [in,out] info If non-null, the information. + * @param typestring The typestring. + * @param [in,out] info If non-null, the information. */ void cdrom_convert_type_string_to_pregap_info(const char *typestring, cdrom_track_info *info) @@ -975,12 +975,12 @@ void cdrom_convert_type_string_to_pregap_info(const char *typestring, cdrom_trac -------------------------------------------------*/ /** - * @fn void cdrom_convert_subtype_string_to_track_info(const char *typestring, cdrom_track_info *info) + * @fn void cdrom_convert_subtype_string_to_track_info(const char *typestring, cdrom_track_info *info) * - * @brief Cdrom convert subtype string to track information. + * @brief Cdrom convert subtype string to track information. * - * @param typestring The typestring. - * @param [in,out] info If non-null, the information. + * @param typestring The typestring. + * @param [in,out] info If non-null, the information. */ void cdrom_convert_subtype_string_to_track_info(const char *typestring, cdrom_track_info *info) @@ -1004,12 +1004,12 @@ void cdrom_convert_subtype_string_to_track_info(const char *typestring, cdrom_tr -------------------------------------------------*/ /** - * @fn void cdrom_convert_subtype_string_to_pregap_info(const char *typestring, cdrom_track_info *info) + * @fn void cdrom_convert_subtype_string_to_pregap_info(const char *typestring, cdrom_track_info *info) * - * @brief Cdrom convert subtype string to pregap information. + * @brief Cdrom convert subtype string to pregap information. * - * @param typestring The typestring. - * @param [in,out] info If non-null, the information. + * @param typestring The typestring. + * @param [in,out] info If non-null, the information. */ void cdrom_convert_subtype_string_to_pregap_info(const char *typestring, cdrom_track_info *info) @@ -1032,13 +1032,13 @@ void cdrom_convert_subtype_string_to_pregap_info(const char *typestring, cdrom_t -------------------------------------------------*/ /** - * @fn const char *cdrom_get_type_string(UINT32 trktype) + * @fn const char *cdrom_get_type_string(UINT32 trktype) * - * @brief Cdrom get type string. + * @brief Cdrom get type string. * - * @param trktype The trktype. + * @param trktype The trktype. * - * @return null if it fails, else a char*. + * @return null if it fails, else a char*. */ const char *cdrom_get_type_string(UINT32 trktype) @@ -1064,13 +1064,13 @@ const char *cdrom_get_type_string(UINT32 trktype) -------------------------------------------------*/ /** - * @fn const char *cdrom_get_subtype_string(UINT32 subtype) + * @fn const char *cdrom_get_subtype_string(UINT32 subtype) * - * @brief Cdrom get subtype string. + * @brief Cdrom get subtype string. * - * @param subtype The subtype. + * @param subtype The subtype. * - * @return null if it fails, else a char*. + * @return null if it fails, else a char*. */ const char *cdrom_get_subtype_string(UINT32 subtype) @@ -1095,14 +1095,14 @@ const char *cdrom_get_subtype_string(UINT32 subtype) -------------------------------------------------*/ /** - * @fn chd_error cdrom_parse_metadata(chd_file *chd, cdrom_toc *toc) + * @fn chd_error cdrom_parse_metadata(chd_file *chd, cdrom_toc *toc) * - * @brief Cdrom parse metadata. + * @brief Cdrom parse metadata. * - * @param [in,out] chd If non-null, the chd. - * @param [in,out] toc If non-null, the TOC. + * @param [in,out] chd If non-null, the chd. + * @param [in,out] toc If non-null, the TOC. * - * @return A chd_error. + * @return A chd_error. */ chd_error cdrom_parse_metadata(chd_file *chd, cdrom_toc *toc) @@ -1272,14 +1272,14 @@ chd_error cdrom_parse_metadata(chd_file *chd, cdrom_toc *toc) -------------------------------------------------*/ /** - * @fn chd_error cdrom_write_metadata(chd_file *chd, const cdrom_toc *toc) + * @fn chd_error cdrom_write_metadata(chd_file *chd, const cdrom_toc *toc) * - * @brief Cdrom write metadata. + * @brief Cdrom write metadata. * - * @param [in,out] chd If non-null, the chd. - * @param toc The TOC. + * @param [in,out] chd If non-null, the chd. + * @param toc The TOC. * - * @return A chd_error. + * @return A chd_error. */ chd_error cdrom_write_metadata(chd_file *chd, const cdrom_toc *toc) @@ -1327,9 +1327,9 @@ chd_error cdrom_write_metadata(chd_file *chd, const cdrom_toc *toc) } /** - * @brief ------------------------------------------------- - * ECC lookup tables pre-calculated tables for ECC data calcs - * -------------------------------------------------. + * @brief ------------------------------------------------- + * ECC lookup tables pre-calculated tables for ECC data calcs + * -------------------------------------------------. */ static const UINT8 ecclow[256] = @@ -1352,7 +1352,7 @@ static const UINT8 ecclow[256] = 0xfd, 0xff, 0xf9, 0xfb, 0xf5, 0xf7, 0xf1, 0xf3, 0xed, 0xef, 0xe9, 0xeb, 0xe5, 0xe7, 0xe1, 0xe3 }; -/** @brief The ecchigh[ 256]. */ +/** @brief The ecchigh[ 256]. */ static const UINT8 ecchigh[256] = { 0x00, 0xf4, 0xf5, 0x01, 0xf7, 0x03, 0x02, 0xf6, 0xf3, 0x07, 0x06, 0xf2, 0x04, 0xf0, 0xf1, 0x05, @@ -1374,10 +1374,10 @@ static const UINT8 ecchigh[256] = }; /** - * @brief ------------------------------------------------- - * poffsets - each row represents the addresses used to calculate a byte of the ECC P - * data 86 (*2) ECC P bytes, 24 values represented by each - * -------------------------------------------------. + * @brief ------------------------------------------------- + * poffsets - each row represents the addresses used to calculate a byte of the ECC P + * data 86 (*2) ECC P bytes, 24 values represented by each + * -------------------------------------------------. */ static const UINT16 poffsets[ECC_P_NUM_BYTES][ECC_P_COMP] = @@ -1471,10 +1471,10 @@ static const UINT16 poffsets[ECC_P_NUM_BYTES][ECC_P_COMP] = }; /** - * @brief ------------------------------------------------- - * qoffsets - each row represents the addresses used to calculate a byte of the ECC Q - * data 52 (*2) ECC Q bytes, 43 values represented by each - * -------------------------------------------------. + * @brief ------------------------------------------------- + * qoffsets - each row represents the addresses used to calculate a byte of the ECC Q + * data 52 (*2) ECC Q bytes, 43 values represented by each + * -------------------------------------------------. */ static const UINT16 qoffsets[ECC_Q_NUM_BYTES][ECC_Q_COMP] = @@ -1547,17 +1547,17 @@ inline UINT8 ecc_source_byte(const UINT8 *sector, UINT32 offset) } /** - * @fn void ecc_compute_bytes(const UINT8 *sector, const UINT16 *row, int rowlen, UINT8 &val1, UINT8 &val2) + * @fn void ecc_compute_bytes(const UINT8 *sector, const UINT16 *row, int rowlen, UINT8 &val1, UINT8 &val2) * - * @brief ------------------------------------------------- - * ecc_compute_bytes - calculate an ECC value (P or Q) - * -------------------------------------------------. + * @brief ------------------------------------------------- + * ecc_compute_bytes - calculate an ECC value (P or Q) + * -------------------------------------------------. * - * @param sector The sector. - * @param row The row. - * @param rowlen The rowlen. - * @param [in,out] val1 The first value. - * @param [in,out] val2 The second value. + * @param sector The sector. + * @param row The row. + * @param rowlen The rowlen. + * @param [in,out] val1 The first value. + * @param [in,out] val2 The second value. */ void ecc_compute_bytes(const UINT8 *sector, const UINT16 *row, int rowlen, UINT8 &val1, UINT8 &val2) @@ -1574,15 +1574,15 @@ void ecc_compute_bytes(const UINT8 *sector, const UINT16 *row, int rowlen, UINT8 } /** - * @fn bool ecc_verify(const UINT8 *sector) + * @fn bool ecc_verify(const UINT8 *sector) * - * @brief ------------------------------------------------- - * ecc_verify - verify the P and Q ECC codes in a sector - * -------------------------------------------------. + * @brief ------------------------------------------------- + * ecc_verify - verify the P and Q ECC codes in a sector + * -------------------------------------------------. * - * @param sector The sector. + * @param sector The sector. * - * @return true if it succeeds, false if it fails. + * @return true if it succeeds, false if it fails. */ bool ecc_verify(const UINT8 *sector) @@ -1608,14 +1608,14 @@ bool ecc_verify(const UINT8 *sector) } /** - * @fn void ecc_generate(UINT8 *sector) + * @fn void ecc_generate(UINT8 *sector) * - * @brief ------------------------------------------------- - * ecc_generate - generate the P and Q ECC codes for a sector, overwriting any - * existing codes - * -------------------------------------------------. + * @brief ------------------------------------------------- + * ecc_generate - generate the P and Q ECC codes for a sector, overwriting any + * existing codes + * -------------------------------------------------. * - * @param [in,out] sector If non-null, the sector. + * @param [in,out] sector If non-null, the sector. */ void ecc_generate(UINT8 *sector) @@ -1630,13 +1630,13 @@ void ecc_generate(UINT8 *sector) } /** - * @fn void ecc_clear(UINT8 *sector) + * @fn void ecc_clear(UINT8 *sector) * - * @brief ------------------------------------------------- - * ecc_clear - erase the ECC P and Q cods to 0 within a sector - * -------------------------------------------------. + * @brief ------------------------------------------------- + * ecc_clear - erase the ECC P and Q cods to 0 within a sector + * -------------------------------------------------. * - * @param [in,out] sector If non-null, the sector. + * @param [in,out] sector If non-null, the sector. */ void ecc_clear(UINT8 *sector) diff --git a/src/lib/util/chd.c b/src/lib/util/chd.c index f9bdf179f8a..07e98d03b85 100644 --- a/src/lib/util/chd.c +++ b/src/lib/util/chd.c @@ -280,11 +280,11 @@ inline UINT8 chd_file::bits_for_value(UINT64 value) //************************************************************************** /** - * @fn chd_file::chd_file() + * @fn chd_file::chd_file() * - * @brief ------------------------------------------------- - * chd_file - constructor - * -------------------------------------------------. + * @brief ------------------------------------------------- + * chd_file - constructor + * -------------------------------------------------. */ chd_file::chd_file() @@ -297,11 +297,11 @@ chd_file::chd_file() } /** - * @fn chd_file::~chd_file() + * @fn chd_file::~chd_file() * - * @brief ------------------------------------------------- - * ~chd_file - destructor - * -------------------------------------------------. + * @brief ------------------------------------------------- + * ~chd_file - destructor + * -------------------------------------------------. */ chd_file::~chd_file() @@ -311,13 +311,13 @@ chd_file::~chd_file() } /** - * @fn sha1_t chd_file::sha1() + * @fn sha1_t chd_file::sha1() * - * @brief ------------------------------------------------- - * sha1 - return our SHA1 value - * -------------------------------------------------. + * @brief ------------------------------------------------- + * sha1 - return our SHA1 value + * -------------------------------------------------. * - * @return A sha1_t. + * @return A sha1_t. */ sha1_t chd_file::sha1() @@ -337,16 +337,16 @@ sha1_t chd_file::sha1() } /** - * @fn sha1_t chd_file::raw_sha1() + * @fn sha1_t chd_file::raw_sha1() * - * @brief ------------------------------------------------- - * raw_sha1 - return our raw SHA1 value - * -------------------------------------------------. + * @brief ------------------------------------------------- + * raw_sha1 - return our raw SHA1 value + * -------------------------------------------------. * - * @exception CHDERR_UNSUPPORTED_VERSION Thrown when a chderr unsupported version error - * condition occurs. + * @exception CHDERR_UNSUPPORTED_VERSION Thrown when a chderr unsupported version error + * condition occurs. * - * @return A sha1_t. + * @return A sha1_t. */ sha1_t chd_file::raw_sha1() @@ -370,16 +370,16 @@ sha1_t chd_file::raw_sha1() } /** - * @fn sha1_t chd_file::parent_sha1() + * @fn sha1_t chd_file::parent_sha1() * - * @brief ------------------------------------------------- - * parent_sha1 - return our parent's SHA1 value - * -------------------------------------------------. + * @brief ------------------------------------------------- + * parent_sha1 - return our parent's SHA1 value + * -------------------------------------------------. * - * @exception CHDERR_UNSUPPORTED_VERSION Thrown when a chderr unsupported version error - * condition occurs. + * @exception CHDERR_UNSUPPORTED_VERSION Thrown when a chderr unsupported version error + * condition occurs. * - * @return A sha1_t. + * @return A sha1_t. */ sha1_t chd_file::parent_sha1() @@ -403,17 +403,17 @@ sha1_t chd_file::parent_sha1() } /** - * @fn chd_error chd_file::hunk_info(UINT32 hunknum, chd_codec_type &compressor, UINT32 &compbytes) + * @fn chd_error chd_file::hunk_info(UINT32 hunknum, chd_codec_type &compressor, UINT32 &compbytes) * - * @brief ------------------------------------------------- - * hunk_info - return information about this hunk - * -------------------------------------------------. + * @brief ------------------------------------------------- + * hunk_info - return information about this hunk + * -------------------------------------------------. * - * @param hunknum The hunknum. - * @param [in,out] compressor The compressor. - * @param [in,out] compbytes The compbytes. + * @param hunknum The hunknum. + * @param [in,out] compressor The compressor. + * @param [in,out] compbytes The compbytes. * - * @return A chd_error. + * @return A chd_error. */ chd_error chd_file::hunk_info(UINT32 hunknum, chd_codec_type &compressor, UINT32 &compbytes) @@ -514,13 +514,13 @@ chd_error chd_file::hunk_info(UINT32 hunknum, chd_codec_type &compressor, UINT32 } /** - * @fn void chd_file::set_raw_sha1(sha1_t rawdata) + * @fn void chd_file::set_raw_sha1(sha1_t rawdata) * - * @brief ------------------------------------------------- - * set_raw_sha1 - set our SHA1 values - * -------------------------------------------------. + * @brief ------------------------------------------------- + * set_raw_sha1 - set our SHA1 values + * -------------------------------------------------. * - * @param rawdata The rawdata. + * @param rawdata The rawdata. */ void chd_file::set_raw_sha1(sha1_t rawdata) @@ -540,15 +540,15 @@ void chd_file::set_raw_sha1(sha1_t rawdata) } /** - * @fn void chd_file::set_parent_sha1(sha1_t parent) + * @fn void chd_file::set_parent_sha1(sha1_t parent) * - * @brief ------------------------------------------------- - * set_parent_sha1 - set the parent SHA1 value - * -------------------------------------------------. + * @brief ------------------------------------------------- + * set_parent_sha1 - set the parent SHA1 value + * -------------------------------------------------. * - * @exception CHDERR_INVALID_FILE Thrown when a chderr invalid file error condition occurs. + * @exception CHDERR_INVALID_FILE Thrown when a chderr invalid file error condition occurs. * - * @param parent The parent. + * @param parent The parent. */ void chd_file::set_parent_sha1(sha1_t parent) @@ -567,19 +567,19 @@ void chd_file::set_parent_sha1(sha1_t parent) } /** - * @fn chd_error chd_file::create(core_file &file, UINT64 logicalbytes, UINT32 hunkbytes, UINT32 unitbytes, chd_codec_type compression[4]) + * @fn chd_error chd_file::create(core_file &file, UINT64 logicalbytes, UINT32 hunkbytes, UINT32 unitbytes, chd_codec_type compression[4]) * - * @brief ------------------------------------------------- - * create - create a new file with no parent using an existing opened file handle - * -------------------------------------------------. + * @brief ------------------------------------------------- + * create - create a new file with no parent using an existing opened file handle + * -------------------------------------------------. * - * @param [in,out] file The file. - * @param logicalbytes The logicalbytes. - * @param hunkbytes The hunkbytes. - * @param unitbytes The unitbytes. - * @param compression The compression. + * @param [in,out] file The file. + * @param logicalbytes The logicalbytes. + * @param hunkbytes The hunkbytes. + * @param unitbytes The unitbytes. + * @param compression The compression. * - * @return A chd_error. + * @return A chd_error. */ chd_error chd_file::create(core_file &file, UINT64 logicalbytes, UINT32 hunkbytes, UINT32 unitbytes, chd_codec_type compression[4]) @@ -602,19 +602,19 @@ chd_error chd_file::create(core_file &file, UINT64 logicalbytes, UINT32 hunkbyte } /** - * @fn chd_error chd_file::create(core_file &file, UINT64 logicalbytes, UINT32 hunkbytes, chd_codec_type compression[4], chd_file &parent) + * @fn chd_error chd_file::create(core_file &file, UINT64 logicalbytes, UINT32 hunkbytes, chd_codec_type compression[4], chd_file &parent) * - * @brief ------------------------------------------------- - * create - create a new file with a parent using an existing opened file handle - * -------------------------------------------------. + * @brief ------------------------------------------------- + * create - create a new file with a parent using an existing opened file handle + * -------------------------------------------------. * - * @param [in,out] file The file. - * @param logicalbytes The logicalbytes. - * @param hunkbytes The hunkbytes. - * @param compression The compression. - * @param [in,out] parent The parent. + * @param [in,out] file The file. + * @param logicalbytes The logicalbytes. + * @param hunkbytes The hunkbytes. + * @param compression The compression. + * @param [in,out] parent The parent. * - * @return A chd_error. + * @return A chd_error. */ chd_error chd_file::create(core_file &file, UINT64 logicalbytes, UINT32 hunkbytes, chd_codec_type compression[4], chd_file &parent) @@ -637,19 +637,19 @@ chd_error chd_file::create(core_file &file, UINT64 logicalbytes, UINT32 hunkbyte } /** - * @fn chd_error chd_file::create(const char *filename, UINT64 logicalbytes, UINT32 hunkbytes, UINT32 unitbytes, chd_codec_type compression[4]) + * @fn chd_error chd_file::create(const char *filename, UINT64 logicalbytes, UINT32 hunkbytes, UINT32 unitbytes, chd_codec_type compression[4]) * - * @brief ------------------------------------------------- - * create - create a new file with no parent using a filename - * -------------------------------------------------. + * @brief ------------------------------------------------- + * create - create a new file with no parent using a filename + * -------------------------------------------------. * - * @param filename Filename of the file. - * @param logicalbytes The logicalbytes. - * @param hunkbytes The hunkbytes. - * @param unitbytes The unitbytes. - * @param compression The compression. + * @param filename Filename of the file. + * @param logicalbytes The logicalbytes. + * @param hunkbytes The hunkbytes. + * @param unitbytes The unitbytes. + * @param compression The compression. * - * @return A chd_error. + * @return A chd_error. */ chd_error chd_file::create(const char *filename, UINT64 logicalbytes, UINT32 hunkbytes, UINT32 unitbytes, chd_codec_type compression[4]) @@ -678,19 +678,19 @@ chd_error chd_file::create(const char *filename, UINT64 logicalbytes, UINT32 hun } /** - * @fn chd_error chd_file::create(const char *filename, UINT64 logicalbytes, UINT32 hunkbytes, chd_codec_type compression[4], chd_file &parent) + * @fn chd_error chd_file::create(const char *filename, UINT64 logicalbytes, UINT32 hunkbytes, chd_codec_type compression[4], chd_file &parent) * - * @brief ------------------------------------------------- - * create - create a new file with a parent using a filename - * -------------------------------------------------. + * @brief ------------------------------------------------- + * create - create a new file with a parent using a filename + * -------------------------------------------------. * - * @param filename Filename of the file. - * @param logicalbytes The logicalbytes. - * @param hunkbytes The hunkbytes. - * @param compression The compression. - * @param [in,out] parent The parent. + * @param filename Filename of the file. + * @param logicalbytes The logicalbytes. + * @param hunkbytes The hunkbytes. + * @param compression The compression. + * @param [in,out] parent The parent. * - * @return A chd_error. + * @return A chd_error. */ chd_error chd_file::create(const char *filename, UINT64 logicalbytes, UINT32 hunkbytes, chd_codec_type compression[4], chd_file &parent) @@ -719,17 +719,17 @@ chd_error chd_file::create(const char *filename, UINT64 logicalbytes, UINT32 hun } /** - * @fn chd_error chd_file::open(const char *filename, bool writeable, chd_file *parent) + * @fn chd_error chd_file::open(const char *filename, bool writeable, chd_file *parent) * - * @brief ------------------------------------------------- - * open - open an existing file for read or read/write - * -------------------------------------------------. + * @brief ------------------------------------------------- + * open - open an existing file for read or read/write + * -------------------------------------------------. * - * @param filename Filename of the file. - * @param writeable true if writeable. - * @param [in,out] parent If non-null, the parent. + * @param filename Filename of the file. + * @param writeable true if writeable. + * @param [in,out] parent If non-null, the parent. * - * @return A chd_error. + * @return A chd_error. */ chd_error chd_file::open(const char *filename, bool writeable, chd_file *parent) @@ -759,17 +759,17 @@ chd_error chd_file::open(const char *filename, bool writeable, chd_file *parent) } /** - * @fn chd_error chd_file::open(core_file &file, bool writeable, chd_file *parent) + * @fn chd_error chd_file::open(core_file &file, bool writeable, chd_file *parent) * - * @brief ------------------------------------------------- - * open - open an existing file for read or read/write - * -------------------------------------------------. + * @brief ------------------------------------------------- + * open - open an existing file for read or read/write + * -------------------------------------------------. * - * @param [in,out] file The file. - * @param writeable true if writeable. - * @param [in,out] parent If non-null, the parent. + * @param [in,out] file The file. + * @param writeable true if writeable. + * @param [in,out] parent If non-null, the parent. * - * @return A chd_error. + * @return A chd_error. */ chd_error chd_file::open(core_file &file, bool writeable, chd_file *parent) @@ -786,11 +786,11 @@ chd_error chd_file::open(core_file &file, bool writeable, chd_file *parent) } /** - * @fn void chd_file::close() + * @fn void chd_file::close() * - * @brief ------------------------------------------------- - * close - close a CHD file for access - * -------------------------------------------------. + * @brief ------------------------------------------------- + * close - close a CHD file for access + * -------------------------------------------------. */ void chd_file::close() @@ -841,26 +841,26 @@ void chd_file::close() } /** - * @fn chd_error chd_file::read_hunk(UINT32 hunknum, void *buffer) - * - * @brief ------------------------------------------------- - * read - read a single hunk from the CHD file - * -------------------------------------------------. - * - * @exception CHDERR_NOT_OPEN Thrown when a chderr not open error condition occurs. - * @exception CHDERR_HUNK_OUT_OF_RANGE Thrown when a chderr hunk out of range error - * condition occurs. - * @exception CHDERR_DECOMPRESSION_ERROR Thrown when a chderr decompression error error - * condition occurs. - * @exception CHDERR_REQUIRES_PARENT Thrown when a chderr requires parent error condition - * occurs. - * @exception CHDERR_READ_ERROR Thrown when a chderr read error error condition - * occurs. - * - * @param hunknum The hunknum. - * @param [in,out] buffer If non-null, the buffer. - * - * @return The hunk. + * @fn chd_error chd_file::read_hunk(UINT32 hunknum, void *buffer) + * + * @brief ------------------------------------------------- + * read - read a single hunk from the CHD file + * -------------------------------------------------. + * + * @exception CHDERR_NOT_OPEN Thrown when a chderr not open error condition occurs. + * @exception CHDERR_HUNK_OUT_OF_RANGE Thrown when a chderr hunk out of range error + * condition occurs. + * @exception CHDERR_DECOMPRESSION_ERROR Thrown when a chderr decompression error error + * condition occurs. + * @exception CHDERR_REQUIRES_PARENT Thrown when a chderr requires parent error condition + * occurs. + * @exception CHDERR_READ_ERROR Thrown when a chderr read error error condition + * occurs. + * + * @param hunknum The hunknum. + * @param [in,out] buffer If non-null, the buffer. + * + * @return The hunk. */ chd_error chd_file::read_hunk(UINT32 hunknum, void *buffer) @@ -990,22 +990,22 @@ chd_error chd_file::read_hunk(UINT32 hunknum, void *buffer) } /** - * @fn chd_error chd_file::write_hunk(UINT32 hunknum, const void *buffer) + * @fn chd_error chd_file::write_hunk(UINT32 hunknum, const void *buffer) * - * @brief ------------------------------------------------- - * write - write a single hunk to the CHD file - * -------------------------------------------------. + * @brief ------------------------------------------------- + * write - write a single hunk to the CHD file + * -------------------------------------------------. * - * @exception CHDERR_NOT_OPEN Thrown when a chderr not open error condition occurs. - * @exception CHDERR_HUNK_OUT_OF_RANGE Thrown when a chderr hunk out of range error - * condition occurs. - * @exception CHDERR_FILE_NOT_WRITEABLE Thrown when a chderr file not writeable error - * condition occurs. + * @exception CHDERR_NOT_OPEN Thrown when a chderr not open error condition occurs. + * @exception CHDERR_HUNK_OUT_OF_RANGE Thrown when a chderr hunk out of range error + * condition occurs. + * @exception CHDERR_FILE_NOT_WRITEABLE Thrown when a chderr file not writeable error + * condition occurs. * - * @param hunknum The hunknum. - * @param buffer The buffer. + * @param hunknum The hunknum. + * @param buffer The buffer. * - * @return A chd_error. + * @return A chd_error. */ chd_error chd_file::write_hunk(UINT32 hunknum, const void *buffer) @@ -1076,17 +1076,17 @@ chd_error chd_file::write_hunk(UINT32 hunknum, const void *buffer) } /** - * @fn chd_error chd_file::read_units(UINT64 unitnum, void *buffer, UINT32 count) + * @fn chd_error chd_file::read_units(UINT64 unitnum, void *buffer, UINT32 count) * - * @brief ------------------------------------------------- - * read_units - read the given number of units from the CHD - * -------------------------------------------------. + * @brief ------------------------------------------------- + * read_units - read the given number of units from the CHD + * -------------------------------------------------. * - * @param unitnum The unitnum. - * @param [in,out] buffer If non-null, the buffer. - * @param count Number of. + * @param unitnum The unitnum. + * @param [in,out] buffer If non-null, the buffer. + * @param count Number of. * - * @return The units. + * @return The units. */ chd_error chd_file::read_units(UINT64 unitnum, void *buffer, UINT32 count) @@ -1095,17 +1095,17 @@ chd_error chd_file::read_units(UINT64 unitnum, void *buffer, UINT32 count) } /** - * @fn chd_error chd_file::write_units(UINT64 unitnum, const void *buffer, UINT32 count) + * @fn chd_error chd_file::write_units(UINT64 unitnum, const void *buffer, UINT32 count) * - * @brief ------------------------------------------------- - * write_units - write the given number of units to the CHD - * -------------------------------------------------. + * @brief ------------------------------------------------- + * write_units - write the given number of units to the CHD + * -------------------------------------------------. * - * @param unitnum The unitnum. - * @param buffer The buffer. - * @param count Number of. + * @param unitnum The unitnum. + * @param buffer The buffer. + * @param count Number of. * - * @return A chd_error. + * @return A chd_error. */ chd_error chd_file::write_units(UINT64 unitnum, const void *buffer, UINT32 count) @@ -1114,18 +1114,18 @@ chd_error chd_file::write_units(UINT64 unitnum, const void *buffer, UINT32 count } /** - * @fn chd_error chd_file::read_bytes(UINT64 offset, void *buffer, UINT32 bytes) + * @fn chd_error chd_file::read_bytes(UINT64 offset, void *buffer, UINT32 bytes) * - * @brief ------------------------------------------------- - * read_bytes - read from the CHD at a byte level, using the cache to handle partial - * hunks - * -------------------------------------------------. + * @brief ------------------------------------------------- + * read_bytes - read from the CHD at a byte level, using the cache to handle partial + * hunks + * -------------------------------------------------. * - * @param offset The offset. - * @param [in,out] buffer If non-null, the buffer. - * @param bytes The bytes. + * @param offset The offset. + * @param [in,out] buffer If non-null, the buffer. + * @param bytes The bytes. * - * @return The bytes. + * @return The bytes. */ chd_error chd_file::read_bytes(UINT64 offset, void *buffer, UINT32 bytes) @@ -1167,18 +1167,18 @@ chd_error chd_file::read_bytes(UINT64 offset, void *buffer, UINT32 bytes) } /** - * @fn chd_error chd_file::write_bytes(UINT64 offset, const void *buffer, UINT32 bytes) + * @fn chd_error chd_file::write_bytes(UINT64 offset, const void *buffer, UINT32 bytes) * - * @brief ------------------------------------------------- - * write_bytes - write to the CHD at a byte level, using the cache to handle partial - * hunks - * -------------------------------------------------. + * @brief ------------------------------------------------- + * write_bytes - write to the CHD at a byte level, using the cache to handle partial + * hunks + * -------------------------------------------------. * - * @param offset The offset. - * @param buffer The buffer. - * @param bytes The bytes. + * @param offset The offset. + * @param buffer The buffer. + * @param bytes The bytes. * - * @return A chd_error. + * @return A chd_error. */ chd_error chd_file::write_bytes(UINT64 offset, const void *buffer, UINT32 bytes) @@ -1221,20 +1221,20 @@ chd_error chd_file::write_bytes(UINT64 offset, const void *buffer, UINT32 bytes) } /** - * @fn chd_error chd_file::read_metadata(chd_metadata_tag searchtag, UINT32 searchindex, std::string &output) + * @fn chd_error chd_file::read_metadata(chd_metadata_tag searchtag, UINT32 searchindex, std::string &output) * - * @brief ------------------------------------------------- - * read_metadata - read the indexed metadata of the given type - * -------------------------------------------------. + * @brief ------------------------------------------------- + * read_metadata - read the indexed metadata of the given type + * -------------------------------------------------. * - * @exception CHDERR_METADATA_NOT_FOUND Thrown when a chderr metadata not found error - * condition occurs. + * @exception CHDERR_METADATA_NOT_FOUND Thrown when a chderr metadata not found error + * condition occurs. * - * @param searchtag The searchtag. - * @param searchindex The searchindex. - * @param [in,out] output The output. + * @param searchtag The searchtag. + * @param searchindex The searchindex. + * @param [in,out] output The output. * - * @return The metadata. + * @return The metadata. */ chd_error chd_file::read_metadata(chd_metadata_tag searchtag, UINT32 searchindex, std::string &output) @@ -1265,18 +1265,18 @@ chd_error chd_file::read_metadata(chd_metadata_tag searchtag, UINT32 searchindex } /** - * @fn chd_error chd_file::read_metadata(chd_metadata_tag searchtag, UINT32 searchindex, dynamic_buffer &output) + * @fn chd_error chd_file::read_metadata(chd_metadata_tag searchtag, UINT32 searchindex, dynamic_buffer &output) * - * @brief Reads a metadata. + * @brief Reads a metadata. * - * @exception CHDERR_METADATA_NOT_FOUND Thrown when a chderr metadata not found error - * condition occurs. + * @exception CHDERR_METADATA_NOT_FOUND Thrown when a chderr metadata not found error + * condition occurs. * - * @param searchtag The searchtag. - * @param searchindex The searchindex. - * @param [in,out] output The output. + * @param searchtag The searchtag. + * @param searchindex The searchindex. + * @param [in,out] output The output. * - * @return The metadata. + * @return The metadata. */ chd_error chd_file::read_metadata(chd_metadata_tag searchtag, UINT32 searchindex, dynamic_buffer &output) @@ -1303,20 +1303,20 @@ chd_error chd_file::read_metadata(chd_metadata_tag searchtag, UINT32 searchindex } /** - * @fn chd_error chd_file::read_metadata(chd_metadata_tag searchtag, UINT32 searchindex, void *output, UINT32 outputlen, UINT32 &resultlen) + * @fn chd_error chd_file::read_metadata(chd_metadata_tag searchtag, UINT32 searchindex, void *output, UINT32 outputlen, UINT32 &resultlen) * - * @brief Reads a metadata. + * @brief Reads a metadata. * - * @exception CHDERR_METADATA_NOT_FOUND Thrown when a chderr metadata not found error - * condition occurs. + * @exception CHDERR_METADATA_NOT_FOUND Thrown when a chderr metadata not found error + * condition occurs. * - * @param searchtag The searchtag. - * @param searchindex The searchindex. - * @param [in,out] output If non-null, the output. - * @param outputlen The outputlen. - * @param [in,out] resultlen The resultlen. + * @param searchtag The searchtag. + * @param searchindex The searchindex. + * @param [in,out] output If non-null, the output. + * @param outputlen The outputlen. + * @param [in,out] resultlen The resultlen. * - * @return The metadata. + * @return The metadata. */ chd_error chd_file::read_metadata(chd_metadata_tag searchtag, UINT32 searchindex, void *output, UINT32 outputlen, UINT32 &resultlen) @@ -1343,20 +1343,20 @@ chd_error chd_file::read_metadata(chd_metadata_tag searchtag, UINT32 searchindex } /** - * @fn chd_error chd_file::read_metadata(chd_metadata_tag searchtag, UINT32 searchindex, dynamic_buffer &output, chd_metadata_tag &resulttag, UINT8 &resultflags) + * @fn chd_error chd_file::read_metadata(chd_metadata_tag searchtag, UINT32 searchindex, dynamic_buffer &output, chd_metadata_tag &resulttag, UINT8 &resultflags) * - * @brief Reads a metadata. + * @brief Reads a metadata. * - * @exception CHDERR_METADATA_NOT_FOUND Thrown when a chderr metadata not found error - * condition occurs. + * @exception CHDERR_METADATA_NOT_FOUND Thrown when a chderr metadata not found error + * condition occurs. * - * @param searchtag The searchtag. - * @param searchindex The searchindex. - * @param [in,out] output The output. - * @param [in,out] resulttag The resulttag. - * @param [in,out] resultflags The resultflags. + * @param searchtag The searchtag. + * @param searchindex The searchindex. + * @param [in,out] output The output. + * @param [in,out] resulttag The resulttag. + * @param [in,out] resultflags The resultflags. * - * @return The metadata. + * @return The metadata. */ chd_error chd_file::read_metadata(chd_metadata_tag searchtag, UINT32 searchindex, dynamic_buffer &output, chd_metadata_tag &resulttag, UINT8 &resultflags) @@ -1385,19 +1385,19 @@ chd_error chd_file::read_metadata(chd_metadata_tag searchtag, UINT32 searchindex } /** - * @fn chd_error chd_file::write_metadata(chd_metadata_tag metatag, UINT32 metaindex, const void *inputbuf, UINT32 inputlen, UINT8 flags) + * @fn chd_error chd_file::write_metadata(chd_metadata_tag metatag, UINT32 metaindex, const void *inputbuf, UINT32 inputlen, UINT8 flags) * - * @brief ------------------------------------------------- - * write_metadata - write the indexed metadata of the given type - * -------------------------------------------------. + * @brief ------------------------------------------------- + * write_metadata - write the indexed metadata of the given type + * -------------------------------------------------. * - * @param metatag The metatag. - * @param metaindex The metaindex. - * @param inputbuf The inputbuf. - * @param inputlen The inputlen. - * @param flags The flags. + * @param metatag The metatag. + * @param metaindex The metaindex. + * @param inputbuf The inputbuf. + * @param inputlen The inputlen. + * @param flags The flags. * - * @return A chd_error. + * @return A chd_error. */ chd_error chd_file::write_metadata(chd_metadata_tag metatag, UINT32 metaindex, const void *inputbuf, UINT32 inputlen, UINT8 flags) @@ -1467,19 +1467,19 @@ chd_error chd_file::write_metadata(chd_metadata_tag metatag, UINT32 metaindex, c } /** - * @fn chd_error chd_file::delete_metadata(chd_metadata_tag metatag, UINT32 metaindex) + * @fn chd_error chd_file::delete_metadata(chd_metadata_tag metatag, UINT32 metaindex) * - * @brief ------------------------------------------------- - * delete_metadata - remove the given metadata from the list - * -------------------------------------------------. + * @brief ------------------------------------------------- + * delete_metadata - remove the given metadata from the list + * -------------------------------------------------. * - * @exception CHDERR_METADATA_NOT_FOUND Thrown when a chderr metadata not found error - * condition occurs. + * @exception CHDERR_METADATA_NOT_FOUND Thrown when a chderr metadata not found error + * condition occurs. * - * @param metatag The metatag. - * @param metaindex The metaindex. + * @param metatag The metatag. + * @param metaindex The metaindex. * - * @return A chd_error. + * @return A chd_error. */ chd_error chd_file::delete_metadata(chd_metadata_tag metatag, UINT32 metaindex) @@ -1505,17 +1505,17 @@ chd_error chd_file::delete_metadata(chd_metadata_tag metatag, UINT32 metaindex) } /** - * @fn chd_error chd_file::clone_all_metadata(chd_file &source) + * @fn chd_error chd_file::clone_all_metadata(chd_file &source) * - * @brief ------------------------------------------------- - * clone_all_metadata - clone the metadata from one CHD to a second - * -------------------------------------------------. + * @brief ------------------------------------------------- + * clone_all_metadata - clone the metadata from one CHD to a second + * -------------------------------------------------. * - * @exception err Thrown when an error error condition occurs. + * @exception err Thrown when an error error condition occurs. * - * @param [in,out] source Another instance to copy. + * @param [in,out] source Another instance to copy. * - * @return A chd_error. + * @return A chd_error. */ chd_error chd_file::clone_all_metadata(chd_file &source) @@ -1552,16 +1552,16 @@ chd_error chd_file::clone_all_metadata(chd_file &source) } /** - * @fn sha1_t chd_file::compute_overall_sha1(sha1_t rawsha1) + * @fn sha1_t chd_file::compute_overall_sha1(sha1_t rawsha1) * - * @brief ------------------------------------------------- - * compute_overall_sha1 - iterate through the metadata and compute the overall hash of - * the CHD file - * -------------------------------------------------. + * @brief ------------------------------------------------- + * compute_overall_sha1 - iterate through the metadata and compute the overall hash of + * the CHD file + * -------------------------------------------------. * - * @param rawsha1 The first rawsha. + * @param rawsha1 The first rawsha. * - * @return The calculated overall sha 1. + * @return The calculated overall sha 1. */ sha1_t chd_file::compute_overall_sha1(sha1_t rawsha1) @@ -1604,17 +1604,17 @@ sha1_t chd_file::compute_overall_sha1(sha1_t rawsha1) } /** - * @fn chd_error chd_file::codec_configure(chd_codec_type codec, int param, void *config) + * @fn chd_error chd_file::codec_configure(chd_codec_type codec, int param, void *config) * - * @brief ------------------------------------------------- - * codec_config - set internal codec parameters - * -------------------------------------------------. + * @brief ------------------------------------------------- + * codec_config - set internal codec parameters + * -------------------------------------------------. * - * @param codec The codec. - * @param param The parameter. - * @param [in,out] config If non-null, the configuration. + * @param codec The codec. + * @param param The parameter. + * @param [in,out] config If non-null, the configuration. * - * @return A chd_error. + * @return A chd_error. */ chd_error chd_file::codec_configure(chd_codec_type codec, int param, void *config) @@ -1640,15 +1640,15 @@ chd_error chd_file::codec_configure(chd_codec_type codec, int param, void *confi } /** - * @fn const char *chd_file::error_string(chd_error err) + * @fn const char *chd_file::error_string(chd_error err) * - * @brief ------------------------------------------------- - * error_string - return an error string for the given CHD error - * -------------------------------------------------. + * @brief ------------------------------------------------- + * error_string - return an error string for the given CHD error + * -------------------------------------------------. * - * @param err The error. + * @param err The error. * - * @return null if it fails, else a char*. + * @return null if it fails, else a char*. */ const char *chd_file::error_string(chd_error err) @@ -1698,14 +1698,14 @@ const char *chd_file::error_string(chd_error err) //************************************************************************** /** - * @fn UINT32 chd_file::guess_unitbytes() + * @fn UINT32 chd_file::guess_unitbytes() * - * @brief ------------------------------------------------- - * guess_unitbytes - for older CHD formats, take a guess at the bytes/unit based on - * metadata - * -------------------------------------------------. + * @brief ------------------------------------------------- + * guess_unitbytes - for older CHD formats, take a guess at the bytes/unit based on + * metadata + * -------------------------------------------------. * - * @return An UINT32. + * @return An UINT32. */ UINT32 chd_file::guess_unitbytes() @@ -1729,19 +1729,19 @@ UINT32 chd_file::guess_unitbytes() } /** - * @fn void chd_file::parse_v3_header(UINT8 *rawheader, sha1_t &parentsha1) + * @fn void chd_file::parse_v3_header(UINT8 *rawheader, sha1_t &parentsha1) * - * @brief ------------------------------------------------- - * parse_v3_header - parse the header from a v3 file and configure core parameters - * -------------------------------------------------. + * @brief ------------------------------------------------- + * parse_v3_header - parse the header from a v3 file and configure core parameters + * -------------------------------------------------. * - * @exception CHDERR_INVALID_FILE Thrown when a chderr invalid file error condition - * occurs. - * @exception CHDERR_UNKNOWN_COMPRESSION Thrown when a chderr unknown compression error - * condition occurs. + * @exception CHDERR_INVALID_FILE Thrown when a chderr invalid file error condition + * occurs. + * @exception CHDERR_UNKNOWN_COMPRESSION Thrown when a chderr unknown compression error + * condition occurs. * - * @param [in,out] rawheader If non-null, the rawheader. - * @param [in,out] parentsha1 The first parentsha. + * @param [in,out] rawheader If non-null, the rawheader. + * @param [in,out] parentsha1 The first parentsha. */ void chd_file::parse_v3_header(UINT8 *rawheader, sha1_t &parentsha1) @@ -1792,19 +1792,19 @@ void chd_file::parse_v3_header(UINT8 *rawheader, sha1_t &parentsha1) } /** - * @fn void chd_file::parse_v4_header(UINT8 *rawheader, sha1_t &parentsha1) + * @fn void chd_file::parse_v4_header(UINT8 *rawheader, sha1_t &parentsha1) * - * @brief ------------------------------------------------- - * parse_v4_header - parse the header from a v4 file and configure core parameters - * -------------------------------------------------. + * @brief ------------------------------------------------- + * parse_v4_header - parse the header from a v4 file and configure core parameters + * -------------------------------------------------. * - * @exception CHDERR_INVALID_FILE Thrown when a chderr invalid file error condition - * occurs. - * @exception CHDERR_UNKNOWN_COMPRESSION Thrown when a chderr unknown compression error - * condition occurs. + * @exception CHDERR_INVALID_FILE Thrown when a chderr invalid file error condition + * occurs. + * @exception CHDERR_UNKNOWN_COMPRESSION Thrown when a chderr unknown compression error + * condition occurs. * - * @param [in,out] rawheader If non-null, the rawheader. - * @param [in,out] parentsha1 The first parentsha. + * @param [in,out] rawheader If non-null, the rawheader. + * @param [in,out] parentsha1 The first parentsha. */ void chd_file::parse_v4_header(UINT8 *rawheader, sha1_t &parentsha1) @@ -1855,16 +1855,16 @@ void chd_file::parse_v4_header(UINT8 *rawheader, sha1_t &parentsha1) } /** - * @fn void chd_file::parse_v5_header(UINT8 *rawheader, sha1_t &parentsha1) + * @fn void chd_file::parse_v5_header(UINT8 *rawheader, sha1_t &parentsha1) * - * @brief ------------------------------------------------- - * parse_v5_header - read the header from a v5 file and configure core parameters - * -------------------------------------------------. + * @brief ------------------------------------------------- + * parse_v5_header - read the header from a v5 file and configure core parameters + * -------------------------------------------------. * - * @exception CHDERR_INVALID_FILE Thrown when a chderr invalid file error condition occurs. + * @exception CHDERR_INVALID_FILE Thrown when a chderr invalid file error condition occurs. * - * @param [in,out] rawheader If non-null, the rawheader. - * @param [in,out] parentsha1 The first parentsha. + * @param [in,out] rawheader If non-null, the rawheader. + * @param [in,out] parentsha1 The first parentsha. */ void chd_file::parse_v5_header(UINT8 *rawheader, sha1_t &parentsha1) @@ -1905,16 +1905,16 @@ void chd_file::parse_v5_header(UINT8 *rawheader, sha1_t &parentsha1) } /** - * @fn chd_error chd_file::compress_v5_map() + * @fn chd_error chd_file::compress_v5_map() * - * @brief ------------------------------------------------- - * compress_v5_map - compress the v5 map and write it to the end of the file - * -------------------------------------------------. + * @brief ------------------------------------------------- + * compress_v5_map - compress the v5 map and write it to the end of the file + * -------------------------------------------------. * - * @exception CHDERR_COMPRESSION_ERROR Thrown when a chderr compression error error - * condition occurs. + * @exception CHDERR_COMPRESSION_ERROR Thrown when a chderr compression error error + * condition occurs. * - * @return A chd_error. + * @return A chd_error. */ chd_error chd_file::compress_v5_map() @@ -2119,14 +2119,14 @@ chd_error chd_file::compress_v5_map() } /** - * @fn void chd_file::decompress_v5_map() + * @fn void chd_file::decompress_v5_map() * - * @brief ------------------------------------------------- - * decompress_v5_map - decompress the v5 map - * -------------------------------------------------. + * @brief ------------------------------------------------- + * decompress_v5_map - decompress the v5 map + * -------------------------------------------------. * - * @exception CHDERR_DECOMPRESSION_ERROR Thrown when a chderr decompression error error - * condition occurs. + * @exception CHDERR_DECOMPRESSION_ERROR Thrown when a chderr decompression error error + * condition occurs. */ void chd_file::decompress_v5_map() @@ -2243,20 +2243,20 @@ void chd_file::decompress_v5_map() } /** - * @fn chd_error chd_file::create_common() + * @fn chd_error chd_file::create_common() * - * @brief ------------------------------------------------- - * create_common - command path when creating a new CHD file - * -------------------------------------------------. + * @brief ------------------------------------------------- + * create_common - command path when creating a new CHD file + * -------------------------------------------------. * - * @exception CHDERR_UNSUPPORTED_VERSION Thrown when a chderr unsupported version error - * condition occurs. - * @exception CHDERR_INVALID_PARAMETER Thrown when a chderr invalid parameter error - * condition occurs. - * @exception CHDERR_UNKNOWN_COMPRESSION Thrown when a chderr unknown compression error - * condition occurs. + * @exception CHDERR_UNSUPPORTED_VERSION Thrown when a chderr unsupported version error + * condition occurs. + * @exception CHDERR_INVALID_PARAMETER Thrown when a chderr invalid parameter error + * condition occurs. + * @exception CHDERR_UNKNOWN_COMPRESSION Thrown when a chderr unknown compression error + * condition occurs. * - * @return The new common. + * @return The new common. */ chd_error chd_file::create_common() @@ -2353,26 +2353,26 @@ chd_error chd_file::create_common() } /** - * @fn chd_error chd_file::open_common(bool writeable) - * - * @brief ------------------------------------------------- - * open_common - common path when opening an existing CHD file for input - * -------------------------------------------------. - * - * @exception CHDERR_INVALID_FILE Thrown when a chderr invalid file error condition - * occurs. - * @exception CHDERR_UNSUPPORTED_VERSION Thrown when a chderr unsupported version error - * condition occurs. - * @exception CHDERR_FILE_NOT_WRITEABLE Thrown when a chderr file not writeable error - * condition occurs. - * @exception CHDERR_INVALID_PARENT Thrown when a chderr invalid parent error condition - * occurs. - * @exception CHDERR_INVALID_PARAMETER Thrown when a chderr invalid parameter error - * condition occurs. - * - * @param writeable true if writeable. - * - * @return A chd_error. + * @fn chd_error chd_file::open_common(bool writeable) + * + * @brief ------------------------------------------------- + * open_common - common path when opening an existing CHD file for input + * -------------------------------------------------. + * + * @exception CHDERR_INVALID_FILE Thrown when a chderr invalid file error condition + * occurs. + * @exception CHDERR_UNSUPPORTED_VERSION Thrown when a chderr unsupported version error + * condition occurs. + * @exception CHDERR_FILE_NOT_WRITEABLE Thrown when a chderr file not writeable error + * condition occurs. + * @exception CHDERR_INVALID_PARENT Thrown when a chderr invalid parent error condition + * occurs. + * @exception CHDERR_INVALID_PARAMETER Thrown when a chderr invalid parameter error + * condition occurs. + * + * @param writeable true if writeable. + * + * @return A chd_error. */ chd_error chd_file::open_common(bool writeable) @@ -2434,14 +2434,14 @@ chd_error chd_file::open_common(bool writeable) } /** - * @fn void chd_file::create_open_common() + * @fn void chd_file::create_open_common() * - * @brief ------------------------------------------------- - * create_open_common - common code for handling creation and opening of a file - * -------------------------------------------------. + * @brief ------------------------------------------------- + * create_open_common - common code for handling creation and opening of a file + * -------------------------------------------------. * - * @exception CHDERR_UNKNOWN_COMPRESSION Thrown when a chderr unknown compression error - * condition occurs. + * @exception CHDERR_UNKNOWN_COMPRESSION Thrown when a chderr unknown compression error + * condition occurs. */ void chd_file::create_open_common() @@ -2467,22 +2467,22 @@ void chd_file::create_open_common() } /** - * @fn void chd_file::verify_proper_compression_append(UINT32 hunknum) - * - * @brief ------------------------------------------------- - * verify_proper_compression_append - verify that the given hunk is a proper candidate - * for appending to a compressed CHD - * -------------------------------------------------. - * - * @exception CHDERR_NOT_OPEN Thrown when a chderr not open error condition occurs. - * @exception CHDERR_HUNK_OUT_OF_RANGE Thrown when a chderr hunk out of range error - * condition occurs. - * @exception CHDERR_FILE_NOT_WRITEABLE Thrown when a chderr file not writeable error - * condition occurs. - * @exception CHDERR_COMPRESSION_ERROR Thrown when a chderr compression error error - * condition occurs. - * - * @param hunknum The hunknum. + * @fn void chd_file::verify_proper_compression_append(UINT32 hunknum) + * + * @brief ------------------------------------------------- + * verify_proper_compression_append - verify that the given hunk is a proper candidate + * for appending to a compressed CHD + * -------------------------------------------------. + * + * @exception CHDERR_NOT_OPEN Thrown when a chderr not open error condition occurs. + * @exception CHDERR_HUNK_OUT_OF_RANGE Thrown when a chderr hunk out of range error + * condition occurs. + * @exception CHDERR_FILE_NOT_WRITEABLE Thrown when a chderr file not writeable error + * condition occurs. + * @exception CHDERR_COMPRESSION_ERROR Thrown when a chderr compression error error + * condition occurs. + * + * @param hunknum The hunknum. */ void chd_file::verify_proper_compression_append(UINT32 hunknum) @@ -2515,18 +2515,18 @@ void chd_file::verify_proper_compression_append(UINT32 hunknum) } /** - * @fn void chd_file::hunk_write_compressed(UINT32 hunknum, INT8 compression, const UINT8 *compressed, UINT32 complength, crc16_t crc16) - * - * @brief ------------------------------------------------- - * hunk_write_compressed - write a hunk to a compressed CHD, discovering the best - * technique - * -------------------------------------------------. - * - * @param hunknum The hunknum. - * @param compression The compression. - * @param compressed The compressed. - * @param complength The complength. - * @param crc16 The CRC 16. + * @fn void chd_file::hunk_write_compressed(UINT32 hunknum, INT8 compression, const UINT8 *compressed, UINT32 complength, crc16_t crc16) + * + * @brief ------------------------------------------------- + * hunk_write_compressed - write a hunk to a compressed CHD, discovering the best + * technique + * -------------------------------------------------. + * + * @param hunknum The hunknum. + * @param compression The compression. + * @param compressed The compressed. + * @param complength The complength. + * @param crc16 The CRC 16. */ void chd_file::hunk_write_compressed(UINT32 hunknum, INT8 compression, const UINT8 *compressed, UINT32 complength, crc16_t crc16) @@ -2546,17 +2546,17 @@ void chd_file::hunk_write_compressed(UINT32 hunknum, INT8 compression, const UIN } /** - * @fn void chd_file::hunk_copy_from_self(UINT32 hunknum, UINT32 otherhunk) + * @fn void chd_file::hunk_copy_from_self(UINT32 hunknum, UINT32 otherhunk) * - * @brief ------------------------------------------------- - * hunk_copy_from_self - mark a hunk as being a copy of another hunk in the same CHD - * -------------------------------------------------. + * @brief ------------------------------------------------- + * hunk_copy_from_self - mark a hunk as being a copy of another hunk in the same CHD + * -------------------------------------------------. * - * @exception CHDERR_INVALID_PARAMETER Thrown when a chderr invalid parameter error - * condition occurs. + * @exception CHDERR_INVALID_PARAMETER Thrown when a chderr invalid parameter error + * condition occurs. * - * @param hunknum The hunknum. - * @param otherhunk The otherhunk. + * @param hunknum The hunknum. + * @param otherhunk The otherhunk. */ void chd_file::hunk_copy_from_self(UINT32 hunknum, UINT32 otherhunk) @@ -2577,14 +2577,14 @@ void chd_file::hunk_copy_from_self(UINT32 hunknum, UINT32 otherhunk) } /** - * @fn void chd_file::hunk_copy_from_parent(UINT32 hunknum, UINT64 parentunit) + * @fn void chd_file::hunk_copy_from_parent(UINT32 hunknum, UINT64 parentunit) * - * @brief ------------------------------------------------- - * hunk_copy_from_parent - mark a hunk as being a copy of a hunk from a parent CHD - * -------------------------------------------------. + * @brief ------------------------------------------------- + * hunk_copy_from_parent - mark a hunk as being a copy of a hunk from a parent CHD + * -------------------------------------------------. * - * @param hunknum The hunknum. - * @param parentunit The parentunit. + * @param hunknum The hunknum. + * @param parentunit The parentunit. */ void chd_file::hunk_copy_from_parent(UINT32 hunknum, UINT64 parentunit) @@ -2601,18 +2601,18 @@ void chd_file::hunk_copy_from_parent(UINT32 hunknum, UINT64 parentunit) } /** - * @fn bool chd_file::metadata_find(chd_metadata_tag metatag, INT32 metaindex, metadata_entry &metaentry, bool resume) + * @fn bool chd_file::metadata_find(chd_metadata_tag metatag, INT32 metaindex, metadata_entry &metaentry, bool resume) * - * @brief ------------------------------------------------- - * metadata_find - find a metadata entry - * -------------------------------------------------. + * @brief ------------------------------------------------- + * metadata_find - find a metadata entry + * -------------------------------------------------. * - * @param metatag The metatag. - * @param metaindex The metaindex. - * @param [in,out] metaentry The metaentry. - * @param resume true to resume. + * @param metatag The metatag. + * @param metaindex The metaindex. + * @param [in,out] metaentry The metaentry. + * @param resume true to resume. * - * @return true if it succeeds, false if it fails. + * @return true if it succeeds, false if it fails. */ bool chd_file::metadata_find(chd_metadata_tag metatag, INT32 metaindex, metadata_entry &metaentry, bool resume) @@ -2657,14 +2657,14 @@ bool chd_file::metadata_find(chd_metadata_tag metatag, INT32 metaindex, metadata } /** - * @fn void chd_file::metadata_set_previous_next(UINT64 prevoffset, UINT64 nextoffset) + * @fn void chd_file::metadata_set_previous_next(UINT64 prevoffset, UINT64 nextoffset) * - * @brief ------------------------------------------------- - * metadata_set_previous_next - set the 'next' offset of a piece of metadata - * -------------------------------------------------. + * @brief ------------------------------------------------- + * metadata_set_previous_next - set the 'next' offset of a piece of metadata + * -------------------------------------------------. * - * @param prevoffset The prevoffset. - * @param nextoffset The nextoffset. + * @param prevoffset The prevoffset. + * @param nextoffset The nextoffset. */ void chd_file::metadata_set_previous_next(UINT64 prevoffset, UINT64 nextoffset) @@ -2691,11 +2691,11 @@ void chd_file::metadata_set_previous_next(UINT64 prevoffset, UINT64 nextoffset) } /** - * @fn void chd_file::metadata_update_hash() + * @fn void chd_file::metadata_update_hash() * - * @brief ------------------------------------------------- - * metadata_update_hash - compute the SHA1 hash of all metadata that requests it - * -------------------------------------------------. + * @brief ------------------------------------------------- + * metadata_update_hash - compute the SHA1 hash of all metadata that requests it + * -------------------------------------------------. */ void chd_file::metadata_update_hash() @@ -2716,16 +2716,16 @@ void chd_file::metadata_update_hash() } /** - * @fn int CLIB_DECL chd_file::metadata_hash_compare(const void *elem1, const void *elem2) + * @fn int CLIB_DECL chd_file::metadata_hash_compare(const void *elem1, const void *elem2) * - * @brief ------------------------------------------------- - * metadata_hash_compare - compare two hash entries - * -------------------------------------------------. + * @brief ------------------------------------------------- + * metadata_hash_compare - compare two hash entries + * -------------------------------------------------. * - * @param elem1 The first element. - * @param elem2 The second element. + * @param elem1 The first element. + * @param elem2 The second element. * - * @return A CLIB_DECL. + * @return A CLIB_DECL. */ int CLIB_DECL chd_file::metadata_hash_compare(const void *elem1, const void *elem2) @@ -2740,11 +2740,11 @@ int CLIB_DECL chd_file::metadata_hash_compare(const void *elem1, const void *ele //************************************************************************** /** - * @fn chd_file_compressor::chd_file_compressor() + * @fn chd_file_compressor::chd_file_compressor() * - * @brief ------------------------------------------------- - * chd_file_compressor - constructor - * -------------------------------------------------. + * @brief ------------------------------------------------- + * chd_file_compressor - constructor + * -------------------------------------------------. */ chd_file_compressor::chd_file_compressor() @@ -2767,11 +2767,11 @@ chd_file_compressor::chd_file_compressor() } /** - * @fn chd_file_compressor::~chd_file_compressor() + * @fn chd_file_compressor::~chd_file_compressor() * - * @brief ------------------------------------------------- - * ~chd_file_compressor - destructor - * -------------------------------------------------. + * @brief ------------------------------------------------- + * ~chd_file_compressor - destructor + * -------------------------------------------------. */ chd_file_compressor::~chd_file_compressor() @@ -2786,11 +2786,11 @@ chd_file_compressor::~chd_file_compressor() } /** - * @fn void chd_file_compressor::compress_begin() + * @fn void chd_file_compressor::compress_begin() * - * @brief ------------------------------------------------- - * compress_begin - initiate compression - * -------------------------------------------------. + * @brief ------------------------------------------------- + * compress_begin - initiate compression + * -------------------------------------------------. */ void chd_file_compressor::compress_begin() @@ -2835,16 +2835,16 @@ void chd_file_compressor::compress_begin() } /** - * @fn chd_error chd_file_compressor::compress_continue(double &progress, double &ratio) + * @fn chd_error chd_file_compressor::compress_continue(double &progress, double &ratio) * - * @brief ------------------------------------------------- - * compress_continue - continue compression - * -------------------------------------------------. + * @brief ------------------------------------------------- + * compress_continue - continue compression + * -------------------------------------------------. * - * @param [in,out] progress The progress. - * @param [in,out] ratio The ratio. + * @param [in,out] progress The progress. + * @param [in,out] ratio The ratio. * - * @return A chd_error. + * @return A chd_error. */ chd_error chd_file_compressor::compress_continue(double &progress, double &ratio) @@ -2989,16 +2989,16 @@ chd_error chd_file_compressor::compress_continue(double &progress, double &ratio } /** - * @fn void *chd_file_compressor::async_walk_parent_static(void *param, int threadid) + * @fn void *chd_file_compressor::async_walk_parent_static(void *param, int threadid) * - * @brief ------------------------------------------------- - * async_walk_parent - handle asynchronous parent walking operations - * -------------------------------------------------. + * @brief ------------------------------------------------- + * async_walk_parent - handle asynchronous parent walking operations + * -------------------------------------------------. * - * @param [in,out] param If non-null, the parameter. - * @param threadid The threadid. + * @param [in,out] param If non-null, the parameter. + * @param threadid The threadid. * - * @return null if it fails, else a void*. + * @return null if it fails, else a void*. */ void *chd_file_compressor::async_walk_parent_static(void *param, int threadid) @@ -3009,11 +3009,11 @@ void *chd_file_compressor::async_walk_parent_static(void *param, int threadid) } /** - * @fn void chd_file_compressor::async_walk_parent(work_item &item) + * @fn void chd_file_compressor::async_walk_parent(work_item &item) * - * @brief Asynchronous walk parent. + * @brief Asynchronous walk parent. * - * @param [in,out] item The item. + * @param [in,out] item The item. */ void chd_file_compressor::async_walk_parent(work_item &item) @@ -3031,16 +3031,16 @@ void chd_file_compressor::async_walk_parent(work_item &item) } /** - * @fn void *chd_file_compressor::async_compress_hunk_static(void *param, int threadid) + * @fn void *chd_file_compressor::async_compress_hunk_static(void *param, int threadid) * - * @brief ------------------------------------------------- - * async_compress_hunk - handle asynchronous hunk compression - * -------------------------------------------------. + * @brief ------------------------------------------------- + * async_compress_hunk - handle asynchronous hunk compression + * -------------------------------------------------. * - * @param [in,out] param If non-null, the parameter. - * @param threadid The threadid. + * @param [in,out] param If non-null, the parameter. + * @param threadid The threadid. * - * @return null if it fails, else a void*. + * @return null if it fails, else a void*. */ void *chd_file_compressor::async_compress_hunk_static(void *param, int threadid) @@ -3051,12 +3051,12 @@ void *chd_file_compressor::async_compress_hunk_static(void *param, int threadid) } /** - * @fn void chd_file_compressor::async_compress_hunk(work_item &item, int threadid) + * @fn void chd_file_compressor::async_compress_hunk(work_item &item, int threadid) * - * @brief Asynchronous compress hunk. + * @brief Asynchronous compress hunk. * - * @param [in,out] item The item. - * @param threadid The threadid. + * @param [in,out] item The item. + * @param threadid The threadid. */ void chd_file_compressor::async_compress_hunk(work_item &item, int threadid) @@ -3081,16 +3081,16 @@ void chd_file_compressor::async_compress_hunk(work_item &item, int threadid) } /** - * @fn void *chd_file_compressor::async_read_static(void *param, int threadid) + * @fn void *chd_file_compressor::async_read_static(void *param, int threadid) * - * @brief ------------------------------------------------- - * async_read - handle asynchronous source file reading - * -------------------------------------------------. + * @brief ------------------------------------------------- + * async_read - handle asynchronous source file reading + * -------------------------------------------------. * - * @param [in,out] param If non-null, the parameter. - * @param threadid The threadid. + * @param [in,out] param If non-null, the parameter. + * @param threadid The threadid. * - * @return null if it fails, else a void*. + * @return null if it fails, else a void*. */ void *chd_file_compressor::async_read_static(void *param, int threadid) @@ -3100,9 +3100,9 @@ void *chd_file_compressor::async_read_static(void *param, int threadid) } /** - * @fn void chd_file_compressor::async_read() + * @fn void chd_file_compressor::async_read() * - * @brief Asynchronous read. + * @brief Asynchronous read. */ void chd_file_compressor::async_read() @@ -3181,11 +3181,11 @@ void chd_file_compressor::async_read() //************************************************************************** /** - * @fn chd_file_compressor::hashmap::hashmap() + * @fn chd_file_compressor::hashmap::hashmap() * - * @brief ------------------------------------------------- - * hashmap - constructor - * -------------------------------------------------. + * @brief ------------------------------------------------- + * hashmap - constructor + * -------------------------------------------------. */ chd_file_compressor::hashmap::hashmap() @@ -3196,11 +3196,11 @@ chd_file_compressor::hashmap::hashmap() } /** - * @fn chd_file_compressor::hashmap::~hashmap() + * @fn chd_file_compressor::hashmap::~hashmap() * - * @brief ------------------------------------------------- - * ~hashmap - destructor - * -------------------------------------------------. + * @brief ------------------------------------------------- + * ~hashmap - destructor + * -------------------------------------------------. */ chd_file_compressor::hashmap::~hashmap() @@ -3210,11 +3210,11 @@ chd_file_compressor::hashmap::~hashmap() } /** - * @fn void chd_file_compressor::hashmap::reset() + * @fn void chd_file_compressor::hashmap::reset() * - * @brief ------------------------------------------------- - * reset - reset the state of the map - * -------------------------------------------------. + * @brief ------------------------------------------------- + * reset - reset the state of the map + * -------------------------------------------------. */ void chd_file_compressor::hashmap::reset() @@ -3233,16 +3233,16 @@ void chd_file_compressor::hashmap::reset() } /** - * @fn UINT64 chd_file_compressor::hashmap::find(crc16_t crc16, sha1_t sha1) + * @fn UINT64 chd_file_compressor::hashmap::find(crc16_t crc16, sha1_t sha1) * - * @brief ------------------------------------------------- - * find - find an item in the CRC map - * -------------------------------------------------. + * @brief ------------------------------------------------- + * find - find an item in the CRC map + * -------------------------------------------------. * - * @param crc16 The CRC 16. - * @param sha1 The first sha. + * @param crc16 The CRC 16. + * @param sha1 The first sha. * - * @return An UINT64. + * @return An UINT64. */ UINT64 chd_file_compressor::hashmap::find(crc16_t crc16, sha1_t sha1) @@ -3255,15 +3255,15 @@ UINT64 chd_file_compressor::hashmap::find(crc16_t crc16, sha1_t sha1) } /** - * @fn void chd_file_compressor::hashmap::add(UINT64 itemnum, crc16_t crc16, sha1_t sha1) + * @fn void chd_file_compressor::hashmap::add(UINT64 itemnum, crc16_t crc16, sha1_t sha1) * - * @brief ------------------------------------------------- - * add - add an item to the CRC map - * -------------------------------------------------. + * @brief ------------------------------------------------- + * add - add an item to the CRC map + * -------------------------------------------------. * - * @param itemnum The itemnum. - * @param crc16 The CRC 16. - * @param sha1 The first sha. + * @param itemnum The itemnum. + * @param crc16 The CRC 16. + * @param sha1 The first sha. */ void chd_file_compressor::hashmap::add(UINT64 itemnum, crc16_t crc16, sha1_t sha1) diff --git a/src/lib/util/chdcd.c b/src/lib/util/chdcd.c index d55b83f5a82..e267c613d1d 100644 --- a/src/lib/util/chdcd.c +++ b/src/lib/util/chdcd.c @@ -22,15 +22,15 @@ ***************************************************************************/ /** - * @def TOKENIZE(); + * @def TOKENIZE(); * - * @brief A macro that defines tokenize. + * @brief A macro that defines tokenize. * - * @param linebuffer The linebuffer. - * @param i Zero-based index of the. - * @param sizeof(linebuffer) The sizeof(linebuffer) - * @param token The token. - * @param sizeof(token) The sizeof(token) + * @param linebuffer The linebuffer. + * @param i Zero-based index of the. + * @param sizeof(linebuffer) The sizeof(linebuffer) + * @param token The token. + * @param sizeof(token) The sizeof(token) */ #define TOKENIZE i = tokenize( linebuffer, i, sizeof(linebuffer), token, sizeof(token) ); @@ -41,7 +41,7 @@ GLOBAL VARIABLES ***************************************************************************/ -/** @brief The linebuffer[ 512]. */ +/** @brief The linebuffer[ 512]. */ static char linebuffer[512]; @@ -51,13 +51,13 @@ static char linebuffer[512]; ***************************************************************************/ /** - * @fn static std::string get_file_path(std::string &path) + * @fn static std::string get_file_path(std::string &path) * - * @brief Gets file path. + * @brief Gets file path. * - * @param [in,out] path Full pathname of the file. + * @param [in,out] path Full pathname of the file. * - * @return The file path. + * @return The file path. */ static std::string get_file_path(std::string &path) @@ -76,13 +76,13 @@ static std::string get_file_path(std::string &path) -------------------------------------------------*/ /** - * @fn static UINT64 get_file_size(const char *filename) + * @fn static UINT64 get_file_size(const char *filename) * - * @brief Gets file size. + * @brief Gets file size. * - * @param filename Filename of the file. + * @param filename Filename of the file. * - * @return The file size. + * @return The file size. */ static UINT64 get_file_size(const char *filename) @@ -104,17 +104,17 @@ static UINT64 get_file_size(const char *filename) -------------------------------------------------*/ /** - * @fn static int tokenize( const char *linebuffer, int i, int linebuffersize, char *token, int tokensize ) + * @fn static int tokenize( const char *linebuffer, int i, int linebuffersize, char *token, int tokensize ) * - * @brief Tokenizes. + * @brief Tokenizes. * - * @param linebuffer The linebuffer. - * @param i Zero-based index of the. - * @param linebuffersize The linebuffersize. - * @param [in,out] token If non-null, the token. - * @param tokensize The tokensize. + * @param linebuffer The linebuffer. + * @param i Zero-based index of the. + * @param linebuffersize The linebuffersize. + * @param [in,out] token If non-null, the token. + * @param tokensize The tokensize. * - * @return An int. + * @return An int. */ static int tokenize( const char *linebuffer, int i, int linebuffersize, char *token, int tokensize ) @@ -162,13 +162,13 @@ static int tokenize( const char *linebuffer, int i, int linebuffersize, char *to -------------------------------------------------*/ /** - * @fn static int msf_to_frames( char *token ) + * @fn static int msf_to_frames( char *token ) * - * @brief Msf to frames. + * @brief Msf to frames. * - * @param [in,out] token If non-null, the token. + * @param [in,out] token If non-null, the token. * - * @return An int. + * @return An int. */ static int msf_to_frames( char *token ) @@ -199,14 +199,14 @@ static int msf_to_frames( char *token ) -------------------------------------------------*/ /** - * @fn static UINT32 parse_wav_sample(const char *filename, UINT32 *dataoffs) + * @fn static UINT32 parse_wav_sample(const char *filename, UINT32 *dataoffs) * - * @brief Parse WAV sample. + * @brief Parse WAV sample. * - * @param filename Filename of the file. - * @param [in,out] dataoffs If non-null, the dataoffs. + * @param filename Filename of the file. + * @param [in,out] dataoffs If non-null, the dataoffs. * - * @return An UINT32. + * @return An UINT32. */ static UINT32 parse_wav_sample(const char *filename, UINT32 *dataoffs) @@ -378,13 +378,13 @@ static UINT32 parse_wav_sample(const char *filename, UINT32 *dataoffs) } /** - * @fn UINT16 read_uint16(FILE *infile) + * @fn UINT16 read_uint16(FILE *infile) * - * @brief Reads uint 16. + * @brief Reads uint 16. * - * @param [in,out] infile If non-null, the infile. + * @param [in,out] infile If non-null, the infile. * - * @return The uint 16. + * @return The uint 16. */ UINT16 read_uint16(FILE *infile) @@ -400,13 +400,13 @@ UINT16 read_uint16(FILE *infile) } /** - * @fn UINT32 read_uint32(FILE *infile) + * @fn UINT32 read_uint32(FILE *infile) * - * @brief Reads uint 32. + * @brief Reads uint 32. * - * @param [in,out] infile If non-null, the infile. + * @param [in,out] infile If non-null, the infile. * - * @return The uint 32. + * @return The uint 32. */ UINT32 read_uint32(FILE *infile) @@ -422,13 +422,13 @@ UINT32 read_uint32(FILE *infile) } /** - * @fn UINT64 read_uint64(FILE *infile) + * @fn UINT64 read_uint64(FILE *infile) * - * @brief Reads uint 64. + * @brief Reads uint 64. * - * @param [in,out] infile If non-null, the infile. + * @param [in,out] infile If non-null, the infile. * - * @return The uint 64. + * @return The uint 64. */ UINT64 read_uint64(FILE *infile) @@ -452,15 +452,15 @@ UINT64 read_uint64(FILE *infile) -------------------------------------------------*/ /** - * @fn chd_error chdcd_parse_nero(const char *tocfname, cdrom_toc &outtoc, chdcd_track_input_info &outinfo) + * @fn chd_error chdcd_parse_nero(const char *tocfname, cdrom_toc &outtoc, chdcd_track_input_info &outinfo) * - * @brief Chdcd parse nero. + * @brief Chdcd parse nero. * - * @param tocfname The tocfname. - * @param [in,out] outtoc The outtoc. - * @param [in,out] outinfo The outinfo. + * @param tocfname The tocfname. + * @param [in,out] outtoc The outtoc. + * @param [in,out] outinfo The outinfo. * - * @return A chd_error. + * @return A chd_error. */ chd_error chdcd_parse_nero(const char *tocfname, cdrom_toc &outtoc, chdcd_track_input_info &outinfo) @@ -638,15 +638,15 @@ chd_error chdcd_parse_nero(const char *tocfname, cdrom_toc &outtoc, chdcd_track_ -------------------------------------------------*/ /** - * @fn chd_error chdcd_parse_iso(const char *tocfname, cdrom_toc &outtoc, chdcd_track_input_info &outinfo) + * @fn chd_error chdcd_parse_iso(const char *tocfname, cdrom_toc &outtoc, chdcd_track_input_info &outinfo) * - * @brief Chdcd parse ISO. + * @brief Chdcd parse ISO. * - * @param tocfname The tocfname. - * @param [in,out] outtoc The outtoc. - * @param [in,out] outinfo The outinfo. + * @param tocfname The tocfname. + * @param [in,out] outtoc The outtoc. + * @param [in,out] outinfo The outinfo. * - * @return A chd_error. + * @return A chd_error. */ chd_error chdcd_parse_iso(const char *tocfname, cdrom_toc &outtoc, chdcd_track_input_info &outinfo) @@ -715,15 +715,15 @@ chd_error chdcd_parse_iso(const char *tocfname, cdrom_toc &outtoc, chdcd_track_i -------------------------------------------------*/ /** - * @fn static chd_error chdcd_parse_gdi(const char *tocfname, cdrom_toc &outtoc, chdcd_track_input_info &outinfo) + * @fn static chd_error chdcd_parse_gdi(const char *tocfname, cdrom_toc &outtoc, chdcd_track_input_info &outinfo) * - * @brief Chdcd parse GDI. + * @brief Chdcd parse GDI. * - * @param tocfname The tocfname. - * @param [in,out] outtoc The outtoc. - * @param [in,out] outinfo The outinfo. + * @param tocfname The tocfname. + * @param [in,out] outtoc The outtoc. + * @param [in,out] outinfo The outinfo. * - * @return A chd_error. + * @return A chd_error. */ static chd_error chdcd_parse_gdi(const char *tocfname, cdrom_toc &outtoc, chdcd_track_input_info &outinfo) @@ -847,15 +847,15 @@ static chd_error chdcd_parse_gdi(const char *tocfname, cdrom_toc &outtoc, chdcd_ -------------------------------------------------*/ /** - * @fn chd_error chdcd_parse_cue(const char *tocfname, cdrom_toc &outtoc, chdcd_track_input_info &outinfo) + * @fn chd_error chdcd_parse_cue(const char *tocfname, cdrom_toc &outtoc, chdcd_track_input_info &outinfo) * - * @brief Chdcd parse cue. + * @brief Chdcd parse cue. * - * @param tocfname The tocfname. - * @param [in,out] outtoc The outtoc. - * @param [in,out] outinfo The outinfo. + * @param tocfname The tocfname. + * @param [in,out] outtoc The outtoc. + * @param [in,out] outinfo The outinfo. * - * @return A chd_error. + * @return A chd_error. */ chd_error chdcd_parse_cue(const char *tocfname, cdrom_toc &outtoc, chdcd_track_input_info &outinfo) @@ -1142,15 +1142,15 @@ chd_error chdcd_parse_cue(const char *tocfname, cdrom_toc &outtoc, chdcd_track_i -------------------------------------------------*/ /** - * @fn chd_error chdcd_parse_toc(const char *tocfname, cdrom_toc &outtoc, chdcd_track_input_info &outinfo) + * @fn chd_error chdcd_parse_toc(const char *tocfname, cdrom_toc &outtoc, chdcd_track_input_info &outinfo) * - * @brief Chdcd parse TOC. + * @brief Chdcd parse TOC. * - * @param tocfname The tocfname. - * @param [in,out] outtoc The outtoc. - * @param [in,out] outinfo The outinfo. + * @param tocfname The tocfname. + * @param [in,out] outtoc The outtoc. + * @param [in,out] outinfo The outinfo. * - * @return A chd_error. + * @return A chd_error. */ chd_error chdcd_parse_toc(const char *tocfname, cdrom_toc &outtoc, chdcd_track_input_info &outinfo) diff --git a/src/lib/util/chdcodec.c b/src/lib/util/chdcodec.c index 753ce852dd3..9f013609133 100644 --- a/src/lib/util/chdcodec.c +++ b/src/lib/util/chdcodec.c @@ -1454,15 +1454,15 @@ UINT32 chd_cd_flac_compressor::compress(const UINT8 *src, UINT32 srclen, UINT8 * } /** - * @fn UINT32 chd_cd_flac_compressor::blocksize(UINT32 bytes) + * @fn UINT32 chd_cd_flac_compressor::blocksize(UINT32 bytes) * - * @brief ------------------------------------------------- - * blocksize - return the optimal block size - * -------------------------------------------------. + * @brief ------------------------------------------------- + * blocksize - return the optimal block size + * -------------------------------------------------. * - * @param bytes The bytes. + * @param bytes The bytes. * - * @return An UINT32. + * @return An UINT32. */ UINT32 chd_cd_flac_compressor::blocksize(UINT32 bytes) @@ -1481,17 +1481,17 @@ UINT32 chd_cd_flac_compressor::blocksize(UINT32 bytes) //************************************************************************** /** - * @fn chd_cd_flac_decompressor::chd_cd_flac_decompressor(chd_file &chd, UINT32 hunkbytes, bool lossy) + * @fn chd_cd_flac_decompressor::chd_cd_flac_decompressor(chd_file &chd, UINT32 hunkbytes, bool lossy) * - * @brief ------------------------------------------------- - * chd_cd_flac_decompressor - constructor - * -------------------------------------------------. + * @brief ------------------------------------------------- + * chd_cd_flac_decompressor - constructor + * -------------------------------------------------. * - * @exception CHDERR_CODEC_ERROR Thrown when a chderr codec error error condition occurs. + * @exception CHDERR_CODEC_ERROR Thrown when a chderr codec error error condition occurs. * - * @param [in,out] chd The chd. - * @param hunkbytes The hunkbytes. - * @param lossy true to lossy. + * @param [in,out] chd The chd. + * @param hunkbytes The hunkbytes. + * @param lossy true to lossy. */ chd_cd_flac_decompressor::chd_cd_flac_decompressor(chd_file &chd, UINT32 hunkbytes, bool lossy) @@ -1521,11 +1521,11 @@ chd_cd_flac_decompressor::chd_cd_flac_decompressor(chd_file &chd, UINT32 hunkbyt } /** - * @fn chd_cd_flac_decompressor::~chd_cd_flac_decompressor() + * @fn chd_cd_flac_decompressor::~chd_cd_flac_decompressor() * - * @brief ------------------------------------------------- - * ~chd_cd_flac_decompressor - destructor - * -------------------------------------------------. + * @brief ------------------------------------------------- + * ~chd_cd_flac_decompressor - destructor + * -------------------------------------------------. */ chd_cd_flac_decompressor::~chd_cd_flac_decompressor() @@ -1534,19 +1534,19 @@ chd_cd_flac_decompressor::~chd_cd_flac_decompressor() } /** - * @fn void chd_cd_flac_decompressor::decompress(const UINT8 *src, UINT32 complen, UINT8 *dest, UINT32 destlen) + * @fn void chd_cd_flac_decompressor::decompress(const UINT8 *src, UINT32 complen, UINT8 *dest, UINT32 destlen) * - * @brief ------------------------------------------------- - * decompress - decompress data using the FLAC codec - * -------------------------------------------------. + * @brief ------------------------------------------------- + * decompress - decompress data using the FLAC codec + * -------------------------------------------------. * - * @exception CHDERR_DECOMPRESSION_ERROR Thrown when a chderr decompression error error - * condition occurs. + * @exception CHDERR_DECOMPRESSION_ERROR Thrown when a chderr decompression error error + * condition occurs. * - * @param src Source for the. - * @param complen The complen. - * @param [in,out] dest If non-null, destination for the. - * @param destlen The destlen. + * @param src Source for the. + * @param complen The complen. + * @param [in,out] dest If non-null, destination for the. + * @param destlen The destlen. */ void chd_cd_flac_decompressor::decompress(const UINT8 *src, UINT32 complen, UINT8 *dest, UINT32 destlen) @@ -1593,15 +1593,15 @@ void chd_cd_flac_decompressor::decompress(const UINT8 *src, UINT32 complen, UINT //************************************************************************** /** - * @fn chd_avhuff_compressor::chd_avhuff_compressor(chd_file &chd, UINT32 hunkbytes, bool lossy) + * @fn chd_avhuff_compressor::chd_avhuff_compressor(chd_file &chd, UINT32 hunkbytes, bool lossy) * - * @brief ------------------------------------------------- - * chd_avhuff_compressor - constructor - * -------------------------------------------------. + * @brief ------------------------------------------------- + * chd_avhuff_compressor - constructor + * -------------------------------------------------. * - * @param [in,out] chd The chd. - * @param hunkbytes The hunkbytes. - * @param lossy true to lossy. + * @param [in,out] chd The chd. + * @param hunkbytes The hunkbytes. + * @param lossy true to lossy. */ chd_avhuff_compressor::chd_avhuff_compressor(chd_file &chd, UINT32 hunkbytes, bool lossy) @@ -1620,22 +1620,22 @@ chd_avhuff_compressor::chd_avhuff_compressor(chd_file &chd, UINT32 hunkbytes, bo } /** - * @fn UINT32 chd_avhuff_compressor::compress(const UINT8 *src, UINT32 srclen, UINT8 *dest) + * @fn UINT32 chd_avhuff_compressor::compress(const UINT8 *src, UINT32 srclen, UINT8 *dest) * - * @brief ------------------------------------------------- - * compress - compress data using the A/V codec - * -------------------------------------------------. + * @brief ------------------------------------------------- + * compress - compress data using the A/V codec + * -------------------------------------------------. * - * @exception CHDERR_INVALID_DATA Thrown when a chderr invalid data error condition - * occurs. - * @exception CHDERR_COMPRESSION_ERROR Thrown when a chderr compression error error - * condition occurs. + * @exception CHDERR_INVALID_DATA Thrown when a chderr invalid data error condition + * occurs. + * @exception CHDERR_COMPRESSION_ERROR Thrown when a chderr compression error error + * condition occurs. * - * @param src Source for the. - * @param srclen The srclen. - * @param [in,out] dest If non-null, destination for the. + * @param src Source for the. + * @param srclen The srclen. + * @param [in,out] dest If non-null, destination for the. * - * @return An UINT32. + * @return An UINT32. */ UINT32 chd_avhuff_compressor::compress(const UINT8 *src, UINT32 srclen, UINT8 *dest) @@ -1662,16 +1662,16 @@ UINT32 chd_avhuff_compressor::compress(const UINT8 *src, UINT32 srclen, UINT8 *d } /** - * @fn void chd_avhuff_compressor::postinit() + * @fn void chd_avhuff_compressor::postinit() * - * @brief ------------------------------------------------- - * postinit - actual initialization of avhuff happens here, on the first attempt to - * compress or decompress data - * -------------------------------------------------. + * @brief ------------------------------------------------- + * postinit - actual initialization of avhuff happens here, on the first attempt to + * compress or decompress data + * -------------------------------------------------. * - * @exception err Thrown when an error error condition occurs. - * @exception CHDERR_INVALID_METADATA Thrown when a chderr invalid metadata error condition - * occurs. + * @exception err Thrown when an error error condition occurs. + * @exception CHDERR_INVALID_METADATA Thrown when a chderr invalid metadata error condition + * occurs. */ void chd_avhuff_compressor::postinit() @@ -1705,15 +1705,15 @@ void chd_avhuff_compressor::postinit() //************************************************************************** /** - * @fn chd_avhuff_decompressor::chd_avhuff_decompressor(chd_file &chd, UINT32 hunkbytes, bool lossy) + * @fn chd_avhuff_decompressor::chd_avhuff_decompressor(chd_file &chd, UINT32 hunkbytes, bool lossy) * - * @brief ------------------------------------------------- - * chd_avhuff_decompressor - constructor - * -------------------------------------------------. + * @brief ------------------------------------------------- + * chd_avhuff_decompressor - constructor + * -------------------------------------------------. * - * @param [in,out] chd The chd. - * @param hunkbytes The hunkbytes. - * @param lossy true to lossy. + * @param [in,out] chd The chd. + * @param hunkbytes The hunkbytes. + * @param lossy true to lossy. */ chd_avhuff_decompressor::chd_avhuff_decompressor(chd_file &chd, UINT32 hunkbytes, bool lossy) @@ -1722,19 +1722,19 @@ chd_avhuff_decompressor::chd_avhuff_decompressor(chd_file &chd, UINT32 hunkbytes } /** - * @fn void chd_avhuff_decompressor::decompress(const UINT8 *src, UINT32 complen, UINT8 *dest, UINT32 destlen) + * @fn void chd_avhuff_decompressor::decompress(const UINT8 *src, UINT32 complen, UINT8 *dest, UINT32 destlen) * - * @brief ------------------------------------------------- - * decompress - decompress data using the A/V codec - * -------------------------------------------------. + * @brief ------------------------------------------------- + * decompress - decompress data using the A/V codec + * -------------------------------------------------. * - * @exception CHDERR_DECOMPRESSION_ERROR Thrown when a chderr decompression error error - * condition occurs. + * @exception CHDERR_DECOMPRESSION_ERROR Thrown when a chderr decompression error error + * condition occurs. * - * @param src Source for the. - * @param complen The complen. - * @param [in,out] dest If non-null, destination for the. - * @param destlen The destlen. + * @param src Source for the. + * @param complen The complen. + * @param [in,out] dest If non-null, destination for the. + * @param destlen The destlen. */ void chd_avhuff_decompressor::decompress(const UINT8 *src, UINT32 complen, UINT8 *dest, UINT32 destlen) @@ -1754,17 +1754,17 @@ void chd_avhuff_decompressor::decompress(const UINT8 *src, UINT32 complen, UINT8 } /** - * @fn void chd_avhuff_decompressor::configure(int param, void *config) + * @fn void chd_avhuff_decompressor::configure(int param, void *config) * - * @brief ------------------------------------------------- - * config - codec-specific configuration for the A/V codec - * -------------------------------------------------. + * @brief ------------------------------------------------- + * config - codec-specific configuration for the A/V codec + * -------------------------------------------------. * - * @exception CHDERR_INVALID_PARAMETER Thrown when a chderr invalid parameter error - * condition occurs. + * @exception CHDERR_INVALID_PARAMETER Thrown when a chderr invalid parameter error + * condition occurs. * - * @param param The parameter. - * @param [in,out] config If non-null, the configuration. + * @param param The parameter. + * @param [in,out] config If non-null, the configuration. */ void chd_avhuff_decompressor::configure(int param, void *config) diff --git a/src/lib/util/corealloc.c b/src/lib/util/corealloc.c index 40d7456546a..a635803e463 100644 --- a/src/lib/util/corealloc.c +++ b/src/lib/util/corealloc.c @@ -395,13 +395,13 @@ void memory_entry::release(memory_entry *entry, const char *file, int line) } /** - * @fn void memory_entry::report_unfreed(UINT64 start) + * @fn void memory_entry::report_unfreed(UINT64 start) * - * @brief ------------------------------------------------- - * report_unfreed - print a list of unfreed memory to the target file - * -------------------------------------------------. + * @brief ------------------------------------------------- + * report_unfreed - print a list of unfreed memory to the target file + * -------------------------------------------------. * - * @param start The start. + * @param start The start. */ void memory_entry::report_unfreed(UINT64 start) diff --git a/src/lib/util/corefile.c b/src/lib/util/corefile.c index 30639615a58..797805ac768 100644 --- a/src/lib/util/corefile.c +++ b/src/lib/util/corefile.c @@ -1029,17 +1029,17 @@ static file_error osd_or_zlib_read(core_file *file, void *buffer, UINT64 offset, -------------------------------------------------*/ /** - * @fn static file_error osd_or_zlib_write(core_file *file, const void *buffer, UINT64 offset, UINT32 length, UINT32 *actual) + * @fn static file_error osd_or_zlib_write(core_file *file, const void *buffer, UINT64 offset, UINT32 length, UINT32 *actual) * - * @brief OSD or zlib write. + * @brief OSD or zlib write. * - * @param [in,out] file If non-null, the file. - * @param buffer The buffer. - * @param offset The offset. - * @param length The length. - * @param [in,out] actual If non-null, the actual. + * @param [in,out] file If non-null, the file. + * @param buffer The buffer. + * @param offset The offset. + * @param length The length. + * @param [in,out] actual If non-null, the actual. * - * @return A file_error. + * @return A file_error. */ static file_error osd_or_zlib_write(core_file *file, const void *buffer, UINT64 offset, UINT32 length, UINT32 *actual) diff --git a/src/lib/util/corestr.c b/src/lib/util/corestr.c index eb6f76ac4b4..b4a75a3bc48 100644 --- a/src/lib/util/corestr.c +++ b/src/lib/util/corestr.c @@ -295,13 +295,13 @@ std::string strmakeupper(std::string& str) } /** - * @fn std::string strmakelower(std::string& str) + * @fn std::string strmakelower(std::string& str) * - * @brief Strmakelowers the given string. + * @brief Strmakelowers the given string. * - * @param [in,out] str The string. + * @param [in,out] str The string. * - * @return A std::string. + * @return A std::string. */ std::string strmakelower(std::string& str) @@ -311,15 +311,15 @@ std::string strmakelower(std::string& str) } /** - * @fn int strreplace(std::string &str, const std::string& search, const std::string& replace) + * @fn int strreplace(std::string &str, const std::string& search, const std::string& replace) * - * @brief Strreplaces. + * @brief Strreplaces. * - * @param [in,out] str The string. - * @param search The search. - * @param replace The replace. + * @param [in,out] str The string. + * @param search The search. + * @param replace The replace. * - * @return An int. + * @return An int. */ int strreplace(std::string &str, const std::string& search, const std::string& replace) diff --git a/src/lib/util/coreutil.c b/src/lib/util/coreutil.c index 2a2a27d712e..a7c2ccb0f22 100644 --- a/src/lib/util/coreutil.c +++ b/src/lib/util/coreutil.c @@ -69,14 +69,14 @@ int gregorian_is_leap_year(int year) /* months are one counted */ /** - * @fn int gregorian_days_in_month(int month, int year) + * @fn int gregorian_days_in_month(int month, int year) * - * @brief Gregorian days in month. + * @brief Gregorian days in month. * - * @param month The month. - * @param year The year. + * @param month The month. + * @param year The year. * - * @return An int. + * @return An int. */ int gregorian_days_in_month(int month, int year) @@ -95,12 +95,12 @@ int gregorian_days_in_month(int month, int year) ***************************************************************************/ /** - * @fn void rand_memory(void *memory, size_t length) + * @fn void rand_memory(void *memory, size_t length) * - * @brief Random memory. + * @brief Random memory. * - * @param [in,out] memory If non-null, the memory. - * @param length The length. + * @param [in,out] memory If non-null, the memory. + * @param length The length. */ void rand_memory(void *memory, size_t length) diff --git a/src/lib/util/cstrpool.c b/src/lib/util/cstrpool.c index 36c5ff694bb..dfb41e25232 100644 --- a/src/lib/util/cstrpool.c +++ b/src/lib/util/cstrpool.c @@ -71,11 +71,11 @@ bool const_string_pool::contains(const char *string) } /** - * @fn const_string_pool::pool_chunk::pool_chunk() + * @fn const_string_pool::pool_chunk::pool_chunk() * - * @brief ------------------------------------------------- - * pool_chunk - constructor - * -------------------------------------------------. + * @brief ------------------------------------------------- + * pool_chunk - constructor + * -------------------------------------------------. */ const_string_pool::pool_chunk::pool_chunk() @@ -85,15 +85,15 @@ const_string_pool::pool_chunk::pool_chunk() } /** - * @fn const char *const_string_pool::pool_chunk::add(const char *string) + * @fn const char *const_string_pool::pool_chunk::add(const char *string) * - * @brief ------------------------------------------------- - * add - add a string to this pool - * -------------------------------------------------. + * @brief ------------------------------------------------- + * add - add a string to this pool + * -------------------------------------------------. * - * @param string The string to add. + * @param string The string to add. * - * @return null if it fails, else a char*. + * @return null if it fails, else a char*. */ const char *const_string_pool::pool_chunk::add(const char *string) diff --git a/src/lib/util/delegate.c b/src/lib/util/delegate.c index 5abf04b3a32..2245cf14bcb 100644 --- a/src/lib/util/delegate.c +++ b/src/lib/util/delegate.c @@ -33,16 +33,16 @@ delegate_mfp::raw_mfp_data delegate_mfp::s_null_mfp = { 0 }; #if (USE_DELEGATE_TYPE == DELEGATE_TYPE_INTERNAL) /** - * @fn delegate_generic_function delegate_mfp::convert_to_generic(delegate_generic_class *&object) const + * @fn delegate_generic_function delegate_mfp::convert_to_generic(delegate_generic_class *&object) const * - * @brief ------------------------------------------------- - * delegate_convert_raw - given an object and an raw function, adjust the object base - * and return the actual final code pointer - * -------------------------------------------------. + * @brief ------------------------------------------------- + * delegate_convert_raw - given an object and an raw function, adjust the object base + * and return the actual final code pointer + * -------------------------------------------------. * - * @param [in,out] object [in,out] If non-null, the object. + * @param [in,out] object [in,out] If non-null, the object. * - * @return The given data converted to a generic. + * @return The given data converted to a generic. */ delegate_generic_function delegate_mfp::convert_to_generic(delegate_generic_class *&object) const diff --git a/src/lib/util/delegate.h b/src/lib/util/delegate.h index 3b02f91b976..848e56480c9 100644 --- a/src/lib/util/delegate.h +++ b/src/lib/util/delegate.h @@ -659,8 +659,7 @@ public: if (is_mfp() && (HAS_DIFFERENT_ABI)) \ return (*reinterpret_cast<generic_member_func>(m_function)) x; \ else \ - return (*m_function) x; \ - + return (*m_function) x; //return MEMBER_ABI (*reinpertret_cast<generic_member_func>(m_function)) x; // call the function diff --git a/src/lib/util/flac.c b/src/lib/util/flac.c index 2e1e999977d..49fc667a184 100644 --- a/src/lib/util/flac.c +++ b/src/lib/util/flac.c @@ -609,15 +609,15 @@ FLAC__StreamDecoderWriteStatus flac_decoder::write_callback(const ::FLAC__Frame } /** - * @fn void flac_decoder::error_callback_static(const FLAC__StreamDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data) + * @fn void flac_decoder::error_callback_static(const FLAC__StreamDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data) * - * @brief ------------------------------------------------- - * error_callback - handle errors (ignore them) - * -------------------------------------------------. + * @brief ------------------------------------------------- + * error_callback - handle errors (ignore them) + * -------------------------------------------------. * - * @param decoder The decoder. - * @param status The status. - * @param [in,out] client_data If non-null, information describing the client. + * @param decoder The decoder. + * @param status The status. + * @param [in,out] client_data If non-null, information describing the client. */ void flac_decoder::error_callback_static(const FLAC__StreamDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data) diff --git a/src/lib/util/harddisk.c b/src/lib/util/harddisk.c index 4b041cf29a8..b1082f3234f 100644 --- a/src/lib/util/harddisk.c +++ b/src/lib/util/harddisk.c @@ -98,13 +98,13 @@ chd_file *hard_disk_get_chd(hard_disk_file *file) -------------------------------------------------*/ /** - * @fn hard_disk_info *hard_disk_get_info(hard_disk_file *file) + * @fn hard_disk_info *hard_disk_get_info(hard_disk_file *file) * - * @brief Hard disk get information. + * @brief Hard disk get information. * - * @param [in,out] file If non-null, the file. + * @param [in,out] file If non-null, the file. * - * @return null if it fails, else a hard_disk_info*. + * @return null if it fails, else a hard_disk_info*. */ hard_disk_info *hard_disk_get_info(hard_disk_file *file) @@ -119,15 +119,15 @@ hard_disk_info *hard_disk_get_info(hard_disk_file *file) -------------------------------------------------*/ /** - * @fn UINT32 hard_disk_read(hard_disk_file *file, UINT32 lbasector, void *buffer) + * @fn UINT32 hard_disk_read(hard_disk_file *file, UINT32 lbasector, void *buffer) * - * @brief Hard disk read. + * @brief Hard disk read. * - * @param [in,out] file If non-null, the file. - * @param lbasector The lbasector. - * @param [in,out] buffer If non-null, the buffer. + * @param [in,out] file If non-null, the file. + * @param lbasector The lbasector. + * @param [in,out] buffer If non-null, the buffer. * - * @return An UINT32. + * @return An UINT32. */ UINT32 hard_disk_read(hard_disk_file *file, UINT32 lbasector, void *buffer) @@ -143,15 +143,15 @@ UINT32 hard_disk_read(hard_disk_file *file, UINT32 lbasector, void *buffer) -------------------------------------------------*/ /** - * @fn UINT32 hard_disk_write(hard_disk_file *file, UINT32 lbasector, const void *buffer) + * @fn UINT32 hard_disk_write(hard_disk_file *file, UINT32 lbasector, const void *buffer) * - * @brief Hard disk write. + * @brief Hard disk write. * - * @param [in,out] file If non-null, the file. - * @param lbasector The lbasector. - * @param buffer The buffer. + * @param [in,out] file If non-null, the file. + * @param lbasector The lbasector. + * @param buffer The buffer. * - * @return An UINT32. + * @return An UINT32. */ UINT32 hard_disk_write(hard_disk_file *file, UINT32 lbasector, const void *buffer) diff --git a/src/lib/util/hashing.c b/src/lib/util/hashing.c index d7244d4edcf..e7f315ecc53 100644 --- a/src/lib/util/hashing.c +++ b/src/lib/util/hashing.c @@ -215,15 +215,15 @@ bool crc16_t::from_string(const char *string, int length) } /** - * @fn const char *crc16_t::as_string(std::string &buffer) const + * @fn const char *crc16_t::as_string(std::string &buffer) const * - * @brief ------------------------------------------------- - * as_string - convert to a string - * -------------------------------------------------. + * @brief ------------------------------------------------- + * as_string - convert to a string + * -------------------------------------------------. * - * @param [in,out] buffer The buffer. + * @param [in,out] buffer The buffer. * - * @return null if it fails, else a char*. + * @return null if it fails, else a char*. */ const char *crc16_t::as_string(std::string &buffer) const @@ -233,14 +233,14 @@ const char *crc16_t::as_string(std::string &buffer) const } /** - * @fn void crc16_creator::append(const void *data, UINT32 length) + * @fn void crc16_creator::append(const void *data, UINT32 length) * - * @brief ------------------------------------------------- - * append - hash a block of data, appending to the currently-accumulated value - * -------------------------------------------------. + * @brief ------------------------------------------------- + * append - hash a block of data, appending to the currently-accumulated value + * -------------------------------------------------. * - * @param data The data. - * @param length The length. + * @param data The data. + * @param length The length. */ void crc16_creator::append(const void *data, UINT32 length) diff --git a/src/lib/util/huffman.c b/src/lib/util/huffman.c index 7f804aec222..9205264f9eb 100644 --- a/src/lib/util/huffman.c +++ b/src/lib/util/huffman.c @@ -731,18 +731,18 @@ huffman_8bit_decoder::huffman_8bit_decoder() } /** - * @fn huffman_error huffman_8bit_decoder::decode(const UINT8 *source, UINT32 slength, UINT8 *dest, UINT32 dlength) + * @fn huffman_error huffman_8bit_decoder::decode(const UINT8 *source, UINT32 slength, UINT8 *dest, UINT32 dlength) * - * @brief ------------------------------------------------- - * decode - decode a full buffer - * -------------------------------------------------. + * @brief ------------------------------------------------- + * decode - decode a full buffer + * -------------------------------------------------. * - * @param source Source for the. - * @param slength The slength. - * @param [in,out] dest If non-null, destination for the. - * @param dlength The dlength. + * @param source Source for the. + * @param slength The slength. + * @param [in,out] dest If non-null, destination for the. + * @param dlength The dlength. * - * @return A huffman_error. + * @return A huffman_error. */ huffman_error huffman_8bit_decoder::decode(const UINT8 *source, UINT32 slength, UINT8 *dest, UINT32 dlength) diff --git a/src/lib/util/jedparse.c b/src/lib/util/jedparse.c index 37bee01fa85..9bed1164303 100644 --- a/src/lib/util/jedparse.c +++ b/src/lib/util/jedparse.c @@ -411,15 +411,15 @@ int jedbin_parse(const void *data, size_t length, jed_data *result) -------------------------------------------------*/ /** - * @fn size_t jedbin_output(const jed_data *data, void *result, size_t length) + * @fn size_t jedbin_output(const jed_data *data, void *result, size_t length) * - * @brief Jedbin output. + * @brief Jedbin output. * - * @param data The data. - * @param [out] result If non-null, the result. - * @param length The length. + * @param data The data. + * @param [out] result If non-null, the result. + * @param length The length. * - * @return A size_t. + * @return A size_t. */ size_t jedbin_output(const jed_data *data, void *result, size_t length) diff --git a/src/lib/util/md5.c b/src/lib/util/md5.c index 7c571d9442e..3c0abb33b30 100644 --- a/src/lib/util/md5.c +++ b/src/lib/util/md5.c @@ -155,12 +155,12 @@ MD5Final(md5byte digest[16], struct MD5Context *ctx) */ /** - * @fn void MD5Transform(UWORD32 buf[4], UWORD32 const in[16]) + * @fn void MD5Transform(UWORD32 buf[4], UWORD32 const in[16]) * - * @brief Md 5 transform. + * @brief Md 5 transform. * - * @param buf The buffer. - * @param in The in. + * @param buf The buffer. + * @param in The in. */ void diff --git a/src/lib/util/opresolv.c b/src/lib/util/opresolv.c index 0dd9252d7b6..91c6f1a9cbd 100644 --- a/src/lib/util/opresolv.c +++ b/src/lib/util/opresolv.c @@ -537,14 +537,14 @@ optreserr_t option_resolution_isvalidvalue(const char *specification, int option } /** - * @fn int option_resolution_contains(const char *specification, int option_char) + * @fn int option_resolution_contains(const char *specification, int option_char) * - * @brief Option resolution contains. + * @brief Option resolution contains. * - * @param specification The specification. - * @param option_char The option character. + * @param specification The specification. + * @param option_char The option character. * - * @return An int. + * @return An int. */ int option_resolution_contains(const char *specification, int option_char) @@ -553,13 +553,13 @@ int option_resolution_contains(const char *specification, int option_char) } /** - * @fn const char *option_resolution_error_string(optreserr_t err) + * @fn const char *option_resolution_error_string(optreserr_t err) * - * @brief Option resolution error string. + * @brief Option resolution error string. * - * @param err The error. + * @param err The error. * - * @return null if it fails, else a char*. + * @return null if it fails, else a char*. */ const char *option_resolution_error_string(optreserr_t err) diff --git a/src/lib/util/options.c b/src/lib/util/options.c index b365c1dd0ff..69e7189f50b 100644 --- a/src/lib/util/options.c +++ b/src/lib/util/options.c @@ -710,13 +710,13 @@ void core_options::remove_entry(core_options::entry &delentry) } /** - * @fn void core_options::copyfrom(const core_options &src) + * @fn void core_options::copyfrom(const core_options &src) * - * @brief ------------------------------------------------- - * copyfrom - copy options from another set - * -------------------------------------------------. + * @brief ------------------------------------------------- + * copyfrom - copy options from another set + * -------------------------------------------------. * - * @param src Source for the. + * @param src Source for the. */ void core_options::copyfrom(const core_options &src) @@ -730,19 +730,19 @@ void core_options::copyfrom(const core_options &src) } /** - * @fn bool core_options::validate_and_set_data(core_options::entry &curentry, const char *newdata, int priority, std::string &error_string) + * @fn bool core_options::validate_and_set_data(core_options::entry &curentry, const char *newdata, int priority, std::string &error_string) * - * @brief ------------------------------------------------- - * validate_and_set_data - make sure the data is of the appropriate type and within - * range, then set it - * -------------------------------------------------. + * @brief ------------------------------------------------- + * validate_and_set_data - make sure the data is of the appropriate type and within + * range, then set it + * -------------------------------------------------. * - * @param [in,out] curentry The curentry. - * @param newdata The newdata. - * @param priority The priority. - * @param [in,out] error_string The error string. + * @param [in,out] curentry The curentry. + * @param newdata The newdata. + * @param priority The priority. + * @param [in,out] error_string The error string. * - * @return true if it succeeds, false if it fails. + * @return true if it succeeds, false if it fails. */ bool core_options::validate_and_set_data(core_options::entry &curentry, const char *newdata, int priority, std::string &error_string) diff --git a/src/lib/util/palette.c b/src/lib/util/palette.c index 7e20e7e9cb7..f2252a24319 100644 --- a/src/lib/util/palette.c +++ b/src/lib/util/palette.c @@ -468,14 +468,14 @@ void palette_t::normalize_range(UINT32 start, UINT32 end, int lum_min, int lum_m } /** - * @fn void palette_t::update_adjusted_color(UINT32 group, UINT32 index) + * @fn void palette_t::update_adjusted_color(UINT32 group, UINT32 index) * - * @brief ------------------------------------------------- - * update_adjusted_color - update a color index by group and index pair - * -------------------------------------------------. + * @brief ------------------------------------------------- + * update_adjusted_color - update a color index by group and index pair + * -------------------------------------------------. * - * @param group The group. - * @param index Zero-based index of the. + * @param group The group. + * @param index Zero-based index of the. */ void palette_t::update_adjusted_color(UINT32 group, UINT32 index) diff --git a/src/lib/util/plaparse.c b/src/lib/util/plaparse.c index f6228d2cbe9..74bc8edcc69 100644 --- a/src/lib/util/plaparse.c +++ b/src/lib/util/plaparse.c @@ -295,15 +295,15 @@ static bool process_field(jed_data *data, const UINT8 **src, const UINT8 *srcend -------------------------------------------------*/ /** - * @fn int pla_parse(const void *data, size_t length, jed_data *result) + * @fn int pla_parse(const void *data, size_t length, jed_data *result) * - * @brief Pla parse. + * @brief Pla parse. * - * @param data The data. - * @param length The length. - * @param [out] result If non-null, the result. + * @param data The data. + * @param length The length. + * @param [out] result If non-null, the result. * - * @return An int. + * @return An int. */ int pla_parse(const void *data, size_t length, jed_data *result) diff --git a/src/lib/util/png.c b/src/lib/util/png.c index 224cdf8d3dc..706dfb5e50f 100644 --- a/src/lib/util/png.c +++ b/src/lib/util/png.c @@ -1097,15 +1097,15 @@ png_error png_write_bitmap(core_file *fp, png_info *info, bitmap_t &bitmap, int ********************************************************************************/ /** - * @fn png_error mng_capture_start(core_file *fp, bitmap_t &bitmap, double rate) + * @fn png_error mng_capture_start(core_file *fp, bitmap_t &bitmap, double rate) * - * @brief Mng capture start. + * @brief Mng capture start. * - * @param [in,out] fp If non-null, the fp. - * @param [in,out] bitmap The bitmap. - * @param rate The rate. + * @param [in,out] fp If non-null, the fp. + * @param [in,out] bitmap The bitmap. + * @param rate The rate. * - * @return A png_error. + * @return A png_error. */ png_error mng_capture_start(core_file *fp, bitmap_t &bitmap, double rate) @@ -1131,17 +1131,17 @@ png_error mng_capture_start(core_file *fp, bitmap_t &bitmap, double rate) } /** - * @fn png_error mng_capture_frame(core_file *fp, png_info *info, bitmap_t &bitmap, int palette_length, const rgb_t *palette) + * @fn png_error mng_capture_frame(core_file *fp, png_info *info, bitmap_t &bitmap, int palette_length, const rgb_t *palette) * - * @brief Mng capture frame. + * @brief Mng capture frame. * - * @param [in,out] fp If non-null, the fp. - * @param [in,out] info If non-null, the information. - * @param [in,out] bitmap The bitmap. - * @param palette_length Length of the palette. - * @param palette The palette. + * @param [in,out] fp If non-null, the fp. + * @param [in,out] info If non-null, the information. + * @param [in,out] bitmap The bitmap. + * @param palette_length Length of the palette. + * @param palette The palette. * - * @return A png_error. + * @return A png_error. */ png_error mng_capture_frame(core_file *fp, png_info *info, bitmap_t &bitmap, int palette_length, const rgb_t *palette) @@ -1150,13 +1150,13 @@ png_error mng_capture_frame(core_file *fp, png_info *info, bitmap_t &bitmap, int } /** - * @fn png_error mng_capture_stop(core_file *fp) + * @fn png_error mng_capture_stop(core_file *fp) * - * @brief Mng capture stop. + * @brief Mng capture stop. * - * @param [in,out] fp If non-null, the fp. + * @param [in,out] fp If non-null, the fp. * - * @return A png_error. + * @return A png_error. */ png_error mng_capture_stop(core_file *fp) diff --git a/src/lib/util/pool.c b/src/lib/util/pool.c index 0ca2be3deaa..ab62f47c6aa 100644 --- a/src/lib/util/pool.c +++ b/src/lib/util/pool.c @@ -571,11 +571,11 @@ static void memory_error(const char *message) -------------------------------------------------*/ /** - * @fn int test_memory_pools(void) + * @fn int test_memory_pools(void) * - * @brief Tests memory pools. + * @brief Tests memory pools. * - * @return An int. + * @return An int. */ int test_memory_pools(void) diff --git a/src/lib/util/sha1.c b/src/lib/util/sha1.c index 732828d9ccf..32247510190 100644 --- a/src/lib/util/sha1.c +++ b/src/lib/util/sha1.c @@ -122,11 +122,11 @@ static void WRITE_UINT32(unsigned char* data, UINT32 val) /* Initialize the SHA values */ /** - * @fn void sha1_init(struct sha1_ctx *ctx) + * @fn void sha1_init(struct sha1_ctx *ctx) * - * @brief Sha 1 initialise. + * @brief Sha 1 initialise. * - * @param [in,out] ctx If non-null, the context. + * @param [in,out] ctx If non-null, the context. */ void @@ -154,12 +154,12 @@ sha1_init(struct sha1_ctx *ctx) Note that this function destroys the data area */ /** - * @fn static void sha1_transform(UINT32 *state, UINT32 *data) + * @fn static void sha1_transform(UINT32 *state, UINT32 *data) * - * @brief Sha 1 transform. + * @brief Sha 1 transform. * - * @param [in,out] state If non-null, the state. - * @param [in,out] data If non-null, the data. + * @param [in,out] state If non-null, the state. + * @param [in,out] data If non-null, the data. */ static void @@ -268,12 +268,12 @@ sha1_transform(UINT32 *state, UINT32 *data) } /** - * @fn static void sha1_block(struct sha1_ctx *ctx, const UINT8 *block) + * @fn static void sha1_block(struct sha1_ctx *ctx, const UINT8 *block) * - * @brief Sha 1 block. + * @brief Sha 1 block. * - * @param [in,out] ctx If non-null, the context. - * @param block The block. + * @param [in,out] ctx If non-null, the context. + * @param block The block. */ static void @@ -294,13 +294,13 @@ sha1_block(struct sha1_ctx *ctx, const UINT8 *block) } /** - * @fn void sha1_update(struct sha1_ctx *ctx, unsigned length, const UINT8 *buffer) + * @fn void sha1_update(struct sha1_ctx *ctx, unsigned length, const UINT8 *buffer) * - * @brief Sha 1 update. + * @brief Sha 1 update. * - * @param [in,out] ctx If non-null, the context. - * @param length The length. - * @param buffer The buffer. + * @param [in,out] ctx If non-null, the context. + * @param length The length. + * @param buffer The buffer. */ void @@ -340,11 +340,11 @@ sha1_update(struct sha1_ctx *ctx, 1 0* (64-bit count of bits processed, MSB-first) */ /** - * @fn void sha1_final(struct sha1_ctx *ctx) + * @fn void sha1_final(struct sha1_ctx *ctx) * - * @brief Sha 1 final. + * @brief Sha 1 final. * - * @param [in,out] ctx If non-null, the context. + * @param [in,out] ctx If non-null, the context. */ void @@ -391,13 +391,13 @@ sha1_final(struct sha1_ctx *ctx) } /** - * @fn void sha1_digest(const struct sha1_ctx *ctx, unsigned length, UINT8 *digest) + * @fn void sha1_digest(const struct sha1_ctx *ctx, unsigned length, UINT8 *digest) * - * @brief Sha 1 digest. + * @brief Sha 1 digest. * - * @param ctx The context. - * @param length The length. - * @param [in,out] digest If non-null, the digest. + * @param ctx The context. + * @param length The length. + * @param [in,out] digest If non-null, the digest. */ void diff --git a/src/lib/util/tagmap.c b/src/lib/util/tagmap.c index 95b0ec4fabf..7995b578314 100644 --- a/src/lib/util/tagmap.c +++ b/src/lib/util/tagmap.c @@ -13,8 +13,8 @@ #include "tagmap.h" #ifdef MAME_DEBUG -/** @brief The tagmap finds. */ +/** @brief The tagmap finds. */ INT32 g_tagmap_finds = 0; -/** @brief true to enable, false to disable the tagmap counter. */ +/** @brief true to enable, false to disable the tagmap counter. */ bool g_tagmap_counter_enabled = false; #endif diff --git a/src/lib/util/un7z.c b/src/lib/util/un7z.c index 57c7eeb0890..bbae440e0ff 100644 --- a/src/lib/util/un7z.c +++ b/src/lib/util/un7z.c @@ -468,11 +468,11 @@ _7z_error _7z_file_decompress(_7z_file *new_7z, void *buffer, UINT32 length) -------------------------------------------------*/ /** - * @fn static void free__7z_file(_7z_file *_7z) + * @fn static void free__7z_file(_7z_file *_7z) * - * @brief Free 7z file. + * @brief Free 7z file. * - * @param [in,out] _7z If non-null, the 7z. + * @param [in,out] _7z If non-null, the 7z. */ static void free__7z_file(_7z_file *_7z) diff --git a/src/lib/util/unicode.c b/src/lib/util/unicode.c index 7f264bc1fb6..5f375337b34 100644 --- a/src/lib/util/unicode.c +++ b/src/lib/util/unicode.c @@ -309,13 +309,13 @@ int utf16f_from_uchar(utf16_char *utf16string, size_t count, unicode_char uchar) -------------------------------------------------*/ /** - * @fn const char *utf8_previous_char(const char *utf8string) + * @fn const char *utf8_previous_char(const char *utf8string) * - * @brief UTF 8 previous character. + * @brief UTF 8 previous character. * - * @param utf8string The UTF 8string. + * @param utf8string The UTF 8string. * - * @return null if it fails, else a char*. + * @return null if it fails, else a char*. */ const char *utf8_previous_char(const char *utf8string) @@ -333,13 +333,13 @@ const char *utf8_previous_char(const char *utf8string) -------------------------------------------------*/ /** - * @fn int utf8_is_valid_string(const char *utf8string) + * @fn int utf8_is_valid_string(const char *utf8string) * - * @brief UTF 8 is valid string. + * @brief UTF 8 is valid string. * - * @param utf8string The UTF 8string. + * @param utf8string The UTF 8string. * - * @return An int. + * @return An int. */ int utf8_is_valid_string(const char *utf8string) diff --git a/src/lib/util/unzip.c b/src/lib/util/unzip.c index 072e29c130d..21e137b9f24 100644 --- a/src/lib/util/unzip.c +++ b/src/lib/util/unzip.c @@ -69,25 +69,25 @@ #define ZIPUNCMP 0x16 /** - * @def ZIPFNLN + * @def ZIPFNLN * - * @brief A macro that defines zipfnln. + * @brief A macro that defines zipfnln. */ #define ZIPFNLN 0x1a /** - * @def ZIPXTRALN + * @def ZIPXTRALN * - * @brief A macro that defines zipxtraln. + * @brief A macro that defines zipxtraln. */ #define ZIPXTRALN 0x1c /** - * @def ZIPNAME + * @def ZIPNAME * - * @brief A macro that defines zipname. + * @brief A macro that defines zipname. */ #define ZIPNAME 0x1e @@ -99,13 +99,13 @@ ***************************************************************************/ /** - * @fn INLINE UINT16 read_word(UINT8 *buf) + * @fn INLINE UINT16 read_word(UINT8 *buf) * - * @brief Reads a word. + * @brief Reads a word. * - * @param [in,out] buf If non-null, the buffer. + * @param [in,out] buf If non-null, the buffer. * - * @return The word. + * @return The word. */ INLINE UINT16 read_word(UINT8 *buf) @@ -114,13 +114,13 @@ INLINE UINT16 read_word(UINT8 *buf) } /** - * @fn INLINE UINT32 read_dword(UINT8 *buf) + * @fn INLINE UINT32 read_dword(UINT8 *buf) * - * @brief Reads a double word. + * @brief Reads a double word. * - * @param [in,out] buf If non-null, the buffer. + * @param [in,out] buf If non-null, the buffer. * - * @return The double word. + * @return The double word. */ INLINE UINT32 read_dword(UINT8 *buf) @@ -134,7 +134,7 @@ INLINE UINT32 read_dword(UINT8 *buf) GLOBAL VARIABLES ***************************************************************************/ -/** @brief The zip cache[ zip cache size]. */ +/** @brief The zip cache[ zip cache size]. */ static zip_file *zip_cache[ZIP_CACHE_SIZE]; @@ -165,14 +165,14 @@ static zip_error decompress_data_type_8(zip_file *zip, UINT64 offset, void *buff -------------------------------------------------*/ /** - * @fn zip_error zip_file_open(const char *filename, zip_file **zip) + * @fn zip_error zip_file_open(const char *filename, zip_file **zip) * - * @brief Queries if a given zip file open. + * @brief Queries if a given zip file open. * - * @param filename Filename of the file. - * @param [in,out] zip If non-null, the zip. + * @param filename Filename of the file. + * @param [in,out] zip If non-null, the zip. * - * @return A zip_error. + * @return A zip_error. */ zip_error zip_file_open(const char *filename, zip_file **zip) @@ -267,11 +267,11 @@ error: -------------------------------------------------*/ /** - * @fn void zip_file_close(zip_file *zip) + * @fn void zip_file_close(zip_file *zip) * - * @brief Zip file close. + * @brief Zip file close. * - * @param [in,out] zip If non-null, the zip. + * @param [in,out] zip If non-null, the zip. */ void zip_file_close(zip_file *zip) @@ -305,9 +305,9 @@ void zip_file_close(zip_file *zip) -------------------------------------------------*/ /** - * @fn void zip_file_cache_clear(void) + * @fn void zip_file_cache_clear(void) * - * @brief Zip file cache clear. + * @brief Zip file cache clear. */ void zip_file_cache_clear(void) @@ -335,13 +335,13 @@ void zip_file_cache_clear(void) -------------------------------------------------*/ /** - * @fn const zip_file_header *zip_file_first_file(zip_file *zip) + * @fn const zip_file_header *zip_file_first_file(zip_file *zip) * - * @brief Zip file first file. + * @brief Zip file first file. * - * @param [in,out] zip If non-null, the zip. + * @param [in,out] zip If non-null, the zip. * - * @return null if it fails, else a zip_file_header*. + * @return null if it fails, else a zip_file_header*. */ const zip_file_header *zip_file_first_file(zip_file *zip) @@ -358,13 +358,13 @@ const zip_file_header *zip_file_first_file(zip_file *zip) -------------------------------------------------*/ /** - * @fn const zip_file_header *zip_file_next_file(zip_file *zip) + * @fn const zip_file_header *zip_file_next_file(zip_file *zip) * - * @brief Zip file next file. + * @brief Zip file next file. * - * @param [in,out] zip If non-null, the zip. + * @param [in,out] zip If non-null, the zip. * - * @return null if it fails, else a zip_file_header*. + * @return null if it fails, else a zip_file_header*. */ const zip_file_header *zip_file_next_file(zip_file *zip) @@ -425,15 +425,15 @@ const zip_file_header *zip_file_next_file(zip_file *zip) -------------------------------------------------*/ /** - * @fn zip_error zip_file_decompress(zip_file *zip, void *buffer, UINT32 length) + * @fn zip_error zip_file_decompress(zip_file *zip, void *buffer, UINT32 length) * - * @brief Zip file decompress. + * @brief Zip file decompress. * - * @param [in,out] zip If non-null, the zip. - * @param [in,out] buffer If non-null, the buffer. - * @param length The length. + * @param [in,out] zip If non-null, the zip. + * @param [in,out] buffer If non-null, the buffer. + * @param length The length. * - * @return A zip_error. + * @return A zip_error. */ zip_error zip_file_decompress(zip_file *zip, void *buffer, UINT32 length) @@ -484,11 +484,11 @@ zip_error zip_file_decompress(zip_file *zip, void *buffer, UINT32 length) -------------------------------------------------*/ /** - * @fn static void free_zip_file(zip_file *zip) + * @fn static void free_zip_file(zip_file *zip) * - * @brief Free zip file. + * @brief Free zip file. * - * @param [in,out] zip If non-null, the zip. + * @param [in,out] zip If non-null, the zip. */ static void free_zip_file(zip_file *zip) @@ -518,13 +518,13 @@ static void free_zip_file(zip_file *zip) -------------------------------------------------*/ /** - * @fn static zip_error read_ecd(zip_file *zip) + * @fn static zip_error read_ecd(zip_file *zip) * - * @brief Reads an ecd. + * @brief Reads an ecd. * - * @param [in,out] zip If non-null, the zip. + * @param [in,out] zip If non-null, the zip. * - * @return The ecd. + * @return The ecd. */ static zip_error read_ecd(zip_file *zip) @@ -602,14 +602,14 @@ static zip_error read_ecd(zip_file *zip) -------------------------------------------------*/ /** - * @fn static zip_error get_compressed_data_offset(zip_file *zip, UINT64 *offset) + * @fn static zip_error get_compressed_data_offset(zip_file *zip, UINT64 *offset) * - * @brief Gets compressed data offset. + * @brief Gets compressed data offset. * - * @param [in,out] zip If non-null, the zip. - * @param [in,out] offset If non-null, the offset. + * @param [in,out] zip If non-null, the zip. + * @param [in,out] offset If non-null, the offset. * - * @return The compressed data offset. + * @return The compressed data offset. */ static zip_error get_compressed_data_offset(zip_file *zip, UINT64 *offset) @@ -650,16 +650,16 @@ static zip_error get_compressed_data_offset(zip_file *zip, UINT64 *offset) -------------------------------------------------*/ /** - * @fn static zip_error decompress_data_type_0(zip_file *zip, UINT64 offset, void *buffer, UINT32 length) + * @fn static zip_error decompress_data_type_0(zip_file *zip, UINT64 offset, void *buffer, UINT32 length) * - * @brief Decompress the data type 0. + * @brief Decompress the data type 0. * - * @param [in,out] zip If non-null, the zip. - * @param offset The offset. - * @param [in,out] buffer If non-null, the buffer. - * @param length The length. + * @param [in,out] zip If non-null, the zip. + * @param offset The offset. + * @param [in,out] buffer If non-null, the buffer. + * @param length The length. * - * @return A zip_error. + * @return A zip_error. */ static zip_error decompress_data_type_0(zip_file *zip, UINT64 offset, void *buffer, UINT32 length) @@ -684,16 +684,16 @@ static zip_error decompress_data_type_0(zip_file *zip, UINT64 offset, void *buff -------------------------------------------------*/ /** - * @fn static zip_error decompress_data_type_8(zip_file *zip, UINT64 offset, void *buffer, UINT32 length) + * @fn static zip_error decompress_data_type_8(zip_file *zip, UINT64 offset, void *buffer, UINT32 length) * - * @brief Decompress the data type 8. + * @brief Decompress the data type 8. * - * @param [in,out] zip If non-null, the zip. - * @param offset The offset. - * @param [in,out] buffer If non-null, the buffer. - * @param length The length. + * @param [in,out] zip If non-null, the zip. + * @param offset The offset. + * @param [in,out] buffer If non-null, the buffer. + * @param length The length. * - * @return A zip_error. + * @return A zip_error. */ static zip_error decompress_data_type_8(zip_file *zip, UINT64 offset, void *buffer, UINT32 length) diff --git a/src/lib/util/vbiparse.c b/src/lib/util/vbiparse.c index 43cfb57c158..9c6c39fc4ea 100644 --- a/src/lib/util/vbiparse.c +++ b/src/lib/util/vbiparse.c @@ -277,15 +277,15 @@ int vbi_parse_white_flag(const UINT16 *source, int sourcewidth, int sourceshift) -------------------------------------------------*/ /** - * @fn void vbi_parse_all(const UINT16 *source, int sourcerowpixels, int sourcewidth, int sourceshift, vbi_metadata *vbi) + * @fn void vbi_parse_all(const UINT16 *source, int sourcerowpixels, int sourcewidth, int sourceshift, vbi_metadata *vbi) * - * @brief Vbi parse all. + * @brief Vbi parse all. * - * @param source Source for the. - * @param sourcerowpixels The sourcerowpixels. - * @param sourcewidth The sourcewidth. - * @param sourceshift The sourceshift. - * @param [in,out] vbi If non-null, the vbi. + * @param source Source for the. + * @param sourcerowpixels The sourcerowpixels. + * @param sourcewidth The sourcewidth. + * @param sourceshift The sourceshift. + * @param [in,out] vbi If non-null, the vbi. */ void vbi_parse_all(const UINT16 *source, int sourcerowpixels, int sourcewidth, int sourceshift, vbi_metadata *vbi) @@ -351,13 +351,13 @@ void vbi_parse_all(const UINT16 *source, int sourcerowpixels, int sourcewidth, i -------------------------------------------------*/ /** - * @fn void vbi_metadata_pack(UINT8 *dest, UINT32 framenum, const vbi_metadata *vbi) + * @fn void vbi_metadata_pack(UINT8 *dest, UINT32 framenum, const vbi_metadata *vbi) * - * @brief Vbi metadata pack. + * @brief Vbi metadata pack. * - * @param [in,out] dest If non-null, destination for the. - * @param framenum The framenum. - * @param vbi The vbi. + * @param [in,out] dest If non-null, destination for the. + * @param framenum The framenum. + * @param vbi The vbi. */ void vbi_metadata_pack(UINT8 *dest, UINT32 framenum, const vbi_metadata *vbi) @@ -387,13 +387,13 @@ void vbi_metadata_pack(UINT8 *dest, UINT32 framenum, const vbi_metadata *vbi) -------------------------------------------------*/ /** - * @fn void vbi_metadata_unpack(vbi_metadata *vbi, UINT32 *framenum, const UINT8 *source) + * @fn void vbi_metadata_unpack(vbi_metadata *vbi, UINT32 *framenum, const UINT8 *source) * - * @brief Vbi metadata unpack. + * @brief Vbi metadata unpack. * - * @param [in,out] vbi If non-null, the vbi. - * @param [in,out] framenum If non-null, the framenum. - * @param source Source for the. + * @param [in,out] vbi If non-null, the vbi. + * @param [in,out] framenum If non-null, the framenum. + * @param source Source for the. */ void vbi_metadata_unpack(vbi_metadata *vbi, UINT32 *framenum, const UINT8 *source) diff --git a/src/lib/util/xmlfile.c b/src/lib/util/xmlfile.c index 193717b30aa..2e11f03418b 100644 --- a/src/lib/util/xmlfile.c +++ b/src/lib/util/xmlfile.c @@ -452,15 +452,15 @@ int xml_get_attribute_int_format(xml_data_node *node, const char *attribute) -------------------------------------------------*/ /** - * @fn float xml_get_attribute_float(xml_data_node *node, const char *attribute, float defvalue) + * @fn float xml_get_attribute_float(xml_data_node *node, const char *attribute, float defvalue) * - * @brief XML get attribute float. + * @brief XML get attribute float. * - * @param [in,out] node If non-null, the node. - * @param attribute The attribute. - * @param defvalue The defvalue. + * @param [in,out] node If non-null, the node. + * @param attribute The attribute. + * @param defvalue The defvalue. * - * @return A float. + * @return A float. */ float xml_get_attribute_float(xml_data_node *node, const char *attribute, float defvalue) @@ -480,15 +480,15 @@ float xml_get_attribute_float(xml_data_node *node, const char *attribute, float -------------------------------------------------*/ /** - * @fn xml_attribute_node *xml_set_attribute(xml_data_node *node, const char *name, const char *value) + * @fn xml_attribute_node *xml_set_attribute(xml_data_node *node, const char *name, const char *value) * - * @brief XML set attribute. + * @brief XML set attribute. * - * @param [in,out] node If non-null, the node. - * @param name The name. - * @param value The value. + * @param [in,out] node If non-null, the node. + * @param name The name. + * @param value The value. * - * @return null if it fails, else an xml_attribute_node*. + * @return null if it fails, else an xml_attribute_node*. */ xml_attribute_node *xml_set_attribute(xml_data_node *node, const char *name, const char *value) @@ -520,15 +520,15 @@ xml_attribute_node *xml_set_attribute(xml_data_node *node, const char *name, con -------------------------------------------------*/ /** - * @fn xml_attribute_node *xml_set_attribute_int(xml_data_node *node, const char *name, int value) + * @fn xml_attribute_node *xml_set_attribute_int(xml_data_node *node, const char *name, int value) * - * @brief XML set attribute int. + * @brief XML set attribute int. * - * @param [in,out] node If non-null, the node. - * @param name The name. - * @param value The value. + * @param [in,out] node If non-null, the node. + * @param name The name. + * @param value The value. * - * @return null if it fails, else an xml_attribute_node*. + * @return null if it fails, else an xml_attribute_node*. */ xml_attribute_node *xml_set_attribute_int(xml_data_node *node, const char *name, int value) @@ -545,15 +545,15 @@ xml_attribute_node *xml_set_attribute_int(xml_data_node *node, const char *name, -------------------------------------------------*/ /** - * @fn xml_attribute_node *xml_set_attribute_float(xml_data_node *node, const char *name, float value) + * @fn xml_attribute_node *xml_set_attribute_float(xml_data_node *node, const char *name, float value) * - * @brief XML set attribute float. + * @brief XML set attribute float. * - * @param [in,out] node If non-null, the node. - * @param name The name. - * @param value The value. + * @param [in,out] node If non-null, the node. + * @param name The name. + * @param value The value. * - * @return null if it fails, else an xml_attribute_node*. + * @return null if it fails, else an xml_attribute_node*. */ xml_attribute_node *xml_set_attribute_float(xml_data_node *node, const char *name, float value) @@ -575,13 +575,13 @@ xml_attribute_node *xml_set_attribute_float(xml_data_node *node, const char *nam -------------------------------------------------*/ /** - * @fn const char *xml_normalize_string(const char *string) + * @fn const char *xml_normalize_string(const char *string) * - * @brief XML normalize string. + * @brief XML normalize string. * - * @param string The string. + * @param string The string. * - * @return null if it fails, else a char*. + * @return null if it fails, else a char*. */ const char *xml_normalize_string(const char *string) @@ -623,13 +623,13 @@ const char *xml_normalize_string(const char *string) -------------------------------------------------*/ /** - * @fn static void *expat_malloc(size_t size) + * @fn static void *expat_malloc(size_t size) * - * @brief Expat malloc. + * @brief Expat malloc. * - * @param size The size. + * @param size The size. * - * @return null if it fails, else a void*. + * @return null if it fails, else a void*. */ static void *expat_malloc(size_t size) @@ -640,11 +640,11 @@ static void *expat_malloc(size_t size) } /** - * @fn static void expat_free(void *ptr) + * @fn static void expat_free(void *ptr) * - * @brief Expat free. + * @brief Expat free. * - * @param [in,out] ptr If non-null, the pointer. + * @param [in,out] ptr If non-null, the pointer. */ static void expat_free(void *ptr) @@ -654,14 +654,14 @@ static void expat_free(void *ptr) } /** - * @fn static void *expat_realloc(void *ptr, size_t size) + * @fn static void *expat_realloc(void *ptr, size_t size) * - * @brief Expat realloc. + * @brief Expat realloc. * - * @param [in,out] ptr If non-null, the pointer. - * @param size The size. + * @param [in,out] ptr If non-null, the pointer. + * @param size The size. * - * @return null if it fails, else a void*. + * @return null if it fails, else a void*. */ static void *expat_realloc(void *ptr, size_t size) @@ -684,14 +684,14 @@ static void *expat_realloc(void *ptr, size_t size) -------------------------------------------------*/ /** - * @fn static int expat_setup_parser(xml_parse_info *parse_info, xml_parse_options *opts) + * @fn static int expat_setup_parser(xml_parse_info *parse_info, xml_parse_options *opts) * - * @brief Expat setup parser. + * @brief Expat setup parser. * - * @param [in,out] parse_info If non-null, information describing the parse. - * @param [in,out] opts If non-null, options for controlling the operation. + * @param [in,out] parse_info If non-null, information describing the parse. + * @param [in,out] opts If non-null, options for controlling the operation. * - * @return An int. + * @return An int. */ static int expat_setup_parser(xml_parse_info *parse_info, xml_parse_options *opts) @@ -746,13 +746,13 @@ static int expat_setup_parser(xml_parse_info *parse_info, xml_parse_options *opt -------------------------------------------------*/ /** - * @fn static void expat_element_start(void *data, const XML_Char *name, const XML_Char **attributes) + * @fn static void expat_element_start(void *data, const XML_Char *name, const XML_Char **attributes) * - * @brief Expat element start. + * @brief Expat element start. * - * @param [in,out] data If non-null, the data. - * @param name The name. - * @param attributes The attributes. + * @param [in,out] data If non-null, the data. + * @param name The name. + * @param attributes The attributes. */ static void expat_element_start(void *data, const XML_Char *name, const XML_Char **attributes) @@ -785,13 +785,13 @@ static void expat_element_start(void *data, const XML_Char *name, const XML_Char -------------------------------------------------*/ /** - * @fn static void expat_data(void *data, const XML_Char *s, int len) + * @fn static void expat_data(void *data, const XML_Char *s, int len) * - * @brief Expat data. + * @brief Expat data. * - * @param [in,out] data If non-null, the data. - * @param s The const XML_Char * to process. - * @param len The length. + * @param [in,out] data If non-null, the data. + * @param s The const XML_Char * to process. + * @param len The length. */ static void expat_data(void *data, const XML_Char *s, int len) @@ -833,12 +833,12 @@ static void expat_data(void *data, const XML_Char *s, int len) -------------------------------------------------*/ /** - * @fn static void expat_element_end(void *data, const XML_Char *name) + * @fn static void expat_element_end(void *data, const XML_Char *name) * - * @brief Expat element end. + * @brief Expat element end. * - * @param [in,out] data If non-null, the data. - * @param name The name. + * @param [in,out] data If non-null, the data. + * @param name The name. */ static void expat_element_end(void *data, const XML_Char *name) @@ -892,15 +892,15 @@ static void expat_element_end(void *data, const XML_Char *name) -------------------------------------------------*/ /** - * @fn static xml_data_node *add_child(xml_data_node *parent, const char *name, const char *value) + * @fn static xml_data_node *add_child(xml_data_node *parent, const char *name, const char *value) * - * @brief Adds a child. + * @brief Adds a child. * - * @param [in,out] parent If non-null, the parent. - * @param name The name. - * @param value The value. + * @param [in,out] parent If non-null, the parent. + * @param name The name. + * @param value The value. * - * @return null if it fails, else an xml_data_node*. + * @return null if it fails, else an xml_data_node*. */ static xml_data_node *add_child(xml_data_node *parent, const char *name, const char *value) @@ -946,15 +946,15 @@ static xml_data_node *add_child(xml_data_node *parent, const char *name, const c -------------------------------------------------*/ /** - * @fn static xml_attribute_node *add_attribute(xml_data_node *node, const char *name, const char *value) + * @fn static xml_attribute_node *add_attribute(xml_data_node *node, const char *name, const char *value) * - * @brief Adds an attribute. + * @brief Adds an attribute. * - * @param [in,out] node If non-null, the node. - * @param name The name. - * @param value The value. + * @param [in,out] node If non-null, the node. + * @param name The name. + * @param value The value. * - * @return null if it fails, else an xml_attribute_node*. + * @return null if it fails, else an xml_attribute_node*. */ static xml_attribute_node *add_attribute(xml_data_node *node, const char *name, const char *value) @@ -1001,13 +1001,13 @@ static xml_attribute_node *add_attribute(xml_data_node *node, const char *name, -------------------------------------------------*/ /** - * @fn static void write_node_recursive(xml_data_node *node, int indent, core_file *file) + * @fn static void write_node_recursive(xml_data_node *node, int indent, core_file *file) * - * @brief Writes a node recursive. + * @brief Writes a node recursive. * - * @param [in,out] node If non-null, the node. - * @param indent The indent. - * @param [in,out] file If non-null, the file. + * @param [in,out] node If non-null, the node. + * @param indent The indent. + * @param [in,out] file If non-null, the file. */ static void write_node_recursive(xml_data_node *node, int indent, core_file *file) @@ -1054,11 +1054,11 @@ static void write_node_recursive(xml_data_node *node, int indent, core_file *fil -------------------------------------------------*/ /** - * @fn static void free_node_recursive(xml_data_node *node) + * @fn static void free_node_recursive(xml_data_node *node) * - * @brief Free node recursive. + * @brief Free node recursive. * - * @param [in,out] node If non-null, the node. + * @param [in,out] node If non-null, the node. */ static void free_node_recursive(xml_data_node *node) diff --git a/src/lib/util/zippath.c b/src/lib/util/zippath.c index 8d22952223a..36c9470ed92 100644 --- a/src/lib/util/zippath.c +++ b/src/lib/util/zippath.c @@ -23,23 +23,23 @@ ***************************************************************************/ /** - * @struct zippath_returned_directory + * @struct zippath_returned_directory * - * @brief A zippath returned directory. + * @brief A zippath returned directory. */ struct zippath_returned_directory { - /** @brief The next. */ + /** @brief The next. */ zippath_returned_directory *next; - /** @brief The name. */ + /** @brief The name. */ std::string name; }; /** - * @class zippath_directory + * @class zippath_directory * - * @brief A zippath directory. + * @brief A zippath directory. */ class zippath_directory @@ -53,23 +53,23 @@ public: returned_dirlist(NULL) { } /* common */ - /** @brief true to returned parent. */ + /** @brief true to returned parent. */ bool returned_parent; - /** @brief The returned entry. */ + /** @brief The returned entry. */ osd_directory_entry returned_entry; /* specific to normal directories */ - /** @brief Pathname of the directory. */ + /** @brief Pathname of the directory. */ osd_directory *directory; /* specific to ZIP directories */ - /** @brief true to called zip first. */ + /** @brief true to called zip first. */ bool called_zip_first; - /** @brief The zipfile. */ + /** @brief The zipfile. */ zip_file *zipfile; - /** @brief The zipprefix. */ + /** @brief The zipprefix. */ std::string zipprefix; - /** @brief The returned dirlist. */ + /** @brief The returned dirlist. */ zippath_returned_directory *returned_dirlist; }; @@ -89,15 +89,15 @@ static int is_7z_file(const char *path); ***************************************************************************/ /** - * @fn int is_path_separator(char c) + * @fn int is_path_separator(char c) * - * @brief ============================================================ - * is_path_separator - * ============================================================. + * @brief ============================================================ + * is_path_separator + * ============================================================. * - * @param c The character. + * @param c The character. * - * @return An int. + * @return An int. */ int is_path_separator(char c) @@ -110,13 +110,13 @@ int is_path_separator(char c) -------------------------------------------------*/ /** - * @fn static void parse_parent_path(const char *path, int *beginpos, int *endpos) + * @fn static void parse_parent_path(const char *path, int *beginpos, int *endpos) * - * @brief Parse parent path. + * @brief Parse parent path. * - * @param path Full pathname of the file. - * @param [in,out] beginpos If non-null, the beginpos. - * @param [in,out] endpos If non-null, the endpos. + * @param path Full pathname of the file. + * @param [in,out] beginpos If non-null, the beginpos. + * @param [in,out] endpos If non-null, the endpos. */ static void parse_parent_path(const char *path, int *beginpos, int *endpos) @@ -149,14 +149,14 @@ static void parse_parent_path(const char *path, int *beginpos, int *endpos) -------------------------------------------------*/ /** - * @fn std::string &zippath_parent(std::string &dst, const char *path) + * @fn std::string &zippath_parent(std::string &dst, const char *path) * - * @brief Zippath parent. + * @brief Zippath parent. * - * @param [in,out] dst Destination for the. - * @param path Full pathname of the file. + * @param [in,out] dst Destination for the. + * @param path Full pathname of the file. * - * @return A std::string& + * @return A std::string& */ std::string &zippath_parent(std::string &dst, const char *path) @@ -182,14 +182,14 @@ std::string &zippath_parent(std::string &dst, const char *path) -------------------------------------------------*/ /** - * @fn std::string &zippath_parent_basename(std::string &dst, const char *path) + * @fn std::string &zippath_parent_basename(std::string &dst, const char *path) * - * @brief Zippath parent basename. + * @brief Zippath parent basename. * - * @param [in,out] dst Destination for the. - * @param path Full pathname of the file. + * @param [in,out] dst Destination for the. + * @param path Full pathname of the file. * - * @return A std::string& + * @return A std::string& */ std::string &zippath_parent_basename(std::string &dst, const char *path) @@ -207,15 +207,15 @@ std::string &zippath_parent_basename(std::string &dst, const char *path) -------------------------------------------------*/ /** - * @fn std::string &zippath_combine(std::string &dst, const char *path1, const char *path2) + * @fn std::string &zippath_combine(std::string &dst, const char *path1, const char *path2) * - * @brief Zippath combine. + * @brief Zippath combine. * - * @param [in,out] dst Destination for the. - * @param path1 The first path. - * @param path2 The second path. + * @param [in,out] dst Destination for the. + * @param path1 The first path. + * @param path2 The second path. * - * @return A std::string& + * @return A std::string& */ std::string &zippath_combine(std::string &dst, const char *path1, const char *path2) @@ -255,13 +255,13 @@ std::string &zippath_combine(std::string &dst, const char *path1, const char *pa -------------------------------------------------*/ /** - * @fn static file_error file_error_from_zip_error(zip_error ziperr) + * @fn static file_error file_error_from_zip_error(zip_error ziperr) * - * @brief File error from zip error. + * @brief File error from zip error. * - * @param ziperr The ziperr. + * @param ziperr The ziperr. * - * @return A file_error. + * @return A file_error. */ static file_error file_error_from_zip_error(zip_error ziperr) @@ -298,15 +298,15 @@ static file_error file_error_from_zip_error(zip_error ziperr) -------------------------------------------------*/ /** - * @fn static file_error create_core_file_from_zip(zip_file *zip, const zip_file_header *header, core_file *&file) + * @fn static file_error create_core_file_from_zip(zip_file *zip, const zip_file_header *header, core_file *&file) * - * @brief Creates core file from zip. + * @brief Creates core file from zip. * - * @param [in,out] zip If non-null, the zip. - * @param header The header. - * @param [in,out] file [in,out] If non-null, the file. + * @param [in,out] zip If non-null, the zip. + * @param header The header. + * @param [in,out] file [in,out] If non-null, the file. * - * @return The new core file from zip. + * @return The new core file from zip. */ static file_error create_core_file_from_zip(zip_file *zip, const zip_file_header *header, core_file *&file) @@ -345,16 +345,16 @@ done: -------------------------------------------------*/ /** - * @fn file_error zippath_fopen(const char *filename, UINT32 openflags, core_file *&file, std::string &revised_path) + * @fn file_error zippath_fopen(const char *filename, UINT32 openflags, core_file *&file, std::string &revised_path) * - * @brief Zippath fopen. + * @brief Zippath fopen. * - * @param filename Filename of the file. - * @param openflags The openflags. - * @param [in,out] file [in,out] If non-null, the file. - * @param [in,out] revised_path Full pathname of the revised file. + * @param filename Filename of the file. + * @param openflags The openflags. + * @param [in,out] file [in,out] If non-null, the file. + * @param [in,out] revised_path Full pathname of the revised file. * - * @return A file_error. + * @return A file_error. */ file_error zippath_fopen(const char *filename, UINT32 openflags, core_file *&file, std::string &revised_path) @@ -487,13 +487,13 @@ done: -------------------------------------------------*/ /** - * @fn static int is_root(const char *path) + * @fn static int is_root(const char *path) * - * @brief Is root. + * @brief Is root. * - * @param path Full pathname of the file. + * @param path Full pathname of the file. * - * @return An int. + * @return An int. */ static int is_root(const char *path) @@ -519,13 +519,13 @@ static int is_root(const char *path) -------------------------------------------------*/ /** - * @fn static int is_7z_file(const char *path) + * @fn static int is_7z_file(const char *path) * - * @brief Is 7z file. + * @brief Is 7z file. * - * @param path Full pathname of the file. + * @param path Full pathname of the file. * - * @return An int. + * @return An int. */ static int is_7z_file(const char *path) @@ -541,13 +541,13 @@ static int is_7z_file(const char *path) -------------------------------------------------*/ /** - * @fn static int is_zip_file(const char *path) + * @fn static int is_zip_file(const char *path) * - * @brief Is zip file. + * @brief Is zip file. * - * @param path Full pathname of the file. + * @param path Full pathname of the file. * - * @return An int. + * @return An int. */ static int is_zip_file(const char *path) @@ -564,13 +564,13 @@ static int is_zip_file(const char *path) -------------------------------------------------*/ /** - * @fn static int is_zip_file_separator(char c) + * @fn static int is_zip_file_separator(char c) * - * @brief Is zip file separator. + * @brief Is zip file separator. * - * @param c The character. + * @param c The character. * - * @return An int. + * @return An int. */ static int is_zip_file_separator(char c) @@ -586,13 +586,13 @@ static int is_zip_file_separator(char c) -------------------------------------------------*/ /** - * @fn static int is_zip_path_separator(char c) + * @fn static int is_zip_path_separator(char c) * - * @brief Is zip path separator. + * @brief Is zip path separator. * - * @param c The character. + * @param c The character. * - * @return An int. + * @return An int. */ static int is_zip_path_separator(char c) @@ -608,14 +608,14 @@ static int is_zip_path_separator(char c) -------------------------------------------------*/ /** - * @fn static char next_path_char(const char *s, int *pos) + * @fn static char next_path_char(const char *s, int *pos) * - * @brief Next path character. + * @brief Next path character. * - * @param s The const char * to process. - * @param [in,out] pos If non-null, the position. + * @param s The const char * to process. + * @param [in,out] pos If non-null, the position. * - * @return A char. + * @return A char. */ static char next_path_char(const char *s, int *pos) @@ -661,15 +661,15 @@ static char next_path_char(const char *s, int *pos) -------------------------------------------------*/ /** - * @fn static const zip_file_header *zippath_find_sub_path(zip_file *zipfile, const char *subpath, osd_dir_entry_type *type) + * @fn static const zip_file_header *zippath_find_sub_path(zip_file *zipfile, const char *subpath, osd_dir_entry_type *type) * - * @brief Zippath find sub path. + * @brief Zippath find sub path. * - * @param [in,out] zipfile If non-null, the zipfile. - * @param subpath The subpath. - * @param [in,out] type If non-null, the type. + * @param [in,out] zipfile If non-null, the zipfile. + * @param subpath The subpath. + * @param [in,out] type If non-null, the type. * - * @return null if it fails, else a zip_file_header*. + * @return null if it fails, else a zip_file_header*. */ static const zip_file_header *zippath_find_sub_path(zip_file *zipfile, const char *subpath, osd_dir_entry_type *type) @@ -726,16 +726,16 @@ static const zip_file_header *zippath_find_sub_path(zip_file *zipfile, const cha -------------------------------------------------*/ /** - * @fn static file_error zippath_resolve(const char *path, osd_dir_entry_type &entry_type, zip_file *&zipfile, std::string &newpath) + * @fn static file_error zippath_resolve(const char *path, osd_dir_entry_type &entry_type, zip_file *&zipfile, std::string &newpath) * - * @brief Zippath resolve. + * @brief Zippath resolve. * - * @param path Full pathname of the file. - * @param [in,out] entry_type Type of the entry. - * @param [in,out] zipfile [in,out] If non-null, the zipfile. - * @param [in,out] newpath The newpath. + * @param path Full pathname of the file. + * @param [in,out] entry_type Type of the entry. + * @param [in,out] zipfile [in,out] If non-null, the zipfile. + * @param [in,out] newpath The newpath. * - * @return A file_error. + * @return A file_error. */ static file_error zippath_resolve(const char *path, osd_dir_entry_type &entry_type, zip_file *&zipfile, std::string &newpath) @@ -834,14 +834,14 @@ done: -------------------------------------------------*/ /** - * @fn file_error zippath_opendir(const char *path, zippath_directory **directory) + * @fn file_error zippath_opendir(const char *path, zippath_directory **directory) * - * @brief Zippath opendir. + * @brief Zippath opendir. * - * @param path Full pathname of the file. - * @param [in,out] directory If non-null, pathname of the directory. + * @param path Full pathname of the file. + * @param [in,out] directory If non-null, pathname of the directory. * - * @return A file_error. + * @return A file_error. */ file_error zippath_opendir(const char *path, zippath_directory **directory) @@ -905,11 +905,11 @@ done: -------------------------------------------------*/ /** - * @fn void zippath_closedir(zippath_directory *directory) + * @fn void zippath_closedir(zippath_directory *directory) * - * @brief Zippath closedir. + * @brief Zippath closedir. * - * @param [in,out] directory If non-null, pathname of the directory. + * @param [in,out] directory If non-null, pathname of the directory. */ void zippath_closedir(zippath_directory *directory) @@ -938,14 +938,14 @@ void zippath_closedir(zippath_directory *directory) -------------------------------------------------*/ /** - * @fn static const char *get_relative_path(zippath_directory *directory, const zip_file_header *header) + * @fn static const char *get_relative_path(zippath_directory *directory, const zip_file_header *header) * - * @brief Gets relative path. + * @brief Gets relative path. * - * @param [in,out] directory If non-null, pathname of the directory. - * @param header The header. + * @param [in,out] directory If non-null, pathname of the directory. + * @param header The header. * - * @return null if it fails, else the relative path. + * @return null if it fails, else the relative path. */ static const char *get_relative_path(zippath_directory *directory, const zip_file_header *header) @@ -970,13 +970,13 @@ static const char *get_relative_path(zippath_directory *directory, const zip_fil -------------------------------------------------*/ /** - * @fn const osd_directory_entry *zippath_readdir(zippath_directory *directory) + * @fn const osd_directory_entry *zippath_readdir(zippath_directory *directory) * - * @brief Zippath readdir. + * @brief Zippath readdir. * - * @param [in,out] directory If non-null, pathname of the directory. + * @param [in,out] directory If non-null, pathname of the directory. * - * @return null if it fails, else an osd_directory_entry*. + * @return null if it fails, else an osd_directory_entry*. */ const osd_directory_entry *zippath_readdir(zippath_directory *directory) @@ -1086,13 +1086,13 @@ const osd_directory_entry *zippath_readdir(zippath_directory *directory) -------------------------------------------------*/ /** - * @fn int zippath_is_zip(zippath_directory *directory) + * @fn int zippath_is_zip(zippath_directory *directory) * - * @brief Zippath is zip. + * @brief Zippath is zip. * - * @param [in,out] directory If non-null, pathname of the directory. + * @param [in,out] directory If non-null, pathname of the directory. * - * @return An int. + * @return An int. */ int zippath_is_zip(zippath_directory *directory) |
