engines/common/SampleFile.cpp

/***************************************************************************
 *                                                                         *
 *   LinuxSampler - modular, streaming capable sampler                     *
 *                                                                         *
 *   Copyright (C) 2003 - 2009 Christian Schoenebeck                       *
 *   Copyright (C) 2009 - 2013 Grigor Iliev                                *
 *                                                                         *
 *   This program 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 program 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 program; if not, write to the Free Software           *
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,                 *
 *   MA  02111-1307  USA                                                   *
 ***************************************************************************/

#include "SampleFile.h"
#include "../../common/global_private.h"
#include "../../common/Exception.h"

#include <cstring>

#define CONVERT_BUFFER_SIZE 4096

namespace LinuxSampler {
    #if CONFIG_DEVMODE
    int SampleFile_OpenFilesCount = 0;
    #endif

    SampleFile::SampleFile(String File, bool DontClose) {
        this->File      = File;
        this->pSndFile  = NULL;
        pConvertBuffer  = NULL;

        SF_INFO sfInfo;
        sfInfo.format = 0;
        pSndFile = sf_open(File.c_str(), SFM_READ, &sfInfo);
        if(pSndFile == NULL) throw Exception(File + ": Can't get sample info: " + String(sf_strerror (NULL)));
        #if CONFIG_DEVMODE
        std::cout << "Number of opened sample files: " << ++SampleFile_OpenFilesCount << std::endl;
        #endif
        SampleRate = sfInfo.samplerate;
        ChannelCount = sfInfo.channels;
        Format = sfInfo.format;

        switch(Format & SF_FORMAT_SUBMASK) {
            case SF_FORMAT_PCM_S8:
            case SF_FORMAT_PCM_U8:
            case SF_FORMAT_DPCM_8:
                FrameSize = ChannelCount;
                break;
            case SF_FORMAT_PCM_16:
            case SF_FORMAT_DPCM_16:
                FrameSize = 2 * ChannelCount;
                break;
            case SF_FORMAT_PCM_24:
            case SF_FORMAT_DWVW_24:
                FrameSize = 3 * ChannelCount;
                break;
            default:
                FrameSize = 2 * ChannelCount;
        }
        TotalFrameCount = sfInfo.frames;

        Loops = 0;
        LoopStart = 0;
        LoopEnd = 0;
        SF_INSTRUMENT instrument;
        if (sf_command(pSndFile, SFC_GET_INSTRUMENT,
                       &instrument, sizeof(instrument)) != SF_FALSE) {
            // TODO: instrument.basenote
#if HAVE_SF_INSTRUMENT_LOOPS
            if (instrument.loop_count && instrument.loops[0].mode != SF_LOOP_NONE) {
                Loops = 1;
                LoopStart = instrument.loops[0].start;
                LoopEnd = instrument.loops[0].end;
            }
#endif
        }
        if(!DontClose) Close();

#if HAVE_DECL_SF_FORMAT_FLAC
        if (FrameSize == 3 * ChannelCount &&
            (Format & SF_FORMAT_TYPEMASK) == SF_FORMAT_FLAC) {
            pConvertBuffer = new int[CONVERT_BUFFER_SIZE];
        }
#endif
    }

    SampleFile::~SampleFile() {
        Close();
        ReleaseSampleData();
        delete[] pConvertBuffer;
    }

    void SampleFile::Open() {
        if(pSndFile) return; // Already opened
        SF_INFO sfInfo;
        sfInfo.format = 0;
        pSndFile = sf_open(File.c_str(), SFM_READ, &sfInfo);
        if(pSndFile == NULL) throw Exception(File + ": Can't load sample");
        #if CONFIG_DEVMODE
        std::cout << "Number of opened sample files: " << ++SampleFile_OpenFilesCount << std::endl;
        #endif
    }

    void SampleFile::Close() {
        if(pSndFile == NULL) return;
        if(sf_close(pSndFile)) std::cerr << "Sample::Close() " << "Failed to close " << File << std::endl;
        pSndFile = NULL;
        #if CONFIG_DEVMODE
        std::cout << "Number of opened sample files: " << --SampleFile_OpenFilesCount << std::endl;
        #endif
    }

    long SampleFile::SetPos(unsigned long FrameOffset) {
        return SetPos(FrameOffset, SEEK_SET);
    }

