cliprs 0.2.1

Rust bindings to CLIP.cpp
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278

#include "common-clip.h"

#include <cassert>
#include <cmath>
#include <cstdint>
#include <cstdio>
#include <cstdlib>
#include <cstring>
#include <fstream>
#include <iostream>
#include <map>
#include <vector>

#ifdef _WIN32
#include <tchar.h>
#include <windows.h>
#else
#include <dirent.h>
#include <sys/stat.h>
#endif

// common utility functions mainly intended for examples and debugging

std::map<std::string, std::vector<std::string>> get_dir_keyed_files(const std::string & path, uint32_t max_files_per_dir = 0) {
    std::map<std::string, std::vector<std::string>> result;

#ifdef _WIN32
    std::string wildcard = path + "\\*";
    WIN32_FIND_DATAA fileData;
    HANDLE hFind = FindFirstFileA(wildcard.c_str(), &fileData);

    if (hFind == INVALID_HANDLE_VALUE) {
        std::cerr << "Failed to open directory: " << path << std::endl;
        return result;
    }

    uint32_t fileCount = 0;

    do {
        std::string name = fileData.cFileName;
        std::string fullPath = path + "\\" + name;

        if (fileData.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) {
            // Skip . and ..
            if (name == "." || name == "..")
                continue;

            std::map<std::string, std::vector<std::string>> subResult = get_dir_keyed_files(fullPath, max_files_per_dir);
            result.insert(subResult.begin(), subResult.end());
        } else {
            size_t pos = path.find_last_of("\\/");
            std::string parentDir = (pos != std::string::npos) ? path.substr(pos + 1) : path;
            result[parentDir].push_back(fullPath);

            ++fileCount;
            if (max_files_per_dir > 0 && fileCount >= max_files_per_dir)
                break;
        }
    } while (FindNextFileA(hFind, &fileData));

    FindClose(hFind);
#else
    DIR * dir;
    struct dirent * entry;
    struct stat fileStat;

    if ((dir = opendir(path.c_str())) == NULL) {
        std::cerr << "Failed to open directory: " << path << std::endl;
        return result;
    }

    uint32_t fileCount = 0;

    while ((entry = readdir(dir)) != NULL) {
        std::string name = entry->d_name;
        std::string fullPath = path + "/" + name;

        if (stat(fullPath.c_str(), &fileStat) < 0) {
            std::cerr << "Failed to get file stat: " << fullPath << std::endl;
            continue;
        }

        if (S_ISDIR(fileStat.st_mode)) {
            // Skip . and ..
            if (name == "." || name == "..")
                continue;

            std::map<std::string, std::vector<std::string>> subResult = get_dir_keyed_files(fullPath, max_files_per_dir);
            result.insert(subResult.begin(), subResult.end());
        } else {
            if (!is_image_file_extension(fullPath)) {
                continue;
            }
            size_t pos = path.find_last_of("/");
            std::string parentDir = (pos != std::string::npos) ? path.substr(pos + 1) : path;
            result[parentDir].push_back(fullPath);

            ++fileCount;
            if (max_files_per_dir > 0 && fileCount >= max_files_per_dir)
                break;
        }
    }

    closedir(dir);
#endif

    return result;
}

bool is_image_file_extension(const std::string & path) {
    size_t pos = path.find_last_of(".");
    if (pos == std::string::npos) {
        return false;
    }

    std::string ext = path.substr(pos);

    if (ext == ".jpg")
        return true;
    if (ext == ".JPG")
        return true;

    if (ext == ".jpeg")
        return true;
    if (ext == ".JPEG")
        return true;

    if (ext == ".gif")
        return true;
    if (ext == ".GIF")
        return true;

    if (ext == ".png")
        return true;
    if (ext == ".PNG")
        return true;

    // TODO(green-sky): determine if we should add more formats from stbi. tga/hdr/pnm seem kinda niche.

    return false;
}

