Moved wxMMedia to contrib/src/mmedia

Added contrib configure
Made wxSocket sample compile
Made OGL compile
Modified main configure to pass some more parameter
to children
Changed the wxProcess doc according to the modification

Still some win makefiles to come


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@6461 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

contrib/docs/latex/mmedia/bugs.tex

@@ -0,0 +1,11 @@
+\chapter{Bugs}\label{bugs}%
+\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
+\setfooter{\thepage}{}{}{}{}{\thepage}
+
+These are the known bugs.
+
+\begin{itemize}\itemsep=0pt
+\item In the OGLEdit sample, .dia files are output double-spaced
+due to an unidentified bug in the way a stream is converted to a file.
+\end{itemize}
+

contrib/docs/latex/mmedia/cdaudio.tex

@@ -0,0 +1,22 @@
+%
+% automatically generated by HelpGen from
+% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/cdbase.h at 26/Feb/00 14:52:12
+%
+
+
+\section{\class{wxCDAudio}}\label{wxcdaudio}
+
+\wxheading{Derived from}
+
+\helpref{wxObject}{wxobject}
+
+\wxheading{Data structures}
+
+{\small \begin{verbatim}
+typedef struct wxCDtime {
+  wxUint8 track
+\end{verbatim}}
+{\small \begin{verbatim}
+typedef enum { PLAYING, PAUSED, STOPPED } CDstatus
+\end{verbatim}}
+

contrib/docs/latex/mmedia/cdaudlnx.tex

@@ -0,0 +1,73 @@
+%
+% automatically generated by HelpGen from
+% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/cdunix.h at 26/Feb/00 14:52:10
+%
+
+
+\section{\class{wxCDAudioLinux}}\label{wxcdaudiolinux}
+
+
+
+\wxheading{Derived from}
+
+\helpref{wxCDAudio}{wxcdaudio}
+
+\wxheading{Data structures}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+
+\membersection{wxCDAudioLinux::wxCDAudioLinux}\label{wxcdaudiolinuxwxcdaudiolinux}
+
+\func{}{wxCDAudioLinux}{\void}
+
+
+\membersection{wxCDAudioLinux::wxCDAudioLinux}\label{wxcdaudiolinuxwxcdaudiolinux}
+
+\func{}{wxCDAudioLinux}{\param{const char* }{dev\_name}}
+
+
+\membersection{wxCDAudioLinux::\destruct{wxCDAudioLinux}}\label{wxcdaudiolinuxdtor}
+
+\func{}{\destruct{wxCDAudioLinux}}{\void}
+
+
+\membersection{wxCDAudioLinux::Play}\label{wxcdaudiolinuxplay}
+
+\func{bool}{Play}{\param{const wxCDtime\& }{beg\_time}, \param{const wxCDtime\& }{end\_time}}
+
+
+\membersection{wxCDAudioLinux::Pause}\label{wxcdaudiolinuxpause}
+
+\func{bool}{Pause}{\void}
+
+
+\membersection{wxCDAudioLinux::Resume}\label{wxcdaudiolinuxresume}
+
+\func{bool}{Resume}{\void}
+
+
+\membersection{wxCDAudioLinux::GetStatus}\label{wxcdaudiolinuxgetstatus}
+
+\func{CDstatus}{GetStatus}{\void}
+
+
+\membersection{wxCDAudioLinux::GetTime}\label{wxcdaudiolinuxgettime}
+
+\func{wxCDtime}{GetTime}{\void}
+
+
+\membersection{wxCDAudioLinux::GetToc}\label{wxcdaudiolinuxgettoc}
+
+\func{CDtoc\&}{GetToc}{\void}
+
+
+\membersection{wxCDAudioLinux::Ok}\label{wxcdaudiolinuxok}
+
+\constfunc{bool}{Ok}{\void}
+
+
+\membersection{wxCDAudioLinux::OpenDevice}\label{wxcdaudiolinuxopendevice}
+
+\func{void}{OpenDevice}{\param{const char* }{dev\_name}}
+

contrib/docs/latex/mmedia/cdaudwin.tex

@@ -0,0 +1,77 @@
+%
+% automatically generated by HelpGen from
+% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/cdwin.h at 26/Feb/00 14:52:15
+%
+
+
+\section{\class{wxCDAudioWin}}\label{wxcdaudiowin}
+
+
+
+\wxheading{Derived from}
+
+\helpref{wxCDAudio}{wxcdaudio}
+
+\wxheading{Data structures}
+
+{\small \begin{verbatim}
+typedef struct CDAW\_Internal {
+  MCIDEVICEID dev\_id
+\end{verbatim}}
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+
+\membersection{wxCDAudioWin::wxCDAudioWin}\label{wxcdaudiowinwxcdaudiowin}
+
+\func{}{wxCDAudioWin}{\void}
+
+
+\membersection{wxCDAudioWin::wxCDAudioWin}\label{wxcdaudiowinwxcdaudiowin}
+
+\func{}{wxCDAudioWin}{\param{const char* }{dev\_name}}
+
+
+\membersection{wxCDAudioWin::\destruct{wxCDAudioWin}}\label{wxcdaudiowindtor}
+
+\func{}{\destruct{wxCDAudioWin}}{\void}
+
+
+\membersection{wxCDAudioWin::Play}\label{wxcdaudiowinplay}
+
+\func{bool}{Play}{\param{const wxCDtime\& }{beg\_time}, \param{const wxCDtime\& }{end\_time}}
+
+
+\membersection{wxCDAudioWin::Pause}\label{wxcdaudiowinpause}
+
+\func{bool}{Pause}{\void}
+
+
+\membersection{wxCDAudioWin::Resume}\label{wxcdaudiowinresume}
+
+\func{bool}{Resume}{\void}
+
+
+\membersection{wxCDAudioWin::GetStatus}\label{wxcdaudiowingetstatus}
+
+\func{CDstatus}{GetStatus}{\void}
+
+
+\membersection{wxCDAudioWin::GetTime}\label{wxcdaudiowingettime}
+
+\func{wxCDtime}{GetTime}{\void}
+
+
+\membersection{wxCDAudioWin::GetToc}\label{wxcdaudiowingettoc}
+
+\func{const CDtoc\&}{GetToc}{\void}
+
+
+\membersection{wxCDAudioWin::Ok}\label{wxcdaudiowinok}
+
+\constfunc{bool}{Ok}{\void}
+
+
+\membersection{wxCDAudioWin::PrepareToc}\label{wxcdaudiowinpreparetoc}
+
+\func{void}{PrepareToc}{\void}
+

contrib/docs/latex/mmedia/cdtoc.tex

@@ -0,0 +1,118 @@
+%
+% automatically generated by HelpGen from
+% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/cdbase.h at 26/Feb/00 14:52:12
+%
+
+
+\section{\class{CDtoc}}\label{cdtoc}
+
+
+Table of contents manager
+
+\wxheading{Derived from}
+
+No base class
+
+\wxheading{Data structures}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+
+\membersection{CDtoc::CDtoc}\label{cdtoccdtoc}
+
+\func{}{CDtoc}{\param{wxCDtime\& }{tot\_tm}, \param{wxCDtime* }{trks\_tm}, \param{wxCDtime* }{trks\_pos}}
+
+
+\membersection{CDtoc::GetTrackTime}\label{cdtocgettracktime}
+
+\constfunc{wxCDtime}{GetTrackTime}{\param{wxUint8 }{track}}
+
+Returns the length of the specified track
+track: track to get length
+
+
+\membersection{CDtoc::GetTrackPos}\label{cdtocgettrackpos}
+
+\constfunc{wxCDtime}{GetTrackPos}{\param{wxUint8 }{track}}
+
+Returns the position of the specified track
+track: track to get position
+
+
+\membersection{CDtoc::GetTotalTime}\label{cdtocgettotaltime}
+
+\constfunc{wxCDtime}{GetTotalTime}{\void}
+
+Returns the total time
+
+
+\membersection{wxCDAudio::wxCDAudio}\label{wxcdaudiowxcdaudio}
+
+\func{}{wxCDAudio}{\void}
+
+
+\membersection{wxCDAudio::\destruct{wxCDAudio}}\label{wxcdaudiodtor}
+
+\func{}{\destruct{wxCDAudio}}{\void}
+
+
+\membersection{wxCDAudio::Play}\label{wxcdaudioplay}
+
+\func{bool}{Play}{\param{const wxCDtime\& }{beg\_play}, \param{const wxCDtime\& }{end\_play}}
+
+Play audio at the specified position
+
+
+\membersection{wxCDAudio::Play}\label{wxcdaudioplay}
+
+\func{bool}{Play}{\param{const wxCDtime\& }{beg\_play}}
+
+Play audio from the specified to the end of the CD audio
+
+
+\membersection{wxCDAudio::Play}\label{wxcdaudioplay}
+
+\func{bool}{Play}{\param{wxUint8 }{beg\_track}, \param{wxUint8 }{end\_track = 0}}
+
+
+\membersection{wxCDAudio::Pause}\label{wxcdaudiopause}
+
+\func{bool}{Pause}{\void}
+
+Pause the audio playing
+
+
+\membersection{wxCDAudio::Resume}\label{wxcdaudioresume}
+
+\func{bool}{Resume}{\void}
+
+Resume a paused audio playing
+
+
+\membersection{wxCDAudio::GetStatus}\label{wxcdaudiogetstatus}
+
+\func{CDstatus}{GetStatus}{\void}
+
+Get the current CD status
+
+
+\membersection{wxCDAudio::GetTime}\label{wxcdaudiogettime}
+
+\func{wxCDtime}{GetTime}{\void}
+
+Get the current playing time
+
+
+\membersection{wxCDAudio::GetToc}\label{wxcdaudiogettoc}
+
+\func{const CDtoc\&}{GetToc}{\void}
+
+Returns the table of contents
+
+
+\membersection{wxCDAudio::Ok}\label{wxcdaudiook}
+
+\constfunc{bool}{Ok}{\void}
+
+CD ok
+

contrib/docs/latex/mmedia/changes.tex

@@ -0,0 +1,3 @@
+\chapter{Change log}
+\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
+\setfooter{\thepage}{}{}{}{}{\thepage}

contrib/docs/latex/mmedia/classes.tex

@@ -0,0 +1,8 @@
+chapter{Class reference}\label{classref}
+\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
+\setfooter{\thepage}{}{}{}{}{\thepage}
+
+These are the main \mmedia\ classes.
+
+\input sndbase.tex
+\input sndfile.tex

contrib/docs/latex/mmedia/intro.tex

@@ -0,0 +1,47 @@
+\chapter{Introduction}
+\pagenumbering{arabic}%
+\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
+\setfooter{\thepage}{}{}{}{}{\thepage}
+
+The MMedia wxWindows extension is a wxWindows library which provides you
+a full set of multimedia classes including sound recording/playing,
+cd audio playing and video playing. The API is portable and can be used
+on any supported systems with the insurance the behaviour will be the
+same.
+
+\section{File structure}
+
+These are the files that comprise the \mmedia\ library.
+
+\begin{description}\itemsep=0pt
+\item[sndbase.h] Header for wxSoundStream base class and wxSoundFormat base class.
+\item[sndbase.cpp] Basic objects implementation.
+\item[sndfile.h] wxSoundFileStream base class header.
+\item[sndfile.cpp] wxSoundFileStream base class implementation.
+\item[sndpcm.h] wxSoundFormatPcm class header.
+\item[sndpcm.cpp] wxSoundFormatPcm class implementation.
+\item[sndcpcm.h] wxSoundCodecPcm class header (PCM converter).
+\item[sndcpcm.cpp] wxSoundCodecPcm class implementation (PCM converter).
+\item[sndulaw.h]
+\item[sndulaw.cpp]
+\item[sndg72x.h]
+\item[sndg72x.cpp]
+\item[sndoss.h]
+\item[sndoss.cpp]
+\item[sndesd.h]
+\item[sndesd.cpp]
+\item[sndwin.h]
+\item[sndwin.cpp]
+\item[cdbase.h]
+\item[cdbase.cpp]
+\item[cdunix.h]
+\item[cdunix.cpp]
+\item[cdwin.h]
+\item[cdwin.cpp]
+\item[vidbase.h]
+\item[vidbase.cpp]
+\item[vidxanm.h]
+\item[vidxanm.cpp]
+\item[vidwin.h]
+\item[vidwin.cpp]
+\end{description}

contrib/docs/latex/mmedia/mmedia.tex

@@ -0,0 +1,46 @@
+\documentstyle[a4,makeidx,verbatim,texhelp,fancyhea,mysober,mytitle]{report}
+\newcommand{\ogl}[0]{{OGL}}%
+\definecolour{black}{0}{0}{0}%
+\definecolour{cyan}{0}{255}{255}%
+\definecolour{green}{0}{255}{0}%
+\definecolour{magenta}{255}{0}{255}%
+\definecolour{red}{255}{0}{0}%
+\definecolour{blue}{0}{0}{200}%
+\definecolour{yellow}{255}{255}{0}%
+\definecolour{white}{255}{255}{255}%
+\input psbox.tex
+\parindent 0pt
+\parskip 11pt
+\title{Object Graphics Library 3.0}
+\author{Julian Smart}
+\date{September 1998}
+
+\makeindex
+\begin{document}
+\maketitle
+
+\pagestyle{fancyplain}
+\bibliographystyle{plain}
+\pagenumbering{roman}
+\setheader{{\it CONTENTS}}{}{}{}{}{{\it CONTENTS}}
+\setfooter{\thepage}{}{}{}{}{\thepage}
+\tableofcontents%
+
+\input{intro.tex}
+%
+\input{sample.tex}
+%
+\input{classes.tex}
+%
+\input{topics.tex}
+%
+\input{bugs.tex}
+%
+\input{changes.tex}
+
+%
+\addcontentsline{toc}{chapter}{Index}
+\setheader{{\it INDEX}}{}{}{}{}{{\it INDEX}}
+\setfooter{\thepage}{}{}{}{}{\thepage}%
+\printindex
+\end{document}

contrib/docs/latex/mmedia/ogl.hpj

@@ -0,0 +1,17 @@
+[OPTIONS]
+BMROOT=d:\wx2\wxwind~1\docs\latex\ogl ; Assume that bitmaps are where the source is
+TITLE=OGL Manual
+CONTENTS=Contents
+COMPRESS=HIGH
+
+[FILES]
+ogl.rtf
+
+[CONFIG]
+CreateButton("Up", "&Up", "JumpId(`ogl.hlp', `Contents')")
+BrowseButtons()
+
+[MAP]
+
+[BITMAPS]
+

contrib/docs/latex/mmedia/sample.tex

@@ -0,0 +1,87 @@
+\chapter{OGLEdit: a sample OGL application}\label{ogledit}%
+\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
+\setfooter{\thepage}{}{}{}{}{\thepage}
+
+OGLEdit is a sample OGL application that allows the user to draw, edit,
+save and load a few shapes. It should clarify aspects of OGL usage, and
+can act as a template for similar applications. OGLEdit can be found in\rtfsp
+{\tt samples/ogledit} in the OGL distribution.
+
+$$\image{10cm;0cm}{ogledit.eps}$$\par
+
+The wxWindows document/view model has been used in OGL, to reduce the amount of
+housekeeping logic required to get it up and running. OGLEdit also provides
+a demonstration of the Undo/Redo capability supported by the document/view classes,
+and how a typical application might implement this feature.
+
+\section{OGLEdit files}
+
+OGLEdit comprises the following source files.
+
+\begin{itemize}\itemsep=0pt
+\item doc.h, doc.cpp: MyDiagram, DiagramDocument, DiagramCommand, MyEvtHandler
+classes related to diagram functionality and documents.
+\item view.h, view.cpp: MyCanvas, DiagramView classes related to visualisation of
+the diagram.
+\item ogledit.h, ogledit.cpp: MyFrame, MyApp classes related to the overall application.
+\item palette.h, palette.cpp: EditorToolPalette implementing the shape palette.
+\end{itemize}
+
+\section{How OGLEdit works}
+
+OGLEdit defines a DiagramDocument class, each of instance of which holds a MyDiagram
+member which itself contains the shapes.
+
+In order to implement specific mouse behaviour for shapes, a class MyEvtHandler is
+defined which is `plugged into' each shape when it is created, instead of overriding each shape class
+individually. This event handler class also holds a label string.
+
+The DiagramCommand class is the key to implementing Undo/Redo. Each instance of DiagramCommand
+stores enough information about an operation (create, delete, change colour etc.) to allow
+it to carry out (or undo) its command. In DiagramView::OnMenuCommand, when the user initiates the
+command, a new DiagramCommand instance is created which is then sent to the document's
+command processor (see wxWindows manual for more information about doc/view and command
+processing).
+
+Apart from menu commands, another way commands are initiated is by the user left-clicking on
+the canvas or right-dragging on a node. MyCanvas::OnLeftClick in view.cpp shows how
+the appropriate wxClassInfo is passed to a DiagramCommand, to allow DiagramCommand::Do
+to create a new shape given the wxClassInfo.
+
+The MyEvtHandler right-drag methods in doc.cpp implement drawing a line between
+two shapes, detecting where the right mouse button was released and looking for a second
+shape. Again, a new DiagramCommand instance is created and passed to the command
+processor to carry out the command.
+
+DiagramCommand::Do and DiagramCommand::Undo embody much of the
+interesting interaction with the OGL library. A complication of note
+when implementing undo is the problem of deleting a node shape which has
+one or more arcs attached to it. If you delete the node, the arc(s)
+should be deleted too. But multiple arc deletion represents more information
+that can be incorporated in the existing DiagramCommand scheme. OGLEdit
+copes with this by treating each arc deletion as a separate command, and
+sending Cut commands recursively, providing an undo path. Undoing such a
+Cut will only undo one command at a time - not a one to one
+correspondence with the original command - but it's a reasonable
+compromise and preserves Do/Undo whilst keeping our DiagramCommand class
+simple.
+
+\section{Possible enhancements}
+
+OGLEdit is very simplistic and does not employ the more advanced features
+of OGL, such as:
+
+\begin{itemize}\itemsep=0pt
+\item attachment points (arcs are drawn to particular points on a shape)
+\item metafile and bitmaps shapes
+\item divided rectangles
+\item composite shapes, and constraints
+\item creating labels in shape regions
+\item arc labels (OGL has support for three movable labels per arc)
+\item spline and multiple-segment line arcs
+\item adding annotations to node and arc shapes
+\item line-straightening (supported by OGL) and alignment (not supported directly by OGL)
+\end{itemize}
+
+These could be added to OGLEdit, at the risk of making it a less
+useful example for beginners.

contrib/docs/latex/mmedia/sndaiff.tex

@@ -0,0 +1,68 @@
+%
+% automatically generated by HelpGen from
+% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndaiff.h at 26/Feb/00 14:52:29
+%
+
+\section{\class{wxSoundAiff}}\label{wxsoundaiff}
+
+AIFF codec
+
+\wxheading{Derived from}
+
+\helpref{wxSoundFileStream}{wxsoundfilestream}
+
+\wxheading{Data structures}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+
+\membersection{wxSoundAiff::wxSoundAiff}\label{wxsoundaiffwxsoundaiff}
+
+\func{}{wxSoundAiff}{\param{wxInputStream\& }{stream}, \param{wxSoundStream\& }{io\_sound}}
+
+\func{}{wxSoundAiff}{\param{wxOutputStream\& }{stream}, \param{wxSoundStream\& }{io\_sound}}
+
+\membersection{wxSoundAiff::\destruct{wxSoundAiff}}\label{wxsoundaiffdtor}
+
+\func{}{\destruct{wxSoundAiff}}{\void}
+
+
+\membersection{wxSoundAiff::CanRead}\label{wxsoundaiffcanread}
+
+\func{bool}{CanRead}{\void}
+
+
+\membersection{wxSoundAiff::GetCodecName}\label{wxsoundaiffgetcodecname}
+
+\constfunc{wxString}{GetCodecName}{\void}
+
+
+\membersection{wxSoundAiff::PrepareToPlay}\label{wxsoundaiffpreparetoplay}
+
+\func{bool}{PrepareToPlay}{\void}
+
+
+\membersection{wxSoundAiff::PrepareToRecord}\label{wxsoundaiffpreparetorecord}
+
+\func{bool}{PrepareToRecord}{\param{wxUint32 }{time}}
+
+
+\membersection{wxSoundAiff::FinishRecording}\label{wxsoundaifffinishrecording}
+
+\func{bool}{FinishRecording}{\void}
+
+
+\membersection{wxSoundAiff::RepositionStream}\label{wxsoundaiffrepositionstream}
+
+\func{bool}{RepositionStream}{\param{wxUint32 }{position}}
+
+
+\membersection{wxSoundAiff::GetData}\label{wxsoundaiffgetdata}
+
+\func{wxUint32}{GetData}{\param{void* }{buffer}, \param{wxUint32 }{len}}
+
+
+\membersection{wxSoundAiff::PutData}\label{wxsoundaiffputdata}
+
+\func{wxUint32}{PutData}{\param{const void* }{buffer}, \param{wxUint32 }{len}}
+

contrib/docs/latex/mmedia/sndbase.tex

@@ -0,0 +1,288 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name:        sndbase.tex
+%% Purpose:     wxMMedia docs
+%% Author:      Guilhem Lavaux <lavaux@easynet.fr>
+%% Modified by:
+%% Created:     2000
+%% RCS-ID:      $Id$
+%% Copyright:   (c) wxWindows team
+%% Licence:     wxWindows licence
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\section{\class{wxSoundStream}}\label{wxsoundstream}
+
+Base class for sound streams
+
+\wxheading{Derived from}
+
+No base class
+
+\wxheading{Include files}
+
+<wx/mmedia/sndbase.h>
+
+\wxheading{Data structures}
+
+%%
+%% wxSoundStream errors
+%%
+
+\wxheading{wxSoundStream errors}
+
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf wxSOUND\_NOERR}}{No error occured}
+\twocolitem{{\bf wxSOUND\_IOERR}}{An input/output error occured, it may concern
+either a driver or a file}
+\twocolitem{{\bf wxSOUND\_INVFRMT}}{The sound format passed to the function is
+invalid. Generally, it means that you passed out of range values to the codec
+stream or you don't pass the right sound format object to the right sound codec
+stream.}
+\twocolitem{{\bf wxSOUND\_INVDEV}}{Invalid device. Generally, it means that the
+sound stream didn't manage to open the device driver due to an invalid parameter
+or to the fact that sound is not supported on this computer.}
+\twocolitem{{\bf wxSOUND\_NOEXACT}}{No exact matching sound codec has been found for
+this sound format. It means that the sound driver didn't manage to setup the sound
+card with the specified values.}
+\twocolitem{{\bf wxSOUND\_NOCODEC}}{No matching codec has been found. Generally, it 
+may happen when you call wxSoundRouterStream::SetSoundFormat().}
+\twocolitem{{\bf wxSOUND\_MEMERR}}{Not enough memory.}
+\end{twocollist}
+
+%%
+%% C callback
+%%
+
+\wxheading{C callback for wxSound event}
+
+When a sound event is generated, it may either call the internal sound event 
+processor (which can be inherited) or call a C function. Its definition is:
+
+\begin{verbatim}
+  typedef void (*wxSoundCallback)(wxSoundStream *stream, int evt,
+                                  void *cdata);
+\end{verbatim}
+
+The {\bf stream} parameter represents the current wxSoundStream.
+
+The {\bf evt} parameter represents the sound event which is the cause of the calling. (See \helpref{wxSound events}{wxsoundstream}).
+
+The {\bf cdata} parameter represents the user callback data which were specified
+when the user called \helpref{wxSoundStream::Register}{wxsoundstreamregister}.
+
+{\it Note:} There are two other ways to catch sound events: you can inherit the
+sound stream and redefine \helpref{wxSoundStream::OnSoundEvent}{wxsoundstreamonsoundevent}, or you can reroute the events to another sound stream using \helpref{wxSoundStream::SetEventHandler}{wxsoundstreamseteventhandler}.
+
+%%
+%% wxSoundStream streaming mode
+%%
+
+\wxheading{wxSound streaming mode}
+
+The wxSoundStream object can work in three different modes. These modes are specified
+at the call to \helpref{wxSoundStream::StartProduction}{wxsoundstreamstartproduction} 
+and cannot be changed until you call 
+\helpref{wxSoundStream::StopProduction}{wxsoundstreamstopproduction}.
+
+The {\bf wxSOUND\_INPUT} mode is the recording mode. It generates {\bf wxSOUND\_INPUT} 
+events and you cannot use wxSoundStream::Write().
+
+The {\bf wxSOUND\_OUTPUT} mode is the playing mode. It generates {\bf wxSOUND\_OUTPUT} 
+events and you cannot use wxSoundStream::Read().
+
+The {\bf wxSOUND\_DUPLEX} mode activates the full duplex mode. The full duplex requires
+you to make synchronous call to \helpref{wxSoundStream::Read}{wxsoundstreamread} and 
+\helpref{wxSoundStream::Write}{wxsoundstreamwrite}. This means that you must be
+careful with realtime problems. Each time you call Read you must call Write.
+
+%%
+%% wxSoundStream events
+%%
+
+\wxheading{wxSoundStream events}
+
+The sound events are generated when the sound driver (or the sound stream) completes
+a previous sound buffer. There are two possible sound events and two meanings.
+
+The {\bf wxSOUND\_INPUT} event is generated when the sound stream has a new input
+buffer ready to be read. You know that you can read a buffer of the size
+\helpref{GetBestSize()}{wxsoundstreamgetbestsize} without blocking. 
+
+The {\bf wxSOUND\_OUTPUT} event is generated when the sound stream has completed a
+previous buffer. This buffer has been sent to the sound driver and it is ready to
+process a new buffer. Consequently, \helpref{Write}{wxsoundstreamwrite} will not
+block too.
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+%% Ctor && Dtor
+
+\membersection{wxSoundStream::wxSoundStream}\label{wxsoundstreamwxsoundstream}
+
+\func{}{wxSoundStream}{\void}
+
+Default constructor.
+
+\membersection{wxSoundStream::\destruct{wxSoundStream}}\label{wxsoundstreamdtor}
+
+\func{}{\destruct{wxSoundStream}}{\void}
+
+Destructor. The destructor stops automatically all started production and destroys
+any temporary buffer.
+
+%%
+%% Read
+%%
+
+\membersection{wxSoundStream::Read}\label{wxsoundstreamread}
+
+\func{wxSoundStream\&}{Read}{\param{void* }{buffer}, \param{wxUint32 }{len}}
+
+Reads {\it len} bytes from the sound stream. This call may block the user so
+use it carefully when you need to intensively refresh the GUI. You may be
+interested by sound events: see \helpref{wxSoundStream::OnSoundEvent}{wxsoundstreamonsoundevent}. 
+
+It is better to use the size returned by \helpref{wxSoundStream::GetBestSize}{wxsoundstreamgetbestsize}: this may improve performance or accuracy of the
+sound event system.
+
+\wxheading{Parameters}
+
+\docparam{len}{{\it len} is expressed in bytes. If you need to do conversions between bytes
+and seconds use wxSoundFormat.
+See \helpref{wxSoundFormatBase}{wxsoundformatbase}, \helpref{wxSoundStream::GetSoundFormat}{wxsoundstreamgetsoundformat}.}
+
+\docparam{data}{Data in \it{buffer} are coded using the sound format attached to this sound 
+stream. The format is specified with 
+\helpref{SetSoundFormat}{wxsoundstreamsetsoundformat}.}
+
+%%
+%% Write
+%%
+
+\membersection{wxSoundStream::Write}\label{wxsoundstreamwrite}
+
+\func{wxSoundStream\&}{Write}{\param{const void* }{buffer}, \param{wxUint32 }{len}}
+
+Writes \it{len} bytes to the sound stream. This call may block the user so
+use it carefully. You may be interested by sound events: see
+\helpref{wxSoundStream::OnSoundEvent}{wxsoundstreamonsoundevent}.
+
+It is better to use the size returned by \helpref{wxSoundStream::GetBestSize}{wxsoundstreamgetbestsize}: this may improve performance or accuracy of the
+sound event system.
+
+\wxheading{Parameters}
+
+\docparam{len}{This is expressed in bytes. If you need to do conversions between bytes
+and seconds use wxSoundFormat.
+See \helpref{wxSoundFormatBase}{wxsoundformatbase}, \helpref{wxSoundStream::GetSoundFormat}{wxsoundstreamgetsoundformat}.}
+
+\docparam{buffer}{Data in \it{buffer} are coded using the sound format attached to this sound 
+stream. The format is specified with 
+\helpref{SetSoundFormat}{wxsoundstreamsetsoundformat}.}
+
+%%
+%% GetBestSize
+%%
+
+\membersection{wxSoundStream::GetBestSize}\label{wxsoundstreamgetbestsize}
+
+\constfunc{wxUint32}{GetBestSize}{\void}
+
+This function returns the best size for IO calls. The best size provides you
+a good alignment for data to be written (or read) to (or from) the sound stream.
+So, when, for example, a sound event is sent, you are sure the sound stream
+will not block for this buffer size.
+
+%%
+%% wxSoundStream:SetSoundFormat
+%%
+
+\membersection{wxSoundStream::SetSoundFormat}\label{wxsoundstreamsetsoundformat}
+
+\func{bool}{SetSoundFormat}{\param{const wxSoundFormatBase\& }{format}}
+
+SetSoundFormat is one of the key function of the wxSoundStream object.
+It specifies the sound format the user needs. SetSoundFormat tries to
+apply the format to the current sound stream (it can be a sound file or a
+sound driver). Then, either it manages to apply it and it returns {\bf TRUE},
+or it could not and it returns {\bf FALSE}. In this case, you must check
+the error with
+\helpref{wxSoundStream::GetError}{wxsoundstreamgeterror}. See
+\helpref{wxSoundStream errors section}{wxsoundstreamerrors} for more details.
+
+
+\wxheading{Note}
+
+The {\bf format} object can be destroyed after the call. The object does not need it.
+
+\wxheading{Note}
+
+If the error is {\bf wxSOUND\_NOTEXACT}, the stream tries to find the best
+approaching format and setups it. You can check the format which it applied
+with \helpref{wxSoundStream::GetSoundFormat}{wxsoundstreamgetsoundformat}.
+
+%%
+%% GetSoundFormat
+%%
+\membersection{wxSoundStream::GetSoundFormat}\label{wxsoundstreamgetsoundformat}
+\constfunc{wxSoundFormatBase\&}{GetSoundFormat}{\void}
+
+It returns a reference to the current sound format of the stream represented by a
+wxSoundFormatBase object. This object {\it must not} be destroyed by anyone except
+the stream itself.
+
+%%
+%% SetCallback
+%%
+\membersection{wxSoundStream::SetCallback}\label{wxsoundstreamregister}
+
+\func{void}{Register}{\param{int }{evt}, \param{wxSoundCallback }{cbk}, \param{void* }{cdata}}
+
+It installs a C callback for wxSoundStream events. The C callbacks are still
+useful to avoid hard inheritance. You can install only one callback per event.
+Each callback has its callback data.
+
+%%
+%% StartProduction
+%%
+\membersection{wxSoundStream::StartProduction}\label{wxsoundstreamstartproduction}
+
+\func{bool}{StartProduction}{\param{int }{evt}}
+
+StartProduction starts the sound streaming. {\it evt} may be one of
+{\bf wxSOUND\_INPUT}, {\bf wxSOUND\_OUTPUT} or {\bf wxSOUND\_DUPLEX}.
+You cannot specify several flags at the same time. Starting the production
+may automaticaly in position of buffer underrun (only in the case you activated
+recording). Actually this may happen the sound IO queue is too short.
+It is also advised that you fill quickly enough the sound IO queue when the
+driver requests it (through a wxSoundEvent).
+
+\membersection{wxSoundStream::StopProduction}\label{wxsoundstreamstopproduction}
+\func{bool}{StopProduction}{\void}
+
+I stops the async notifier and the sound streaming straightly.
+
+\membersection{wxSoundStream::SetEventHandler}\label{wxsoundstreamseteventhandler}
+\func{void}{SetEventHandler}{\param{wxSoundStream* }{handler}}
+
+Sets the event handler: if it is non-null, all events are routed to it.
+
+\membersection{wxSoundStream::GetError}\label{wxsoundstreamgeterror}
+\constfunc{wxSoundError}{GetError}{\void}
+
+It returns the last error which occured.
+
+\membersection{wxSoundStream::GetLastAccess}\label{wxsoundstreamgetlastaccess}
+\constfunc{wxUint32}{GetLastAccess}{\void}
+
+It returns the number of bytes which were effectively written to/read from the sound stream.
+
+\membersection{wxSoundStream::QueueFilled}\label{wxsoundstreamqueuefilled}
+\constfunc{bool}{QueueFilled}{\void}
+
+It returns whether the sound IO queue is full. When it is full, the next IO call will block
+until the IO queue has at least one empty entry.
+
+\membersection{wxSoundStream::OnSoundEvent}\label{wxsoundstreamonsoundevent}
+\func{void}{OnSoundEvent}{\param{int }{evt}}
+
+It is called by the wxSoundStream when a new sound event occured.

contrib/docs/latex/mmedia/sndcodec.tex

@@ -0,0 +1,39 @@
+%
+% automatically generated by HelpGen from
+% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndcodec.h at 26/Feb/00 14:26:29
+%
+
+\section{\class{wxSoundStreamCodec}}\label{wxsoundstreamcodec}
+
+\wxheading{Derived from}
+
+\helpref{wxSoundStream}{wxsoundstream}
+
+\wxheading{Data structures}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxSoundStreamCodec::wxSoundStreamCodec}\label{wxsoundstreamcodecwxsoundstreamcodec}
+
+\func{}{wxSoundStreamCodec}{\param{wxSoundStream\& }{snd\_io}}
+
+
+\membersection{wxSoundStreamCodec::\destruct{wxSoundStreamCodec}}\label{wxsoundstreamcodecdtor}
+
+\func{}{\destruct{wxSoundStreamCodec}}{\void}
+
+
+\membersection{wxSoundStreamCodec::StartProduction}\label{wxsoundstreamcodecstartproduction}
+
+\func{bool}{StartProduction}{\param{int }{evt}}
+
+
+\membersection{wxSoundStreamCodec::StopProduction}\label{wxsoundstreamcodecstopproduction}
+
+\func{bool}{StopProduction}{\void}
+
+
+\membersection{wxSoundStreamCodec::GetBestSize}\label{wxsoundstreamcodecgetbestsize}
+
+\constfunc{wxUint32}{GetBestSize}{\void}
+

contrib/docs/latex/mmedia/sndesd.tex

@@ -0,0 +1,64 @@
+%
+% automatically generated by HelpGen from
+% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndesd.h at 26/Feb/00 14:26:56
+%
+
+\section{\class{wxSoundStreamESD}}\label{wxsoundstreamesd}
+
+ESD output class
+
+\wxheading{Derived from}
+
+\helpref{wxSoundStream}{wxsoundstream}
+
+\wxheading{Data structures}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+
+\membersection{wxSoundStreamESD::wxSoundStreamESD}\label{wxsoundstreamesdwxsoundstreamesd}
+
+\func{}{wxSoundStreamESD}{\param{const wxString\& }{hostname = "localhost"}}
+
+
+\membersection{wxSoundStreamESD::\destruct{wxSoundStreamESD}}\label{wxsoundstreamesddtor}
+
+\func{}{\destruct{wxSoundStreamESD}}{\void}
+
+
+\membersection{wxSoundStreamESD::Read}\label{wxsoundstreamesdread}
+
+\func{wxSoundStream\&}{Read}{\param{void* }{buffer}, \param{wxUint32 }{len}}
+
+
+\membersection{wxSoundStreamESD::Write}\label{wxsoundstreamesdwrite}
+
+\func{wxSoundStream\&}{Write}{\param{const void* }{buffer}, \param{wxUint32 }{len}}
+
+
+\membersection{wxSoundStreamESD::SetSoundFormat}\label{wxsoundstreamesdsetsoundformat}
+
+\func{bool}{SetSoundFormat}{\param{const wxSoundFormatBase\& }{format}}
+
+
+\membersection{wxSoundStreamESD::StartProduction}\label{wxsoundstreamesdstartproduction}
+
+\func{bool}{StartProduction}{\param{int }{evt}}
+
+
+\membersection{wxSoundStreamESD::StopProduction}\label{wxsoundstreamesdstopproduction}
+
+\func{bool}{StopProduction}{\void}
+
+
+\membersection{wxSoundStreamESD::WakeUpEvt}\label{wxsoundstreamesdwakeupevt}
+
+\func{void}{WakeUpEvt}{\param{int }{evt}}
+
+You should not call this.
+
+
+\membersection{wxSoundStreamESD::QueueFilled}\label{wxsoundstreamesdqueuefilled}
+
+\constfunc{bool}{QueueFilled}{\void}
+

contrib/docs/latex/mmedia/sndfg72x.tex

@@ -0,0 +1,87 @@
+%
+% automatically generated by HelpGen from
+% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndg72x.h at 26/Feb/00 14:52:19
+%
+
+
+\section{\class{wxSoundFormatG72X}}\label{wxsoundformatg72x}
+
+
+G72X format
+
+\wxheading{Derived from}
+
+\helpref{wxSoundFormatBase}{wxsoundformatbase}
+
+\wxheading{Data structures}
+
+{\small \begin{verbatim}
+typedef enum {
+  wxSOUND\_G721,
+  wxSOUND\_G723\_24,
+  wxSOUND\_G723\_40
+} wxSoundG72XType
+\end{verbatim}}
+
+{\small \begin{verbatim}
+typedef struct g72x\_state g72state
+\end{verbatim}}
+
+This fixes a bug in Mingw95
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxSoundFormatG72X::wxSoundFormatG72X}\label{wxsoundformatg72xwxsoundformatg72x}
+
+\func{}{wxSoundFormatG72X}{\void}
+
+
+\membersection{wxSoundFormatG72X::\destruct{wxSoundFormatG72X}}\label{wxsoundformatg72xdtor}
+
+\func{}{\destruct{wxSoundFormatG72X}}{\void}
+
+
+\membersection{wxSoundFormatG72X::SetG72XType}\label{wxsoundformatg72xsetg72xtype}
+
+\func{void}{SetG72XType}{\param{wxSoundG72XType }{type}}
+
+
+\membersection{wxSoundFormatG72X::GetG72XType}\label{wxsoundformatg72xgetg72xtype}
+
+\constfunc{wxSoundG72XType}{GetG72XType}{\void}
+
+
+\membersection{wxSoundFormatG72X::SetSampleRate}\label{wxsoundformatg72xsetsamplerate}
+
+\func{void}{SetSampleRate}{\param{wxUint32 }{srate}}
+
+
+\membersection{wxSoundFormatG72X::GetSampleRate}\label{wxsoundformatg72xgetsamplerate}
+
+\constfunc{wxUint32}{GetSampleRate}{\void}
+
+
+\membersection{wxSoundFormatG72X::GetType}\label{wxsoundformatg72xgettype}
+
+\constfunc{wxSoundFormatType}{GetType}{\void}
+
+
+\membersection{wxSoundFormatG72X::Clone}\label{wxsoundformatg72xclone}
+
+\constfunc{wxSoundFormatBase*}{Clone}{\void}
+
+
+\membersection{wxSoundFormatG72X::GetTimeFromBytes}\label{wxsoundformatg72xgettimefrombytes}
+
+\constfunc{wxUint32}{GetTimeFromBytes}{\param{wxUint32 }{bytes}}
+
+
+\membersection{wxSoundFormatG72X::GetBytesFromTime}\label{wxsoundformatg72xgetbytesfromtime}
+
+\constfunc{wxUint32}{GetBytesFromTime}{\param{wxUint32 }{time}}
+
+
+\membersection{wxSoundFormatG72X::operator!=}\label{wxsoundformatg72xoperatorneq}
+
+\constfunc{bool}{operator!=}{\param{const wxSoundFormatBase\& }{frmt2}}
+

contrib/docs/latex/mmedia/sndfile.tex

@@ -0,0 +1,232 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name:        sndfile.tex
+%% Purpose:     wxMMedia docs
+%% Author:      Guilhem Lavaux <lavaux@easynet.fr>
+%% Modified by:
+%% Created:     2000
+%% RCS-ID:      $Id$
+%% Copyright:   (c) wxWindows team
+%% Licence:     wxWindows licence
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\section{\class{wxSoundFileStream}}\label{wxsoundfilestream}
+
+Base class for file coders/decoders. This class is not constructor (it is an abstract
+class).
+
+\wxheading{Derived from}
+
+\helpref{wxSoundStream}{wxsoundstream}
+
+\wxheading{Include file}
+
+wx/sndfile.h
+
+\wxheading{Data structures}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxSoundFileStream::wxSoundFileStream}\label{wxsoundfilestreamwxsoundfilestream}
+
+\func{}{wxSoundFileStream}{\param{wxInputStream\& }{stream}, \param{wxSoundStream\& }{io\_sound}}
+
+It constructs a new file decoder object which will send 
+audio data to the specified sound stream. 
+The {\it stream} is the input stream to be decoded. The
+{\it io_sound} is the destination sound stream.
+Once it has been constructed, you cannot change any of
+the specified streams nor the direction of the stream.
+
+You will have access to the playback functions.
+
+\func{}{wxSoundFileStream}{\param{wxOutputStream\& }{stream}, \param{wxSoundStream\& }{io\_sound}}
+
+It constructs a new file coder object which will get
+data to be recorded from the specified sound stream.
+The {\it stream} is the output wxStream. The {\it io_sound}
+is the source sound stream of the audio data. Once
+it has been constructed, you cannot change any of
+the specified streams nor the direction of the stream.
+
+\membersection{wxSoundFileStream::\destruct{wxSoundFileStream}}\label{wxsoundfilestreamdtor}
+\func{}{\destruct{wxSoundFileStream}}{\void}
+
+It destroys the current sound file codec.
+
+\membersection{wxSoundFileStream::Play}\label{wxsoundfilestreamplay}
+\func{bool}{Play}{\void}
+
+It starts playing the file. The playing begins, in background
+in nearly all cases, after the return of the function. The
+codec returns to a {\bf stopped} state when it reaches the
+end of the file.
+On success, it returns TRUE.
+
+\membersection{wxSoundFileStream::Record}\label{wxsoundfilestreamrecord}
+\func{bool}{Record}{\param{wxUint32 }{time}}
+
+It starts recording data from the sound stream and writing them
+to the output stream. You have to precise the recording length in
+parameter. This length is expressed in seconds. If you want to
+control the record length (using \helpref{Stop}{wxsoundfilestreamstop}),
+you can set it to wxSOUND_INFINITE_TIME.
+
+On success, it returns TRUE.
+
+\membersection{wxSoundFileStream::Stop}\label{wxsoundfilestreamstop}
+\func{bool}{Stop}{\void}
+
+It stops either recording or playing. Whatever happens (even unexpected
+errors), the stream is stopped when the function returns. When you are
+in recording mode, the file headers are updated and flushed if possible
+(ie: if the output stream is seekable).
+
+On success, it returns TRUE.
+
+\membersection{wxSoundFileStream::Pause}\label{wxsoundfilestreampause}
+\func{bool}{Pause}{\void}
+
+The file codec tries to pause the stream: it means that it stops audio
+production but keep the file pointer at the place.
+
+If the file codec is already paused, it returns FALSE.
+
+On success, it returns TREE.
+
+\membersection{wxSoundFileStream::Resume}\label{wxsoundfilestreamresume}
+\func{bool}{Resume}{\void}
+
+When the file codec has been paused using
+\helpref{Pause}{wxsoundfilestreampause}, you could be interrested in
+resuming it. This is the goal of this function.
+
+\membersection{wxSoundFileStream::IsStopped}\label{wxsoundfilestreamisstopped}
+\constfunc{bool}{IsStopped}{\void}
+
+It returns TRUE when the stream is stopped, in another case it returns
+FALSE.
+
+\membersection{wxSoundFileStream::IsPaused}\label{wxsoundfilestreamispaused}
+\constfunc{bool}{IsPaused}{\void}
+
+It returns TRUE when the stream is paused, in another case it returns
+FALSE.
+
+\membersection{wxSoundFileStream::StartProduction}\label{wxsoundfilestreamstartproduction}
+\func{bool}{StartProduction}{\param{int }{evt}}
+
+It is really not advised you call this function. From the wxSoundFileStream
+point of view it is an internal function. Internally, it is called after
+the file stream has been prepared to be played or to receive audio data and 
+when it wants to start processing audio data.
+
+\membersection{wxSoundFileStream::StopProduction}\label{wxsoundfilestreamstopproduction}
+\func{bool}{StopProduction}{\void}
+
+As for \helpref{StartProduction}{wxsoundfilestreamstopproduction}, it is not
+advised for you to call this function. It is called by
+\helpref{Stop}{wxsoundfilestreamstop} when it needs to stop the audio data
+processing.
+
+\membersection{wxSoundFileStream::GetLength}\label{wxsoundfilestreamgetlength}
+\func{wxUint32}{GetLength}{\void}
+
+It returns the audio data length of the file stream. This length is expressed
+in bytes. If you need the length in seconds, you will need to use
+\helpref{GetSoundFormat}{wxsoundstreamgetsoundformat} and
+\helpref{GetTimeFromBytes}{wxsoundformatbasegettimefrombytes}.
+
+\membersection{wxSoundFileStream::GetPosition}\label{wxsoundfilestreamgetposition}
+\func{wxUint32}{GetPosition}{\void}
+
+It returns the current position in the soundfile stream. The position
+is expressed in bytes. If you need the length in seconds, you will need to use
+\helpref{GetSoundFormat}{wxsoundstreamgetsoundformat} and
+\helpref{GetTimeFromBytes}{wxsoundformatbasegettimefrombytes}.
+
+\membersection{wxSoundFileStream::SetPosition}\label{wxsoundfilestreamsetposition}
+\func{wxUint32}{SetPosition}{\param{wxUint32 }{new\_position}}
+
+It sets the current in the soundfile stream. The position
+ {\it new\_position} must be expressed in bytes. You can get
+a length/position in bytes from a time value using
+\helpref{GetSoundFormat}{wxsoundstreamgetsoundformat} and 
+\helpref{GetTimeFromBytes}{wxsoundformatbasegettimefrombytes}.
+
+On success, it returns TRUE.
+
+\wxheading{Warning}
+
+Some wxStream may not be capable to support this function as
+it may not support the seekable functionnality. If this happens,
+it returns FALSE and leave the stream at the same position.
+
+\membersection{wxSoundFileStream::Read}\label{wxsoundfilestreamread}
+\func{wxSoundStream\&}{Read}{\param{void* }{buffer}, \param{wxUint32 }{len}}
+
+You can obtain the audio data encoded in the file using this function.
+But it must be considered as an internal function. Used carelessly, it
+may corrupt the current state of the stream.
+Data are returned using in the original file coding (You must use a sound
+format object to decode it).
+
+\membersection{wxSoundFileStream::Write}\label{wxsoundfilestreamwrite}
+\func{wxSoundStream\&}{Write}{\param{const void* }{buffer}, \param{wxUint32 }{len}}
+
+You can put encoded audio data to the file using this function.
+But it must be considered as an internal function. Used carelessly, it
+may corrupt the current state of the stream.
+Data must be coded with the specified file coding (You must use a sound
+format object to do this).
+
+\membersection{wxSoundFileStream::SetSoundFormat}\label{wxsoundfilestreamsetsoundformat}
+\func{bool}{SetSoundFormat}{\param{const wxSoundFormatBase\& }{format}}
+
+\membersection{wxSoundFileStream::GetCodecName}\label{wxsoundfilestreamgetcodecname}
+\constfunc{wxString}{GetCodecName}{\void}
+
+This function returns the Codec name. This is useful for those who
+want to build a player (But also in some other case).
+
+\membersection{wxSoundFileStream::CanRead}\label{wxsoundfilestreamcanread}
+\func{bool}{CanRead}{\void}
+
+You should use this function to test whether this file codec can read
+the stream you passed to it.
+
+
+\membersection{wxSoundFileStream::PrepareToPlay}\label{wxsoundfilestreampreparetoplay}
+\func{bool}{PrepareToPlay}{\void}
+
+
+\membersection{wxSoundFileStream::PrepareToRecord}\label{wxsoundfilestreampreparetorecord}
+\func{bool}{PrepareToRecord}{\param{wxUint32 }{time}}
+
+
+\membersection{wxSoundFileStream::FinishRecording}\label{wxsoundfilestreamfinishrecording}
+\func{bool}{FinishRecording}{\void}
+
+
+\membersection{wxSoundFileStream::RepositionStream}\label{wxsoundfilestreamrepositionstream}
+
+\func{bool}{RepositionStream}{\param{wxUint32 }{position}}
+
+
+\membersection{wxSoundFileStream::FinishPreparation}\label{wxsoundfilestreamfinishpreparation}
+
+\func{void}{FinishPreparation}{\param{wxUint32 }{len}}
+
+
+\membersection{wxSoundFileStream::GetData}\label{wxsoundfilestreamgetdata}
+
+\func{wxUint32}{GetData}{\param{void* }{buffer}, \param{wxUint32 }{len}}
+
+
+\membersection{wxSoundFileStream::PutData}\label{wxsoundfilestreamputdata}
+
+\func{wxUint32}{PutData}{\param{const void* }{buffer}, \param{wxUint32 }{len}}
+
+
+\membersection{wxSoundFileStream::OnSoundEvent}\label{wxsoundfilestreamonsoundevent}
+
+\func{void}{OnSoundEvent}{\param{int }{evt}}
+

contrib/docs/latex/mmedia/sndfpcm.tex

@@ -0,0 +1,104 @@
+%
+% automatically generated by HelpGen from
+% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndpcm.h at 26/Feb/00 14:26:33
+%
+
+
+\section{\class{wxSoundFormatPcm}}\label{wxsoundformatpcm}
+
+
+PCM specification class
+
+\wxheading{Derived from}
+
+\helpref{wxSoundFormatBase}{wxsoundformatbase}
+
+\wxheading{Data structures}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+
+\membersection{wxSoundFormatPcm::wxSoundFormatPcm}\label{wxsoundformatpcmwxsoundformatpcm}
+
+\func{}{wxSoundFormatPcm}{\param{wxUint32 }{srate = 22500}, \param{wxUint8 }{bps = 8}, \param{wxUint16 }{channels = 2}, \param{bool }{sign = TRUE}, \param{int }{order = wxLITTLE\_ENDIAN}}
+
+
+\membersection{wxSoundFormatPcm::\destruct{wxSoundFormatPcm}}\label{wxsoundformatpcmdtor}
+
+\func{}{\destruct{wxSoundFormatPcm}}{\void}
+
+
+\membersection{wxSoundFormatPcm::SetSampleRate}\label{wxsoundformatpcmsetsamplerate}
+
+\func{void}{SetSampleRate}{\param{wxUint32 }{srate}}
+
+
+\membersection{wxSoundFormatPcm::SetBPS}\label{wxsoundformatpcmsetbps}
+
+\func{void}{SetBPS}{\param{wxUint8 }{bps}}
+
+
+\membersection{wxSoundFormatPcm::SetChannels}\label{wxsoundformatpcmsetchannels}
+
+\func{void}{SetChannels}{\param{wxUint16 }{nchannels}}
+
+
+\membersection{wxSoundFormatPcm::SetOrder}\label{wxsoundformatpcmsetorder}
+
+\func{void}{SetOrder}{\param{int }{order}}
+
+
+\membersection{wxSoundFormatPcm::Signed}\label{wxsoundformatpcmsigned}
+
+\func{void}{Signed}{\param{bool }{sign}}
+
+
+\membersection{wxSoundFormatPcm::GetSampleRate}\label{wxsoundformatpcmgetsamplerate}
+
+\constfunc{wxUint32}{GetSampleRate}{\void}
+
+
+\membersection{wxSoundFormatPcm::GetBPS}\label{wxsoundformatpcmgetbps}
+
+\constfunc{wxUint8}{GetBPS}{\void}
+
+
+\membersection{wxSoundFormatPcm::GetChannels}\label{wxsoundformatpcmgetchannels}
+
+\constfunc{wxUint16}{GetChannels}{\void}
+
+
+\membersection{wxSoundFormatPcm::GetOrder}\label{wxsoundformatpcmgetorder}
+
+\constfunc{int}{GetOrder}{\void}
+
+
+\membersection{wxSoundFormatPcm::Signed}\label{wxsoundformatpcmgetsigned}
+
+\constfunc{bool}{Signed}{\void}
+
+
+\membersection{wxSoundFormatPcm::GetType}\label{wxsoundformatpcmgettype}
+
+\constfunc{wxSoundFormatType}{GetType}{\void}
+
+
+\membersection{wxSoundFormatPcm::Clone}\label{wxsoundformatpcmclone}
+
+\constfunc{wxSoundFormatBase*}{Clone}{\void}
+
+
+\membersection{wxSoundFormatPcm::GetTimeFromBytes}\label{wxsoundformatpcmgettimefrombytes}
+
+\constfunc{wxUint32}{GetTimeFromBytes}{\param{wxUint32 }{bytes}}
+
+
+\membersection{wxSoundFormatPcm::GetBytesFromTime}\label{wxsoundformatpcmgetbytesfromtime}
+
+\constfunc{wxUint32}{GetBytesFromTime}{\param{wxUint32 }{time}}
+
+
+\membersection{wxSoundFormatPcm::operator!}\label{wxsoundformatpcmoperatornot}
+
+\constfunc{bool}{operator!}{\param{const wxSoundFormatBase\& }{frmt2}}
+

contrib/docs/latex/mmedia/sndfrmt.tex

@@ -0,0 +1,69 @@
+%
+% automatically generated by HelpGen from
+% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndbase.h at 26/Feb/00 14:23:29
+%
+
+
+\section{\class{wxSoundFormatBase}}\label{wxsoundformatbase}
+
+
+Base class for sound format specification
+
+\wxheading{Derived from}
+
+No base class
+
+\wxheading{Data structures}
+
+{\small \begin{verbatim}
+typedef enum {
+  wxSOUND\_NOFORMAT,
+  wxSOUND\_PCM,
+  wxSOUND\_ULAW,
+  wxSOUND\_G72X,
+  wxSOUND\_MSADPCM
+} wxSoundFormatType
+\end{verbatim}}
+
+wxSoundFormatType: it specifies the format family of the sound data
+which will be passed to the stream.
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxSoundFormatBase::wxSoundFormatBase}\label{wxsoundformatbasewxsoundformatbase}
+
+\func{}{wxSoundFormatBase}{\void}
+
+
+\membersection{wxSoundFormatBase::\destruct{wxSoundFormatBase}}\label{wxsoundformatbasedtor}
+
+\func{}{\destruct{wxSoundFormatBase}}{\void}
+
+
+\membersection{wxSoundFormatBase::GetType}\label{wxsoundformatbasegettype}
+
+\constfunc{wxSoundFormatType}{GetType}{\void}
+
+It returns a "standard" format type.
+
+
+\membersection{wxSoundFormatBase::Clone}\label{wxsoundformatbaseclone}
+
+\constfunc{wxSoundFormatBase*}{Clone}{\void}
+
+It clones the current format.
+
+
+\membersection{wxSoundFormatBase::GetTimeFromBytes}\label{wxsoundformatbasegettimefrombytes}
+
+\constfunc{wxUint32}{GetTimeFromBytes}{\param{wxUint32 }{bytes}}
+
+
+\membersection{wxSoundFormatBase::GetBytesFromTime}\label{wxsoundformatbasegetbytesfromtime}
+
+\constfunc{wxUint32}{GetBytesFromTime}{\param{wxUint32 }{time}}
+
+
+\membersection{wxSoundFormatBase::operator!=}\label{wxsoundformatbaseoperatorneq}
+
+\constfunc{bool}{operator!=}{\param{const wxSoundFormatBase\& }{frmt2}}

contrib/docs/latex/mmedia/sndfulaw.tex

@@ -0,0 +1,74 @@
+%
+% automatically generated by HelpGen from
+% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndulaw.h at 26/Feb/00 14:52:25
+%
+
+
+\section{\class{wxSoundFormatUlaw}}\label{wxsoundformatulaw}
+
+
+ULAW format
+
+\wxheading{Derived from}
+
+\helpref{wxSoundFormatBase}{wxsoundformatbase}
+
+\wxheading{Data structures}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+
+\membersection{wxSoundFormatUlaw::wxSoundFormatUlaw}\label{wxsoundformatulawwxsoundformatulaw}
+
+\func{}{wxSoundFormatUlaw}{\void}
+
+
+\membersection{wxSoundFormatUlaw::\destruct{wxSoundFormatUlaw}}\label{wxsoundformatulawdtor}
+
+\func{}{\destruct{wxSoundFormatUlaw}}{\void}
+
+
+\membersection{wxSoundFormatUlaw::SetSampleRate}\label{wxsoundformatulawsetsamplerate}
+
+\func{void}{SetSampleRate}{\param{wxUint32 }{srate}}
+
+
+\membersection{wxSoundFormatUlaw::GetSampleRate}\label{wxsoundformatulawgetsamplerate}
+
+\constfunc{wxUint32}{GetSampleRate}{\void}
+
+
+\membersection{wxSoundFormatUlaw::SetChannels}\label{wxsoundformatulawsetchannels}
+
+\func{void}{SetChannels}{\param{wxUint8 }{channels}}
+
+
+\membersection{wxSoundFormatUlaw::GetChannels}\label{wxsoundformatulawgetchannels}
+
+\constfunc{wxUint8}{GetChannels}{\void}
+
+
+\membersection{wxSoundFormatUlaw::GetType}\label{wxsoundformatulawgettype}
+
+\constfunc{wxSoundFormatType}{GetType}{\void}
+
+
+\membersection{wxSoundFormatUlaw::Clone}\label{wxsoundformatulawclone}
+
+\constfunc{wxSoundFormatBase*}{Clone}{\void}
+
+
+\membersection{wxSoundFormatUlaw::GetTimeFromBytes}\label{wxsoundformatulawgettimefrombytes}
+
+\constfunc{wxUint32}{GetTimeFromBytes}{\param{wxUint32 }{bytes}}
+
+
+\membersection{wxSoundFormatUlaw::GetBytesFromTime}\label{wxsoundformatulawgetbytesfromtime}
+
+\constfunc{wxUint32}{GetBytesFromTime}{\param{wxUint32 }{time}}
+
+
+\membersection{wxSoundFormatUlaw::operator!=}\label{wxsoundformatulawoperatorneq}
+
+\constfunc{bool}{operator!=}{\param{const wxSoundFormatBase\& }{frmt2}}
+

contrib/docs/latex/mmedia/sndg72x.tex

@@ -0,0 +1,54 @@
+%
+% automatically generated by HelpGen from
+% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndg72x.h at 26/Feb/00 14:52:19
+%
+
+
+\section{\class{wxSoundStreamG72X}}\label{wxsoundstreamg72x}
+
+
+ULAW converter class
+
+\wxheading{Derived from}
+
+\helpref{wxSoundStreamCodec}{wxsoundstreamcodec}
+
+\wxheading{Data structures}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+
+\membersection{wxSoundStreamG72X::wxSoundStreamG72X}\label{wxsoundstreamg72xwxsoundstreamg72x}
+
+\func{}{wxSoundStreamG72X}{\param{wxSoundStream\& }{sndio}}
+
+
+\membersection{wxSoundStreamG72X::\destruct{wxSoundStreamG72X}}\label{wxsoundstreamg72xdtor}
+
+\func{}{\destruct{wxSoundStreamG72X}}{\void}
+
+
+\membersection{wxSoundStreamG72X::Read}\label{wxsoundstreamg72xread}
+
+\func{wxSoundStream\&}{Read}{\param{void* }{buffer}, \param{wxUint32 }{len}}
+
+
+\membersection{wxSoundStreamG72X::Write}\label{wxsoundstreamg72xwrite}
+
+\func{wxSoundStream\&}{Write}{\param{const void* }{buffer}, \param{wxUint32 }{len}}
+
+
+\membersection{wxSoundStreamG72X::SetSoundFormat}\label{wxsoundstreamg72xsetsoundformat}
+
+\func{bool}{SetSoundFormat}{\param{const wxSoundFormatBase\& }{format}}
+
+
+\membersection{wxSoundStreamG72X::PutBits}\label{wxsoundstreamg72xputbits}
+
+\func{void}{PutBits}{\param{wxUint8 }{bits}}
+
+
+\membersection{wxSoundStreamG72X::GetBits}\label{wxsoundstreamg72xgetbits}
+
+\func{wxUint8}{GetBits}{\void}
+

contrib/docs/latex/mmedia/sndoss.tex

@@ -0,0 +1,71 @@
+%
+% automatically generated by HelpGen from
+% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndoss.h at 26/Feb/00 14:26:53
+%
+
+
+\section{\class{wxSoundStreamOSS}}\label{wxsoundstreamoss}
+
+
+OSS output class
+
+\wxheading{Derived from}
+
+\helpref{wxSoundStream}{wxsoundstream}
+
+\wxheading{Data structures}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+
+\membersection{wxSoundStreamOSS::wxSoundStreamOSS}\label{wxsoundstreamosswxsoundstreamoss}
+
+\func{}{wxSoundStreamOSS}{\param{const wxString\& }{dev\_name = \_T("/dev/dsp")}}
+
+
+\membersection{wxSoundStreamOSS::\destruct{wxSoundStreamOSS}}\label{wxsoundstreamossdtor}
+
+\func{}{\destruct{wxSoundStreamOSS}}{\void}
+
+
+\membersection{wxSoundStreamOSS::Read}\label{wxsoundstreamossread}
+
+\func{wxSoundStream\&}{Read}{\param{void* }{buffer}, \param{wxUint32 }{len}}
+
+
+\membersection{wxSoundStreamOSS::Write}\label{wxsoundstreamosswrite}
+
+\func{wxSoundStream\&}{Write}{\param{const void* }{buffer}, \param{wxUint32 }{len}}
+
+
+\membersection{wxSoundStreamOSS::GetBestSize}\label{wxsoundstreamossgetbestsize}
+
+\constfunc{wxUint32}{GetBestSize}{\void}
+
+
+\membersection{wxSoundStreamOSS::SetSoundFormat}\label{wxsoundstreamosssetsoundformat}
+
+\func{bool}{SetSoundFormat}{\param{const wxSoundFormatBase\& }{format}}
+
+
+\membersection{wxSoundStreamOSS::StartProduction}\label{wxsoundstreamossstartproduction}
+
+\func{bool}{StartProduction}{\param{int }{evt}}
+
+
+\membersection{wxSoundStreamOSS::StopProduction}\label{wxsoundstreamossstopproduction}
+
+\func{bool}{StopProduction}{\void}
+
+
+\membersection{wxSoundStreamOSS::QueueFilled}\label{wxsoundstreamossqueuefilled}
+
+\constfunc{bool}{QueueFilled}{\void}
+
+
+\membersection{wxSoundStreamOSS::WakeUpEvt}\label{wxsoundstreamosswakeupevt}
+
+\func{void}{WakeUpEvt}{\param{int }{evt}}
+
+You should not call this.
+

contrib/docs/latex/mmedia/sndpcm.tex

@@ -0,0 +1,48 @@
+%
+% automatically generated by HelpGen from
+% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndcpcm.h at 26/Feb/00 14:26:35
+%
+
+
+\section{\class{wxSoundStreamPcm}}\label{wxsoundstreampcm}
+
+
+PCM converter class
+
+\wxheading{Derived from}
+
+\helpref{wxSoundStreamCodec}{wxsoundstreamcodec}
+
+\wxheading{Data structures}
+
+{\small \begin{verbatim}
+typedef void (*ConverterType)(const char *buf\_in, char *buf\_out, wxUint32 len) ConverterType
+\end{verbatim}}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+
+\membersection{wxSoundStreamPcm::wxSoundStreamPcm}\label{wxsoundstreampcmwxsoundstreampcm}
+
+\func{}{wxSoundStreamPcm}{\param{wxSoundStream\& }{sndio}}
+
+
+\membersection{wxSoundStreamPcm::\destruct{wxSoundStreamPcm}}\label{wxsoundstreampcmdtor}
+
+\func{}{\destruct{wxSoundStreamPcm}}{\void}
+
+
+\membersection{wxSoundStreamPcm::Read}\label{wxsoundstreampcmread}
+
+\func{wxSoundStream\&}{Read}{\param{void* }{buffer}, \param{wxUint32 }{len}}
+
+
+\membersection{wxSoundStreamPcm::Write}\label{wxsoundstreampcmwrite}
+
+\func{wxSoundStream\&}{Write}{\param{const void* }{buffer}, \param{wxUint32 }{len}}
+
+
+\membersection{wxSoundStreamPcm::SetSoundFormat}\label{wxsoundstreampcmsetsoundformat}
+
+\func{bool}{SetSoundFormat}{\param{const wxSoundFormatBase\& }{format}}
+

contrib/docs/latex/mmedia/sndrter.tex

@@ -0,0 +1,59 @@
+%
+% automatically generated by HelpGen from
+% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndfile.h at 26/Feb/00 14:26:42
+%
+
+
+\section{\class{wxSoundRouterStream}}\label{wxsoundrouterstream}
+
+
+Codec router class
+
+\wxheading{Derived from}
+
+\helpref{wxSoundStreamCodec}{wxsoundstreamcodec}
+
+\wxheading{Data structures}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+
+\membersection{wxSoundRouterStream::wxSoundRouterStream}\label{wxsoundrouterstreamwxsoundrouterstream}
+
+\func{}{wxSoundRouterStream}{\param{wxSoundStream\& }{sndio}}
+
+
+\membersection{wxSoundRouterStream::\destruct{wxSoundRouterStream}}\label{wxsoundrouterstreamdtor}
+
+\func{}{\destruct{wxSoundRouterStream}}{\void}
+
+
+\membersection{wxSoundRouterStream::Read}\label{wxsoundrouterstreamread}
+
+\func{wxSoundStream\&}{Read}{\param{void* }{buffer}, \param{wxUint32 }{len}}
+
+
+\membersection{wxSoundRouterStream::Write}\label{wxsoundrouterstreamwrite}
+
+\func{wxSoundStream\&}{Write}{\param{const void* }{buffer}, \param{wxUint32 }{len}}
+
+
+\membersection{wxSoundRouterStream::SetSoundFormat}\label{wxsoundrouterstreamsetsoundformat}
+
+\func{bool}{SetSoundFormat}{\param{const wxSoundFormatBase\& }{format}}
+
+
+\membersection{wxSoundRouterStream::StartProduction}\label{wxsoundrouterstreamstartproduction}
+
+\func{bool}{StartProduction}{\param{int }{evt}}
+
+
+\membersection{wxSoundRouterStream::StopProduction}\label{wxsoundrouterstreamstopproduction}
+
+\func{bool}{StopProduction}{\void}
+
+
+\membersection{wxSoundRouterStream::GetBestSize}\label{wxsoundrouterstreamgetbestsize}
+
+\constfunc{wxUint32}{GetBestSize}{\void}
+

contrib/docs/latex/mmedia/sndulaw.tex

@@ -0,0 +1,49 @@
+%
+% automatically generated by HelpGen from
+% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndulaw.h at 26/Feb/00 14:52:25
+%
+
+
+\section{\class{wxSoundStreamUlaw}}\label{wxsoundstreamulaw}
+
+
+ULAW converter class
+
+\wxheading{Derived from}
+
+\helpref{wxSoundStreamCodec}{wxsoundstreamcodec}
+
+\wxheading{Data structures}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+
+\membersection{wxSoundStreamUlaw::wxSoundStreamUlaw}\label{wxsoundstreamulawwxsoundstreamulaw}
+
+\func{}{wxSoundStreamUlaw}{\param{wxSoundStream\& }{sndio}}
+
+
+\membersection{wxSoundStreamUlaw::\destruct{wxSoundStreamUlaw}}\label{wxsoundstreamulawdtor}
+
+\func{}{\destruct{wxSoundStreamUlaw}}{\void}
+
+
+\membersection{wxSoundStreamUlaw::Read}\label{wxsoundstreamulawread}
+
+\func{wxSoundStream\&}{Read}{\param{void* }{buffer}, \param{wxUint32 }{len}}
+
+
+\membersection{wxSoundStreamUlaw::Write}\label{wxsoundstreamulawwrite}
+
+\func{wxSoundStream\&}{Write}{\param{const void* }{buffer}, \param{wxUint32 }{len}}
+
+
+\membersection{wxSoundStreamUlaw::SetSoundFormat}\label{wxsoundstreamulawsetsoundformat}
+
+\func{bool}{SetSoundFormat}{\param{const wxSoundFormatBase\& }{format}}
+
+
+\membersection{wxSoundStreamUlaw::GetBestSize}\label{wxsoundstreamulawgetbestsize}
+
+\constfunc{wxUint32}{GetBestSize}{\void}
+

contrib/docs/latex/mmedia/sndwave.tex

@@ -0,0 +1,91 @@
+%
+% automatically generated by HelpGen from
+% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndwav.h at 26/Feb/00 14:26:40
+%
+
+
+\section{\class{wxSoundWave}}\label{wxsoundwave}
+
+
+WAVE codec
+
+\wxheading{Derived from}
+
+\helpref{wxSoundFileStream}{wxsoundfilestream}
+
+\wxheading{Data structures}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+
+\membersection{wxSoundWave::wxSoundWave}\label{wxsoundwavewxsoundwave}
+
+\func{}{wxSoundWave}{\param{wxInputStream\& }{stream}, \param{wxSoundStream\& }{io\_sound}}
+
+\func{}{wxSoundWave}{\param{wxOutputStream\& }{stream}, \param{wxSoundStream\& }{io\_sound}}
+
+
+\membersection{wxSoundWave::\destruct{wxSoundWave}}\label{wxsoundwavedtor}
+
+\func{}{\destruct{wxSoundWave}}{\void}
+
+
+\membersection{wxSoundWave::CanRead}\label{wxsoundwavecanread}
+
+\func{bool}{CanRead}{\void}
+
+
+\membersection{wxSoundWave::GetCodecName}\label{wxsoundwavegetcodecname}
+
+\constfunc{wxString}{GetCodecName}{\void}
+
+
+\membersection{wxSoundWave::PrepareToPlay}\label{wxsoundwavepreparetoplay}
+
+\func{bool}{PrepareToPlay}{\void}
+
+
+\membersection{wxSoundWave::PrepareToRecord}\label{wxsoundwavepreparetorecord}
+
+\func{bool}{PrepareToRecord}{\param{wxUint32 }{time}}
+
+
+\membersection{wxSoundWave::FinishRecording}\label{wxsoundwavefinishrecording}
+
+\func{bool}{FinishRecording}{\void}
+
+
+\membersection{wxSoundWave::RepositionStream}\label{wxsoundwaverepositionstream}
+
+\func{bool}{RepositionStream}{\param{wxUint32 }{position}}
+
+
+\membersection{wxSoundWave::GetData}\label{wxsoundwavegetdata}
+
+\func{wxUint32}{GetData}{\param{void* }{buffer}, \param{wxUint32 }{len}}
+
+
+\membersection{wxSoundWave::PutData}\label{wxsoundwaveputdata}
+
+\func{wxUint32}{PutData}{\param{const void* }{buffer}, \param{wxUint32 }{len}}
+
+
+\membersection{wxSoundWave::HandleOutputPCM}\label{wxsoundwavehandleoutputpcm}
+
+\func{bool}{HandleOutputPCM}{\param{wxDataInputStream\& }{data}, \param{wxUint16 }{channels}, \param{wxUint32 }{sample\_fq}, \param{wxUint32 }{byte\_p\_sec}, \param{wxUint16 }{byte\_p\_spl}, \param{wxUint16 }{bits\_p\_spl}}
+
+
+\membersection{wxSoundWave::HandleOutputG721}\label{wxsoundwavehandleoutputg721}
+
+\func{bool}{HandleOutputG721}{\param{wxDataInputStream\& }{data}, \param{wxUint16 }{channels}, \param{wxUint32 }{sample\_fq}, \param{wxUint32 }{byte\_p\_sec}, \param{wxUint16 }{byte\_p\_spl}, \param{wxUint16 }{bits\_p\_spl}}
+
+
+\membersection{wxSoundWave::HandleInputPCM}\label{wxsoundwavehandleinputpcm}
+
+\func{wxSoundFormatBase*}{HandleInputPCM}{\param{wxDataOutputStream\& }{data}}
+
+
+\membersection{wxSoundWave::HandleInputG72X}\label{wxsoundwavehandleinputg72x}
+
+\func{wxSoundFormatBase*}{HandleInputG72X}{\param{wxDataOutputStream\& }{data}}
+

contrib/docs/latex/mmedia/sndwin.tex

@@ -0,0 +1,140 @@
+%
+% automatically generated by HelpGen from
+% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndwin.h at 26/Feb/00 14:26:51
+%
+
+
+\section{\class{wxSoundStreamWin}}\label{wxsoundstreamwin}
+
+\wxheading{Derived from}
+
+\helpref{wxSoundStream}{wxsoundstream}
+
+\wxheading{Data structures}
+
+{\small \begin{verbatim}
+typedef struct \_wxSoundInternal wxSoundInternal
+\end{verbatim}}
+
+{\small \begin{verbatim}
+typedef struct \_wxSoundInfoHeader wxSoundInfoHeader
+\end{verbatim}}
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+
+\membersection{wxSoundStreamWin::wxSoundStreamWin}\label{wxsoundstreamwinwxsoundstreamwin}
+
+\func{}{wxSoundStreamWin}{\void}
+
+
+\membersection{wxSoundStreamWin::\destruct{wxSoundStreamWin}}\label{wxsoundstreamwindtor}
+
+\func{}{\destruct{wxSoundStreamWin}}{\void}
+
+
+\membersection{wxSoundStreamWin::Write}\label{wxsoundstreamwinwrite}
+
+\func{wxSoundStream\&}{Write}{\param{const void* }{buffer}, \param{wxUint32 }{len}}
+
+
+\membersection{wxSoundStreamWin::Read}\label{wxsoundstreamwinread}
+
+\func{wxSoundStream\&}{Read}{\param{void* }{buffer}, \param{wxUint32 }{len}}
+
+
+\membersection{wxSoundStreamWin::SetSoundFormat}\label{wxsoundstreamwinsetsoundformat}
+
+\func{bool}{SetSoundFormat}{\param{wxSoundFormatBase\& }{base}}
+
+
+\membersection{wxSoundStreamWin::StartProduction}\label{wxsoundstreamwinstartproduction}
+
+\func{bool}{StartProduction}{\param{int }{evt}}
+
+
+\membersection{wxSoundStreamWin::StopProduction}\label{wxsoundstreamwinstopproduction}
+
+\func{bool}{StopProduction}{\void}
+
+
+\membersection{wxSoundStreamWin::QueueFilled}\label{wxsoundstreamwinqueuefilled}
+
+\constfunc{bool}{QueueFilled}{\void}
+
+
+\membersection{wxSoundStreamWin::NotifyDoneBuffer}\label{wxsoundstreamwinnotifydonebuffer}
+
+\func{void}{NotifyDoneBuffer}{\param{wxUint32 }{dev\_handle}, \param{int }{flag}}
+
+Internal but defined as public
+
+
+\membersection{wxSoundStreamWin::GetBestSize}\label{wxsoundstreamwingetbestsize}
+
+\constfunc{wxUint32}{GetBestSize}{\void}
+
+
+\membersection{wxSoundStreamWin::CreateSndWindow}\label{wxsoundstreamwincreatesndwindow}
+
+\func{void}{CreateSndWindow}{\void}
+
+
+\membersection{wxSoundStreamWin::DestroySndWindow}\label{wxsoundstreamwindestroysndwindow}
+
+\func{void}{DestroySndWindow}{\void}
+
+
+\membersection{wxSoundStreamWin::OpenDevice}\label{wxsoundstreamwinopendevice}
+
+\func{bool}{OpenDevice}{\param{int }{mode}}
+
+
+\membersection{wxSoundStreamWin::CloseDevice}\label{wxsoundstreamwinclosedevice}
+
+\func{void}{CloseDevice}{\void}
+
+
+\membersection{wxSoundStreamWin::AllocHeader}\label{wxsoundstreamwinallocheader}
+
+\func{wxSoundInfoHeader*}{AllocHeader}{\param{int }{mode}}
+
+
+\membersection{wxSoundStreamWin::FreeHeader}\label{wxsoundstreamwinfreeheader}
+
+\func{void}{FreeHeader}{\param{wxSoundInfoHeader* }{header}, \param{int }{mode}}
+
+
+\membersection{wxSoundStreamWin::AllocHeaders}\label{wxsoundstreamwinallocheaders}
+
+\func{bool}{AllocHeaders}{\param{int }{mode}}
+
+
+\membersection{wxSoundStreamWin::FreeHeaders}\label{wxsoundstreamwinfreeheaders}
+
+\func{void}{FreeHeaders}{\param{int }{mode}}
+
+
+\membersection{wxSoundStreamWin::WaitFor}\label{wxsoundstreamwinwaitfor}
+
+\func{void}{WaitFor}{\param{wxSoundInfoHeader* }{info}}
+
+
+\membersection{wxSoundStreamWin::AddToQueue}\label{wxsoundstreamwinaddtoqueue}
+
+\func{bool}{AddToQueue}{\param{wxSoundInfoHeader* }{info}}
+
+
+\membersection{wxSoundStreamWin::ClearHeader}\label{wxsoundstreamwinclearheader}
+
+\func{void}{ClearHeader}{\param{wxSoundInfoHeader* }{info}}
+
+
+\membersection{wxSoundStreamWin::NextFragmentOutput}\label{wxsoundstreamwinnextfragmentoutput}
+
+\func{wxSoundInfoHeader*}{NextFragmentOutput}{\void}
+
+
+\membersection{wxSoundStreamWin::NextFragmentInput}\label{wxsoundstreamwinnextfragmentinput}
+
+\func{wxSoundInfoHeader*}{NextFragmentInput}{\void}
+

contrib/docs/latex/mmedia/tex2rtf.ini

@@ -0,0 +1,35 @@
+;    Last change:  JS    8 Sep 98    2:54 pm
+runTwice = yes
+titleFontSize = 12
+authorFontSize = 10
+chapterFontSize = 12
+sectionFontSize = 12
+subsectionFontSize = 12
+headerRule = yes
+footerRule = yes
+useHeadingStyles = yes
+listItemIndent=40
+generateHPJ = no
+htmlBrowseButtons = bitmap
+winHelpVersion = 3
+winHelpContents = yes
+winHelpTitle = "OGL Manual"
+truncateFilenames = yes
+combineSubSections = yes
+\overview [2] {\rtfonly{See also }\settransparency{on}\sethotspotcolour{off}\sethotspotunderline{on}\winhelponly{\image{}{books.bmp}\settransparency{off}}
+\htmlonly{\image{}{books.gif}}\helpref{#1}{#2}
+\sethotspotcolour{on}\sethotspotunderline{on}}
+\docparam [2]{\parskip{0}{\it #1}\htmlignore{\par}\parskip{10}\indented{1cm}{#2}}
+\wxheading [1]{{\bf \htmlignore{\fcol{blue}{#1}}\htmlonly{\fcol{red}{#1}}}}
+\const [0] {{\bf const}}
+\constfunc [3] {{\bf #1} {\bf #2}(#3) {\bf const}\index{#2}}
+\windowstyle [1] {{\bf #1}\index{#1}}
+
+;;
+;; These two are for generating MS HTML Help project, contents and index files.
+;;
+htmlWorkshopFiles = true
+htmlIndex = true
+\pythonnote [1] {{\bf \fcol{blue}{wxPython note:}} #1}
+%\pythonnote [1] {}
+

contrib/docs/latex/mmedia/texhelp.sty

@@ -0,0 +1,298 @@
+% LaTeX style file
+% Name:   texhelp.sty
+% Author: Julian Smart
+%
+% Purpose
+% -------
+% Style file to enable the simultaneous preparation of printed LaTeX and on-line
+% hypertext manuals.
+% Use in conjunction with Tex2RTF (see Tex2RTF documentation).
+%
+% Note that if a non-ASCII character starts a newline and there should be a space
+% between the last word on the previous line and the first word on this line,
+% you need to use \rtfsp to generate a space in Windows Help. \rtfsp is ignored
+% in all other formats.
+%
+% Julian Smart
+% Artificial Intelligence Applications Institute
+%
+%
+% ============== C++/CLIPS Documentation Facilities ==============
+%
+% Each class definition should be typeset with e.g.
+%
+% \section{\class{Name}: Parent}
+%
+% followed by a description of the class.
+% Each member should follow:
+%
+% \membersection{wxName::Member}
+%
+% with a description of what this member does.
+% Then, one (or more if overloaded) member (function) in detail:
+%
+% \func{return type}{name}{args}
+% or
+% \member{type}{name}
+%
+% where args is a list of \param{type}{name}, ...
+
+% Function, e.g.
+% e.g. to typeset
+%
+% void DoIt(char *string);
+%
+% write:
+%
+% \func{void}{DoIt}{\param{char *}{string}}
+%
+
+\newcommand{\func}[3]{\hangafter=1\noindent\hangindent=10mm
+{{\it #1} {\bf #2}\index{#2}}(#3)}
+
+% For function/type definition where the name is a pointer,
+% e.g. to typeset
+%
+% typedef void (*wxFunction)(wxObject&)
+%
+% write:
+%
+% \pfunc{typedef void}{wxFunction}{param{wxObject&}}
+
+\newcommand{\pfunc}[3]{\hangafter=1\noindent\hangindent=10mm
+{{\it #1} ({\bf *#2})\index{#2}}(#3)}
+
+% Use an ordinary \section command for class name definitions.
+
+% This is used for a member, such as wxBitmap: GetDepth
+\newcommand{\membersection}[1]{\subsection*{#1}\index{#1}}
+
+% CLIPS function
+\newcommand{\clipsfunc}[3]{\hangafter=1\noindent\hangindent=10mm
+{{\bf #1} ({\bf #2}\index{#2}}#3)}
+
+\newcommand{\clipssection}[1]{\chapter{#1}}
+
+% This is used for a CLIPS function name
+\newcommand{\functionsection}[1]{\subsection*{#1}}
+
+% Member: a type and a name
+\newcommand{\member}[2]{{\bf #1 \it #2}}
+
+% C++ Parameter: a type and a name (no intervening space)
+\newcommand{\param}[2]{{\it #1}{\bf #2}}
+
+% CLIPS Parameter: a type and a name (one intervening space)
+\newcommand{\cparam}[2]{{\bf #1} {\it #2}}
+
+% Class: puts in index
+\newcommand{\class}[1]{#1\index{#1}}
+
+%\newcommand{\docparam}[2]{\parskip=0pt {\it #1}\par\parskip=10pt\begin{indented}{1cm}{#2}\end{indented}}
+
+% Void type
+\newcommand{\void}{{\it void}}
+
+% Typeset destructor
+\newcommand{\destruct}[1]{{$\sim$}#1}
+
+% Typeset insert/extract operators
+\newcommand{\cinsert}{$<<$}
+\newcommand{\cextract}{$>>$}
+
+
+% =================== Hypertext facilities ===================
+%
+% To insert hyperlinks (or references, in Latex), \label the sections
+% or membersections \label{ref-label} immediately after the section, on the same line,
+% and use \helpref{text-to-show}{ref-label} to make a reference.
+%
+
+% Type text with section reference
+\newcommand{\helpref}[2]{{\it #1} (p.\ \pageref{#2}) }
+
+% Type text with URL in verbatim mode
+\newcommand{\urlref}[2]{#1 (\verb$#2$)}
+
+% Don't typeset section number in LaTeX
+\newcommand{\helprefn}[2]{{\it #1}}
+
+% Like helpref, but popup text in WinHelp instead of hyperlinked
+\newcommand{\popref}[2]{{\it #1}}
+
+% Like footnote, but popup text.
+\newcommand{\footnotepopup}[2]{{\it #1}\footnote{#2}}
+
+% =================== On-line help specific macros ===================
+%
+
+% Global document font size/family, help only.
+\newcommand{\helpfontsize}[1]{}
+\newcommand{\helpfontfamily}[1]{}
+
+% Ignore in all on-line help
+\newcommand{\helpignore}[1]{#1}
+% Only print in all on-line help
+\newcommand{\helponly}[1]{}
+
+% Ignore in LaTeX
+\newcommand{\latexignore}[1]{}
+% Only print in LaTeX
+\newcommand{\latexonly}[1]{#1}
+
+% Ignore in linear RTF
+\newcommand{\rtfignore}[1]{#1}
+% Only print in linear RTF
+\newcommand{\rtfonly}[1]{}
+
+% Ignore in WinHelp RTF
+\newcommand{\winhelpignore}[1]{#1}
+% Only print in WinHelp RTF
+\newcommand{\winhelponly}[1]{}
+
+% Ignore in wxHelp
+\newcommand{\xlpignore}[1]{#1}
+% Only print in wxHelp
+\newcommand{\xlponly}[1]{}
+
+% Ignore in HTML
+\newcommand{\htmlignore}[1]{#1}
+% Only print in HTML
+\newcommand{\htmlonly}[1]{}
+
+% Input a file only for help system (binder thickness is not a limitation
+% in help systems!)
+\newcommand{\helpinput}[1]{}
+
+\newcommand{\rtfsp}{ } % Force a space in RTF, ignore in Latex
+
+% =================== Miscellaneous macros ===================
+%
+% Headings consistent with generated ones
+\newcommand{\myheading}[1]{\vspace*{25pt}
+\begin{flushleft}
+{\LARGE \bf #1}
+\end{flushleft}
+\vskip 20pt
+}
+
+% Heading with entry in contents page.
+\newcommand{\chapterheading}[1]{\myheading{#1}
+\addcontentsline{toc}{chapter}{#1}}
+
+\newcommand{\sectionheading}[1]{\myheading{#1}
+\addcontentsline{toc}{section}{#1}}
+
+% Glossary environment
+\newenvironment{helpglossary}{\newpage\chapterheading{Glossary}\begin{description}}{\end{description}}
+
+% Glossary entry
+\newcommand{\gloss}[1]{\item[#1]\index{#1}}
+
+% Image: EPS in Latex, BMP or MF (whatever's available) in RTF. Requires psbox.
+\newcommand{\image}[2]{\psboxto(#1){#2}}
+
+% Image, left aligned (HTML)
+\newcommand{\imager}[2]{\psboxto(#1){#2}}
+
+% Image, right aligned (HTML)
+\newcommand{\imagel}[2]{\psboxto(#1){#2}}
+
+% Imagemap: principally for HTML only. In Latex,
+% acts like \image.
+\newcommand{\imagemap}[3]{\psboxto(#1){#2}}
+
+% Headers and footers
+% \setheader{EvenPageLeft}{EvenPageCentre}{EvenPageRight}
+% {OddPageLeft}{OddPageCentre}{OddPageRight}
+\newcommand{\setheader}[6]{
+\lhead[\fancyplain{}{#1}]{\fancyplain{}{#4}}
+\chead[\fancyplain{}{#2}]{\fancyplain{}{#5}}
+\rhead[\fancyplain{}{#3}]{\fancyplain{}{#6}}
+}
+
+% \setfooter{EvenPageLeft}{EvenPageCentre}{EvenPageRight}
+% {OddPageLeft}{OddPageCentre}{OddPageRight}
+\newcommand{\setfooter}[6]{
+\lfoot[\fancyplain{#1}{#1}]{\fancyplain{#4}{#4}}
+\cfoot[\fancyplain{#2}{#2}]{\fancyplain{#5}{#5}}
+\rfoot[\fancyplain{#3}{#3}]{\fancyplain{#6}{#6}}
+}
+
+% Needed for telling RTF where margin paragraph should go
+% in mirrored margins mode.
+\newcommand{\marginpareven}[1]{\hspace*{0pt}\marginpar{#1}}
+\newcommand{\marginparodd}[1]{\hspace*{0pt}\marginpar{#1}}
+
+% Environment for two-column table popular in WinHelp and manuals.
+\newcommand{\twocolwidtha}[1]{\def\twocolwidthaval{#1}}
+\newcommand{\twocolwidthb}[1]{\def\twocolwidthbval{#1}}
+\newcommand{\twocolspacing}[1]{\def\twocolspacingval{#1}}
+
+\twocolwidtha{3cm}
+\twocolwidthb{8.5cm}
+\twocolspacing{2}
+
+\newcommand{\twocolitem}[2]{#1 & #2\\}
+\newcommand{\twocolitemruled}[2]{#1 & #2\\\hline}
+
+\newenvironment{twocollist}{\renewcommand{\arraystretch}{\twocolspacingval}\begin{tabular}{lp{\twocolwidthbval}}}%
+{\end{tabular}\renewcommand{\arraystretch}{1}}
+
+% Specifying table rows for RTF compatibility
+\newcommand{\row}[1]{#1\\}
+
+% Use for the last ruled row for correct RTF generation.
+\newcommand{\ruledrow}[1]{#1\\\hline}
+
+% Indentation environment. Arg1 is left margin size
+\newenvironment{indented}[1]{\begin{list}{}{\leftmargin=#1}\item[]}%
+{\end{list}}
+
+% Framed box of text, normal formatting.
+\newcommand{\normalbox}[1]{\fbox{\vbox{#1}}}
+% Double-framed box of text.
+\newcommand{\normalboxd}[1]{\fbox{\fbox{\vbox{#1}}}}
+
+% WITHDRAWN -- can't do in RTF, easily.
+% Framed box of text, horizontally centred. Ragged right within box.
+% \newcommand{\centeredbox}[2]{\begin{center}\fbox{\parbox{#1}{\raggedright#2}}\end{center}}
+% Double-framed box of text, horizontally centred. Ragged right within box.
+% \newcommand{\centeredboxd}[2]{\begin{center}\fbox{\fbox{\parbox{#1}{\raggedright#2}}}\end{center}}
+
+% toocomplex environment: simply prints the argument in LaTeX,
+% comes out verbatim in all generated formats.
+\newenvironment{toocomplex}{}{}
+
+% Colour: dummy commands since LaTeX doesn't support colour.
+% \definecolour{name}{red}{blue}{green}
+% \fcol{name}{text} ; Foreground
+% \bcol{name}{text} ; Background
+\newcommand{\definecolour}[4]{}
+\newcommand{\definecolor}[4]{}
+\newcommand{\fcol}[2]{#2}
+\newcommand{\bcol}[2]{#2}
+\newcommand{\sethotspotcolour}[1]{}
+\newcommand{\sethotspotunderline}[1]{}
+\newcommand{\settransparency}[1]{}
+\newcommand{\backslashraw}[0]{}
+\newcommand{\lbraceraw}[0]{}
+\newcommand{\rbraceraw}[0]{}
+\newcommand{\registered}[0]{(r)}
+\newcommand{\background}[1]{}
+\newcommand{\textcolour}[1]{}
+\newcommand{\overview}[2]{See \helpref{#1}{#2}.}
+\newcommand{\docparam}[2]{{\it #1}\begin{list}{}{\leftmargin=1cm}\item[]
+#2%
+\end{list}}
+\newcommand{\wxheading}[1]{{\bf #1}}
+\newcommand{\const}[0]{{\bf const}}
+\newcommand{\constfunc}[3]{{\bf #1} {\bf #2}(#3) {\bf const}\index{#2}}
+\newcommand{\windowstyle}[1]{{\bf #1}\index{#1}}
+
+\addtolength{\textwidth}{1in}
+\addtolength{\oddsidemargin}{-0.5in}
+\addtolength{\topmargin}{-0.5in}
+\addtolength{\textheight}{1in}
+\sloppy
+

contrib/docs/latex/mmedia/topics.tex

@@ -0,0 +1,161 @@
+\chapter{Topic overviews}
+\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
+\setfooter{\thepage}{}{}{}{}{\thepage}
+
+The following sections describe particular topics.
+
+\section{OGL overview}\label{ogloverview}
+
+\helpref{wxShapeCanvas}{wxshapecanvas}, derived from {\bf wxCanvas}, is the drawing area
+for a number of \helpref{wxShape}{wxshape} instances. Everything drawn on a
+wxShapeCanvas is derived from wxShape, which provides virtual
+member functions for redrawing, creating and destroying
+resize/selection `handles', movement and erasing behaviour, mouse
+click behaviour, calculating the bounding box of the shape, linking
+nodes with arcs, and so on.
+
+The way a client application copes with `damage' to the canvas is to
+erase (white out) anything should no longer be displayed, redraw the shape,
+and then redraw everything on the canvas to repair any damage. If quick edit
+mode is on for the canvas, the complete should be omitted by OGL and the
+application.
+
+Selection handles (called control points in the code) are implemented as
+wxRectangleShapes.
+
+Events are passed to shapes by the canvas in a high-level form, for example {\bf OnLeftClick},
+{\bf OnBeginDragLeft}, {\bf OnDragLeft}, {\bf OnEndDragLeft}. The canvas decides
+what is a click and what is a drag, whether it is on a shape or the canvas itself,
+and (by interrogating the shape) which attachment point the click is associated with.
+
+In order to provide event-handling flexibility, each shapes has an `event handler' associated with it,
+which by default is the shape itself (all shapes derive from wxShapeEvtHandler).
+An application can modify the event-handling behaviour simply by plugging a new
+event handler into the shape. This can avoid the need for multiple inheritance when
+new properties and behaviour are required for a number of different shape classes: instead
+of overriding each class, one new event handler class can be defined and used for all
+existing shape classes.
+
+A range of shapes have been predefined in the library, including rectangles, ellipses,
+polygons. A client application can derive from these shapes and/or derive entirely
+new shapes from wxShape.
+
+Instances of a class called \helpref{wxDiagram}{wxdiagram} organise collections of
+shapes, providing default file input and output behaviour.
+
+\section{wxDividedShape overview}\label{dividedshapeoverview}
+
+Classes: \helpref{wxDividedShape}{wxdividedshape}
+
+A wxDividedShape is a rectangle with a number of vertical divisions. Each
+division may have its text formatted with independent characteristics, and
+the size of each division relative to the whole image may be specified.
+
+Once a wxDividedShape has been created, the user may move the divisions with the
+mouse. By pressing Ctrl while right-clicking, the region attributes can be edited.
+
+Here are examples of creating wxDividedShape objects:
+
+{\small
+\begin{verbatim}
+  /*
+   * Divided rectangle with 3 regions
+   *
+   */
+
+  wxDividedShape *dividedRect = new wxDividedShape(50, 60);
+
+  wxShapeRegion *region = new wxShapeRegion;
+  region->SetProportions(0.0, 0.25);
+  dividedRect->AddRegion(region);
+
+  region = new wxShapeRegion;
+  region->SetProportions(0.0, 0.5);
+  dividedRect->AddRegion(region);
+
+  region = new wxShapeRegion;
+  region->SetProportions(0.0, 0.25);
+  dividedRect->AddRegion(region);
+  
+  dividedRect->SetSize(50, 60); // Allow it to calculate region sizes
+  dividedRect->SetPen(wxBLACK_PEN);
+  dividedRect->SetBrush(wxWHITE_BRUSH);
+  dividedRect->Show(TRUE);
+  dividedRect->NameRegions();
+
+  /*
+   * Divided rectangle with 3 regions, rounded
+   *
+   */
+
+  wxDividedShape *dividedRect3 = new wxDividedShape(50, 60);
+  dividedRect3->SetCornerRadius(-0.4);
+
+  region = new wxShapeRegion;
+  region->SetProportions(0.0, 0.25);
+  dividedRect3->AddRegion(region);
+
+  region = new wxShapeRegion;
+  region->SetProportions(0.0, 0.5);
+  dividedRect3->AddRegion(region);
+
+  region = new wxShapeRegion;
+  region->SetProportions(0.0, 0.25);
+  dividedRect3->AddRegion(region);
+  
+  dividedRect3->SetSize(50, 60); // Allow it to calculate region sizes
+  dividedRect3->SetPen(wxBLACK_PEN);
+  dividedRect3->SetBrush(wxWHITE_BRUSH);
+  dividedRect3->Show(TRUE);
+  dividedRect3->NameRegions();
+\end{verbatim}
+}
+
+\section{wxCompositeShape overview}\label{compositeshapeoverview}
+
+Classes: \helpref{wxCompositeShape}{wxcompositeshape}, \helpref{wxOGLConstraint}{wxoglconstraint}
+
+The wxCompositeShape allows fairly complex shapes to be created, and maintains
+a set of constraints which specify the layout and proportions of child shapes.
+
+Add child shapes to a wxCompositeShape using \helpref{AddChild}{wxcompositeshapeaddchild}, and
+add constraints using \helpref{AddConstraint}{wxcompositeshapeaddconstraint}.
+
+After children and shapes have been added, call \helpref{Recompute}{wxcompositeshaperecompute} which
+will return TRUE is the constraints could be satisfied, FALSE otherwise. If
+constraints have been correctly and consistently specified, this call will succeed.
+
+If there is more than one child, constraints must be specified: OGL cannot calculate
+the size and position of children otherwise. Don't assume that children will simply
+move relative to the parent without the use of constraints.
+
+To specify a constraint, you need three things:
+
+\begin{enumerate}\itemsep=0pt
+\item a constraint type, such as gyCONSTRAINT\_CENTRED\_VERTICALLY;
+\item a reference shape, with respect to which other shapes are going to be positioned - the\rtfsp
+{\it constraining} shape;
+\item a list of one or more shapes to be constrained: the {\it constrained} shapes.
+\end{enumerate}
+
+The constraining shape can be either the parent of the constrained shapes, or a sibling. The
+constrained shapes must all be siblings of each other.
+
+For an exhaustive list and description of the available constraint types, see the \helpref{wxOGLConstraint constructor}{wxoglconstraintconstr}.
+Note that most constraints operate in one dimension only (vertically or horizontally), so you will
+usually need to specify constraints in pairs.
+
+You can set the spacing between constraining and constrained shapes by
+calling \helpref{wxOGLConstraint::SetSpacing}{wxoglconstraintsetspacing}.
+
+Finally, a wxCompositeShape can have {\it divisions}, which are special child shapes of class
+wxDivisionShape (not to be confused with wxDividedShape). The purpose of this is to allow
+the composite to be divided into user-adjustable regions (divisions) into which other shapes
+can be dropped dynamically, given suitable application code. Divisons allow the child
+shapes to have an identity of their own - they can be manipulated independently of their container -
+but to behave as if they are contained with the division, moving with the parent shape.
+Divisions boundaries can themselves be moved using the mouse.
+
+To create an initial division, call \helpref{wxCompositeShape::MakeContainer}{wxcompositeshapemakecontainer}.
+Make further divisions by calling \helpref{wxDivisionShape::Divide}{wxdivisionshapedivide}.
+

contrib/docs/latex/mmedia/vidbase.tex

@@ -0,0 +1,173 @@
+%
+% automatically generated by HelpGen from
+% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/vidbase.h at 26/Feb/00 14:51:56
+%
+
+\section{\class{wxVideoBaseDriver}}\label{wxvideobasedriver}
+
+Classes definition
+
+\wxheading{Derived from}
+
+\helpref{wxObject}{wxobject}
+
+\wxheading{Data structures}
+
+{\small \begin{verbatim}
+typedef enum {
+  wxVIDEO\_MSAVI,
+  wxVIDEO\_MPEG,
+  wxVIDEO\_QT,
+  wxVIDEO\_GIF,
+  wxVIDEO\_JMOV,
+  wxVIDEO\_FLI,
+  wxVIDEO\_IFF,
+  wxVIDEO\_SGI,
+  wxVIDEO\_MPEG2
+} wxVideoType
+\end{verbatim}}
+
+wxMMedia2 (video) types
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+
+\membersection{wxVideoBaseDriver::wxVideoBaseDriver}\label{wxvideobasedriverwxvideobasedriver}
+
+\func{}{wxVideoBaseDriver}{\void}
+
+Ctors
+
+
+\membersection{wxVideoBaseDriver::wxVideoBaseDriver}\label{wxvideobasedriverwxvideobasedriver}
+
+\func{}{wxVideoBaseDriver}{\param{wxInputStream\& }{str}}
+
+
+\membersection{wxVideoBaseDriver::wxVideoBaseDriver}\label{wxvideobasedriverwxvideobasedriver}
+
+\func{}{wxVideoBaseDriver}{\param{const wxString\& }{filename}}
+
+
+\membersection{wxVideoBaseDriver::\destruct{wxVideoBaseDriver}}\label{wxvideobasedriverdtor}
+
+\func{}{\destruct{wxVideoBaseDriver}}{\void}
+
+Dtor
+
+
+\membersection{wxVideoBaseDriver::Play}\label{wxvideobasedriverplay}
+
+\func{bool}{Play}{\void}
+
+Usual functions ... They all return FALSE in case of errors.
+
+
+\membersection{wxVideoBaseDriver::Stop}\label{wxvideobasedriverstop}
+
+\func{bool}{Stop}{\void}
+
+
+\membersection{wxVideoBaseDriver::Pause}\label{wxvideobasedriverpause}
+
+\func{bool}{Pause}{\void}
+
+
+\membersection{wxVideoBaseDriver::Resume}\label{wxvideobasedriverresume}
+
+\func{bool}{Resume}{\void}
+
+
+\membersection{wxVideoBaseDriver::SetSize}\label{wxvideobasedriversetsize}
+
+\func{bool}{SetSize}{\param{wxSize }{size}}
+
+Size management
+
+
+\membersection{wxVideoBaseDriver::GetSize}\label{wxvideobasedrivergetsize}
+
+\constfunc{bool}{GetSize}{\param{wxSize\& }{size}}
+
+
+\membersection{wxVideoBaseDriver::IsCapable}\label{wxvideobasedriveriscapable}
+
+\constfunc{bool}{IsCapable}{\param{wxVideoType }{WXUNUSED(v\_type)}}
+
+Test the capability of the driver to handle the specified type
+
+
+\membersection{wxVideoBaseDriver::GetMovieCodec}\label{wxvideobasedrivergetmoviecodec}
+
+\constfunc{wxString}{GetMovieCodec}{\void}
+
+Return the video codec name
+
+
+\membersection{wxVideoBaseDriver::GetAudioCodec}\label{wxvideobasedrivergetaudiocodec}
+
+\constfunc{wxString}{GetAudioCodec}{\void}
+
+Return the audio codec name
+
+
+\membersection{wxVideoBaseDriver::GetSampleRate}\label{wxvideobasedrivergetsamplerate}
+
+\constfunc{wxUint32}{GetSampleRate}{\void}
+
+Return misc info about audio
+
+
+\membersection{wxVideoBaseDriver::GetChannels}\label{wxvideobasedrivergetchannels}
+
+\constfunc{wxUint8}{GetChannels}{\void}
+
+
+\membersection{wxVideoBaseDriver::GetBPS}\label{wxvideobasedrivergetbps}
+
+\constfunc{wxUint8}{GetBPS}{\void}
+
+
+\membersection{wxVideoBaseDriver::GetFrameRate}\label{wxvideobasedrivergetframerate}
+
+\constfunc{double}{GetFrameRate}{\void}
+
+Return frame rate
+
+
+\membersection{wxVideoBaseDriver::GetNbFrames}\label{wxvideobasedrivergetnbframes}
+
+\constfunc{wxUint32}{GetNbFrames}{\void}
+
+Return number of frames
+
+
+\membersection{wxVideoBaseDriver::OnFinished}\label{wxvideobasedriveronfinished}
+
+\func{void}{OnFinished}{\void}
+
+Called when the movie finished
+
+
+\membersection{wxVideoBaseDriver::AttachOutput}\label{wxvideobasedriverattachoutput}
+
+\func{bool}{AttachOutput}{\param{wxWindow\& }{output}}
+
+Attaches the video output to a window. The video will be shown in that window.
+
+
+\membersection{wxVideoBaseDriver::DetachOutput}\label{wxvideobasedriverdetachoutput}
+
+\func{void}{DetachOutput}{\void}
+
+
+\membersection{wxVideoBaseDriver::IsPaused}\label{wxvideobasedriverispaused}
+
+\constfunc{bool}{IsPaused}{\void}
+
+They return the state of the movie.
+
+
+\membersection{wxVideoBaseDriver::IsStopped}\label{wxvideobasedriverisstopped}
+
+\constfunc{bool}{IsStopped}{\void}
+

contrib/docs/latex/mmedia/vidwin.tex

@@ -0,0 +1,147 @@
+%
+% automatically generated by HelpGen from
+% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/vidwin.h at 26/Feb/00 14:52:03
+%
+
+
+\section{\class{wxVideoWindows}}\label{wxvideowindows}
+
+
+
+Class definition
+
+\wxheading{Derived from}
+
+\helpref{wxVideoBaseDriver}{wxvideobasedriver}
+
+\wxheading{Data structures}
+
+{\small \begin{verbatim}
+typedef struct VIDW\_Internal {
+    MCIDEVICEID m\_dev\_id
+\end{verbatim}}
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+
+\membersection{wxVideoWindows::OpenFile}\label{wxvideowindowsopenfile}
+
+\func{void}{OpenFile}{\void}
+
+
+\membersection{wxVideoWindows::wxVideoWindows}\label{wxvideowindowswxvideowindows}
+
+\func{}{wxVideoWindows}{\void}
+
+
+\membersection{wxVideoWindows::wxVideoWindows}\label{wxvideowindowswxvideowindows}
+
+\func{}{wxVideoWindows}{\param{wxInputStream\& }{str}}
+
+
+\membersection{wxVideoWindows::wxVideoWindows}\label{wxvideowindowswxvideowindows}
+
+\func{}{wxVideoWindows}{\param{const wxString\& }{fname}}
+
+
+\membersection{wxVideoWindows::\destruct{wxVideoWindows}}\label{wxvideowindowsdtor}
+
+\func{}{\destruct{wxVideoWindows}}{\void}
+
+
+\membersection{wxVideoWindows::Play}\label{wxvideowindowsplay}
+
+\func{bool}{Play}{\void}
+
+
+\membersection{wxVideoWindows::Stop}\label{wxvideowindowsstop}
+
+\func{bool}{Stop}{\void}
+
+
+\membersection{wxVideoWindows::Pause}\label{wxvideowindowspause}
+
+\func{bool}{Pause}{\void}
+
+
+\membersection{wxVideoWindows::Resume}\label{wxvideowindowsresume}
+
+\func{bool}{Resume}{\void}
+
+
+\membersection{wxVideoWindows::GetSize}\label{wxvideowindowsgetsize}
+
+\constfunc{bool}{GetSize}{\param{wxSize\& }{size}}
+
+
+\membersection{wxVideoWindows::SetSize}\label{wxvideowindowssetsize}
+
+\func{bool}{SetSize}{\param{wxSize }{size}}
+
+
+\membersection{wxVideoWindows::GetMovieCodec}\label{wxvideowindowsgetmoviecodec}
+
+\constfunc{wxString}{GetMovieCodec}{\void}
+
+Return codec name for each stream.
+
+
+\membersection{wxVideoWindows::GetAudioCodec}\label{wxvideowindowsgetaudiocodec}
+
+\constfunc{wxString}{GetAudioCodec}{\void}
+
+
+\membersection{wxVideoWindows::GetSampleRate}\label{wxvideowindowsgetsamplerate}
+
+\constfunc{wxUint32}{GetSampleRate}{\void}
+
+Return misc. info about audio
+
+
+\membersection{wxVideoWindows::GetChannels}\label{wxvideowindowsgetchannels}
+
+\constfunc{wxUint8}{GetChannels}{\void}
+
+
+\membersection{wxVideoWindows::GetBPS}\label{wxvideowindowsgetbps}
+
+\constfunc{wxUint8}{GetBPS}{\void}
+
+
+\membersection{wxVideoWindows::GetFrameRate}\label{wxvideowindowsgetframerate}
+
+\constfunc{double}{GetFrameRate}{\void}
+
+Return the frame rate of the video (in frames/second)
+
+
+\membersection{wxVideoWindows::GetNbFrames}\label{wxvideowindowsgetnbframes}
+
+\constfunc{wxUint32}{GetNbFrames}{\void}
+
+Return the total number of frames in the movie
+
+
+\membersection{wxVideoWindows::IsCapable}\label{wxvideowindowsiscapable}
+
+\func{bool}{IsCapable}{\param{wxVideoType }{v\_type}}
+
+
+\membersection{wxVideoWindows::AttachOutput}\label{wxvideowindowsattachoutput}
+
+\func{bool}{AttachOutput}{\param{wxWindow\& }{output}}
+
+
+\membersection{wxVideoWindows::DetachOutput}\label{wxvideowindowsdetachoutput}
+
+\func{void}{DetachOutput}{\void}
+
+
+\membersection{wxVideoWindows::IsPaused}\label{wxvideowindowsispaused}
+
+\constfunc{bool}{IsPaused}{\void}
+
+
+\membersection{wxVideoWindows::IsStopped}\label{wxvideowindowsisstopped}
+
+\constfunc{bool}{IsStopped}{\void}
+

contrib/docs/latex/mmedia/vidxanm.tex

@@ -0,0 +1,170 @@
+%
+% automatically generated by HelpGen from
+% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/vidxanm.h at 26/Feb/00 14:52:06
+%
+
+
+\section{\class{wxVideoXANIM}}\label{wxvideoxanim}
+
+
+
+Class definition
+
+\wxheading{Derived from}
+
+\helpref{wxVideoBaseDriver}{wxvideobasedriver}
+
+\wxheading{Data structures}
+
+{\small \begin{verbatim}
+typedef struct wxXANIMinternal {
+    Display *xanim\_dpy
+\end{verbatim}}
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+
+\membersection{wxVideoXANIM::wxVideoXANIM}\label{wxvideoxanimwxvideoxanim}
+
+\func{}{wxVideoXANIM}{\void}
+
+
+\membersection{wxVideoXANIM::wxVideoXANIM}\label{wxvideoxanimwxvideoxanim}
+
+\func{}{wxVideoXANIM}{\param{wxInputStream\& }{str}}
+
+
+\membersection{wxVideoXANIM::wxVideoXANIM}\label{wxvideoxanimwxvideoxanim}
+
+\func{}{wxVideoXANIM}{\param{const wxString\& }{filename}}
+
+
+\membersection{wxVideoXANIM::\destruct{wxVideoXANIM}}\label{wxvideoxanimdtor}
+
+\func{}{\destruct{wxVideoXANIM}}{\void}
+
+
+\membersection{wxVideoXANIM::Play}\label{wxvideoxanimplay}
+
+\func{bool}{Play}{\void}
+
+
+\membersection{wxVideoXANIM::Pause}\label{wxvideoxanimpause}
+
+\func{bool}{Pause}{\void}
+
+
+\membersection{wxVideoXANIM::Resume}\label{wxvideoxanimresume}
+
+\func{bool}{Resume}{\void}
+
+
+\membersection{wxVideoXANIM::Stop}\label{wxvideoxanimstop}
+
+\func{bool}{Stop}{\void}
+
+
+\membersection{wxVideoXANIM::SetVolume}\label{wxvideoxanimsetvolume}
+
+\func{bool}{SetVolume}{\param{wxUint8 }{vol}}
+
+
+\membersection{wxVideoXANIM::SetSize}\label{wxvideoxanimsetsize}
+
+\func{bool}{SetSize}{\param{wxSize }{size}}
+
+
+\membersection{wxVideoXANIM::GetSize}\label{wxvideoxanimgetsize}
+
+\constfunc{bool}{GetSize}{\param{wxSize\& }{size}}
+
+
+\membersection{wxVideoXANIM::GetMovieCodec}\label{wxvideoxanimgetmoviecodec}
+
+\constfunc{wxString}{GetMovieCodec}{\void}
+
+Return the video codec name
+
+
+\membersection{wxVideoXANIM::GetAudioCodec}\label{wxvideoxanimgetaudiocodec}
+
+\constfunc{wxString}{GetAudioCodec}{\void}
+
+Return the audio codec name
+
+
+\membersection{wxVideoXANIM::GetSampleRate}\label{wxvideoxanimgetsamplerate}
+
+\constfunc{wxUint32}{GetSampleRate}{\void}
+
+Return misc info about audio
+
+
+\membersection{wxVideoXANIM::GetChannels}\label{wxvideoxanimgetchannels}
+
+\constfunc{wxUint8}{GetChannels}{\void}
+
+
+\membersection{wxVideoXANIM::GetBPS}\label{wxvideoxanimgetbps}
+
+\constfunc{wxUint8}{GetBPS}{\void}
+
+
+\membersection{wxVideoXANIM::GetFrameRate}\label{wxvideoxanimgetframerate}
+
+\constfunc{double}{GetFrameRate}{\void}
+
+Return frame rate
+
+
+\membersection{wxVideoXANIM::GetNbFrames}\label{wxvideoxanimgetnbframes}
+
+\constfunc{wxUint32}{GetNbFrames}{\void}
+
+Return number of frames in the movie
+
+
+\membersection{wxVideoXANIM::IsCapable}\label{wxvideoxanimiscapable}
+
+\constfunc{bool}{IsCapable}{\param{wxVideoType }{v\_type}}
+
+
+\membersection{wxVideoXANIM::AttachOutput}\label{wxvideoxanimattachoutput}
+
+\func{bool}{AttachOutput}{\param{wxWindow\& }{output}}
+
+
+\membersection{wxVideoXANIM::DetachOutput}\label{wxvideoxanimdetachoutput}
+
+\func{void}{DetachOutput}{\void}
+
+
+\membersection{wxVideoXANIM::IsPaused}\label{wxvideoxanimispaused}
+
+\constfunc{bool}{IsPaused}{\void}
+
+
+\membersection{wxVideoXANIM::IsStopped}\label{wxvideoxanimisstopped}
+
+\constfunc{bool}{IsStopped}{\void}
+
+
+\membersection{wxVideoXANIM::RestartXANIM}\label{wxvideoxanimrestartxanim}
+
+\func{bool}{RestartXANIM}{\void}
+
+Start the subprocess with the right parameters
+
+
+\membersection{wxVideoXANIM::SendCommand}\label{wxvideoxanimsendcommand}
+
+\func{bool}{SendCommand}{\param{const char* }{command}, \param{char** }{ret = NULL}, \param{wxUint32* }{size = NULL}}
+
+Send a command to the subprocess
+
+
+\membersection{wxVideoXANIM::CollectInfo}\label{wxvideoxanimcollectinfo}
+
+\func{bool}{CollectInfo}{\void}
+
+Collect informations from XAnim
+