whisper : rename binaries + fix build (wip)

Author: ggerganov

README.md

@@ -97,52 +97,35 @@ include_directories(${CMAKE_CURRENT_SOURCE_DIR})
 
 if (EMSCRIPTEN)
     add_subdirectory(whisper.wasm)
-    set_target_properties(libmain PROPERTIES FOLDER "libs")
     add_subdirectory(stream.wasm)
-    set_target_properties(libstream PROPERTIES FOLDER "libs")
     add_subdirectory(command.wasm)
-    set_target_properties(libcommand PROPERTIES FOLDER "libs")
     #add_subdirectory(talk.wasm)
-    #set_target_properties(libtalk PROPERTIES FOLDER "libs")
     add_subdirectory(bench.wasm)
-    set_target_properties(libbench PROPERTIES FOLDER "libs")
 elseif(CMAKE_JS_VERSION)
     add_subdirectory(addon.node)
-    set_target_properties(addon.node PROPERTIES FOLDER "examples")
 else()
-    add_subdirectory(main)
-    set_target_properties(main PROPERTIES FOLDER "examples")
+    add_subdirectory(cli)
 if (WHISPER_SDL2)
     add_subdirectory(stream)
-    set_target_properties(stream PROPERTIES FOLDER "examples")
 endif (WHISPER_SDL2)
     add_subdirectory(server)
-    set_target_properties(server PROPERTIES FOLDER "examples")
 if (WHISPER_SDL2)
     add_subdirectory(command)
-    set_target_properties(command PROPERTIES FOLDER "examples")
 endif (WHISPER_SDL2)
     add_subdirectory(bench)
-    set_target_properties(bench PROPERTIES FOLDER "examples")
     add_subdirectory(quantize)
-    set_target_properties(quantize PROPERTIES FOLDER "examples")
 if (WHISPER_SDL2)
     # TODO: disabled until update
     #       https://github.com/ggerganov/whisper.cpp/issues/1818
     #add_subdirectory(talk)
-    #set_target_properties(talk PROPERTIES FOLDER "examples")
     add_subdirectory(talk-llama)
-    set_target_properties(talk-llama PROPERTIES FOLDER "examples")
     add_subdirectory(lsp)
-    set_target_properties(lsp PROPERTIES FOLDER "examples")
     if (GGML_SYCL)
         add_subdirectory(sycl)
-        set_target_properties(ls-sycl-device PROPERTIES FOLDER "examples")
     endif()
 endif (WHISPER_SDL2)
 endif()
 
 if (WHISPER_SDL2)
     add_subdirectory(wchess)
-    set_target_properties(wchess PROPERTIES FOLDER "examples")
 endif (WHISPER_SDL2)

examples/CMakeLists.txt

@@ -0,0 +1,11 @@
+set(TARGET whisper-cli)
+add_executable(${TARGET} cli.cpp)
+
+include(DefaultTargetOptions)
+
+target_link_libraries(${TARGET} PRIVATE common whisper ${FFMPEG_LIBRARIES} ${CMAKE_THREAD_LIBS_INIT})
+
+install(TARGETS ${TARGET} RUNTIME)
+
+add_executable(main ../deprecation-warning.cpp)
+target_compile_features(main PRIVATE cxx_std_11)

examples/cli/CMakeLists.txt

@@ -1,12 +1,12 @@
-# main
+# whisper.cpp/examples/cli
 
 This is the main example demonstrating most of the functionality of the Whisper model.
 It can be used as a reference for using the `whisper.cpp` library in other projects.
 
 ```
-./main -h
+./build/bin/whisper-cli -h
 
-usage: ./main [options] file0.wav file1.wav ...
+usage: ./whisper-cli [options] file0.wav file1.wav ...
 
 options:
   -h,        --help              [default] show this help message and exit

examples/main/README.md renamed to examples/cli/README.md

@@ -0,0 +1,35 @@
+// Warns users that this filename was deprecated, and provides a link for more information.
+
+#include <cstdio>
+#include <string>
+#include <unordered_map>
+
+// Main
+int main(int argc, char** argv) {
+    std::string filename = "main";
+    if (argc >= 1) {
+        filename = argv[0];
+    }
+
+    // Get only the program name from the full path
+    auto pos = filename.find_last_of("/\\");
+    if (pos != std::string::npos) {
+        filename = filename.substr(pos+1);
+    }
+
+    // Append "llama-" to the beginning of filename to get the replacemnt filename
+    auto replacement_filename = "llama-" + filename;
+
+    // The exception is if the filename is "main", then our replacement filename is "llama-cli"
+    if (filename == "main") {
+        replacement_filename = "llama-cli";
+    }
+
+    fprintf(stdout, "\n");
+    fprintf(stdout, "WARNING: The binary '%s' is deprecated.\n", filename.c_str());
+    fprintf(stdout, " Please use '%s' instead.\n", replacement_filename.c_str());
+    fprintf(stdout, " See https://github.com/ggerganov/llama.cpp/tree/master/examples/deprecation-warning/README.md for more information.\n");
+    fprintf(stdout, "\n");
+
+    return EXIT_FAILURE;
+}