[Gnash-commit] /srv/bzr/gnash/trunk r11388: updated docs

[Ben Limmer]

------------------------------------------------------------
revno: 11388
committer: Ben Limmer <address@hidden>
branch nick: trunk
timestamp: Fri 2009-08-07 14:51:26 -0600
message:
  updated docs
modified:
  doc/C/usermanual/gnashrc.xml
  libmedia/AudioInput.h
  libmedia/VideoInput.h
  libmedia/gst/AudioInputGst.cpp
  libmedia/gst/VideoInputGst.cpp

=== modified file 'doc/C/usermanual/gnashrc.xml'
--- a/doc/C/usermanual/gnashrc.xml      2009-06-07 18:06:16 +0000
+++ b/doc/C/usermanual/gnashrc.xml      2009-08-07 20:51:26 +0000
@@ -169,6 +169,19 @@
          for the plugin, so you have to explicitly start any movie on a 
webpage. This option is <emphasis>off</emphasis> by default.
          </entry>
        </row>
+    
+    <entry>webcamDevice</entry>
+         <entry>integer</entry>
+         <entry>The integer value (index into vector of video devices) that 
represents the default webcam.
+      To easily get this entry run utilities/findwebcams (only works with 
Gstreamer right now)</entry>
+       </row>
+    
+    <entry>microphoneDevice</entry>
+         <entry>integer</entry>
+         <entry>The integer value (index into vector of microphone devices) 
that represents the default microphone.
+      To easily get this entry run utilities/findmicrophones (only works with 
Gstreamer right now)</entry>
+       </row>
+    
        <row>
          <entry>flashVersionString</entry>
          <entry>string</entry>

