spWave.h

Go to the documentation of this file.

 
#ifndef __SPWAVE_H
#define __SPWAVE_H
 
#include <sp/spDefs.h>
#include <sp/spAudioDefs.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define SP_WAVE_WAV_ID "wav"
#define SP_WAVE_AIFF_ID "aiff"
#define SP_WAVE_AIFC_ID "aifc"
    
#if BYTE_ORDER == BIG_ENDIAN
#define SP_WAV_NEED_SWAP 1
#else
#define SP_WAV_NEED_SWAP 0
#endif
 
#if BYTE_ORDER == BIG_ENDIAN
#define SP_AIFF_NEED_SWAP 0
#else
#define SP_AIFF_NEED_SWAP 1
#endif
 
#define SP_WAVE_FORMAT_SIZE 32
#define SP_WAVE_FILE_TYPE_SIZE 32       
#define SP_WAVE_FILE_DESC_SIZE 128      
#define SP_WAVE_FILE_FILTER_SIZE 32     
typedef struct _spWaveInfo {
    char file_type[SP_WAVE_FILE_TYPE_SIZE];     
    char file_desc[SP_WAVE_FILE_DESC_SIZE];     
    char file_filter[SP_WAVE_FILE_FILTER_SIZE]; 
    int buffer_size;            
    spLong header_size;         
    int samp_bit;               
    int num_channel;            
    double samp_rate;           
    long bit_rate;              
    spLong length;              
} spWaveInfo;
 
#define SP_SONG_NO_INFO 0       
#define SP_SONG_TRACK_MASK (1L<<0) 
#define SP_SONG_TITLE_MASK (1L<<1) 
#define SP_SONG_ARTIST_MASK (1L<<2) 
#define SP_SONG_ALBUM_MASK (1L<<3)  
#define SP_SONG_GENRE_MASK (1L<<4)  
#define SP_SONG_RELEASE_MASK (1L<<5) 
#define SP_SONG_COPYRIGHT_MASK (1L<<6) 
#define SP_SONG_ENGINEER_MASK (1L<<7)  
#define SP_SONG_SOURCE_MASK (1L<<8)    
#define SP_SONG_SOFTWARE_MASK (1L<<9)  
#define SP_SONG_SUBJECT_MASK (1L<<10)  
#define SP_SONG_COMMENT_MASK (1L<<11)  
#define SP_SONG_ALBUM_ARTIST_MASK (1L<<12) 
#define SP_SONG_COMPOSER_MASK (1L<<13)     
#define SP_SONG_LYRICIST_MASK (1L<<14)     
#define SP_SONG_PRODUCER_MASK (1L<<15)     
#define SP_SONG_ISRC_MASK (1L<<16)         
#define SP_SONG_TRACK_TOTAL_MASK (1L<<17)  
#define SP_SONG_DISC_MASK (1L<<18)         
#define SP_SONG_DISC_TOTAL_MASK (1L<<19)   
#define SP_SONG_TEMPO_MASK (1L<<20)        
#define SP_SONG_ID3V1_MASK (1L<<24)        
#define SP_SONG_ID3V2_2_MASK (1L<<25)      
#define SP_SONG_ID3V2_3_MASK (1L<<26)      
#define SP_SONG_ID3V2_4_MASK (1L<<27)      
#define SP_SONG_UTF8_STRING_IN_FILE_MASK (1L<<28)  
#define SP_SONG_ISO8859_1_STRING_IN_FILE_MASK (1L<<29)  
#define SP_SONG_ID3V2_SUPPORT_MASK (SP_SONG_TRACK_MASK|SP_SONG_TITLE_MASK|SP_SONG_ARTIST_MASK|SP_SONG_ALBUM_MASK|SP_SONG_GENRE_MASK|SP_SONG_RELEASE_MASK|SP_SONG_COPYRIGHT_MASK|SP_SONG_ENGINEER_MASK|SP_SONG_SOURCE_MASK|SP_SONG_SOFTWARE_MASK|SP_SONG_COMMENT_MASK|SP_SONG_ALBUM_ARTIST_MASK|SP_SONG_COMPOSER_MASK|SP_SONG_LYRICIST_MASK|SP_SONG_ISRC_MASK|SP_SONG_TRACK_TOTAL_MASK|SP_SONG_DISC_MASK|SP_SONG_DISC_TOTAL_MASK|SP_SONG_TEMPO_MASK)
#define SP_SONG_ID3V2_2_SUPPORT_MASK (SP_SONG_ID3V2_SUPPORT_MASK|SP_SONG_ID3V2_2_MASK)
#define SP_SONG_ID3V2_3_SUPPORT_MASK (SP_SONG_ID3V2_SUPPORT_MASK|SP_SONG_ID3V2_3_MASK)
#define SP_SONG_ID3V2_4_SUPPORT_MASK (SP_SONG_ID3V2_SUPPORT_MASK|SP_SONG_ID3V2_4_MASK)
#define SP_SONG_ID3V2_ALL_SUPPORT_MASK (SP_SONG_ID3V2_SUPPORT_MASK|SP_SONG_ID3V2_2_MASK|SP_SONG_ID3V2_3_MASK|SP_SONG_ID3V2_4_MASK)
    