    long SampleFile::SetPos(unsigned long FrameCount, int Whence) {
        if(pSndFile == NULL) {
            std::cerr << "Sample::SetPos() " << File << " not opened" << std::endl;
            return -1;
        }

        return sf_seek(pSndFile, FrameCount, Whence);
    }

    long SampleFile::GetPos() {
        if(pSndFile == NULL) {
            std::cerr << "Sample::GetPos() " << File << " not opened" << std::endl;
            return -1;
        }

        return sf_seek(pSndFile, 0, SEEK_CUR);
    }

    Sample::buffer_t SampleFile::LoadSampleData() {
        return LoadSampleDataWithNullSamplesExtension(GetTotalFrameCount(), 0); // 0 amount of NullSamples
    }

    Sample::buffer_t SampleFile::LoadSampleData(unsigned long FrameCount) {
        return LoadSampleDataWithNullSamplesExtension(FrameCount, 0); // 0 amount of NullSamples
    }

    Sample::buffer_t SampleFile::LoadSampleDataWithNullSamplesExtension(uint NullFrameCount) {
        return LoadSampleDataWithNullSamplesExtension(GetTotalFrameCount(), NullFrameCount);
    }

    Sample::buffer_t SampleFile::LoadSampleDataWithNullSamplesExtension(unsigned long FrameCount, uint NullFramesCount) {
        Open();
        if (FrameCount > GetTotalFrameCount()) FrameCount = GetTotalFrameCount();
        
        if (Offset > MaxOffset && FrameCount < GetTotalFrameCount()) {
            FrameCount = FrameCount + Offset > GetTotalFrameCount() ? GetTotalFrameCount() - Offset : FrameCount;
            // Offset the RAM cache
            RAMCacheOffset = Offset;
        }
        if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;
        unsigned long allocationsize = (FrameCount + NullFramesCount) * this->FrameSize;
        SetPos(RAMCacheOffset, SEEK_SET); // reset read position to playback start point
        RAMCache.pStart            = new int8_t[allocationsize];

        RAMCache.Size = Read(RAMCache.pStart, FrameCount) * this->FrameSize;
        RAMCache.NullExtensionSize = allocationsize - RAMCache.Size;
        // fill the remaining buffer space with silence samples
        memset((int8_t*)RAMCache.pStart + RAMCache.Size, 0, RAMCache.NullExtensionSize);
        Close();
        return GetCache();
    }

    long SampleFile::Read(void* pBuffer, unsigned long FrameCount) {
        Open();
        
        if (GetPos() + FrameCount > GetTotalFrameCount()) FrameCount = GetTotalFrameCount() - GetPos(); // For the cases where a different sample end is specified (not the end of the file)

        // ogg and flac files must be read with sf_readf, not
        // sf_read_raw. On big endian machines, sf_readf_short is also
        // used for 16 bit wav files, to get automatic endian
        // conversion (for 24 bit samples this is handled in
        // Synthesize::GetSample instead).

#if WORDS_BIGENDIAN || HAVE_DECL_SF_FORMAT_VORBIS || HAVE_DECL_SF_FORMAT_FLAC
        if (
#if WORDS_BIGENDIAN
            FrameSize == 2 * ChannelCount
#else
#if HAVE_DECL_SF_FORMAT_VORBIS
            ((Format & SF_FORMAT_SUBMASK) == SF_FORMAT_VORBIS)
#if HAVE_DECL_SF_FORMAT_FLAC
            ||
#endif
#endif
#if HAVE_DECL_SF_FORMAT_FLAC
            (FrameSize == 2 * ChannelCount &&
             (Format & SF_FORMAT_TYPEMASK) == SF_FORMAT_FLAC)
#endif
#endif
            ) {
            return sf_readf_short(pSndFile, static_cast<short*>(pBuffer), FrameCount);
#if HAVE_DECL_SF_FORMAT_FLAC
        } else if (FrameSize == 3 * ChannelCount &&
                   (Format & SF_FORMAT_TYPEMASK) == SF_FORMAT_FLAC) {
            // 24 bit flac needs to be converted from the 32 bit
            // integers returned by libsndfile
            int j = 0;
            sf_count_t count = FrameCount;
            const sf_count_t bufsize = CONVERT_BUFFER_SIZE / ChannelCount;
            unsigned char* const dst = static_cast<unsigned char*>(pBuffer);
            while (count > 0) {
                int n = sf_readf_int(pSndFile, pConvertBuffer, std::min(count, bufsize));
                if (n <= 0) break;
                for (int i = 0 ; i < n * ChannelCount ; i++) {
                    dst[j++] = pConvertBuffer[i] >> 8;
                    dst[j++] = pConvertBuffer[i] >> 16;
                    dst[j++] = pConvertBuffer[i] >> 24;
                }
                count -= n;
            }
            return FrameCount - count;
#endif            
        } else
#endif
        {
            int bytes = sf_read_raw(pSndFile, pBuffer, FrameCount * GetFrameSize());
            return bytes / GetFrameSize();
        }
    }

