src/Audio/PCMSynthesiser.hpp

   1 /*
   2 Copyright_License {
   3
   4   XCSoar Glide Computer - http://www.xcsoar.org/
   5   Copyright (C) 2000-2013 The XCSoar Project
   6   A detailed list of copyright holders can be found in the file "AUTHORS".
   7
   8   This program is free software; you can redistribute it and/or
   9   modify it under the terms of the GNU General Public License
  10   as published by the Free Software Foundation; either version 2
  11   of the License, or (at your option) any later version.
  12
  13   This program is distributed in the hope that it will be useful,
  14   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16   GNU General Public License for more details.
  17
  18   You should have received a copy of the GNU General Public License
  19   along with this program; if not, write to the Free Software
  20   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  21 }
  22 */
  23
  24 #ifndef XCSOAR_AUDIO_PCM_SYNTHESISER_HPP
  25 #define XCSOAR_AUDIO_PCM_SYNTHESISER_HPP
  26
  27 #include <stddef.h>
  28 #include <stdint.h>
  29
  30 /**
  31  * This interface is used by PCMPlayer.
  32  */
  33 class PCMSynthesiser {
  34 public:
  35   /**
  36    * The caller requests to generate PCM samples.
  37    *
  38    * Note that this method may be called from any thread.  The
  39    * PCMSynthesiser implementation must be thread-safe.
  40    *
  41    * @param buffer the destination buffer (host byte order)
  42    * @param n the number of 16 bit mono samples that shall be generated
  43    */
  44   virtual void Synthesise(int16_t *buffer, size_t n) = 0;
  45 };
  46
  47 #endif