Public API Reference

isndsys/ss_renderer.h

Go to the documentation of this file.

/*
    Copyright (C) 2004 by Andrew Mann
    Copyright (C) 1998-2000 by Jorrit Tyberghein

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library 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
    Library General Public License for more details.

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

#ifndef __CS_SNDSYS_RENDERER_H__
#define __CS_SNDSYS_RENDERER_H__

#include "csutil/scf.h"
#include "isndsys/ss_filter.h"

struct csSndSysSoundFormat;
struct iSndSysData;
struct iSndSysStream;
struct iSndSysSource;
struct iSndSysListener;
struct iSndSysRendererCallback;

#ifndef CS_SNDSYS_SOURCE_DISTANCE_INFINITE
#define CS_SNDSYS_SOURCE_DISTANCE_INFINITE -1.0f
#endif

#define CS_SNDSYS_SOURCE_STOPPED    0
#define CS_SNDSYS_SOURCE_PLAYING    1


struct iSndSysRenderer : public virtual iBase
{
  SCF_INTERFACE(iSndSysRenderer,0,2,1);

  virtual void SetVolume (float vol) = 0;

  virtual float GetVolume () = 0;

  virtual csPtr<iSndSysStream> CreateStream(iSndSysData* data,
        int mode3d) = 0;

  virtual csPtr<iSndSysSource> CreateSource(iSndSysStream* stream) = 0;

  virtual bool RemoveStream(iSndSysStream* stream) = 0;

  virtual bool RemoveSource(iSndSysSource* source) = 0;

  virtual csRef<iSndSysListener> GetListener () = 0;

  virtual bool RegisterCallback(iSndSysRendererCallback *pCallback) = 0;

  virtual bool UnregisterCallback(iSndSysRendererCallback *pCallback) = 0;
};

//
//  A component wishing to receive notification of Sound Renderer events
//  should implement this interface, and call iSndSysRenderer::RegisterCallback()
//  to register with the renderer.
//
struct iSndSysRendererCallback : public virtual iBase
{
  SCF_INTERFACE(iSndSysRendererCallback,0,1,0);

  virtual void StreamAddNotification(iSndSysStream *pStream) = 0;

  virtual void StreamRemoveNotification(iSndSysStream *pStream) = 0;

  virtual void SourceAddNotification(iSndSysSource *pSource) = 0;

  virtual void SourceRemoveNotification(iSndSysSource *pSource) = 0;
};



struct iSndSysRendererSoftware : public virtual iBase
{
  SCF_INTERFACE(iSndSysRendererSoftware,0,1,1);

  //  Output filters can only receive sound data and cannot modify it.  They will receive data
  //   from the same thread that the CS event handler executes in, once per frame.
  //
  //  Valid Locations:  SS_FILTER_LOC_RENDEROUT
  //  
  //  Returns FALSE if the filter could not be added.
  virtual bool AddOutputFilter(SndSysFilterLocation Location, iSndSysSoftwareOutputFilter *pFilter) = 0;

  //
  //  Valid Locations:  SS_FILTER_LOC_RENDEROUT
  //
  // Returns FALSE if the filter is not in the list at the time of the call.
  virtual bool RemoveOutputFilter(SndSysFilterLocation Location, iSndSysSoftwareOutputFilter *pFilter) = 0;
};



#endif // __CS_SNDSYS_RENDERER_H__

---