config.xml 17 KB
Newer Older
Clément Stenac's avatar
Clément Stenac committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922
<?xml version="1.0" encoding="UTF-8"?>
<!-- revision:1.1 -->
<chapter id="config"><title id="tconfig">Configuration</title>

<para>

VLS lit sa configuration depuis le fichier
<filename moreinfo="none">vls.cfg</filename>, qui doit se trouver dans le répertoire
courant ou dans <filename moreinfo="none">SYSCONF_DIR/videolan/vls</filename>
<emphasis>SYSCONF_DIR</emphasis> est <filename moreinfo="none">/usr/local/etc</filename>
si vous avez installé VLS à la main, ou <filename moreinfo="none">/etc</filename> si
vous avez utilisé le package Debian

.</para>

<para>


Pour écrire un fichier <filename moreinfo="none">vls.cfg</filename>, utilisez celui fourni
avec VLS comme point de départ



.</para>

<sect1><title>

Structure générale

</title>

<para>

Le fichier de configuration
<filename moreinfo="none">vls.cfg</filename> est divisé en section, chacune contenant
plusieurs variables

:</para>
<programlisting format="linespecific">


BEGIN "Section1"
   Variable1 = "valeur1"
   Variable2 = "valeur2"
  [...]
END

BEGIN "Section2"
   Variable1 = "valeur1"
   Variable3 = "valeur3"
  [...]
END
 

[...]
</programlisting>

<para>

Tous les noms de section, noms de variable, et
valeurs ne sont pas sensibles à la case. Il peut y avoir des sections
et sous-sections vides. Les commentaires doivent être placés après un
<keycap moreinfo="none">#</keycap>. Certaines variables ont une valeur par défaut; ce
qui signifie que vous pouvez ne pas les déclarer, leur valeur sera alors
la valeur par défaut

.</para>

</sect1>

<sect1><title>

Ecriture d'un <filename moreinfo="none">vls.cfg</filename>

</title>

<para>

Nous allons maintenant détailler toutes les sections
du fichier <filename moreinfo="none">vls.cfg</filename>

:</para>

<sect2><title>Section "VLS"</title>

<para>

Cette section contient des paramètres globaux

.</para>

<programlisting format="linespecific">
LogFile = "name"
</programlisting>

<para>

Nom du fichier de log de VLS. Si une valeur vide
("") est entrée, aucun log n'est écrit. Le défaut est "vls.log"

.</para>

<programlisting format="linespecific">
SystemLog = "[disable|enable]"
</programlisting>

<para>

Log dans le mécanisme de log du système.
Actuellement, seul syslogd est supporté: compilez avec
<command moreinfo="none">./configure --enable-syslog</command>

.</para>

<caution><para>

Si VLS est lancé en tant que
<command moreinfo="none">vlsd</command>, la configuration suivante est requise

:</para>

<programlisting format="linespecific">
BEGIN "Vls"
  LogFile   = ""
  SystemLog = "enabled"
  ScreenLog = "disabled"
END
</programlisting>

</caution>

<programlisting format="linespecific">
ScreenLog = "[disable|enable]"
</programlisting>

<para>

Affichage des logs sur la console

.</para>

<para>

Exemple

:</para>

<programlisting format="linespecific">
BEGIN "Vls"
  LogFile   = "vls.log"
  SystemLog = "disable"
  ScreenLog = "enable"
END
</programlisting>

</sect2>

<sect2><title>

Section "Groups"

</title>

<para>

Dans cette section, vous pouvez définir des groupes
d'utilisateurs et quelles commandes ils sont autorisés à exécuter. Pour
chaque groupe, vous devez ajouter une ligne du type

:</para>

<programlisting format="linespecific">
groupname = "command1|command2|..."
</programlisting>

<para>

Ceci ajoute le groupe "groupname", dont les
utilisateurs peuvent exécuter command1,command2, ... Les commandes
disponibles sont: browse, start, suspend, resume, forward, rewind, stop,
shutdown, logout

