utils/wxMMedia2/lib/sndfile.h

   1 // --------------------------------------------------------------------------
   2 // Name: sndfile.h
   3 // Purpose:
   4 // Date: 08/11/1999
   5 // Author: Guilhem Lavaux <lavaux@easynet.fr> (C) 1999
   6 // CVSID: $Id$
   7 // --------------------------------------------------------------------------
   8 #ifndef _WX_SNDFILE_H
   9 #define _WX_SNDFILE_H
  10
  11 #include <wx/defs.h>
  12 #include <wx/stream.h>
  13 #include <stdlib.h>
  14 #include "sndbase.h"
  15 #include "sndcodec.h"
  16
  17 #define wxSOUND_INFINITE_TIME ((unsigned long)-1)
  18
  19 //
  20 // Codec router class
  21 //
  22
  23 class WXDLLEXPORT wxSoundRouterStream: public wxSoundStreamCodec {
  24  public:
  25   wxSoundRouterStream(wxSoundStream& sndio);
  26   ~wxSoundRouterStream();
  27
  28   wxSoundStream& Read(void *buffer, wxUint32 len);
  29   wxSoundStream& Write(const void *buffer, wxUint32 len);
  30
  31   bool SetSoundFormat(const wxSoundFormatBase& format);
  32
  33   bool StartProduction(int evt);
  34   bool StopProduction();
  35
  36   wxUint32 GetBestSize() const;
  37
  38  protected:
  39   wxSoundStream *m_router;
  40 };
  41
  42 typedef enum {
  43  wxSOUND_FILE_STOPPED,
  44  wxSOUND_FILE_PAUSED,
  45  wxSOUND_FILE_PLAYING,
  46  wxSOUND_FILE_RECORDING
  47 } wxSoundFileState;
  48
  49 //
  50 // Base class for file coders/decoders
  51 //
  52
  53 class wxSoundFileStream: public wxSoundStream {
  54  public:
  55   wxSoundFileStream(wxInputStream& stream, wxSoundStream& io_sound);
  56   wxSoundFileStream(wxOutputStream& stream, wxSoundStream& io_sound);
  57   ~wxSoundFileStream();
  58
  59   // Usual sound file calls (Play, Stop, ...)
  60   bool Play();
  61   bool Record(unsigned long time);
  62   bool Stop();
  63   bool Pause();
  64   bool Resume();
  65
  66   // Functions which return the current state
  67   bool IsStopped() const { return m_state == wxSOUND_FILE_STOPPED; }
  68   bool IsPaused() const { return m_state == wxSOUND_FILE_PAUSED; }
  69
  70   // A user should not call these two functions. Several things must be done before calling them.
  71   // Users should use Play(), ...
  72   bool StartProduction(int evt);
  73   bool StopProduction();
  74
  75   // These three functions deals with the length, the position in the sound file.
  76   // All the values are expressed in bytes. If you need the values expressed in terms of
  77   // time, you have to use GetSoundFormat().GetTimeFromBytes(...)
  78   wxUint32 GetLength();
  79   wxUint32 GetPosition();
  80   wxUint32 SetPosition(wxUint32 new_position);
  81
  82   // These two functions use the sound format specified by GetSoundFormat(). All samples
  83   // must be encoded in that format.
  84   wxSoundStream& Read(void *buffer, wxUint32 len);
  85   wxSoundStream& Write(const void *buffer, wxUint32 len);
  86
  87   // This function set the sound format of the file. !! It must be used only when you are
  88   // in output mode (concerning the file) !! If you are in input mode (concerning the file)
  89   // You can't use this function to modify the format of the samples returned by Read() !
  90   // For this action, you must use wxSoundRouterStream applied to wxSoundFileStream.
  91   bool SetSoundFormat(const wxSoundFormatBase& format);
  92
  93   // You should use this function to test whether this file codec can read the stream you passed
  94   // to it.
  95   virtual bool CanRead() { return FALSE; }
  96
  97  protected:
  98   wxSoundRouterStream m_codec;
  99   wxSoundStream *m_sndio;
 100   wxInputStream *m_input;
 101   wxOutputStream *m_output;
 102
 103   wxSoundFileState m_state, m_oldstate;
 104   wxUint32 m_length, m_bytes_left;
 105   bool m_prepared;
 106
 107  protected:
 108   virtual bool PrepareToPlay() = 0;
 109   virtual bool PrepareToRecord(unsigned long time) = 0;
 110   virtual bool FinishRecording() = 0;
 111   void FinishPreparation(wxUint32 len);
 112
 113   virtual wxUint32 GetData(void *buffer, wxUint32 len) = 0;
 114   virtual wxUint32 PutData(const void *buffer, wxUint32 len) = 0;
 115
 116   void OnSoundEvent(int evt);
 117 };
 118
 119 #endif