Magic_Game/src/kiwano-audio/Sound.h

// Copyright (c) 2016-2018 Kiwano - Nomango
//
// 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
#include <kiwano-audio/Transcoder.h>
#include <kiwano/core/ObjectBase.h>
#include <kiwano/core/Resource.h>
#include <kiwano/platform/win32/ComPtr.hpp>
#include <xaudio2.h>

namespace kiwano
{
namespace audio
{
class AudioModule;

KGE_DECLARE_SMART_PTR(Sound);

/**
 * \addtogroup Audio
 * @{
 */

/**
 * \~chinese
 * @brief <EFBFBD><EFBFBD>Ƶ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>
 */
class KGE_API Sound : public ObjectBase
{
    friend class AudioModule;

public:
    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ƶ<EFBFBD><C6B5><EFBFBD><EFBFBD>
    /// @param res <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ƶ<EFBFBD>ļ<EFBFBD>·<EFBFBD><C2B7>
    static SoundPtr Create(const String& file_path);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ƶ<EFBFBD><C6B5><EFBFBD><EFBFBD>
    /// @param res <20><>Ƶ<EFBFBD><C6B5>Դ
    static SoundPtr Create(const Resource& res);

    Sound();

    virtual ~Sound();

    /// \~chinese
    /// @brief <20>򿪱<EFBFBD><F2BFAAB1><EFBFBD><EFBFBD><EFBFBD>Ƶ<EFBFBD>ļ<EFBFBD>
    /// @param res <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ƶ<EFBFBD>ļ<EFBFBD>·<EFBFBD><C2B7>
    bool Load(const String& file_path);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ƶ<EFBFBD><C6B5>Դ
    /// @param res <20><>Ƶ<EFBFBD><C6B5>Դ
    bool Load(const Resource& res);

    /// \~chinese
    /// @brief <20>Ƿ<EFBFBD><C7B7><EFBFBD>Ч
    bool IsValid() const;

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD>
    /// @param loop_count <20><><EFBFBD><EFBFBD>ѭ<EFBFBD><D1AD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> -1 Ϊѭ<CEAA><D1AD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    void Play(int loop_count = 0);

    /// \~chinese
    /// @brief <20><>ͣ
    void Pause();

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD>
    void Resume();

    /// \~chinese
    /// @brief ֹͣ
    void Stop();

    /// \~chinese
    /// @brief <20>رղ<D8B1><D5B2><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Դ
    void Close();

    /// \~chinese
    /// @brief <20>Ƿ<EFBFBD><C7B7><EFBFBD><EFBFBD>ڲ<EFBFBD><DAB2><EFBFBD>
    bool IsPlaying() const;

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD><C8A1><EFBFBD><EFBFBD>
    float GetVolume() const;

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    /// @param volume <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>С<EFBFBD><D0A1>1.0 Ϊԭʼ<D4AD><CABC><EFBFBD><EFBFBD>, <20><><EFBFBD><EFBFBD> 1 Ϊ<>Ŵ<EFBFBD><C5B4><EFBFBD><EFBFBD><EFBFBD>, 0 Ϊ<><CEAA>С<EFBFBD><D0A1><EFBFBD><EFBFBD>
    void SetVolume(float volume);

private:
    IXAudio2SourceVoice* GetXAudio2Voice() const;

    void SetXAudio2Voice(IXAudio2SourceVoice* voice);

private:
    bool                 opened_;
    bool                 playing_;
    Transcoder           transcoder_;
    IXAudio2SourceVoice* voice_;
};

/** @} */

inline IXAudio2SourceVoice* Sound::GetXAudio2Voice() const
{
    return voice_;
}

inline void Sound::SetXAudio2Voice(IXAudio2SourceVoice* voice)
{
    voice_ = voice;
}
}  // namespace audio
}  // namespace kiwano