]> git.sesse.net Git - vlc/blobdiff - doc/intf-cdda.txt
Merge branch 'master' of git@git.videolan.org:vlc
[vlc] / doc / intf-cdda.txt
index 20ce4fc8c34c0ad859a177ba2ed7378f464f8037..47a0669c4738ac37c250330b4f00667877b5b2c9 100644 (file)
@@ -1,6 +1,6 @@
 This file documents the ``Extended'' VLC CD-DA Plugin
 
-Copyright (C) 2003 Rocky Bernstein (rocky@panix.com)
+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
@@ -28,7 +28,8 @@ MRL handling:
    support)
 
 Features:
--  Can customize the what to show in the play-list title 
+-  Can customize the what to show in the play-list title and author. 
+-  Duration of each track is shown
 -  Media information is shown using CDDB
 -  Dynamic debugging
 -  Will scan for a CD-ROM drive with a CD-DA loaded in it.
@@ -260,6 +261,11 @@ Troubleshooting Guide
 This gives higher-level troubleshooting. More detailed and
 lower-level information is given in the next section DEBUGGING. 
 
+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 a playlist of
 the CD.
 Determination: start at step 1.
@@ -268,20 +274,74 @@ 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. Do you even have the plugin loaded? 
+-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 libcddb
+
+     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 a playlist of
+    the CD.)
+
+   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
-   you see a expandalbe entry under "access" labeled "cddax"? If so,
+   you see a expandable entry under "access" labeled "cddax"? If so,
    skip on to step 2.
 
-   a) If no "cddax" expandable list, thent the CDDAX plugin isn't
+   a) If no "cddax" expandable list, then the CDDAX plugin isn't
    loaded. Does a shared object exist?  The plugin shared object is
    called "libcddax_plugin.so" It should be in the directory that has
    ...vlc/access. If this isn't around you need to build and install
    the CDDAX plugin.
 
-   b) if libcddax_plugin.so is in the fileystem, there might be a
+   b) if libcddax_plugin.so is in the filesystem, there might be a
    loader error; perhaps libcdio is not installed or
    are the wrong version. Use ldd on the file to see that it has all
    of the libraries dependencies satisfied. Also you might be able
@@ -289,8 +349,8 @@ Determination: start at step 5.
    calls. On Linux and other OS's) "strace" can be used to see if the
    file gets accessed. On Solaris use "truss". 
 
-   For example on Linux, amonst the many line of output when I run
-   "strace -e trace=file vlc" I see this amongst lots of other
+   For example on Linux, among the many line of output when I run
+   "strace -e trace=file vlc" I see this along with a lot of other
    output:
 
    ...
@@ -303,7 +363,7 @@ Determination: start at step 5.
   
    There may also be a message may under "setup/logs".
 
-2. (There plugin was loaded and preferences found).  In the "cddax" tab
+2. (There plugin was loaded and preferences found.)  In the "cddax" tab
    of preference. An important selection is "cddax-device."  If this is
    set to the empty string, CDDAX will try to scan your drives for a
    suitable device if the driver has the capability to scan for
@@ -315,11 +375,11 @@ Determination: start at step 5.
    rather than /dev/cdrom.
 
 3. (CD-DA Setup devices seems correct and there is a CD in the
-   drive).  Bring up the playlist. If you specified only a drive and
+   drive.)  Bring up the playlist. If you specified only a drive and
    no track, you should see in the playlist a list of tracks on the CD.
    
    a. If not something's wrong like step 2. Another tack may be to try
-   to read a disk image of a CD and thus elimate any problems with
+   to read a disk image of a CD and thus eliminate any problems with
    hardware. If this works, then this is a hardware problem. 
 
 4. (You have a list of entries describing the CD-DA or disk-file of
@@ -364,7 +424,7 @@ you see what's going on dynamically. Various debugging settings will
 cause output to appear on vlc's plugin log and/or "standard error"
 (assuming you've run vlc in a way that you can capture this).
 
-You think of debug switches as a bit mask, that you specifiy as an
+You think of debug switches as a bit mask, that you specify as an
 integers the various "bit" values (given in decimal) are listed below.
 
    name    value  description
@@ -376,8 +436,8 @@ integers the various "bit" values (given in decimal) are listed below.
    CALL       16  all calls
    LSN        32  LSN changes
    SEEK       64  Seeks to set location
-   CDIO      128  Debugging from CDIO
-   CDDB      256  CDDB debugging
+   CDIO      128  Debugging from CDIO library routines
+   CDDB      256  debugging from CDDB library routines
 
 **CD debugging...
 
@@ -387,4 +447,4 @@ analyze the contents of a CD.
 The tool cd-read from libcdio can be used to show the sectors of 
 the CD or CD image or extract sectors. 
 
-$Id: intf-cdda.txt,v 1.3 2003/12/02 03:33:22 rocky Exp $
+$Id$