APV versioning changes

CMakeLists.txt

@@ -5,17 +5,19 @@ cmake_minimum_required (VERSION 3.12)
 ########################################
 
 # Set project version from git tag or version.txt file
-function(get_versions versionstring VERSION_MAJOR VERSION_MINOR VERSION_PATCH)
-    string(REGEX REPLACE "^([vV])([0-9]*)([.][0-9]*[.][0-9]*-?.*)$" "\\2" numbers ${versionstring})
-    set(VERSION_MAJOR ${numbers} PARENT_SCOPE)
-    string(REGEX REPLACE "^([vV][0-9]*[.])([0-9]*)([.][0-9]*-?.*)$" "\\2" numbers ${versionstring})
-    set(VERSION_MINOR ${numbers} PARENT_SCOPE)
-    string(REGEX REPLACE "^([vV][0-9]*[.][0-9]*[.])([0-9]*)(-?.*)$" "\\2" numbers ${versionstring})
-    set(VERSION_PATCH ${numbers} PARENT_SCOPE)
+function(get_versions versionstring VERSION_APISET VERSION_MAJOR VERSION_MINOR VERSION_PATCH)
+    string(REGEX REPLACE "^([vV])([0-9]+)([.])([0-9]+)([.])([0-9]+)([.])([0-9]+)$" "\\2" numbers ${versionstring})
+    set(${VERSION_APISET} ${numbers} PARENT_SCOPE)
+    string(REGEX REPLACE "^([vV])([0-9]+)([.])([0-9]+)([.])([0-9]+)([.])([0-9]+)$" "\\4" numbers ${versionstring})
+    set(${VERSION_MAJOR} ${numbers} PARENT_SCOPE)
+    string(REGEX REPLACE "^([vV])([0-9]+)([.])([0-9]+)([.])([0-9]+)([.])([0-9]+)$" "\\6" numbers ${versionstring})
+    set(${VERSION_MINOR} ${numbers} PARENT_SCOPE)
+    string(REGEX REPLACE "^([vV])([0-9]+)([.])([0-9]+)([.])([0-9]+)([.])([0-9]+)$" "\\8" numbers ${versionstring})
+    set(${VERSION_PATCH} ${numbers} PARENT_SCOPE)
 endfunction()
 
 execute_process(
-    COMMAND git describe --match "v[0-9]*.[0-9]*.[0-9]*" --abbrev=0 --tags
+    COMMAND git describe --match "v[0-9]*.[0-9]*.[0-9]*.[0-9]*" --abbrev=0 --tags
     WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
     RESULT_VARIABLE RESULT
     OUTPUT_VARIABLE OUTPUT)
@@ -32,7 +34,7 @@ if(NOT RESULT EQUAL 0)
     message(FATAL_ERROR
         "version.txt file doesn't exist!\n"
         "Since your working directory doesn't contain a git repository you must provide \"${CMAKE_SOURCE_DIR}/version.txt\" file containing a valid version string.\n"
-        "The version string provided to version.txt must match the following format:\n\tv[VERSION_MAJOR].[VERSION_MINOR].[VERSION_PATCH]\n"
+        "The version string provided to version.txt must match the following format:\n\tv[VERSION_APISET].[VERSION_MAJOR].[VERSION_MINOR].[VERSION_PATCH]\n"
         "To get the information on version of the downloaded library please follow the link below:\n\t https://github.com/AcademySoftwareFoundation/openapv"
         )
   endif()
@@ -46,17 +48,18 @@ else()
   string(REGEX REPLACE "\n$" "" VERSION_STRING "${VERSION_STRING}")
 endif()
 
-if(NOT ${VERSION_STRING} MATCHES "^([vV])([0-9]*)([.][0-9]*[.][0-9]*-?.*)$")
-  message(FATAL_ERROR "Version string ${VERSION_STRING} doesn't match required format v[VERSION_MAJOR].[VERSION_MINOR].[VERSION_PATCH]")
+if(NOT ${VERSION_STRING} MATCHES "^([vV])([0-9]+)([.])([0-9]+)([.])([0-9]+)([.])([0-9]+)$")
+  message(FATAL_ERROR "Version string ${VERSION_STRING} doesn't match required format v[VERSION_APISET].[VERSION_MAJOR].[VERSION_MINOR].[VERSION_PATCH]")
 endif()
 
-get_versions(${VERSION_STRING} VERSION_MAJOR VERSION_MINOR VERSION_PATCH)
+get_versions(${VERSION_STRING} VERSION_APISET VERSION_MAJOR VERSION_MINOR VERSION_PATCH)
 if(VERSION_MAJOR STREQUAL ${VERSION_STRING})
   message(FATAL_ERROR "Version string parsing error")
 endif()
