trunk/src/helper.h

/***************************************************************************
 *                                                                         *
 *   libgig - C++ cross-platform Gigasampler format file access library    *
 *                                                                         *
 *   Copyright (C) 2003-2017 by Christian Schoenebeck                      *
 *                              <cuse@users.sourceforge.net>               *
 *                                                                         *
 *   This library is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This library is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this library; if not, write to the Free Software           *
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,                 *
 *   MA  02111-1307  USA                                                   *
 ***************************************************************************/

#ifndef __LIBGIG_HELPER_H__
#define __LIBGIG_HELPER_H__

#include <string.h>
#include <string>
#include <sstream>
#include <algorithm>

#if defined(WIN32) && !HAVE_CONFIG_H
# include "../win32/libgig_private.h" // like config.h, automatically generated by Dev-C++
# define PACKAGE "libgig"
# define VERSION VER_STRING // VER_STRING defined in libgig_private.h
#endif // WIN32

#if HAVE_CONFIG_H /*&& !HAVE_VASPRINTF*/ && defined(WIN32)
# include <stdarg.h>
int vasprintf(char** ret, const char* format, va_list arg);
#endif

#include "RIFF.h"

// *************** Helper Functions **************
// *

template<class T> inline std::string ToString(T o) {
    std::stringstream ss;
    ss << o;
    return ss.str();
}

inline std::string toLowerCase(std::string s) {
    std::transform(s.begin(), s.end(), s.begin(), ::tolower);
    return s;
}

inline long Min(long A, long B) {
    return (A > B) ? B : A;
}

inline long Abs(long val) {
    return (val > 0) ? val : -val;
}

inline void swapBytes_16(void* Word) {
    uint8_t byteCache = *((uint8_t*) Word);
    *((uint8_t*) Word)     = *((uint8_t*) Word + 1);
    *((uint8_t*) Word + 1) = byteCache;
}

inline void swapBytes_32(void* Word) {
    uint8_t byteCache = *((uint8_t*) Word);
    *((uint8_t*) Word)     = *((uint8_t*) Word + 3);
    *((uint8_t*) Word + 3) = byteCache;
    byteCache = *((uint8_t*) Word + 1);
    *((uint8_t*) Word + 1) = *((uint8_t*) Word + 2);
    *((uint8_t*) Word + 2) = byteCache;
}

inline void swapBytes_64(void* Word) {
    uint8_t byteCache = ((uint8_t*)Word)[0];
    ((uint8_t*)Word)[0] = ((uint8_t*)Word)[7];
    ((uint8_t*)Word)[7] = byteCache;
    byteCache = ((uint8_t*)Word)[1];
    ((uint8_t*)Word)[1] = ((uint8_t*)Word)[6];
    ((uint8_t*)Word)[6] = byteCache;
    byteCache = ((uint8_t*)Word)[2];
    ((uint8_t*)Word)[2] = ((uint8_t*)Word)[5];
    ((uint8_t*)Word)[5] = byteCache;
    byteCache = ((uint8_t*)Word)[3];
    ((uint8_t*)Word)[3] = ((uint8_t*)Word)[4];
    ((uint8_t*)Word)[4] = byteCache;
}

inline void swapBytes(void* Word, uint64_t WordSize) {
    uint8_t byteCache;
    uint64_t lo = 0, hi = WordSize - 1;
    for (; lo < hi; hi--, lo++) {
        byteCache = *((uint8_t*) Word + lo);
        *((uint8_t*) Word + lo) = *((uint8_t*) Word + hi);
        *((uint8_t*) Word + hi) = byteCache;
    }
}

/**
 * Stores a 16 bit integer in memory using little-endian format.
 *
 * @param pData - memory pointer
 * @param data  - integer to be stored
 */
inline void store16(uint8_t* pData, uint16_t data) {
    pData[0] = data;
    pData[1] = data >> 8;
}

/**
 * Stores a 32 bit integer in memory using little-endian format.
 *
 * @param pData - memory pointer
 * @param data  - integer to be stored
 */
inline void store32(uint8_t* pData, uint32_t data) {
    pData[0] = data;
    pData[1] = data >> 8;
    pData[2] = data >> 16;
    pData[3] = data >> 24;
}

/**
 * Loads a 32 bit integer in memory using little-endian format.
 *
 * @param pData - memory pointer
 * @returns 32 bit data word
 */
