diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile.am | 28 | ||||
| -rw-r--r-- | doc/README | 19 | ||||
| -rw-r--r-- | doc/README.dxr3_pl | 319 | ||||
| -rw-r--r-- | doc/faq/Makefile.am | 29 | ||||
| -rw-r--r-- | doc/hackersguide/Makefile.am | 31 |
5 files changed, 18 insertions, 408 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 1cfab2ee9..f45fafd98 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -2,34 +2,12 @@ include $(top_srcdir)/misc/Makefile.common SUBDIRS = man hackersguide faq -EXTRA_DIST = $(docs_DOCS) -docdir = $(prefix)/share/doc/xine -docs_DOCS = README README.config_en README.dvb README.dxr3 README.dxr3_pl \ +EXTRA_DIST = $(docs_DATA) +docsdir = $(prefix)/share/doc/xine +docs_DATA = README README.config_en README.dvb README.dxr3 \ README.freebsd README.irix README.network_dvd README.opengl \ README.solaris README.syncfb - -install-data-local: - @documentations='$(docs_DOCS)'; \ - for doc in $$documentations; do \ - destdir=$(DESTDIR)$(docdir); \ - name=`echo $$doc` \ - dir=$$destdir; \ - $(mkinstalldirs) $$dir; \ - $(INSTALL_DATA) $$doc $$dir/$$name; \ - echo "installing $$doc as $$dir/$$name"; \ - done - -uninstall-local: - @documentations='$(docs_DOCS)'; \ - for doc in $$documentations; do \ - destdir=$(DESTDIR)$(docdir); \ - name=`echo $$doc` \ - dir=$$destdir; \ - rm -f $$dir/$$name; \ - echo "removing $$dir/$$name" ; \ - done - docs: @cd faq && $(MAKE) $@ @cd hackersguide && $(MAKE) $@ diff --git a/doc/README b/doc/README index dbb4e7ab1..9bbd61a31 100644 --- a/doc/README +++ b/doc/README @@ -11,6 +11,12 @@ engine features common to all frontends. faq/ contains the xine engine FAQ +hackersguide/ + contains the xine hacker's guide for developers + +man/ + contains some general manpages about xine-lib + README.config_en details about xine engine config options @@ -18,7 +24,6 @@ README.dvb instructions on how to get DVB (DigitalTV) working in xine README.dxr3 -README.dxr3_pl instructions on how to get use the DXR3 (hollywood+) in xine README.freebsd @@ -38,15 +43,3 @@ README.solaris README.syncfb information about xine's SyncFB video output plugin - -README.tvmode - how to get tv output working - -man/ - contains some general manpages about xine-lib - -hackersguide/ - contains the xine hacker's guide for developers - -dvb_channels - sample channel file for DVB diff --git a/doc/README.dxr3_pl b/doc/README.dxr3_pl deleted file mode 100644 index f25d01a04..000000000 --- a/doc/README.dxr3_pl +++ /dev/null @@ -1,319 +0,0 @@ - - ---------------------- - xine - ---------------------- - - wolny odtwarzacz wideo - - -Wstęp -===== - -Ta dokumantacja jest przeznaczona dla użytkowników dekodera dxr3 -firmy Creative Labs lub Sigma Designs. - -Ta wersja xine domyślnie zawiera wtyczkę dla wsparcia wspomnianych -dekoderów sprzętowych. Brakującym elementem jest moduł jądra systemu. -Ten moduł jest dostępny na stronie głównej projektu dxr3/hw+ pod -adresem - - http://dxr3.sourceforge.net/ - -Różne formaty dystrybucji (skompresowane, RPMy) są wyszczególnione -pod adresem - - http://dxr3.sourceforge.net/download.html - -Ponieważ konfiguracja sterownika dxr3/hw+ jest nieco skomplikowane, -proszę zaglądnąć do dokumentu HOWTO: - - http://dxr3.sourceforge.net/howto.html - -Wtyczka xine dxr3 wymaga przynajmniej wersji - - em8300-0.8.1 sterownika kernela linuxa - - -Kompilacja -========== - -Bardzo ważnym jest skompilowanie i zainstalowanie sterwonika -(modułu) dxr3/hw+ *przed* kompilacją xine-lib. Nie zachowanie -wspomnianej zasady spowoduje wyłączenie obsługi dxr3 z ostrzeżeniem -przez skryp ./configure. - -W celu aktywacji wtyczkę, plik em8300.h musi być dostępny -w katalogu /usr/src/linux/include/linux. Jeśli masz niestandardowy -katalog źródeł jądra linuxa np. /usr/src/linux-2.4.5, musisz -podać go jako parametr: - -./configure --with-linux-path=/usr/src/linux-2.4.5 - -Wtyczka dxr3 xine -================= - -Są dwa sposoby użycia karty dxr3 przez xine. - -1. dekodowanie i wyświetlanie mpeg-1/mpeg-2 (DVD, VCD, ...). - -Jest to normalne użytkowanie. Zamiast dekodować mpeg programowo, -xine ustawia wyświetlanie (TV albo overlay) i wysyła dane mpeg -poprzez sterownik jądra do dekodera mpeg na karcie dxr3 bardzo -podobnie do odtwarzacza windowsowego który prawdopodobnie otrzymałeś -wraz z kartą. W tym trybie, powinieneś używać wtyczkę dekodera dxr3 -razem z wtyczką wyjścia obrazu dxr3. - -xine powinno wybrać wtyczkę dekodera dxr3 automatycznie gdy -napotka strumień mpeg, lecz jest możliwe że nie użyje automatycznie -wtyczki wyjścia obrazu dxr3. W takim przypadku, wystartuj xine -z opcją "-V dxr3" aby zdefiniować wtyczkę wyjścia obrazu dxr3. Jeśli -użyjesz innej wtyczki wyjścia obrazu, jak Xv lub XShm, xine nie -będzie mógł użyć dekodujących własności sprzętu dxr3 i użyje -zamiast tego biblioteki libmpeg2. - - Oto uproszczony opis tego co dzieje się gdy odtwarzasz -dvd z pomocą xine używającego sterownika wyjścia obrazu dxr3: - -DVD -> podział obrazu i dźwięku mpeg oraz strumieni dźwięku --> wysyłanie obrazu mpeg do dxr3 -> obraz pojawia się na ekranie - -2. wyświetlanie obrazu nie-mpeg na sprzęcie dxr3. - -Obraz nie-mpeg może być avi, quicktime, windows-media-files lub -cokolwiek xine może odkodować. - -Ta opcja musi być wkompilowana i wymaga wspieranego kodera mpeg. -W tym momencie istnieją dwa: -- libfame z fame.sourceforge.net (bardzo szybki, dobrej jakości) -- librte (versja 0.4) z zapping.sourceforge.net (szybki, bardzo -dobrej jakości) -Jeśli ./configure znajdzie jeden albo obydwa, wkompiluje -wsparcie dla kodowania do sterownika dxr3. - -Aby użyć tego sterownika dla wyjścia obrazu zamiast, powiedzmy, -Xv, wystartuj xine z linii poleceń z opcją "-V dxr3", np. -$ xine -V dxr3 my_movie.avi - -W przeciwieństwie do przypadku 1), gdzie karta wykonuje -dekodowanie obrazu, tutaj xine wykonuje dekodowanie programowo, -jak zwykle i wysyła zdekompresowany obraz do sterownika wyjścia -obrazu. Sterownik wyjścia dxr3 zakodowywuje, w czasie -rzeczywistym, ten obraz jako wewnętrzną ramke mpeg-1 i wysyła -to do dekodera mpeg na karcie. - -Używając tego triku, możemy wyświetlić dowolny format obrazu -poprzez wyjście TV karty dxr3. Sprytne, nie? Jedyną wadą tego -rozwiązania jest wymagana dodatkowa moc do przeliczenia tego -odkodowania i zakodowania obrazu w czasie rzeczywistym -programowo. Wymagana moc procesora zależy oczywiście od -rozdzielczości formatu źródła, ale według reguły kciuka -zalecany jest system z 128 MB pamięci RAM i P-III/Athlonem -taktowanym zegarem 800 MHz. - -Oto opis tego co dzieje się gdy odgrywasz plik avi w ten -sposób (porównaj do poprzedniego opisu!) - --> oddzielenie strumienia obrazu i dźwięku -> dekodowanie -strumienia obrazu -> zakodowywanie obrazu jako mpeg-1 -> -wysyłanie strumienia mpeg-1 do dxr3 -> obraz wyświetlany -na ekranie. - -konfiguracja xine -================= - -xine posiada wiele opcji konfiguracyjnych w $HOME/.xine/config -(zobacz również doc/README.config_en) - -dxr3.devicename: - /dev/em8300-0 Ścieżka bezwzględna do urządzenia dxr3. - -dxr3.preferred_tvmode: - default Użyj obecnych ustawień sterownika - ntsc NTSC 60Hz - pal PAL 50Hz - pal60 PAL 60Hz - -dxr3.videoout_mode: - letterboxed overlay - wyjście obrazu overlay na monitorze VGA z opcją - przełączania "w locie" do trybu TV. (patrz - 'Właściwość VGA overlay' poniżej). Overlay - będzie wyświetlany z czarnymi brzegami jeśli - obraz jest anamorficzny. To może być użyteczne - w rzadkim przypadku napisów które poprawnie - są wyświetlane tylko w trybie letterbox. - Dobrym tego przykładem są animowane - sylwetki komentatorów w "Ghostbusters". - widescreen overlay - wyjście obrazu overlay na monitorze VGA z - opcją przełączania w locie do trybu TV - (patrz 'Właściwość VGA overlay' poniżej). - Najpopularniejszy wariant trybu overlay dxr3. - letterboxed tv - wysyła obraz tylko do wyjścia TV karty. - To jest tryb używany dla standardowego - telewizora 4:3. Anamorficzne proporcje będą - wyświetlane letterboxed, materiał pan&scan - będzie miał obraz obcięty. - widescreen tv - wysyła obraz tylko do wyjścia TV karty. To - jest tryb przeznaczony dla telewizorów 16:9. - Zawartość anamorficzna i pan&scan wypełni obraz - ale będziesz musiał ustawić proporcje TV ręcznie. - -dxr3_keycolor: (tylko w trybie overlay) - 0x80a040 Szesnastkowa wartość RGB koloru kluczowego. - Nie powinna być zmieniana. - -dxr3.color_interval: (tylko w trybie overlay) - 50.0 Zakres tolerancji dla koloru kluczowego. Wyższa wartość - pozwala na większy zakres kolorów kluczowych. Używane - do korekcji błędów w wyświetlaniu kolorów na wyjściu VGA. - Mniejsza wartość jest zalecana aby nie używać "błędnych" - kolorów do trybu overlay. Rozsądny zakres to 20.0 - 200.0 - -dxr3.scr_priority: - 10 Priorytet wtyczki dxr3 scr. <5 oznacza że czasomierz - systemowy ma być użyty. >5 narzuca użycie dxr3 jako - źródło synchronizacji. Jeśli tego nie rozumiesz - pozostaw ustawienia domyślne. - -dxr3.decoder_priority: - 10 Priorytet wtyczki dekodera dxr3. <5 oznacza że sprzętowe - dekodowanie będzie wyłączone i będzie użyte zamiast tego - libmpeg2. W ten sposób jakikolwiek materiał wideo, - włączając w to mpeg będzie przechodził przez programowe - dekodowanie i ponowne kodowanie do mpeg. - -dxr3.contrast: -dxr3.brightness: -dxr3.saturation: - 500 Nie powinno być potrzebne zmienianie ręczne. Użyj xine - do regulacji. Zakres 100 - 900 - -dxr3.alt_play_mode: - 1 Włącz lub wyłącza rozszerzony tryb bufora dostępnego - przynajmniej na części kart. Znaczące polepszenie - było zaobserwowane z zakłuconymi strumieniami przerywanymi - pauzami. - -dxr3.sync_every_frame: - 0 Próbuje ustawić znaczniki czasu synchronizacji dla każdej - ramki. Zazwyczaj nie jest to wymagane, nawet jeśli - sychrnonizacyjne znaczniki czasu są ustawiane od czasu - czasu. - -dxr3.correct_durations: - 0 Włącza mały automat który koryguje czas trwania ramki - niektórych strumieni mpeg z błędnymi kodekami framerate. - Obecnie została zaimplementowana korekta dla ntsc błędnie - nazwana jako strumień pal. Włączaj tylko kiedy spotkasz - taki strumień. - -video.driver: - dxr3 Sterownik obrazu dxr3 robi całą niezbędną konfigurację - karty i kodowanie do mpeg gdy odtwarzany jest strumień - nie-mpeg (patrz wyżej) - -audio.driver: - oss wyjście em8300 audio jest dostępne jako zwykłe urządzenie - OSS. Sterownik audio musi więc być ustawione na oss. - Może być również ustawione przy użyciu "-A oss" jako - opcji w lini poleceń. - -audio.oss_device_num: - 0-16 komputery z zainstalowaną kartą dxr3 często mają również - zainstaloaną kartę dźwiękową. Jeśli odtwarzanie dźwięku - odbywa się za pomocą błędnego urządzenia, wymagane - urządzenie może być ustawione za pomocą tej opcji. - -Poniższe ustawienia dotyczą tylko części kodującej do mpeg: - -dxr3.enc_alt_play_mode: - 1 Patrz na dxr3.alt_play_mode. Różnica polega na tym - że ta jest używana w trybie kodowania. - -dxr3.enc_swap_fields: - 0 Zamienia parzyste pola z nieparzystymi obrazu. Włącz - tę opcję dla materiałów które generują pionowe skakanie - obrazu na ekranie. - -dxr3.enc_add_bars: - 1 Dodaj czarne pasy gdy obraz ma proporcje nie obsługiwane - przez kartę. Jest wymagane do utrzymania prawidłowych - proporcji. - -dxr3.encoder: - Program kodujący który ma być użyty. - Zależnie od tego co zostało wkompilowane może być "fame" - lub "rte". Według reguły kciuka, powinieneś spróbować - najpierw rte ponieważ daje on lepszą jakość obrazu. Jeśli - masz za dużo opuszczonych ramek, przełącz na "fame" i - znajdź optymalne ustawienie fame_quality (patrz niżej) - dla Twojego systemu. - -dxr3.fame_quality: (tylko koder libfame) - 0-100 Ustawienie jakości kodowania mpeg1 przez fame. Niższa - wartość jest szybsza ale daje znaczące zniekształcenia - Wyższa jest lepsza ale wolniejsza. Wartości pomiędzy - 0 a 100, 90 jest dobrą wartością początkową. - -dxr3.rte_bitrate: (tylko koder rte) - 1000-20000 Bitrate w kbit/s wyjścia kodera librte. Niższa wartość - jest szybsza, ale różnica nie jest tak duża jak w - ustawieniach libfame. Jeśli masz za dużo opuszczonych - ramek, lepiej użyj kodera libfame. - -Zalecane jest uruchomienie XINE przynajmniej raz przed edycją -pliku konfiguracyjnego, ponieważ wszystkie opcje są zapisywane w -pliku .xinerc i mają swoją domyślną wartość. Xine można zmusić do -użycia sterownika dxr3 używając opcji "-V dxr3" w lini poleceń. -Jeśli domyślne ustawienia sterownika są błędne - trzeba poprawić -jedynie wartość opcji tvmode. - -Funkcjonalność zoom (tylko TVout) -================================= -Przyciskając klawisz 'z' włącza inną specyficzną dla trybu -wyjścia TV które powiększa centralną część obrazu 16:9 aby -wyświetlić dużo mniejsze (albo wogóle) czarne pasy na dole i -górze. To obcina obraz na lewo i prawo aby zachować odpowiednie -proporcje. Użyj SHIFT-z aby wyłączyć. - -Funkcjonalność przełączania trybu TV -==================================== -Naciśnięcie kombinacji CTRL-o przełącza pomiędzy trybami TV pal, -pal60, i NTSC. Wybrany format będzie działał tylko do końca -aktualnej sesji xine, przy starcie tryb TV bedzie ustawione -z powrotem do wartości w .xine/config - -Funkcjonalność VGA overlay -========================== - -W poprzednich wersjach xine, trzeba było używać dxr3view by używać -mechanizmu em8300 overlay. Teraz od wersji 0.5, można odtwarzać w trybie -em8300 overlay bezbośrednio w oknie video xine. - -Pierwszy pomysł i poprawnie pracujący kod przyszedł od Mike Lampard -<mjl@datafast.net.au>. Chwała mu za tą nową funkcjonalność. - -W celu aktywacji, "dxr3_tvmode" musi być ustawiony na "overlay". -Ale to nie zadziała dopóki stary dxr3view też będzie uruchomiony -(po prostu sprawdź). Przed pierwszym użyciem, musisz uruchomić "autocal". -To zachowa parametry trybu overlay w pliku "~/.overlay". Więcej informacji -również w HOWTO dxr3. - -Rzuć również okiem na wyżej opisane opcje xinerc dxr3_keycolor i -dxr3_color_interval. - - ---- -Wersja tego pliku: -$Id: README.dxr3_pl,v 1.1 2003/01/05 13:11:53 guenter Exp $ - -********************************* -* Tłumaczenie: Bartłomiej Muryn * -* Uwagi do tłumaczenia proszę * -* przesyłać na adres * -* _4ever_@irc.pl * -********************************* - diff --git a/doc/faq/Makefile.am b/doc/faq/Makefile.am index 1e6fe0142..dadf02021 100644 --- a/doc/faq/Makefile.am +++ b/doc/faq/Makefile.am @@ -1,36 +1,15 @@ include $(top_srcdir)/misc/Makefile.common EXTRA_DIST = README faq.sgml -docs_DOCS = faq.html faq.txt +docs_DATA = faq.html faq.txt -docdir = $(prefix)/share/doc/xine/faq +docsdir = $(prefix)/share/doc/xine/faq -install-data-local: - @documentations='$(docs_DOCS)'; \ - for doc in $$documentations; do \ - destdir=$(DESTDIR)$(docdir); \ - name=`echo $$doc` \ - dir=$$destdir; \ - $(mkinstalldirs) $$dir; \ - $(INSTALL_DATA) $$doc $$dir/$$name; \ - echo "installing $$doc as $$dir/$$name"; \ - done - -uninstall-local: - @documentations='$(docs_DOCS)'; \ - for doc in $$documentations; do \ - destdir=$(DESTDIR)$(docdir); \ - name=`echo $$doc` \ - dir=$$destdir; \ - rm -f $$dir/$$name; \ - echo "removing $$dir/$$name" ; \ - done - -docs: $(docs_DOCS) +docs: $(docs_DATA) dist-hook: @make fail_if_missing=yes docs - cp $(docs_DOCS) $(distdir) + cp $(docs_DATA) $(distdir) faq.html: faq.sgml @if test "$(SGMLTOOLS)" != "no"; then \ diff --git a/doc/hackersguide/Makefile.am b/doc/hackersguide/Makefile.am index b4cfa2228..9a07e8e68 100644 --- a/doc/hackersguide/Makefile.am +++ b/doc/hackersguide/Makefile.am @@ -8,38 +8,17 @@ hackersguide_sgml = hackersguide.sgml \ stream.sgml \ output.sgml -docs_DOCS = hackersguide.html architecture.png library.png overlays.png +docs_DATA = hackersguide.html architecture.png library.png overlays.png EXTRA_DIST = README $(hackersguide_sgml) architecture.fig library.fig overlays.fig -docdir = $(prefix)/share/doc/xine/hackersguide - -install-data-local: - @documentations='$(docs_DOCS)'; \ - for doc in $$documentations; do \ - destdir=$(DESTDIR)$(docdir); \ - name=`echo $$doc` \ - dir=$$destdir; \ - $(mkinstalldirs) $$dir; \ - $(INSTALL_DATA) $$doc $$dir/$$name; \ - echo "installing $$doc as $$dir/$$name"; \ - done - -uninstall-local: - @documentations='$(docs_DOCS)'; \ - for doc in $$documentations; do \ - destdir=$(DESTDIR)$(docdir); \ - name=`echo $$doc` \ - dir=$$destdir; \ - rm -f $$dir/$$name; \ - echo "removing $$dir/$$name" ; \ - done - -docs: $(docs_DOCS) +docsdir = $(prefix)/share/doc/xine/hackersguide + +docs: $(docs_DATA) dist-hook: @make fail_if_missing=yes docs - cp $(docs_DOCS) $(distdir) + cp $(docs_DATA) $(distdir) hackersguide.html: $(hackersguide_sgml) @if test "$(SGMLTOOLS)" != "no"; then \ |