-message("OAPV VERSION=${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH}")
+message("OAPV version: ${VERSION_APISET}.${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH}")
 
-project(OAPV VERSION ${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH} LANGUAGES C)
+
+project(OAPV VERSION ${VERSION_APISET}.${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH} LANGUAGES C)
 
 ########################################
 # Input arguments.
@@ -219,10 +222,7 @@ set(CPACK_PACKAGE_CONTACT "https://github.com/AcademySoftwareFoundation")
 set(CPACK_PACKAGE_HOMEPAGE_URL "https://github.com/AcademySoftwareFoundation/openapv/releases")
 set(CMAKE_PROJECT_HOMEPAGE_URL "https://github.com/AcademySoftwareFoundation/openapv")
 set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Open Advanced Professional Video Codec")
-set(CPACK_PACKAGE_VERSION "${PROJECT_VERSION}")
-set(CPACK_PACKAGE_VERSION_MAJOR "${PROJECT_VERSION_MAJOR}")
-set(CPACK_PACKAGE_VERSION_MINOR "${PROJECT_VERSION_MINOR}")
-set(CPACK_PACKAGE_VERSION_PATCH "${PROJECT_VERSION_PATCH}")
+set(CPACK_PACKAGE_VERSION "${VERSION_APISET}.${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH}")
 set(CPACK_PACKAGE_CHECKSUM MD5)
 
 set(CPACK_DEBIAN_PACKAGE_MAINTAINER "AcademySoftwareFoundation")

app/oapv_app_dec.c

@@ -378,7 +378,7 @@ int main(int argc, const char **argv)
 
     // print logo
     logv2("  ____                ___   ___ _   __\n");
-    logv2(" / __ \\___  ___ ___  / _ | / _ \\ | / / Decoder (v%s)\n", oapv_version());
+    logv2(" / __ \\___  ___ ___  / _ | / _ \\ | / / Decoder (v%s)\n", ver_num_2_ver_str(oapv_version()));
     logv2("/ /_/ / _ \\/ -_) _ \\/ __ |/ ___/ |/ / \n");
     logv2("\\____/ .__/\\__/_//_/_/ |_/_/   |___/  \n");
     logv2("    /_/                               \n");

app/oapv_app_enc.c

@@ -599,7 +599,7 @@ int main(int argc, const char **argv)
 
     // print logo
     logv2("  ____                ___   ___ _   __\n");
-    logv2(" / __ \\___  ___ ___  / _ | / _ \\ | / / Encoder (v%s)\n", oapv_version());
+    logv2(" / __ \\___  ___ ___  / _ | / _ \\ | / / Encoder (v%s)\n", ver_num_2_ver_str(oapv_version()));
     logv2("/ /_/ / _ \\/ -_) _ \\/ __ |/ ___/ |/ / \n");
     logv2("\\____/ .__/\\__/_//_/_/ |_/_/   |___/  \n");
     logv2("    /_/                               \n");

app/oapv_app_util.h

@@ -789,4 +789,16 @@ static unsigned char char_to_hex(char a)
     return ret;
 }
 
+/* get version string */
+char * ver_num_2_ver_str(unsigned int ver_num)
+{
+    static char oapv_app_ver_str[16];
+    snprintf(oapv_app_ver_str, sizeof(oapv_app_ver_str), "%d.%d.%d.%d",
+        OAPV_VER_GET_APISET(ver_num),
+        OAPV_VER_GET_MAJOR(ver_num),
+        OAPV_VER_GET_MINOR(ver_num),
+        OAPV_VER_GET_PATCH(ver_num));
+    return (char*)oapv_app_ver_str;
+}
+
 #endif /* _OAPV_APP_UTIL_H_ */

inc/oapv.h

