ccollect:0.6.2->0.7.0
[nslu2-linux/optware.git] / sources / wizd / wizd.conf
bloba3f4ff22a6bf564698db93899b2d18c3bd497666
1 ## ===========================================================================
2 ## wizd.conf
3 ## wizd -- MediaWiz Server Daemon.  config file.
4 ## ===========================================================================
7 ## Enable/disable debug log output
8 flag_debug_log_output   false
9 debug_log_filename      /opt/var/log/wizd_debug.log
12 ## (Daemon conversion)
13 ##  This flag controls whether the server runs as a hidden application
14 ##  or if it runs with a console window
15 ##  hidden:   true  (default)
16 ##  console:  false
17 flag_daemon     false
21 ## ==============================
22 ##  =  HTTP processing section setting
23 ## ==============================
26 ## Base location for your media files
27 document_root   /opt/share/wizd/docroot
29 ## Aliases show up in the base location as virtual folders
30 ## When selected they get redirected to the path you enter here
31 ## Format:   alias  [name]  [path]
32 ## Under Windows, "/cygdrive/c/" and "c:\" are equivalent
33 ## You can list up to 16 aliases here
34 ## alias: allplay will play whatever files are present
35 ## moviealias: allplay defaults to video playlists
36 ## musicalias: allplay defaults to music playlists
37 ## photoalias: allplay defaults to photo playlists
38 ## secretalias: like a secret directory, but can take an absolute path
39 ##              and the 3-digit code can be used from any directory
41 #alias       DVD        /share/hdd/data/DVD
42 #alias       Internet   /share/hdd/data/favourites
43 #moviealias  HDTV       /share/hdd/data/movie
44 #musicalias  Music      /share/hdd/data/music
45 #photoalias  Photos     /share/hdd/data/photo
47 ## Enable this flag to allow file deletion from the LinkPlayer
48 ## To delete files, press the "setup" button on your remote TWICE
49 ## To exit from the delete mode (red screen), press the "stop" button
51 ##  false:   no file deletion allowed
52 ##  true:    can delete files from the client - Use with caution!!!
53 flag_allow_delete       false
55 ## server listening Port (default:8000)
56 ## Choose a number other than 8000 if you want to run
57 ## both wizd and Link Server at the same time
58 server_port     8004
60 ## Enable this flag to default the directory display to thumbnail mode
61 ## If this flag is false, then it will default to the details listing mode
62 ## (note this setting may be overridden in the skin configuration)
63 flag_default_thumb False
65 ## Set desired size for resized jpeg images
66 ## Set these to control the resolution of jpeg images sent from wizd
67 ## The width and height set the target screen size
68 ## The widen_ratio sets the pre-distortion to compensate for
69 ## screen distortion on the client (the LinkPlayer2)
70 ## The LinkPlayer2 in 4:3 mode uses bitmap size 720x480, or 3:2
71 ## (3/2)*1.125 = (4/3), widen_ratio 1.125 corrects the aspect ratio
72 ## Note: JPEG file sizes should be a multiple of 16, so 1088 is better than 1080
73 ## allow_crop will crop up to the specified percentage from the top/bottom
74 ## of the picture to fill up more of a 16:9 screen
75 ##    12% is the equivalent of the cropping on a 4x6 photo
76 ##    33% will make a digital photo fill the width of a 16:9 screen
78 ## For 4:3 480i or 480p output
79 #target_jpeg_width 720
80 #target_jpeg_height 480
81 #widen_ratio 1.125
83 ## For 720p output
84 #target_jpeg_width 1280
85 #target_jpeg_height 720
86 #widen_ratio 1
87 #allow_crop 12
89 ## For 1080i output
90 target_jpeg_width       1920
91 target_jpeg_height      1088
92 widen_ratio     1
93 allow_crop      12
95 ## Set this true to enable slide label display during slideshows
96 flag_slide_show_labels  false
98 ## Set the desired slideshow duration per slide, in seconds
99 slide_show_seconds      10
101 ## Set this to eliminate small thumbnail JPEG images from the slideshows
102 minimum_jpeg_size       50000
104 ## Access control IP (up to 32 lines)
105 ##  Only allow access from the addresses which are listed
106 ##  If there is no setting, all addresses are accepted
107 ##  The first set of numbers is the network address
108 ##  The second set of numbers is the netmask
109 #access_allow   192.168.0.0/255.255.255.0
110 #access_allow   192.168.1.0/255.255.255.0
113 ## User-Agent access control permission setting (to 32 lines)
114 ##   When defined, only the listed User-Agents are accepted
115 ##   If there is no setting, all User-Agents are accepted
116 #allow_user_agent       Syabas
117 #allow_user_agent       Mozilla
121 ## ===================================
122 ##  =  Indication department setting
123 ## ===================================
125 ## The language code of the LinkPlayer
126 ## This is the screen character code setting on the LinkPlayer side.
127 ## If this setting doesn't match the LinkPlayer setting,
128 ## then the characters displayed on the screen will be incorrect.
129 ## This setting affects non-english characters such as umlauts
130 ## and accents, in addition to supporting Japanese characters.
131 ## If you select "disabled" then there will be no conversion made.
133 ##     Shift JIS:sjis (default) Japanese code for encoding char
134 ##     EUC:      euc  (Extended Unix Code)
135 ##     UTF-8     utf8
136 ##     UTF-16    utf16
137 ##     Windows   windows
138 ##     Unix      unix
139 ##     no conversion:   disabled
140 client_language_code    disabled
143 ## The language code on the Server side (OS side)
144 ## This is the screen character code setting for you server (Operating System)
145 ## If this setting doesn't match the character set used by your server,
146 ## then he characters displayed on the screen will be incorrect.
147 ## This setting affects non-english characters such as umlauts
148 ## and accents, in addition to supporting Japanese characters.
149 ## If you select "disabled" then there will be no conversion made.
151 ##      default:  auto         (default)   (Automatic operation decision :)
152 ##      Japanese: sjis         (Shift JIS, not recommended. use AUTO)
153 ##      EUC:       euc          (Extended Unix Code)
154 ##      UTF-8      utf8         (Recommended for MacOSX/Fedora)
155 ##      UTF-16     utf16        (Not tested. Might not work)
156 ##      no conversion:  disabled
157 server_language_code    disabled
161 ## Skin settings.  This enabled the use of "skins" to change the appearance
162 ## of the program on your LinkPlayer screen.  You can modify the background
163 ## image, the font sizes, and the organization of the information displayed.
164 ##     true: skin used
165 ##     false (default): no skin used
166 flag_use_skin   true
169 ## Skin root is the base directory location where the skin files are stored.
170 ## Skin name is the subdirectory under skin_root for the selected skin.
171 ##  When using skins, if these directories do not exist, the server will 
172 ##  close immediately.
173 skin_root       /opt/share/wizd/skin
174 skin_name       linkplayer_hires
176 ## Define alternate skin names which are selected based on the User-Agent string
177 ## When the "Res624x416" string is matched, the "linkplayer" skin will be used
178 ## You can use any match string up to 64 characters long, and can include spaces
179 ## The match must be an exact match (case included) to a substring in the User-Agent
180 ## You can use this to use different skins for different player types,
181 ## or different skins for SD and HD browser modes
182 ## or different skins for different firmware versions
183 ## or even different skins for different players 
184 ##  (since the User-Agent string contains the unique MAC address of the player)
185 ## Turn on the debug log, and look in wizd_debug.log to see what your User-Agent string is
186 alternate_skin  linkplayer              Res624x416
187 alternate_skin  linkplayer_hires        Res1104x656
188 alternate_skin  linkplayer_hires        Mozilla
191 ## Rule setting of file sort with menu
192 ##      none (default)  (no sorting)
193 ##      name_up         Name (ascending order)
194 ##      name_down       Name (descending order)
195 ##      time_up         Date (ascending order)
196 ##      time_down       Date (descending order)
197 ##      size_up         Size (ascending order)
198 ##      size_down       Size (descending order)
199 sort_rule       name_up
202 ## The number of lines of page 1 of menu screen.
203 ## (default: 14)
204 ## (note this setting is usually overridden in the skin configuration)
205 #page_line_max  14
208 ## MAX length of displayed file name [ byte ] (excluding the extension)
209 ## Filenames longer than this limit will still work, but on the screen
210 ## they will be truncated so that they fit the screen.
211 ##      default:  (no restriction)
212 ## (note this setting is usually overridden in the skin configuration)
213 #menu_filename_length_max       40
216 ## Enable CAP/HEX encoding for use with samba
217 ## ":A2:97:b7:97:a7:82:bf:a3.avi" for example.
218 ## [ Note ] use with "server_language_code AUTO"
219 ## [ Note ] Samba is a Linux program that simulates Windows File Sharing
221 ##      enabled      true 
222 ##      disable      false(default)
223 #flag_decode_samba_hex_and_cap  true
226 ##  Hiding unknown file extensions
227 ##  When this setting is enabled, then any extensions which are not
228 ##  recognized by the program will be hidden, and will not be displayed
229 ##  on the LinkPlayer.  If you disable this setting, then you will
230 ##  be able to see all files, including the the files which you cannot play.
231 ##    hide:        true        (default)
232 ##    don't hide:  false 
233 flag_unknown_extention_file_hide        true
236 ## With file name, the parts surrounded by () [ ] are deleted
237 ## (As for deletion object only half angle parenthesis)
238 ## [ Example ] "masterpiece drama [ DivX5.05 ] (2).avi" -> "masterpiece drama.avi"
239 ##    enabled:    true  
240 ##    disabled:   false (default)
241 #flag_filename_cut_parenthesis_area     true
244 ## With file name, the identical character string as the directory name is deleted
245 ## [ Example ] "/masterpiece drama/masterpiece drama 1st story avi" -> "1st story avi"
246 ##    enabled    true
247 ##    disabled   false (default)
248 #flag_filename_cut_same_directory_name  true
251 ## Illegal character prevention with Allplay (all the slash/backslash conversions of file name)
252 ## [ Note ] MediaWiz firmware of old edition transforms, unless this setting is true.
253 ## As for new edition firmware, it works OK with the "false" setting
254 ## Apparently this is intended to work work around a bug in early versions of the
255 ## MediaWiz firmware.  Leave this setting "false"
256 ##    »ÈÍѤ¹¤ë    true
257 ##    ºï½ü¤·¤Ê¤¤  false(default)
258 flag_allplay_filelist_adjust    false
261 ## (Secret Directory)
262 ## up to 10 special hidden directories
263 ## Format:
264 ##  secret_directory directory_name TVID
265 ## 
266 ## When defined you can go to this directory by entering the 3-digit TVID directly
267 ## on the LinkPlayer remote control
268 ## The secret directory is just a directory name, NOT A COMPLETE PATH
269 ## and this link is only available when the named directory exists
270 ## in the current directory.
272 ## secret_directory <directory name> <TVID> (3-digit number)
273 #secret_directory       ero_movie       988
274 #secret_directory       ero_gazou       989
277 ## ---------------------------
278 ## - (SVI indication processing setting)
279 ## ---------------------------
281 ## Directory with identical name as the SVI file is hidden or not
282 ##      hide:           true 
283 ##      don't hide:     false(default)
284 flag_hide_same_svi_name_directory       false
287 ## (MAX length of SVI file information display (byte))
288 ##      default: (no restriction)
289 #menu_svi_info_length_max       100
292 ## ================================
293 ## Automatic server detection (SSDP processing) section setting
294 ## ================================
296 ## Automatic server detection.
297 ## When enabled, this will send out announcements to the network so the LinkPlayer
298 ## can recognize and connect to this server software automatically.
299 ## When disabled, you will need to manually configure the LinkPlayer to connect to this server. 
300 ##    enable:true  (default)
301 ##    disabled:false
302 flag_auto_detect        true
305 ## The server name which shows on the LinkPlayer server menu
306 server_name     Wizd
309 ## The host IP address which makes the SSDP server detection communication
310 ## Use this to force the server to operate on only one network segment, 
311 ## if you have multiple network segments.
312 ## In most cases the default automatic setting will work.
313 ##    Default: Automatic
314 #auto_detect_bind_ip_address    192.168.0.200
318 ## ============================
319 ## = (Complete monitoring system)
320 ## ============================
322 ## (Execution user/group setting)
323 ## UserID where wizd operates can be set. Only valid when root starts the server
324 ##  Default: user which starts the application
325 ## This is useful when running the server in Linux
326 ## For windows, leave these disabled
327 #exec_user      wizd
328 #exec_group     wizd
332 ## =================================
333 ## = Stream buffering configuration
334 ## =================================
336 ## (Block count of read cache buffer)
337 ## buffer_size is the block count of the disk cache buffer which is used for streaming
338 ## stream_chunk_size is the number of bytes in each block of the read buffer
339 ## socket_chunk_size is the number of bytes written to the network in each network write
340 ## flag_buffer_send_asap, if true, sends the bytes as soon as they are read from the file
341 ##                        if false, will continue reading until the buffer is full before writing
343 ## Recommended values:
344 ##   buffer_size        8
345 ##   stream_chunk_size  65536
346 ##   socket_chunk_size  32768
347 ##   flag_buffer_send_asap      false
348 buffer_size     8
349 stream_chunk_size       65536
350 socket_chunk_size       32768
351 flag_buffer_send_asap   false
353 ## Socket buffer sizes
354 ## The default is to use the value provided by the operating system
355 ## The value used is reported in the debug log output
356 ## Since the server sends large amounts of data, but receives little,
357 ## the sndbuf should be larger than the rcvbuf
358 ## In Windows XP you can use the Task Manager to view the network performance curves,
359 ## and then experiment with the numbers to see which numbers give the smoothest curves
360 ## The most important numbers are stream_sndbuf and stream_chunk_size
361 stream_rcvbuf   4096
362 stream_sndbuf   1048576
365 ## UserAgent proxy override
366 ## When defined, if a proxy server is detected, this UserAgent is assumed
367 ## Only one setting is allowed here
368 ##  default: not used
369 #user_agent_proxy_override      Syabas/03-84-031224-08-VTL-102-000/08-VTL (uCOS-II v2.05;NOS;KA9Q; 624x416,HiColor; www.syabas.com)
370 #user_agent_proxy_override      Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)
373 ## Restriction on the number of clients accepted at one time
374 ## Too many clients can cause serious problems in linux
375 ##  default: 0 (no restriction)
376 #max_child_count        2
379 ## CGI Execution: allow or not
380 ##  This allows server side scripts to be used.
381 ##  Server scripts are executable programs or scripts with the ".cgi" extension
382 ##  If you have cygwin and perl installed, then you can use perl scripts as well
383 ##    allow:true  (default)
384 ##    do not allow:false
385 flag_execute_cgi        false
388 ## (output error when executing CGI script)
389 # default: /dev/null
390 #debug_cgi_output       /dev/tty
391 #debug_cgi_output       /opt/var/log/wizd_cgi_debug.log
394 ## Proxy use
395 ## Enables operation through a proxy server
396 ##    Allow proxy: true  (default)
397 ##    Prohibit proxy: false
398 #flag_allow_proxy       false
401 ## User-Agent for PC connections
402 ##  User-Agent matching this string will be flagged as PC clients,
403 ##  and will have output adjusted to display better on PCs
404 # default: undefined
405 user_agent_pc   Mozilla
407 ## HTTP Basic authentication
408 ## Enable this to enable username/password authentication to limit access to the server
409 # usage    user:password
410 #http_passwd    wizd:hoge
412 ##  Adjust file name playlist for Windows, replaces the '\' with '/',
413 ##  case insensitive and sjis character set
414 ##      Adjust filenames:           true
415 ##      Leave filenames unchanged:  false (default)
416 flag_filename_adjustment_for_windows    true
418 ## Enable parsing mp3 files for ID3 tags
419 ## The ID3 tag information is then displayed in the playlist
420 ## and can be used in the skin display
421 flag_read_mp3_tag       true
423 ## Enable automatic combining of series of VOB files into a single virtual file
424 ## This allows you to play back DVD movies smoothly, without break between files
425 flag_show_first_vob_only        true
427 ## Enable single-chapter mode with DVD playback
428 ## When enabled, the LinkPlayer will pause for about 1 second between chapters
429 ## but you will have a little better navigation by chapter
430 ## Default: false
431 flag_split_vob_chapters false
433 ## Enable display of the audio stream information in DVD directories
434 flag_show_audio_info    true
436 ## Hide any DVD titles which are short (e.g. menus)
437 flag_hide_short_titles  true
439 ## Enable scanning of subdirectories when creating all play lists
440 ## true: will play files in current folder AND all subfolders
441 ## false: will play ONLY the files in the current folder
442 flag_allplay_includes_subdir    true
444 ## max_play_list_items   Set the maximum number of playlist items sent to the LinkPlayer
445 ## max_play_list_search  Set the maximum number of files found prior to randomly shuffling them
446 ## Generally you would want the search value to be high enough to cover all of your files,
447 ## so you get decent randomization of recursive allplay and shuffle playlists 
448 ## If the number of items is too high, it may take a long time to create the playlist
449 ## I think the LinkPlayer has a maximum playlist length of 9999 files?
450 ## The default items is 500
451 ## The default search is 2000
452 max_play_list_items     200
453 max_play_list_search    10000
455 ## Set the threshold over which bookmarks will be saved
456 ## Files smaller than this will not get bookmarks saved
457 ## When saving a bookmark, this number will be subtracted from the current file offset
458 ## to account for the buffer size in the LinkPlayer, so that playback will resume
459 ## at nearly the same position as it was stopped.
461 ## flag_goto_percent_video, when true, creates chapter points at 10% intervals for single-play video
462 ## flag_goto_percent_audio, when true, creates chapter points at 10% intervals for single-play mp3
464 ## define this as "0" to disable bookmarks
465 ## Default value is 10000000
466 bookmark_threshold      12000000
467 flag_bookmarks_only_for_mpeg    true
468 flag_goto_percent_video true
469 flag_goto_percent_audio false
471 ## Length of empty "dummy" chapters sent as placeholders to re-sync the
472 ## LinkPlayer position with the wizd position
473 ## If this value is 0, then no attempt is made to re-sync chapters
474 ## If this value is about 1000000 then the dummy chapters will show
475 ## just a little bit of the beginning of each chapter while it re-syncs
476 dummy_chapter_length    0
478 ## This flag sets how to open .vob files
479 ## true: to always use the libdvdread library to access vob files (more compatible)
480 ## false: directly access the vob files from the hard drive (faster)
481 flag_always_use_dvdopen false
483 # Mime type mapping to skin lines
484 # The skin type also effects how wizd handles the file.
485 # For example, "jpeg" type files are displayed differently from "image"
486 # The following skin line types are available:
488 #  unknown      ( everything else )
489 #  dir          ( directory )
490 #  pseudo       ( ²¾Áۥǥ£¥ì¥¯¥È¥ê )
492 #  document     ( text files )
493 #  url          ( internet explorer URL link files)
494 #  movie        ( streamed video )
495 #  music        ( streamed music )
496 #  image        ( bitmaps such as bmp, gif, png )
497 #  jpeg         ( photographs )
498 #  playlist     ( list of videos )
499 #  musiclist    ( list of songs )
500 #  svi          ( AVI video )
501 #  iso          ( ISO image file )
503 # Note: following are hard-coded in the program as internally required mappings
504 #  playlist (plw, pls, upl)
505 #  musiclist (m3u)
506 #  url: (url)
507 #  pseudo: (tsv)
509 #               ext.    mimetype        skinline
510 # Document types
511 mime_type       txt     text/plain      document
512 mime_type       htm     text/html       document 
513 mime_type       html    text/html       document
515 # Image types
516 mime_type       gif     image/gif       image
517 mime_type       png     image/png       image
518 mime_type       jpg     image/jpeg      jpeg
519 mime_type       jpeg    image/jpeg      jpeg
521 # SVI types
522 mime_type       svi     video/mpeg      svi
523 mime_type       sv3     video/mpeg      svi
525 # Video types
526 mime_type       avi     video/msvideo   movie
527 mime_type       mpg     video/mpeg      movie
528 mime_type       mpeg    video/mpeg      movie
529 mime_type       hnl     video/mpeg      movie
530 mime_type       nuv     video/mpeg      movie
531 mime_type       vob     video/mpeg      movie
532 mime_type       vro     video/mpeg      movie
533 mime_type       ts      video/mpeg      movie
534 mime_type       tp      video/mpeg      movie
535 mime_type       m2t     video/mpeg      movie
536 mime_type       mov     video/quicktime movie
537 mime_type       wmv     video/x-ms-wmv  movie
538 mime_type       asf     video/x-ms-wmx  movie
539 mime_type       divx    video/divx5     movie
540 mime_type       mp4     video/divx5     movie
542 # ISO images
543 mime_type       iso     video/mpeg      iso
544 mime_type       img     video/mpeg      iso
546 # Audio types
547 mime_type       mp3     audio/x-mpeg    music
548 mime_type       ogg     audio/x-ogg     music
549 mime_type       wma     audio/x-ms-wma  music
550 mime_type       wav     audio/x-wav     music
551 mime_type       ac3     audio/ac3       music
552 mime_type       m4a     audio/x-m4a     music
555 # Filename extension remapping
556 # Note: this only changes the name of the file as it is reported to the client
557 # It does not change how the file is interpreted on the server,
558 # so the mime_type for the original extension will be used
559 # so the original extension MUST have a mime_type defined for it
561 #               orig    served
562 ext_remap       m2p     mpg
563 ext_remap       m2t     ts
564 ext_remap       tp      ts
565 ext_remap       mpeg    mpg
566 ext_remap       jpeg    jpg
568 ## ===========================================================================
569 ## = wizd -- end of config file.
570 ## ===========================================================================