summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--HISTORY1
-rw-r--r--README166
-rw-r--r--TROUBLESHOOTING47
3 files changed, 123 insertions, 91 deletions
diff --git a/HISTORY b/HISTORY
index 3827bed..c27f8b7 100644
--- a/HISTORY
+++ b/HISTORY
@@ -6,6 +6,7 @@ VDR Plugin 'ttxtsubs' Revision History
(Dropped 1.7.12 and 1.7.13 patch)
- Got rid of the backround thread
- Fixed live TV subtitles on FF cards, where there is no transfer mode
+- Updated README and TROUBLESHOOTING (Closes #323)
2010-03-06: Version 0.2.1
- Added Estonian translation by Arthur Konovalov (Closes #271)
diff --git a/README b/README
index 90ed2e0..236da75 100644
--- a/README
+++ b/README
@@ -1,109 +1,99 @@
-This is a "plugin" for the Video Disk Recorder (VDR).
+vdr-ttxtsubs - a teletext subtitle plugin for the Linux Video Disk Recorder
+===========================================================================
-Written by: Ragnar Sundblad <ragge@nada.kth.se>
+About
+-----
-Project's homepage: http://www.nada.kth.se/~ragge/vdr/ttxtsubs/
+Description:
+ This plug-in implements displaying, recording and replaying teletext
+ based subtitles using the on screen display.
-Latest version available at: http://projects.vdr-developer.org/projects/show/plg-ttxtsubs
+Current Maintainer:
+ Tobias Grimm <vdr@e-tobi.net>
-Copyright:
+Original Author:
+ Ragnar Sundblad <ragge@nada.kth.se>
-(C) 2003 - 2008 Ragnar Sundblad
+Homepage:
+ http://projects.vdr-developer.org/projects/show/plg-ttxtsubs
+Old homepage:
+ http://www.nada.kth.se/~ragge/vdr/ttxtsubs/
+
+Copyright:
+ (C) 2003 - 2008 Ragnar Sundblad
+ (C) 2009 - 2010 Tobias Grimm
License:
+ This program is free software; you can redistribute it and/or modify it
+ under the terms of the GNU General Public License as published by the
+ Free Software Foundation; either version 2 of the License, or (at your
+ option) any later version.
-This program is free software; you can redistribute it and/or modify it
-under the terms of the GNU General Public License as published by the
-Free Software Foundation; either version 2 of the License, or (at your
-option) any later version.
+ This program is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+ or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ more details.
-This program is distributed in the hope that it will be useful, but
-WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
-or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
-more details.
+ You should have received a copy of the GNU General Public License along with
+ this program (see file `COPYING`); if not, write to the
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ MA 02110-1301 USA
-You should have received a copy of the GNU General Public License along with
-this program (see file `COPYING`); if not, write to the
-Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
-MA 02110-1301 USA
+Introduction
+------------
-Description:
+This plug-in is for VDR >= 1.7.6. It currently needs a some changes to the VDR
+code in order to work. A patch file is included in patches/ which can be safely
+applied even if you don't use the ttxtsubs plug-in. For your convenience, the
+patch is also available as a set of logical chunks, each covering a specific
+feature.
+
+The main responsibilities of the VDR patch are to enable the reception of the
+teletext data stream and to discover the subtitle pages. So even without the
+plug-in, the patch will allow you to record teletext subtitles, which e.g. can
+be shown in 3'rd partly players like VLC.
+
+
+Usage
+-----
+
+Important: In order to be able to receive the teletext subtitles, you must
+enable the teletext subtitle support in VDR's setup. You will find this setting
+in the DVB section of the setup.
+
+Ideally the available subtitle pages / languages will be auto-detected. But this
+might not be possible with all broadcasters. Especially the German broadcasters
+don't care very much about the DVB standard in this regard and you have to
+configure the subtitle page(s) for each channel manually.
+
+In order to do so, you have to stop VDR and edit the channels.conf. After the
+Tpid entry, you can add tuples of language codes and page numbers like this:
+
+ ...:2001;150=deu,151=fin:...
+
+See `man 5 vdr` for a detailed description of the channels.conf.
+
+Future versions of the plug-in will provide an OSD setup for this setting, but
+right now you are on your own.
+
+To see the subtitles, you also must select the subtitle languages you would
+like to see in the plug-ins OSD setup. In the future this might get somehow
+merged with VDRs built-in DVB-subtitle selection.
+
+In the plug-ins setup you can also configure some parameters which control how
+the subtitles will be displayed.
-This plugin implements displaying, recording and replaying teletext
-based subtitles using the on screen display.
-
-
-Long Description:
-
-The teletext decoder/displayer is currently very basic and limited. It
-can't show colours and it doesn't take into account the editors
-attempts to place the text on different places on the screen.
-
-The DVB drivers from the Metzlers as of late February 2003 and
-Convergence/linuxtv.org as of March 5 2003 have firmware fixes against
-OSD problems. (Thanks a lot guys!) An upgrade to either of those is
-strongly recommended. If the plugin is used with earlier firmware,
-data may get lost when the OSD is updated possibly resulting in bad
-video and audio, especially when recording or playing recordings.
-
-Both the live displayer and the recorder finds subtitling PID and page
-for the selected language, and optionally for the hearing impaired, by
-scanning the DVB Service Information. You don't have to set up channel
-Tpids. Though, if you have set a Sid it will be used to speed up
-Service Information scanning. (Can't say it makes much of a
-difference, though).
-
-The recorder writes a filtered subset of the teletext data with only
-the subtitle pages and an index page at page 100 (or subsequent page
-if that page number is used for subtitling). The filtered stream is
-written as a private_stream_1 with subtype 0x1f (the last teletext
-subtype). An ordinary teletext PES stream recorded for example by
-setting Dpid1 to a teletext PID will typically have a subtype of
-0x10.
-
-The recording player scans the index page to find the selected
-language. (If it can't find an index page it will use the page number
-from the current channel. This may be removed in the future.) The
-index page itself can't be viewed with this plugin.
-
-If you can't select your language, look up its 3 letter acronym in
-<http://www.loc.gov/standards/iso639-2/englangn_ascii.html> and/or
-check the output from ttxtsubs, and enter the language code in your
-VDR setup.conf at ttxtsubs.language. This will hopefully be easier in
-a future release.
-
-Consider this code alpha quality. The code could use some major
-cleanup. The program design was from the beginning just not, as it
-started as a test hack, and it has from then been incompletely
-reworked a few times.
-
-
-Installation:
-
-This plugin is for VDR >= 1.7.6. It currently needs a few hooks in, and
-changes to, VDR to work. A patch file is included and it should
-be harmless if you don't have the plugin loaded, so even if you patch
-VDR and later decide not to use this plugin you don't necessarily have
-to reinstall VDR. It is probably possible to build the plugin for
-other version of VDR, but don't count on it.
-
-cd /put/your/path/here/VDR/PLUGINS/src
-tar -xzf /put/your/path/here/vdr-ttxtsubs-X.Y.Z.tgz
-ln -s ttxtsubs-X.Y.Z ttxtsubs
-cd /put/your/path/here/VDR
-patch -p1 < PLUGINS/src/ttxtsubs/patches/vdr-X.Y.Z-ttxtsubs.patch
-make
-make plugins
-./vdr -P ttxtsubs
+Additional notes
+----------------
A Note about reported problems with Digitainer II:
-If you own a Digitainer II, you may run into an issue with the OSD and a corrupted
-main menu. OlvierH reported, that the following setting at least partially solves
-this:
+If you own a Digitainer II, you may run into an issue with the OSD and a
+corrupted main menu. OlvierH reported, that the following setting at leas
+partially solves this:
Advanced Chipset Features - AGP &P2P Bridge Control - VGA Share Memory Size: 64M
(default is 32M)
diff --git a/TROUBLESHOOTING b/TROUBLESHOOTING
index b63dead..b8cf3f5 100644
--- a/TROUBLESHOOTING
+++ b/TROUBLESHOOTING
@@ -1,3 +1,47 @@
+General troubleshooting
+-----------------------
+
+Don't see any subtitles?
+
+ 1. Do you really have the patch for VDR applied and are you really running
+ this patched VDR version?
+ 2. Do you have the teletext subtitle option in VDR's setup menu in the DVB
+ section enabled?
+ 3. Are you sure your broadcaster supports automatic detection of the subtitle
+ pages? If not, you must manually configure the subtitle pages in the
+ channels.conf!
+ 4. Are you sure the current broadcasting does have subtitles at all? No
+ channel sends subtitles 24/7, so please make sure the current broadcasting
+ really contains subtitles. You may want to check this with the OSDTeletext
+ plug-in by manually going to the subtitle page.
+ 5. Do you have selected the subtitle languages you want to see in
+ the plug-ins setup?
+
+Nothing works, want to report a bug?
+
+Please report bugs to:
+
+ http://projects.vdr-developer.org/projects/plg-ttxtsubs/issues
+
+...and include the following information:
+
+ - VDR version, plug-in version, patch version
+ - VDR's channels.conf and setup.conf
+ - Syslog and stderr messages
+ - If possible the complete patched VDR source tree
+ - If possible a small 5min-recording which should contain subtitles. You can
+ use a service like e.g. use a duckload.com to upload this (the bug-tracker
+ does not allow attachments larger than 5 MB). You should include the delete
+ link, so we can remove the recording after downloading it.
+
+
+Advanced troubleshooting
+-------------------------
+
+The following describes some more detailed troubleshooting procedures but
+is partially deprecated (Especially the references to the ttxtsubs output
+on STDERR or the syslog):
+
Ttxtsubs is made to be fully automatic with no other user settable
settings than preferred subtitling language or languages and a few
appearance options. This is how set top boxes work, and, in my
@@ -30,7 +74,6 @@ the subtitles aren't announced in the channel's "service information",
at least not correctly. You can double check this using dvbsnoop, see
below.
-
To find the subtitles, a DVB receiver as ttxtsubs scans the channel's
"Service Information". This meta data contains information about what
PIDs to use for receiving the channel, such as what PID to use for
@@ -59,14 +102,12 @@ Note that the PID may be different for each language and purpose. This
is one reason why ttxtsubs has to find out the PID itself and doesn't
care at all about how you set up the channel's TPid.
-
To find out what ttxtsubs is doing, you must currently (0.0.5pre2)
look at the stderr output in the shell where you run VDR. In a future
version, it may instead show this in the VDR menus in a more user
friendly manner. At the end of this text you can find some typical
messages from ttxtsubs with explanations.
-
You can use dvbsnoop, http://dvbsnoop.sourceforge.net, to check what
the service information really says.
First dump pid 0 to find the Program Map PID for your channel: