ciderpress/util/SoundFile.h

102 lines
3.5 KiB
C
Raw Normal View History

2007-03-27 17:47:10 +00:00
/*
* CiderPress
* Copyright (C) 2007 by faddenSoft, LLC. All Rights Reserved.
* See the file LICENSE for distribution terms.
*/
/*
* Class that encapsulates a sound file. Includes loading of sounds from WAV
* files and other formats. Does not create or write sound files.
*
* [ Copied from libfadden. ]
*/
Large set of changes to restore CiderPress build. CiderPress and MDC now compile, and execute far enough to open their respective "about" boxes, but I doubt they'll do much more than that. * Switch from MBCS to UNICODE APIs Microsoft switched to UTF-16 (by way of UCS-2) a long time ago, and the support for MBCS seems to be getting phased out. So it's time to switch to wide strings. This is a bit awkward for CiderPress because it works with disk and file archives with 8-bit filenames, and I want NufxLib and DiskImgLib to continue to work on Linux (which has largely taken the UTF-8 approach to Unicode). The libraries will continue to work with 8-bit filenames, with CiderPress/MDC doing the conversion at the appropriate point. There were a couple of places where strings from a structure handed back by one of the libraries were used directly in the UI, or vice-versa, which is a problem because we have nowhere to store the result of the conversion. These currently have fixed place-holder "xyzzy" strings. All UI strings are now wide. Various format strings now use "%ls" and "%hs" to explicitly specify wide and narrow. This doesn't play well with gcc, so only the Windows-specific parts use those. * Various updates to vcxproj files The project-file conversion had some cruft that is now largely gone. The build now has a common output directory for the EXEs and libraries, avoiding the old post-build copy steps. * Added zlib 1.2.8 and nufxlib 2.2.2 source snapshots The old "prebuilts" directory is now gone. The libraries are now built as part of building the apps. I added a minimal set of files for zlib, and a full set for nufxlib. The Linux-specific nufxlib goodies are included for the benefit of the Linux utilities, which are currently broken (don't build). * Replace symbols used for include guards Symbols with a leading "__" are reserved.
2014-11-10 23:32:55 +00:00
#ifndef UTIL_SOUNDFILE_H
#define UTIL_SOUNDFILE_H
2007-03-27 17:47:10 +00:00
#include <mmsystem.h>
#include <stdint.h>
2007-03-27 17:47:10 +00:00
/*
* Class providing read-only access to uncompressed sound samples and
* associated meta-data. The sound file is assumed to fit in main memory.
2007-03-27 17:47:10 +00:00
*
* Because game sound effects are generally loaded into "secondary sound
* buffers" allocated by DirectX, this class doesn't load the sound data
* into local storage unless necessary.
*
* WAV data is little-endian. 8-bit data is unsigned, 16-bit data is
* signed.
*/
class SoundFile {
public:
SoundFile(void) :
2014-11-18 05:13:13 +00:00
mFP(NULL),
mDoClose(false),
mFileStart(0),
mSampleStart(-1),
mSampleLen(-1)
{
memset(&mFormat, 0, sizeof(mFormat));
}
virtual ~SoundFile(void) {
2014-11-18 05:13:13 +00:00
if (mDoClose && mFP != NULL)
fclose(mFP);
}
2007-03-27 17:47:10 +00:00
/* create the object from a file on disk; returns 0 on success */
Large set of changes to restore CiderPress build. CiderPress and MDC now compile, and execute far enough to open their respective "about" boxes, but I doubt they'll do much more than that. * Switch from MBCS to UNICODE APIs Microsoft switched to UTF-16 (by way of UCS-2) a long time ago, and the support for MBCS seems to be getting phased out. So it's time to switch to wide strings. This is a bit awkward for CiderPress because it works with disk and file archives with 8-bit filenames, and I want NufxLib and DiskImgLib to continue to work on Linux (which has largely taken the UTF-8 approach to Unicode). The libraries will continue to work with 8-bit filenames, with CiderPress/MDC doing the conversion at the appropriate point. There were a couple of places where strings from a structure handed back by one of the libraries were used directly in the UI, or vice-versa, which is a problem because we have nowhere to store the result of the conversion. These currently have fixed place-holder "xyzzy" strings. All UI strings are now wide. Various format strings now use "%ls" and "%hs" to explicitly specify wide and narrow. This doesn't play well with gcc, so only the Windows-specific parts use those. * Various updates to vcxproj files The project-file conversion had some cruft that is now largely gone. The build now has a common output directory for the EXEs and libraries, avoiding the old post-build copy steps. * Added zlib 1.2.8 and nufxlib 2.2.2 source snapshots The old "prebuilts" directory is now gone. The libraries are now built as part of building the apps. I added a minimal set of files for zlib, and a full set for nufxlib. The Linux-specific nufxlib goodies are included for the benefit of the Linux utilities, which are currently broken (don't build). * Replace symbols used for include guards Symbols with a leading "__" are reserved.
2014-11-10 23:32:55 +00:00
int Create(const WCHAR* fileName, CString* pErrMsg);
/* create from FILE*; if doClose==true, file will be closed on error */
int Create(FILE* fp, long len, bool doClose, CString* pErrMsg);
2007-03-27 17:47:10 +00:00
/* create object from a buffer of memory */
//int Create(const void* buf, long len);
2007-03-27 17:47:10 +00:00
/* read a block of audio samples from the specified offset */
int ReadData(void* buf, long sampleOffset, long len) const;
2007-03-27 17:47:10 +00:00
/* seek to an absolute offset within the WAV file */
int SeekAbs(long offset) { return fseek(mFP, offset, SEEK_SET); }
2007-03-27 17:47:10 +00:00
long GetDataOffset(void) const { return mSampleStart; }
uint32_t GetDataLen(void) const { return mSampleLen; }
const WAVEFORMATEX* GetWaveFormat(void) { return &mFormat; }
2007-03-27 17:47:10 +00:00
/* returns the #of bytes per sample (all channels) */
int GetBPS(void) const {
2014-11-18 05:13:13 +00:00
ASSERT(mFP != NULL);
return ((mFormat.wBitsPerSample+7)/8) * mFormat.nChannels;
}
2007-03-27 17:47:10 +00:00
private:
DECLARE_COPY_AND_OPEQ(SoundFile)
int SkipToHeader(uint32_t hdrID, uint32_t* pChunkLen);
2007-03-27 17:47:10 +00:00
enum { kWAVMinSize = 40 };
2007-03-27 17:47:10 +00:00
//void* mBuffer; // pointer to memory we need to delete
FILE* mFP; // currently open sound file
bool mDoClose; // do we own mFP?
2007-03-27 17:47:10 +00:00
long mFileStart; // so we can rewind the sound file
long mSampleStart; // offset in mem or file to sound samples
uint32_t mSampleLen; // length in bytes of audio sample section
2007-03-27 17:47:10 +00:00
WAVEFORMATEX mFormat; // WAV parameters (from mmsystem.h/mmreg.h)
2007-03-27 17:47:10 +00:00
};
#if 0 // contents of the WAVEFORMATEX struct; "cbSize" is not in WAV file
2007-03-27 17:47:10 +00:00
typedef struct tWAVEFORMATEX
{
WORD wFormatTag; /* format type */
WORD nChannels; /* number of channels (i.e. mono, stereo...) */
DWORD nSamplesPerSec; /* sample rate */
DWORD nAvgBytesPerSec; /* for buffer estimation */
WORD nBlockAlign; /* block size of data */
WORD wBitsPerSample; /* Number of bits per sample of mono data */
WORD cbSize; /* The count in bytes of the size of
extra information (after cbSize) */
} WAVEFORMATEX;
#endif
Large set of changes to restore CiderPress build. CiderPress and MDC now compile, and execute far enough to open their respective "about" boxes, but I doubt they'll do much more than that. * Switch from MBCS to UNICODE APIs Microsoft switched to UTF-16 (by way of UCS-2) a long time ago, and the support for MBCS seems to be getting phased out. So it's time to switch to wide strings. This is a bit awkward for CiderPress because it works with disk and file archives with 8-bit filenames, and I want NufxLib and DiskImgLib to continue to work on Linux (which has largely taken the UTF-8 approach to Unicode). The libraries will continue to work with 8-bit filenames, with CiderPress/MDC doing the conversion at the appropriate point. There were a couple of places where strings from a structure handed back by one of the libraries were used directly in the UI, or vice-versa, which is a problem because we have nowhere to store the result of the conversion. These currently have fixed place-holder "xyzzy" strings. All UI strings are now wide. Various format strings now use "%ls" and "%hs" to explicitly specify wide and narrow. This doesn't play well with gcc, so only the Windows-specific parts use those. * Various updates to vcxproj files The project-file conversion had some cruft that is now largely gone. The build now has a common output directory for the EXEs and libraries, avoiding the old post-build copy steps. * Added zlib 1.2.8 and nufxlib 2.2.2 source snapshots The old "prebuilts" directory is now gone. The libraries are now built as part of building the apps. I added a minimal set of files for zlib, and a full set for nufxlib. The Linux-specific nufxlib goodies are included for the benefit of the Linux utilities, which are currently broken (don't build). * Replace symbols used for include guards Symbols with a leading "__" are reserved.
2014-11-10 23:32:55 +00:00
#endif /*UTIL_SOUNDFILE_H*/