* modules/stream_out/*: attempt at adding descriptions to the config options.

diff --git a/modules/stream_out/display.c b/modules/stream_out/display.c
index 187b4a806e5d01778bbaf08739f882533a1c7ef6..e7990f3a5f8935ad3b14d47ba2ee83373ce86a50 100644 (file)
--- a/modules/stream_out/display.c
+++ b/modules/stream_out/display.c
@@ -34,6 +34,13 @@
 /*****************************************************************************
  * Module descriptor
  *****************************************************************************/
+#define AUDIO_TEXT N_("Enable audio")
+#define AUDIO_LONGTEXT N_( "Enable/disable audio rendering." )
+#define VIDEO_TEXT N_("Enable video")
+#define VIDEO_LONGTEXT N_( "Enable/disable video rendering." )
+#define DELAY_TEXT N_("Delay")
+#define DELAY_LONGTEXT N_( "Introduces a delay in the display of the stream." )
+
 static int  Open ( vlc_object_t * );
 static void Close( vlc_object_t * );
 
@@ -43,9 +50,12 @@ vlc_module_begin();
     set_description( _("Display stream output") );
     set_capability( "sout stream", 50 );
     add_shortcut( "display" );
-    add_bool( SOUT_CFG_PREFIX "audio", 1, NULL, "audio", "", VLC_TRUE );
-    add_bool( SOUT_CFG_PREFIX "video", 1, NULL, "video", "", VLC_TRUE );
-    add_integer( SOUT_CFG_PREFIX "delay", 100, NULL, "delay", "", VLC_TRUE );
+    add_bool( SOUT_CFG_PREFIX "audio", 1, NULL, AUDIO_TEXT,
+              AUDIO_LONGTEXT, VLC_TRUE );
+    add_bool( SOUT_CFG_PREFIX "video", 1, NULL, VIDEO_TEXT,
+              VIDEO_LONGTEXT, VLC_TRUE );
+    add_integer( SOUT_CFG_PREFIX "delay", 100, NULL, DELAY_TEXT,
+                 DELAY_LONGTEXT, VLC_TRUE );
     set_callbacks( Open, Close );
 vlc_module_end();
 
@@ -80,10 +90,12 @@ static int Open( vlc_object_t *p_this )
     sout_stream_sys_t *p_sys;
     vlc_value_t val;
 
-    sout_ParseCfg( p_stream, SOUT_CFG_PREFIX, ppsz_sout_options, p_stream->p_cfg );
+    sout_ParseCfg( p_stream, SOUT_CFG_PREFIX, ppsz_sout_options,
+                   p_stream->p_cfg );
 
-    p_sys           = malloc( sizeof( sout_stream_sys_t ) );
-    p_sys->p_input  = vlc_object_find( p_stream, VLC_OBJECT_INPUT, FIND_ANYWHERE );
+    p_sys          = malloc( sizeof( sout_stream_sys_t ) );
+    p_sys->p_input = vlc_object_find( p_stream, VLC_OBJECT_INPUT,
+                                      FIND_ANYWHERE );
     if( !p_sys->p_input )
     {
         msg_Err( p_stream, "cannot find p_input" );

diff --git a/modules/stream_out/es.c b/modules/stream_out/es.c
index db61298d53330617d16964128aae9417c394428a..13c5550fe7a1ddfb04f585e49b435e63a5641476 100644 (file)
--- a/modules/stream_out/es.c
+++ b/modules/stream_out/es.c
@@ -34,6 +34,41 @@
 /*****************************************************************************
  * Module descriptor
  *****************************************************************************/
+#define ACCESS_TEXT N_("Output access method")
+#define ACCESS_LONGTEXT N_( \
+    "Allows you to specify the output access method used for the streaming " \
+    "output." )
+#define ACCESSA_TEXT N_("Audio output access method")
+#define ACCESSA_LONGTEXT N_( \
+    "Allows you to specify the output access method used for the audio " \
+    "streaming output." )
+#define ACCESSV_TEXT N_("Video output access method")
+#define ACCESSV_LONGTEXT N_( \
+    "Allows you to specify the output access method used for the video " \
+    "streaming output." )
+
+#define MUX_TEXT N_("Output muxer")
+#define MUX_LONGTEXT N_( \
+    "Allows you to specify the muxer used for the streaming output." )
+#define MUXA_TEXT N_("Audio output muxer")
+#define MUXA_LONGTEXT N_( \
+    "Allows you to specify the muxer used for the audio streaming output." )
+#define MUXV_TEXT N_("Video output muxer")
+#define MUXV_LONGTEXT N_( \
+    "Allows you to specify the muxer used for the video streaming output." )
+
+#define DEST_TEXT N_("Output URL")
+#define DEST_LONGTEXT N_( \
+    "Allows you to specify the output URL used for the streaming output." )
+#define DESTA_TEXT N_("Audio output URL")
+#define DESTA_LONGTEXT N_( \
+    "Allows you to specify the output URL used for the audio streaming " \
+    "output." )
+#define DESTV_TEXT N_("Video output URL")
+#define DESTV_LONGTEXT N_( \
+    "Allows you to specify the output URL used for the video streaming " \
+    "output." )
+
 static int      Open    ( vlc_object_t * );
 static void     Close   ( vlc_object_t * );
 
