aomdx.h: Normalize codec control comments Bug: aomedia:3223 Change-Id: Ia3a351899bbab04fb506ed10f038a6b8f8ec20f4 (cherry picked from commit 8ca6f2f27f9517de2ac5576b25ab9ada575553cb)
diff --git a/aom/aomdx.h b/aom/aomdx.h index 7842be8..de9cb8c 100644 --- a/aom/aomdx.h +++ b/aom/aomdx.h
@@ -209,14 +209,16 @@ AOMD_GET_LAST_REF_USED, /*!\brief Codec control function to get the dimensions that the current - * frame is decoded at, int* parameter. This may be different to the - * intended display size for the frame as specified in the wrapper or frame - * header (see AV1D_GET_DISPLAY_SIZE). + * frame is decoded at, int* parameter + * + * This may be different to the intended display size for the frame as + * specified in the wrapper or frame header (see AV1D_GET_DISPLAY_SIZE). */ AV1D_GET_FRAME_SIZE, /*!\brief Codec control function to get the current frame's intended display - * dimensions (as specified in the wrapper or frame header), int* parameter. + * dimensions (as specified in the wrapper or frame header), int* parameter + * * This may be different to the decoded dimensions of this frame (see * AV1D_GET_FRAME_SIZE). */ @@ -232,12 +234,13 @@ */ AV1D_GET_IMG_FORMAT, - /*!\brief Codec control function to get the size of the tile, unsigned int - parameter */ + /*!\brief Codec control function to get the size of the tile, unsigned int* + * parameter + */ AV1D_GET_TILE_SIZE, - /*!\brief Codec control function to get the tile count in a tile list, int* - * parameter + /*!\brief Codec control function to get the tile count in a tile list, + * unsigned int* parameter */ AV1D_GET_TILE_COUNT, @@ -301,7 +304,8 @@ AV1_SET_DECODE_TILE_ROW, AV1_SET_DECODE_TILE_COL, - /*!\brief Codec control function to set the tile coding mode, int parameter + /*!\brief Codec control function to set the tile coding mode, unsigned int + * parameter * * - 0 = tiles are coded in normal tile mode * - 1 = tiles are coded in large-scale tile mode @@ -309,7 +313,7 @@ AV1_SET_TILE_MODE, /*!\brief Codec control function to get the frame header information of an - * encoded frame, unsigned int* parameter + * encoded frame, aom_tile_data* parameter */ AV1D_GET_FRAME_HEADER_INFO, @@ -355,7 +359,7 @@ AV1D_SET_OPERATING_POINT, /*!\brief Codec control function to indicate whether to output one frame per - * temporal unit (the default), or one frame per spatial layer. int parameter + * temporal unit (the default), or one frame per spatial layer, int parameter * * In a scalable stream, each temporal unit corresponds to a single "frame" * of video, and within a temporal unit there may be multiple spatial layers @@ -382,47 +386,59 @@ */ AV1D_SET_SKIP_FILM_GRAIN, - /*!\brief Codec control function to check the presence of forward key frames + /*!\brief Codec control function to check the presence of forward key frames, + * int* parameter */ AOMD_GET_FWD_KF_PRESENT, /*!\brief Codec control function to get the frame flags of the previous frame - * decoded. This will return a flag of type aom_codec_frame_flags_t. + * decoded, int* parameter + * + * This will return a flag of type aom_codec_frame_flags_t. */ AOMD_GET_FRAME_FLAGS, - /*!\brief Codec control function to check the presence of altref frames */ + /*!\brief Codec control function to check the presence of altref frames, int* + * parameter + */ AOMD_GET_ALTREF_PRESENT, /*!\brief Codec control function to get tile information of the previous frame - * decoded. This will return a struct of type aom_tile_info. + * decoded, aom_tile_info* parameter + * + * This will return a struct of type aom_tile_info. */ AOMD_GET_TILE_INFO, - /*!\brief Codec control function to get screen content tools information. + /*!\brief Codec control function to get screen content tools information, + * aom_screen_content_tools_info* parameter + * * It returns a struct of type aom_screen_content_tools_info, which contains * the header flags allow_screen_content_tools, allow_intrabc, and * force_integer_mv. */ AOMD_GET_SCREEN_CONTENT_TOOLS_INFO, - /*!\brief Codec control function to get the still picture coding information + /*!\brief Codec control function to get the still picture coding information, + * aom_still_picture_info* parameter */ AOMD_GET_STILL_PICTURE, - /*!\brief Codec control function to get superblock size. - * It returns an integer, indicating the superblock size - * read from the sequence header(0 for BLOCK_64X64 and - * 1 for BLOCK_128X128) + /*!\brief Codec control function to get superblock size, + * aom_superblock_size_t* parameter + * + * It returns an enum, indicating the superblock size read from the sequence + * header(0 for BLOCK_64X64 and 1 for BLOCK_128X128) */ AOMD_GET_SB_SIZE, /*!\brief Codec control function to check if the previous frame - * decoded has show existing frame flag set. + * decoded has show existing frame flag set, int* parameter */ AOMD_GET_SHOW_EXISTING_FRAME_FLAG, - /*!\brief Codec control function to get the S_FRAME coding information + /*!\brief Codec control function to get the S_FRAME coding information, + * aom_s_frame_info* parameter */ AOMD_GET_S_FRAME_INFO,