Public API Reference

isndsys/ss_source.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_ISNDSYS_SOURCE_H__
#define __CS_SNDSYS_ISNDSYS_SOURCE_H__

#include "csutil/scf.h"
#include "csgeom/vector3.h"
#include "isndsys/ss_structs.h"
#include "isndsys/ss_filter.h"

struct iSndSysFilter;
struct iSndSysStream;

#ifndef CS_SNDSYS_SOURCE_DISTANCE_INFINITE
#define CS_SNDSYS_SOURCE_DISTANCE_INFINITE -1.0f
#endif

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

  virtual void SetVolume (float volume) = 0;
  virtual float GetVolume () = 0;

  virtual csRef<iSndSysStream> GetStream() = 0;

  //  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_SOURCEOUT, SS_FILTER_LOC_SOURCEIN
  //  
  //  Returns FALSE if the filter could not be added.
  virtual bool AddOutputFilter(SndSysFilterLocation Location, iSndSysSoftwareOutputFilter *pFilter) = 0;

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

  virtual iSndSysSource *GetPtr() = 0;
};

struct iSndSysSourceSoftware : public iSndSysSource
{
  SCF_INTERFACE(iSndSysSourceSoftware,2,0,0);

  virtual size_t MergeIntoBuffer(csSoundSample *frame_buffer, size_t frame_count) = 0;


  virtual void ProcessOutputFilters() = 0;

};

struct iSndSysSourceSoftware3D : public iSndSysSourceSoftware
{
  SCF_INTERFACE(iSndSysSourceSoftware3D,2,0,0);

  virtual void SetPosition(csVector3 pos) = 0;
  virtual csVector3 GetPosition() = 0;

  virtual void SetDirection(csVector3 dir) = 0;
  virtual csVector3 GetDirection() = 0;

  virtual void SetDirectionalRadiation(float rad) = 0;

  virtual float GetDirectionalRadiation() = 0;

  virtual void SetMinimumDistance (float distance) = 0;

  virtual void SetMaximumDistance (float distance) = 0;

  virtual float GetMinimumDistance () = 0;

  virtual float GetMaximumDistance () = 0;

//  virtual bool AttachFilter(csRef<iSound2Filter> filter) = 0;

//  virtual bool RemoveFilter(csRef<iSound2Filter> filter)= 0;
};

#endif // __CS_SNDSYS_ISNDSYS_SOURCE_H__

---