annotate Plugins/Input/adplug/core/opl.h @ 507:b3dd43f37b81 trunk

[svn] documentation updates.

/*
 * Adplug - Replayer for many OPL2/OPL3 audio file formats.
 * Copyright (C) 1999 - 2005 Simon Peter, <[e-mail]>, et al.
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * opl.h - OPL base class, by Simon Peter <[e-mail]>
 */

#ifndef H_ADPLUG_OPL
#define H_ADPLUG_OPL

class Copl
{
 public:
  typedef enum {
    TYPE_OPL2, TYPE_OPL3, TYPE_DUAL_OPL2
  } ChipType;

  Copl()
    : currChip(0), currType(TYPE_OPL2)
    {
    }

  virtual void write(int reg, int val) = 0;	// combined register select + data write
  virtual void setchip(int n)			// select OPL chip
    {
      if(n < 2)
	currChip = n;
    }

  virtual void init(void) = 0;			// reinitialize OPL chip(s)

  // return this OPL chip's type
  ChipType gettype()
    {
      return currType;
    }

  // Emulation only: fill buffer
  virtual void update(short *buf, int samples) {}

 protected:
  int		currChip;		// currently selected OPL chip number
  ChipType	currType;		// this OPL chip's type
};

#endif