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.
 */

#pragma once
#ifdef NOT_USERSPACE
#   error This is a userspace-only header, not allowed by the current build.
#endif

#include <sifteo/asset.h>
#include <sifteo/abi.h>

namespace Sifteo {

struct AudioChannel {
    _SYSAudioChannelID sys;
    typedef _SYSAudioChannelID AudioChannelID;

    static const AudioChannelID UNDEFINED = _SYS_AUDIO_INVALID_CHANNEL_ID;

    static const AudioChannelID NUM_CHANNELS = _SYS_AUDIO_MAX_CHANNELS;

    static const int32_t MAX_VOLUME = _SYS_AUDIO_MAX_VOLUME;

    enum LoopMode {
        UNDEF_LOOP = _SYS_LOOP_UNDEF,       
        ONCE = _SYS_LOOP_ONCE,              
        REPEAT = _SYS_LOOP_REPEAT,          
    };

    AudioChannel() : sys(UNDEFINED)
    {}

    AudioChannel(AudioChannelID id) : sys(id)
    {}

    void init(AudioChannelID id)
    {
        ASSERT(id < NUM_CHANNELS && "AudioChannel ID is invalid");
        sys = id;
    }

    bool play(const AssetAudio &asset, LoopMode loopMode = UNDEF_LOOP) const
    {
        ASSERT(sys < NUM_CHANNELS && "AudioChannel has invalid ID");
        return _SYS_audio_play(&asset.sys, sys, (_SYSAudioLoopType) loopMode);
    }

    bool isPlaying() const
    {
        ASSERT(sys < NUM_CHANNELS && "AudioChannel has invalid ID");
        return _SYS_audio_isPlaying(sys);
    }

    void stop() const
    {
        ASSERT(sys < NUM_CHANNELS && "AudioChannel has invalid ID");
        _SYS_audio_stop(sys);
    }

    void pause() const
    {
        ASSERT(sys < NUM_CHANNELS && "AudioChannel has invalid ID");
        _SYS_audio_pause(sys);
    }

    void resume() const
    {
        ASSERT(sys < NUM_CHANNELS && "AudioChannel has invalid ID");
        _SYS_audio_resume(sys);
    }

    void setVolume(int volume) const
    {
        ASSERT(sys < NUM_CHANNELS && "AudioChannel has invalid ID");
        _SYS_audio_setVolume(sys, volume);
    }

    void setSpeed(unsigned hz) const
    {
        ASSERT(sys < NUM_CHANNELS && "AudioChannel has invalid ID");
        _SYS_audio_setSpeed(sys, hz);
    }

    int volume() const
    {
        ASSERT(sys < NUM_CHANNELS && "AudioChannel has invalid ID");
        return _SYS_audio_volume(sys);
    }

    uint32_t pos() const
    {
        ASSERT(sys < NUM_CHANNELS && "AudioChannel has invalid ID");
        return _SYS_audio_pos(sys);
    }
};

struct AudioTracker {
    static bool play(const AssetTracker &asset) {
        return _SYS_tracker_play(&asset.song);
    }

    static bool resume() {
        return _SYS_tracker_play(0);
    }

    static void pause() {
        _SYS_tracker_pause();
    }

    static void stop() {
        _SYS_tracker_stop();
    }

    static bool isStopped() {
        return _SYS_tracker_isStopped();
    }

    static bool isPaused() {
        return _SYS_tracker_isPaused();
    }

    static void setVolume(int volume, _SYSAudioChannelID ch = -1)
    {
        ASSERT(volume >= 0 && volume <= _SYS_AUDIO_MAX_VOLUME);
        _SYS_tracker_setVolume(volume, ch);
    }

    static void setTempoModifier(int modifier)
    {
        ASSERT(modifier > -100);
        _SYS_tracker_setTempoModifier(modifier);
    }

    static void setPosition(uint16_t phrase, uint16_t row)
    {
        _SYS_tracker_setPosition(phrase, row);
    }
};

} // namespace Sifteo