ik_SAudioStreamFormat.h

Go to the documentation of this file.

// Copyright (C) 2002-2014 Nikolaus Gebhardt
// This file is part of the "irrKlang" library.
// For conditions of distribution and use, see copyright notice in irrKlang.h

#ifndef __S_IRRKLANG_AUDIO_STREAM_FORMAT_H_INCLUDED__
#define __S_IRRKLANG_AUDIO_STREAM_FORMAT_H_INCLUDED__

#include "ik_IRefCounted.h"


namespace irrklang
{

    enum ESampleFormat
    {
        ESF_U8, 

        ESF_S16 
    };


    struct SAudioStreamFormat
    {
        ik_s32 ChannelCount; 


        ik_s32 FrameCount;      

        ik_s32 SampleRate;
        
        ESampleFormat SampleFormat;

        inline ik_s32 getSampleSize() const
        {
            return (SampleFormat == ESF_U8) ? 1 : 2;
        }

        inline ik_s32 getFrameSize() const
        {
            return ChannelCount * getSampleSize();
        }

        /* Returns an invalid negative value when the stream has an unknown lenght */
        inline ik_s32 getSampleDataSize() const
        {
            return getFrameSize() * FrameCount;
        }

        inline ik_s32 getBytesPerSecond() const
        {
            return getFrameSize() * SampleRate;
        }
    };


} // end namespace irrklang

#endif