@@ -44,17 +79,26 @@ vlc_module_begin();
     set_capability( "sout stream", 50 );
     add_shortcut( "es" );
 
-    add_string( SOUT_CFG_PREFIX "access", "", NULL, "access", "", VLC_TRUE );
-    add_string( SOUT_CFG_PREFIX "access-audio", "", NULL, "access audio", "", VLC_TRUE );
-    add_string( SOUT_CFG_PREFIX "access-video", "", NULL, "access video", "", VLC_TRUE );
-
-    add_string( SOUT_CFG_PREFIX "mux", "", NULL, "mux", "", VLC_TRUE );
-    add_string( SOUT_CFG_PREFIX "mux-audio", "", NULL, "mux audio", "", VLC_TRUE );
-    add_string( SOUT_CFG_PREFIX "mux-video", "", NULL, "mux video", "", VLC_TRUE );
-
-    add_string( SOUT_CFG_PREFIX "dst", "", NULL, "dst", "", VLC_TRUE );
-    add_string( SOUT_CFG_PREFIX "dst-audio", "", NULL, "dst audio", "", VLC_TRUE );
-    add_string( SOUT_CFG_PREFIX "dst-video", "", NULL, "dst video", "", VLC_TRUE );
+    add_string( SOUT_CFG_PREFIX "access", "", NULL, ACCESS_TEXT,
+                ACCESS_LONGTEXT, VLC_TRUE );
+    add_string( SOUT_CFG_PREFIX "access-audio", "", NULL, ACCESSA_TEXT,
+                ACCESSA_LONGTEXT, VLC_TRUE );
+    add_string( SOUT_CFG_PREFIX "access-video", "", NULL, ACCESSV_TEXT,
+                ACCESSV_LONGTEXT, VLC_TRUE );
+
+    add_string( SOUT_CFG_PREFIX "mux", "", NULL, MUX_TEXT,
+                MUX_LONGTEXT, VLC_TRUE );
+    add_string( SOUT_CFG_PREFIX "mux-audio", "", NULL, MUXA_TEXT,
+                MUXA_LONGTEXT, VLC_TRUE );
+    add_string( SOUT_CFG_PREFIX "mux-video", "", NULL, MUXV_TEXT,
+                MUXV_LONGTEXT, VLC_TRUE );
+
+    add_string( SOUT_CFG_PREFIX "dst", "", NULL, DEST_TEXT,
+                DEST_LONGTEXT, VLC_TRUE );
+    add_string( SOUT_CFG_PREFIX "dst-audio", "", NULL, DESTA_TEXT,
+                DESTA_LONGTEXT, VLC_TRUE );
+    add_string( SOUT_CFG_PREFIX "dst-video", "", NULL, DESTV_TEXT,
+                DESTV_LONGTEXT, VLC_TRUE );
 
     set_callbacks( Open, Close );
 vlc_module_end();

diff --git a/modules/stream_out/rtp.c b/modules/stream_out/rtp.c
index 6f90057091e66b2d5252bb0e3ba81815b74d5d03..e483ff854effbac3a5dc0fdb035df98685348fa8 100644 (file)
--- a/modules/stream_out/rtp.c
+++ b/modules/stream_out/rtp.c
@@ -36,6 +36,25 @@
 /*****************************************************************************
  * Module descriptor
  *****************************************************************************/
+#define DST_TEXT N_("Destination")
+#define DST_LONGTEXT N_( \
+    "Allows you to specify the output URL used for the streaming output." )
+#define NAME_TEXT N_("Session name")
+#define NAME_LONGTEXT N_( \
+    "Allows you to specify the session name used for the streaming output." )
+#define SDP_TEXT N_("SDP")
+#define SDP_LONGTEXT N_( \
+    "Allows you to specify the SDP used for the streaming output." )
+#define MUX_TEXT N_("Muxer")
+#define MUX_LONGTEXT N_( \
+    "Allows you to specify the muxer used for the streaming output." )
+#define PORT_TEXT N_("Port")
+#define PORT_LONGTEXT N_( \
+    "Allows you to specify the port used for the streaming output." )
+#define TTL_TEXT N_("Time to live")
+#define TTL_LONGTEXT N_( \
+    "Allows you to specify the time to live for the output stream." )
+
 static int  Open ( vlc_object_t * );
 static void Close( vlc_object_t * );
 
