abi/audio.h

/* -*- mode: C; c-basic-offset: 4; intent-tabs-mode: nil -*-
 *
 * Sifteo SDK
 *
 * Copyright <c> 2012 Sifteo, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#ifndef _SIFTEO_ABI_AUDIO_H
#define _SIFTEO_ABI_AUDIO_H

#include <sifteo/abi/types.h>

#ifdef __cplusplus
extern "C" {
#endif


typedef uint8_t _SYSAudioChannelID;     

#define _SYS_AUDIO_INVALID_CHANNEL_ID   ((_SYSAudioChannelID)-1)
#define _SYS_AUDIO_MAX_CHANNELS         8

#define _SYS_AUDIO_MAX_VOLUME_LOG2      8
#define _SYS_AUDIO_MAX_VOLUME           (1 << _SYS_AUDIO_MAX_VOLUME_LOG2)
#define _SYS_AUDIO_DEFAULT_VOLUME       (_SYS_AUDIO_MAX_VOLUME / 2)


/*
 * Types of audio supported by the system
 */
enum _SYSAudioType {
    _SYS_PCM = 1,
    _SYS_ADPCM = 2
};

enum _SYSAudioLoopType {
    _SYS_LOOP_UNDEF              = -1,
    _SYS_LOOP_ONCE               = 0,
    _SYS_LOOP_REPEAT             = 1,
    _SYS_LOOP_EMULATED_PING_PONG = 2,
};

struct _SYSAudioModule {
    uint32_t sampleRate;    
    uint32_t loopStart;     
    uint32_t loopEnd;       
    uint8_t loopType;       
    uint8_t type;           
    uint16_t volume;        
    uint32_t dataSize;      
    uint32_t pData;         
};

struct _SYSXMPattern {
    uint16_t nRows;         
    uint16_t dataSize;      
    uint32_t pData;         
};

struct _SYSXMInstrument {
    struct _SYSAudioModule sample;  
    int8_t finetune;                
    int8_t relativeNoteNumber;      
    uint8_t compression;            
    
    uint32_t volumeEnvelopePoints;  
    uint8_t nVolumeEnvelopePoints;  
    uint8_t volumeSustainPoint;     
    uint8_t volumeLoopStartPoint;   
    uint8_t volumeLoopEndPoint;     
    uint8_t volumeType;             
    uint8_t vibratoType;            
    uint8_t vibratoSweep;           
    uint8_t vibratoDepth;           
    uint8_t vibratoRate;            
    uint16_t volumeFadeout;         
};

struct _SYSXMSong {
    uint32_t patternOrderTable;     
    uint16_t patternOrderTableSize; 
    uint8_t restartPosition;        
    uint8_t nChannels;              
    
    uint16_t nPatterns;             
    uint32_t patterns;              
    
    uint8_t nInstruments;           
    uint32_t instruments;           
    
    uint8_t frequencyTable;         
    uint16_t tempo;                 
    uint16_t bpm;                   
};

#ifdef __cplusplus
}  // extern "C"
#endif

#endif