+This file documents the ``Extended'' VLC Video CD Plugin
+
+Copyright (C) 2003, 2004 Rocky Bernstein (rocky@panix.com)
+
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.1 or
+any later version published by the Free Software Foundation; with the
+Invariant Sections being ``Free Software'' and ``Free Software Needs
+Free Documentation'', with the Front-Cover Texts being ``A GNU Manual,''
+and with the Back-Cover Texts as in (a) below.
+
+(a) The Free Software Foundation's Back-Cover Text is: ``You have
+freedom to copy and modify this GNU Manual, like GNU software. Copies
+published by the Free Software Foundation raise funds for GNU
+development.''
+
-----------------------------------------------------------------
Quick start
-----------------------------------------------------------------
that doesn't have to happen switching between entries because there in
fact is no gap.
-Another unit we use is a called a "segment." These are used in menus
-an still frames. A menu doesn't have to have a still-frame associated
-with it; A menu might be implimented as a short looped movie clip.
-However Video CD specifications allow still frames to have higher
-resolution than motion clips. And several segments can reside in track
-0.
-
-A "playback list item" (also called a "list id or LID) combines
-"entries" and "segments" and "tracks" together with some navigation
-logic. "Playback Control" is simply starting playback at a particular
-playback list item, and unless otherwise specified you'd start with
-the first playback item which we call P1.
+Another unit we use is a called a "segment." These are just the
+playable units in track 0. Segments come in fixed-length units so
+several may be combined to form a single logical playable unit. Still
+frames for menus are segments. A menu doesn't have to have a
+still-frame associated with it; a menu might be implemented as a short
+looped movie clip. But all still frames are segments. Also, Video CD
+specifications allow still frames to have higher resolution than
+motion clips. All segments reside in track 0.
+
+A "list ID" (also called a LID and and is one greater than a Play
+Sequence descripter or "PSD" number) combines "entries" and "segments"
+and "tracks" together with some navigation logic. "Playback Control"
+(acronym PBC) is simply starting playback at a particular LID, and
+unless otherwise specified you'd start with the first playback item
+which we call P1.
Below we will refer to an "item" as combination of a unit name (track,
entry, segment, playback) and a whole number.
vcdx:///dev/cdrom@S1 - Play segment 1 from /dev/cdrom. This
assumes there *is* a segment 1. Check
the MRL list to see if that is the case.
-vcdx://@P1 - Play Playlist item 1 from default device
+vcdx://@P1 - Play LID item 1 from default device
If there is no playback control, MRL will
- get converted into vcdx:/:E0. Again
+ get converted into vcdx://@E0. Again
check the MRL list to see if there is a P1.
vcdx://@P1* - probably same as above.
vcdx:///dev/cdrom@E1 - Play Entry id 1 from default device
This gives higher-level troubleshooting. More detailed and
lower-level information is given in the next section DEBUGGING.
-1. Do you even have the plugin loaded?
+Problem: something doesn't work. Start at step -1.
+
+Problem: The program gets a SEGFAULT or gives core dump. Start at step
+0.
+
+Problem: I don't get anything playing. I can't even get information
+listed in "Media and Stream Information" or the playlist.
+Determination: start at step 1.
+
+Problem: Okay, I something plays menu now. But I don't see information
+about the CD in the playlist.
+Determination: start at step 5.
+
+
+-1. (Something doesn't work.)
+
+ A lot of what is put here really is applicable to reporting
+ problems and troubleshooting in vlc and the concepts really
+ apply to any sort of bug reporting.
+
+ When reporting a problem it's helpful to have facts:
+
+ a) the version of vlc) you are using
+
+ b) the OS you are running on
+
+ c) the version of libcdio and/or libcddb you are using
+ versions of libcdio and libcddb can be obtained by running
+ pkg-config --modversion libcdio
+ pkg-config --modversion libvcdinfo
+
+ d) what you input or requested (e.g. the full command line entered -
+ if it is possible to reproduce the problem by giving a
+ commandline that is desirable since it is probably the simplest
+ way to convey exactly what was requested)
+
+ People often give (some part) of an error message neglecting
+ to also include what was requested or entered that led to the
+ output.
+
+ e) The setting for this plugin. That is the values of the
+ variables that start cddax- listed above. On Unix this can
+ generally be found in ~/.vlc/vlcrc
+
+
+ f) Exactly the messages that were what given. You can turn
+ increase the verbosity level by setting "verbosity=2" in the
+ vlc preferences files. On Unix the preferences file is
+ generally in ~/vlc/.vlcrc but there are GUI ways to set this
+ too. Give everything that is in the message log.
+
+0. (The program gets a SEGFAULT or gives core dump.)
+
+ Get and send a stack trace.
+
+ In addition to -1. Make sure the program has been compiled with
+ debugging symbols put into the code. This is usually done by having
+ the "-g" flag set when compiling the program.
+
+ You can get a strack trace the GNU debugger using the "where"
+ command. For example on this might work:
+
+ gdb vlc *name-of-corefile*
+ where
+
+
+1. (I don't get anything playing. I can't even get information
+ listed in "Media and Stream Information" or the playlist)
+
+ Do you even have the plugin loaded?
When you run the vlc GUI, under Settings/Preferences you should see
a "plugins" expandable list and under that another "access" list do
http://www.vcdimager.org/
http://www.vcdimager.org/guides/#guides
-$Id: intf-vcd.txt,v 1.1 2003/11/23 17:06:43 rocky Exp $
+$Id$