.</para>

<para>

Exemple

:</para>

<programlisting format="linespecific">
BEGIN "Groups"
  monitor = "help|browse|logout"
  master  = "help|browse|start|resume|suspend|forward|rewind|stop|shutdown|logout"
END
</programlisting>

</sect2>

<sect2><title>

Section "Users"

</title>

<para>

Cette section contient la liste des utilisateurs
autorisés à contrôler VLS via l'interface d'administration. Pour chaque
utilisateur, vous devez ajouter une ligne du type

:</para>

<programlisting format="linespecific">
username = "password:groupname"
</programlisting>

<para>

Ceci ajoute un utilisateur "username", qui
appartient au groupe "groupname", défini dans la section "Groups", et
qui peut se logguer avec le mot de passe "password"

.</para>

<itemizedlist>

<listitem><para>

Sous Unix/Linux, le mot de passe doit être encrypté,
avec un outil tel que <command moreinfo="none">mkpasswd</command>, ou à l'aide de la
fonction unix "crypt"

.</para></listitem>

<listitem><para>

Sous Windows, le mot de passe doit être en clair

.</para></listitem>

</itemizedlist>

<para>

Exemple pour Unix/Linux

:</para>

<programlisting format="linespecific">
BEGIN "Users"
  monitor = "3BcKWoiQn0vi6:monitor"       # password is 'monitor'
  admin   = "42BKiCguFAL/c:master"        # password is 'Vir4Gv5S'
END
</programlisting>

</sect2>

<sect2><title>

Section "Telnet"

</title>

<para>

Dans cette section, vous pouvez configure
l'interface d'administration telnet

.</para>

<programlisting format="linespecific">
LocalPort = "port"
</programlisting>

<para>

Définit le port qui sera utilisé pour le serveur
telnet. Le port par défaut est "9999"

.</para>

<programlisting format="linespecific">
Domain = "domain"
</programlisting>

<para>

Soit "inet4", soit "inet6" (défaut = "inet4").
Si vous voulez utiliser IPv4, mettez "inet4", et pour l'IPv6, mettez
"inet6"

.</para>

<programlisting format="linespecific">
LocalAddress = "IP address"
</programlisting>

<para>

Définit sur quelle adresse IP le serveur Telnet va
écouter les requêtes. L'adresse par défaut est "0.0.0.0" (ou "0::0" avec
l'IPv6)

.</para>

<para>

Exemple

:</para>

<programlisting format="linespecific">
BEGIN "Telnet"
  LocalPort = "9999"
END
</programlisting>
</sect2>

<sect2><title>

Section "NativeAdmin"

</title>

<para>

Même syntaxe que "Telnet". Inutilisé

.</para>

</sect2>

<sect2><title>

Section "Inputs"

</title>

<para>

Dans cette section, vous pouvez définir quelles
entrées vous désirez utiliser. Pour chaque entrée, ajoutez une ligne du
type

:</para>

<programlisting format="linespecific">
InputName = "Type"
</programlisting>

<para>

Ceci ajoute une entrée nommée "InputName", de type
"Type". Comme expliqué, il existe plusieurs types d'entrées

:</para>

<itemizedlist>

<listitem><para>


"local" pour jouer des fichiers ou des DVDs

,</para></listitem>

<listitem><para>

"video" pour lire depuis une carte d'encodage
MPEG

,</para></listitem>

<listitem><para>

"dvb" pour lire depuis une carte DVB

,</para></listitem>

<listitem><para>

"v4l" pour lire depuis un périphérique Video4Linux

.</para></listitem>

</itemizedlist>

<para>

Chaque entrée doit être configurée dans sa propre
section (voir la suite)

.</para>

<para>

Exemple

:</para>

<programlisting format="linespecific">
BEGIN "Inputs"
  local1 = "local"
  pvr    = "video"
  dvb1   = "dvb"
  tuner  = "v4l"
END
</programlisting>
</sect2>

<sect2><title>

