PAudioOut.h

Go to the documentation of this file.

//* -*- mode:C++; tab-width:4; c-basic-offset:4; indent-tabs-mode:nil -*- */
//    Name:       src/devices/PAudioOut.h
//    Purpose:    Controls sound presentation (but not recording).
//    Author:     Shane T. Mueller, Ph.D.
//    Copyright:  (c) 2003-2026 Shane T. Mueller <smueller@obereed.net>
//    License:    GPL 2
//
//
//
//     This file is part of the PEBL project.
//
//    PEBL 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.
//
//    PEBL 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 PEBL; if not, write to the Free Software
//    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#ifndef __PAUDIOOUT_H__
#define __PAUDIOOUT_H__
#include "PDevice.h"
#include <string>
 
 
 
class PAudioOut: public PDevice
{
 public:
    PAudioOut();
    PAudioOut(const std::string & filename);
    virtual ~PAudioOut();
 
 
    virtual bool LoadSoundFile(const std::string & filename){return false;};
 
    virtual bool Play(){return false;};
    virtual bool PlayForeground(){return false;};
    virtual bool Stop(){return false;};
    virtual bool SetPanning(const double left,const double right){return false;};
    //A PAudioOut has a tunable amplitude parameter.  Set to 100
    //to get the 'real' volume of the file; adjust up or down as needed.
    //Will not avoid clipping.
 
    //virtual int GetAmplitude(){return 0;};
    //virtual void SetAmplitude(int ){};
 
    virtual bool Initialize(){return false;};
 
    //These are mainly for programatically-generated sound buffers
    //(see below).
    //    void SetSampleRate(long int);
    //    long int GetSampleRate();
 
 
 
    //Programatically-generated sound buffers.  No file needed.
    virtual bool CreateSineWave(float freq, long unsigned int length, long double volume){
        float x = freq;
        long unsigned int xx = length;
        long double xxx =volume;return false;};
    //virtual bool CreateSquareWave(float freq, double length, int amplitude);
    //virtual bool CreateSawtoothWave(float freq, double length, int amplitude);
 
    virtual PEBL_DEVICE_TYPE GetDeviceType(){return PDT_AUDIO_OUT;};
 
private:
 
protected:
    unsigned int mSampleRate;
    int mChannel;        //index of channel to use--for mixer
    long double  mAmplitudeLeft;  //left; between 0 and 1
    long double  mAmplitudeRight; //right; between 0 and 1
 
    //  int mFileName;
};
 
 
#endif