@@ -36,18 +36,26 @@
 extern "C" {
 #endif
 
-#include <oapv_config.h>
-
-#if defined(OAPV_LIBVERSION_HEADER)
-#include <oapv/oapv_libversion.h>
+#if defined(ANDROID) || defined(OAPV_STATIC_DEFINE)
+    #define OAPV_EXPORT
+#else
+    #include <oapv/oapv_exports.h>
 #endif
 
-#if defined(OAPV_EXPORT_HEADER) && !defined(OAPV_STATIC_DEFINE)
-#include <oapv/oapv_exports.h>
-#else
-#define OAPV_EXPORT
+#if !defined(ANDROID)
+    #include <oapv/oapv_version.h>
 #endif
 
+/* macro for version */
+/* the version string follows the rule of API_SET.MAJOR.MINOR.PATCH */
+#define OAPV_VER_SET(apiset, major, minor, patch) \
+    (((apiset & 0xFF) << 24)|((major & 0xFF) << 16)|((minor & 0xFF) << 8)|\
+    (patch & 0xFF))
+#define OAPV_VER_GET_APISET(v)          (((v) >> 24) & 0xFF)
+#define OAPV_VER_GET_MAJOR(v)           (((v) >> 16) & 0xFF)
+#define OAPV_VER_GET_MINOR(v)           (((v) >>  8) & 0xFF)
+#define OAPV_VER_GET_PATCH(v)           (((v) >>  0) & 0xFF)
+
 /* size of macroblock */
 #define OAPV_LOG2_MB                    (4)
 #define OAPV_LOG2_MB_W                  (4)
@@ -664,7 +672,7 @@ OAPV_EXPORT int oapvd_info(void *au, int au_size, oapv_au_info_t *aui);
 /*****************************************************************************
  * openapv version
  *****************************************************************************/
-OAPV_EXPORT char *oapv_version();
+OAPV_EXPORT unsigned int oapv_version();
 
 #ifdef __cplusplus
 } /* extern "C" */

inc/oapv_libversion.h.in → inc/oapv_version.h.in

@@ -29,22 +29,25 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef __OAPV_LIBVERSION_H__8465216516551324987461894651851187416502317561968__
-#define __OAPV_LIBVERSION_H__8465216516551324987461894651851187416502317561968__
+#ifndef __OAPV_VERSION_H__8465216516551324987461894651851187416502317561968__
+#define __OAPV_VERSION_H__8465216516551324987461894651851187416502317561968__
 
 #cmakedefine01 OAPV_BUILD_SHARED_LIB
 #if !OAPV_BUILD_SHARED_LIB && !defined(OAPV_STATIC_DEFINE)
 #define OAPV_STATIC_DEFINE
 #endif
 #undef OAPV_BUILD_SHARED_LIB
 
-#define OAPV_LIB_VERSION_MAJOR @LIB_VERSION_MAJOR@
-#define OAPV_LIB_VERSION_MINOR @LIB_VERSION_MINOR@
-#define OAPV_LIB_VERSION_PATCH @LIB_VERSION_PATCH@
+// Project version
+#define OAPV_VERSION_APISET @VERSION_APISET@
+#define OAPV_VERSION_MAJOR  @VERSION_MAJOR@
+#define OAPV_VERSION_MINOR  @VERSION_MINOR@
+#define OAPV_VERSION_PATCH  @VERSION_PATCH@
 
-#define OAPV_CHECK_LIB_VERSION(major, minor, patch)                            \
-    ((major) < OAPV_LIB_VERSION_MAJOR ||                                       \
-    ((major) == OAPV_LIB_VERSION_MAJOR && (minor) < OAPV_LIB_VERSION_MINOR) || \
-    ((major) == OAPV_LIB_VERSION_MAJOR && (minor) == OAPV_LIB_VERSION_MINOR && (patch) <= OAPV_LIB_VERSION_PATCH))
+#define OAPV_CHECK_VERSION(apiset, major, minor, patch)                      \
+    ((apiset) < OAPV_VERSION_APISET || \
+    ((apiset) == OAPV_VERSION_APISET && (major) < OAPV_VERSION_MAJOR) || \
+    ((apiset) == OAPV_VERSION_APISET && (major) == OAPV_VERSION_MAJOR && (minor) < OAPV_VERSION_MINOR) || \
+    ((apiset) == OAPV_VERSION_APISET && (major) == OAPV_VERSION_MAJOR && (minor) == OAPV_VERSION_MINOR && (patch) <= OAPV_VERSION_PATCH)) 
 
-#endif /* __OAPV_LIBVERSION_H__8465216516551324987461894651851187416502317561968__ */
+#endif /* __OAPV_VERSION_H__8465216516551324987461894651851187416502317561968__ */

pkgconfig/oapv.pc.in

@@ -7,7 +7,7 @@ includedir=@CMAKE_INSTALL_PREFIX@/@CMAKE_INSTALL_INCLUDEDIR@/@LIB_NAME_BASE@
 Name: oapv
 Description: Advanced Professional Video Codec
 
-Version: @PROJECT_VERSION_MAJOR@.@PROJECT_VERSION_MINOR@.@PROJECT_VERSION_PATCH@
+Version: @VERSION_APISET@.@VERSION_MAJOR@.@VERSION_MINOR@.@VERSION_PATCH@
 
 Requires:
 Libs: -L${libdir} -l@LIB_NAME_BASE@

src/CMakeLists.txt

@@ -1,9 +1,5 @@
 set(LIB_NAME_BASE oapv)
 
