plugins/admin/templates/settings.tmpl

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">\r
   2 <html>\r
   3 <head>\r
   4 \r
   5   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">\r
   6   <title>pyTivo Web Configuration</title>\r
   7 \r
   8 \r
   9   <script language="javascript" type="text/javascript">\r
  10 function switchDiv(pass, type){ hideallids(type);\r
  11 showDiv(pass);\r
  12 }\r
  13 function hideallids(type){\r
  14 //loop through the array and hide each element by id\r
  15 var divs = document.getElementsByTagName('div');\r
  16 for (var i=0;i<divs.length;i++){\r
  17 if(divs[i].id.match(type)){\r
  18 hideDiv(divs[i].id);\r
  19 }\r
  20 } }\r
  21 function hideDiv(pass) {\r
  22 var divs = document.getElementsByTagName('div');\r
  23 for(i=0;i<divs.length;i++){\r
  24 if(divs[i].id.match(pass)){//if they are 'see' divs\r
  25 if (document.getElementById) // DOM3 = IE5, NS6\r
  26 divs[i].style.visibility="hidden";// show/hide\r
  27 else\r
  28 if (document.layers) // Netscape 4\r
  29 document.layers[divs[i]].display = 'hidden';\r
  30 else // IE 4\r
  31 document.all.hideshow.divs[i].visibility = 'hidden';\r
  32 }\r
  33 }\r
  34 }\r
  35 function showDiv(pass) {\r
  36 var divs = document.getElementsByTagName('div');\r
  37 for(i=0;i<divs.length;i++){\r
  38 if(divs[i].id == pass){\r
  39 if (document.getElementById)\r
  40 divs[i].style.visibility="visible";\r
  41 else\r
  42 if (document.layers) // Netscape 4\r
  43 document.layers[divs[i]].display = 'visible';\r
  44 else // IE 4\r
  45 document.all.hideshow.divs[i].visibility = 'visible';\r
  46 }\r
  47 }\r
  48 }\r
  49   </script>\r
  50 </head>\r
  51 \r
  52 \r
  53 <body style="background-color: rgb(250, 250, 250);">\r
  54 \r
  55 <p align="center"><font size="6">pyTivo Web\r
  56 Configuration</font> <a href="#">help</a></p>\r
  57 <center>\r
  58 <table style="background-color: rgb(255, 255, 255);text-align: left; margin-left: auto; margin-right: auto;" border="0" cellpadding="0" cellspacing="4">\r
  59 \r
  60   <tbody>\r
  61 \r
  62     <tr>\r
  63 \r
  64       <td style="border-right: 1px dotted rgb(153, 153, 153); vertical-align: top;">\r
  65       <div id="leftframe" style="position: relative; text-align: center; width: 200px;">\r
  66       <form name="select_section">Sections\r
  67         <select name="section" size="7">\r
  68         <option value="set-server">Global Server Settings</option>\r
  69 #for $name, $data in $shares_data\r
  70         <option value="set-share-$name">$name</option>\r
  71 #end for\r
  72 #for $name, $data in $tivos_data\r
  73         <option value="set-tivo-$name">$name</option>\r
  74 #end for\r
  75         </select>\r
  76 \r
  77         <input name="B3" value="Edit Section" type="button" onclick="switchDiv(select_section.section.options[select_section.section.selectedIndex].value, 'set-');return true;"> <input name="B1" value="Delete Section" type="button"><input name="B2" value="Add Section" type="button"></form>\r
  78 \r
  79       <hr>Administration\r
  80       <form method="post">\r
  81         <p align="center"><input name="B1" value="Save Changes" type="button"><input name="B2" value="Restart pyTivo" type="submit"></p>\r
  82 \r
  83       </form>\r
  84 \r
  85 View Raw File </div>\r
  86 \r
  87       </td>\r
  88 \r
  89       <td style="vertical-align: top;">\r
  90       <div id="settings" style="width: 300px; overflow: scroll; height: 450px; position: relative;">\r
  91       <form method="post">\r
  92         <div id="set-server" style="width: 280px; text-align: center;position: absolute; left: 0px; top: 0px; visibility: hidden;"><b>Global\r
  93 Server Settings</b><br>\r
  94 \r
  95         <hr style="width: 100%; height: 2px;"> \r
  96         <table align="center">\r
  97 #set $i = 0\r
  98 #for $key in $server_known\r
  99 #set $i += 1\r
 100 #if $i%2\r
 101 <tr style="background-color: rgb(250, 250, 250);">\r
 102 #else\r
 103 <tr>\r
 104 #end if\r
 105 <td>\r
 106 #if $key in $server_data\r
 107         <p>$key :</td><td><input size="20" name="$key" value="$server_data[$key]" onfocus="switchDiv('help-$key', 'help-');return true;" type="text"></p>\r
 108 \r
 109 #else\r
 110         <p>$key :</td><td><input size="20" name="$key" value="" onfocus="switchDiv('help-$key', 'help-');return true;" type="text"></p>\r
 111 \r
 112 #end if\r
 113 </td></tr>\r
 114 #end for\r
 115 <tr><td colspan="2" align="center" style="border-bottom: 1px solid rgb(153, 153, 153);">User Defined Settings:</td></tr>        \r
 116 #set $i = 0\r
 117 #for $key in $server_data \r
 118         #if not $key in $server_known\r
 119                 #set $i += 1\r
 120                 #if $i%2\r
 121                         <tr style="background-color: rgb(250, 250, 250);">\r
 122                 #else\r
 123                         <tr>\r
 124                 #end if\r
 125                 <td>        <p> $key :</td><td>\r
 126                 <input size="20" name="$key" value="$server_data[$key]" onfocus="switchDiv('help-$key', 'help-');return true;" type="text"></p>\r
 127                 </td></tr>\r
 128         #end if \r
 129 #end for \r
 130         </table> </div>\r
 131 \r
 132 #for $name, $data in $shares_data\r
 133         <div id="set-share-$name" style="text-align: center;position: absolute; left: 0px; top: 0px; visibility: hidden;">[<input size="20" name="title" value="$name">]<br>\r
 134         <hr style="width: 100%; height: 2px;"><table align="center">\r
 135         #set $i = 0\r
 136         #for $key in $shares_known\r
 137                 #set $i += 1\r
 138                 #if $i%2\r
 139                         <tr style="background-color: rgb(250, 250, 250);">\r
 140                 #else\r
 141                         <tr>\r
 142                 #end if\r
 143                 #if $key in $data\r
 144                         <td><p>$key :</td><td><input size="20" name="$key" value="$data[$key]" onfocus="switchDiv('help-$key', 'help-');return true;" type="text"></p>\r
 145                         </td>\r
 146                 #else\r
 147                         <td><p>$key : </td><td><input size="20" name="$key" value="" onfocus="switchDiv('help-$key', 'help-');return true;" type="text"></p>\r
 148                         </td>\r
 149                 #end if\r
 150                 </tr>\r
 151         #end for\r
 152 \r
 153         <tr><td colspan="2" align="center" style="border-bottom: 1px solid rgb(153, 153, 153);">User Defined Settings:</td></tr> \r
 154         #set $i = 0\r
 155         #for $key in $data \r
 156                 #if not $key in $shares_known\r
 157                         #set $i += 1\r
 158                         #if $i%2\r
 159                                 <tr style="background-color: rgb(250, 250, 250);">\r
 160                         #else\r
 161                                 <tr>\r
 162                         #end if\r
 163                         <td><p> $key : </td><td>\r
 164                         <input size="20" name="$key" value="$data[$key]" onfocus="switchDiv('help-$key', 'help-');return true;" type="text"></p>\r
 165                         </td></tr>\r
 166                 #end if \r
 167         #end for\r
 168         </table>\r
 169         </div>\r
 170 #end for\r
 171 \r
 172 #for $name, $data in $tivos_data\r
 173         <div id="set-tivo-$name" style="text-align: center;position: absolute; left: 0px; top: 0px; visibility: hidden;">[<input size="20" name="title" value="$name">]<br>\r
 174         <hr style="width: 100%; height: 2px;"><table align="center">\r
 175         #set $i = 0\r
 176         #for $key in $tivos_known\r
 177                 #set $i += 1\r
 178                 #if $i%2\r
 179                         <tr style="background-color: rgb(250, 250, 250);">\r
 180                 #else\r
 181                         <tr>\r
 182                 #end if\r
 183                 #if $key in $data\r
 184                         <td><p>$key :</td><td><input size="20" name="$key" value="$data[$key]" onfocus="switchDiv('help-$key', 'help-');return true;" type="text"></p>\r
 185                         </td>\r
 186                 #else\r
 187                         <td><p>$key :</td><td><input size="20" name="$key" value="" onfocus="switchDiv('help-$key', 'help-');return true;" type="text"></p>\r
 188                         </td>\r
 189                 #end if\r
 190                 </tr>\r
 191         #end for\r
 192 \r
 193         <tr><td colspan="2" align="center" style="border-bottom: 1px solid rgb(153, 153, 153);">User Defined Settings:</td></tr> \r
 194         #set $i = 0\r
 195         #for $key in $data \r
 196                 #if not $key in $tivos_known\r
 197                         #set $i += 1\r
 198                         #if $i%2\r
 199                                 <tr style="background-color: rgb(250, 250, 250);">\r
 200                         #else\r
 201                                 <tr>\r
 202                         #end if\r
 203                         <td><p> $key :</td><td> \r
 204                         <input size="20" name="$key" value="$data[$key]" onfocus="switchDiv('help-$key', 'help-');return true;" type="text"></p>\r
 205                         </td></tr>\r
 206                 #end if \r
 207         #end for\r
 208         </table>\r
 209         </div>\r
 210 #end for\r
 211 \r
 212       </form>\r
 213 \r
 214       </div>\r
 215 \r
 216       </td>\r
 217 \r
 218       <td style="border-left: 1px dotted rgb(153, 153, 153); vertical-align: top;">\r
 219       <div id="sidesections" style="width: 400px; position: relative;"><!-- HELP SECTIONS -->\r
 220       <div id="help-instructions" style="position: absolute; left: 0px; top: 0px; visibility: visible;">\r
 221       <p align="center"><strong>Instructions</strong>\r
 222       </p>\r
 223 \r
 224 Instructions and sample settings will appear here when you click on the\r
 225 settings boxes</div>\r
 226 \r
 227       <div id="help-port" style="position: absolute; left: 0px; top: 0px; visibility: hidden;">\r
 228       <p align="center"><strong>port</strong> </p>\r
 229 \r
 230       <p> <strong>Default Setting:</strong> None,\r
 231 must be entered. Distributed conf file uses 9032<br>\r
 232 \r
 233       <strong>Valid Entries:</strong> Valid port number<br>\r
 234 \r
 235       <strong>Required:</strong> Yes, without a port\r
 236 setting in the conf file pyTivo will not start.<br>\r
 237 \r
 238       <strong>Skill:</strong> Basic<br>\r
 239 \r
 240       <strong>Description:</strong> The port which pyTivo\r
 241 uses to serve your files. Can be changed if it conflicts with another\r
 242 program. It is reported on Ubuntu that this port is already used so you\r
 243 may need to change it to something like port=9254.<br>\r
 244 \r
 245       <strong>Example Settings:</strong> 9032 </p>\r
 246 \r
 247       </div>\r
 248 \r
 249       <div id="help-guid" style="position: absolute; left: 0px; top: 0px; visibility: hidden;">\r
 250       <p align="center"><strong>guid</strong> </p>\r
 251 \r
 252       <p> <strong>Default Setting:</strong> 123456<br>\r
 253 \r
 254       <strong>Valid Entries:</strong> Any 6 digit number<br>\r
 255 \r
 256       <strong>Required:</strong> Generally NO, will default\r
 257 to '123456' if left blank. If you use more than one pyTivo server on\r
 258 the same network a different random number is required here.<br>\r
 259 \r
 260       <strong>Skill:</strong> Advanced<br>\r
 261 \r
 262       <strong>Description:</strong> A unique identifier\r
 263 used in the beacon to identify this server. If you have 2 or more\r
 264 pyTivo servers on one network each server must use its own unique\r
 265 identifier.<br>\r
 266 \r
 267       <strong>Example Settings:</strong> Any 6 digit\r
 268 number. </p>\r
 269 \r
 270       </div>\r
 271 \r
 272       <div id="help-ffmpeg" style="position: absolute; left: 0px; top: 0px; visibility: hidden;">\r
 273       <p align="center"><strong>ffmpeg</strong>\r
 274       </p>\r
 275 \r
 276       <p> <strong>Default Setting:</strong> There is\r
 277 none.<br>\r
 278 \r
 279       <strong>Valid Entries:</strong> Operating system path<br>\r
 280 \r
 281       <strong>Required:</strong> Yes! <br>\r
 282 \r
 283       <strong>Skill:</strong> Basic<br>\r
 284 \r
 285       <strong>Description:</strong> This is the full path\r
 286 to your ffmpeg binary. For windows users ffmpeg is distributed with\r
 287 pyTivo and is in the plugins/video folder<br>\r
 288 \r
 289       <strong>Example Settings:</strong> <span class="underline">Linux</span> = /usr/bin/ffmpeg | <span class="underline">Windows</span> = c:\Program\r
 290 Files\pyTivo\plugins\video\ffmpeg_mp2.exe </p>\r
 291 \r
 292       </div>\r
 293 \r
 294       <div id="help-beacon" style="position: absolute; left: 0px; top: 0px; visibility: hidden;">\r
 295       <p align="center"><strong>beacon</strong>\r
 296       </p>\r
 297 \r
 298       <p> <strong>Default Setting:</strong>\r
 299 255.255.255.255<br>\r
 300 \r
 301       <strong>Valid Entries:</strong> A Subnet or Listen<br>\r
 302 \r
 303       <strong>Required:</strong> No, defaults to\r
 304 255.255.255.255<br>\r
 305 \r
 306       <strong>Skill:</strong> Advanced<br>\r
 307 \r
 308       <strong>Description:</strong> The subnet which the\r
 309 beacon should broadcast on. Most people can leave this at the default\r
 310 setting. If set to listen will accept incoming TCP requests.<br>\r
 311 \r
 312       <strong>Example Settings:</strong> 255.255.255.255 </p>\r
 313 \r
 314       </div>\r
 315 \r
 316       <div id="help-hack83" style="position: absolute; left: 0px; top: 0px; visibility: hidden;">\r
 317       <p align="center"><strong>hack83</strong>\r
 318       </p>\r
 319 \r
 320       <p> <strong>Default Setting:</strong> False<br>\r
 321 \r
 322       <strong>Valid Entries:</strong> True/False<br>\r
 323 \r
 324       <strong>Required:</strong> No<br>\r
 325 \r
 326       <strong>Skill:</strong> Moderate<br>\r
 327 \r
 328       <strong>Description:</strong> Available in the <a class="wiki" href="/wiki/SubFoldersBranch">SubFoldersBranch</a>.\r
 329 Allows TiVos with software 8.3 and above to display subfolders as users\r
 330 are accustomed too prior to the 8.3Software glitch. If you use this\r
 331 then you don't need to use <a href="http://pytivo.armooo.net/wiki/ConfigurepyTivo#auto_subshares">auto_subshares</a>.\r
 332       <strong>Warning:</strong> navigating folders too fast\r
 333 with this setting enabled may cause <a class="wiki" href="/wiki/TiVo">TiVo</a> to reboot. <br>\r
 334 \r
 335       <strong>Example Settings:</strong> True/False </p>\r
 336 \r
 337       </div>\r
 338 \r
 339       <div id="help-debug" style="position: absolute; left: 0px; top: 0px; visibility: hidden;">\r
 340       <p align="center"><strong>debug</strong>\r
 341       </p>\r
 342 \r
 343       <p> <strong>Default Setting:</strong> False<br>\r
 344 \r
 345       <strong>Valid Entries:</strong> True/False<br>\r
 346 \r
 347       <strong>Required:</strong> No<br>\r
 348 \r
 349       <strong>Skill:</strong> Advanced<br>\r
 350 \r
 351       <strong>Description:</strong> Will create a file\r
 352 named debug.txt in the base folder of pyTivo. This file will contain\r
 353 debug information helpful in diagnosing problems. Generally only\r
 354 necessary if you are having a problem and the information is requested\r
 355 by support staff.<br>\r
 356 \r
 357       <strong>Example Settings:</strong> True/False </p>\r
 358 \r
 359       </div>\r
 360 \r
 361       <div id="help-optres" style="position: absolute; left: 0px; top: 0px; visibility: hidden;">\r
 362       <p align="center"><strong>optres</strong>\r
 363       </p>\r
 364 \r
 365       <p> <strong>Default Setting:</strong> False<br>\r
 366 \r
 367       <strong>Valid Entries:</strong> True/False<br>\r
 368 \r
 369       <strong>Required:</strong> No<br>\r
 370 \r
 371       <strong>Skill:</strong> Moderate<br>\r
 372 \r
 373       <strong>Description:</strong> Allows for the use of\r
 374 the Optimal Resolution in transcoding. By setting optes = true pyTivo\r
 375 will treat the <a href="http://pytivo.armooo.net/wiki/ConfigurepyTivo#height">height</a>\r
 376 and <a href="http://pytivo.armooo.net/wiki/ConfigurepyTivo#width">width</a>\r
 377 settings in the conf file as a maximum. If the video to be transcoded\r
 378 has smaller dimensions that are closer to other acceptable TiVo\r
 379 dimensions then pyTivo will use these dimensions. This allows for\r
 380 faster transcoding and small files when the initial video is a lower\r
 381 quality.<br>\r
 382 \r
 383       <strong>Example Settings:</strong> True/False </p>\r
 384 \r
 385       </div>\r
 386 \r
 387       <div id="help-audio_br" style="position: absolute; left: 0px; top: 0px; visibility: hidden;">\r
 388       <p align="center"><strong>audio_br</strong>\r
 389       </p>\r
 390 \r
 391       <p> <strong>Default Setting:</strong> 192K<br>\r
 392 \r
 393       <strong>Valid Entries:</strong> Any valid Bit rate.\r
 394 Up to 384K for SD TiVos. Up to 448K for HD TiVos.<br>\r
 395 \r
 396       <strong>Required:</strong> No<br>\r
 397 \r
 398       <strong>Skill:</strong> Advanced<br>\r
 399 \r
 400       <strong>Description:</strong> This allows you to\r
 401 choose the default server audio bit rate used in transcoding. The\r
 402 default is likely fine for most users. Users with HD units and high\r
 403 quality videos to transcode will want to use higher value. Higher\r
 404 values may slow down transcoding and will increase the file size.\r
 405 Increased file sizes take up more room on the <a class="wiki" href="/wiki/TiVo">TiVo</a> and take longer to transfer\r
 406 over the network.<br>\r
 407 \r
 408       <strong>Example Settings:</strong> 192K, 384K, 448K. </p>\r
 409 \r
 410       </div>\r
 411 \r
 412       <div id="help-max_audio_br" style="position: absolute; left: 0px; top: 0px; visibility: hidden;">\r
 413       <p align="center"><strong>max_audio_br</strong>\r
 414       </p>\r
 415 \r
 416       <p> <strong>Default Setting:</strong> 448K<br>\r
 417 \r
 418       <strong>Valid Entries:</strong> Any valid Bit rate. <br>\r
 419 \r
 420       <strong>Required:</strong> No<br>\r
 421 \r
 422       <strong>Skill:</strong> Advanced<br>\r
 423 \r
 424       <strong>Description:</strong> This sets the maximum\r
 425 audio bit rate that can be sent to the <a class="wiki" href="/wiki/TiVo">TiVo</a>. Files having a higher bit\r
 426 rate will be transcoded to ensure <a class="wiki" href="/wiki/TiVo">TiVo</a> compatibilty. <br>\r
 427 \r
 428       <strong>Example Settings:</strong> 384K, 448K. </p>\r
 429 \r
 430       </div>\r
 431 \r
 432       <div id="help-video_br" style="position: absolute; left: 0px; top: 0px; visibility: hidden;">\r
 433       <p align="center"><strong>video_br</strong>\r
 434       </p>\r
 435 \r
 436       <p> <strong>Default Setting:</strong> 4096K\r
 437 for SD <a class="wiki" href="/wiki/TiVo">TiVo</a>'s,\r
 438 8192K for HD <a class="wiki" href="/wiki/TiVo">TiVo</a>'s<br>\r
 439 \r
 440       <strong>Valid Entries:</strong> Any valid Bit rate.\r
 441 1024K = 1Mi<br>\r
 442 \r
 443       <strong>Required:</strong> No<br>\r
 444 \r
 445       <strong>Skill:</strong> Advanced<br>\r
 446 \r
 447       <strong>Description:</strong> This allows you to\r
 448 choose the default server video bit rate used in transcoding. FFmpeg\r
 449 does not strictly follow this bit rate, there is a certain level of\r
 450 tolerance that is allowed. Also a low quality file will always have a\r
 451 low bit rate. The default is likely fine for most users. Higher values\r
 452 may slow down transcoding and will increase the file size. Increased\r
 453 file sizes take up more room on the <a class="wiki" href="/wiki/TiVo">TiVo</a> and take longer to transfer\r
 454 over the network.<br>\r
 455 \r
 456       <strong>Example Settings:</strong> 4096K, 8Mi, 12Mi </p>\r
 457 \r
 458       </div>\r
 459 \r
 460       <div id="help-max_video_br" style="position: absolute; left: 0px; top: 0px; visibility: hidden;">\r
 461       <p align="center"><strong>max_video_br</strong>\r
 462       </p>\r
 463 \r
 464       <p> <strong>Default Setting:</strong> 17408k<br>\r
 465 \r
 466       <strong>Valid Entries:</strong> Any valid Bit rate.\r
 467 1024K = 1Mi<br>\r
 468 \r
 469       <strong>Required:</strong> No<br>\r
 470 \r
 471       <strong>Skill:</strong> Advanced<br>\r
 472 \r
 473       <strong>Description:</strong> This allows you to\r
 474 choose the maximum bit rate and is more strict than the <a href="http://pytivo.armooo.net/wiki/ConfigurepyTivo#video_br">video_br</a>\r
 475 setting above. However setting this can cause buffer overflows and can\r
 476 cause issues with ffmpeg. In addition to setting the ffmpeg maxrate\r
 477 option, this setting is used to determine if the video bitrate of the\r
 478 source video file is too high for the <a class="wiki" href="/wiki/TiVo">TiVo</a>. Otherwise compatible\r
 479 mpeg's with a video bitrate above this setting will be transcoded\r
 480 rather than sent to the <a class="wiki" href="/wiki/TiVo">TiVo</a>\r
 481 untouched. Raising this setting much higher than the default will likly\r
 482 result in pixelation during playback. Recommended only for skilled\r
 483 users. <strong>Note:</strong> there is a report that\r
 484 ffmpeg throws an error with 17Mi but accepts 17408K just fine. <br>\r
 485 \r
 486       <strong>Example Settings: 17408k</strong> </p>\r
 487 \r
 488       </div>\r
 489 \r
 490       <div id="help-width" style="position: absolute; left: 0px; top: 0px; visibility: hidden;">\r
 491       <p align="center"><strong>width</strong>\r
 492       </p>\r
 493 \r
 494       <p> <strong>Default Setting:</strong> 544<br>\r
 495 \r
 496       <strong>Valid Entries:</strong> Any valid pixel\r
 497 dimension. Setting will be rounded to nearest acceptable <a class="wiki" href="/wiki/TiVo">TiVo</a>\r
 498 dimension<br>\r
 499 \r
 500       <strong>Required:</strong> No<br>\r
 501 \r
 502       <strong>Skill:</strong> Moderate<br>\r
 503 \r
 504       <strong>Description:</strong> Allows you to choose\r
 505 the output dimension of the transcoded videos. SD units are limited to\r
 506 544 and below. Likely HD users will want to choose a higher value.\r
 507 Higher values may slow down transcoding and will increase the file\r
 508 size. Increased file sizes take up more room on the TiVo and take\r
 509 longer to transfer over the network.<br>\r
 510 \r
 511       <strong>Example Settings:</strong> 1920, 1440, 1280,\r
 512 720, 704, 544, 480, 352. </p>\r
 513 \r
 514       </div>\r
 515 \r
 516       <div id="help-height" style="position: absolute; left: 0px; top: 0px; visibility: hidden;">\r
 517       <p align="center"><strong>height</strong>\r
 518       </p>\r
 519 \r
 520       <p> <strong>Default Setting:</strong> 480<br>\r
 521 \r
 522       <strong>Valid Entries:</strong> Any valid pixel\r
 523 dimension. Setting will be rounded to nearest acceptable <a class="wiki" href="/wiki/TiVo">TiVo</a>\r
 524 dimension<br>\r
 525 \r
 526       <strong>Required:</strong> No<br>\r
 527 \r
 528       <strong>Skill:</strong> Moderate<br>\r
 529 \r
 530       <strong>Description:</strong> Allows you to choose\r
 531 the output dimension of the transcoded videos. SD units are limited to\r
 532 480 and below. Likely HD users will want to choose a higher value.\r
 533 Higher values may slow down transcoding and will increase the file\r
 534 size. Increased file sizes take up more room on the TiVo and take\r
 535 longer to transfer over the network.<br>\r
 536 \r
 537       <strong>Example Settings:</strong> 1080, 720, 480 </p>\r
 538 \r
 539       </div>\r
 540 \r
 541       <div id="help-ffmpeg_prams" style="position: absolute; left: 0px; top: 0px; visibility: hidden;">\r
 542       <p align="center"><strong>ffmpeg_prams</strong>\r
 543       </p>\r
 544 \r
 545       <p> <strong>Default Setting:</strong> -vcodec\r
 546 mpeg2video -r 29.97 -b %(video_br)s -maxrate %(max_video_br)s -bufsize\r
 547 %(buff_size)s %(aspect_ratio)s -comment pyTivo.py -ac 2 -ab\r
 548 %(audio_br)s -ar 44100 -f vob -<br>\r
 549 \r
 550       <strong>Valid Entries:</strong> A valid ffmpeg command<br>\r
 551 \r
 552       <strong>Required:</strong> No<br>\r
 553 \r
 554       <strong>Skill:</strong> Very Advanced<br>\r
 555 \r
 556       <strong>Description:</strong> This allows you to\r
 557 control the parameters passed to ffmpeg. Most users will be just fine\r
 558 with the default setting. Some HD users are experimenting with the\r
 559 following line:<br>\r
 560 \r
 561 -vcodec mpeg2video -maxrate %(max_video_br)s -qscale 1.2 -bufsize\r
 562 %(buff_size)s -comment pyTivo.py -acodec ac3 -ab %(audio_br)s -ar 48000\r
 563 -f vob -<br>\r
 564 \r
 565 The major difference is that this does not alter the dimensions of the\r
 566 video. The native height and width setting of the video used to\r
 567 transcode the video. This will only work for HD and S3 units. So far\r
 568 there has not been any report of dimensions which the HD units will not\r
 569 accept. Additionally this line increases the audio frequency setting to\r
 570 48000 too. <strong>Example Settings:</strong> See Above\r
 571 and the forum. </p>\r
 572 \r
 573       </div>\r
 574 \r
 575       <div id="help-bufsize" style="position: absolute; left: 0px; top: 0px; visibility: hidden;">\r
 576       <p align="center"><strong>bufsize</strong>\r
 577       </p>\r
 578 \r
 579       <p> <strong>Default Setting:</strong> 1024k<br>\r
 580 \r
 581       <strong>Valid Entries:</strong> Any valid byte size<br>\r
 582 \r
 583       <strong>Required:</strong> No<br>\r
 584 \r
 585       <strong>Skill:</strong> Very Advanced<br>\r
 586 \r
 587       <strong>Description:</strong> Allows you to set the\r
 588 buffer size used by ffmpeg. I don't know much about this setting, but\r
 589 from what I can tell it is rather touchy and should only be edited by\r
 590 advanced users.<br>\r
 591 \r
 592       <strong>Example Settings:</strong> 1024k<br>\r
 593 \r
 594       </p>\r
 595 \r
 596       </div>\r
 597 \r
 598       <div id="help-type" style="position: absolute; left: 0px; top: 0px; visibility: hidden;">\r
 599       <p align="center"><strong>type</strong> </p>\r
 600 \r
 601       <p> <strong>Default Setting:</strong> None<br>\r
 602 \r
 603       <strong>Valid Entries:</strong> Video, Music, or any\r
 604 other valid plugin name.<br>\r
 605 \r
 606       <strong>Required:</strong> Yes<br>\r
 607 \r
 608       <strong>Skill:</strong> Basic<br>\r
 609 \r
 610       <strong>Description:</strong> Sets the type of share\r
 611 that this will be. This must be set to something otherwise pyTivo will\r
 612 not start.<br>\r
 613 \r
 614       <strong>Example Settings:</strong> Video or Music </p>\r
 615 \r
 616       </div>\r
 617 \r
 618       <div id="help-path" style="position: absolute; left: 0px; top: 0px; visibility: hidden;">\r
 619       <p align="center"><strong>path</strong> </p>\r
 620 \r
 621       <p> <strong>Default Setting:</strong> None<br>\r
 622 \r
 623       <strong>Valid Entries:</strong> Any operating system\r
 624 path<br>\r
 625 \r
 626       <strong>Required:</strong> Yes<br>\r
 627 \r
 628       <strong>Skill:</strong> Basic<br>\r
 629 \r
 630       <strong>Description:</strong> Sets the base path to\r
 631 your media content. While pyTivo will start with an invalid path your\r
 632 shares will not work at all.<br>\r
 633 \r
 634       <strong>Example Settings:</strong> <span class="underline">Windows</span> = C:\videos | <span class="underline">Linux</span> = /home/user/media </p>\r
 635 \r
 636       </div>\r
 637 \r
 638       <div id="help-subshares" style="position: absolute; left: 0px; top: 0px; visibility: hidden;">\r
 639       <p align="center"><strong>auto_subshares</strong>\r
 640       </p>\r
 641 \r
 642       <p> <strong>Default Setting:</strong> false<br>\r
 643 \r
 644       <strong>Valid Entries:</strong> True/False<br>\r
 645 \r
 646       <strong>Required:</strong> No<br>\r
 647 \r
 648       <strong>Skill:</strong> Moderate<br>\r
 649 \r
 650       <strong>Description:</strong> Subfolders of the share\r
 651 paths you define will be seen by pyTivo and displayed as subfolders in\r
 652 the Now Playing List. This is an alternative to the <a href="http://pytivo.armooo.net/wiki/ConfigurepyTivo#hack83">hack83</a>\r
 653 setting which enables the <a class="wiki" href="/wiki/SubFoldersBranch">SubFoldersBranch</a><br>\r
 654 \r
 655       <strong>Example Settings:</strong> True/False </p>\r
 656 \r
 657       </div>\r
 658 \r
 659       <div id="help-precache" style="position: absolute; left: 0px; top: 0px; visibility: hidden;">\r
 660       <p align="center"><strong>precache</strong>\r
 661       </p>\r
 662 \r
 663       <p> <strong>Default Setting:</strong> false<br>\r
 664 \r
 665       <strong>Valid Entries:</strong> True/False<br>\r
 666 \r
 667       <strong>Required:</strong> No<br>\r
 668 \r
 669       <strong>Skill:</strong> Moderate<br>\r
 670 \r
 671       <strong>Description:</strong> In order to verify that\r
 672 the video files present on your computer were compatible with ffmpeg in\r
 673 older versions pyTivo would query ffmpeg for each file. While this\r
 674 information was cached it still caused a delay in the initial loading\r
 675 of a list of files. This precache setting forced pyTivo to inspect each\r
 676 video prior to starting the pyTivo server. However, this had two\r
 677 drawbacks. 1. It took time as much as two minutes before pyTivo was\r
 678 ready to accept requests. 2. It did not update the cache if new files\r
 679 were added while the pyTivo server was running. <br>\r
 680 \r
 681 In the more recent releases, anything after Feb 16, 2008, pyTivo no\r
 682 longer needs to query ffmpeg when creating a file list. Instead pyTivo\r
 683 has a list of accepted video format extensions. If the file extension\r
 684 falls within this list it is displayed on the TiVo. This achieves the\r
 685 same speed increase as the precache method without the delay in loading\r
 686 the pyTivo server. <br>\r
 687 \r
 688 There are still two drawbacks to this method. 1. The video file must\r
 689 have an extension that is in the list. There is a possibility that a\r
 690 new video file extension could come out before pyTivo is updated. 2.\r
 691 Incomplete or video files with errors will still appear in the TiVo\r
 692 listing if they have the correct extension, even though they are not\r
 693 valid files. Both of these concerns are minimal. 1. Very few new\r
 694 formats of video files come out very often. And all extensions are\r
 695 stored in the video.ext file which is easily edited. 2. When viewing\r
 696 the file details before transferring the pyTivo server queries ffmpeg\r
 697 to make sure it is valid. If the file is not valid it will show up as a\r
 698 copyrighted file and transferring it will be prevented by TiVo. <br>\r
 699 \r
 700 It is recommended that you leave precaching turned off as it is no\r
 701 longer needed.<br>\r
 702 \r
 703       <strong>Example Settings:</strong> True/False </p>\r
 704 \r
 705       </div>\r
 706 \r
 707       <div id="help-aspect169" style="position: absolute; left: 0px; top: 0px; visibility: hidden;">\r
 708       <p align="center"><strong>aspect169</strong>\r
 709       </p>\r
 710 \r
 711       <p> <strong>Default Setting:</strong> True<br>\r
 712 \r
 713       <strong>Valid Entries:</strong> True/False<br>\r
 714 \r
 715       <strong>Required:</strong> No<br>\r
 716 \r
 717       <strong>Skill:</strong> Moderate<br>\r
 718 \r
 719       <strong>Description:</strong> Most TiVos, even S2,\r
 720 can handle 16:9 videos perfectly. Some S2s are known not to handle 16:9\r
 721 and will default to false in this setting. If you are experiencing\r
 722 major distortion you can try setting this to false. Likely mos users\r
 723 will not have to mess with this.<br>\r
 724 \r
 725       <strong>Example Settings:</strong> True/False </p>\r
 726 \r
 727       </div>\r
 728 \r
 729       <div id="help-shares" style="position: absolute; left: 0px; top: 0px; visibility: hidden;">\r
 730       <p align="center"><strong>shares</strong>\r
 731       </p>\r
 732 \r
 733       <p> <strong>Default Setting:</strong> Blank,\r
 734 which is equivalent to allow all shares on this TiVo.<br>\r
 735 \r
 736       <strong>Valid Entries:</strong> The name of any share\r
 737 in your pyTivo.conf file. A comma separated list.<br>\r
 738 \r
 739       <strong>Required:</strong> No<br>\r
 740 \r
 741       <strong>Skill:</strong> Easy<br>\r
 742 \r
 743       <strong>Description:</strong> Only the shares listed\r
 744 in this setting will be visible on this TiVo. Will ignore invalid\r
 745 shares. If no valid shares are listed or the setting does not exist,\r
 746 all shares will be visible on this TiVo.<br>\r
 747 \r
 748       <strong>Example Settings:</strong> Movies, Kids Stuff\r
 749       </p>\r
 750 \r
 751       </div>\r
 752 \r
 753 <!-- END HELP SECTIONS --> </div>\r
 754 \r
 755       </td>\r
 756 \r
 757     </tr>\r
 758 \r
 759   </tbody>\r
 760 </table>\r
 761 </center>\r
 762 </body>\r
 763 </html>\r