git.sesse.net Git - vlc/blob - modules/access/cdda/cdda.c

   1 /*****************************************************************************
   2  * cddax.c : CD digital audio input module for vlc using libcdio
   3  *****************************************************************************
   4  * Copyright (C) 2000,2003 VideoLAN
   5  * $Id: cdda.c,v 1.5 2003/12/01 01:08:42 rocky Exp $
   6  *
   7  * Authors: Rocky Bernstein <rocky@panix.com>
   8  *          Laurent Aimar <fenrir@via.ecp.fr>
   9  *          Gildas Bazin <gbazin@netcourrier.com>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  24  *****************************************************************************/
  25
  26 /*****************************************************************************
  27  * Preamble
  28  *****************************************************************************/
  29
  30 #include <vlc/vlc.h>
  31
  32
  33 /*****************************************************************************
  34  * prototypes
  35  *****************************************************************************/
  36 int  E_(Open)         ( vlc_object_t * );
  37 void E_(Close)        ( vlc_object_t * );
  38
  39 int  E_(OpenIntf)     ( vlc_object_t * );
  40 void E_(CloseIntf)    ( vlc_object_t * );
  41 int  E_(DemuxOpen)    ( vlc_object_t * p_this);
  42 void E_(DemuxClose)   ( vlc_object_t * p_this);
  43
  44 int  E_(DebugCallback)       ( vlc_object_t *p_this, const char *psz_name,
  45                                vlc_value_t oldval, vlc_value_t val,
  46                                void *p_data );
  47
  48 /*****************************************************************************
  49  * Module descriptor
  50  *****************************************************************************/
  51
  52 /*****************************************************************************
  53  * Option help text
  54  *****************************************************************************/
  55
  56 #define DEBUG_LONGTEXT N_( \
  57     "This integer when viewed in binary is a debugging mask\n" \
  58     "meta info        1\n" \
  59     "events           2\n" \
  60     "MRL              4\n" \
  61     "external call    8\n" \
  62     "all calls (10)  16\n" \
  63     "LSN       (20)  32\n" \
  64     "seek      (40)  64\n" \
  65     "libcdio   (80) 128\n" \
  66     "libcddb  (100) 256\n" )
  67
  68 #define DEV_LONGTEXT N_( \
  69     "Specify the name of the CD-ROM device that will be used by default. " \
  70     "If you don't specify anything, we'll scan for a suitable CD-ROM device.")
  71
  72 #define CACHING_LONGTEXT N_( \
  73     "Allows you to modify the default caching value for cdda streams. This " \
  74     "value should be set in millisecond units." )
  75
  76 #define TITLE_FMT_LONGTEXT N_( \
  77 "Format used in the GUI Playlist Title. Similar to the Unix date \n" \
  78 "Format specifiers that start with a percent sign. Specifiers are: \n" \
  79 "   %a : The artist\n" \
  80 "   %A : The album information \n" \
  81 "   %C : Category\n" \
  82 "   %I : CDDB disk ID\n" \
  83 "   %G : Genre\n" \
  84 "   %M : The current MRL\n" \
  85 "   %m : The CD-DA Media Catalog Number (MCN)\n" \
  86 "   %p : The artist/performer/composer in the track \n" \
  87 "   %T : The track number\n" \
  88 "   %s : Number of seconds in this track \n" \
  89 "   %t : The name\n" \
  90 "   %Y : The year 19xx or 20xx\n" \
  91 "   %% : a %\n")
  92
  93 #ifdef HAVE_LIBCDDB
  94 #define DEFAULT_TITLE_FORMAT "Track %T. %t - %p %s",
  95 #else
  96 #define DEFAULT_TITLE_FORMAT "%T %M",
  97 #endif
  98
  99 /*****************************************************************************
 100  * Module descriptor
 101  *****************************************************************************/
 102
 103 vlc_module_begin();
 104     add_usage_hint( N_("cddax://[device-or-file][@[T]num]") );
 105     set_description( _("Compact Disc Digital Audio (CD-DA) input") );
 106     set_capability( "access", 75 /* slightly higher than cdda */ );
 107     set_callbacks( E_(Open), E_(Close) );
 108     add_shortcut( "cdda" );
 109     add_shortcut( "cddax" );
 110
 111     /* Configuration options */
 112     add_category_hint( N_("CDX"), NULL, VLC_TRUE );
 113
 114     add_integer ( MODULE_STRING "-debug", 0, E_(DebugCallback),
 115                   N_("set debug mask for additional debugging."),
 116                   DEBUG_LONGTEXT, VLC_TRUE );
 117
 118     add_integer( MODULE_STRING "-caching",
 119                  DEFAULT_PTS_DELAY / 1000, NULL,
 120                  N_("Caching value in ms"),
 121                  CACHING_LONGTEXT, VLC_TRUE );
 122
 123     add_string( MODULE_STRING "-device", "", NULL,
 124                 N_("CD-ROM device name"),
 125                 DEV_LONGTEXT, VLC_FALSE );
 126
 127     add_string( MODULE_STRING "-title-format", DEFAULT_TITLE_FORMAT, NULL,
 128                 N_("Format to use in playlist 'title' field"),
 129                 TITLE_FMT_LONGTEXT, VLC_TRUE );
 130
 131 #ifdef HAVE_LIBCDDB
 132     add_bool( MODULE_STRING "-cddb-enabled", 1, NULL,
 133               N_("Do CDDB lookups?"),
 134               N_("If set, lookup CD-DA track information using the CDDB "
 135                  "protocol"),
 136               VLC_FALSE );
 137
 138     add_string( MODULE_STRING "-cddb-server", "freedb.freedb.org", NULL,
 139                 N_("CDDB server"),
 140                 N_( "Contact this CDDB server look up CD-DA information"),
 141                  VLC_TRUE );
 142
 143     add_integer( MODULE_STRING "-cddb-port", 8880, NULL,
 144                  N_("CDDB server port"),
 145                  N_("CDDB server uses this port number to communicate on"),
 146                  VLC_TRUE );
 147
 148     add_string( MODULE_STRING "-cddb-email", "me@home", NULL,
 149                 N_("email address reported to CDDB server"),
 150                 N_("email address reported to CDDB server"),
 151                  VLC_TRUE );
 152
 153     add_bool( MODULE_STRING "-cddb-enable-cache", 1, NULL,
 154               N_("Cache CDDB lookups?"),
 155               N_("If set cache CDDB information about this CD"),
 156               VLC_FALSE );
 157
 158     add_bool( MODULE_STRING "-cddb-httpd", 0, NULL,
 159               N_("Contact CDDB via the HTTP protocol?"),
 160               N_("If set, the CDDB server get information via the CDDB HTTP "
 161                  "protocol"),
 162               VLC_TRUE );
 163
 164     add_integer( MODULE_STRING "-cddb-timeout", 10, NULL,
 165                  N_("CDDB server timeout"),
 166                  N_("Time (in seconds) to wait for a response from the "
 167                     "CDDB server"),
 168                  VLC_FALSE );
 169
 170     add_string( MODULE_STRING "-cddb-cachedir", "~/.cddbslave", NULL,
 171                 N_("Directory to cache CDDB requests"),
 172                 N_("Directory to cache CDDB requests"),
 173                  VLC_TRUE );
 174
 175 #endif
 176
 177     add_submodule();
 178         set_description( _("CD Audio demux") );
 179         set_capability( "demux", 0 );
 180         set_callbacks( E_(DemuxOpen), E_(DemuxClose) );
 181         add_shortcut( "cdda" );
 182
 183     add_submodule();
 184         set_capability( "interface", 0 );
 185         set_callbacks( E_(OpenIntf), E_(CloseIntf) );
 186
 187 vlc_module_end();