/[svn]/libgig/trunk/src/helper.h
ViewVC logotype

Diff of /libgig/trunk/src/helper.h

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 803 by schoenebeck, Sat Nov 12 12:36:49 2005 UTC revision 3476 by schoenebeck, Wed Feb 20 19:12:49 2019 UTC
# Line 1  Line 1 
1  /***************************************************************************  /***************************************************************************
2   *                                                                         *   *                                                                         *
3   *   libgig - C++ cross-platform Gigasampler format file loader library    *   *   libgig - C++ cross-platform Gigasampler format file access library    *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003-2005 by Christian Schoenebeck                      *   *   Copyright (C) 2003-2019 by Christian Schoenebeck                      *
6   *                              <cuse@users.sourceforge.net>               *   *                              <cuse@users.sourceforge.net>               *
7   *                                                                         *   *                                                                         *
8   *   This library is free software; you can redistribute it and/or modify  *   *   This library is free software; you can redistribute it and/or modify  *
# Line 24  Line 24 
24  #ifndef __LIBGIG_HELPER_H__  #ifndef __LIBGIG_HELPER_H__
25  #define __LIBGIG_HELPER_H__  #define __LIBGIG_HELPER_H__
26    
27    #include <string.h>
28  #include <string>  #include <string>
29  #include <sstream>  #include <sstream>
30    #include <algorithm>
31    
32    #if defined(WIN32) && !HAVE_CONFIG_H && !defined(_MSC_VER)
33    # include "../win32/libgig_private.h" // like config.h, automatically generated by Dev-C++
34    # define PACKAGE "libgig"
35    # define VERSION VER_STRING // VER_STRING defined in libgig_private.h
36    #endif // WIN32
37    
38    #if (HAVE_CONFIG_H /*&& !HAVE_VASPRINTF*/ && defined(WIN32)) || defined(_MSC_VER)
39    # include <stdarg.h>
40    int vasprintf(char** ret, const char* format, va_list arg);
41    #endif
42    
43    #if defined(_MSC_VER)
44    # if _MSC_VER < 1900
45    #  error versions prior to msvc 2015 have not been tested
46    # else
47    #  include <BaseTsd.h>
48    typedef SSIZE_T ssize_t;
49    # endif
50    #endif
51    
52    #include "RIFF.h"
53    
54  // *************** Helper Functions **************  // *************** Helper Functions **************
55  // *  // *
# Line 36  template<class T> inline std::string ToS Line 60  template<class T> inline std::string ToS
60      return ss.str();      return ss.str();
61  }  }
62    
63    // Behaves as printf() just that it returns it as string instead of writing to stdout.
64    inline std::string strPrint(const char* fmt, ...) {
65        va_list args;
66        va_start(args, fmt);
67        char* buf = NULL;
68        vasprintf(&buf, fmt, args);
69        std::string res = buf;
70        if (buf) free(buf);
71        va_end(args);
72        return res;
73    }
74    
75    inline std::string toLowerCase(std::string s) {
76        std::transform(s.begin(), s.end(), s.begin(), ::tolower);
77        return s;
78    }
79    
80    inline long Min(long A, long B) {
81        return (A > B) ? B : A;
82    }
83    
84    inline long Abs(long val) {
85        return (val > 0) ? val : -val;
86    }
87    
88    inline void swapBytes_16(void* Word) {
89        uint8_t byteCache = *((uint8_t*) Word);
90        *((uint8_t*) Word)     = *((uint8_t*) Word + 1);
91        *((uint8_t*) Word + 1) = byteCache;
92    }
93    
94    inline void swapBytes_32(void* Word) {
95        uint8_t byteCache = *((uint8_t*) Word);
96        *((uint8_t*) Word)     = *((uint8_t*) Word + 3);
97        *((uint8_t*) Word + 3) = byteCache;
98        byteCache = *((uint8_t*) Word + 1);
99        *((uint8_t*) Word + 1) = *((uint8_t*) Word + 2);
100        *((uint8_t*) Word + 2) = byteCache;
101    }
102    
103    inline void swapBytes_64(void* Word) {
104        uint8_t byteCache = ((uint8_t*)Word)[0];
105        ((uint8_t*)Word)[0] = ((uint8_t*)Word)[7];
106        ((uint8_t*)Word)[7] = byteCache;
107        byteCache = ((uint8_t*)Word)[1];
108        ((uint8_t*)Word)[1] = ((uint8_t*)Word)[6];
109        ((uint8_t*)Word)[6] = byteCache;
110        byteCache = ((uint8_t*)Word)[2];
111        ((uint8_t*)Word)[2] = ((uint8_t*)Word)[5];
112        ((uint8_t*)Word)[5] = byteCache;
113        byteCache = ((uint8_t*)Word)[3];
114        ((uint8_t*)Word)[3] = ((uint8_t*)Word)[4];
115        ((uint8_t*)Word)[4] = byteCache;
116    }
117    
118    inline void swapBytes(void* Word, uint64_t WordSize) {
119        uint8_t byteCache;
120        uint64_t lo = 0, hi = WordSize - 1;
121        for (; lo < hi; hi--, lo++) {
122            byteCache = *((uint8_t*) Word + lo);
123            *((uint8_t*) Word + lo) = *((uint8_t*) Word + hi);
124            *((uint8_t*) Word + hi) = byteCache;
125        }
126    }
127    
128    /**
129     * Stores a 16 bit integer in memory using little-endian format.
130     *
131     * @param pData - memory pointer
132     * @param data  - integer to be stored
133     */
134    inline void store16(uint8_t* pData, uint16_t data) {
135        pData[0] = data;
136        pData[1] = data >> 8;
137    }
138    
139    /**
140     * Stores a 32 bit integer in memory using little-endian format.
141     *
142     * @param pData - memory pointer
143     * @param data  - integer to be stored
144     */
145    inline void store32(uint8_t* pData, uint32_t data) {
146        pData[0] = data;
147        pData[1] = data >> 8;
148        pData[2] = data >> 16;
149        pData[3] = data >> 24;
150    }
151    
152    /**
153     * Loads a 16 bit integer in memory using little-endian format.
154     *
155     * @param pData - memory pointer
156     * @returns 16 bit data word
157     */
158    inline uint16_t load16(uint8_t* pData) {
159        return uint16_t(pData[0]) |
160               uint16_t(pData[1]) << 8;
161    }
162    
163    /**
164     * Loads a 32 bit integer in memory using little-endian format.
165     *
166     * @param pData - memory pointer
167     * @returns 32 bit data word
168     */
169    inline uint32_t load32(uint8_t* pData) {
170        return uint32_t(pData[0])       |
171               uint32_t(pData[1]) << 8  |
172               uint32_t(pData[2]) << 16 |
173               uint32_t(pData[3]) << 24;
174    }
175    
176    /**
177     * Swaps the order of the data words in the given memory area
178     * with a granularity given by \a WordSize.
179     *
180     * @param pData    - pointer to the memory area to be swapped
181     * @param AreaSize - size of the memory area to be swapped (in bytes)
182     * @param WordSize - size of the data words (in bytes)
183     */
184    inline void SwapMemoryArea(void* pData, unsigned long AreaSize, uint WordSize) {
185        if (!AreaSize) return; // AreaSize==0 would cause a segfault here
186        switch (WordSize) { // TODO: unefficient
187            case 1: {
188                uint8_t* pDst = (uint8_t*) pData;
189                uint8_t  cache;
190                unsigned long lo = 0, hi = AreaSize - 1;
191                for (; lo < hi; hi--, lo++) {
192                    cache    = pDst[lo];
193                    pDst[lo] = pDst[hi];
194                    pDst[hi] = cache;
195                }
196                break;
197            }
198            case 2: {
199                uint16_t* pDst = (uint16_t*) pData;
200                uint16_t  cache;
201                unsigned long lo = 0, hi = (AreaSize >> 1) - 1;
202                for (; lo < hi; hi--, lo++) {
203                    cache    = pDst[lo];
204                    pDst[lo] = pDst[hi];
205                    pDst[hi] = cache;
206                }
207                break;
208            }
209            case 4: {
210                uint32_t* pDst = (uint32_t*) pData;
211                uint32_t  cache;
212                unsigned long lo = 0, hi = (AreaSize >> 2) - 1;
213                for (; lo < hi; hi--, lo++) {
214                    cache    = pDst[lo];
215                    pDst[lo] = pDst[hi];
216                    pDst[hi] = cache;
217                }
218                break;
219            }
220            default: {
221                uint8_t* pCache = new uint8_t[WordSize]; // TODO: unefficient
222                unsigned long lo = 0, hi = AreaSize - WordSize;
223                for (; lo < hi; hi -= WordSize, lo += WordSize) {
224                    memcpy(pCache, (uint8_t*) pData + lo, WordSize);
225                    memcpy((uint8_t*) pData + lo, (uint8_t*) pData + hi, WordSize);
226                    memcpy((uint8_t*) pData + hi, pCache, WordSize);
227                }
228                if (pCache) delete[] pCache;
229                break;
230            }
231        }
232    }
233    
234    /** @brief Load given info field (string).
235     *
236     * Load info field string from given info chunk (\a ck) and save value to \a s.
237     */
238    inline void LoadString(RIFF::Chunk* ck, std::string& s) {
239        if (ck) {
240            const char* str = (char*)ck->LoadChunkData();
241            if (!str) {
242                ck->ReleaseChunkData();
243                s = "";
244                return;
245            }
246            int size = (int) ck->GetSize();
247            int len;
248            for (len = 0 ; len < size ; len++)
249                if (str[len] == '\0') break;
250            s.assign(str, len);
251            ck->ReleaseChunkData();
252        }
253    }
254    
255    /** @brief Apply given INFO field to the respective chunk.
256     *
257     * Apply given info value string to given info chunk, which is a
258     * subchunk of INFO list chunk \a lstINFO. If the given chunk already
259     * exists, value \a s will be applied. Otherwise if it doesn't exist yet
260     * and either \a s or \a sDefault is not an empty string, such a chunk
261     * will be created and either \a s or \a sDefault will be applied
262     * (depending on which one is not an empty string, if both are not an
263     * empty string \a s will be preferred).
264     *
265     * @param ChunkID  - 32 bit RIFF chunk ID of INFO subchunk (only used in case \a ck is NULL)
266     * @param ck       - INFO (sub)chunk where string should be stored to
267     * @param lstINFO  - parent (INFO) RIFF list chunk
268     * @param s        - current value of info field
269     * @param sDefault - default value
270     * @param bUseFixedLengthStrings - should a specific string size be forced in the chunk?
271     * @param size     - wanted size of the INFO chunk. This is ignored if bUseFixedLengthStrings is false.
272     */
273    inline void SaveString(uint32_t ChunkID, RIFF::Chunk* ck, RIFF::List* lstINFO, const std::string& s, const std::string& sDefault, bool bUseFixedLengthStrings, int size) {
274        if (ck) { // if chunk exists already, use 's' as value
275            if (!bUseFixedLengthStrings) size = (int) s.size() + 1;
276            ck->Resize(size);
277            char* pData = (char*) ck->LoadChunkData();
278            strncpy(pData, s.c_str(), size);
279        } else if (s != "" || sDefault != "" || bUseFixedLengthStrings) { // create chunk
280            const std::string& sToSave = (s != "") ? s : sDefault;
281            if (!bUseFixedLengthStrings) size = (int) sToSave.size() + 1;
282            ck = lstINFO->AddSubChunk(ChunkID, size);
283            char* pData = (char*) ck->LoadChunkData();
284            strncpy(pData, sToSave.c_str(), size);
285        }
286    }
287    
288    // private helper function to convert progress of a subprocess into the global progress
289    inline void __notify_progress(RIFF::progress_t* pProgress, float subprogress) {
290        if (pProgress && pProgress->callback) {
291            const float totalrange    = pProgress->__range_max - pProgress->__range_min;
292            const float totalprogress = pProgress->__range_min + subprogress * totalrange;
293            pProgress->factor         = totalprogress;
294            pProgress->callback(pProgress); // now actually notify about the progress
295        }
296    }
297    
298    // private helper function to divide a progress into subprogresses
299    inline void __divide_progress(RIFF::progress_t* pParentProgress, RIFF::progress_t* pSubProgress, float totalTasks, float currentTask) {
300        if (pParentProgress && pParentProgress->callback) {
301            const float totalrange    = pParentProgress->__range_max - pParentProgress->__range_min;
302            pSubProgress->callback    = pParentProgress->callback;
303            pSubProgress->custom      = pParentProgress->custom;
304            pSubProgress->__range_min = pParentProgress->__range_min + totalrange * currentTask / totalTasks;
305            pSubProgress->__range_max = pSubProgress->__range_min + totalrange / totalTasks;
306        }
307    }
308    
309    #ifdef _WIN32
310    # define NATIVE_PATH_SEPARATOR '\\'
311    #else
312    # define NATIVE_PATH_SEPARATOR '/'
313    #endif
314    
315    /**
316     * Returns the owning path of the given path (its parent path). So for example
317     * passing "/some/path" would return "/some".
318     */
319    inline std::string parentPath(const std::string path) {
320        std::size_t pos = path.find_last_of(NATIVE_PATH_SEPARATOR);
321        return (pos == std::string::npos) ? path : path.substr(0, pos);
322    }
323    
324    /**
325     * Returns the last (lowest) portion of the given path. So for example passing
326     * "/some/path" would return "path".
327     */
328    inline std::string lastPathComponent(const std::string path) {
329        std::size_t pos = path.find_last_of(NATIVE_PATH_SEPARATOR);
330        return (pos == std::string::npos) ? path : path.substr(pos+1);
331    }
332    
333    /**
334     * Returns the given path with the type extension being stripped from its end.
335     * So for example passing "/some/path.foo" would return "/some/path".
336     */
337    inline std::string pathWithoutExtension(const std::string path) {
338        std::size_t posSep = path.find_last_of(NATIVE_PATH_SEPARATOR);
339        std::size_t posBase = (posSep == std::string::npos) ? 0 : posSep+1;
340        std::size_t posDot = path.find_last_of(".", posBase);
341        return (posDot != std::string::npos && posDot > posBase)
342               ? path.substr(0, posDot) : path;
343    }
344    
345    /**
346     * Returns the type extension of the given path. So for example passing
347     * "/some/path.foo" would return "foo".
348     */
349    inline std::string extensionOfPath(const std::string path) {
350        std::size_t posSep = path.find_last_of(NATIVE_PATH_SEPARATOR);
351        std::size_t posBase = (posSep == std::string::npos) ? 0 : posSep+1;
352        std::size_t posDot = path.find_last_of(".", posBase);
353        return (posDot != std::string::npos && posDot > posBase)
354               ? path.substr(posDot+1) : "";
355    }
356    
357    /**
358     * Combines the two given paths with each other. So for example passing
359     * "/some/path" and "/another/one" would return "/some/path/another/one".
360     */
361    inline std::string concatPath(const std::string path1, const std::string path2) {
362        return (!path1.empty() && *(path1.rbegin()) != NATIVE_PATH_SEPARATOR &&
363                !path2.empty() && *(path2.begin())  != NATIVE_PATH_SEPARATOR)
364            ? path1 + NATIVE_PATH_SEPARATOR + path2
365            : path1 + path2;
366    }
367    
368  #endif // __LIBGIG_HELPER_H__  #endif // __LIBGIG_HELPER_H__
Legend:
Removed from v.803  
changed lines
  Added in v.3476
  ViewVC Help
Powered by ViewVC