psk31lx     documentation     new, restructured version  
-----------------------------------------------------------------------------

1.) directory structure
=======================

modes/
  Containes all mode depending classes used for encoding and decoding,
  currently the PSK31 recevier, PSK31 transmitter and FFT receiver.
  Further extensions like MT63 or RTTY receiver/transmitter will be
  put here.
  psk31-receveier.C, .h
  psk31-transmitter.C, .h
  psk31-coder.C, .h
  psk31-fft.C, .h
  hansis-fft.C, .h
  coder.h

server/
  Containes all code for interfacing the user interface with the low
  level stuff. Two modes are supported: direct mode and socket
  communication mode. Currently only the direct mode is sufficiently
  tested.

  direct-mode:
  server-main.C
     Opens audio device, starts a new thread for audio processing and
     en-/decoding. The main tread continues to be the user interface,
     which can call the offered access functions...

  socket-mode:
  socket-server.C
  user-socket.C
     [names will change, do not use this code, it is not functional]
     In theory, it should be that way in the future:
       linking modes/* with socket-server, you get an executable,
       which opens audio, and offers a socket for interfacing a user
       interface 
       linking user/* with userif-socket, you get an executable user
       interface, which will use socket to connect to the server. It
       should work identically to a user interface linked with
       server-main and all modes/* stuff.
 

user/
  That's my plain old text based user interface

user-twpsk/
  This includes everything which belongs to the twpsk graphical X11 
  interface by Ted Williams WA0EIR


"make"
  should compile everything


2.) server API (direct and socket mode) [currently used direct mode available]
-----------------------------------------------------------------------------
see server/server.h for details...




  (to be continued...)