#define SP_SONG_INFO_SIZE 128   
#define SP_SONG_INFO_GENRE_SIZE 32 
#define SP_SONG_INFO_ALBUM_ARTIST_SIZE 96 
#define SP_SONG_INFO_RELEASE_SIZE 48 
#define SP_SONG_INFO_PRODUCER_SIZE 64 
#define SP_SONG_INFO_SOURCE_SIZE 48 
#define SP_SONG_INFO_COMPOSER_SIZE 80 
#define SP_SONG_INFO_SOFTWARE_SIZE 48 
#define SP_SONG_INFO_LYRICIST_SIZE 80 
#define SP_SONG_INFO_SUBJECT_SIZE 104 
#define SP_SONG_INFO_ISRC_SIZE 24 
typedef struct _spSongInfo {
    unsigned long info_mask;            
    spLong32 track;                     
    char title[SP_SONG_INFO_SIZE];      
    char artist[SP_SONG_INFO_SIZE];     
    char album[SP_SONG_INFO_SIZE];      
    char genre[SP_SONG_INFO_SIZE];      
    char release[SP_SONG_INFO_SIZE];    
    char copyright[SP_SONG_INFO_SIZE];  
    char engineer[SP_SONG_INFO_SIZE];   
    char source[SP_SONG_INFO_SIZE];     
    char software[SP_SONG_INFO_SIZE];   
    char subject[SP_SONG_INFO_SIZE];    
    char comment[SP_SONG_INFO_SIZE];    
} spSongInfo;
 
/* 0.7.12+ */
typedef struct _spSongInfoV2 {
    unsigned long info_mask;                    
    spLong32 track;                             
    char title[SP_SONG_INFO_SIZE];              
    char artist[SP_SONG_INFO_SIZE];             
    char album[SP_SONG_INFO_SIZE];              
    char genre[SP_SONG_INFO_GENRE_SIZE];        
    char album_artist[SP_SONG_INFO_ALBUM_ARTIST_SIZE]; 
    char release[SP_SONG_INFO_RELEASE_SIZE];    
    char producer[SP_SONG_INFO_PRODUCER_SIZE];  
    spLong32 track_total;                       
    spLong32 disc;                              
    spLong32 disc_total;                        
    spLong32 tempo;                             
    char copyright[SP_SONG_INFO_SIZE];          
    char engineer[SP_SONG_INFO_SIZE];           
    char source[SP_SONG_INFO_SOURCE_SIZE];      
    char composer[SP_SONG_INFO_COMPOSER_SIZE];  
    char software[SP_SONG_INFO_SOFTWARE_SIZE];  
    char lyricist[SP_SONG_INFO_LYRICIST_SIZE];  
    char subject[SP_SONG_INFO_SUBJECT_SIZE];    
    char isrc[SP_SONG_INFO_ISRC_SIZE];          
    char comment[SP_SONG_INFO_SIZE];            
} spSongInfoV2;
    
typedef struct _spSongInfo *spSongInfoPtr;
typedef struct _spSongInfoV2 *spSongInfoV2Ptr;
    
#if defined(MACOS)
#pragma import on
#endif
 