Configuration des entrées

</title>

<para>

Pour chaque entrée déclarée dans la section
"Inputs", à l'exception des entrées "local", vous devez ajouter une
section avec le même nom que l'entrée correspondante. Par exemple,
si vous déclarez une entrée "pvr", il doit également y avoir une
section "pvr". La syntaxe de ces sections dépend du type de l'entrée
correspondante

.</para>

<para>

Pour configurer une entrée locale, vous n'avez
rien à faire, sauf si vous utilisez une stratégie "trickplay"
différente

:</para>

<programlisting format="linespecific">
BEGIN "Local1"
  ProgramCount = "1"
  TrickPlay    = "normal"
END
</programlisting>

<para>

"Local1" est le nom de l'entrée que vous configurez.
"ProgramCount" est le nombre de programmes correspondant à cette
entrée". "TrickPLay" est la stratégie trickplay utilisée par l'entrée
(le défaut est "normal")

.</para>

<para>

Pour configurer une entrée vidéo, ajoutez une
section dans ce format

:</para>

<programlisting format="linespecific">
BEGIN "VideoInputName"
  Device = "device"
  Type   = "type"
END
</programlisting>

<para>

"VideoInputName" est le nom de l'entrée vidéo que
vous configurez. "Device" est l'adresse de la carte d'encodage MPEG
que vous désirez utiliser (le défaut est "/dev/video"). "Type" est
soit "MPEG2-PS", soit "MPEG2-TS", selon la configuration de votre
périphérique (le défaut est "MPEG2-PS")

.</para>

<para>

Exemple pour une carte Hauppauge WinTV-PVR-250

:</para>

<programlisting format="linespecific">
BEGIN "pvr"
  Device = "/dev/video0"
  Type   = "Mpeg2-PS"
END
</programlisting>

<para>

Pour configurer une entrée dvb, ajoutez une section
du type suivant

:</para>

<programlisting format="linespecific">
BEGIN "DvbInputName"
  DeviceNumber = "devicenumber"
  SendMethod   = "0"
END
</programlisting>

<para>

"DvbInputName" est le nom de l'entrée dvb que
vous configurez. Réglez "SendMethod" à "0" si vous désirez diffuser
le flux DVB complet et à "1" si vous désirez diffuser les flux MPEG
audio et vidéo (le défaut est "0"). "DeviceNumber" est le numéro du
périphérique DVB depuis leequel vous désirez lire (lecture depuis
<filename moreinfo="none">/dev/ost/dvr&lt;devicenumber&gt;</filename>, le défaut étant
""). Le fichier de configuration de dvb est défini par le périphérique.
Vous pouvez le trouver dans <filename moreinfo="none">$HOME/.dvbrc</filename> pour
/dev/dvb/adapter0 ou dans <filename moreinfo="none">$HOME/.dvbrc.X</filename> pour
<filename moreinfo="none">/dev/dvb/adapterX</filename>
.</para>

<para>

Exemple

:</para>

<programlisting format="linespecific">
BEGIN "dvb1"
  DeviceNumber = "0"
  TrickPlay = "normal"
END
</programlisting>

</sect2>

<sect2><title>

Section "Channels"

</title>

<para>

Dans cette section, vous pouvez définir les
sorties que vous désirez utiliser. Pour chacune, ajoutez une ligne du
type

:</para>

<programlisting format="linespecific">
ChannelName = "Type"
</programlisting>

<para>

Ceci ajoute une sortie appelée "ChannelName", de
type "Type". Ceci doit être "network" ou "file". Comme les entrées, les
sorties doivent être configurées dans leur propre section

.</para>

<para>

Exemple

:</para>

<programlisting format="linespecific">
BEGIN "Channels"
  localhost  = "network"
  client1    = "network"
  client2    = "network"
  multicast1 = "network"
  multicast2 = "network"
  localfile  = "file"
END
</programlisting>

</sect2>

<sect2><title>

Configuration des sorties

</title>

<para>