@@ -45,13 +64,20 @@ vlc_module_begin();
     set_description( _("RTP stream output") );
     set_capability( "sout stream", 0 );
     add_shortcut( "rtp" );
-    add_string( SOUT_CFG_PREFIX "dst", "", NULL, "destination", "", VLC_TRUE );
-    add_string( SOUT_CFG_PREFIX "name", "", NULL, "name", "", VLC_TRUE );
-    add_string( SOUT_CFG_PREFIX "sdp", "", NULL, "sdp", "", VLC_TRUE );
-    add_string( SOUT_CFG_PREFIX "mux", "", NULL, "mux", "", VLC_TRUE );
 
-    add_integer( SOUT_CFG_PREFIX "port", 1234, NULL, "port", "", VLC_TRUE );
-    add_integer( SOUT_CFG_PREFIX "ttl", 0, NULL, "port", "", VLC_TRUE );
+    add_string( SOUT_CFG_PREFIX "dst", "", NULL, DST_TEXT,
+                DST_LONGTEXT, VLC_TRUE );
+    add_string( SOUT_CFG_PREFIX "name", "", NULL, NAME_TEXT,
+                NAME_LONGTEXT, VLC_TRUE );
+    add_string( SOUT_CFG_PREFIX "sdp", "", NULL, SDP_TEXT,
+                SDP_LONGTEXT, VLC_TRUE );
+    add_string( SOUT_CFG_PREFIX "mux", "", NULL, MUX_TEXT,
+                MUX_LONGTEXT, VLC_TRUE );
+
+    add_integer( SOUT_CFG_PREFIX "port", 1234, NULL, PORT_TEXT,
+                 PORT_LONGTEXT, VLC_TRUE );
+    add_integer( SOUT_CFG_PREFIX "ttl", 0, NULL, TTL_TEXT,
+                 TTL_LONGTEXT, VLC_TRUE );
 
     set_callbacks( Open, Close );
 vlc_module_end();

diff --git a/modules/stream_out/standard.c b/modules/stream_out/standard.c
index 4ff6666b1c396b2c1531b21ed674f00587dcc062..7143bebe588ab3133541253f979a46c56dea9596 100644 (file)
--- a/modules/stream_out/standard.c
+++ b/modules/stream_out/standard.c
@@ -37,6 +37,18 @@
 /*****************************************************************************
  * Module descriptor
  *****************************************************************************/
+#define ACCESS_TEXT N_("Output access method")
+#define ACCESS_LONGTEXT N_( \
+    "Allows you to pecify the output access method used for the streaming " \
+    "output." )
+#define MUX_TEXT N_("Output muxer")
+#define MUX_LONGTEXT N_( \
+    "Allows you to pecify the output muxer method used for the streaming " \
+    "output." )
+#define URL_TEXT N_("Output URL")
+#define URL_LONGTEXT N_( \
+    "Allows you to pecify the output URL used for the streaming output." )
+
 static int      Open    ( vlc_object_t * );
 static void     Close   ( vlc_object_t * );
 
@@ -48,9 +60,12 @@ vlc_module_begin();
     add_shortcut( "standard" );
     add_shortcut( "std" );
 
-    add_string( SOUT_CFG_PREFIX "access", "", NULL, "access", "", VLC_TRUE );
-    add_string( SOUT_CFG_PREFIX "mux", "", NULL, "mux", "", VLC_TRUE );
-    add_string( SOUT_CFG_PREFIX "url", "", NULL, "url", "", VLC_TRUE );
+    add_string( SOUT_CFG_PREFIX "access", "", NULL, ACCESS_TEXT,
+                ACCESS_LONGTEXT, VLC_FALSE );
+    add_string( SOUT_CFG_PREFIX "mux", "", NULL, MUX_TEXT,
+                MUX_LONGTEXT, VLC_FALSE );
+    add_string( SOUT_CFG_PREFIX "url", "", NULL, URL_TEXT,
+                URL_LONGTEXT, VLC_FALSE );
 
     add_bool( SOUT_CFG_PREFIX "sap", 0, NULL, "sap", "", VLC_TRUE );
     add_string( SOUT_CFG_PREFIX "sap-name", "", NULL, "sap name", "", VLC_TRUE );