From c766d434b0e2f7d8787a30703c06e27e9b2bb8d7 Mon Sep 17 00:00:00 2001 From: Geoffroy Couprie Date: Fri, 1 Jan 2010 21:58:09 +0100 Subject: [PATCH] Add a bunch of help strings. Feel free to correct them, and add more --- modules/access/fake.c | 2 +- modules/access/smb.c | 2 ++ modules/audio_filter/chorus_flanger.c | 3 ++- modules/audio_filter/normvol.c | 2 +- modules/video_filter/ball.c | 3 +++ modules/video_filter/canvas.c | 4 +++- modules/video_filter/clone.c | 3 +++ modules/video_filter/colorthres.c | 4 +++- modules/video_filter/crop.c | 3 +++ modules/video_filter/erase.c | 3 +++ modules/video_filter/gaussianblur.c | 3 +++ modules/video_filter/gradient.c | 3 +++ modules/video_filter/grain.c | 2 ++ modules/video_filter/logo.c | 4 +++- modules/video_filter/marq.c | 5 ++++- modules/video_filter/mirror.c | 2 +- modules/video_filter/panoramix.c | 4 ++++ modules/video_filter/rss.c | 3 +++ modules/video_filter/scene.c | 2 ++ modules/video_filter/sharpen.c | 6 ++++-- modules/video_filter/transform.c | 2 ++ modules/video_output/msw/direct3d.c | 5 ++++- modules/video_output/msw/directx.c | 6 +++++- 23 files changed, 64 insertions(+), 12 deletions(-) diff --git a/modules/access/fake.c b/modules/access/fake.c index 0cd8b09c1e..77ee197708 100644 --- a/modules/access/fake.c +++ b/modules/access/fake.c @@ -61,7 +61,7 @@ static void Close( vlc_object_t * ); vlc_module_begin () set_shortname( N_("Fake") ) - set_description( N_("Fake input") ) + set_description( N_("Fake video input") ) set_category( CAT_INPUT ) set_subcategory( SUBCAT_INPUT_ACCESS ) diff --git a/modules/access/smb.c b/modules/access/smb.c index b47e6fe06f..0571fceefb 100644 --- a/modules/access/smb.c +++ b/modules/access/smb.c @@ -72,9 +72,11 @@ static void Close( vlc_object_t * ); #define DOMAIN_LONGTEXT N_("Domain/Workgroup that " \ "will be used for the connection.") +#define SMB_HELP N_("Samba (Windows network shares) input") vlc_module_begin () set_shortname( "SMB" ) set_description( N_("SMB input") ) + set_help(SMB_HELP) set_capability( "access", 0 ) set_category( CAT_INPUT ) set_subcategory( SUBCAT_INPUT_ACCESS ) diff --git a/modules/audio_filter/chorus_flanger.c b/modules/audio_filter/chorus_flanger.c index 6f2c6ce743..294c696052 100644 --- a/modules/audio_filter/chorus_flanger.c +++ b/modules/audio_filter/chorus_flanger.c @@ -75,7 +75,8 @@ struct filter_sys_t vlc_module_begin () set_description( N_("Sound Delay") ) - set_shortname( N_("delay") ) + set_shortname( N_("Delay") ) + set_help( N_("Add a delay effect to the sound") ) set_category( CAT_AUDIO ) set_subcategory( SUBCAT_AUDIO_AFILTER ) add_shortcut( "delay" ) diff --git a/modules/audio_filter/normvol.c b/modules/audio_filter/normvol.c index 8710e2700e..77c7ce69fa 100644 --- a/modules/audio_filter/normvol.c +++ b/modules/audio_filter/normvol.c @@ -72,7 +72,7 @@ struct filter_sys_t "increase the response time of the filter to a spike " \ "but will make it less sensitive to short variations." ) -#define LEVEL_TEXT N_("Max level" ) +#define LEVEL_TEXT N_("Maximal volume level" ) #define LEVEL_LONGTEXT N_("If the average power over the last N buffers " \ "is higher than this value, the volume will be normalized. " \ "This value is a positive floating point number. A value " \ diff --git a/modules/video_filter/ball.c b/modules/video_filter/ball.c index 52e2597767..ecb330d6db 100644 --- a/modules/video_filter/ball.c +++ b/modules/video_filter/ball.c @@ -123,6 +123,8 @@ static int getBallColor( vlc_object_t *p_this, char const *psz_newval ); #define GRAD_THRESH_TEXT N_("Gradient threshold") #define GRAD_THRESH_LONGTEXT N_("Set gradient threshold for edge computation.") +#define BALL_HELP N_("Augmented reality ball game") + #define FILTER_PREFIX "ball-" static const char *const mode_list[] = { "red", "green", "blue", "white" }; @@ -132,6 +134,7 @@ static const char *const mode_list_text[] = { N_("Red"), N_("Green"), vlc_module_begin () set_description( N_("Ball video filter") ) set_shortname( N_( "Ball" )) + set_help(BALL_HELP) set_capability( "video filter2", 0 ) set_category( CAT_VIDEO ) set_subcategory( SUBCAT_VIDEO_VFILTER ) diff --git a/modules/video_filter/canvas.c b/modules/video_filter/canvas.c index ce5573a35a..c14ee78422 100644 --- a/modules/video_filter/canvas.c +++ b/modules/video_filter/canvas.c @@ -94,6 +94,7 @@ static int alloc_init( filter_t *, void * ); #define PADD_LONGTEXT N_( \ "If enabled, video will be padded to fit in canvas after scaling. " \ "Otherwise, video will be cropped to fix in canvas after scaling." ) +#define CANVAS_HELP N_( "Automatically resize and pad a video" ) #define CFG_PREFIX "canvas-" @@ -102,8 +103,9 @@ static int alloc_init( filter_t *, void * ); *****************************************************************************/ vlc_module_begin () set_shortname( N_("Canvas") ) - set_description( N_("Automatically resize and pad a video") ) + set_description( N_("Canvas video filter") ) set_capability( "video filter2", 0 ) + set_help( CANVAS_HELP ) set_callbacks( Activate, Destroy ) set_category( CAT_VIDEO ) diff --git a/modules/video_filter/clone.c b/modules/video_filter/clone.c index e1798c78fd..33b461cbf5 100644 --- a/modules/video_filter/clone.c +++ b/modules/video_filter/clone.c @@ -44,6 +44,8 @@ #define VOUTLIST_LONGTEXT N_("You can use specific video output modules " \ "for the clones. Use a comma-separated list of modules." ) +#define CLONE_HELP N_("Duplicate your video to multiple windows " \ + "and/or video output modules") #define CFG_PREFIX "clone-" static int Open ( vlc_object_t * ); @@ -53,6 +55,7 @@ vlc_module_begin () set_description( N_("Clone video filter") ) set_capability( "video splitter", 0 ) set_shortname( N_("Clone" )) + set_help(CLONE_HELP) set_category( CAT_VIDEO ) set_subcategory( SUBCAT_VIDEO_VFILTER ) diff --git a/modules/video_filter/colorthres.c b/modules/video_filter/colorthres.c index e89a211a72..9533179d4e 100644 --- a/modules/video_filter/colorthres.c +++ b/modules/video_filter/colorthres.c @@ -1,5 +1,5 @@ /***************************************************************************** - * colorthres.c: Theshold color based on similarity to reference color + * colorthres.c: Threshold color based on similarity to reference color ***************************************************************************** * Copyright (C) 2000-2009 the VideoLAN team * $Id$ @@ -55,6 +55,7 @@ static picture_t *Filter( filter_t *, picture_t * ); "grayscaled. This must be an hexadecimal (like HTML colors). The first two "\ "chars are for red, then green, then blue. #000000 = black, #FF0000 = red,"\ " #00FF00 = green, #FFFF00 = yellow (red + green), #FFFFFF = white" ) +#define COLOR_HELP N_("Select one color in the video") static const int pi_color_values[] = { 0x00FF0000, 0x00FF00FF, 0x00FFFF00, 0x0000FF00, 0x000000FF, 0x0000FFFF }; @@ -66,6 +67,7 @@ static const char *const ppsz_color_descriptions[] = { vlc_module_begin () set_description( N_("Color threshold filter") ) set_shortname( N_("Color threshold" )) + set_help(COLOR_HELP) set_category( CAT_VIDEO ) set_subcategory( SUBCAT_VIDEO_VFILTER ) set_capability( "video filter2", 0 ) diff --git a/modules/video_filter/crop.c b/modules/video_filter/crop.c index 464a470a41..fe89d9ec84 100644 --- a/modules/video_filter/crop.c +++ b/modules/video_filter/crop.c @@ -76,6 +76,8 @@ static int FilterCallback ( vlc_object_t *, char const *, #define AUTOCROP_TEXT N_("Automatic cropping") #define AUTOCROP_LONGTEXT N_("Automatically detect black borders and crop them.") +#define CROP_HELP N_("Remove borders of the video and replace them by black borders") + #ifdef BEST_AUTOCROP #define RATIOMAX_TEXT N_("Ratio max (x 1000)") #define RATIOMAX_LONGTEXT N_("Maximum image ratio. The crop plugin will never automatically crop to a higher ratio (ie, to a more \"flat\" image). The value is x1000: 1333 means 4/3.") @@ -103,6 +105,7 @@ static int FilterCallback ( vlc_object_t *, char const *, vlc_module_begin () set_description( N_("Crop video filter") ) set_shortname( N_("Crop" )) + set_help(CROP_HELP) set_category( CAT_VIDEO ) set_subcategory( SUBCAT_VIDEO_VFILTER ) set_capability( "video filter", 0 ) diff --git a/modules/video_filter/erase.c b/modules/video_filter/erase.c index 55b26b3fde..5bbcfaede1 100644 --- a/modules/video_filter/erase.c +++ b/modules/video_filter/erase.c @@ -59,12 +59,15 @@ static int EraseCallback( vlc_object_t *, char const *, #define POSY_TEXT N_("Y coordinate") #define POSY_LONGTEXT N_("Y coordinate of the mask.") +#define ERASE_HELP N_("Remove zones of the video using a picture as mask") + #define CFG_PREFIX "erase-" vlc_module_begin () set_description( N_("Erase video filter") ) set_shortname( N_( "Erase" )) set_capability( "video filter2", 0 ) + set_help(ERASE_HELP) set_category( CAT_VIDEO ) set_subcategory( SUBCAT_VIDEO_VFILTER ) diff --git a/modules/video_filter/gaussianblur.c b/modules/video_filter/gaussianblur.c index 995b9290c5..735090202a 100644 --- a/modules/video_filter/gaussianblur.c +++ b/modules/video_filter/gaussianblur.c @@ -49,11 +49,14 @@ static void Destroy ( vlc_object_t * ); "Gaussian's standard deviation. The bluring will take " \ "into account pixels up to 3*sigma away in any direction.") +#define GAUSSIAN_HELP N_("Add a blurring effect") + #define FILTER_PREFIX "gaussianblur-" vlc_module_begin () set_description( N_("Gaussian blur video filter") ) set_shortname( N_( "Gaussian Blur" )) + set_help(GAUSSIAN_HELP) set_capability( "video filter2", 0 ) set_category( CAT_VIDEO ) set_subcategory( SUBCAT_VIDEO_VFILTER ) diff --git a/modules/video_filter/gradient.c b/modules/video_filter/gradient.c index 9fde41eae6..f83ff65417 100644 --- a/modules/video_filter/gradient.c +++ b/modules/video_filter/gradient.c @@ -70,6 +70,8 @@ static void FilterHough ( filter_t *, picture_t *, picture_t * ); #define CARTOON_LONGTEXT N_("Apply cartoon effect. It is only used by " \ "\"gradient\" and \"edge\".") +#define GRADIENT_HELP N_("Apply color gradient or edge detection effects") + static const char *const mode_list[] = { "gradient", "edge", "hough" }; static const char *const mode_list_text[] = { N_("Gradient"), N_("Edge"), N_("Hough") }; @@ -78,6 +80,7 @@ static const char *const mode_list_text[] = { N_("Gradient"), N_("Edge"), N_("Ho vlc_module_begin () set_description( N_("Gradient video filter") ) set_shortname( N_( "Gradient" )) + set_help(GRADIENT_HELP) set_capability( "video filter2", 0 ) set_category( CAT_VIDEO ) set_subcategory( SUBCAT_VIDEO_VFILTER ) diff --git a/modules/video_filter/grain.c b/modules/video_filter/grain.c index 92e0cfe50f..685af6fffc 100644 --- a/modules/video_filter/grain.c +++ b/modules/video_filter/grain.c @@ -45,12 +45,14 @@ static picture_t *Filter( filter_t *, picture_t * ); #define FILTER_PREFIX "grain-" +#define NOISE_HELP N_("add grain to image") /***************************************************************************** * Module descriptor *****************************************************************************/ vlc_module_begin () set_description( N_("Grain video filter") ) set_shortname( N_( "Grain" )) + set_help(NOISE_HELP) set_capability( "video filter2", 0 ) set_category( CAT_VIDEO ) set_subcategory( SUBCAT_VIDEO_VFILTER ) diff --git a/modules/video_filter/logo.c b/modules/video_filter/logo.c index 6b583c9f18..4903d85955 100644 --- a/modules/video_filter/logo.c +++ b/modules/video_filter/logo.c @@ -70,6 +70,8 @@ "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \ "also use combinations of these values, eg 6 = top-right).") +#define LOGO_HELP N_("Use a local picture as logo on the video") + #define CFG_PREFIX "logo-" static const int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 }; @@ -84,7 +86,7 @@ static void Close ( vlc_object_t * ); vlc_module_begin () set_category( CAT_VIDEO ) set_subcategory( SUBCAT_VIDEO_SUBPIC ) - + set_help(LOGO_HELP) set_capability( "sub filter", 0 ) set_callbacks( OpenSub, Close ) set_description( N_("Logo sub filter") ) diff --git a/modules/video_filter/marq.c b/modules/video_filter/marq.c index 43bba5c23b..f90dafa48e 100644 --- a/modules/video_filter/marq.c +++ b/modules/video_filter/marq.c @@ -139,12 +139,16 @@ static const char *const ppsz_pos_descriptions[] = #define CFG_PREFIX "marq-" +#define MARQUEE_HELP N_("Display text above the video") + /***************************************************************************** * Module descriptor *****************************************************************************/ vlc_module_begin () set_capability( "sub filter", 0 ) set_shortname( N_("Marquee" )) + set_description( N_("Marquee display") ) + set_help(MARQUEE_HELP) set_callbacks( CreateFilter, DestroyFilter ) set_category( CAT_VIDEO ) set_subcategory( SUBCAT_VIDEO_SUBPIC ) @@ -173,7 +177,6 @@ vlc_module_begin () add_integer( CFG_PREFIX "refresh", 1000, NULL, REFRESH_TEXT, REFRESH_LONGTEXT, false ) - set_description( N_("Marquee display") ) add_shortcut( "time" ) add_obsolete_string( "time-format" ) add_obsolete_string( "time-x" ) diff --git a/modules/video_filter/mirror.c b/modules/video_filter/mirror.c index 6d54149bf3..46b821674b 100644 --- a/modules/video_filter/mirror.c +++ b/modules/video_filter/mirror.c @@ -77,7 +77,7 @@ static const char *const ppsz_direction_descriptions[] = { vlc_module_begin () set_description( N_("Mirror video filter") ) set_shortname( N_("Mirror video" )) - set_help( N_("Splits video in two same parts, like in the mirror") ) + set_help( N_("Splits video in two same parts, like in a mirror") ) set_category( CAT_VIDEO ) set_subcategory( SUBCAT_VIDEO_VFILTER ) set_capability( "video filter2", 0 ) diff --git a/modules/video_filter/panoramix.c b/modules/video_filter/panoramix.c index 4c23398d6a..10b16e2e14 100644 --- a/modules/video_filter/panoramix.c +++ b/modules/video_filter/panoramix.c @@ -68,12 +68,16 @@ #define CFG_PREFIX "panoramix-" +#define PANORAMIX_HELP N_("Split the video in multiple windows to " \ + "display on a wall of screens") + static int Open ( vlc_object_t * ); static void Close( vlc_object_t * ); vlc_module_begin() set_description( N_("Panoramix: wall with overlap video filter") ) set_shortname( N_("Panoramix" )) + set_help(PANORAMIX_HELP) set_capability( "video splitter", 0 ) set_category( CAT_VIDEO ) set_subcategory( SUBCAT_VIDEO_VFILTER ) diff --git a/modules/video_filter/rss.c b/modules/video_filter/rss.c index f00eed1e36..af30af559e 100644 --- a/modules/video_filter/rss.c +++ b/modules/video_filter/rss.c @@ -167,6 +167,8 @@ struct filter_sys_t #define TITLE_TEXT N_("Title display mode") #define TITLE_LONGTEXT N_("Title display mode. Default is 0 (hidden) if the feed has an image and feed images are enabled, 1 otherwise.") +#define RSS_HELP N_("Display a RSS or ATOM Feed on your video") + static const int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 }; static const char *const ppsz_pos_descriptions[] = { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"), @@ -190,6 +192,7 @@ static const char *const ppsz_title_modes[] = vlc_module_begin () set_capability( "sub filter", 1 ) set_shortname( "RSS / Atom" ) + set_help(RSS_HELP) set_callbacks( CreateFilter, DestroyFilter ) set_category( CAT_VIDEO ) set_subcategory( SUBCAT_VIDEO_SUBPIC ) diff --git a/modules/video_filter/scene.c b/modules/video_filter/scene.c index 0e9a3f783f..532aae647e 100644 --- a/modules/video_filter/scene.c +++ b/modules/video_filter/scene.c @@ -85,11 +85,13 @@ static void SavePicture( filter_t *, picture_t * ); "creating one file per image. In this case, " \ "the number is not appended to the filename." ) +#define SCENE_HELP N_("Send your video to picture files") #define CFG_PREFIX "scene-" vlc_module_begin () set_shortname( N_( "Scene filter" ) ) set_description( N_( "Scene video filter" ) ) + set_help(SCENE_HELP) set_category( CAT_VIDEO ) set_subcategory( SUBCAT_VIDEO_VOUT ) set_capability( "video filter2", 0 ) diff --git a/modules/video_filter/sharpen.c b/modules/video_filter/sharpen.c index 587a0bd5d6..463a322519 100644 --- a/modules/video_filter/sharpen.c +++ b/modules/video_filter/sharpen.c @@ -56,14 +56,16 @@ static picture_t *Filter( filter_t *, picture_t * ); static int SharpenCallback( vlc_object_t *, char const *, vlc_value_t, vlc_value_t, void * ); +#define SHARPEN_HELP N_("Augment contrast between contours.") #define FILTER_PREFIX "sharpen-" /***************************************************************************** * Module descriptor *****************************************************************************/ vlc_module_begin () - set_description( N_("Augment contrast between contours.") ) - set_shortname( N_("Sharpen video filter") ) + set_description( N_("Sharpen video filter") ) + set_shortname( N_("Sharpen") ) + set_help(SHARPEN_HELP) set_category( CAT_VIDEO ) set_subcategory( SUBCAT_VIDEO_VFILTER ) set_capability( "video filter2", 0 ) diff --git a/modules/video_filter/transform.c b/modules/video_filter/transform.c index 9630e772b7..bf90947615 100644 --- a/modules/video_filter/transform.c +++ b/modules/video_filter/transform.c @@ -70,11 +70,13 @@ static const char *const type_list_text[] = { N_("Rotate by 90 degrees"), N_("Rotate by 180 degrees"), N_("Rotate by 270 degrees"), N_("Flip horizontally"), N_("Flip vertically") }; +#define TRANSFORM_HELP N_("Rotate or flip the video") #define CFG_PREFIX "transform-" vlc_module_begin () set_description( N_("Video transformation filter") ) set_shortname( N_("Transformation")) + set_help(TRANSFORM_HELP) set_capability( "video filter", 0 ) set_category( CAT_VIDEO ) set_subcategory( SUBCAT_VIDEO_VFILTER ) diff --git a/modules/video_output/msw/direct3d.c b/modules/video_output/msw/direct3d.c index 68d26c809d..ed3ba3b33c 100644 --- a/modules/video_output/msw/direct3d.c +++ b/modules/video_output/msw/direct3d.c @@ -58,14 +58,17 @@ static void Close(vlc_object_t *); #define DESKTOP_LONGTEXT N_(\ "The desktop mode allows you to display the video on the desktop.") +#define D3D_HELP N_("Recommended video output for Windows Vista and later versions") + vlc_module_begin () set_shortname("Direct3D") + set_description(N_("Direct3D video output")) + set_help(D3D_HELP) set_category(CAT_VIDEO) set_subcategory(SUBCAT_VIDEO_VOUT) add_bool("direct3d-desktop", false, NULL, DESKTOP_TEXT, DESKTOP_LONGTEXT, true) - set_description(N_("DirectX 3D video output")) set_capability("vout display", 70) add_shortcut("direct3d_xp") set_callbacks(OpenVideoXP, Close) diff --git a/modules/video_output/msw/directx.c b/modules/video_output/msw/directx.c index 82bbd4f5a7..be246c9e8c 100644 --- a/modules/video_output/msw/directx.c +++ b/modules/video_output/msw/directx.c @@ -155,11 +155,16 @@ BOOL WINAPI DirectXEnumCallback2( GUID* p_guid, LPTSTR psz_desc, "window to open on. For example, \"\\\\.\\DISPLAY1\" or " \ "\"\\\\.\\DISPLAY2\"." ) +#define DX_HELP N_("Recommended video output for Windows XP. " \ + "Incompatible with Vista's Aero interface" ) + static const char *const ppsz_dev[] = { "" }; static const char *const ppsz_dev_text[] = { N_("Default") }; vlc_module_begin () set_shortname( "DirectX" ) + set_description( N_("DirectX (DirectDraw) video output") ) + set_help(DX_HELP) set_category( CAT_VIDEO ) set_subcategory( SUBCAT_VIDEO_VOUT ) add_bool( "directx-hw-yuv", true, NULL, HW_YUV_TEXT, HW_YUV_LONGTEXT, @@ -174,7 +179,6 @@ vlc_module_begin () change_string_list( ppsz_dev, ppsz_dev_text, FindDevicesCallback ) change_action_add( FindDevicesCallback, N_("Refresh list") ) - set_description( N_("DirectX (DirectDraw) video output") ) set_capability( "video output", 100 ) add_shortcut( "directx" ) set_callbacks( OpenVideo, CloseVideo ) -- 2.39.2