ekiga r6310 - in trunk: . lib/engine/audioinput/skel lib/engine/audiooutput/skel lib/engine/videoinput/skel

[mschneid svn gnome org]

Author: mschneid
Date: Fri May 23 16:22:15 2008
New Revision: 6310
URL: http://svn.gnome.org/viewvc/ekiga?rev=6310&view=rev

Log:
Commenting. 


Modified:
   trunk/ChangeLog
   trunk/lib/engine/audioinput/skel/audioinput-core.h
   trunk/lib/engine/audiooutput/skel/audiooutput-core.h
   trunk/lib/engine/videoinput/skel/videoinput-core.h

Modified: trunk/lib/engine/audioinput/skel/audioinput-core.h
==============================================================================
--- trunk/lib/engine/audioinput/skel/audioinput-core.h	(original)
+++ trunk/lib/engine/audioinput/skel/audioinput-core.h	Fri May 23 16:22:15 2008
@@ -65,7 +65,34 @@
  * @{
  */
 
-  /** Core object for the audio inputsupport
+  /** Core object for the audio input support
+   * The audio input core abstracts all functionality related to audio input
+   * in a thread safe manner. Typically, most of the functions except start_stream(),
+   * stop_stream(), set_stream_buffer_size() and get_frame_data() will be called from 
+   * a UI thread, while the three mentioned funtions will be used by an audio 
+   * streaming thread.
+   * 
+   * The audio input core abstracts different audio input managers, which can 
+   * represent different backends like PTLIB, from the application and can 
+   * switch the input device transparently for the audio streaming thread
+   * even while capturing is in progress.
+   *
+   * If the removal of an audio input device is detected by a failed
+   * read or by a message from the HalCore, the audio input core will 
+   * determine the responsible audio input manager and send a signal to the UI,
+   * which can be used to update device lists. Also, if the removed device was the 
+   * currently used one, the core falls back to the backup device.
+   * 
+   * A similar procedure is performed on the addition of a device. In case we fell 
+   * back due to a removed device, and the respective device is re-added to the system,
+   * it will be automatically activated.
+   *
+   * The audio input core can also be used in a preview mode, where it starts a separate
+   * thread (represented by the AudioPreviewManager), which grabs frames from the audio 
+   * input core and passes them to the audio output core. This can be used for audio device
+   * testing. Note that, contrary to the video preview, the audio preview does not support
+   * direct switching between the preview and the streaming mode, which must tus be
+   * be prevented by the UI.
    */
   class AudioInputCore
     : public Service

Modified: trunk/lib/engine/audiooutput/skel/audiooutput-core.h
==============================================================================
--- trunk/lib/engine/audiooutput/skel/audiooutput-core.h	(original)
+++ trunk/lib/engine/audiooutput/skel/audiooutput-core.h	Fri May 23 16:22:15 2008
@@ -58,14 +58,35 @@
 namespace Ekiga
 {
 /**
- * @defgroup audiooutput Audio AudioInput
+ * @defgroup audiooutput
  * @{
  */
 
    class AudioOutputManager;
    class AudioOutputCore;
 
-  /** Core object for the audio auioinput support
+  /** Core object for the audio output support
+   * The audio output core abstracts all functionality related to audio output
+   * in a thread safe manner. Typically, most of the functions except start(),
+   * stop(), set_buffer_size() and set_frame_data() will be called from a UI thread,
+   * while the three mentioned funtions will be used by an audio streaming thread.
+   * 
+   * The audio output core abstracts different audio output managers, which can 
+   * represent different backends like PTLIB, from the application and can 
+   * switch the output device transparently for the audio streaming thread,
+   * even while audio output is in progress.
+   *
+   * If the removal of an audio output device is detected by a failed
+   * write or by a message from the HalCore, the audio output core will 
+   * determine the responsible audio output manager and send a signal to the UI,
+   * which can be used to update device lists. Also, if the removed device was the 
+   * currently used one, the core falls back to the backup device.
+   * 
+   * A similar procedure is performed on the addition of a device. In case we fell 
+   * back due to a removed device, and the respective device is re-added to the system,
+   * it will be automatically activated.
+   *
+
    */
   class AudioOutputCore
     : public Service

Modified: trunk/lib/engine/videoinput/skel/videoinput-core.h
==============================================================================
--- trunk/lib/engine/videoinput/skel/videoinput-core.h	(original)
+++ trunk/lib/engine/videoinput/skel/videoinput-core.h	Fri May 23 16:22:15 2008
@@ -65,7 +65,37 @@
   class VideoInputManager;
   class VideoInputCore;
 
-  /** Core object for the video vidinput support
+  /** Core object for the video input support
+   * The video input core abstracts all functionality related to video input
+   * in a thread safe manner. Typically, most of the functions except start_stream(),
+   * stop_stream(), and get_frame_data() will be called from 
+   * a UI thread, while the three mentioned funtions will be used by a video
+   * streaming thread.
+   * 
+   * The video output core abstracts different video input managers, which can 
+   * represent different backends like PTLIB, from the application and can 
+   * switch the output device transparently for the video streaming thread,
+   * even while capturing is in progress.
+   *
+   * If the removal of an video input device is detected by a failed
+   * read or by a message from the HalCore, the video input core will 
+   * determine the responsible video input manager and send a signal to the UI,
+   * which can be used to update device lists. Also, if the removed device was the 
+   * currently used one, the core falls back to the backup device.
+   * 
+   * A similar procedure is performed on the addition of a device. In case we fell 
+   * back due to a removed device, and the respective device is re-added to the system,
+   * it will be automatically activated.
+   *
+   * The video input core can also be used in a preview mode, where it starts a separate
+   * thread (represented by the VideoPreviewManager), which grabs frames from the video 
+   * input core and passes them to the video output core. This can be used for displaying
+   * the local camera signal while not being in a call. If the preview is active and them
+   * and the stream is started, the core will automatically determined if the device needs
+   * to be reinitialized (the stream settings may be different from the preview settings
+   * due to the capabilities negotiation). In case preview is set to active and them
+   * the streaming is ended, the core will automatically switch back to preview mode,
+   * also reinitializing the device if preview settings differ from stream settings.
    */
   class VideoInputCore
     : public Service