diff --git a/.gitignore b/.gitignore index 2c74351..25478cc 100644 --- a/.gitignore +++ b/.gitignore @@ -15,7 +15,8 @@ # Precompiled Headers *.gch *.pch -src/config.h +RSPTerrainLib/src/config.h +RSETerrain/src/config.h # Libraries *.lib diff --git a/CMakeLists.txt b/CMakeLists.txt index 29061a9..cf1ceb5 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,67 +1,78 @@ # CMakeLists.txt -# Written by JackCarterSmith, 2021 +#################################################### +# Written by JackCarterSmith, 2022 # This code is released under the RSE license. +#################################################### -cmake_minimum_required(VERSION 3.1) -cmake_policy(VERSION 3.1) + +# CMake requirement and general configuration +cmake_minimum_required(VERSION 3.12) +cmake_policy(VERSION 3.12) set(CMAKE_MODULE_PATH ${CMAKE_BINARY_DIR}) - -# define project -#add_definitions(-DCONF_NO_GL) -if(DEFINED ENV{CI}) - project(rse-texture VERSION 1.0.1.$ENV{CI_BUILD_NUMBER} DESCRIPTION "RogueSquadron Extractor - Texture" LANGUAGES C) - set(RSE_TEX_NAME $ENV{CI_OUTPUT_NAME}-${PROJECT_VERSION}) -else() - project(rse-texture VERSION 1.0.1 DESCRIPTION "RogueSquadron Extractor - Texture" LANGUAGES C) - set(RSE_TEX_NAME RSE_Texture-${PROJECT_VERSION}) +if(DEFINED ENV{MS_COMPATIBLE}) + set(CMAKE_GNUtoMS ON) # Enable compatibility level to exported libraries endif() -configure_file(${CMAKE_CURRENT_SOURCE_DIR}/src/config.h.in ${CMAKE_CURRENT_SOURCE_DIR}/src/config.h @ONLY) -include(CheckIncludeFile) -include(CheckCSourceCompiles) -#include(${CMAKE_BINARY_DIR}/conanbuildinfo.cmake) -#conan_basic_setup() -# needed packages - -find_package(ZLIB 1.2.11 EXACT REQUIRED) -include_directories(${ZLIB_INCLUDE_DIR}) -find_package(PNG 1.6.37 EXACT REQUIRED) -include_directories(${PNG_INCLUDE_DIR}) - -# define src/headers files - -FILE(GLOB_RECURSE RSE_TEX_SRCS src/*.c) -FILE(GLOB_RECURSE RSE_TEX_HRDS src/*.h) -SOURCE_GROUP("Source Files" FILES ${RSE_TEX_SRCS}) -SOURCE_GROUP("Header Files" FILES ${RSE_TEX_HRDS}) - -# begin building RSE-Texture - -#set(CMAKE_BUILD_TYPE Debug) -#include_directories(${CMAKE_CURRENT_SOURCE_DIR}) -add_executable(rse-texture ${RSE_TEX_SRCS} ${RSE_TEX_HRDS}) -#set_property(TARGET rse-texture PROPERTY C_STANDARD 99) -set_target_properties(rse-texture PROPERTIES OUTPUT_NAME ${RSE_TEX_NAME}) -if(MSVC) - # msvc does not append 'lib' - do it here to have consistent name - #set_target_properties(rse-texture PROPERTIES PREFIX "lib") - set_target_properties(rse-texture PROPERTIES IMPORT_PREFIX "lib") +# Project definition +if(DEFINED ENV{CI}) # Jenkins CI integration mode + project(rse-texture VERSION $ENV{CI_VERSION}.$ENV{CI_BUILD_NUMBER} DESCRIPTION "RogueSquadron Extractor - Texture" LANGUAGES C) + set(RSE_TEXTURE_NAME $ENV{CI_OUTPUT_NAME}) +else() # Standalone project mode, should not be used for release. + project(rse-texture VERSION 2.0.0 DESCRIPTION "RogueSquadron Extractor - Texture" LANGUAGES C) + set(RSE_TEXTURE_NAME RSETexture) endif() -target_link_libraries(rse-texture ${ZLIB_LIBRARIES} ${PNG_LIBRARIES}) +set(RSP_TEXTURE_LIB_NAME RSPTexture${PROJECT_VERSION_MAJOR}${PROJECT_VERSION_MINOR}) +set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall") -# add GPG signature command +# Compilation option +option(RSPTEXTURE_SHARED "Build shared lib" ON) + +# Push compile infos to source +configure_file(${CMAKE_CURRENT_SOURCE_DIR}/config.h.in ${CMAKE_CURRENT_SOURCE_DIR}/RSPTextureLib/src/config.h @ONLY) +#configure_file(${CMAKE_CURRENT_SOURCE_DIR}/config.h.in ${CMAKE_CURRENT_SOURCE_DIR}/RSETexture/src/config.h @ONLY) + + +# The project is divided in two parts: +# - RSPTextureLib is the parser library for textures data, it's take HMT file as input and output extracted datas. +# It is intended to be used by others apps like rendering engine or others. +# - RSETexture is the standalone application of the library, take HMT file in argument and output PNG file. +# Artists or users can directly use this program to retrieve data in common datas format. +set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/bin) +set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/lib) +set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/lib) +add_subdirectory(RSPTextureLib) +add_subdirectory(RSETexture) + + +# GPG signature custom command #add_custom_command( # OUTPUT "" # COMMAND gpg --batch --detach-sign -# -o ${RSE_TEX_NAME}_${CI_SYS_TARGET}.gpg -# ${RSE_TEX_NAME} -# DEPENDS ${RSE_TEX_NAME} +# -o ${RSE_MOD_NAME}_${CI_SYS_TARGET}.gpg +# ${RSE_MOD_NAME} +# DEPENDS ${RSE_MOD_NAME} # VERBATIM #) -# install executable -install(TARGETS rse-texture - RUNTIME DESTINATION bin -) \ No newline at end of file + +# Install project executable +set(INSTALL_BIN_DIR "${CMAKE_INSTALL_PREFIX}/bin" CACHE PATH "Installation directory for executables") +set(INSTALL_LIB_DIR "${CMAKE_INSTALL_PREFIX}/lib" CACHE PATH "Installation directory for libraries") +set(INSTALL_INC_DIR "${CMAKE_INSTALL_PREFIX}/include" CACHE PATH "Installation directory for headers") +if(RSPTEXTURE_SHARED) + set(RSE_TEXTURE_TARGETS_LIST rse-texture rsp-texture-lib rsp-texture-libstatic) +else() + set(RSE_TEXTURE_TARGETS_LIST rse-texture rsp-texture-libstatic) +endif() +install(TARGETS ${RSE_TEXTURE_TARGETS_LIST} + RUNTIME DESTINATION ${INSTALL_BIN_DIR} + LIBRARY DESTINATION ${INSTALL_LIB_DIR} + ARCHIVE DESTINATION ${INSTALL_LIB_DIR} +) +# Install library includes +install(FILES ${RSP_PUBLIC_HRDS} DESTINATION ${INSTALL_INC_DIR}) +# Install dependancies +install(FILES ${PROJECT_BINARY_DIR}/bin/libpng16.dll + DESTINATION ${INSTALL_BIN_DIR}) diff --git a/Jenkinsfile b/Jenkinsfile index 5f8de41..bc01dc7 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -1,77 +1,79 @@ pipeline { - agent any - options { - skipDefaultCheckout(true) - } - environment { - CI_OUTPUT_NAME = "RSE_Texture" - CI_BUILD_NUMBER = "$BUILD_NUMBER" - } - stages { - stage('Prepare') { - steps { - cleanWs() - rtConanClient(id: "conan", userHome: "/home/jackcartersmith") - } - } - stage('Build') { - steps { - parallel( - linux: { - dir("linux") { - checkout([$class: 'GitSCM', branches: [[name: '**']], browser: [$class: 'GiteaBrowser', repoUrl: 'https://git.jcsmith.fr/JCS-Prod/RSE-Texture'], extensions: [], userRemoteConfigs: [[credentialsId: 'jenkins-ssh', url: 'ssh://git@git.jcsmith.fr:2322/JCS-Prod/RSE-Texture.git']]]) - dir("build") { - rtConanRun(clientId: "conan", command: "install .. --build missing") - } - cmakeBuild buildDir: 'build', installation: 'latest', steps: [[args: 'all']] - } - }, - windows: { - dir("windows") { - checkout([$class: 'GitSCM', branches: [[name: '**']], browser: [$class: 'GiteaBrowser', repoUrl: 'https://git.jcsmith.fr/JCS-Prod/RSE-Texture'], extensions: [], userRemoteConfigs: [[credentialsId: 'jenkins-ssh', url: 'ssh://git@git.jcsmith.fr:2322/JCS-Prod/RSE-Texture.git']]]) - dir("build") { - rtConanRun(clientId: "conan", command: "install .. --profile windows --build missing") - } - cmakeBuild buildDir: 'build', cmakeArgs: '-DGNU_HOST=x86_64-w64-mingw32 -DCMAKE_TOOLCHAIN_FILE=../mingw_cross_toolchain.cmake', installation: 'latest', steps: [[args: 'all']] - } - } - ) - } - } - stage('Deploy') { - steps { - dir("zip_linux") { - sh 'cp ../linux/build/${CI_OUTPUT_NAME}-1.0.1.${BUILD_NUMBER}* .' - } - dir("zip_win") { - sh 'cp ../windows/build/${CI_OUTPUT_NAME}-1.0.1.${BUILD_NUMBER}* ../windows/build/*.dll .' - } - zip archive: false, dir: 'zip_linux', exclude: '', glob: '', zipFile: 'x64.zip' - sh 'mv x64.zip ${CI_OUTPUT_NAME}-1.0.1.${BUILD_NUMBER}_x64.zip' - zip archive: false, dir: 'zip_win', exclude: '', glob: '', zipFile: 'mingw64.zip' - sh 'mv mingw64.zip ${CI_OUTPUT_NAME}-1.0.1.${BUILD_NUMBER}_mingw64.zip' - archiveArtifacts(artifacts: '*.zip') - fingerprint(targets: '*.zip') - } - } - stage('Sign') { - steps { - sh 'ls -l' - sh 'gpg --batch --detach-sign -o ${CI_OUTPUT_NAME}-1.0.1.${BUILD_NUMBER}_x64.zip.gpg ${CI_OUTPUT_NAME}-1.0.1.${BUILD_NUMBER}_x64.zip' - sh 'gpg --batch --detach-sign -o ${CI_OUTPUT_NAME}-1.0.1.${BUILD_NUMBER}_mingw64.zip.gpg ${CI_OUTPUT_NAME}-1.0.1.${BUILD_NUMBER}_mingw64.zip' - archiveArtifacts(artifacts: '*.gpg') - fingerprint(targets: '*.gpg') - } - } - } - /* - post { - always { - cleanWs(cleanWhenNotBuilt: false, - deleteDirs: true, - disableDeferredWipeout: true, - notFailBuild: true) - } - } - */ + agent any + options { + skipDefaultCheckout(true) + } + environment { + CI_OUTPUT_NAME = "RSETexture" + CI_VERSION = "2.0.0" + CI_BUILD_NUMBER = "$BUILD_NUMBER" + } + stages { + stage('Prepare') { + steps { + cleanWs() + rtConanClient(id: "conan", userHome: "/home/jackcartersmith") + } + } + stage('Build') { + steps { + parallel( + linux: { + dir("linux") { + checkout([$class: 'GitSCM', branches: [[name: '**']], browser: [$class: 'GiteaBrowser', repoUrl: 'https://git.jcsmith.fr/JCS-Prod/RSE-Texture'], extensions: [], userRemoteConfigs: [[credentialsId: 'jenkins-ssh', url: 'ssh://git@git.jcsmith.fr:2322/JCS-Prod/RSE-Texture.git']]]) + sh 'git submodule update --init --recursive' + dir("build") { + rtConanRun(clientId: "conan", command: "install .. --build=missing") + } + cmakeBuild buildDir: 'build', installation: 'latest', steps: [[args: 'all']] + } + }, + windows: { + dir("windows") { + checkout([$class: 'GitSCM', branches: [[name: '**']], browser: [$class: 'GiteaBrowser', repoUrl: 'https://git.jcsmith.fr/JCS-Prod/RSE-Terrain'], extensions: [], userRemoteConfigs: [[credentialsId: 'jenkins-ssh', url: 'ssh://git@git.jcsmith.fr:2322/JCS-Prod/RSE-Texture.git']]]) + sh 'git submodule update --init --recursive' + dir("build") { + rtConanRun(clientId: "conan", command: "install .. --profile=windows --build=missing") + } + cmakeBuild buildDir: 'build', cmakeArgs: '-DGNU_HOST=x86_64-w64-mingw32 -DCMAKE_TOOLCHAIN_FILE=../cmake/mingw_cross_toolchain.cmake', installation: 'latest', steps: [[args: 'all']] + } + } + ) + } + } + stage('Deploy') { + steps { + dir("zip_linux") { + sh 'cp -R ../linux/build/bin ../linux/build/lib ../linux/RSPTextureLib/include .' + } + dir("zip_win") { + sh 'cp -R ../windows/build/bin ../windows/build/lib ../windows/RSPTextureLib/include .' + } + zip archive: false, dir: 'zip_linux', exclude: '', glob: '', zipFile: 'linux_x64.zip' + sh 'mv linux_x64.zip ${CI_OUTPUT_NAME}_${CI_VERSION}.${BUILD_NUMBER}_Linux_x86_64.zip' + zip archive: false, dir: 'zip_win', exclude: '', glob: '', zipFile: 'mingw64.zip' + sh 'mv mingw64.zip ${CI_OUTPUT_NAME}_${CI_VERSION}.${BUILD_NUMBER}_mingw64.zip' + archiveArtifacts(artifacts: '*.zip') + fingerprint(targets: '*.zip') + } + } + stage('Sign') { + steps { + sh 'gpg --batch --detach-sign -o ${CI_OUTPUT_NAME}_${CI_VERSION}.${BUILD_NUMBER}_Linux_x86_64.zip.gpg ${CI_OUTPUT_NAME}_${CI_VERSION}.${BUILD_NUMBER}_Linux_x86_64.zip' + sh 'gpg --batch --detach-sign -o ${CI_OUTPUT_NAME}_${CI_VERSION}.${BUILD_NUMBER}_mingw64.zip.gpg ${CI_OUTPUT_NAME}_${CI_VERSION}.${BUILD_NUMBER}_mingw64.zip' + archiveArtifacts(artifacts: '*.gpg') + fingerprint(targets: '*.gpg') + } + } + } + /* + post { + always { + cleanWs(cleanWhenNotBuilt: false, + deleteDirs: true, + disableDeferredWipeout: true, + notFailBuild: true) + } + } + */ } \ No newline at end of file diff --git a/LICENSE-zlib b/LICENSE-zlib deleted file mode 100644 index 1375708..0000000 --- a/LICENSE-zlib +++ /dev/null @@ -1,21 +0,0 @@ - - Copyright (C) 1995-2022 Jean-loup Gailly and Mark Adler - - This software is provided 'as-is', without any express or implied - warranty. In no event will the authors be held liable for any damages - arising from the use of this software. - - Permission is granted to anyone to use this software for any purpose, - including commercial applications, and to alter it and redistribute it - freely, subject to the following restrictions: - - 1. The origin of this software must not be misrepresented; you must not - claim that you wrote the original software. If you use this software - in a product, an acknowledgment in the product documentation would be - appreciated but is not required. - 2. Altered source versions must be plainly marked as such, and must not be - misrepresented as being the original software. - 3. This notice may not be removed or altered from any source distribution. - - Jean-loup Gailly Mark Adler - jloup@gzip.org madler@alumni.caltech.edu \ No newline at end of file diff --git a/README.md b/README.md index be175ef..1af4cb8 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ The collection consist of few independants modules, each of them deals with spec All modules are independants. This is the **'TEXTURE'** module. -:exclamation: **Master branch is ugly for now and should not be used, please take only released versions.** :exclamation: +[![Build Status](https://ci.jcsmith.fr/job/JCS-Prod/job/RSE-Texture/job/master/badge/icon)](https://ci.jcsmith.fr/job/JCS-Prod/job/RSE-Texture/job/master/) ## TEXTURE MODULE @@ -20,9 +20,13 @@ This module can do: - Manage transparent textures, - Fixed some errored RGB color encoding. +## TODO + +- Discover all last unknowns fields, etc. + ### Using -`RSE-Texture_"version" [options] ` or you can simply drag&drop hmt files on it. +`RSETexture [options] ` or you can simply drag&drop hmt files on it. A futur main program can extract all HMT files directly from DAT file. Due to issue with copyrights, I can't provide samples... You need to extract HMT files yourself. @@ -32,20 +36,19 @@ Due to issue with copyrights, I can't provide samples... You need to extract HMT ### Options - -h Print this message -- -v Activate verbose output +- -v,-vv Activate verbose/debug output mode respectively - -no-subdir Extract textures directly inside current folder ### Dependencies Necessary libs (provided only in windows release) for running and for compiling. -- zlib (1.2.11) - libpng (1.6.37) ### Compiling You can compile on both Windows (MinGW) or native Linux system thanks to CMake, you only need to adjust your dependencies on Windows or use Conan packages manager (https://conan.io). -zlib-dev (zlib1g-dev) and libpng16-dev distrib packages can be used on debian/ubuntu. +libpng16-dev distrib package can be used on debian/ubuntu. To compile, just clone and launch cmake: diff --git a/RSETexture/CMakeLists.txt b/RSETexture/CMakeLists.txt new file mode 100644 index 0000000..9a49ab8 --- /dev/null +++ b/RSETexture/CMakeLists.txt @@ -0,0 +1,43 @@ +# CMakeLists.txt + +#################################################### +# Written by JackCarterSmith, 2022 +# This code is released under the RSE license. +#################################################### + + +# General configuration +include(CheckIncludeFile) +include(CheckCSourceCompiles) + +# Import needed packages and references their include path +find_package(PNG 1.6.37 REQUIRED) +include_directories(${PNG_INCLUDE_DIR}) + + +# Define src/headers files +file(GLOB_RECURSE RSE_TEXTURE_SOURCES ./src/*.c) +source_group("Source Files" FILES ${RSE_TEXTURE_SOURCES}) + + +# Building instructions for RSE-Texture +if(DEFINED ENV{CI}) + set(CMAKE_BUILD_TYPE RELEASE) +endif() + + +# Declare standalone application +add_executable(rse-texture ${RSE_TEXTURE_SOURCES}) +set_property(TARGET rse-texture PROPERTY C_STANDARD 90) + +#target_include_directories(rse-texture PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/src) +set_target_properties(rse-texture PROPERTIES OUTPUT_NAME ${RSE_TEXTURE_NAME}) + +# Link externals libraries to the linker +if(MSVC) + # msvc does not append 'lib' - do it here to have consistent name + set_target_properties(rse-texture PROPERTIES IMPORT_PREFIX "lib") + target_link_libraries(rse-texture PRIVATE rsp-texture-libstatic ${PNG_LIBRARIES}) +else() + target_link_libraries(rse-texture PRIVATE rsp-texture-libstatic ${PNG_LIBRARIES}) +endif() diff --git a/src/HMT_Parser.c b/RSETexture/src/HMT_Parser.c similarity index 96% rename from src/HMT_Parser.c rename to RSETexture/src/HMT_Parser.c index 8311ce7..ac3dada 100644 --- a/src/HMT_Parser.c +++ b/RSETexture/src/HMT_Parser.c @@ -1,167 +1,167 @@ -#include "HMT_Parser.h" - - -HMT_FILE *parseHMTFile(FILE *hmt_src) { - int i; - HMT_FILE *_buff = NULL; - - if (hmt_src == NULL) return NULL; - _buff = calloc(1, sizeof(HMT_FILE)); - - rewind(hmt_src); //Rewind file at the start - fread(&(_buff->material_count), 4, 1, hmt_src); // Extract first usefull datas - fread(&(_buff->texture_offset), 4, 1, hmt_src); - - // Read materials - printf("[INFO] Materials detected: %d\n", _buff->material_count); - _buff->materials_list = calloc(_buff->material_count, sizeof(HMT_MATERIAL)); // Create a big list of materials entries - for (i=0; i<_buff->material_count; i++) { - // Extract materials datas - if (readMaterial(&(_buff->materials_list[i]), hmt_src) != 0) { - purgeHMTFromMemory(_buff); - return NULL; - } - } - - // Read textures - fseek(hmt_src, _buff->texture_offset, SEEK_SET); - fread(&(_buff->texture_count), 4, 1, hmt_src); - printf("[INFO] Textures detected: %d\n", _buff->texture_count); - if (_buff->texture_count > 0) { - _buff->textures_list = calloc(_buff->texture_count, sizeof(HMT_TEXTURE)); // Create a big list of textures entries - for (i=0; i<_buff->texture_count; i++) { - // Extract textures datas - if (readTexture(&(_buff->textures_list[i]), hmt_src) != 0) { - purgeHMTFromMemory(_buff); - return NULL; - } - } - } - - return _buff; -} - -int readMaterial(HMT_MATERIAL *mat, FILE *hmt_src) { - if (mat == NULL || hmt_src == NULL) return EXIT_FAILURE; - - fread(mat, sizeof(HMT_MATERIAL), 1, hmt_src); - - if (_options & 0x1) { - if (mat->zero != 0 || mat->hex_a != 0x0A) printf("\n Uncommon file detected!\n"); - printf(" Material type: %d\n Texture index: %d\n\n", mat->type_, mat->texture_index); //TODO: To develop?! - } - - return EXIT_SUCCESS; -} - -int readTexture(HMT_TEXTURE *tex, FILE *hmt_src) { - unsigned char u0,u1,bpp; - long pos; - RS_IMAGE_DESC desc; - - fread(&(tex->data_offset), 4, 1, hmt_src); - fseek(hmt_src, 28, SEEK_CUR); // Skip zeros area - fread(&(tex->palette_offset), 4, 1, hmt_src); - fread(&(tex->textureName_offset), 4, 1, hmt_src); - fread(&(tex->width), 2, 1, hmt_src); - fread(&(tex->height), 2, 1, hmt_src); - - fread(&u0, 1, 1, hmt_src); - fread(&bpp, 1, 1, hmt_src); - fread(&(tex->image.type_), 1, 1, hmt_src); - fread(&u1, 1, 1, hmt_src); - fread(&(tex->image.alpha_color._red), 1, 1, hmt_src); - fread(&(tex->image.alpha_color._green), 1, 1, hmt_src); - fread(&(tex->image.alpha_color._blue), 1, 1, hmt_src); - fread(&(tex->image.alpha_color._alpha), 1, 1, hmt_src); - - pos = ftell(hmt_src); - fseek(hmt_src, tex->textureName_offset, SEEK_SET); - fread(&(tex->name), 16, 1, hmt_src); - fseek(hmt_src, pos, SEEK_SET); - - desc = getImageDescFromType(tex->image.type_); - tex->image.paletteEntries = desc.palette_entries; - tex->image.sampleBits = desc.sample_bits; - tex->image.width = tex->width; - tex->image.height = tex->height; - - if (_options & VERBOSE_ENABLED) { - printf(" Texture name: %s\n", tex->name); - printf(" Size w: %ld h: %ld\n", tex->width, tex->height); - printf(" u0: %d u1: %d\n", u0, u1); - printf(" Texture type: %d\n", tex->image.type_); - printf(" Samplebits: %d\n", tex->image.sampleBits); - printf(" Palette entries: %d\n", tex->image.paletteEntries); - printf(" Transparent color (RGB): %X %X %X\n", tex->image.alpha_color._red, tex->image.alpha_color._green, tex->image.alpha_color._blue); - printf(" Palette offset: %d\n", tex->palette_offset); - printf(" Data offset: %d\n", tex->data_offset); - printf("\n"); - } - - if (tex->palette_offset > 0) { - if (_options & VERBOSE_ENABLED) printf("\nPalette entries: %d\n", tex->image.paletteEntries); - fseek(hmt_src, tex->palette_offset, SEEK_SET); - getPaletteFromFile(&(tex->image), hmt_src); - } - fseek(hmt_src, tex->data_offset, SEEK_SET); - getSamplesFromFile(&(tex->image), hmt_src); - decodePixels(&(tex->image)); - - fseek(hmt_src, pos, SEEK_SET); - - return EXIT_SUCCESS; -} - -int getPaletteFromFile(RS_IMAGE *img, FILE *f) { - int entries = img->paletteEntries; - - switch (entries) { - case 16: - case 256: - fread(img->palette, sizeof(PIXEL), entries, f); - break; - default: - break; - } - - return EXIT_SUCCESS; -} - -int getSamplesFromFile(RS_IMAGE *img, FILE *f) { - int sample_bits = img->sampleBits; - int size = div(img->width*img->height*sample_bits, 8).quot; - - #ifdef _WIN32 - if (f->_bufsiz >= ftell(f)+size) { - printf("[ERR] WARNING! Please fix size/sample."); - return EXIT_FAILURE; - } - #else - if (__fbufsize(f) >= ftell(f)+size) { - printf("[ERR] WARNING! Please fix size/sample."); - return EXIT_FAILURE; - } - #endif - - - img->samples = calloc(1, size); - fread(img->samples, size, 1, f); - if (img->type_ == 2) fread(img->samples, div(size, 4).quot, 1, f); - - return EXIT_SUCCESS; -} - -void purgeHMTFromMemory(HMT_FILE *_f) { - if (_f == NULL) return; - - if (_f->textures_list != NULL) { - if (_f->textures_list->image.pixels != NULL) free(_f->textures_list->image.pixels); - if (_f->textures_list->image.samples != NULL) free(_f->textures_list->image.samples); - } - free(_f->textures_list); - - if (_f->materials_list != NULL) free(_f->materials_list); - - free(_f); -} +#include "HMT_Parser.h" + + +HMT_FILE *parseHMTFile(FILE *hmt_src) { + int i; + HMT_FILE *_buff = NULL; + + if (hmt_src == NULL) return NULL; + _buff = calloc(1, sizeof(HMT_FILE)); + + rewind(hmt_src); //Rewind file at the start + fread(&(_buff->material_count), 4, 1, hmt_src); // Extract first usefull datas + fread(&(_buff->texture_offset), 4, 1, hmt_src); + + // Read materials + printf("[INFO] Materials detected: %d\n", _buff->material_count); + _buff->materials_list = calloc(_buff->material_count, sizeof(HMT_MATERIAL)); // Create a big list of materials entries + for (i=0; i<_buff->material_count; i++) { + // Extract materials datas + if (readMaterial(&(_buff->materials_list[i]), hmt_src) != 0) { + purgeHMTFromMemory(_buff); + return NULL; + } + } + + // Read textures + fseek(hmt_src, _buff->texture_offset, SEEK_SET); + fread(&(_buff->texture_count), 4, 1, hmt_src); + printf("[INFO] Textures detected: %d\n", _buff->texture_count); + if (_buff->texture_count > 0) { + _buff->textures_list = calloc(_buff->texture_count, sizeof(HMT_TEXTURE)); // Create a big list of textures entries + for (i=0; i<_buff->texture_count; i++) { + // Extract textures datas + if (readTexture(&(_buff->textures_list[i]), hmt_src) != 0) { + purgeHMTFromMemory(_buff); + return NULL; + } + } + } + + return _buff; +} + +int readMaterial(HMT_MATERIAL *mat, FILE *hmt_src) { + if (mat == NULL || hmt_src == NULL) return EXIT_FAILURE; + + fread(mat, sizeof(HMT_MATERIAL), 1, hmt_src); + + if (_options & 0x1) { + if (mat->zero != 0 || mat->hex_a != 0x0A) printf("\n Uncommon file detected!\n"); + printf(" Material type: %d\n Texture index: %d\n\n", mat->type_, mat->texture_index); //TODO: To develop?! + } + + return EXIT_SUCCESS; +} + +int readTexture(HMT_TEXTURE *tex, FILE *hmt_src) { + unsigned char u0,u1,bpp; + long pos; + RS_IMAGE_DESC desc; + + fread(&(tex->data_offset), 4, 1, hmt_src); + fseek(hmt_src, 28, SEEK_CUR); // Skip zeros area + fread(&(tex->palette_offset), 4, 1, hmt_src); + fread(&(tex->textureName_offset), 4, 1, hmt_src); + fread(&(tex->width), 2, 1, hmt_src); + fread(&(tex->height), 2, 1, hmt_src); + + fread(&u0, 1, 1, hmt_src); + fread(&bpp, 1, 1, hmt_src); + fread(&(tex->image.type_), 1, 1, hmt_src); + fread(&u1, 1, 1, hmt_src); + fread(&(tex->image.alpha_color._red), 1, 1, hmt_src); + fread(&(tex->image.alpha_color._green), 1, 1, hmt_src); + fread(&(tex->image.alpha_color._blue), 1, 1, hmt_src); + fread(&(tex->image.alpha_color._alpha), 1, 1, hmt_src); + + pos = ftell(hmt_src); + fseek(hmt_src, tex->textureName_offset, SEEK_SET); + fread(&(tex->name), 16, 1, hmt_src); + fseek(hmt_src, pos, SEEK_SET); + + desc = getImageDescFromType(tex->image.type_); + tex->image.paletteEntries = desc.palette_entries; + tex->image.sampleBits = desc.sample_bits; + tex->image.width = tex->width; + tex->image.height = tex->height; + + if (_options & VERBOSE_ENABLED) { + printf(" Texture name: %s\n", tex->name); + printf(" Size w: %ld h: %ld\n", tex->width, tex->height); + printf(" u0: %d u1: %d\n", u0, u1); + printf(" Texture type: %d\n", tex->image.type_); + printf(" Samplebits: %d\n", tex->image.sampleBits); + printf(" Palette entries: %d\n", tex->image.paletteEntries); + printf(" Transparent color (RGB): %X %X %X\n", tex->image.alpha_color._red, tex->image.alpha_color._green, tex->image.alpha_color._blue); + printf(" Palette offset: %d\n", tex->palette_offset); + printf(" Data offset: %d\n", tex->data_offset); + printf("\n"); + } + + if (tex->palette_offset > 0) { + if (_options & VERBOSE_ENABLED) printf("\nPalette entries: %d\n", tex->image.paletteEntries); + fseek(hmt_src, tex->palette_offset, SEEK_SET); + getPaletteFromFile(&(tex->image), hmt_src); + } + fseek(hmt_src, tex->data_offset, SEEK_SET); + getSamplesFromFile(&(tex->image), hmt_src); + decodePixels(&(tex->image)); + + fseek(hmt_src, pos, SEEK_SET); + + return EXIT_SUCCESS; +} + +int getPaletteFromFile(RS_IMAGE *img, FILE *f) { + int entries = img->paletteEntries; + + switch (entries) { + case 16: + case 256: + fread(img->palette, sizeof(PIXEL), entries, f); + break; + default: + break; + } + + return EXIT_SUCCESS; +} + +int getSamplesFromFile(RS_IMAGE *img, FILE *f) { + int sample_bits = img->sampleBits; + int size = div(img->width*img->height*sample_bits, 8).quot; + + #ifdef _WIN32 + if (f->_bufsiz >= ftell(f)+size) { + printf("[ERR] WARNING! Please fix size/sample."); + return EXIT_FAILURE; + } + #else + if (__fbufsize(f) >= ftell(f)+size) { + printf("[ERR] WARNING! Please fix size/sample."); + return EXIT_FAILURE; + } + #endif + + + img->samples = calloc(1, size); + fread(img->samples, size, 1, f); + if (img->type_ == 2) fread(img->samples, div(size, 4).quot, 1, f); + + return EXIT_SUCCESS; +} + +void purgeHMTFromMemory(HMT_FILE *_f) { + if (_f == NULL) return; + + if (_f->textures_list != NULL) { + if (_f->textures_list->image.pixels != NULL) free(_f->textures_list->image.pixels); + if (_f->textures_list->image.samples != NULL) free(_f->textures_list->image.samples); + } + free(_f->textures_list); + + if (_f->materials_list != NULL) free(_f->materials_list); + + free(_f); +} diff --git a/src/HMT_Parser.h b/RSETexture/src/HMT_Parser.h similarity index 96% rename from src/HMT_Parser.h rename to RSETexture/src/HMT_Parser.h index 020b1e6..3600f5c 100644 --- a/src/HMT_Parser.h +++ b/RSETexture/src/HMT_Parser.h @@ -1,111 +1,111 @@ -#ifndef HMT_PARSER_H_ -#define HMT_PARSER_H_ - -#include -#ifndef _WIN32 - #include -#endif -#include -#include "options.h" -#include "RS_images.h" - -///////////////////////////// -///// Define HMT types ////// -///////////////////////////// - -/** - * @brief Material struct inside HMT file type - * - * Actual RE material struct:\n - * 4B material entry count MC\n - * 4B offset after material entries / offset to textures\n - * MC * material entry (36B)\n - * [\n - * 2B int material/texture type:\n - * 1 - material with texture\n - * 2 - material without texture\n - * 2B int texture index\n - * 4B float (scale factor?)\n - * 4B float (always 1.0)\n - * 4B int zero\n - * 4B int 0x0A\n - * 16B name\n - * ]\n - * - * @image html hmt_materialDef.png - */ -typedef struct HMTMaterial { - short type_; /**< Material type:\n 1 = Material with texture\n 2 = Material without texture */ - short texture_index; - float unknow1,unknow2; - int zero; - int hex_a; - char name[16]; -}HMT_MATERIAL; - -/** - * @brief Texture struct inside HMT file type - * - * Actual RE texture struct:\n - * 4B int texcount Tc\n - * TC * texture entry 52B\n - * [\n - * 4B int pixel offset\n - * 28B zero\n - * 4B int palette offset, 0 = no palette\n - * 4B int texname offset\n - * 2B int width\n - * 2B int height\n - * 8B texture format [\n - * 1B int : always 1?\n - * 1B int : bits per sample?\n - * 1B int : subtype:\n - * -0 - palette 16x3B RGB, 4bit per pixel\n - * -1 - 256x3B palette RGB, 8bit per pixel\n - * -3 - RGBA 32bpp\n - * -4 - greyscale, 4bpp\n - * -5 - grayscale, 8bpp\n - * 1B int ? 0, 0x40, 0x80\n - * 4B RGBA transparent color?\n - * ]\n - * ]\n - * - * @image html hmt_textureDef.png - */ -typedef struct HMTTexture { - int data_offset; - int palette_offset; - int textureName_offset; - unsigned long width, height; - char name[16]; - RS_IMAGE image; -}HMT_TEXTURE; - -/** - * @brief Instance of HMTFile in memory - * This structure contain all parsed data for a single HMT file. - */ -typedef struct HMTFile { - int material_count; /**< Number of materials registered inside HMTFile instance. */ - int texture_offset; /**< Address from which texture data begins. */ - int texture_count; /**< Number of textures registered inside HMTFile instance. */ - HMT_MATERIAL *materials_list; /**< Starting pointer of the materials list. Managed like an array and declared as a pointer */ - HMT_TEXTURE *textures_list; /**< Starting pointer of the textures list. Managed like an array and declared as a pointer*/ -}HMT_FILE; - - -///////////////////////////// -///// Declare functions ///// -///////////////////////////// -HMT_FILE *parseHMTFile(FILE *hmt_src); -int readMaterial(HMT_MATERIAL *mat, FILE *hmt_src); -int readTexture(HMT_TEXTURE *tex, FILE *hmt_src); -HMT_MATERIAL *getMaterialFromIndex(int i); -HMT_MATERIAL *getMaterialFromName(char *matName); -HMT_TEXTURE *getTextureFromIndex(int i); -HMT_TEXTURE *getTextureFromMaterial(HMT_MATERIAL *mat); -int getPaletteFromFile(RS_IMAGE *img, FILE *f); -int getSamplesFromFile(RS_IMAGE *img, FILE *f); -void purgeHMTFromMemory(HMT_FILE *_f); - -#endif +#ifndef HMT_PARSER_H_ +#define HMT_PARSER_H_ + +#include +#ifndef _WIN32 + #include +#endif +#include +#include "options.h" +#include "RS_images.h" + +///////////////////////////// +///// Define HMT types ////// +///////////////////////////// + +/** + * @brief Material struct inside HMT file type + * + * Actual RE material struct:\n + * 4B material entry count MC\n + * 4B offset after material entries / offset to textures\n + * MC * material entry (36B)\n + * [\n + * 2B int material/texture type:\n + * 1 - material with texture\n + * 2 - material without texture\n + * 2B int texture index\n + * 4B float (scale factor?)\n + * 4B float (always 1.0)\n + * 4B int zero\n + * 4B int 0x0A\n + * 16B name\n + * ]\n + * + * @image html hmt_materialDef.png + */ +typedef struct HMTMaterial { + short type_; /**< Material type:\n 1 = Material with texture\n 2 = Material without texture */ + short texture_index; + float unknow1,unknow2; + int zero; + int hex_a; + char name[16]; +}HMT_MATERIAL; + +/** + * @brief Texture struct inside HMT file type + * + * Actual RE texture struct:\n + * 4B int texcount Tc\n + * TC * texture entry 52B\n + * [\n + * 4B int pixel offset\n + * 28B zero\n + * 4B int palette offset, 0 = no palette\n + * 4B int texname offset\n + * 2B int width\n + * 2B int height\n + * 8B texture format [\n + * 1B int : always 1?\n + * 1B int : bits per sample?\n + * 1B int : subtype:\n + * -0 - palette 16x3B RGB, 4bit per pixel\n + * -1 - 256x3B palette RGB, 8bit per pixel\n + * -3 - RGBA 32bpp\n + * -4 - greyscale, 4bpp\n + * -5 - grayscale, 8bpp\n + * 1B int ? 0, 0x40, 0x80\n + * 4B RGBA transparent color?\n + * ]\n + * ]\n + * + * @image html hmt_textureDef.png + */ +typedef struct HMTTexture { + int data_offset; + int palette_offset; + int textureName_offset; + unsigned long width, height; + char name[16]; + RS_IMAGE image; +}HMT_TEXTURE; + +/** + * @brief Instance of HMTFile in memory + * This structure contain all parsed data for a single HMT file. + */ +typedef struct HMTFile { + int material_count; /**< Number of materials registered inside HMTFile instance. */ + int texture_offset; /**< Address from which texture data begins. */ + int texture_count; /**< Number of textures registered inside HMTFile instance. */ + HMT_MATERIAL *materials_list; /**< Starting pointer of the materials list. Managed like an array and declared as a pointer */ + HMT_TEXTURE *textures_list; /**< Starting pointer of the textures list. Managed like an array and declared as a pointer*/ +}HMT_FILE; + + +///////////////////////////// +///// Declare functions ///// +///////////////////////////// +HMT_FILE *parseHMTFile(FILE *hmt_src); +int readMaterial(HMT_MATERIAL *mat, FILE *hmt_src); +int readTexture(HMT_TEXTURE *tex, FILE *hmt_src); +HMT_MATERIAL *getMaterialFromIndex(int i); +HMT_MATERIAL *getMaterialFromName(char *matName); +HMT_TEXTURE *getTextureFromIndex(int i); +HMT_TEXTURE *getTextureFromMaterial(HMT_MATERIAL *mat); +int getPaletteFromFile(RS_IMAGE *img, FILE *f); +int getSamplesFromFile(RS_IMAGE *img, FILE *f); +void purgeHMTFromMemory(HMT_FILE *_f); + +#endif diff --git a/src/Image_Exporter.c b/RSETexture/src/Image_Exporter.c similarity index 100% rename from src/Image_Exporter.c rename to RSETexture/src/Image_Exporter.c diff --git a/src/Image_Exporter.h b/RSETexture/src/Image_Exporter.h similarity index 100% rename from src/Image_Exporter.h rename to RSETexture/src/Image_Exporter.h diff --git a/src/Texture-Extractor.c b/RSETexture/src/RSETexture.c similarity index 96% rename from src/Texture-Extractor.c rename to RSETexture/src/RSETexture.c index 48b752a..8871502 100644 --- a/src/Texture-Extractor.c +++ b/RSETexture/src/RSETexture.c @@ -1,133 +1,133 @@ -/* - ================================================================================ - Name : Texture-Extractor.c - Author : JackCarterSmith - License : GPL-v3.0 - Description : DAT textures extractor to PNG format with enhanced function in C - ================================================================================ - */ - -#include "Texture-Extractor.h" - - -int _options; // Global options settings variable - -int main(int argc, char *argv[]) { - // Init buffer vars - HMT_FILE *hmt_fdatas = NULL; - int file_index; - - printf("\n*** RogueSquadron Extractor (RSE) - TEXTURE module - v%s ***\n", VERSION); - - // Check if filenames arguments exist - if (argc < 2) { - printf("\n[ERR] No input file/commands specified!\n"); - dispHelp(); - return EXIT_FAILURE; //TODO: implement own error codes system - } - _options = checkArgs(argv, argc); // Analyse program arguments - if (_options == -1) return EXIT_SUCCESS; - - // Do the work - for (file_index=(_options >> 8) & 0xFF; file_index 1) { - for (i=1; itexture_count > 0) { - if (_options & OUTPUT_DIR) createSubDir(filename); - for (i=0; itexture_count; i++) { - switch (hmt_f->textures_list[i].image.type_) { - case 0: - case 1: - case 3: - case 4: - case 5: - if (saveToPNG(&(hmt_f->textures_list[i].image), hmt_f->textures_list[i].name, filename)) { - printf("[ERR] Failed saving image file: %s\n", hmt_f->textures_list[i].name); - return EXIT_FAILURE; - } else printf("[INFO] Saved image file: %s\n", hmt_f->textures_list[i].name); - break; - default: - printf("[WARN] Can't export %s ! Image type %d not currently supported! (WIP)\n", hmt_f->textures_list[i].name, hmt_f->textures_list[i].image.type_); - } - - } - } - - return EXIT_SUCCESS; -} - -void dispHelp() { - printf("\n"); - printf("Options:\n -h Print this message\n -v Activate verbose console output\n -no-subdir Extract textures inside current folder\n"); - printf("\n"); - printf("Usage: RSE-Texture_%s [options] \n", VERSION); - printf("\n"); -} +/* + ================================================================================ + Name : Texture-Extractor.c + Author : JackCarterSmith + License : GPL-v3.0 + Description : DAT textures extractor to PNG format with enhanced function in C + ================================================================================ + */ + +#include "Texture-Extractor.h" + + +int _options; // Global options settings variable + +int main(int argc, char *argv[]) { + // Init buffer vars + HMT_FILE *hmt_fdatas = NULL; + int file_index; + + printf("\n*** RogueSquadron Extractor (RSE) - TEXTURE module - v%s ***\n", VERSION); + + // Check if filenames arguments exist + if (argc < 2) { + printf("\n[ERR] No input file/commands specified!\n"); + dispHelp(); + return EXIT_FAILURE; //TODO: implement own error codes system + } + _options = checkArgs(argv, argc); // Analyse program arguments + if (_options == -1) return EXIT_SUCCESS; + + // Do the work + for (file_index=(_options >> 8) & 0xFF; file_index 1) { + for (i=1; itexture_count > 0) { + if (_options & OUTPUT_DIR) createSubDir(filename); + for (i=0; itexture_count; i++) { + switch (hmt_f->textures_list[i].image.type_) { + case 0: + case 1: + case 3: + case 4: + case 5: + if (saveToPNG(&(hmt_f->textures_list[i].image), hmt_f->textures_list[i].name, filename)) { + printf("[ERR] Failed saving image file: %s\n", hmt_f->textures_list[i].name); + return EXIT_FAILURE; + } else printf("[INFO] Saved image file: %s\n", hmt_f->textures_list[i].name); + break; + default: + printf("[WARN] Can't export %s ! Image type %d not currently supported! (WIP)\n", hmt_f->textures_list[i].name, hmt_f->textures_list[i].image.type_); + } + + } + } + + return EXIT_SUCCESS; +} + +void dispHelp() { + printf("\n"); + printf("Options:\n -h Print this message\n -v Activate verbose console output\n -no-subdir Extract textures inside current folder\n"); + printf("\n"); + printf("Usage: RSE-Texture_%s [options] \n", VERSION); + printf("\n"); +} diff --git a/src/RS_images.c b/RSETexture/src/RS_images.c similarity index 97% rename from src/RS_images.c rename to RSETexture/src/RS_images.c index fa51456..b52ad8d 100644 --- a/src/RS_images.c +++ b/RSETexture/src/RS_images.c @@ -1,152 +1,152 @@ -#include "RS_images.h" - - -//extern int _options; // Global options settings variable - -void decodePixels(RS_IMAGE *img) { - int size; - - //img->pixels = NULL; - if (!(img->type_ == 0 || - img->type_ == 1 || - img->type_ == 2 || - img->type_ == 3 || - img->type_ == 4 || - img->type_ == 5)) return; - - size = img->height * img->width; - switch (img->sampleBits) { - case 32: - img->pixels = calloc(1, size * sizeof(PIXEL_A)); - memcpy(img->pixels, img->samples, size * sizeof(PIXEL_A)); - break; - case 4: - img->pixels = calloc(1, size * sizeof(PIXEL_A)); - if (img->paletteEntries == 0) { - convert4bitsGreyTo32bitsRGBA(img->samples, img->pixels, size, &(img->alpha_color)); - } else if (img->paletteEntries == 16) { - convert4bitsTo32bitsRGBA(img->samples, img->pixels, size, img->palette, &(img->alpha_color)); - } - break; - case 8: - if (img->paletteEntries == 0) { - img->pixels = calloc(1, size); - memcpy(img->pixels, img->samples, size); - } else if (img->paletteEntries == 256) { - img->pixels = calloc(1, size * sizeof(PIXEL_A)); - convert8bitsTo32bitsRGBA(img->samples, img->pixels, size, img->palette, &(img->alpha_color)); - } - break; - case 16: - img->pixels = calloc(1, size); - useOddBytes(img->samples, img->pixels, size); - break; - default: - break; - } -} - -int isTransparentColor(PIXEL_A *testColor, PIXEL_A *transp_color) { - if (transp_color == NULL || testColor == NULL) return -2; - - if (!(testColor->_red == transp_color->_red)) return -1; - if (!(testColor->_green == transp_color->_green)) return -1; - if (!(testColor->_blue == transp_color->_blue)) return -1; - - return 0; -} - -void convert4bitsGreyTo32bitsRGBA(unsigned char *samples_tab, PIXEL_A *pixels_tab, int sampling, PIXEL_A *transp_color) { - int i; - unsigned char v; - - for(i=0; i> 4 & 0xF) * 256, 16).quot; - pixels_tab[i*2]._green = div((v >> 4 & 0xF) * 256, 16).quot; - pixels_tab[i*2]._blue = div((v >> 4 & 0xF) * 256, 16).quot; - if (isTransparentColor(&(pixels_tab[i*2]), transp_color) == 0) pixels_tab[i*2]._alpha = 0xFF - transp_color->_alpha; else pixels_tab[i*2]._alpha = 0xFF; // Test if color is a transparent color and adjust alpha layer - pixels_tab[i*2+1]._red = div((v & 0xF) * 256, 16).quot; - pixels_tab[i*2+1]._green = div((v & 0xF) * 256, 16).quot; - pixels_tab[i*2+1]._blue = div((v & 0xF) * 256, 16).quot; - if (isTransparentColor(&(pixels_tab[i*2+1]), transp_color) == 0) pixels_tab[i*2+1]._alpha = 0xFF - transp_color->_alpha; else pixels_tab[i*2+1]._alpha = 0xFF; // Test if color is a transparent color and adjust alpha layer - } -} - -void convert4bitsTo32bitsRGBA(unsigned char *samples_tab, PIXEL_A *pixels_tab, int size, PIXEL *pal, PIXEL_A *transp_color) { - int i,index; - - for(i=0; i> 4) & 0xF]._red; - pixels_tab[i*2]._green = pal[(index >> 4) & 0xF]._green; - pixels_tab[i*2]._blue = pal[(index >> 4) & 0xF]._blue; - if (isTransparentColor(&(pixels_tab[i*2]), transp_color) == 0) pixels_tab[i*2]._alpha = 0xFF - transp_color->_alpha; else pixels_tab[i*2]._alpha = 0xFF; // Test if color is a transparent color and adjust alpha layer - pixels_tab[i*2+1]._red = pal[index & 0xF]._red; - pixels_tab[i*2+1]._green = pal[index & 0xF]._green; - pixels_tab[i*2+1]._blue = pal[index & 0xF]._blue; - if (isTransparentColor(&(pixels_tab[i*2+1]), transp_color) == 0) pixels_tab[i*2]._alpha = 0xFF - transp_color->_alpha; else pixels_tab[i*2+1]._alpha = 0xFF; // Test if color is a transparent color and adjust alpha layer - } -} - -void convert8bitsTo32bitsRGBA(unsigned char *samples_tab, PIXEL_A *pixels_tab, int size, PIXEL *pal, PIXEL_A *transp_color) { - int i,index; - - for(i=0; i_alpha; else pixels_tab[i]._alpha = 0xFF; // Test if color is a transparent color and adjust alpha layer - } -} - -void useOddBytes(unsigned char *src, PIXEL_A *dst, int size) { - int i; - - for(i=0; i<(size-1); i++) { - //dst[i] = src[i*2+1]; //FIXME: Implement optimized byte shifting - //dst[i]._red = src[i*2+1]; - //dst[i]._green = src[i*2+1]; - //dst[i]._blue = src[i*2+1]; - } -} - -PIXEL_A *pixelAt(RS_IMAGE *img, int posX , int posY) { - return img->pixels + img->width * posY + posX; -} - -RS_IMAGE_DESC getImageDescFromType(unsigned char type) { - RS_IMAGE_DESC desc; - - switch(type) { - case 0: - desc.palette_entries = 16; - desc.sample_bits = 4; - break; - case 1: - desc.palette_entries = 256; - desc.sample_bits = 8; - break; - case 2: - desc.palette_entries = 0; - desc.sample_bits = 16; - break; - case 3: - desc.palette_entries = 0; - desc.sample_bits = 32; - break; - case 4: - desc.palette_entries = 0; - desc.sample_bits = 4; - break; - case 5: - desc.palette_entries = 0; - desc.sample_bits = 8; - break; - default: - break; - } - - return desc; -} +#include "RS_images.h" + + +//extern int _options; // Global options settings variable + +void decodePixels(RS_IMAGE *img) { + int size; + + //img->pixels = NULL; + if (!(img->type_ == 0 || + img->type_ == 1 || + img->type_ == 2 || + img->type_ == 3 || + img->type_ == 4 || + img->type_ == 5)) return; + + size = img->height * img->width; + switch (img->sampleBits) { + case 32: + img->pixels = calloc(1, size * sizeof(PIXEL_A)); + memcpy(img->pixels, img->samples, size * sizeof(PIXEL_A)); + break; + case 4: + img->pixels = calloc(1, size * sizeof(PIXEL_A)); + if (img->paletteEntries == 0) { + convert4bitsGreyTo32bitsRGBA(img->samples, img->pixels, size, &(img->alpha_color)); + } else if (img->paletteEntries == 16) { + convert4bitsTo32bitsRGBA(img->samples, img->pixels, size, img->palette, &(img->alpha_color)); + } + break; + case 8: + if (img->paletteEntries == 0) { + img->pixels = calloc(1, size); + memcpy(img->pixels, img->samples, size); + } else if (img->paletteEntries == 256) { + img->pixels = calloc(1, size * sizeof(PIXEL_A)); + convert8bitsTo32bitsRGBA(img->samples, img->pixels, size, img->palette, &(img->alpha_color)); + } + break; + case 16: + img->pixels = calloc(1, size); + useOddBytes(img->samples, img->pixels, size); + break; + default: + break; + } +} + +int isTransparentColor(PIXEL_A *testColor, PIXEL_A *transp_color) { + if (transp_color == NULL || testColor == NULL) return -2; + + if (!(testColor->_red == transp_color->_red)) return -1; + if (!(testColor->_green == transp_color->_green)) return -1; + if (!(testColor->_blue == transp_color->_blue)) return -1; + + return 0; +} + +void convert4bitsGreyTo32bitsRGBA(unsigned char *samples_tab, PIXEL_A *pixels_tab, int sampling, PIXEL_A *transp_color) { + int i; + unsigned char v; + + for(i=0; i> 4 & 0xF) * 256, 16).quot; + pixels_tab[i*2]._green = div((v >> 4 & 0xF) * 256, 16).quot; + pixels_tab[i*2]._blue = div((v >> 4 & 0xF) * 256, 16).quot; + if (isTransparentColor(&(pixels_tab[i*2]), transp_color) == 0) pixels_tab[i*2]._alpha = 0xFF - transp_color->_alpha; else pixels_tab[i*2]._alpha = 0xFF; // Test if color is a transparent color and adjust alpha layer + pixels_tab[i*2+1]._red = div((v & 0xF) * 256, 16).quot; + pixels_tab[i*2+1]._green = div((v & 0xF) * 256, 16).quot; + pixels_tab[i*2+1]._blue = div((v & 0xF) * 256, 16).quot; + if (isTransparentColor(&(pixels_tab[i*2+1]), transp_color) == 0) pixels_tab[i*2+1]._alpha = 0xFF - transp_color->_alpha; else pixels_tab[i*2+1]._alpha = 0xFF; // Test if color is a transparent color and adjust alpha layer + } +} + +void convert4bitsTo32bitsRGBA(unsigned char *samples_tab, PIXEL_A *pixels_tab, int size, PIXEL *pal, PIXEL_A *transp_color) { + int i,index; + + for(i=0; i> 4) & 0xF]._red; + pixels_tab[i*2]._green = pal[(index >> 4) & 0xF]._green; + pixels_tab[i*2]._blue = pal[(index >> 4) & 0xF]._blue; + if (isTransparentColor(&(pixels_tab[i*2]), transp_color) == 0) pixels_tab[i*2]._alpha = 0xFF - transp_color->_alpha; else pixels_tab[i*2]._alpha = 0xFF; // Test if color is a transparent color and adjust alpha layer + pixels_tab[i*2+1]._red = pal[index & 0xF]._red; + pixels_tab[i*2+1]._green = pal[index & 0xF]._green; + pixels_tab[i*2+1]._blue = pal[index & 0xF]._blue; + if (isTransparentColor(&(pixels_tab[i*2+1]), transp_color) == 0) pixels_tab[i*2]._alpha = 0xFF - transp_color->_alpha; else pixels_tab[i*2+1]._alpha = 0xFF; // Test if color is a transparent color and adjust alpha layer + } +} + +void convert8bitsTo32bitsRGBA(unsigned char *samples_tab, PIXEL_A *pixels_tab, int size, PIXEL *pal, PIXEL_A *transp_color) { + int i,index; + + for(i=0; i_alpha; else pixels_tab[i]._alpha = 0xFF; // Test if color is a transparent color and adjust alpha layer + } +} + +void useOddBytes(unsigned char *src, PIXEL_A *dst, int size) { + int i; + + for(i=0; i<(size-1); i++) { + //dst[i] = src[i*2+1]; //FIXME: Implement optimized byte shifting + //dst[i]._red = src[i*2+1]; + //dst[i]._green = src[i*2+1]; + //dst[i]._blue = src[i*2+1]; + } +} + +PIXEL_A *pixelAt(RS_IMAGE *img, int posX , int posY) { + return img->pixels + img->width * posY + posX; +} + +RS_IMAGE_DESC getImageDescFromType(unsigned char type) { + RS_IMAGE_DESC desc; + + switch(type) { + case 0: + desc.palette_entries = 16; + desc.sample_bits = 4; + break; + case 1: + desc.palette_entries = 256; + desc.sample_bits = 8; + break; + case 2: + desc.palette_entries = 0; + desc.sample_bits = 16; + break; + case 3: + desc.palette_entries = 0; + desc.sample_bits = 32; + break; + case 4: + desc.palette_entries = 0; + desc.sample_bits = 4; + break; + case 5: + desc.palette_entries = 0; + desc.sample_bits = 8; + break; + default: + break; + } + + return desc; +} diff --git a/src/RS_images.h b/RSETexture/src/RS_images.h similarity index 97% rename from src/RS_images.h rename to RSETexture/src/RS_images.h index c3ceb60..f24c7c5 100644 --- a/src/RS_images.h +++ b/RSETexture/src/RS_images.h @@ -1,85 +1,85 @@ -#ifndef RS_IMAGES_H_ -#define RS_IMAGES_H_ - -#include -#include -#include -//#include "options.h" - -/** - * @brief Constant contain the number of channel inside a PIXEL definition. - */ -#define PIXEL_MEMBERS_NBR 4 - - -///////////////////////////// -///// Define new types ////// -///////////////////////////// - -/** - * @brief RGBA pixel structure, used to store datas for implementation inside PNG files. - */ -typedef struct PixelRGBA { - unsigned char _red; - unsigned char _green; - unsigned char _blue; - unsigned char _alpha; -}PIXEL_A; - -/** - * @brief RGB pixel structure, used to store datas for implementation inside PNG files, optimised version without alpha channel support. - */ -typedef struct PixelRGB { - unsigned char _red; - unsigned char _green; - unsigned char _blue; -}PIXEL; - -/** - * @brief Image definition from Rogue Squadron HMT files - */ -typedef struct RSImage { - int data_size; /**< Image bytes size */ - int width, height; - unsigned char type_; /**< Image type (0 = RBG/4bits per pixel, 1 = RBG/8bpp, 3 = RGBA/32bpp , 4 = grayscale/4bpp, 5 = grayscale/8bpp */ - unsigned char sampleBits; /**< Bits per samble */ - int paletteEntries; - PIXEL_A alpha_color; - PIXEL_A *pixels; /**< Image pixels list, managed like an array and declared as a pointer */ - unsigned char *samples; /**< Image samples list managed like an array and declared as a pointer */ - PIXEL palette[256]; /**< Image palette definition */ //TODO: Create union struct type instead -}RS_IMAGE; - -typedef struct RSImage_desc { - int palette_entries; - int sample_bits; -}RS_IMAGE_DESC; - - -///////////////////////////// -///// Declare functions ///// -///////////////////////////// - -/** - * @brief Conversion table for image type using RS_IMAGE_DESC. - * Return RS_IMAGE_DESC by providing image type as int\n - * - * Detailed conversion:\n\n - * Type 0 -> Palette entries: 16 ; Sample bits: 4\n - * Type 1 -> Palette entries: 256 ; Sample bits: 8\n - * Type 2 -> Palette entries: 0 ; Sample bits: 16\n - * Type 3 -> Palette entries: 0 ; Sample bits: 32\n - * Type 4 -> Palette entries: 0 ; Sample bits: 4\n - * Type 5 -> Palette entries: 0 ; Sample bits: 8\n - */ -RS_IMAGE_DESC getImageDescFromType(unsigned char type); //TODO: Optimise function - -int isTransparentColor(PIXEL_A *testColor, PIXEL_A *transp_color); -void convert4bitsGreyTo32bitsRGBA(unsigned char *samples_tab, PIXEL_A *pixels_tab, int sampling, PIXEL_A *transp_color); -void convert4bitsTo32bitsRGBA(unsigned char *samples_tab, PIXEL_A *pixels_tab, int size, PIXEL *pal, PIXEL_A *transp_color); -void convert8bitsTo32bitsRGBA(unsigned char *samples_tab, PIXEL_A *pixels_tab, int size, PIXEL *pal, PIXEL_A *transp_color); -void useOddBytes(unsigned char *src, PIXEL_A *dst, int size); -void decodePixels(RS_IMAGE *img); -PIXEL_A *pixelAt(RS_IMAGE *img, int posX , int posY); - -#endif +#ifndef RS_IMAGES_H_ +#define RS_IMAGES_H_ + +#include +#include +#include +//#include "options.h" + +/** + * @brief Constant contain the number of channel inside a PIXEL definition. + */ +#define PIXEL_MEMBERS_NBR 4 + + +///////////////////////////// +///// Define new types ////// +///////////////////////////// + +/** + * @brief RGBA pixel structure, used to store datas for implementation inside PNG files. + */ +typedef struct PixelRGBA { + unsigned char _red; + unsigned char _green; + unsigned char _blue; + unsigned char _alpha; +}PIXEL_A; + +/** + * @brief RGB pixel structure, used to store datas for implementation inside PNG files, optimised version without alpha channel support. + */ +typedef struct PixelRGB { + unsigned char _red; + unsigned char _green; + unsigned char _blue; +}PIXEL; + +/** + * @brief Image definition from Rogue Squadron HMT files + */ +typedef struct RSImage { + int data_size; /**< Image bytes size */ + int width, height; + unsigned char type_; /**< Image type (0 = RBG/4bits per pixel, 1 = RBG/8bpp, 3 = RGBA/32bpp , 4 = grayscale/4bpp, 5 = grayscale/8bpp */ + unsigned char sampleBits; /**< Bits per samble */ + int paletteEntries; + PIXEL_A alpha_color; + PIXEL_A *pixels; /**< Image pixels list, managed like an array and declared as a pointer */ + unsigned char *samples; /**< Image samples list managed like an array and declared as a pointer */ + PIXEL palette[256]; /**< Image palette definition */ //TODO: Create union struct type instead +}RS_IMAGE; + +typedef struct RSImage_desc { + int palette_entries; + int sample_bits; +}RS_IMAGE_DESC; + + +///////////////////////////// +///// Declare functions ///// +///////////////////////////// + +/** + * @brief Conversion table for image type using RS_IMAGE_DESC. + * Return RS_IMAGE_DESC by providing image type as int\n + * + * Detailed conversion:\n\n + * Type 0 -> Palette entries: 16 ; Sample bits: 4\n + * Type 1 -> Palette entries: 256 ; Sample bits: 8\n + * Type 2 -> Palette entries: 0 ; Sample bits: 16\n + * Type 3 -> Palette entries: 0 ; Sample bits: 32\n + * Type 4 -> Palette entries: 0 ; Sample bits: 4\n + * Type 5 -> Palette entries: 0 ; Sample bits: 8\n + */ +RS_IMAGE_DESC getImageDescFromType(unsigned char type); //TODO: Optimise function + +int isTransparentColor(PIXEL_A *testColor, PIXEL_A *transp_color); +void convert4bitsGreyTo32bitsRGBA(unsigned char *samples_tab, PIXEL_A *pixels_tab, int sampling, PIXEL_A *transp_color); +void convert4bitsTo32bitsRGBA(unsigned char *samples_tab, PIXEL_A *pixels_tab, int size, PIXEL *pal, PIXEL_A *transp_color); +void convert8bitsTo32bitsRGBA(unsigned char *samples_tab, PIXEL_A *pixels_tab, int size, PIXEL *pal, PIXEL_A *transp_color); +void useOddBytes(unsigned char *src, PIXEL_A *dst, int size); +void decodePixels(RS_IMAGE *img); +PIXEL_A *pixelAt(RS_IMAGE *img, int posX , int posY); + +#endif diff --git a/src/options.h b/RSETexture/src/options.h similarity index 100% rename from src/options.h rename to RSETexture/src/options.h diff --git a/RSPTextureLib/CMakeLists.txt b/RSPTextureLib/CMakeLists.txt new file mode 100644 index 0000000..604fcef --- /dev/null +++ b/RSPTextureLib/CMakeLists.txt @@ -0,0 +1,67 @@ +# CMakeLists.txt + +#################################################### +# Written by JackCarterSmith, 2022 +# This code is released under the RSE license. +#################################################### + + +# General library configuration +if(DEFINED ENV{MS_COMPATIBLE}) + set(CMAKE_GNUtoMS ON) # Enable compatibility level to exported libraries +endif() + +include(CheckIncludeFile) +include(CheckCSourceCompiles) + + +# Define src/headers files +file(GLOB_RECURSE RSP_TEXTURE_SOURCES ./src/*.c) +source_group("Source Files" FILES ${RSP_TEXTURE_SOURCES}) +file(GLOB RSP_PUBLIC_HRDS ./include/*.h) +set(RSP_PUBLIC_HRDS ${RSP_PUBLIC_HRDS} PARENT_SCOPE) + + +# Building instructions for RSP-Texture library +if(DEFINED ENV{CI}) + set(CMAKE_BUILD_TYPE RELEASE) +endif() + + +# Declare the shared library instance +if(RSPTEXTURE_SHARED) + add_library(rsp-texture-lib SHARED ${RSP_TEXTURE_SOURCES}) + set_property(TARGET rsp-texture-lib PROPERTY C_STANDARD 90) + + target_include_directories(rsp-texture-lib PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include) + + set_target_properties(rsp-texture-lib PROPERTIES OUTPUT_NAME ${RSP_TEXTURE_LIB_NAME}) + set_target_properties(rsp-texture-lib PROPERTIES DEFINE_SYMBOL RSPTEXTURE_DLL) + + if(MSVC) + # msvc does not append 'lib' - do it here to have consistent name + set_target_properties(rsp-texture-lib PROPERTIES PREFIX "lib") + set_target_properties(rsp-texture-lib PROPERTIES IMPORT_PREFIX "lib") + endif() +endif() + + +# Declare the static library instance +add_library(rsp-texture-libstatic STATIC ${RSP_TEXTURE_SOURCES}) +set_property(TARGET rsp-texture-libstatic PROPERTY C_STANDARD 90) + +target_include_directories(rsp-texture-libstatic PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include) + +if(NOT MSVC) + set_target_properties(rsp-texture-libstatic PROPERTIES OUTPUT_NAME "${RSP_TEXTURE_LIB_NAME}") + set_target_properties(rsp-texture-libstatic PROPERTIES CLEAN_DIRECT_OUTPUT 1) +else() + set_target_properties(rsp-texture-libstatic PROPERTIES OUTPUT_NAME "${RSP_TEXTURE_LIB_NAME}_static") + set_target_properties(rsp-texture-libstatic PROPERTIES CLEAN_DIRECT_OUTPUT 1) +endif() + +if(MSVC) + # msvc does not append 'lib' - do it here to have consistent name + set_target_properties(rsp-texture-libstatic PROPERTIES PREFIX "lib") + set_target_properties(rsp-texture-libstatic PROPERTIES IMPORT_PREFIX "lib") +endif() diff --git a/RSPTextureLib/include/RSPTexture.h b/RSPTextureLib/include/RSPTexture.h new file mode 100644 index 0000000..f208531 --- /dev/null +++ b/RSPTextureLib/include/RSPTexture.h @@ -0,0 +1,101 @@ +/** + * @file RSPTexture.h + * @date 25/08/2022 + * @author JackCarterSmith + * @copyright GPL-v3.0 + * @brief Rogue Squadron Parser texture library, used to decode HMT datas + * from original game file and access them through public interface. + * + */ + +#include "RSPTexture_datatypes.h" + +#ifndef RSPTEXTURELIB_H_ +#define RSPTEXTURELIB_H_ + + +#if defined(_MSC_VER) +# define RSPTEXTURE_ABI_EXPORT __declspec(dllexport) +# define RSPTEXTURE_ABI_IMPORT __declspec(dllimport) +#elif __GNUC__ >= 4 +# define RSPTEXTURE_ABI_EXPORT __attribute__ ((visibility("default"))) +# define RSPTEXTURE_ABI_IMPORT __attribute__ ((visibility("default"))) +#else +# define RSPTEXTURE_ABI_EXPORT +# define RSPTEXTURE_ABI_IMPORT +#endif + +#if defined(RSPTEXTURE_DLL) +# if defined(WIN32) +# if defined(RSPTEXTURE_DLLBUILD) +# define RSPTEXTURE_EXTERN extern RSPTEXTURE_ABI_EXPORT +# else +# define RSPTEXTURE_EXTERN extern RSPTEXTURE_ABI_IMPORT +# endif +# endif +#endif + +#ifndef RSPTEXTURE_EXTERN +# define RSPTEXTURE_EXTERN extern +#endif + + +#ifdef __cplusplus +extern "C" { +#endif + +/////////////////////////////////////////////////////////////////////////////// +// Library's functions declaration +/////////////////////////////////////////////////////////////////////////////// + +/** + * @brief Get the current library version. + * @return Char array of the version, escape char included. + */ +RSPTEXTURE_EXTERN char* RSPTexture_getVersion( void ); + +/** + * @brief Run texture parser for the specified file in file system. + * @details Texture library can process HMT file from file system. It's a easy + * approach using this library for debugging purpose. + * + * @param[out] hmtStruct HMT texture structure to be filled with parsed datas. + * @param[in] filePath Path to the HMT file in system. + * @param[in] params Parser options. See RSPTEXTURE_PARAMETERS. + * + * @return Error status, return RSPLIB_SUCCESS in nominal case. + */ +RSPTEXTURE_EXTERN unsigned short RSPTexture_processHMTFile( + T_RSPTEXTURE_HMT* hmtStruct, const char* const filePath, + const RSPTEXTURE_PARAMETERS params + ); + +/** + * @brief Run texture parser for the specified file in memory. + * @details Texture library can process HMT file directly stored in RAM memory, + * you must load the file beforehand through a malloc/memcpy call. + * @warning No controls routines are implemented to verify file length! + * + * @param[out] hmtStruct HMT texture structure to be filled with parsed datas. + * @param[in] memFilePtr Pointer to the beginning of the file in memory. + * @param[in] memFileSize Size of the file in bytes. + * @param[in] params Parser options. See RSPTEXTURE_PARAMETERS. + * + * @return Error status, return RSPLIB_SUCCESS in nominal case. + */ +RSPTEXTURE_EXTERN unsigned short RSPTexture_processHMTFileMemory( + T_RSPTEXTURE_HMT* hmtStruct, const void* const memFilePtr, const long memFileSize, + const RSPTEXTURE_PARAMETERS params + ); + +/** + * @brief Clean HMT object and it's childrens from memory. + * @param[in] hmtStruct Pointer to data to be cleaned up. + */ +RSPTEXTURE_EXTERN void RSPTexture_freeHMT( T_RSPTEXTURE_HMT* hmtStruct ); + +#ifdef __cplusplus +} +#endif + +#endif /* RSPTEXTURELIB_H_ */ diff --git a/RSPTextureLib/include/RSPTexture_datatypes.h b/RSPTextureLib/include/RSPTexture_datatypes.h new file mode 100644 index 0000000..08a428c --- /dev/null +++ b/RSPTextureLib/include/RSPTexture_datatypes.h @@ -0,0 +1,88 @@ +/** + * @file RSPTexture_datatypes.h + * @date 25/08/2022 + * @author JackCarterSmith + * @copyright GPL-v3.0 + * @brief RSP Texture workflow structures definitions + * + */ + +#ifndef RSPTEXTURELIB_DATATYPES_H_ +#define RSPTEXTURELIB_DATATYPES_H_ + +#ifdef __cplusplus +extern "C" { +#endif + +/////////////////////////////////////////////////////////////////////////////// +// Configuration structure +/////////////////////////////////////////////////////////////////////////////// + +typedef union u_rsptexture_parameters { + struct { + unsigned char verbose_mode:1; //!< Output simple details about ID and other "light" things. + unsigned char debug_mode:1; //!< Output all values of faces, indices and vertices and others "heavy" things. + unsigned char god_mode:1; //!< Dev only. Output experimental values. + + unsigned char reserved0:5; //!< For future use. + }; + unsigned char raw; //!< Raw options access for bit-masking or memory copy/compare. +} RSPTEXTURE_PARAMETERS ; + + +//////////////////////////////////////////////////////////////////////////////// +// Lib's structure definitions +//////////////////////////////////////////////////////////////////////////////// + +#ifndef MEMFILE +typedef char* MEMFILE; +#endif +#ifndef HEIGHTMAP_T +typedef unsigned char** HEIGHTMAP_T; +#endif +#ifndef T_VECTOR3 +typedef struct vector3 { float x,y,z; } T_VECTOR3; +#endif +#ifndef T_VERTEX +typedef T_VECTOR3 T_VERTEX; +#endif + +typedef struct rspterrain_heightmap { + unsigned short width; + unsigned short height; + + HEIGHTMAP_T heightmap; +} T_RSPTERRAIN_HEIGHTMAP ; + +typedef struct rspterrain_mesh { + unsigned short width; + unsigned short height; + + unsigned int vertices_count; + T_VERTEX* verticesmap; +} T_RSPTERRAIN_MESH ; + +typedef struct rspterrain_tile { + unsigned short texmap_id; + + unsigned char low_height; + unsigned char high_height; + + unsigned char height_values[5][5]; +} T_RSPTERRAIN_TILE; + +typedef struct rspterrain_obj { + unsigned short width; + unsigned short height; + + float height_scale; + + unsigned short tiles_count; + T_RSPTERRAIN_TILE* tilesmap; +} T_RSPTERRAIN_HMP ; + +#ifdef __cplusplus +} +#endif + +#endif /* RSPTEXTURELIB_DATATYPES_H_ */ diff --git a/RSPTextureLib/include/RSPTexture_errordefs.h b/RSPTextureLib/include/RSPTexture_errordefs.h new file mode 100644 index 0000000..3e2c289 --- /dev/null +++ b/RSPTextureLib/include/RSPTexture_errordefs.h @@ -0,0 +1,45 @@ +/** + * @file RSPTerrain_errordefs.h + * @date 22/08/2022 + * @author JackCarterSmith + * @copyright GPL-v3.0 + * @brief Errors type definition file. Used mostly by methods in this project. + * + */ + +#include + + +#ifndef RSPLIB_ERRORS_H_ +#define RSPLIB_ERRORS_H_ + +#ifdef __cplusplus +extern "C" { +#endif + +/////////////////////////////////////////////////////////////////////////////// +// Errors types definitions +/////////////////////////////////////////////////////////////////////////////// + +#ifndef NO_ERROR +#define NO_ERROR 0 // In case of dual declaration by GCC +#endif +#define RSPLIB_SUCCESS NO_ERROR //!< All is running good! + +#define RSPLIB_ERROR_GENERIC 1 //!< Misuse of the program +#define RSPLIB_ERROR_MEMORY 2 //!< Memory de/allocation failure +#define RSPLIB_ERROR_IO 3 //!< File system access failure +#define RSPLIB_ERROR_PROCESS 4 //!< Internal processing failure + +#define RSPLIB_ERROR_ARGS_NULL 16 //!< Method not NULL input expected +#define RSPLIB_ERROR_ARGS_RANGE 17 //!< Method input out of expected range + +#define RSPLIB_ERROR_MOD_DISABLED 64 //!< A necessary module hasn't been activated during compilation time + +#define RSPLIB_ERROR_REALITY_BRK -1 //!< This error can only appear in alternate reality + +#ifdef __cplusplus +} +#endif + +#endif /* RSPLIB_ERRORS_H_ */ diff --git a/RSPTextureLib/src/RSPTexture.c b/RSPTextureLib/src/RSPTexture.c new file mode 100644 index 0000000..56e2712 --- /dev/null +++ b/RSPTextureLib/src/RSPTexture.c @@ -0,0 +1,40 @@ +/** + * @file RSPTexture.c + * @date 25/08/2022 + * @author JackCarterSmith + * @copyright GPL-v3.0 + * @brief HMT textures datas parser and export to PNG format. + * + */ + +#include +#include +#include +#include "config.h" +#include "RSPTexture_errordefs.h" +#include "RSPTexture_datatypes.h" +#include "hmt_parser.h" +#include "data_builders.h" +#include "RSPTexture.h" + + +inline char* RSPTexture_getVersion( void ) { + return PRG_VERSION; +} + +unsigned short RSPTexture_processHMPFile( T_RSPTEXTURE_HMT* hmtStruct, const char* const filePath, + const RSPTEXTURE_PARAMETERS params ) { + + if ( hmtStruct == NULL || filePath == NULL ) return RSPLIB_ERROR_ARGS_NULL; + + return RSP_TextureLib_ParseHMTFile(filePath, hmtStruct, ¶ms); +} + +unsigned short RSPTexture_processHMPFileMemory( T_RSPTEXTURE_HMT* hmtStruct, const void* const memFilePtr, + const long memFileSize, const RSPTEXTURE_PARAMETERS params ) { + + if ( hmtStruct == NULL || memFilePtr == NULL ) return RSPLIB_ERROR_ARGS_NULL; + + return RSP_TextureLib_ParseHMTMemFile((MEMFILE)memFilePtr, hmtStruct, ¶ms); +} + diff --git a/RSPTextureLib/src/RS_images.c b/RSPTextureLib/src/RS_images.c new file mode 100644 index 0000000..b52ad8d --- /dev/null +++ b/RSPTextureLib/src/RS_images.c @@ -0,0 +1,152 @@ +#include "RS_images.h" + + +//extern int _options; // Global options settings variable + +void decodePixels(RS_IMAGE *img) { + int size; + + //img->pixels = NULL; + if (!(img->type_ == 0 || + img->type_ == 1 || + img->type_ == 2 || + img->type_ == 3 || + img->type_ == 4 || + img->type_ == 5)) return; + + size = img->height * img->width; + switch (img->sampleBits) { + case 32: + img->pixels = calloc(1, size * sizeof(PIXEL_A)); + memcpy(img->pixels, img->samples, size * sizeof(PIXEL_A)); + break; + case 4: + img->pixels = calloc(1, size * sizeof(PIXEL_A)); + if (img->paletteEntries == 0) { + convert4bitsGreyTo32bitsRGBA(img->samples, img->pixels, size, &(img->alpha_color)); + } else if (img->paletteEntries == 16) { + convert4bitsTo32bitsRGBA(img->samples, img->pixels, size, img->palette, &(img->alpha_color)); + } + break; + case 8: + if (img->paletteEntries == 0) { + img->pixels = calloc(1, size); + memcpy(img->pixels, img->samples, size); + } else if (img->paletteEntries == 256) { + img->pixels = calloc(1, size * sizeof(PIXEL_A)); + convert8bitsTo32bitsRGBA(img->samples, img->pixels, size, img->palette, &(img->alpha_color)); + } + break; + case 16: + img->pixels = calloc(1, size); + useOddBytes(img->samples, img->pixels, size); + break; + default: + break; + } +} + +int isTransparentColor(PIXEL_A *testColor, PIXEL_A *transp_color) { + if (transp_color == NULL || testColor == NULL) return -2; + + if (!(testColor->_red == transp_color->_red)) return -1; + if (!(testColor->_green == transp_color->_green)) return -1; + if (!(testColor->_blue == transp_color->_blue)) return -1; + + return 0; +} + +void convert4bitsGreyTo32bitsRGBA(unsigned char *samples_tab, PIXEL_A *pixels_tab, int sampling, PIXEL_A *transp_color) { + int i; + unsigned char v; + + for(i=0; i> 4 & 0xF) * 256, 16).quot; + pixels_tab[i*2]._green = div((v >> 4 & 0xF) * 256, 16).quot; + pixels_tab[i*2]._blue = div((v >> 4 & 0xF) * 256, 16).quot; + if (isTransparentColor(&(pixels_tab[i*2]), transp_color) == 0) pixels_tab[i*2]._alpha = 0xFF - transp_color->_alpha; else pixels_tab[i*2]._alpha = 0xFF; // Test if color is a transparent color and adjust alpha layer + pixels_tab[i*2+1]._red = div((v & 0xF) * 256, 16).quot; + pixels_tab[i*2+1]._green = div((v & 0xF) * 256, 16).quot; + pixels_tab[i*2+1]._blue = div((v & 0xF) * 256, 16).quot; + if (isTransparentColor(&(pixels_tab[i*2+1]), transp_color) == 0) pixels_tab[i*2+1]._alpha = 0xFF - transp_color->_alpha; else pixels_tab[i*2+1]._alpha = 0xFF; // Test if color is a transparent color and adjust alpha layer + } +} + +void convert4bitsTo32bitsRGBA(unsigned char *samples_tab, PIXEL_A *pixels_tab, int size, PIXEL *pal, PIXEL_A *transp_color) { + int i,index; + + for(i=0; i> 4) & 0xF]._red; + pixels_tab[i*2]._green = pal[(index >> 4) & 0xF]._green; + pixels_tab[i*2]._blue = pal[(index >> 4) & 0xF]._blue; + if (isTransparentColor(&(pixels_tab[i*2]), transp_color) == 0) pixels_tab[i*2]._alpha = 0xFF - transp_color->_alpha; else pixels_tab[i*2]._alpha = 0xFF; // Test if color is a transparent color and adjust alpha layer + pixels_tab[i*2+1]._red = pal[index & 0xF]._red; + pixels_tab[i*2+1]._green = pal[index & 0xF]._green; + pixels_tab[i*2+1]._blue = pal[index & 0xF]._blue; + if (isTransparentColor(&(pixels_tab[i*2+1]), transp_color) == 0) pixels_tab[i*2]._alpha = 0xFF - transp_color->_alpha; else pixels_tab[i*2+1]._alpha = 0xFF; // Test if color is a transparent color and adjust alpha layer + } +} + +void convert8bitsTo32bitsRGBA(unsigned char *samples_tab, PIXEL_A *pixels_tab, int size, PIXEL *pal, PIXEL_A *transp_color) { + int i,index; + + for(i=0; i_alpha; else pixels_tab[i]._alpha = 0xFF; // Test if color is a transparent color and adjust alpha layer + } +} + +void useOddBytes(unsigned char *src, PIXEL_A *dst, int size) { + int i; + + for(i=0; i<(size-1); i++) { + //dst[i] = src[i*2+1]; //FIXME: Implement optimized byte shifting + //dst[i]._red = src[i*2+1]; + //dst[i]._green = src[i*2+1]; + //dst[i]._blue = src[i*2+1]; + } +} + +PIXEL_A *pixelAt(RS_IMAGE *img, int posX , int posY) { + return img->pixels + img->width * posY + posX; +} + +RS_IMAGE_DESC getImageDescFromType(unsigned char type) { + RS_IMAGE_DESC desc; + + switch(type) { + case 0: + desc.palette_entries = 16; + desc.sample_bits = 4; + break; + case 1: + desc.palette_entries = 256; + desc.sample_bits = 8; + break; + case 2: + desc.palette_entries = 0; + desc.sample_bits = 16; + break; + case 3: + desc.palette_entries = 0; + desc.sample_bits = 32; + break; + case 4: + desc.palette_entries = 0; + desc.sample_bits = 4; + break; + case 5: + desc.palette_entries = 0; + desc.sample_bits = 8; + break; + default: + break; + } + + return desc; +} diff --git a/RSPTextureLib/src/RS_images.h b/RSPTextureLib/src/RS_images.h new file mode 100644 index 0000000..f24c7c5 --- /dev/null +++ b/RSPTextureLib/src/RS_images.h @@ -0,0 +1,85 @@ +#ifndef RS_IMAGES_H_ +#define RS_IMAGES_H_ + +#include +#include +#include +//#include "options.h" + +/** + * @brief Constant contain the number of channel inside a PIXEL definition. + */ +#define PIXEL_MEMBERS_NBR 4 + + +///////////////////////////// +///// Define new types ////// +///////////////////////////// + +/** + * @brief RGBA pixel structure, used to store datas for implementation inside PNG files. + */ +typedef struct PixelRGBA { + unsigned char _red; + unsigned char _green; + unsigned char _blue; + unsigned char _alpha; +}PIXEL_A; + +/** + * @brief RGB pixel structure, used to store datas for implementation inside PNG files, optimised version without alpha channel support. + */ +typedef struct PixelRGB { + unsigned char _red; + unsigned char _green; + unsigned char _blue; +}PIXEL; + +/** + * @brief Image definition from Rogue Squadron HMT files + */ +typedef struct RSImage { + int data_size; /**< Image bytes size */ + int width, height; + unsigned char type_; /**< Image type (0 = RBG/4bits per pixel, 1 = RBG/8bpp, 3 = RGBA/32bpp , 4 = grayscale/4bpp, 5 = grayscale/8bpp */ + unsigned char sampleBits; /**< Bits per samble */ + int paletteEntries; + PIXEL_A alpha_color; + PIXEL_A *pixels; /**< Image pixels list, managed like an array and declared as a pointer */ + unsigned char *samples; /**< Image samples list managed like an array and declared as a pointer */ + PIXEL palette[256]; /**< Image palette definition */ //TODO: Create union struct type instead +}RS_IMAGE; + +typedef struct RSImage_desc { + int palette_entries; + int sample_bits; +}RS_IMAGE_DESC; + + +///////////////////////////// +///// Declare functions ///// +///////////////////////////// + +/** + * @brief Conversion table for image type using RS_IMAGE_DESC. + * Return RS_IMAGE_DESC by providing image type as int\n + * + * Detailed conversion:\n\n + * Type 0 -> Palette entries: 16 ; Sample bits: 4\n + * Type 1 -> Palette entries: 256 ; Sample bits: 8\n + * Type 2 -> Palette entries: 0 ; Sample bits: 16\n + * Type 3 -> Palette entries: 0 ; Sample bits: 32\n + * Type 4 -> Palette entries: 0 ; Sample bits: 4\n + * Type 5 -> Palette entries: 0 ; Sample bits: 8\n + */ +RS_IMAGE_DESC getImageDescFromType(unsigned char type); //TODO: Optimise function + +int isTransparentColor(PIXEL_A *testColor, PIXEL_A *transp_color); +void convert4bitsGreyTo32bitsRGBA(unsigned char *samples_tab, PIXEL_A *pixels_tab, int sampling, PIXEL_A *transp_color); +void convert4bitsTo32bitsRGBA(unsigned char *samples_tab, PIXEL_A *pixels_tab, int size, PIXEL *pal, PIXEL_A *transp_color); +void convert8bitsTo32bitsRGBA(unsigned char *samples_tab, PIXEL_A *pixels_tab, int size, PIXEL *pal, PIXEL_A *transp_color); +void useOddBytes(unsigned char *src, PIXEL_A *dst, int size); +void decodePixels(RS_IMAGE *img); +PIXEL_A *pixelAt(RS_IMAGE *img, int posX , int posY); + +#endif diff --git a/src/Texture-Extractor.h b/RSPTextureLib/src/Texture-Extractor.h similarity index 91% rename from src/Texture-Extractor.h rename to RSPTextureLib/src/Texture-Extractor.h index a92aa5f..eb11aaf 100644 --- a/src/Texture-Extractor.h +++ b/RSPTextureLib/src/Texture-Extractor.h @@ -1,26 +1,26 @@ -#ifndef TEXTURE_EXTRACTOR_H_ -#define TEXTURE_EXTRACTOR_H_ - -#include -#include -#include -#if defined(_WIN32) - #include -#else - #include - #include -#endif -#include "config.h" -#include "options.h" -#include "HMT_Parser.h" -#include "RS_images.h" -#include "Image_Exporter.h" - - -void createSubDir(char *dirName); -int checkArgs(char *args[], int arg_nbr); -HMT_FILE *extractDatasFromHMT(char* hmt_filename); -int exportTextures(HMT_FILE *hmt_f, char *filename); -void dispHelp(); - -#endif +#ifndef TEXTURE_EXTRACTOR_H_ +#define TEXTURE_EXTRACTOR_H_ + +#include +#include +#include +#if defined(_WIN32) + #include +#else + #include + #include +#endif +#include "config.h" +#include "options.h" +#include "hmt_parser.h" +#include "RS_images.h" +#include "Image_Exporter.h" + + +void createSubDir(char *dirName); +int checkArgs(char *args[], int arg_nbr); +HMT_FILE *extractDatasFromHMT(char* hmt_filename); +int exportTextures(HMT_FILE *hmt_f, char *filename); +void dispHelp(); + +#endif diff --git a/RSPTextureLib/src/config.h b/RSPTextureLib/src/config.h new file mode 100644 index 0000000..9b62256 --- /dev/null +++ b/RSPTextureLib/src/config.h @@ -0,0 +1,6 @@ +#ifndef CONFIG_H_ +#define CONFIG_H_ + +#define PRG_VERSION "2.0.0" + +#endif /* CONFIG_H_ */ diff --git a/RSPTextureLib/src/hmt_parser.c b/RSPTextureLib/src/hmt_parser.c new file mode 100644 index 0000000..0475f91 --- /dev/null +++ b/RSPTextureLib/src/hmt_parser.c @@ -0,0 +1,167 @@ +#include "hmt_parser.h" + + +HMT_FILE *parseHMTFile(FILE *hmt_src) { + int i; + HMT_FILE *_buff = NULL; + + if (hmt_src == NULL) return NULL; + _buff = calloc(1, sizeof(HMT_FILE)); + + rewind(hmt_src); //Rewind file at the start + fread(&(_buff->material_count), 4, 1, hmt_src); // Extract first usefull datas + fread(&(_buff->texture_offset), 4, 1, hmt_src); + + // Read materials + printf("[INFO] Materials detected: %d\n", _buff->material_count); + _buff->materials_list = calloc(_buff->material_count, sizeof(HMT_MATERIAL)); // Create a big list of materials entries + for (i=0; i<_buff->material_count; i++) { + // Extract materials datas + if (readMaterial(&(_buff->materials_list[i]), hmt_src) != 0) { + purgeHMTFromMemory(_buff); + return NULL; + } + } + + // Read textures + fseek(hmt_src, _buff->texture_offset, SEEK_SET); + fread(&(_buff->texture_count), 4, 1, hmt_src); + printf("[INFO] Textures detected: %d\n", _buff->texture_count); + if (_buff->texture_count > 0) { + _buff->textures_list = calloc(_buff->texture_count, sizeof(HMT_TEXTURE)); // Create a big list of textures entries + for (i=0; i<_buff->texture_count; i++) { + // Extract textures datas + if (readTexture(&(_buff->textures_list[i]), hmt_src) != 0) { + purgeHMTFromMemory(_buff); + return NULL; + } + } + } + + return _buff; +} + +int readMaterial(HMT_MATERIAL *mat, FILE *hmt_src) { + if (mat == NULL || hmt_src == NULL) return EXIT_FAILURE; + + fread(mat, sizeof(HMT_MATERIAL), 1, hmt_src); + + if (_options & 0x1) { + if (mat->zero != 0 || mat->hex_a != 0x0A) printf("\n Uncommon file detected!\n"); + printf(" Material type: %d\n Texture index: %d\n\n", mat->type_, mat->texture_index); //TODO: To develop?! + } + + return EXIT_SUCCESS; +} + +int readTexture(HMT_TEXTURE *tex, FILE *hmt_src) { + unsigned char u0,u1,bpp; + long pos; + RS_IMAGE_DESC desc; + + fread(&(tex->data_offset), 4, 1, hmt_src); + fseek(hmt_src, 28, SEEK_CUR); // Skip zeros area + fread(&(tex->palette_offset), 4, 1, hmt_src); + fread(&(tex->textureName_offset), 4, 1, hmt_src); + fread(&(tex->width), 2, 1, hmt_src); + fread(&(tex->height), 2, 1, hmt_src); + + fread(&u0, 1, 1, hmt_src); + fread(&bpp, 1, 1, hmt_src); + fread(&(tex->image.type_), 1, 1, hmt_src); + fread(&u1, 1, 1, hmt_src); + fread(&(tex->image.alpha_color._red), 1, 1, hmt_src); + fread(&(tex->image.alpha_color._green), 1, 1, hmt_src); + fread(&(tex->image.alpha_color._blue), 1, 1, hmt_src); + fread(&(tex->image.alpha_color._alpha), 1, 1, hmt_src); + + pos = ftell(hmt_src); + fseek(hmt_src, tex->textureName_offset, SEEK_SET); + fread(&(tex->name), 16, 1, hmt_src); + fseek(hmt_src, pos, SEEK_SET); + + desc = getImageDescFromType(tex->image.type_); + tex->image.paletteEntries = desc.palette_entries; + tex->image.sampleBits = desc.sample_bits; + tex->image.width = tex->width; + tex->image.height = tex->height; + + if (_options & VERBOSE_ENABLED) { + printf(" Texture name: %s\n", tex->name); + printf(" Size w: %ld h: %ld\n", tex->width, tex->height); + printf(" u0: %d u1: %d\n", u0, u1); + printf(" Texture type: %d\n", tex->image.type_); + printf(" Samplebits: %d\n", tex->image.sampleBits); + printf(" Palette entries: %d\n", tex->image.paletteEntries); + printf(" Transparent color (RGB): %X %X %X\n", tex->image.alpha_color._red, tex->image.alpha_color._green, tex->image.alpha_color._blue); + printf(" Palette offset: %d\n", tex->palette_offset); + printf(" Data offset: %d\n", tex->data_offset); + printf("\n"); + } + + if (tex->palette_offset > 0) { + if (_options & VERBOSE_ENABLED) printf("\nPalette entries: %d\n", tex->image.paletteEntries); + fseek(hmt_src, tex->palette_offset, SEEK_SET); + getPaletteFromFile(&(tex->image), hmt_src); + } + fseek(hmt_src, tex->data_offset, SEEK_SET); + getSamplesFromFile(&(tex->image), hmt_src); + decodePixels(&(tex->image)); + + fseek(hmt_src, pos, SEEK_SET); + + return EXIT_SUCCESS; +} + +int getPaletteFromFile(RS_IMAGE *img, FILE *f) { + int entries = img->paletteEntries; + + switch (entries) { + case 16: + case 256: + fread(img->palette, sizeof(PIXEL), entries, f); + break; + default: + break; + } + + return EXIT_SUCCESS; +} + +int getSamplesFromFile(RS_IMAGE *img, FILE *f) { + int sample_bits = img->sampleBits; + int size = div(img->width*img->height*sample_bits, 8).quot; + + #ifdef _WIN32 + if (f->_bufsiz >= ftell(f)+size) { + printf("[ERR] WARNING! Please fix size/sample."); + return EXIT_FAILURE; + } + #else + if (__fbufsize(f) >= ftell(f)+size) { + printf("[ERR] WARNING! Please fix size/sample."); + return EXIT_FAILURE; + } + #endif + + + img->samples = calloc(1, size); + fread(img->samples, size, 1, f); + if (img->type_ == 2) fread(img->samples, div(size, 4).quot, 1, f); + + return EXIT_SUCCESS; +} + +void purgeHMTFromMemory(HMT_FILE *_f) { + if (_f == NULL) return; + + if (_f->textures_list != NULL) { + if (_f->textures_list->image.pixels != NULL) free(_f->textures_list->image.pixels); + if (_f->textures_list->image.samples != NULL) free(_f->textures_list->image.samples); + } + free(_f->textures_list); + + if (_f->materials_list != NULL) free(_f->materials_list); + + free(_f); +} diff --git a/RSPTextureLib/src/hmt_parser.h b/RSPTextureLib/src/hmt_parser.h new file mode 100644 index 0000000..3600f5c --- /dev/null +++ b/RSPTextureLib/src/hmt_parser.h @@ -0,0 +1,111 @@ +#ifndef HMT_PARSER_H_ +#define HMT_PARSER_H_ + +#include +#ifndef _WIN32 + #include +#endif +#include +#include "options.h" +#include "RS_images.h" + +///////////////////////////// +///// Define HMT types ////// +///////////////////////////// + +/** + * @brief Material struct inside HMT file type + * + * Actual RE material struct:\n + * 4B material entry count MC\n + * 4B offset after material entries / offset to textures\n + * MC * material entry (36B)\n + * [\n + * 2B int material/texture type:\n + * 1 - material with texture\n + * 2 - material without texture\n + * 2B int texture index\n + * 4B float (scale factor?)\n + * 4B float (always 1.0)\n + * 4B int zero\n + * 4B int 0x0A\n + * 16B name\n + * ]\n + * + * @image html hmt_materialDef.png + */ +typedef struct HMTMaterial { + short type_; /**< Material type:\n 1 = Material with texture\n 2 = Material without texture */ + short texture_index; + float unknow1,unknow2; + int zero; + int hex_a; + char name[16]; +}HMT_MATERIAL; + +/** + * @brief Texture struct inside HMT file type + * + * Actual RE texture struct:\n + * 4B int texcount Tc\n + * TC * texture entry 52B\n + * [\n + * 4B int pixel offset\n + * 28B zero\n + * 4B int palette offset, 0 = no palette\n + * 4B int texname offset\n + * 2B int width\n + * 2B int height\n + * 8B texture format [\n + * 1B int : always 1?\n + * 1B int : bits per sample?\n + * 1B int : subtype:\n + * -0 - palette 16x3B RGB, 4bit per pixel\n + * -1 - 256x3B palette RGB, 8bit per pixel\n + * -3 - RGBA 32bpp\n + * -4 - greyscale, 4bpp\n + * -5 - grayscale, 8bpp\n + * 1B int ? 0, 0x40, 0x80\n + * 4B RGBA transparent color?\n + * ]\n + * ]\n + * + * @image html hmt_textureDef.png + */ +typedef struct HMTTexture { + int data_offset; + int palette_offset; + int textureName_offset; + unsigned long width, height; + char name[16]; + RS_IMAGE image; +}HMT_TEXTURE; + +/** + * @brief Instance of HMTFile in memory + * This structure contain all parsed data for a single HMT file. + */ +typedef struct HMTFile { + int material_count; /**< Number of materials registered inside HMTFile instance. */ + int texture_offset; /**< Address from which texture data begins. */ + int texture_count; /**< Number of textures registered inside HMTFile instance. */ + HMT_MATERIAL *materials_list; /**< Starting pointer of the materials list. Managed like an array and declared as a pointer */ + HMT_TEXTURE *textures_list; /**< Starting pointer of the textures list. Managed like an array and declared as a pointer*/ +}HMT_FILE; + + +///////////////////////////// +///// Declare functions ///// +///////////////////////////// +HMT_FILE *parseHMTFile(FILE *hmt_src); +int readMaterial(HMT_MATERIAL *mat, FILE *hmt_src); +int readTexture(HMT_TEXTURE *tex, FILE *hmt_src); +HMT_MATERIAL *getMaterialFromIndex(int i); +HMT_MATERIAL *getMaterialFromName(char *matName); +HMT_TEXTURE *getTextureFromIndex(int i); +HMT_TEXTURE *getTextureFromMaterial(HMT_MATERIAL *mat); +int getPaletteFromFile(RS_IMAGE *img, FILE *f); +int getSamplesFromFile(RS_IMAGE *img, FILE *f); +void purgeHMTFromMemory(HMT_FILE *_f); + +#endif diff --git a/RSPTextureLib/src/hmt_struct.h b/RSPTextureLib/src/hmt_struct.h new file mode 100644 index 0000000..88fb46a --- /dev/null +++ b/RSPTextureLib/src/hmt_struct.h @@ -0,0 +1,71 @@ +/** + * @file hmp_struct.h + * @date 22/08/2022 + * @author JackCarterSmith + * @copyright GPL-v3.0 + * @brief HMP file mapping definition. + * + */ + +#ifndef RSPTERRAINLIB_HMP_STRUCT_H_ +#define RSPTERRAINLIB_HMP_STRUCT_H_ + + +/* + * long = 64bits??? (8 Bytes) + * int = 32bits (4 Bytes) + * short = 16bits (2 Bytes) + * char = 8bits (1 Bytes) + */ + +#if defined(_MSC_VER) +#define PACK +#elif defined(__GNUC__) +#define PACK __attribute__((packed)) +#endif + +/////////////////////////////////////////////////////////////////////////////// +// Declaration of Memory Mapped Structure +// Caution: the place of variable is important for correct mapping! +/////////////////////////////////////////////////////////////////////////////// + +#if defined(_MSC_VER) +#pragma pack(push, 1) +#endif + +typedef struct PACK hmpfile_header { + unsigned int reserved0; //12B of zeros + unsigned int reserved1; + unsigned int reserved2; + + float reserved3; // Always 0x3F000000 + float height_scale; + float reserved4; // Always 0x3F000000 + + unsigned short tiles_count; + unsigned short unknown0; + + unsigned int tiles_start_offset; + unsigned int unknown1; // Offset to some datas? + + unsigned short width_BLK; + unsigned short height_BLK; +} T_HMPFILE_HEADER; + +typedef unsigned short T_TILE_INDICES; + +typedef struct PACK hmpfile_tile { + unsigned short texmap_id; + + unsigned char unknown0; + unsigned char low_height; // LOD application? Clipping? Terrain render quadrants? + unsigned char high_height; + + unsigned char height_values[5][5]; // first and last row/column overlap with a neighboring tile, "glue" for tiles, need to be identical to avoid "hill" effect +} T_HMPFILE_TILE; + +#if defined(_MSC_VER) +#pragma pack(pop) +#endif + +#endif /* RSPTERRAINLIB_HMP_STRUCT_H_ */ diff --git a/mingw_cross_toolchain.cmake b/cmake/mingw_cross_toolchain.cmake similarity index 100% rename from mingw_cross_toolchain.cmake rename to cmake/mingw_cross_toolchain.cmake diff --git a/conanfile.txt b/conanfile.txt index 26b54e2..e9ea766 100644 --- a/conanfile.txt +++ b/conanfile.txt @@ -1,5 +1,4 @@ [requires] -zlib/1.2.11 libpng/1.6.37 [generators] @@ -7,8 +6,7 @@ cmake cmake_find_package [options] -zlib:shared=True libpng:shared=True [imports] -bin, *.dll -> . \ No newline at end of file +bin, *.dll -> ./bin \ No newline at end of file diff --git a/config.h.in b/config.h.in new file mode 100644 index 0000000..3f2e0c4 --- /dev/null +++ b/config.h.in @@ -0,0 +1,6 @@ +#ifndef CONFIG_H_ +#define CONFIG_H_ + +#define PRG_VERSION "@PROJECT_VERSION@" + +#endif /* CONFIG_H_ */ diff --git a/Doxyfile b/doc/Doxyfile similarity index 81% rename from Doxyfile rename to doc/Doxyfile index 8591f0c..2a86fa7 100644 --- a/Doxyfile +++ b/doc/Doxyfile @@ -1,2680 +1,2492 @@ -# Doxyfile 1.9.2 - -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project. -# -# All text after a double hash (##) is considered a comment and is placed in -# front of the TAG it is preceding. -# -# All text after a single hash (#) is considered a comment and will be ignored. -# The format is: -# TAG = value [value, ...] -# For lists, items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (\" \"). - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -# This tag specifies the encoding used for all characters in the configuration -# file that follow. The default is UTF-8 which is also the encoding used for all -# text before the first occurrence of this tag. Doxygen uses libiconv (or the -# iconv built into libc) for the transcoding. See -# https://www.gnu.org/software/libiconv/ for the list of possible encodings. -# The default value is: UTF-8. - -DOXYFILE_ENCODING = UTF-8 - -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by -# double-quotes, unless you are using Doxywizard) that should identify the -# project for which the documentation is generated. This name is used in the -# title of most generated pages and in a few other places. -# The default value is: My Project. - -PROJECT_NAME = RSE-Texture - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. This -# could be handy for archiving the generated documentation or if some version -# control system is used. - -PROJECT_NUMBER = 1.0 - -# Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer a -# quick idea about the purpose of the project. Keep the description short. - -PROJECT_BRIEF = - -# With the PROJECT_LOGO tag one can specify a logo or an icon that is included -# in the documentation. The maximum height of the logo should not exceed 55 -# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy -# the logo to the output directory. - -PROJECT_LOGO = - -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path -# into which the generated documentation will be written. If a relative path is -# entered, it will be relative to the location where doxygen was started. If -# left blank the current directory will be used. - -OUTPUT_DIRECTORY = docs - -# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- -# directories (in 2 levels) under the output directory of each output format and -# will distribute the generated files over these directories. Enabling this -# option can be useful when feeding doxygen a huge amount of source files, where -# putting all generated files in the same directory would otherwise causes -# performance problems for the file system. -# The default value is: NO. - -CREATE_SUBDIRS = NO - -# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII -# characters to appear in the names of generated files. If set to NO, non-ASCII -# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode -# U+3044. -# The default value is: NO. - -ALLOW_UNICODE_NAMES = NO - -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, -# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), -# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, -# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), -# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, -# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, -# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, -# Ukrainian and Vietnamese. -# The default value is: English. - -OUTPUT_LANGUAGE = English - -# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member -# descriptions after the members that are listed in the file and class -# documentation (similar to Javadoc). Set to NO to disable this. -# The default value is: YES. - -BRIEF_MEMBER_DESC = YES - -# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief -# description of a member or function before the detailed description -# -# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. -# The default value is: YES. - -REPEAT_BRIEF = YES - -# This tag implements a quasi-intelligent brief description abbreviator that is -# used to form the text in various listings. Each string in this list, if found -# as the leading text of the brief description, will be stripped from the text -# and the result, after processing the whole list, is used as the annotated -# text. Otherwise, the brief description is used as-is. If left blank, the -# following values are used ($name is automatically replaced with the name of -# the entity):The $name class, The $name widget, The $name file, is, provides, -# specifies, contains, represents, a, an and the. - -ABBREVIATE_BRIEF = "The $name class" \ - "The $name widget" \ - "The $name file" \ - is \ - provides \ - specifies \ - contains \ - represents \ - a \ - an \ - the - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# doxygen will generate a detailed section even if there is only a brief -# description. -# The default value is: NO. - -ALWAYS_DETAILED_SEC = NO - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. -# The default value is: NO. - -INLINE_INHERITED_MEMB = NO - -# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path -# before files name in the file list and in the header files. If set to NO the -# shortest path that makes the file name unique will be used -# The default value is: YES. - -FULL_PATH_NAMES = YES - -# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. -# Stripping is only done if one of the specified strings matches the left-hand -# part of the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the path to -# strip. -# -# Note that you can specify absolute paths here, but also relative paths, which -# will be relative from the directory where doxygen is started. -# This tag requires that the tag FULL_PATH_NAMES is set to YES. - -STRIP_FROM_PATH = - -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the -# path mentioned in the documentation of a class, which tells the reader which -# header file to include in order to use a class. If left blank only the name of -# the header file containing the class definition is used. Otherwise one should -# specify the list of include paths that are normally passed to the compiler -# using the -I flag. - -STRIP_FROM_INC_PATH = - -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but -# less readable) file names. This can be useful is your file systems doesn't -# support long names like on DOS, Mac, or CD-ROM. -# The default value is: NO. - -SHORT_NAMES = NO - -# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the -# first line (until the first dot) of a Javadoc-style comment as the brief -# description. If set to NO, the Javadoc-style will behave just like regular Qt- -# style comments (thus requiring an explicit @brief command for a brief -# description.) -# The default value is: NO. - -JAVADOC_AUTOBRIEF = YES - -# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line -# such as -# /*************** -# as being the beginning of a Javadoc-style comment "banner". If set to NO, the -# Javadoc-style will behave just like regular comments and it will not be -# interpreted by doxygen. -# The default value is: NO. - -JAVADOC_BANNER = NO - -# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first -# line (until the first dot) of a Qt-style comment as the brief description. If -# set to NO, the Qt-style will behave just like regular Qt-style comments (thus -# requiring an explicit \brief command for a brief description.) -# The default value is: NO. - -QT_AUTOBRIEF = NO - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a -# multi-line C++ special comment block (i.e. a block of //! or /// comments) as -# a brief description. This used to be the default behavior. The new default is -# to treat a multi-line C++ comment block as a detailed description. Set this -# tag to YES if you prefer the old behavior instead. -# -# Note that setting this tag to YES also means that rational rose comments are -# not recognized any more. -# The default value is: NO. - -MULTILINE_CPP_IS_BRIEF = NO - -# By default Python docstrings are displayed as preformatted text and doxygen's -# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the -# doxygen's special commands can be used and the contents of the docstring -# documentation blocks is shown as doxygen documentation. -# The default value is: YES. - -PYTHON_DOCSTRING = YES - -# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the -# documentation from any documented member that it re-implements. -# The default value is: YES. - -INHERIT_DOCS = YES - -# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new -# page for each member. If set to NO, the documentation of a member will be part -# of the file/class/namespace that contains it. -# The default value is: NO. - -SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen -# uses this value to replace tabs by spaces in code fragments. -# Minimum value: 1, maximum value: 16, default value: 4. - -TAB_SIZE = 4 - -# This tag can be used to specify a number of aliases that act as commands in -# the documentation. An alias has the form: -# name=value -# For example adding -# "sideeffect=@par Side Effects:^^" -# will allow you to put the command \sideeffect (or @sideeffect) in the -# documentation, which will result in a user-defined paragraph with heading -# "Side Effects:". Note that you cannot put \n's in the value part of an alias -# to insert newlines (in the resulting output). You can put ^^ in the value part -# of an alias to insert a newline as if a physical newline was in the original -# file. When you need a literal { or } or , in the value part of an alias you -# have to escape them by means of a backslash (\), this can lead to conflicts -# with the commands \{ and \} for these it is advised to use the version @{ and -# @} or use a double escape (\\{ and \\}) - -ALIASES = - -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources -# only. Doxygen will then generate output that is more tailored for C. For -# instance, some of the names that are used will be different. The list of all -# members will be omitted, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_FOR_C = YES - -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or -# Python sources only. Doxygen will then generate output that is more tailored -# for that language. For instance, namespaces will be presented as packages, -# qualified scopes will look different, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_JAVA = NO - -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources. Doxygen will then generate output that is tailored for Fortran. -# The default value is: NO. - -OPTIMIZE_FOR_FORTRAN = NO - -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for VHDL. -# The default value is: NO. - -OPTIMIZE_OUTPUT_VHDL = NO - -# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice -# sources only. Doxygen will then generate output that is more tailored for that -# language. For instance, namespaces will be presented as modules, types will be -# separated into more groups, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_SLICE = NO - -# Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given -# extension. Doxygen has a built-in mapping, but you can override or extend it -# using this tag. The format is ext=language, where ext is a file extension, and -# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, -# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, -# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: -# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser -# tries to guess whether the code is fixed or free formatted code, this is the -# default for Fortran type files). For instance to make doxygen treat .inc files -# as Fortran files (default is PHP), and .f files as C (default is Fortran), -# use: inc=Fortran f=C. -# -# Note: For files without extension you can use no_extension as a placeholder. -# -# Note that for custom extensions you also need to set FILE_PATTERNS otherwise -# the files are not read by doxygen. When specifying no_extension you should add -# * to the FILE_PATTERNS. -# -# Note see also the list of default file extension mappings. - -EXTENSION_MAPPING = - -# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments -# according to the Markdown format, which allows for more readable -# documentation. See https://daringfireball.net/projects/markdown/ for details. -# The output of markdown processing is further processed by doxygen, so you can -# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in -# case of backward compatibilities issues. -# The default value is: YES. - -MARKDOWN_SUPPORT = YES - -# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up -# to that level are automatically included in the table of contents, even if -# they do not have an id attribute. -# Note: This feature currently applies only to Markdown headings. -# Minimum value: 0, maximum value: 99, default value: 5. -# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. - -TOC_INCLUDE_HEADINGS = 0 - -# When enabled doxygen tries to link words that correspond to documented -# classes, or namespaces to their corresponding documentation. Such a link can -# be prevented in individual cases by putting a % sign in front of the word or -# globally by setting AUTOLINK_SUPPORT to NO. -# The default value is: YES. - -AUTOLINK_SUPPORT = YES - -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should set this -# tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); -# versus func(std::string) {}). This also make the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. -# The default value is: NO. - -BUILTIN_STL_SUPPORT = NO - -# If you use Microsoft's C++/CLI language, you should set this option to YES to -# enable parsing support. -# The default value is: NO. - -CPP_CLI_SUPPORT = NO - -# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: -# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen -# will parse them like normal C++ but will assume all classes use public instead -# of private inheritance when no explicit protection keyword is present. -# The default value is: NO. - -SIP_SUPPORT = NO - -# For Microsoft's IDL there are propget and propput attributes to indicate -# getter and setter methods for a property. Setting this option to YES will make -# doxygen to replace the get and set methods by a property in the documentation. -# This will only work if the methods are indeed getting or setting a simple -# type. If this is not the case, or you want to show the methods anyway, you -# should set this option to NO. -# The default value is: YES. - -IDL_PROPERTY_SUPPORT = YES - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. -# The default value is: NO. - -DISTRIBUTE_GROUP_DOC = NO - -# If one adds a struct or class to a group and this option is enabled, then also -# any nested class or struct is added to the same group. By default this option -# is disabled and one has to add nested compounds explicitly via \ingroup. -# The default value is: NO. - -GROUP_NESTED_COMPOUNDS = NO - -# Set the SUBGROUPING tag to YES to allow class member groups of the same type -# (for instance a group of public functions) to be put as a subgroup of that -# type (e.g. under the Public Functions section). Set it to NO to prevent -# subgrouping. Alternatively, this can be done per class using the -# \nosubgrouping command. -# The default value is: YES. - -SUBGROUPING = YES - -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions -# are shown inside the group in which they are included (e.g. using \ingroup) -# instead of on a separate page (for HTML and Man pages) or section (for LaTeX -# and RTF). -# -# Note that this feature does not work in combination with -# SEPARATE_MEMBER_PAGES. -# The default value is: NO. - -INLINE_GROUPED_CLASSES = NO - -# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions -# with only public data fields or simple typedef fields will be shown inline in -# the documentation of the scope in which they are defined (i.e. file, -# namespace, or group documentation), provided this scope is documented. If set -# to NO, structs, classes, and unions are shown on a separate page (for HTML and -# Man pages) or section (for LaTeX and RTF). -# The default value is: NO. - -INLINE_SIMPLE_STRUCTS = NO - -# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or -# enum is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically be -# useful for C code in case the coding convention dictates that all compound -# types are typedef'ed and only the typedef is referenced, never the tag name. -# The default value is: NO. - -TYPEDEF_HIDES_STRUCT = NO - -# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This -# cache is used to resolve symbols given their name and scope. Since this can be -# an expensive process and often the same symbol appears multiple times in the -# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small -# doxygen will become slower. If the cache is too large, memory is wasted. The -# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range -# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 -# symbols. At the end of a run doxygen will report the cache usage and suggest -# the optimal cache size from a speed point of view. -# Minimum value: 0, maximum value: 9, default value: 0. - -LOOKUP_CACHE_SIZE = 0 - -# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use -# during processing. When set to 0 doxygen will based this on the number of -# cores available in the system. You can set it explicitly to a value larger -# than 0 to get more control over the balance between CPU load and processing -# speed. At this moment only the input processing can be done using multiple -# threads. Since this is still an experimental feature the default is set to 1, -# which effectively disables parallel processing. Please report any issues you -# encounter. Generating dot graphs in parallel is controlled by the -# DOT_NUM_THREADS setting. -# Minimum value: 0, maximum value: 32, default value: 1. - -NUM_PROC_THREADS = 1 - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in -# documentation are documented, even if no documentation was available. Private -# class members and static file members will be hidden unless the -# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. -# Note: This will also disable the warnings about undocumented members that are -# normally produced when WARNINGS is set to YES. -# The default value is: NO. - -EXTRACT_ALL = YES - -# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will -# be included in the documentation. -# The default value is: NO. - -EXTRACT_PRIVATE = YES - -# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual -# methods of a class will be included in the documentation. -# The default value is: NO. - -EXTRACT_PRIV_VIRTUAL = NO - -# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal -# scope will be included in the documentation. -# The default value is: NO. - -EXTRACT_PACKAGE = NO - -# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be -# included in the documentation. -# The default value is: NO. - -EXTRACT_STATIC = NO - -# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined -# locally in source files will be included in the documentation. If set to NO, -# only classes defined in header files are included. Does not have any effect -# for Java sources. -# The default value is: YES. - -EXTRACT_LOCAL_CLASSES = YES - -# This flag is only useful for Objective-C code. If set to YES, local methods, -# which are defined in the implementation section but not in the interface are -# included in the documentation. If set to NO, only methods in the interface are -# included. -# The default value is: NO. - -EXTRACT_LOCAL_METHODS = NO - -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base name of -# the file that contains the anonymous namespace. By default anonymous namespace -# are hidden. -# The default value is: NO. - -EXTRACT_ANON_NSPACES = NO - -# If this flag is set to YES, the name of an unnamed parameter in a declaration -# will be determined by the corresponding definition. By default unnamed -# parameters remain unnamed in the output. -# The default value is: YES. - -RESOLVE_UNNAMED_PARAMS = YES - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all -# undocumented members inside documented classes or files. If set to NO these -# members will be included in the various overviews, but no documentation -# section is generated. This option has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_MEMBERS = NO - -# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. If set -# to NO, these classes will be included in the various overviews. This option -# has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_CLASSES = NO - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend -# declarations. If set to NO, these declarations will be included in the -# documentation. -# The default value is: NO. - -HIDE_FRIEND_COMPOUNDS = NO - -# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any -# documentation blocks found inside the body of a function. If set to NO, these -# blocks will be appended to the function's detailed documentation block. -# The default value is: NO. - -HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation that is typed after a -# \internal command is included. If the tag is set to NO then the documentation -# will be excluded. Set it to YES to include the internal documentation. -# The default value is: NO. - -INTERNAL_DOCS = NO - -# With the correct setting of option CASE_SENSE_NAMES doxygen will better be -# able to match the capabilities of the underlying filesystem. In case the -# filesystem is case sensitive (i.e. it supports files in the same directory -# whose names only differ in casing), the option must be set to YES to properly -# deal with such files in case they appear in the input. For filesystems that -# are not case sensitive the option should be be set to NO to properly deal with -# output files written for symbols that only differ in casing, such as for two -# classes, one named CLASS and the other named Class, and to also support -# references to files without having to specify the exact matching casing. On -# Windows (including Cygwin) and MacOS, users should typically set this option -# to NO, whereas on Linux or other Unix flavors it should typically be set to -# YES. -# The default value is: system dependent. - -CASE_SENSE_NAMES = NO - -# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with -# their full class and namespace scopes in the documentation. If set to YES, the -# scope will be hidden. -# The default value is: NO. - -HIDE_SCOPE_NAMES = NO - -# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will -# append additional text to a page's title, such as Class Reference. If set to -# YES the compound reference will be hidden. -# The default value is: NO. - -HIDE_COMPOUND_REFERENCE= NO - -# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class -# will show which file needs to be included to use the class. -# The default value is: YES. - -SHOW_HEADERFILE = YES - -# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of -# the files that are included by a file in the documentation of that file. -# The default value is: YES. - -SHOW_INCLUDE_FILES = YES - -# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each -# grouped member an include statement to the documentation, telling the reader -# which file to include in order to use the member. -# The default value is: NO. - -SHOW_GROUPED_MEMB_INC = NO - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include -# files with double quotes in the documentation rather than with sharp brackets. -# The default value is: NO. - -FORCE_LOCAL_INCLUDES = NO - -# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the -# documentation for inline members. -# The default value is: YES. - -INLINE_INFO = YES - -# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the -# (detailed) documentation of file and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. -# The default value is: YES. - -SORT_MEMBER_DOCS = YES - -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief -# descriptions of file, namespace and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. Note that -# this will also influence the order of the classes in the class list. -# The default value is: NO. - -SORT_BRIEF_DOCS = NO - -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the -# (brief and detailed) documentation of class members so that constructors and -# destructors are listed first. If set to NO the constructors will appear in the -# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. -# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief -# member documentation. -# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting -# detailed member documentation. -# The default value is: NO. - -SORT_MEMBERS_CTORS_1ST = NO - -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy -# of group names into alphabetical order. If set to NO the group names will -# appear in their defined order. -# The default value is: NO. - -SORT_GROUP_NAMES = NO - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by -# fully-qualified names, including namespaces. If set to NO, the class list will -# be sorted only by class name, not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the alphabetical -# list. -# The default value is: NO. - -SORT_BY_SCOPE_NAME = NO - -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper -# type resolution of all parameters of a function it will reject a match between -# the prototype and the implementation of a member function even if there is -# only one candidate or it is obvious which candidate to choose by doing a -# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still -# accept a match between prototype and implementation in such cases. -# The default value is: NO. - -STRICT_PROTO_MATCHING = NO - -# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo -# list. This list is created by putting \todo commands in the documentation. -# The default value is: YES. - -GENERATE_TODOLIST = YES - -# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test -# list. This list is created by putting \test commands in the documentation. -# The default value is: YES. - -GENERATE_TESTLIST = NO - -# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug -# list. This list is created by putting \bug commands in the documentation. -# The default value is: YES. - -GENERATE_BUGLIST = YES - -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) -# the deprecated list. This list is created by putting \deprecated commands in -# the documentation. -# The default value is: YES. - -GENERATE_DEPRECATEDLIST= NO - -# The ENABLED_SECTIONS tag can be used to enable conditional documentation -# sections, marked by \if ... \endif and \cond -# ... \endcond blocks. - -ENABLED_SECTIONS = - -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the -# initial value of a variable or macro / define can have for it to appear in the -# documentation. If the initializer consists of more lines than specified here -# it will be hidden. Use a value of 0 to hide initializers completely. The -# appearance of the value of individual variables and macros / defines can be -# controlled using \showinitializer or \hideinitializer command in the -# documentation regardless of this setting. -# Minimum value: 0, maximum value: 10000, default value: 30. - -MAX_INITIALIZER_LINES = 30 - -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at -# the bottom of the documentation of classes and structs. If set to YES, the -# list will mention the files that were used to generate the documentation. -# The default value is: YES. - -SHOW_USED_FILES = YES - -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This -# will remove the Files entry from the Quick Index and from the Folder Tree View -# (if specified). -# The default value is: YES. - -SHOW_FILES = YES - -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces -# page. This will remove the Namespaces entry from the Quick Index and from the -# Folder Tree View (if specified). -# The default value is: YES. - -SHOW_NAMESPACES = YES - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command command input-file, where command is the value of the -# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided -# by doxygen. Whatever the program writes to standard output is used as the file -# version. For an example see the documentation. - -FILE_VERSION_FILTER = - -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. To create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. You can -# optionally specify a file name after the option, if omitted DoxygenLayout.xml -# will be used as the name of the layout file. See also section "Changing the -# layout of pages" for information. -# -# Note that if you run doxygen from a directory containing a file called -# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE -# tag is left empty. - -LAYOUT_FILE = - -# The CITE_BIB_FILES tag can be used to specify one or more bib files containing -# the reference definitions. This must be a list of .bib files. The .bib -# extension is automatically appended if omitted. This requires the bibtex tool -# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. -# For LaTeX the style of the bibliography can be controlled using -# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the -# search path. See also \cite for info how to create references. - -CITE_BIB_FILES = - -#--------------------------------------------------------------------------- -# Configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated to -# standard output by doxygen. If QUIET is set to YES this implies that the -# messages are off. -# The default value is: NO. - -QUIET = NO - -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES -# this implies that the warnings are on. -# -# Tip: Turn warnings on while writing the documentation. -# The default value is: YES. - -WARNINGS = YES - -# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate -# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag -# will automatically be disabled. -# The default value is: YES. - -WARN_IF_UNDOCUMENTED = YES - -# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as documenting some parameters in -# a documented function twice, or documenting parameters that don't exist or -# using markup commands wrongly. -# The default value is: YES. - -WARN_IF_DOC_ERROR = YES - -# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete -# function parameter documentation. If set to NO, doxygen will accept that some -# parameters have no documentation without warning. -# The default value is: YES. - -WARN_IF_INCOMPLETE_DOC = YES - -# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that -# are documented, but have no documentation for their parameters or return -# value. If set to NO, doxygen will only warn about wrong parameter -# documentation, but not about the absence of documentation. If EXTRACT_ALL is -# set to YES then this flag will automatically be disabled. See also -# WARN_IF_INCOMPLETE_DOC -# The default value is: NO. - -WARN_NO_PARAMDOC = NO - -# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when -# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS -# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but -# at the end of the doxygen process doxygen will return with a non-zero status. -# Possible values are: NO, YES and FAIL_ON_WARNINGS. -# The default value is: NO. - -WARN_AS_ERROR = NO - -# The WARN_FORMAT tag determines the format of the warning messages that doxygen -# can produce. The string should contain the $file, $line, and $text tags, which -# will be replaced by the file and line number from which the warning originated -# and the warning text. Optionally the format may contain $version, which will -# be replaced by the version of the file (if it could be obtained via -# FILE_VERSION_FILTER) -# The default value is: $file:$line: $text. - -WARN_FORMAT = "$file:$line: $text" - -# The WARN_LOGFILE tag can be used to specify a file to which warning and error -# messages should be written. If left blank the output is written to standard -# error (stderr). - -WARN_LOGFILE = - -#--------------------------------------------------------------------------- -# Configuration options related to the input files -#--------------------------------------------------------------------------- - -# The INPUT tag is used to specify the files and/or directories that contain -# documented source files. You may enter file names like myfile.cpp or -# directories like /usr/src/myproject. Separate the files or directories with -# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING -# Note: If this tag is empty the current directory is searched. - -INPUT = src - -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses -# libiconv (or the iconv built into libc) for the transcoding. See the libiconv -# documentation (see: -# https://www.gnu.org/software/libiconv/) for the list of possible encodings. -# The default value is: UTF-8. - -INPUT_ENCODING = UTF-8 - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and -# *.h) to filter out the source-files in the directories. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# read by doxygen. -# -# Note the list of default checked file patterns might differ from the list of -# default file extension mappings. -# -# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, -# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, -# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, -# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C -# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, -# *.vhdl, *.ucf, *.qsf and *.ice. - -FILE_PATTERNS = *.c \ - *.cc \ - *.cxx \ - *.cpp \ - *.c++ \ - *.java \ - *.ii \ - *.ixx \ - *.ipp \ - *.i++ \ - *.inl \ - *.idl \ - *.ddl \ - *.odl \ - *.h \ - *.hh \ - *.hxx \ - *.hpp \ - *.h++ \ - *.cs \ - *.d \ - *.php \ - *.php4 \ - *.php5 \ - *.phtml \ - *.inc \ - *.m \ - *.markdown \ - *.md \ - *.mm \ - *.dox \ - *.py \ - *.pyw \ - *.f90 \ - *.f95 \ - *.f03 \ - *.f08 \ - *.f \ - *.for \ - *.tcl \ - *.vhd \ - *.vhdl \ - *.ucf \ - *.qsf - -# The RECURSIVE tag can be used to specify whether or not subdirectories should -# be searched for input files as well. -# The default value is: NO. - -RECURSIVE = YES - -# The EXCLUDE tag can be used to specify files and/or directories that should be -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. -# -# Note that relative paths are relative to the directory from which doxygen is -# run. - -EXCLUDE = - -# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or -# directories that are symbolic links (a Unix file system feature) are excluded -# from the input. -# The default value is: NO. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories for example use the pattern */test/* - -EXCLUDE_PATTERNS = - -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories use the pattern */test/* - -EXCLUDE_SYMBOLS = - -# The EXAMPLE_PATH tag can be used to specify one or more files or directories -# that contain example code fragments that are included (see the \include -# command). - -EXAMPLE_PATH = - -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank all -# files are included. - -EXAMPLE_PATTERNS = * - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude commands -# irrespective of the value of the RECURSIVE tag. -# The default value is: NO. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or directories -# that contain images that are to be included in the documentation (see the -# \image command). - -IMAGE_PATH = DoxyImg - -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command: -# -# -# -# where is the value of the INPUT_FILTER tag, and is the -# name of an input file. Doxygen will then use the output that the filter -# program writes to standard output. If FILTER_PATTERNS is specified, this tag -# will be ignored. -# -# Note that the filter must not add or remove lines; it is applied before the -# code is scanned, but not when the output code is generated. If lines are added -# or removed, the anchors will not be placed correctly. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by doxygen. - -INPUT_FILTER = - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: pattern=filter -# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how -# filters are used. If the FILTER_PATTERNS tag is empty or if none of the -# patterns match the file name, INPUT_FILTER is applied. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by doxygen. - -FILTER_PATTERNS = - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will also be used to filter the input files that are used for -# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). -# The default value is: NO. - -FILTER_SOURCE_FILES = NO - -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and -# it is also possible to disable source filtering for a specific pattern using -# *.ext= (so without naming a filter). -# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. - -FILTER_SOURCE_PATTERNS = - -# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that -# is part of the input, its contents will be placed on the main page -# (index.html). This can be useful if you have a project on for instance GitHub -# and want to reuse the introduction page also for the doxygen output. - -USE_MDFILE_AS_MAINPAGE = - -#--------------------------------------------------------------------------- -# Configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will be -# generated. Documented entities will be cross-referenced with these sources. -# -# Note: To get rid of all source code in the generated output, make sure that -# also VERBATIM_HEADERS is set to NO. -# The default value is: NO. - -SOURCE_BROWSER = NO - -# Setting the INLINE_SOURCES tag to YES will include the body of functions, -# classes and enums directly into the documentation. -# The default value is: NO. - -INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any -# special comment blocks from generated source code fragments. Normal C, C++ and -# Fortran comments will always remain visible. -# The default value is: YES. - -STRIP_CODE_COMMENTS = YES - -# If the REFERENCED_BY_RELATION tag is set to YES then for each documented -# entity all documented functions referencing it will be listed. -# The default value is: NO. - -REFERENCED_BY_RELATION = NO - -# If the REFERENCES_RELATION tag is set to YES then for each documented function -# all documented entities called/used by that function will be listed. -# The default value is: NO. - -REFERENCES_RELATION = NO - -# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set -# to YES then the hyperlinks from functions in REFERENCES_RELATION and -# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will -# link to the documentation. -# The default value is: YES. - -REFERENCES_LINK_SOURCE = YES - -# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the -# source code will show a tooltip with additional information such as prototype, -# brief description and links to the definition and documentation. Since this -# will make the HTML file larger and loading of large files a bit slower, you -# can opt to disable this feature. -# The default value is: YES. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -SOURCE_TOOLTIPS = YES - -# If the USE_HTAGS tag is set to YES then the references to source code will -# point to the HTML generated by the htags(1) tool instead of doxygen built-in -# source browser. The htags tool is part of GNU's global source tagging system -# (see https://www.gnu.org/software/global/global.html). You will need version -# 4.8.6 or higher. -# -# To use it do the following: -# - Install the latest version of global -# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file -# - Make sure the INPUT points to the root of the source tree -# - Run doxygen as normal -# -# Doxygen will invoke htags (and that will in turn invoke gtags), so these -# tools must be available from the command line (i.e. in the search path). -# -# The result: instead of the source browser generated by doxygen, the links to -# source code will now point to the output of htags. -# The default value is: NO. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a -# verbatim copy of the header file for each class for which an include is -# specified. Set to NO to disable this. -# See also: Section \class. -# The default value is: YES. - -VERBATIM_HEADERS = YES - -# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the -# clang parser (see: -# http://clang.llvm.org/) for more accurate parsing at the cost of reduced -# performance. This can be particularly helpful with template rich C++ code for -# which doxygen's built-in parser lacks the necessary type information. -# Note: The availability of this option depends on whether or not doxygen was -# generated with the -Duse_libclang=ON option for CMake. -# The default value is: NO. - -CLANG_ASSISTED_PARSING = NO - -# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS -# tag is set to YES then doxygen will add the directory of each input to the -# include path. -# The default value is: YES. -# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. - -CLANG_ADD_INC_PATHS = YES - -# If clang assisted parsing is enabled you can provide the compiler with command -# line options that you would normally use when invoking the compiler. Note that -# the include paths will already be set by doxygen for the files and directories -# specified with INPUT and INCLUDE_PATH. -# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. - -CLANG_OPTIONS = - -# If clang assisted parsing is enabled you can provide the clang parser with the -# path to the directory containing a file called compile_commands.json. This -# file is the compilation database (see: -# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the -# options used when the source files were built. This is equivalent to -# specifying the -p option to a clang tool, such as clang-check. These options -# will then be passed to the parser. Any options specified with CLANG_OPTIONS -# will be added as well. -# Note: The availability of this option depends on whether or not doxygen was -# generated with the -Duse_libclang=ON option for CMake. - -CLANG_DATABASE_PATH = - -#--------------------------------------------------------------------------- -# Configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all -# compounds will be generated. Enable this if the project contains a lot of -# classes, structs, unions or interfaces. -# The default value is: YES. - -ALPHABETICAL_INDEX = YES - -# In case all classes in a project start with a common prefix, all classes will -# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag -# can be used to specify a prefix (or a list of prefixes) that should be ignored -# while generating the index headers. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -IGNORE_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the HTML output -#--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output -# The default value is: YES. - -GENERATE_HTML = YES - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_OUTPUT = html - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each -# generated HTML page (for example: .htm, .php, .asp). -# The default value is: .html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a user-defined HTML header file for -# each generated HTML page. If the tag is left blank doxygen will generate a -# standard header. -# -# To get valid HTML the header file that includes any scripts and style sheets -# that doxygen needs, which is dependent on the configuration options used (e.g. -# the setting GENERATE_TREEVIEW). It is highly recommended to start with a -# default header using -# doxygen -w html new_header.html new_footer.html new_stylesheet.css -# YourConfigFile -# and then modify the file new_header.html. See also section "Doxygen usage" -# for information on how to generate the default header that doxygen normally -# uses. -# Note: The header is subject to change so you typically have to regenerate the -# default header when upgrading to a newer version of doxygen. For a description -# of the possible markers and block names see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_HEADER = - -# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each -# generated HTML page. If the tag is left blank doxygen will generate a standard -# footer. See HTML_HEADER for more information on how to generate a default -# footer and what special commands can be used inside the footer. See also -# section "Doxygen usage" for information on how to generate the default footer -# that doxygen normally uses. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FOOTER = - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style -# sheet that is used by each HTML page. It can be used to fine-tune the look of -# the HTML output. If left blank doxygen will generate a default style sheet. -# See also section "Doxygen usage" for information on how to generate the style -# sheet that doxygen normally uses. -# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as -# it is more robust and this tag (HTML_STYLESHEET) will in the future become -# obsolete. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_STYLESHEET = - -# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined -# cascading style sheets that are included after the standard style sheets -# created by doxygen. Using this option one can overrule certain style aspects. -# This is preferred over using HTML_STYLESHEET since it does not replace the -# standard style sheet and is therefore more robust against future updates. -# Doxygen will copy the style sheet files to the output directory. -# Note: The order of the extra style sheet files is of importance (e.g. the last -# style sheet in the list overrules the setting of the previous ones in the -# list). For an example see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_STYLESHEET = - -# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or -# other source files which should be copied to the HTML output directory. Note -# that these files will be copied to the base HTML output directory. Use the -# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these -# files. In the HTML_STYLESHEET file, use the file name only. Also note that the -# files will be copied as-is; there are no commands or markers available. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_FILES = - -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen -# will adjust the colors in the style sheet and background images according to -# this color. Hue is specified as an angle on a color-wheel, see -# https://en.wikipedia.org/wiki/Hue for more information. For instance the value -# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 -# purple, and 360 is red again. -# Minimum value: 0, maximum value: 359, default value: 220. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_HUE = 220 - -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors -# in the HTML output. For a value of 0 the output will use gray-scales only. A -# value of 255 will produce the most vivid colors. -# Minimum value: 0, maximum value: 255, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_SAT = 100 - -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the -# luminance component of the colors in the HTML output. Values below 100 -# gradually make the output lighter, whereas values above 100 make the output -# darker. The value divided by 100 is the actual gamma applied, so 80 represents -# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not -# change the gamma. -# Minimum value: 40, maximum value: 240, default value: 80. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_GAMMA = 80 - -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting this -# to YES can help to show when doxygen was last run and thus if the -# documentation is up to date. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_TIMESTAMP = NO - -# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML -# documentation will contain a main index with vertical navigation menus that -# are dynamically created via JavaScript. If disabled, the navigation index will -# consists of multiple levels of tabs that are statically embedded in every HTML -# page. Disable this option to support browsers that do not have JavaScript, -# like the Qt help browser. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_DYNAMIC_MENUS = YES - -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the -# page has loaded. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_DYNAMIC_SECTIONS = NO - -# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries -# shown in the various tree structured indices initially; the user can expand -# and collapse entries dynamically later on. Doxygen will expand the tree to -# such a level that at most the specified number of entries are visible (unless -# a fully collapsed tree already exceeds this amount). So setting the number of -# entries 1 will produce a full collapsed tree by default. 0 is a special value -# representing an infinite number of entries and will result in a full expanded -# tree by default. -# Minimum value: 0, maximum value: 9999, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_INDEX_NUM_ENTRIES = 100 - -# If the GENERATE_DOCSET tag is set to YES, additional index files will be -# generated that can be used as input for Apple's Xcode 3 integrated development -# environment (see: -# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To -# create a documentation set, doxygen will generate a Makefile in the HTML -# output directory. Running make will produce the docset in that directory and -# running make install will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at -# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy -# genXcode/_index.html for more information. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_DOCSET = NO - -# This tag determines the name of the docset feed. A documentation feed provides -# an umbrella under which multiple documentation sets from a single provider -# (such as a company or product suite) can be grouped. -# The default value is: Doxygen generated docs. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_FEEDNAME = "Doxygen generated docs" - -# This tag specifies a string that should uniquely identify the documentation -# set bundle. This should be a reverse domain-name style string, e.g. -# com.mycompany.MyDocSet. Doxygen will append .docset to the name. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_BUNDLE_ID = org.doxygen.Project - -# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify -# the documentation publisher. This should be a reverse domain-name style -# string, e.g. com.mycompany.MyDocSet.documentation. -# The default value is: org.doxygen.Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_ID = org.doxygen.Publisher - -# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. -# The default value is: Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_NAME = Publisher - -# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three -# additional HTML index files: index.hhp, index.hhc, and index.hhk. The -# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop -# on Windows. In the beginning of 2021 Microsoft took the original page, with -# a.o. the download links, offline the HTML help workshop was already many years -# in maintenance mode). You can download the HTML help workshop from the web -# archives at Installation executable (see: -# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo -# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). -# -# The HTML Help Workshop contains a compiler that can convert all HTML output -# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML -# files are now used as the Windows 98 help format, and will replace the old -# Windows help format (.hlp) on all Windows platforms in the future. Compressed -# HTML files also contain an index, a table of contents, and you can search for -# words in the documentation. The HTML workshop also contains a viewer for -# compressed HTML files. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_HTMLHELP = NO - -# The CHM_FILE tag can be used to specify the file name of the resulting .chm -# file. You can add a path in front of the file if the result should not be -# written to the html output directory. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_FILE = - -# The HHC_LOCATION tag can be used to specify the location (absolute path -# including file name) of the HTML help compiler (hhc.exe). If non-empty, -# doxygen will try to run the HTML help compiler on the generated index.hhp. -# The file has to be specified with full path. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -HHC_LOCATION = - -# The GENERATE_CHI flag controls if a separate .chi index file is generated -# (YES) or that it should be included in the main .chm file (NO). -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -GENERATE_CHI = NO - -# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) -# and project file content. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_INDEX_ENCODING = - -# The BINARY_TOC flag controls whether a binary table of contents is generated -# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it -# enables the Previous and Next buttons. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members to -# the table of contents of the HTML help documentation and to the tree view. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -TOC_EXPAND = NO - -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that -# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help -# (.qch) of the generated HTML documentation. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_QHP = NO - -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify -# the file name of the resulting .qch file. The path specified is relative to -# the HTML output folder. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QCH_FILE = - -# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help -# Project output. For more information please see Qt Help Project / Namespace -# (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_NAMESPACE = org.doxygen.Project - -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt -# Help Project output. For more information please see Qt Help Project / Virtual -# Folders (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). -# The default value is: doc. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_VIRTUAL_FOLDER = doc - -# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom -# filter to add. For more information please see Qt Help Project / Custom -# Filters (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_NAME = - -# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see Qt Help Project / Custom -# Filters (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_ATTRS = - -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's filter section matches. Qt Help Project / Filter Attributes (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_SECT_FILTER_ATTRS = - -# The QHG_LOCATION tag can be used to specify the location (absolute path -# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to -# run qhelpgenerator on the generated .qhp file. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHG_LOCATION = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be -# generated, together with the HTML files, they form an Eclipse help plugin. To -# install this plugin and make it available under the help contents menu in -# Eclipse, the contents of the directory containing the HTML and XML files needs -# to be copied into the plugins directory of eclipse. The name of the directory -# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. -# After copying Eclipse needs to be restarted before the help appears. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the Eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have this -# name. Each documentation set should have its own identifier. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. - -ECLIPSE_DOC_ID = org.doxygen.Project - -# If you want full control over the layout of the generated HTML pages it might -# be necessary to disable the index and replace it with your own. The -# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top -# of each HTML page. A value of NO enables the index and the value YES disables -# it. Since the tabs in the index contain the same information as the navigation -# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -DISABLE_INDEX = NO - -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. If the tag -# value is set to YES, a side panel will be generated containing a tree-like -# index structure (just like the one that is generated for HTML Help). For this -# to work a browser that supports JavaScript, DHTML, CSS and frames is required -# (i.e. any modern browser). Windows users are probably better off using the -# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can -# further fine tune the look of the index (see "Fine-tuning the output"). As an -# example, the default style sheet generated by doxygen has an example that -# shows how to put an image at the root of the tree instead of the PROJECT_NAME. -# Since the tree basically has the same information as the tab index, you could -# consider setting DISABLE_INDEX to YES when enabling this option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_TREEVIEW = YES - -# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the -# FULL_SIDEBAR option determines if the side bar is limited to only the treeview -# area (value NO) or if it should extend to the full height of the window (value -# YES). Setting this to YES gives a layout similar to -# https://docs.readthedocs.io with more room for contents, but less room for the -# project logo, title, and description. If either GENERATOR_TREEVIEW or -# DISABLE_INDEX is set to NO, this option has no effect. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FULL_SIDEBAR = NO - -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that -# doxygen will group on one line in the generated HTML documentation. -# -# Note that a value of 0 will completely suppress the enum values from appearing -# in the overview section. -# Minimum value: 0, maximum value: 20, default value: 4. -# This tag requires that the tag GENERATE_HTML is set to YES. - -ENUM_VALUES_PER_LINE = 4 - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used -# to set the initial width (in pixels) of the frame in which the tree is shown. -# Minimum value: 0, maximum value: 1500, default value: 250. -# This tag requires that the tag GENERATE_HTML is set to YES. - -TREEVIEW_WIDTH = 250 - -# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to -# external symbols imported via tag files in a separate window. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -EXT_LINKS_IN_WINDOW = NO - -# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg -# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see -# https://inkscape.org) to generate formulas as SVG images instead of PNGs for -# the HTML output. These images will generally look nicer at scaled resolutions. -# Possible values are: png (the default) and svg (looks nicer but requires the -# pdf2svg or inkscape tool). -# The default value is: png. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FORMULA_FORMAT = png - -# Use this tag to change the font size of LaTeX formulas included as images in -# the HTML documentation. When you change the font size after a successful -# doxygen run you need to manually remove any form_*.png images from the HTML -# output directory to force them to be regenerated. -# Minimum value: 8, maximum value: 50, default value: 10. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_FONTSIZE = 10 - -# Use the FORMULA_TRANSPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are not -# supported properly for IE 6.0, but are supported on all modern browsers. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_TRANSPARENT = YES - -# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands -# to create new LaTeX commands to be used in formulas as building blocks. See -# the section "Including formulas" for details. - -FORMULA_MACROFILE = - -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see -# https://www.mathjax.org) which uses client side JavaScript for the rendering -# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX -# installed or if you want to formulas look prettier in the HTML output. When -# enabled you may also need to install MathJax separately and configure the path -# to it using the MATHJAX_RELPATH option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -USE_MATHJAX = NO - -# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. -# Note that the different versions of MathJax have different requirements with -# regards to the different settings, so it is possible that also other MathJax -# settings have to be changed when switching between the different MathJax -# versions. -# Possible values are: MathJax_2 and MathJax_3. -# The default value is: MathJax_2. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_VERSION = MathJax_2 - -# When MathJax is enabled you can set the default output format to be used for -# the MathJax output. For more details about the output format see MathJax -# version 2 (see: -# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 -# (see: -# http://docs.mathjax.org/en/latest/web/components/output.html). -# Possible values are: HTML-CSS (which is slower, but has the best -# compatibility. This is the name for Mathjax version 2, for MathJax version 3 -# this will be translated into chtml), NativeMML (i.e. MathML. Only supported -# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This -# is the name for Mathjax version 3, for MathJax version 2 this will be -# translated into HTML-CSS) and SVG. -# The default value is: HTML-CSS. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_FORMAT = HTML-CSS - -# When MathJax is enabled you need to specify the location relative to the HTML -# output directory using the MATHJAX_RELPATH option. The destination directory -# should contain the MathJax.js script. For instance, if the mathjax directory -# is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax -# Content Delivery Network so you can quickly see the result without installing -# MathJax. However, it is strongly recommended to install a local copy of -# MathJax from https://www.mathjax.org before deployment. The default value is: -# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 -# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest - -# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax -# extension names that should be enabled during MathJax rendering. For example -# for MathJax version 2 (see -# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): -# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols -# For example for MathJax version 3 (see -# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): -# MATHJAX_EXTENSIONS = ams -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_EXTENSIONS = - -# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces -# of code that will be used on startup of the MathJax code. See the MathJax site -# (see: -# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an -# example see the documentation. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_CODEFILE = - -# When the SEARCHENGINE tag is enabled doxygen will generate a search box for -# the HTML output. The underlying search engine uses javascript and DHTML and -# should work on any modern browser. Note that when using HTML help -# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) -# there is already a search function so this one should typically be disabled. -# For large projects the javascript based search engine can be slow, then -# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to -# search using the keyboard; to jump to the search box use + S -# (what the is depends on the OS and browser, but it is typically -# , /