bool app_params_parse(int argc, char ** argv, app_params & params, const int min_text_arg, const int min_image_arg) {
    for (int i = 0; i < argc; i++) {
        std::string arg = std::string(argv[i]);
        if (arg == "-m" || arg == "--model") {
            params.model = argv[++i];
        } else if (arg == "-t" || arg == "--threads") {
            params.n_threads = std::stoi(argv[++i]);
        } else if (arg == "--text") {
            params.texts.push_back(argv[++i]);
        } else if (arg == "--image") {
            params.image_paths.push_back(argv[++i]);
        } else if (arg == "-v" || arg == "--verbose") {
            params.verbose = std::stoi(argv[++i]);
        } else if (arg == "-h" || arg == "--help") {
            print_help(argc, argv, params, min_text_arg, min_image_arg);
            exit(0);
        } else {
            if (i != 0) {
                printf("%s: unrecognized argument: %s\n", __func__, arg.c_str());
                return false;
            }
        }
    }
    return params.image_paths.size() >= min_image_arg && params.texts.size() >= min_text_arg;
}

void print_help(int argc, char ** argv, app_params & params, const int min_text_arg, const int min_image_arg) {
    printf("Usage: %s [options]\n", argv[0]);
    printf("\nOptions:");
    printf("  -h, --help: Show this message and exit\n");
    printf("  -m <path>, --model <path>: path to model. Default: %s\n", params.model.c_str());
    printf("  -t N, --threads N: Number of threads to use for inference. Default: %d\n", params.n_threads);
    printf("  --text <text>: Text to encode");
    if (min_text_arg >= 1) {
        printf(". At least %d text should be specified\n", min_text_arg);
    } else {
        printf("\n");
    }
    printf("  --image <path>: Path to an image file");
    if (min_image_arg >= 1) {
        printf(". At least one image path should be specified\n");
    } else {
        printf("\n");
    }
    printf("  -v <level>, --verbose <level>: Control the level of verbosity. 0 = minimum, 2 = maximum. Default: %d\n",
           params.verbose);
}

void write_floats_to_file(float * array, int size, char * filename) {
    // Open the file for writing.
    FILE * file = fopen(filename, "w");
    if (file == NULL) {
        printf("Error opening file: %s\n", filename);
        return;
    }

    // Write the float values to the file.
    for (int i = 0; i < size; i++) {
        fprintf(file, "%f\n", array[i]);
    }

    // Close the file.
    fclose(file);
}

// Define a structure to represent the numpy header
typedef struct {
    uint8_t major_version;
    uint8_t minor_version;
    uint16_t header_len;
    char * header[128];
} NumpyHeader;

// Function to write a numpy .npy file
int writeNpyFile(const char * filename, const float * data, const int * shape, int ndims) {
    if (ndims != 2) {
        printf("Only 2-dimensional arrays are supported for now\n");
        return 1;
    }

    FILE * file = fopen(filename, "wb");
    if (!file) {
        perror("Error opening file");
        return 1;
    }

    // Create the numpy header
    NumpyHeader header;
    header.major_version = 1;
    header.minor_version = 0;

    // Calculate the length of the header data
    snprintf((char *)header.header, sizeof(header.header), "{'descr': '<f4', 'fortran_order': False, 'shape': (%d, %d), }",
             shape[0], shape[1]);
    header.header_len = 118;

    // Write the numpy header to the file
    fwrite("\x93NUMPY", 1, 6, file);
    fwrite(&header.major_version, 1, 1, file);
    fwrite(&header.minor_version, 1, 1, file);
    fwrite(&header.header_len, 2, 1, file);
    fwrite((char *)header.header, 1, strlen((char *)header.header), file);
    const int padding_len = 128 - (10 + strlen((char *)header.header) + 1);
    for (int i = 0; i < padding_len; ++i) {
        fputc(0x20, file);
    }
    fputc(0x0a, file);

    // Write the array data (assuming little-endian format)
    int num_elements = 1;
    for (int i = 0; i < ndims; i++) {
        num_elements *= shape[i];
    }
    fwrite(data, sizeof(float) * num_elements, 1, file);

    // Clean up and close the file
    fclose(file);

    return 0;
}

// Constructor-like function
struct clip_image_u8_batch clip_image_u8_batch_make(std::vector<clip_image_u8> & images) {
    struct clip_image_u8_batch batch;
    batch.data = images.data();
    batch.size = images.size();
    return batch;
}

// Constructor-like function
struct clip_image_f32_batch clip_image_f32_batch_make(std::vector<clip_image_f32> & images) {
    struct clip_image_f32_batch batch;
    batch.data = images.data();
    batch.size = images.size();
    return batch;
}