Public API Reference

isndsys/ss_stream.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_STREAM_H__
#define __CS_SNDSYS_STREAM_H__

#include "csutil/scf.h"

struct csSndSysSoundFormat;
struct iSndSysData;
struct iSndSysStreamCallback;

const size_t CS_SNDSYS_STREAM_UNKNOWN_LENGTH = (size_t)-1;

#define CS_SNDSYS_STREAM_PAUSED     0
#define CS_SNDSYS_STREAM_UNPAUSED   1

#define CS_SNDSYS_STREAM_DONTLOOP   0
#define CS_SNDSYS_STREAM_LOOP       1

enum
{
  CS_SND3D_DISABLE=0,
  CS_SND3D_RELATIVE,
  CS_SND3D_ABSOLUTE
};

//
//  All audio is presented to the sound system in the form of a stream.
//  This interface is the minimal interface that all audio providing 
//  objects must implement in order to produce sound.
//
struct iSndSysStream : public virtual iBase
{
  SCF_INTERFACE(iSndSysStream,0,2,1);

  //  This is not guaranteed to be useful for any particular purpose, different,
  //  or even accurate.  This is mainly for diagnostic purposes.
  virtual const char *GetDescription() = 0;

  virtual const csSndSysSoundFormat *GetRenderedFormat() = 0;

  virtual int Get3dMode() = 0;

  virtual size_t GetFrameCount() = 0;

  virtual size_t GetPosition() = 0;

  virtual bool ResetPosition() = 0;

  virtual bool SetPosition (size_t newposition) = 0;

  virtual bool Pause() = 0;

  virtual bool Unpause() = 0;

  virtual int GetPauseState() = 0;

  virtual bool SetLoopState(int loopstate) = 0;

  virtual int GetLoopState() = 0;

  virtual void SetPlayRatePercent(int percent) = 0;

  virtual int GetPlayRatePercent() = 0;

  virtual void SetAutoUnregister(bool autounreg) = 0;

  virtual bool GetAutoUnregister() = 0;

  virtual bool GetAutoUnregisterRequested() = 0;


  virtual void AdvancePosition(size_t frame_delta) = 0;

  virtual void GetDataPointers(size_t* position_marker, size_t max_requested_frames,
        void **buffer1, size_t *buffer1_frames, void **buffer2, size_t *buffer2_frames) = 0;

  virtual void InitializeSourcePositionMarker (size_t* position_marker) = 0;

  virtual void ProcessNotifications() = 0;

  virtual bool RegisterCallback(iSndSysStreamCallback *pCallback) = 0;

  virtual bool UnregisterCallback(iSndSysStreamCallback *pCallback) = 0;

  //   it's crossed.
  virtual bool RegisterFrameNotification(size_t frame_number) = 0;
};

//
//  A component wishing to receive notification of Sound Stream events
//  should implement this interface, and call iSndSysStream::RegisterCallback()
//  to register with the stream of interest.
//
struct iSndSysStreamCallback : public virtual iBase
{
  SCF_INTERFACE(iSndSysStreamCallback,0,1,0);

  virtual void StreamLoopNotification() = 0;

  virtual void StreamPauseNotification() = 0;

  virtual void StreamUnpauseNotification() = 0;

  virtual void StreamFrameNotification(size_t frame_number) = 0;
};





#endif // __CS_SNDSYS_STREAM_H__

---