    unsigned long SampleFile::ReadAndLoop (
        void*           pBuffer,
        unsigned long   FrameCount,
        PlaybackState*  pPlaybackState
    ) {
        // TODO:
        SetPos(pPlaybackState->position);
        unsigned long count = Read(pBuffer, FrameCount);
        pPlaybackState->position = GetPos();
        return count;
    }

    void SampleFile::ReleaseSampleData() {
        if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;
        RAMCache.pStart = NULL;
        RAMCache.Size   = 0;
        RAMCache.NullExtensionSize = 0;
    }

    Sample::buffer_t SampleFile::GetCache() {
        // return a copy of the buffer_t structure
        buffer_t result;
        result.Size              = this->RAMCache.Size;
        result.pStart            = this->RAMCache.pStart;
        result.NullExtensionSize = this->RAMCache.NullExtensionSize;
        return result;
    }
} // namespace LinuxSampler
1	iliev	2012	/***************************************************************************
2			* *
3			* LinuxSampler - modular, streaming capable sampler *
4			* *
5			* Copyright (C) 2003 - 2009 Christian Schoenebeck *
6	persson	2399	* Copyright (C) 2009 - 2013 Grigor Iliev *
7	iliev	2012	* *
8			* This program 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 program 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 program; if not, write to the Free Software *
20			* Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
21			* MA 02111-1307 USA *
22			***************************************************************************/
23
24			#include "SampleFile.h"
25	persson	2119	#include "../../common/global_private.h"
26	iliev	2012	#include "../../common/Exception.h"
27
28			#include <cstring>
29
30	persson	2399	#define CONVERT_BUFFER_SIZE 4096
31
32	iliev	2012	namespace LinuxSampler {
33			#if CONFIG_DEVMODE
34			int SampleFile_OpenFilesCount = 0;
35			#endif
36
37			SampleFile::SampleFile(String File, bool DontClose) {
38			this->File = File;
39			this->pSndFile = NULL;
40	persson	2399	pConvertBuffer = NULL;
41	iliev	2012
42			SF_INFO sfInfo;
43			sfInfo.format = 0;
44			pSndFile = sf_open(File.c_str(), SFM_READ, &sfInfo);
45			if(pSndFile == NULL) throw Exception(File + ": Can't get sample info: " + String(sf_strerror (NULL)));
46			#if CONFIG_DEVMODE
47			std::cout << "Number of opened sample files: " << ++SampleFile_OpenFilesCount << std::endl;
48			#endif
49			SampleRate = sfInfo.samplerate;
50			ChannelCount = sfInfo.channels;
51			Format = sfInfo.format;
52
53	persson	2119	switch(Format & SF_FORMAT_SUBMASK) {
54	iliev	2012	case SF_FORMAT_PCM_S8:
55			case SF_FORMAT_PCM_U8:
56	iliev	2019	case SF_FORMAT_DPCM_8:
57			FrameSize = ChannelCount;
58			break;
59	iliev	2012	case SF_FORMAT_PCM_16:
60			case SF_FORMAT_DPCM_16:
61	iliev	2019	FrameSize = 2 * ChannelCount;
62	iliev	2012	break;
63	iliev	2019	case SF_FORMAT_PCM_24:
64			case SF_FORMAT_DWVW_24:
65			FrameSize = 3 * ChannelCount;
66			break;
67	iliev	2012	default:
68	iliev	2019	FrameSize = 2 * ChannelCount;
69	iliev	2012	}
70			TotalFrameCount = sfInfo.frames;
71
72	persson	2167	Loops = 0;
73			LoopStart = 0;
74			LoopEnd = 0;
75			SF_INSTRUMENT instrument;
76			if (sf_command(pSndFile, SFC_GET_INSTRUMENT,
77			&instrument, sizeof(instrument)) != SF_FALSE) {
78			// TODO: instrument.basenote
79			#if HAVE_SF_INSTRUMENT_LOOPS
80			if (instrument.loop_count && instrument.loops[0].mode != SF_LOOP_NONE) {
81			Loops = 1;
82			LoopStart = instrument.loops[0].start;
83			LoopEnd = instrument.loops[0].end;
84			}
85			#endif
86			}
87	iliev	2012	if(!DontClose) Close();
88	persson	2399
89			#if HAVE_DECL_SF_FORMAT_FLAC
90			if (FrameSize == 3 * ChannelCount &&
91			(Format & SF_FORMAT_TYPEMASK) == SF_FORMAT_FLAC) {
92			pConvertBuffer = new int[CONVERT_BUFFER_SIZE];
93			}
94			#endif
95	iliev	2012	}
96
97			SampleFile::~SampleFile() {
98			Close();
99	persson	2058	ReleaseSampleData();
100	persson	2399	delete[] pConvertBuffer;
101	iliev	2012	}
102
103			void SampleFile::Open() {
104			if(pSndFile) return; // Already opened
105			SF_INFO sfInfo;
106			sfInfo.format = 0;
107			pSndFile = sf_open(File.c_str(), SFM_READ, &sfInfo);
108			if(pSndFile == NULL) throw Exception(File + ": Can't load sample");
109			#if CONFIG_DEVMODE
110			std::cout << "Number of opened sample files: " << ++SampleFile_OpenFilesCount << std::endl;
111			#endif
112			}
113
114			void SampleFile::Close() {
115			if(pSndFile == NULL) return;
116			if(sf_close(pSndFile)) std::cerr << "Sample::Close() " << "Failed to close " << File << std::endl;
117			pSndFile = NULL;
118			#if CONFIG_DEVMODE
119			std::cout << "Number of opened sample files: " << --SampleFile_OpenFilesCount << std::endl;
120			#endif
121			}
122
123			long SampleFile::SetPos(unsigned long FrameOffset) {
124			return SetPos(FrameOffset, SEEK_SET);
125			}
126
127			long SampleFile::SetPos(unsigned long FrameCount, int Whence) {
128			if(pSndFile == NULL) {
129			std::cerr << "Sample::SetPos() " << File << " not opened" << std::endl;
130			return -1;
131			}
132
133			return sf_seek(pSndFile, FrameCount, Whence);
134			}
135
136			long SampleFile::GetPos() {
137			if(pSndFile == NULL) {
138			std::cerr << "Sample::GetPos() " << File << " not opened" << std::endl;
139			return -1;
140			}
141
142			return sf_seek(pSndFile, 0, SEEK_CUR);
143			}
144
145			Sample::buffer_t SampleFile::LoadSampleData() {
146	iliev	2234	return LoadSampleDataWithNullSamplesExtension(GetTotalFrameCount(), 0); // 0 amount of NullSamples
147	iliev	2012	}
148
149			Sample::buffer_t SampleFile::LoadSampleData(unsigned long FrameCount) {
150			return LoadSampleDataWithNullSamplesExtension(FrameCount, 0); // 0 amount of NullSamples
151			}
152
153			Sample::buffer_t SampleFile::LoadSampleDataWithNullSamplesExtension(uint NullFrameCount) {
154	iliev	2234	return LoadSampleDataWithNullSamplesExtension(GetTotalFrameCount(), NullFrameCount);
155	iliev	2012	}
156
157			Sample::buffer_t SampleFile::LoadSampleDataWithNullSamplesExtension(unsigned long FrameCount, uint NullFramesCount) {
158			Open();
159	iliev	2234	if (FrameCount > GetTotalFrameCount()) FrameCount = GetTotalFrameCount();
160	iliev	2216
161	iliev	2234	if (Offset > MaxOffset && FrameCount < GetTotalFrameCount()) {
162			FrameCount = FrameCount + Offset > GetTotalFrameCount() ? GetTotalFrameCount() - Offset : FrameCount;
163	iliev	2216	// Offset the RAM cache
164			RAMCacheOffset = Offset;
165			}
166	iliev	2012	if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;
167			unsigned long allocationsize = (FrameCount + NullFramesCount) * this->FrameSize;
168	iliev	2216	SetPos(RAMCacheOffset, SEEK_SET); // reset read position to playback start point
169	iliev	2012	RAMCache.pStart = new int8_t[allocationsize];
170
171			RAMCache.Size = Read(RAMCache.pStart, FrameCount) * this->FrameSize;
172			RAMCache.NullExtensionSize = allocationsize - RAMCache.Size;
173			// fill the remaining buffer space with silence samples
174			memset((int8_t*)RAMCache.pStart + RAMCache.Size, 0, RAMCache.NullExtensionSize);
175			Close();
176			return GetCache();
177			}
178
179			long SampleFile::Read(void* pBuffer, unsigned long FrameCount) {
180			Open();
181	iliev	2234
182			if (GetPos() + FrameCount > GetTotalFrameCount()) FrameCount = GetTotalFrameCount() - GetPos(); // For the cases where a different sample end is specified (not the end of the file)
183	persson	2119
184	persson	2399	// ogg and flac files must be read with sf_readf, not
185			// sf_read_raw. On big endian machines, sf_readf_short is also
186			// used for 16 bit wav files, to get automatic endian
187			// conversion (for 24 bit samples this is handled in
188			// Synthesize::GetSample instead).
189	persson	2119
190	persson	2399	#if WORDS_BIGENDIAN \|\| HAVE_DECL_SF_FORMAT_VORBIS \|\| HAVE_DECL_SF_FORMAT_FLAC
191	persson	2119	if (
192			#if WORDS_BIGENDIAN
193			FrameSize == 2 * ChannelCount
194			#else
195	persson	2399	#if HAVE_DECL_SF_FORMAT_VORBIS
196			((Format & SF_FORMAT_SUBMASK) == SF_FORMAT_VORBIS)
197			#if HAVE_DECL_SF_FORMAT_FLAC
198			\|\|
199	persson	2119	#endif
200	persson	2399	#endif
201			#if HAVE_DECL_SF_FORMAT_FLAC
202			(FrameSize == 2 * ChannelCount &&
203			(Format & SF_FORMAT_TYPEMASK) == SF_FORMAT_FLAC)
204			#endif
205			#endif
206	persson	2119	) {
207			return sf_readf_short(pSndFile, static_cast<short*>(pBuffer), FrameCount);
208	persson	2399	#if HAVE_DECL_SF_FORMAT_FLAC
209			} else if (FrameSize == 3 * ChannelCount &&
210			(Format & SF_FORMAT_TYPEMASK) == SF_FORMAT_FLAC) {
211			// 24 bit flac needs to be converted from the 32 bit
212			// integers returned by libsndfile
213			int j = 0;
214			sf_count_t count = FrameCount;
215			const sf_count_t bufsize = CONVERT_BUFFER_SIZE / ChannelCount;
216			unsigned char* const dst = static_cast<unsigned char*>(pBuffer);
217			while (count > 0) {
218			int n = sf_readf_int(pSndFile, pConvertBuffer, std::min(count, bufsize));
219			if (n <= 0) break;
220			for (int i = 0 ; i < n * ChannelCount ; i++) {
221			dst[j++] = pConvertBuffer[i] >> 8;
222			dst[j++] = pConvertBuffer[i] >> 16;
223			dst[j++] = pConvertBuffer[i] >> 24;
224			}
225			count -= n;
226			}
227			return FrameCount - count;
228			#endif
229	persson	2119	} else
230			#endif
231			{
232			int bytes = sf_read_raw(pSndFile, pBuffer, FrameCount * GetFrameSize());
233			return bytes / GetFrameSize();
234			}
235	iliev	2012	}
236
237			unsigned long SampleFile::ReadAndLoop (
238			void* pBuffer,
239			unsigned long FrameCount,
240			PlaybackState* pPlaybackState
241			) {
242			// TODO:
243			SetPos(pPlaybackState->position);
244	iliev	2018	unsigned long count = Read(pBuffer, FrameCount);
245	iliev	2012	pPlaybackState->position = GetPos();
246	iliev	2018	return count;
247	iliev	2012	}
248
249			void SampleFile::ReleaseSampleData() {
250			if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;
251			RAMCache.pStart = NULL;
252			RAMCache.Size = 0;
253			RAMCache.NullExtensionSize = 0;
254			}
255
256			Sample::buffer_t SampleFile::GetCache() {
257			// return a copy of the buffer_t structure
258			buffer_t result;
259			result.Size = this->RAMCache.Size;
260			result.pStart = this->RAMCache.pStart;
261			result.NullExtensionSize = this->RAMCache.NullExtensionSize;
262			return result;
263			}
264			} // namespace LinuxSampler