Pour chaque sortie déclarée dans la section
"Channels", vous devez ajouter une section avec le nom correspondant.
La syntaxe de cette section dépend du type de la sortie
correspondante

.</para>

<para>

Pour configurer une sortie network, ajoutez une
section dans le format suivant

:</para>

<programlisting format="linespecific">
BEGIN "NetChannelName"
  Domain    = "Domain"
  Type      = "Type"
  SrcHost   = "SourceHost"
  SrcPort   = "SourcePort"
  DstHost   = "DestHost"
  DstPort   = "DestPort"
  TTL       = "ttl"
  Interface = "Interface"
END
</programlisting>

<itemizedlist>

<listitem><para>

"NetChannelName" est le nom de la sortie que vous
configurez

.</para></listitem>

<listitem><para>

"Domain" est soit "inet4", pour des adresses IPv4,
ou "inet6", pour des adresses IPv6 (le défaut est "inet4")

.</para></listitem>

<listitem><para>

"Type" est soit, "unicast", "broadcast" ou
"multicast" (le défaut est "unicast"), selon ce que vous désirez faire,
et votre adresse "DstHost")

.</para></listitem>

<listitem><para>

"SourceHost" est l'adresse IP (ou le nom DNS)
depuis lequel VLS va envoyer le flux

.</para></listitem>

<listitem><para>

"SourcePort" est le port UDP depuis lequel le flux
sera envoyé

.</para></listitem>

<listitem><para>

"DestHost" est l'adresse IP (ou le nom DNS) vers
lequel le flux sera envoyé

.</para></listitem>

<listitem><para>

"DestPort" est le port UDP vers lequel le flux sera
envoyé (le défaut est "1234")

.</para></listitem>

<listitem><para>

"TTL" est une option utile seulement si "Type" est
"multicast" (le défaut est "0"). Vous pouvez l'utiliser pour modifier le
nombre de routeur que le paquet pourra téléviser

.</para></listitem>

<listitem><para>

"Interface" est une option qui ne fonctionne que
sous GNU/Linux, pour forcer l'interface réseau de sortie ("eth1", par
exemple). Vous devez être root pour utiliser cette option

.</para></listitem>

</itemizedlist>

<note><para>