=== modified file 'libmedia/AudioInput.h'
--- a/libmedia/AudioInput.h     2009-08-04 17:46:54 +0000
+++ b/libmedia/AudioInput.h     2009-08-07 20:51:26 +0000
@@ -26,6 +26,10 @@
 namespace gnash {
 namespace media {
 
+/// \class AudioInput
+/// This is the base class that talks to Microphone_as.cpp. It is basically
+/// exactly what's specified in the livedocs. Most of the real work is done
+/// in the AudioInputGst or AudioInputFFMPEG source files, respectively.
 class AudioInput {
        
 public:

=== modified file 'libmedia/VideoInput.h'
--- a/libmedia/VideoInput.h     2009-08-07 19:56:42 +0000
+++ b/libmedia/VideoInput.h     2009-08-07 20:51:26 +0000
@@ -54,10 +54,13 @@
     int get_height() {return _height;};
     
     void set_index(int i) {_index = i;};
+    // livedocs say that this should return a number, but when testing with
+    // flashplayer it appears to actually return a string.
     std::string get_index() {
         char buffer[2];
         sprintf(buffer, "%i", _index);
-        return buffer;};
+        return buffer;
+    };
     
     void set_keyFrameInterval(int i) {_keyFrameInterval = i;};
     int get_keyFrameInterval() {return _keyFrameInterval;};

=== modified file 'libmedia/gst/AudioInputGst.cpp'
--- a/libmedia/gst/AudioInputGst.cpp    2009-08-07 19:56:42 +0000
+++ b/libmedia/gst/AudioInputGst.cpp    2009-08-07 20:51:26 +0000
@@ -35,7 +35,8 @@
 namespace gnash {
 namespace media {
 namespace gst {
-       AudioInputGst::AudioInputGst() {
+       AudioInputGst::AudioInputGst() 
+    {
                gst_init(NULL,NULL);
         
         findAudioDevs();
@@ -59,7 +60,8 @@
        }
     
     void
-    AudioInputGst::findAudioDevs() {
+    AudioInputGst::findAudioDevs() 
+    {
         _numdevs = 0;
         
         //enumerate audio test sources
@@ -118,7 +120,8 @@
     }
     
     bool
-    AudioInputGst::checkSupportedFormats(GstCaps *caps) {
+    AudioInputGst::checkSupportedFormats(GstCaps *caps) 
+    {
         gint num_structs;
         
         num_structs = gst_caps_get_size (caps);
@@ -317,7 +320,8 @@
     } 
     
     gboolean
-    AudioInputGst::audioCreateSourceBin(GnashAudioPrivate *audio) {
+    AudioInputGst::audioCreateSourceBin(GnashAudioPrivate *audio) 
+    {
         GError *error = NULL;
         gchar *command = NULL;
         if(g_strcmp0(audio->_deviceName, "audiotest") == 0) {
@@ -355,7 +359,8 @@
     }
     
     gboolean
-    AudioInputGst::audioCreateMainBin(GnashAudioPrivate *audio) {
+    AudioInputGst::audioCreateMainBin(GnashAudioPrivate *audio) 
+    {
         GstElement *tee, *audioPlaybackQueue, *saveQueue;
         gboolean ok;
         GstPad  *pad;
@@ -433,7 +438,8 @@
     }
     
     gboolean
-    AudioInputGst::audioCreatePlaybackBin(GnashAudioPrivate *audio) {
+    AudioInputGst::audioCreatePlaybackBin(GnashAudioPrivate *audio) 
+    {
         GstElement* autosink;
         GstPad* pad;
         gboolean ok;
@@ -457,7 +463,8 @@
     }
     
     gboolean
-    AudioInputGst::makeAudioSourcePlaybackLink(GnashAudioPrivate *audio) {
+    AudioInputGst::makeAudioSourcePlaybackLink(GnashAudioPrivate *audio) 
+    {
         if (gst_bin_get_by_name(GST_BIN(audio->_pipeline), "playbackBin") == 
NULL) {
             gst_object_ref(audio->_audioPlaybackBin);
             gst_bin_add(GST_BIN(audio->_pipeline), audio->_audioPlaybackBin);
@@ -482,7 +489,8 @@
     }
     
     gboolean
-    AudioInputGst::breakAudioSourcePlaybackLink(GnashAudioPrivate *audio) {
+    AudioInputGst::breakAudioSourcePlaybackLink(GnashAudioPrivate *audio) 
+    {
         if (audio->_pipelineIsPlaying == true) {
             audioStop(audio);
         }
@@ -548,7 +556,8 @@
     }
     
     gboolean
-    AudioInputGst::audioCreateSaveBin(GnashAudioPrivate* audio) {
+    AudioInputGst::audioCreateSaveBin(GnashAudioPrivate* audio) 
+    {
         GstElement *audioConvert, *audioEnc, *filesink;
         GstPad* pad;
         
@@ -594,7 +603,8 @@
     }
     
     gboolean
-    AudioInputGst::makeAudioSourceSaveLink (GnashAudioPrivate* audio) {
+    AudioInputGst::makeAudioSourceSaveLink (GnashAudioPrivate* audio) 
+    {
         if (gst_bin_get_by_name(GST_BIN(audio->_pipeline), "audioSaveBin") == 
NULL) {
             gst_object_ref(audio->_audioSaveBin);
             gst_bin_add(GST_BIN(audio->_pipeline), audio->_audioSaveBin);
@@ -619,7 +629,8 @@
     }
     
     gboolean
-    AudioInputGst::breakAudioSourceSaveLink (GnashAudioPrivate *audio) {
+    AudioInputGst::breakAudioSourceSaveLink (GnashAudioPrivate *audio) 
+    {
         if (audio->_pipelineIsPlaying == true) {
             audioStop(audio);
         }
@@ -654,7 +665,8 @@
     }
     
     bool
-    AudioInputGst::audioPlay(GnashAudioPrivate *audio) {
+    AudioInputGst::audioPlay(GnashAudioPrivate *audio) 
+    {
         GstStateChangeReturn state;
         GstBus *bus;
         gint ret;
@@ -675,7 +687,8 @@
     }
     
     bool
-    AudioInputGst::audioStop(GnashAudioPrivate *audio) {
+    AudioInputGst::audioStop(GnashAudioPrivate *audio) 
+    {
         GstStateChangeReturn state;
         
         state = gst_element_set_state (audio->_pipeline, GST_STATE_NULL);
@@ -689,7 +702,8 @@
     }
     
     int
-    AudioInputGst::makeAudioDevSelection() {
+    AudioInputGst::makeAudioDevSelection() 
+    {
         int devselect = -1;
         devselect = rcfile.getAudioInputDevice();
         if (devselect == -1) {

=== modified file 'libmedia/gst/VideoInputGst.cpp'
--- a/libmedia/gst/VideoInputGst.cpp    2009-08-07 19:56:42 +0000
+++ b/libmedia/gst/VideoInputGst.cpp    2009-08-07 20:51:26 +0000
@@ -40,7 +40,8 @@
 namespace gst {
     
     //initializes the Gstreamer interface
-    VideoInputGst::VideoInputGst() {
+    VideoInputGst::VideoInputGst() 
+    {
         gst_init(NULL,NULL);
         
         int devSelection;
@@ -66,7 +67,8 @@
         webcamCreateSaveBin(_globalWebcam);
     }
     
-    VideoInputGst::~VideoInputGst() {
+    VideoInputGst::~VideoInputGst() 
+    {
         log_unimpl("Video Input destructor");
     }
     
@@ -74,7 +76,8 @@
     //which contain important information about the hardware camera
     //inputs available on the machine
     void
-    VideoInputGst::findVidDevs() {
+    VideoInputGst::findVidDevs() 
+    {
         _numdevs = 0;
         
         //find video test sources
@@ -311,7 +314,8 @@
     //pulls webcam device selection from gnashrc (will eventually tie into
     //gui)
     int
-    VideoInputGst::makeWebcamDeviceSelection() {
+    VideoInputGst::makeWebcamDeviceSelection()
+    {
         int dev_select;
         dev_select = rcfile.getWebcamDevice();
         if (dev_select == -1) {
@@ -434,7 +438,8 @@
 
     //probe the selected camera for the formats it supports
     void
-    VideoInputGst::getSupportedFormats(GnashWebcam *cam, GstCaps *caps) {
+    VideoInputGst::getSupportedFormats(GnashWebcam *cam, GstCaps *caps) 
+    {
         gint i;
         gint num_structs;
         
@@ -537,7 +542,8 @@
 
     //create a bin containing the source and a connector ghostpad
     gboolean
-    VideoInputGst::webcamCreateSourceBin(GnashWebcamPrivate *webcam) {
+    VideoInputGst::webcamCreateSourceBin(GnashWebcamPrivate *webcam) 
+    {
         GError *error = NULL;
         gchar *command = NULL;
         
@@ -659,7 +665,8 @@
     
     gboolean
     VideoInputGst::checkForSupportedFramerate(GnashWebcamPrivate *webcam,
-            int fps) {
+            int fps) 
+    {
         
         for (int i = 0; i < webcam->_currentFormat->numFramerates; ++i) {
             int val = std::ceil(
@@ -673,7 +680,8 @@
     }
     
     gboolean
-    VideoInputGst::webcamChangeSourceBin(GnashWebcamPrivate *webcam) {
+    VideoInputGst::webcamChangeSourceBin(GnashWebcamPrivate *webcam) 
+    {
         GError *error = NULL;
         gchar *command = NULL;
         
@@ -844,7 +852,8 @@
     //capabilities as well as save-to-file or buffer capabilities (both
     //implemented as bin ghostpads)
     gboolean
-    VideoInputGst::webcamCreateMainBin(GnashWebcamPrivate *webcam) {
+    VideoInputGst::webcamCreateMainBin(GnashWebcamPrivate *webcam) 
+    {
         GstElement *tee, *video_display_queue, *save_queue;
         gboolean ok;
         GstPad  *pad;
@@ -927,7 +936,8 @@
     }
 
     gboolean
-    VideoInputGst::webcamCreateDisplayBin(GnashWebcamPrivate *webcam) {
+    VideoInputGst::webcamCreateDisplayBin(GnashWebcamPrivate *webcam) 
+    {
         GstElement *video_scale, *video_sink;
         gboolean ok;
         GstPad  *pad;
@@ -976,7 +986,8 @@
     //make link between display_queue src ghostpad in main_bin and
     //the elements necessary to display video to screen (_videoDisplayBin)
     gboolean
-    VideoInputGst::webcamMakeVideoDisplayLink(GnashWebcamPrivate *webcam) {
+    VideoInputGst::webcamMakeVideoDisplayLink(GnashWebcamPrivate *webcam) 
+    {
         if (gst_bin_get_by_name(GST_BIN(webcam->_pipeline), 
"video_display_bin") == NULL) {
             gst_object_ref(webcam->_videoDisplayBin);
             gst_bin_add (GST_BIN(webcam->_pipeline), webcam->_videoDisplayBin);
@@ -1002,7 +1013,8 @@
     
     //break the link that displays the webcam video to the screen
     gboolean
-    VideoInputGst::webcamBreakVideoDisplayLink(GnashWebcamPrivate *webcam) {
+    VideoInputGst::webcamBreakVideoDisplayLink(GnashWebcamPrivate *webcam) 
+    {
         if (webcam->_pipelineIsPlaying == true) {
             GstStateChangeReturn state;
             state = gst_element_set_state(webcam->_pipeline, GST_STATE_NULL);
@@ -1033,7 +1045,8 @@
     
     //make link to saveQueue in main bin
     gboolean
-    VideoInputGst::webcamMakeVideoSaveLink(GnashWebcamPrivate *webcam) {
+    VideoInputGst::webcamMakeVideoSaveLink(GnashWebcamPrivate *webcam) 
+    {
         if (gst_bin_get_by_name(GST_BIN(webcam->_pipeline), "video_save_bin") 
== NULL) {
             gst_object_ref(webcam->_videoSaveBin);
             gst_bin_add(GST_BIN(webcam->_pipeline), webcam->_videoSaveBin);
@@ -1059,7 +1072,8 @@
     
     //break link to saveQueue in main bin
     gboolean
-    VideoInputGst::webcamBreakVideoSaveLink(GnashWebcamPrivate *webcam) {
+    VideoInputGst::webcamBreakVideoSaveLink(GnashWebcamPrivate *webcam) 
+    {
         if (webcam->_pipelineIsPlaying == true) {
             GstStateChangeReturn state;
             state = gst_element_set_state(webcam->_pipeline, GST_STATE_NULL);
@@ -1100,7 +1114,8 @@
     //create a bin to take the video stream and dump it out to
     //an ogg file
     gboolean
-    VideoInputGst::webcamCreateSaveBin(GnashWebcamPrivate *webcam) {
+    VideoInputGst::webcamCreateSaveBin(GnashWebcamPrivate *webcam) 
+    {
         GstElement *video_save_csp, *video_save_rate, *video_save_scale, 
*video_enc;
         GstElement *mux;
         GstPad     *pad;
@@ -1194,7 +1209,8 @@
     
     //start the pipeline and run the g_main_loop
     gboolean
-    VideoInputGst::webcamPlay(GnashWebcamPrivate *webcam) {
+    VideoInputGst::webcamPlay(GnashWebcamPrivate *webcam) 
+    {
         GstStateChangeReturn state;
         GstBus *bus;
         gint ret;
@@ -1214,7 +1230,8 @@
     }
     
     gboolean
-    VideoInputGst::webcamStop(GnashWebcamPrivate *webcam) {
+    VideoInputGst::webcamStop(GnashWebcamPrivate *webcam) 
+    {
         GstStateChangeReturn state;
         
         state = gst_element_set_state (webcam->_pipeline, GST_STATE_NULL);