-set(LIB_VERSION_MAJOR 1)
-set(LIB_VERSION_MINOR 0)
-set(LIB_VERSION_PATCH 0)
-
 file(GLOB LIB_INC "../inc/*.h")
 file(GLOB LIB_API_SRC "oapv.c")
 file(GLOB LIB_BASE_SRC "oapv_*.c")
@@ -15,17 +11,13 @@ file(GLOB LIB_NEON_INC "../src/neon/oapv_*.h" )
 file(GLOB LIB_AVX_SRC "../src/avx/oapv_*.c")
 file(GLOB LIB_AVX_INC "../src/avx/oapv_*.h" )
 
-set(LIB_LIBVERSION_HEADER "${CMAKE_BINARY_DIR}/include/${LIB_NAME_BASE}/${LIB_NAME_BASE}_libversion.h")
-configure_file("${CMAKE_SOURCE_DIR}/inc/${LIB_NAME_BASE}_libversion.h.in" "${LIB_LIBVERSION_HEADER}" @ONLY)
-list(APPEND LIB_INC "${LIB_LIBVERSION_HEADER}")
+set(LIB_VERSION_HEADER "${CMAKE_BINARY_DIR}/include/${LIB_NAME_BASE}/${LIB_NAME_BASE}_version.h")
+configure_file("${CMAKE_SOURCE_DIR}/inc/${LIB_NAME_BASE}_version.h.in" "${LIB_VERSION_HEADER}" @ONLY)
+list(APPEND LIB_INC "${LIB_VERSION_HEADER}")
 
 include(GenerateExportHeader)
 include_directories("${CMAKE_BINARY_DIR}/include")
 
-set(LIB_CONFIG_HEADER "${CMAKE_SOURCE_DIR}/inc/${LIB_NAME_BASE}_config.h")
-configure_file("${CMAKE_SOURCE_DIR}/inc/${LIB_NAME_BASE}_config.h.in" "${LIB_CONFIG_HEADER}" @ONLY)
-list(APPEND LIB_INC "${LIB_CONFIG_HEADER}")
-
 
 message("SYSTEM_PROCESSOR=${CMAKE_SYSTEM_PROCESSOR}")
 
@@ -67,7 +59,7 @@ endif()
 
 if(OAPV_BUILD_SHARED_LIB)
   add_library(${LIB_NAME_BASE}_dynamic SHARED ${SOURCE_FILES})
-  set_target_properties(${LIB_NAME_BASE}_dynamic PROPERTIES VERSION ${LIB_VERSION_MAJOR}.${LIB_VERSION_MINOR}.${LIB_VERSION_PATCH} SOVERSION ${LIB_VERSION_MAJOR})
+  set_target_properties(${LIB_NAME_BASE}_dynamic PROPERTIES VERSION ${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH} SOVERSION ${VERSION_MAJOR})
   set_target_properties(${LIB_NAME_BASE}_dynamic PROPERTIES OUTPUT_NAME ${LIB_NAME_BASE})
 
   # @todo Consider using WINDOWS_EXPORT_ALL_SYMBOLS instead of generate_export_header

src/oapv.c

@@ -2153,5 +2153,22 @@ int oapvd_info(void *au, int au_size, oapv_au_info_t *aui)
 #endif // ENABLE_DECODER
 ///////////////////////////////////////////////////////////////////////////////
 
-static char *oapv_ver = "0.1.13.1";
-char * oapv_version() { return oapv_ver; }
+unsigned int oapv_version() {
+#if defined(ANDROID)
+    // For Android, the library version is hardcoded,
+    // because the configuration process does not generate the oapv_version.h
+    // header file containing the definitions for OAPV_VERSION_APISET,
+    // OAPV_VERSION_MAJOR, OAPV_VERSION_MINOR, and OAPV_VERSION_PATCH
+    // that specify the version numbers.
+    const int OAPV_VERSION_APISET = 0;
+    const int OAPV_VERSION_MAJOR  = 1;
+    const int OAPV_VERSION_MINOR  = 13;
+    const int OAPV_VERSION_PATCH  = 1;
+#else
+#if !defined(OAPV_VERSION_APISET) || !defined(OAPV_VERSION_MAJOR) || \
+    !defined(OAPV_VERSION_MINOR) || !defined(OAPV_VERSION_PATCH)
+    #pragma message("Error: version numbers are not defined!")
+#endif
+#endif
+    return OAPV_VER_SET(OAPV_VERSION_APISET, OAPV_VERSION_MAJOR, OAPV_VERSION_MINOR, OAPV_VERSION_PATCH);
+}

version.txt

@@ -1 +1 @@
-v0.1.13
+v0.1.13.1