contrib/include/wx/mmedia/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 "wx/mmedia/defs.h"
  14 #include "wx/mmedia/sndbase.h"
  15 #include "wx/mmedia/sndcodec.h"
  16
  17 #define wxSOUND_INFINITE_TIME ((wxUint32)-1)
  18
  19 //
  20 // Codec router class
  21 //
  22
  23 class WXDLLIMPEXP_MMEDIA 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(wxUint32 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.
  71     // Several things must be done before calling them.
  72     // Users should use Play(), ...
  73     bool StartProduction(int evt);
  74     bool StopProduction();
  75
  76     // These three functions deals with the length, the position in the sound file.
  77     // All the values are expressed in bytes. If you need the values expressed
  78     // in terms of time, you have to use GetSoundFormat().GetTimeFromBytes(...)
  79     wxUint32 GetLength();
  80     wxUint32 GetPosition();
  81     wxUint32 SetPosition(wxUint32 new_position);
  82
  83     // These two functions use the sound format specified by GetSoundFormat().
  84     // All samples must be encoded in that format.
  85     wxSoundStream& Read(void *buffer, wxUint32 len);
  86     wxSoundStream& Write(const void *buffer, wxUint32 len);
  87
  88     // This function set the sound format of the file. !! It must be used only
  89     // when you are in output mode (concerning the file) !! If you are in
  90     // input mode (concerning the file) you can't use this function to modify
  91     // the format of the samples returned by Read() !
  92     // For this action, you must use wxSoundRouterStream applied to wxSoundFileStream.
  93     bool SetSoundFormat(const wxSoundFormatBase& format);
  94
  95     // This function returns the Codec name. This is useful for those who want to build
  96     // a player (But also in some other case).
  97     virtual wxString GetCodecName() const;
  98
  99     // You should use this function to test whether this file codec can read
 100     // the stream you passed to it.
 101     virtual bool CanRead() { return FALSE; }
 102
 103 protected:
 104     wxSoundRouterStream m_codec;
 105     wxSoundStream *m_sndio;
 106     wxInputStream *m_input;
 107     wxOutputStream *m_output;
 108
 109     wxSoundFileState m_state, m_oldstate;
 110     wxUint32 m_length, m_bytes_left;
 111     bool m_prepared;
 112
 113 protected:
 114     virtual bool PrepareToPlay() = 0;
 115     virtual bool PrepareToRecord(wxUint32 time) = 0;
 116     virtual bool FinishRecording() = 0;
 117     virtual bool RepositionStream(wxUint32 position) = 0;
 118     void FinishPreparation(wxUint32 len);
 119
 120     virtual wxUint32 GetData(void *buffer, wxUint32 len) = 0;
 121     virtual wxUint32 PutData(const void *buffer, wxUint32 len) = 0;
 122
 123     void OnSoundEvent(int evt);
 124 };
 125
 126 #endif