Public API Reference

csplugincommon/sndsys/snddata.h

/*
    Copyright (C) 2006 by Andrew Mann

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    General Public License for more details.

    You should have received a copy of the GNU General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/


#ifndef SNDDATA_H
#define SNDDATA_H

#include "iutil/databuff.h"
#include "isndsys/ss_structs.h"
#include "isndsys/ss_data.h"
#include "csutil/scf_implementation.h"

namespace CS
{
  namespace SndSys
  {


  class CS_CRYSTALSPACE_EXPORT SndSysBasicData :
    public scfImplementation1<SndSysBasicData, iSndSysData>
  {
  public:
    SndSysBasicData(iBase *pParent);
    virtual ~SndSysBasicData();

    // Internal functions
  protected:

    //    This is only called the first time that SoundFormat or SampleCount data is requested.
    virtual void Initialize() = 0;


    // Interface implementation

    //------------------------
    // iSndSysData
    //------------------------
  public:
    virtual const csSndSysSoundFormat *GetFormat();

    virtual size_t GetFrameCount();

    virtual size_t GetDataSize() = 0;

    virtual iSndSysStream *CreateStream (csSndSysSoundFormat *pRenderFormat, int Mode3D) = 0;

    //   A filename isn't a bad idea!
    virtual void SetDescription (const char *pDescription);

    //   This may return 0 if no description is set.
    virtual const char *GetDescription() { return m_pDescription; }

    //  Member variables
  protected:

    bool m_bInfoReady;

    //    Currently this is the default format that the ogg vorbis library returns for a given Ogg audio file.
    csSndSysSoundFormat m_SoundFormat;

    size_t m_FrameCount;

    char *m_pDescription;
  };



  }
  // END namespace CS::SndSys
}
// END namespace CS


#endif // #ifndef SNDDATA_H

---