inline uint32_t load32(uint8_t* pData) {
    return uint32_t(pData[0])       |
           uint32_t(pData[1]) << 8  |
           uint32_t(pData[2]) << 16 |
           uint32_t(pData[3]) << 24;
}

/**
 * Swaps the order of the data words in the given memory area
 * with a granularity given by \a WordSize.
 *
 * @param pData    - pointer to the memory area to be swapped
 * @param AreaSize - size of the memory area to be swapped (in bytes)
 * @param WordSize - size of the data words (in bytes)
 */
inline void SwapMemoryArea(void* pData, unsigned long AreaSize, uint WordSize) {
    if (!AreaSize) return; // AreaSize==0 would cause a segfault here
    switch (WordSize) { // TODO: unefficient
        case 1: {
            uint8_t* pDst = (uint8_t*) pData;
            uint8_t  cache;
            unsigned long lo = 0, hi = AreaSize - 1;
            for (; lo < hi; hi--, lo++) {
                cache    = pDst[lo];
                pDst[lo] = pDst[hi];
                pDst[hi] = cache;
            }
            break;
        }
        case 2: {
            uint16_t* pDst = (uint16_t*) pData;
            uint16_t  cache;
            unsigned long lo = 0, hi = (AreaSize >> 1) - 1;
            for (; lo < hi; hi--, lo++) {
                cache    = pDst[lo];
                pDst[lo] = pDst[hi];
                pDst[hi] = cache;
            }
            break;
        }
        case 4: {
            uint32_t* pDst = (uint32_t*) pData;
            uint32_t  cache;
            unsigned long lo = 0, hi = (AreaSize >> 2) - 1;
            for (; lo < hi; hi--, lo++) {
                cache    = pDst[lo];
                pDst[lo] = pDst[hi];
                pDst[hi] = cache;
            }
            break;
        }
        default: {
            uint8_t* pCache = new uint8_t[WordSize]; // TODO: unefficient
            unsigned long lo = 0, hi = AreaSize - WordSize;
            for (; lo < hi; hi -= WordSize, lo += WordSize) {
                memcpy(pCache, (uint8_t*) pData + lo, WordSize);
                memcpy((uint8_t*) pData + lo, (uint8_t*) pData + hi, WordSize);
                memcpy((uint8_t*) pData + hi, pCache, WordSize);
            }
            if (pCache) delete[] pCache;
            break;
        }
    }
}

/** @brief Load given info field (string).
 *
 * Load info field string from given info chunk (\a ck) and save value to \a s.
 */
inline void LoadString(RIFF::Chunk* ck, std::string& s) {
    if (ck) {
        const char* str = (char*)ck->LoadChunkData();
        int size = (int) ck->GetSize();
        int len;
        for (len = 0 ; len < size ; len++)
            if (str[len] == '\0') break;
        s.assign(str, len);
        ck->ReleaseChunkData();
    }
}

/** @brief Apply given INFO field to the respective chunk.
 *
 * Apply given info value string to given info chunk, which is a
 * subchunk of INFO list chunk \a lstINFO. If the given chunk already
 * exists, value \a s will be applied. Otherwise if it doesn't exist yet
 * and either \a s or \a sDefault is not an empty string, such a chunk
 * will be created and either \a s or \a sDefault will be applied
 * (depending on which one is not an empty string, if both are not an
 * empty string \a s will be preferred).
 *
 * @param ChunkID  - 32 bit RIFF chunk ID of INFO subchunk (only used in case \a ck is NULL)
 * @param ck       - INFO (sub)chunk where string should be stored to
 * @param lstINFO  - parent (INFO) RIFF list chunk
 * @param s        - current value of info field
 * @param sDefault - default value
 * @param bUseFixedLengthStrings - should a specific string size be forced in the chunk?
 * @param size     - wanted size of the INFO chunk. This is ignored if bUseFixedLengthStrings is false.
 */
inline void SaveString(uint32_t ChunkID, RIFF::Chunk* ck, RIFF::List* lstINFO, const std::string& s, const std::string& sDefault, bool bUseFixedLengthStrings, int size) {
    if (ck) { // if chunk exists already, use 's' as value
        if (!bUseFixedLengthStrings) size = (int) s.size() + 1;
        ck->Resize(size);
        char* pData = (char*) ck->LoadChunkData();
        strncpy(pData, s.c_str(), size);
    } else if (s != "" || sDefault != "" || bUseFixedLengthStrings) { // create chunk
        const std::string& sToSave = (s != "") ? s : sDefault;
        if (!bUseFixedLengthStrings) size = (int) sToSave.size() + 1;
        ck = lstINFO->AddSubChunk(ChunkID, size);
        char* pData = (char*) ck->LoadChunkData();
        strncpy(pData, sToSave.c_str(), size);
    }
}

