]> git.sesse.net Git - vlc/blob - modules/access/cdda/cdda.c
string review.
[vlc] / 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.16 2004/01/25 14:42:05 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_(DebugCB)      ( vlc_object_t *p_this, const char *psz_name,
45                         vlc_value_t oldval, vlc_value_t val,
46                         void *p_data );
47
48 int  E_(CDDBEnabledCB)( vlc_object_t *p_this, const char *psz_name,
49                         vlc_value_t oldval, vlc_value_t val,
50                         void *p_data );
51
52 /*****************************************************************************
53  * Module descriptor
54  *****************************************************************************/
55
56 /*****************************************************************************
57  * Option help text
58  *****************************************************************************/
59
60 #define DEBUG_LONGTEXT N_( \
61     "This integer when viewed in binary is a debugging mask\n" \
62     "meta info        1\n" \
63     "events           2\n" \
64     "MRL              4\n" \
65     "external call    8\n" \
66     "all calls (10)  16\n" \
67     "LSN       (20)  32\n" \
68     "seek      (40)  64\n" \
69     "libcdio   (80) 128\n" \
70     "libcddb  (100) 256\n" )
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 CDDB_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 "   %n : The number of tracks on the CD\n" \
87 "   %p : The artist/performer/composer in the track\n" \
88 "   %T : The track number\n" \
89 "   %s : Number of seconds in this track \n" \
90 "   %t : The title\n" \
91 "   %Y : The year 19xx or 20xx\n" \
92 "   %% : a % \n")
93
94 #define TITLE_FMT_LONGTEXT N_( \
95 "Format used in the GUI Playlist Title. Similar to the Unix date \n" \
96 "Format specifiers that start with a percent sign. Specifiers are: \n" \
97 "   %M : The current MRL\n" \
98 "   %m : The CD-DA Media Catalog Number (MCN)\n" \
99 "   %n : The number of tracks on the CD\n" \
100 "   %T : The track number\n" \
101 "   %s : Number of seconds in this track \n" \
102 "   %% : a % \n")
103
104 /*****************************************************************************
105  * Module descriptor
106  *****************************************************************************/
107
108 vlc_module_begin();
109     add_usage_hint( N_("cddax://[device-or-file][@[T]num]") );
110     set_description( _("Compact Disc Digital Audio (CD-DA) input") );
111     set_capability( "access", 75 /* slightly higher than cdda */ );
112     set_callbacks( E_(Open), E_(Close) );
113     add_shortcut( "cdda" );
114     add_shortcut( "cddax" );
115
116     /* Configuration options */
117     add_category_hint( N_("CDX"), NULL, VLC_TRUE );
118
119     add_integer ( MODULE_STRING "-debug", 0, E_(DebugCB),
120                   N_("If nonzero, this gives additional debug information."),
121                   DEBUG_LONGTEXT, VLC_TRUE );
122
123     add_integer( MODULE_STRING "-caching",
124                  DEFAULT_PTS_DELAY / 1000, NULL,
125                  N_("Caching value in microseconds"),
126                  CACHING_LONGTEXT, VLC_TRUE );
127
128     add_string( MODULE_STRING "-author-format",
129                 "%A - %a %C %I", NULL,
130                 N_("Format to use in playlist \"author\" field"),
131                 TITLE_FMT_LONGTEXT, VLC_TRUE );
132
133     add_string( MODULE_STRING "-title-format",
134                 "%T %M", NULL,
135                 N_("Format to use in playlist \"title\" field when no CDDB"),
136                 TITLE_FMT_LONGTEXT, VLC_TRUE );
137
138 #ifdef HAVE_LIBCDDB
139     add_string( MODULE_STRING "-cddb-title-format",
140                 "Track %T. %t - %p", NULL,
141                 N_("Format to use in playlist \"title\" field when using CDDB"),
142                 CDDB_TITLE_FMT_LONGTEXT, VLC_TRUE );
143
144     add_bool( MODULE_STRING "-cddb-enabled", 1, E_(CDDBEnabledCB),
145               N_("Do CDDB lookups?"),
146               N_("If set, lookup CD-DA track information using the CDDB "
147                  "protocol"),
148               VLC_FALSE );
149
150     add_string( MODULE_STRING "-cddb-server", "freedb.freedb.org", NULL,
151                 N_("CDDB server"),
152                 N_( "Contact this CDDB server look up CD-DA information"),
153                  VLC_TRUE );
154
155     add_integer( MODULE_STRING "-cddb-port", 8880, NULL,
156                  N_("CDDB server port"),
157                  N_("CDDB server uses this port number to communicate on"),
158                  VLC_TRUE );
159
160     add_string( MODULE_STRING "-cddb-email", "me@home", NULL,
161                 N_("email address reported to CDDB server"),
162                 N_("email address reported to CDDB server"),
163                  VLC_TRUE );
164
165     add_bool( MODULE_STRING "-cddb-enable-cache", 1, NULL,
166               N_("Cache CDDB lookups?"),
167               N_("If set cache CDDB information about this CD"),
168               VLC_FALSE );
169
170     add_bool( MODULE_STRING "-cddb-httpd", 0, NULL,
171               N_("Contact CDDB via the HTTP protocol?"),
172               N_("If set, the CDDB server gets information via the CDDB HTTP "
173                  "protocol"),
174               VLC_TRUE );
175
176     add_integer( MODULE_STRING "-cddb-timeout", 10, NULL,
177                  N_("CDDB server timeout"),
178                  N_("Time (in seconds) to wait for a response from the "
179                     "CDDB server"),
180                  VLC_FALSE );
181
182     add_string( MODULE_STRING "-cddb-cachedir", "~/.cddbslave", NULL,
183                 N_("Directory to cache CDDB requests"),
184                 N_("Directory to cache CDDB requests"),
185                  VLC_TRUE );
186
187 #endif
188
189     add_submodule();
190         set_description( _("Audio CD demux") );
191         set_capability( "demux", 0 );
192         set_callbacks( E_(DemuxOpen), E_(DemuxClose) );
193         add_shortcut( "cdda" );
194
195 vlc_module_end();