audio.h

Go to the documentation of this file.

/*
** Jo Sega Saturn Engine
** Copyright (c) 2012-2024, Johannes Fetz (johannesfetz@gmail.com)
** All rights reserved.
**
** Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are met:
**     * Redistributions of source code must retain the above copyright
**       notice, this list of conditions and the following disclaimer.
**     * Redistributions in binary form must reproduce the above copyright
**       notice, this list of conditions and the following disclaimer in the
**       documentation and/or other materials provided with the distribution.
**     * Neither the name of the Johannes Fetz nor the
**       names of its contributors may be used to endorse or promote products
**       derived from this software without specific prior written permission.
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
** ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
** WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
** DISCLAIMED. IN NO EVENT SHALL Johannes Fetz BE LIABLE FOR ANY
** DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
** (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
** LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
** ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
** SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef __JO_AUDIO_H__
# define __JO_AUDIO_H__
 
#ifdef JO_COMPILE_WITH_AUDIO_SUPPORT
 
# define JO_SOUND_MAX_CHANNEL       (6)
 
typedef enum
{
    JoSoundMono8Bit = (0x00 | 0x10),
    JoSoundMono16Bit = (0x00 | 0x00),
    JoSoundStereo8Bit = (0x80 | 0x10),
    JoSoundStereo16Bit = (0x80 | 0x00)
}                   jo_sound_mode;
 
typedef struct
{
    char            *data;
    unsigned int    data_length;
    jo_sound_mode   mode;
    unsigned char   current_playing_channel;
    unsigned short  sample_rate; // Set sampling rate from 8000 to 44100 kHz
    unsigned char   volume; // Change volume: 0 (JO_MIN_AUDIO_VOLUME) -> 127 (JO_MAX_AUDIO_VOLUME)
    char            pan; // Adjust stereo: -128 (left speaker) -> 127 (right speaker)
}                   jo_sound;
 
# define JO_DEFAULT_AUDIO_VOLUME    (127)
 
# define JO_MAX_AUDIO_VOLUME        (127)
 
# define JO_MIN_AUDIO_VOLUME        (0)
 
void    jo_audio_play_cd_track(const int from_track, const int to_track, const bool repeat_infinitely);
 
void    jo_audio_set_volume(const unsigned char vol);
 
void    jo_audio_stop_cd(void);
 
void    jo_audio_play_sound_on_channel(jo_sound * const sound, const unsigned char channel);
 
void    jo_audio_play_sound(jo_sound * const sound);
 
void    jo_audio_stop_sound(const jo_sound * const sound);
 
#ifdef JO_COMPILE_WITH_FS_SUPPORT
 
bool     jo_audio_load_pcm(const char * const filename, const jo_sound_mode mode, jo_sound *sound);
 
bool     jo_audio_load_pcm_async(const char * const filename, const jo_sound_mode mode, jo_sound *sound);
 
#endif
 
void     jo_audio_free_pcm(jo_sound *sound);
 
int                         jo_audio_usage_percent(void);
 
#endif /* !JO_COMPILE_WITH_AUDIO_SUPPORT */
 
#endif /* !__JO_AUDIO_H__ */
 
/*
** END OF FILE
*/