// private helper function to convert progress of a subprocess into the global progress
inline void __notify_progress(RIFF::progress_t* pProgress, float subprogress) {
    if (pProgress && pProgress->callback) {
        const float totalrange    = pProgress->__range_max - pProgress->__range_min;
        const float totalprogress = pProgress->__range_min + subprogress * totalrange;
        pProgress->factor         = totalprogress;
        pProgress->callback(pProgress); // now actually notify about the progress
    }
}

// private helper function to divide a progress into subprogresses
inline void __divide_progress(RIFF::progress_t* pParentProgress, RIFF::progress_t* pSubProgress, float totalTasks, float currentTask) {
    if (pParentProgress && pParentProgress->callback) {
        const float totalrange    = pParentProgress->__range_max - pParentProgress->__range_min;
        pSubProgress->callback    = pParentProgress->callback;
        pSubProgress->custom      = pParentProgress->custom;
        pSubProgress->__range_min = pParentProgress->__range_min + totalrange * currentTask / totalTasks;
        pSubProgress->__range_max = pSubProgress->__range_min + totalrange / totalTasks;
    }
}

#endif // __LIBGIG_HELPER_H__
1	schoenebeck	803	/***************************************************************************
2			* *
3	schoenebeck	933	* libgig - C++ cross-platform Gigasampler format file access library *
4	schoenebeck	803	* *
5	schoenebeck	3185	* Copyright (C) 2003-2017 by Christian Schoenebeck *
6	schoenebeck	803	* <cuse@users.sourceforge.net> *
7			* *
8			* This library is free software; you can redistribute it and/or modify *
9			* it under the terms of the GNU General Public License as published by *
10			* the Free Software Foundation; either version 2 of the License, or *
11			* (at your option) any later version. *
12			* *
13			* This library is distributed in the hope that it will be useful, *
14			* but WITHOUT ANY WARRANTY; without even the implied warranty of *
15			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16			* GNU General Public License for more details. *
17			* *
18			* You should have received a copy of the GNU General Public License *
19			* along with this library; if not, write to the Free Software *
20			* Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
21			* MA 02111-1307 USA *
22			***************************************************************************/
23
24			#ifndef __LIBGIG_HELPER_H__
25			#define __LIBGIG_HELPER_H__
26
27	schoenebeck	809	#include <string.h>
28	schoenebeck	803	#include <string>
29			#include <sstream>
30	schoenebeck	3185	#include <algorithm>
31	schoenebeck	803
32	persson	1330	#if defined(WIN32) && !HAVE_CONFIG_H
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	schoenebeck	3200	#if HAVE_CONFIG_H /&& !HAVE_VASPRINTF/ && defined(WIN32)
39	schoenebeck	3199	# include <stdarg.h>
40			int vasprintf(char** ret, const char* format, va_list arg);
41			#endif
42
43	schoenebeck	929	#include "RIFF.h"
44
45	schoenebeck	803	// ************* Helper Functions ************
46			// *
47
48			template<class T> inline std::string ToString(T o) {
49			std::stringstream ss;
50			ss << o;
51			return ss.str();
52			}
53
54	schoenebeck	3185	inline std::string toLowerCase(std::string s) {
55			std::transform(s.begin(), s.end(), s.begin(), ::tolower);
56			return s;
57			}
58
59	schoenebeck	809	inline long Min(long A, long B) {
60			return (A > B) ? B : A;
61			}
62
63			inline long Abs(long val) {
64			return (val > 0) ? val : -val;
65			}
66
67	schoenebeck	2912	inline void swapBytes_16(void* Word) {
68			uint8_t byteCache = ((uint8_t) Word);
69			((uint8_t) Word) = ((uint8_t) Word + 1);
70			((uint8_t) Word + 1) = byteCache;
71			}
72
73			inline void swapBytes_32(void* Word) {
74			uint8_t byteCache = ((uint8_t) Word);
75			((uint8_t) Word) = ((uint8_t) Word + 3);
76			((uint8_t) Word + 3) = byteCache;
77			byteCache = ((uint8_t) Word + 1);
78			((uint8_t) Word + 1) = ((uint8_t) Word + 2);
79			((uint8_t) Word + 2) = byteCache;
80			}
81
82			inline void swapBytes_64(void* Word) {
83			uint8_t byteCache = ((uint8_t*)Word)[0];
84			((uint8_t)Word)[0] = ((uint8_t)Word)[7];
85			((uint8_t*)Word)[7] = byteCache;
86			byteCache = ((uint8_t*)Word)[1];
87			((uint8_t)Word)[1] = ((uint8_t)Word)[6];
88			((uint8_t*)Word)[6] = byteCache;
89			byteCache = ((uint8_t*)Word)[2];
90			((uint8_t)Word)[2] = ((uint8_t)Word)[5];
91			((uint8_t*)Word)[5] = byteCache;
92			byteCache = ((uint8_t*)Word)[3];
93			((uint8_t)Word)[3] = ((uint8_t)Word)[4];
94			((uint8_t*)Word)[4] = byteCache;
95			}
96
97			inline void swapBytes(void* Word, uint64_t WordSize) {
98			uint8_t byteCache;
99			uint64_t lo = 0, hi = WordSize - 1;
100			for (; lo < hi; hi--, lo++) {
101			byteCache = ((uint8_t) Word + lo);
102			((uint8_t) Word + lo) = ((uint8_t) Word + hi);
103			((uint8_t) Word + hi) = byteCache;
104			}
105			}
106
107	schoenebeck	809	/**
108	persson	1179	* Stores a 16 bit integer in memory using little-endian format.
109			*
110			* @param pData - memory pointer
111			* @param data - integer to be stored
112			*/
113			inline void store16(uint8_t* pData, uint16_t data) {
114			pData[0] = data;
115			pData[1] = data >> 8;
116			}
117
118			/**
119			* Stores a 32 bit integer in memory using little-endian format.
120			*
121			* @param pData - memory pointer
122			* @param data - integer to be stored
123			*/
124			inline void store32(uint8_t* pData, uint32_t data) {
125			pData[0] = data;
126			pData[1] = data >> 8;
127			pData[2] = data >> 16;
128			pData[3] = data >> 24;
129			}
130
131			/**
132	schoenebeck	2912	* Loads a 32 bit integer in memory using little-endian format.
133			*
134			* @param pData - memory pointer
135			* @returns 32 bit data word
136			*/
137			inline uint32_t load32(uint8_t* pData) {
138			return uint32_t(pData[0]) \|
139			uint32_t(pData[1]) << 8 \|
140			uint32_t(pData[2]) << 16 \|
141			uint32_t(pData[3]) << 24;
142			}
143
144			/**
145	schoenebeck	809	* Swaps the order of the data words in the given memory area
146			* with a granularity given by \a WordSize.
147			*
148			* @param pData - pointer to the memory area to be swapped
149			* @param AreaSize - size of the memory area to be swapped (in bytes)
150			* @param WordSize - size of the data words (in bytes)
151			*/
152			inline void SwapMemoryArea(void* pData, unsigned long AreaSize, uint WordSize) {
153	schoenebeck	1875	if (!AreaSize) return; // AreaSize==0 would cause a segfault here
154	schoenebeck	809	switch (WordSize) { // TODO: unefficient
155			case 1: {
156			uint8_t* pDst = (uint8_t*) pData;
157			uint8_t cache;
158			unsigned long lo = 0, hi = AreaSize - 1;
159			for (; lo < hi; hi--, lo++) {
160			cache = pDst[lo];
161			pDst[lo] = pDst[hi];
162			pDst[hi] = cache;
163			}
164			break;
165			}
166			case 2: {
167			uint16_t* pDst = (uint16_t*) pData;
168			uint16_t cache;
169			unsigned long lo = 0, hi = (AreaSize >> 1) - 1;
170			for (; lo < hi; hi--, lo++) {
171			cache = pDst[lo];
172			pDst[lo] = pDst[hi];
173			pDst[hi] = cache;
174			}
175			break;
176			}
177			case 4: {
178			uint32_t* pDst = (uint32_t*) pData;
179			uint32_t cache;
180			unsigned long lo = 0, hi = (AreaSize >> 2) - 1;
181			for (; lo < hi; hi--, lo++) {
182			cache = pDst[lo];
183			pDst[lo] = pDst[hi];
184			pDst[hi] = cache;
185			}
186			break;
187			}
188			default: {
189			uint8_t* pCache = new uint8_t[WordSize]; // TODO: unefficient
190			unsigned long lo = 0, hi = AreaSize - WordSize;
191			for (; lo < hi; hi -= WordSize, lo += WordSize) {
192			memcpy(pCache, (uint8_t*) pData + lo, WordSize);
193			memcpy((uint8_t) pData + lo, (uint8_t) pData + hi, WordSize);
194			memcpy((uint8_t*) pData + hi, pCache, WordSize);
195			}
196	schoenebeck	1875	if (pCache) delete[] pCache;
197	schoenebeck	809	break;
198			}
199			}
200			}
201
202	schoenebeck	929	/** @brief Load given info field (string).
203			*
204			* Load info field string from given info chunk (\a ck) and save value to \a s.
205			*/
206			inline void LoadString(RIFF::Chunk* ck, std::string& s) {
207			if (ck) {
208			const char* str = (char*)ck->LoadChunkData();
209	schoenebeck	3053	int size = (int) ck->GetSize();
210	schoenebeck	929	int len;
211			for (len = 0 ; len < size ; len++)
212			if (str[len] == '\0') break;
213			s.assign(str, len);
214			ck->ReleaseChunkData();
215			}
216			}
217
218			/** @brief Apply given INFO field to the respective chunk.
219			*
220			* Apply given info value string to given info chunk, which is a
221			* subchunk of INFO list chunk \a lstINFO. If the given chunk already
222			* exists, value \a s will be applied. Otherwise if it doesn't exist yet
223			* and either \a s or \a sDefault is not an empty string, such a chunk
224			* will be created and either \a s or \a sDefault will be applied
225			* (depending on which one is not an empty string, if both are not an
226			* empty string \a s will be preferred).
227			*
228			* @param ChunkID - 32 bit RIFF chunk ID of INFO subchunk (only used in case \a ck is NULL)
229			* @param ck - INFO (sub)chunk where string should be stored to
230			* @param lstINFO - parent (INFO) RIFF list chunk
231			* @param s - current value of info field
232			* @param sDefault - default value
233			* @param bUseFixedLengthStrings - should a specific string size be forced in the chunk?
234			* @param size - wanted size of the INFO chunk. This is ignored if bUseFixedLengthStrings is false.
235			*/
236			inline void SaveString(uint32_t ChunkID, RIFF::Chunk* ck, RIFF::List* lstINFO, const std::string& s, const std::string& sDefault, bool bUseFixedLengthStrings, int size) {
237			if (ck) { // if chunk exists already, use 's' as value
238	schoenebeck	3053	if (!bUseFixedLengthStrings) size = (int) s.size() + 1;
239	schoenebeck	929	ck->Resize(size);
240			char* pData = (char*) ck->LoadChunkData();
241			strncpy(pData, s.c_str(), size);
242	persson	1180	} else if (s != "" \|\| sDefault != "" \|\| bUseFixedLengthStrings) { // create chunk
243	schoenebeck	929	const std::string& sToSave = (s != "") ? s : sDefault;
244	schoenebeck	3053	if (!bUseFixedLengthStrings) size = (int) sToSave.size() + 1;
245	schoenebeck	929	ck = lstINFO->AddSubChunk(ChunkID, size);
246			char* pData = (char*) ck->LoadChunkData();
247			strncpy(pData, sToSave.c_str(), size);
248			}
249			}
250
251	schoenebeck	2682	// private helper function to convert progress of a subprocess into the global progress
252			inline void __notify_progress(RIFF::progress_t* pProgress, float subprogress) {
253			if (pProgress && pProgress->callback) {
254			const float totalrange = pProgress->__range_max - pProgress->__range_min;
255			const float totalprogress = pProgress->__range_min + subprogress * totalrange;
256			pProgress->factor = totalprogress;
257			pProgress->callback(pProgress); // now actually notify about the progress
258			}
259			}
260
261			// private helper function to divide a progress into subprogresses
262			inline void __divide_progress(RIFF::progress_t* pParentProgress, RIFF::progress_t* pSubProgress, float totalTasks, float currentTask) {
263			if (pParentProgress && pParentProgress->callback) {
264			const float totalrange = pParentProgress->__range_max - pParentProgress->__range_min;
265			pSubProgress->callback = pParentProgress->callback;
266			pSubProgress->custom = pParentProgress->custom;
267			pSubProgress->__range_min = pParentProgress->__range_min + totalrange * currentTask / totalTasks;
268			pSubProgress->__range_max = pSubProgress->__range_min + totalrange / totalTasks;
269			}
270			}
271
272	schoenebeck	803	#endif // __LIBGIG_HELPER_H__