libcm/src/cmAudioPortFile.h

//| Copyright: (C) 2009-2020 Kevin Larke <contact AT larke DOT org> 
//| License: GNU GPL version 3.0 or above. See the accompanying LICENSE file.
#ifndef cmAudioPortFile_h
#define cmAudioPortFile_h

#ifdef __cplusplus
extern "C" {
#endif

  //( { file_desc:"This is an audio device driver for cmAudioPort which supports reading and writing audio files as though they are real-time devices." kw[audio file rt] } 
  
  cmApRC_t      cmApFileAllocate( cmRpt_t* rpt );
  cmApRC_t      cmApFileFree();

  cmApRC_t      cmApFileInitialize( cmRpt_t* rpt, unsigned baseApDevIdx );
  cmApRC_t      cmApFileFinalize();
  bool          cmApFileIsValid();

  unsigned      cmApFileDeviceCreate( 
    const cmChar_t* devLabel,
    const cmChar_t* iFn,
    const cmChar_t* oFn,
    unsigned        oBits,
    unsigned        oChCnt );

  cmApRC_t      cmApFileDeviceDestroy( unsigned devIdx ); 
  
  unsigned      cmApFileDeviceCount();
  const char*   cmApFileDeviceLabel(          unsigned devIdx );
  unsigned      cmApFileDeviceChannelCount(   unsigned devIdx, bool inputFl );
  double        cmApFileDeviceSampleRate(     unsigned devIdx );
  unsigned      cmApFileDeviceFramesPerCycle( unsigned devIdx, bool inputFl );

  cmApRC_t      cmApFileDeviceSetup(          
    unsigned          devIdx, 
    double            srate, 
    unsigned          framesPerCycle, 
    cmApCallbackPtr_t callbackPtr,
    void*             userCbPtr );


  cmApRC_t      cmApFileDeviceStart( unsigned devIdx );
  cmApRC_t      cmApFileDeviceStop(  unsigned devIdx );
  bool          cmApFileDeviceIsStarted( unsigned devIdx );
  void          cmApFileReport( cmRpt_t* rpt );
  void          cmApFileTest( cmRpt_t* rpt );

  //)
  
#ifdef __cplusplus
}
#endif


#endif