"SrcHost" et "SrcPort" sont optionnels (si vous ne
les réglez pas, VLS n'attachera pas la socket)

.</para></note>

<para>

Pour configurer une sortie file, ajoutez une section
dans le format suivant

:</para>

<programlisting format="linespecific">
BEGIN "FileChannelName"
  FileName = "file"
  Append   = "append"
END
</programlisting>

<para>

"FileChannelName" est le nom de la sortie file que
vous configurez. "file" est le nom du fichier où le flux sera stocké (le
défaut est "fileout.ts"). "append" est soit "yes", soit "no", et indique
si VLS ajoute le flux à la fin du fichier, ou le réécrire

.</para>

<para>

Exemple

:</para>

<programlisting format="linespecific">
BEGIN "localhost"         # The client is on the same host as the server
  DstHost = "localhost"
  DstPort = "1234"
END

BEGIN "client1"           # unicast towards client1
  DstHost = "192.168.1.2"
  DstPort = "1234"
END

BEGIN "client2"           # unicast towards client2 in IPv6
  Domain  = "inet6"
  DstHost = "3ffe:ffff::2:12:42"
  DstPort = "1234"
END

BEGIN "multicast1"         # multicast streaming
  Type    = "multicast"
  DstHost = "239.2.12.42"
  DstPort = "1234"
  TTL     = "2"
END

BEGIN "multicast2"         # multicast streaming in IPv6
  Domain  = "inet6"
  Type    = "multicast"
  DstHost = "ff08::1"
  DstPort = "1234"
  TTL     = "12"
END

BEGIN "localfile"         # file output
  FileName = "stream.ts"
  Append   = "no"
END
</programlisting>

<caution><para>

Si vous utililsez Windows, vous devez spécifier les
valeurs "SrcHost" et "SrcPort". Par exemple

:</para>

<programlisting format="linespecific">
BEGIN "client1"         # The client is on the same host as the server
  SrcHost = "192.168.1.1"  # IP of VLS
  SrcPort = "1242"         # Source port : the value is not important
  DstHost = "192.168.1.2"  # IP of the client
  DstPort = "1234"
END
</programlisting>

</caution>

</sect2>

<sect2><title>

Configuration des programmes

</title>

<para>

Comme expliqué précédemment, vous devez définir
les programmes. Chacun est un flux MPEG (un fichier, par exemple).
Pour cela, vous devez ajouter une section "Input" dans votre fichier
<filename moreinfo="none">vls.cfg</filename>. Chaque section Input doit avoir la syntaxe
suivante

:</para>

<programlisting format="linespecific">
BEGIN "Input"
  FilesPath    = "path"
  ProgramCount = "count"
END
</programlisting>

<para>

"path" est le chemin où vos fichiers MPEG sont
situés (par défaut, c'est le répertoire courant). "count" est le nombre
de programmes ("0" par défaut)

.</para>

<para>

Pour chaque programme, vous devez ajouter une
section avec la syntaxe suivante

:</para>

<programlisting format="linespecific">
BEGIN "number"
  Name     = "name"
  Type     = "type"
  FileName = "file"
  Device   = "device"
END
</programlisting>

<itemizedlist>

<listitem><para>

"number" est le numéro de programme: le premier est
1, le second 2, ...

</para></listitem>

<listitem><para>

"name" est le nom du programme, que vous utiliserez
pour lancer le programme (voir la section suivante)

.</para></listitem>

<listitem><para>

"type" peut être "Mpeg1-PS", "Mpeg2-PS", "Mpeg2-TS",
ou "DVD". Si votre flux est stocké dans un fichier MPEG (*.mpeg,
*.mpg, *.vob, and so on...), il es probablement au format Mpeg1-PS ou
Mpeg2-PS

.</para></listitem>

<listitem><para>

si type n'est pas "dvd", VLS supposera que votre
fichier est stocké dans le fichier "file", dans le répertoire "path" (où
"path" est le répertoire défini dans la section "Input")

.</para></listitem>

<listitem><para>

dans le cas contraire, la variable "Device" sera
utilisée à la place de "FileName". Elle représente l'adresse de votre
lecteur de DVD ("/dev/hdc" ou "/dev/cdrom", par exemple). Vous pouvez
également jouer un DVD copié sur un disque dur: "device" est alors
l'endroit où les fichiers .vob sont stockés ("/mnt/data/VIDEO_TS", par
exemple)

.</para></listitem>
</itemizedlist>

<note>
&streamable-mpeg-file;
</note>

<note><para>

Pour pouvoir lire des DVDs, vous devez compiler VLS
avec le support des DVD, qui utilise libdvdread et libdvdcss. Vous devez
avoir l'accès en lecture <emphasis>et</emphasis> en écriture à votre
lecteur de DVD

.</para></note>


<para>

Exemple complet

:</para>

<programlisting format="linespecific">
BEGIN "Input"
  FilesPath = "/home/videolan/streams"
  ProgramCount = "4"
END

BEGIN "1"     # MPEG2 stream stored in /home/videolan/streams/Dolby.vob
  Name     = "dolby"
  FileName = "Dolby.vob"
  Type     = "Mpeg2-PS"
END

BEGIN "2"     # another file
  Name     = "canyon"
  FileName = "Dolby_Canyon.vob"
  Type     = "Mpeg2-PS"
END

BEGIN "3"     # DVD
  Name     = "dvd"
  Device   = "/dev/cdrom"
  Type     = "Dvd"
END

BEGIN "4"     # DVD stored on a hard disk
  Name     = "matrix"
  Device   = "/mnt/data/matrix/VIDEO_TS"
  Type     = "Dvd"
END
</programlisting>

</sect2>
</sect1>
</chapter>