extern spBool spIsWavFile(const char *filename);
extern spBool spReadWavInfo(spWaveInfo *wave_info, FILE *fp);
extern spBool spWriteWavInfo(spWaveInfo *wave_info, FILE *fp);
extern long _spReadWavData(spWaveInfo *wave_info, char *data, long length, FILE *fp);
extern long _spWriteWavData(spWaveInfo *wave_info, char *data, long length, FILE *fp);
extern unsigned long spGetWavSongInfoMask(void);
extern spBool spGetWavSongInfo(spSongInfo *song_info, FILE *fp); /* fp must be located at file start or data end */
extern spBool spReadWavSongInfo(spWaveInfo *wave_info, spSongInfo *song_info, FILE *fp);
extern spBool spAddWavSongInfo(spSongInfo *song_info, FILE *fp); /* fp must be located at file start or data end */
extern spBool spWriteWavSongInfo(spWaveInfo *wave_info, spSongInfo *song_info, FILE *fp);
 
/* (data buffer size) = length * sizeof(short), (samp_bit <= 16)
   (data buffer size) = length * sizeof(long), (16 < samp_bit <= 32) */
#define spReadWavData(wave_info, data, length, fp) _spReadWavData(wave_info, (char *)(data), length, fp)
#define spWriteWavData(wave_info, data, length, fp) _spWriteWavData(wave_info, (char *)(data), length, fp)
 
extern spBool spIsAiffFile(const char *filename);
extern spBool spReadAiffInfo(spWaveInfo *wave_info, FILE *fp);
extern spBool spWriteAiffInfo(spWaveInfo *wave_info, FILE *fp);
extern long _spReadAiffData(spWaveInfo *wave_info, char *data, long length, FILE *fp);
extern long _spWriteAiffData(spWaveInfo *wave_info, char *data, long length, FILE *fp);
extern unsigned long spGetAiffSongInfoMask(void);
extern spBool spGetAiffSongInfo(spSongInfo *song_info, FILE *fp); /* location of fp is not restricted */
extern spBool spReadAiffSongInfo(spWaveInfo *wave_info, spSongInfo *song_info, FILE *fp);
extern spBool spAddAiffSongInfo(spSongInfo *song_info, FILE *fp); /* fp must be located at file start or data end */
extern spBool spWriteAiffSongInfo(spWaveInfo *wave_info, spSongInfo *song_info, FILE *fp);
 
#define spReadAiffData(wave_info, data, length, fp) _spReadAiffData(wave_info, (char *)(data), length, fp)
#define spWriteAiffData(wave_info, data, length, fp) _spWriteAiffData(wave_info, (char *)(data), length, fp)
 
extern spBool spInitWaveInfo(spWaveInfo *wave_info);
extern spBool spCopyWaveInfo(spWaveInfo *dest_info, spWaveInfo *src_info);
extern spBool spInitSongInfo(spSongInfo *song_info);
extern spBool spInitSongInfoV2(spSongInfoV2 *song_info);
extern spBool spCopySongInfo(spSongInfo *dest_info, spSongInfo *src_info);
extern spBool spCopySongInfoV2(spSongInfoV2 *dest_info, spSongInfoV2 *src_info);
extern spBool spEqSongInfo(spSongInfo *info1, spSongInfo *info2);
extern spBool spEqSongInfoV2(spSongInfoV2 *info1, spSongInfoV2 *info2);
extern spBool spShowSongInfo(spSongInfo *song_info, const char *indent, FILE *fp);
extern spBool spShowSongInfoV2(spSongInfoV2 *song_info, const char *indent, FILE *fp);
 
/* the following functions may remove in future release */
extern void spPlayFileUseDatLink(spBool flag);
extern void spPlayFileUseWav(spBool flag);
extern spBool spSetPlayCommand(const char *format);
extern spBool spPlayFile(const char *filename, int num_channel, double samp_rate);
extern spBool spPlayFileAsync(const char *filename, int num_channel, double samp_rate);
 
#if defined(MACOS)
#pragma import off
#endif
 
#ifdef __cplusplus
}  /* Close scope of 'extern "C"' declaration */
#endif
 
#endif /* __SPWAVE_H */