Fix a bunch of warnings and errors
[vlc.git] / modules / access / cdda.c
1 /*****************************************************************************
2  * cdda.c : CD digital audio input module for vlc
3  *****************************************************************************
4  * Copyright (C) 2000, 2003 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
8  *          Gildas Bazin <gbazin@netcourrier.com>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 /**
26  * Todo:
27  *   - Improve CDDB support (non-blocking, cache, ...)
28  *   - Fix tracknumber in MRL
29  */
30
31 /*****************************************************************************
32  * Preamble
33  *****************************************************************************/
34 #include <stdlib.h>
35
36 #include <vlc/vlc.h>
37 #include <vlc/input.h>
38
39 #include "codecs.h"
40 #include "vcd/cdrom.h"
41
42 #include <vlc_playlist.h>
43
44 #ifdef HAVE_LIBCDDB
45 #include <cddb/cddb.h>
46 #endif
47
48 #ifdef HAVE_ERRNO_H
49 #include <errno.h>
50 #endif
51
52 /*****************************************************************************
53  * Module descriptior
54  *****************************************************************************/
55 static int  Open ( vlc_object_t * );
56 static void Close( vlc_object_t * );
57
58 #define CACHING_TEXT N_("Caching value in ms")
59 #define CACHING_LONGTEXT N_( \
60     "Default caching value for Audio CDs. This " \
61     "value should be set in milliseconds." )
62
63 vlc_module_begin();
64     set_shortname( _("Audio CD"));
65     set_description( _("Audio CD input") );
66     set_capability( "access2", 10 );
67     set_category( CAT_INPUT );
68     set_subcategory( SUBCAT_INPUT_ACCESS );
69     set_callbacks( Open, Close );
70
71     add_usage_hint( N_("[cdda:][device][@[track]]") );
72     add_integer( "cdda-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT,
73                  CACHING_LONGTEXT, VLC_TRUE );
74
75     add_integer( "cdda-track", -1 , NULL, NULL, NULL, VLC_TRUE );
76         change_internal();
77     add_integer( "cdda-first-sector", -1, NULL, NULL, NULL, VLC_TRUE );
78         change_internal();
79     add_integer( "cdda-last-sector", -1, NULL, NULL, NULL, VLC_TRUE );
80         change_internal();
81
82     add_string( "cddb-server", "freedb.freedb.org", NULL,
83                 N_( "CDDB Server" ), N_( "Address of the CDDB server to use." ),
84                 VLC_TRUE );
85     add_integer( "cddb-port", 8880, NULL,
86                 N_( "CDDB port" ), N_( "CDDB Server port to use." ),
87                 VLC_TRUE );
88     add_shortcut( "cdda" );
89     add_shortcut( "cddasimple" );
90 vlc_module_end();
91
92
93 /* how many blocks VCDRead will read in each loop */
94 #define CDDA_BLOCKS_ONCE 20
95 #define CDDA_DATA_ONCE   (CDDA_BLOCKS_ONCE * CDDA_DATA_SIZE)
96
97 /*****************************************************************************
98  * Access: local prototypes
99  *****************************************************************************/
100 struct access_sys_t
101 {
102     vcddev_t    *vcddev;                            /* vcd device descriptor */
103
104     /* Current position */
105     int         i_sector;                                  /* Current Sector */
106     int *       p_sectors;                                  /* Track sectors */
107
108     /* Wave header for the output data */
109     WAVEHEADER  waveheader;
110     vlc_bool_t  b_header;
111
112     int         i_track;
113     int         i_first_sector;
114     int         i_last_sector;
115
116 #ifdef HAVE_LIBCDDB
117     cddb_disc_t *p_disc;
118 #endif
119 };
120
121 static block_t *Block( access_t * );
122 static int      Seek( access_t *, int64_t );
123 static int      Control( access_t *, int, va_list );
124
125 static int GetTracks( access_t *p_access, playlist_t *p_playlist,
126                       playlist_item_t *p_parent );
127
128 #ifdef HAVE_LIBCDDB
129 static void GetCDDBInfo( access_t *p_access, int i_titles, int *p_sectors );
130 #endif
131
132 /*****************************************************************************
133  * Open: open cdda
134  *****************************************************************************/
135 static int Open( vlc_object_t *p_this )
136 {
137     access_t     *p_access = (access_t*)p_this;
138     access_sys_t *p_sys;
139     vcddev_t *vcddev;
140     char *psz_name;
141     int i_mrl_tracknum = -1;
142
143     input_thread_t *p_input;
144     playlist_item_t *p_item = NULL;
145     playlist_t *p_playlist  = NULL;
146     int i_ret;
147
148     if( !p_access->psz_path || !*p_access->psz_path )
149     {
150         /* Only when selected */
151         if( !p_this->b_force ) return VLC_EGENERIC;
152
153         psz_name = var_CreateGetString( p_this, "cd-audio" );
154         if( !psz_name || !*psz_name )
155         {
156             if( psz_name ) free( psz_name );
157             return VLC_EGENERIC;
158         }
159     }
160     else psz_name = strdup( p_access->psz_path );
161
162 #ifdef WIN32
163     if( psz_name[0] && psz_name[1] == ':' &&
164         psz_name[2] == '\\' && psz_name[3] == '\0' ) psz_name[2] = '\0';
165 #endif
166
167     /* Open CDDA */
168     if( (vcddev = ioctl_Open( VLC_OBJECT(p_access), psz_name )) == NULL )
169     {
170         msg_Warn( p_access, "could not open %s", psz_name );
171         free( psz_name );
172         return VLC_EGENERIC;
173     }
174     free( psz_name );
175
176     /* Set up p_access */
177     STANDARD_BLOCK_ACCESS_INIT
178     p_sys->vcddev = vcddev;
179
180     /* We only do separate items if the whole disc is requested -
181      *  Dirty hack we access some private data ! */
182     p_input = (input_thread_t *)( p_access->p_parent );
183
184    /* Do we play a single track ? */
185    p_sys->i_track = var_CreateGetInteger( p_access, "cdda-track" );
186
187    if( p_sys->i_track < 0 && i_mrl_tracknum <= 0 )
188    {
189         p_playlist = (playlist_t *) vlc_object_find( p_access,
190                                        VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
191         if( !p_playlist ) return VLC_EGENERIC;
192
193         if( p_playlist->status.p_item->p_input ==
194              ((input_thread_t *)p_access->p_parent)->input.p_item )
195             p_item = p_playlist->status.p_item;
196         else
197         {
198             input_item_t *p_current = ( (input_thread_t*)p_access->p_parent)->
199                                          input.p_item;
200             p_item = playlist_LockItemGetByInput( p_playlist, p_current );
201
202             if( !p_item )
203             {
204                 msg_Dbg( p_playlist, "unable to find item in playlist");
205                 return -1;
206             }
207         }
208
209         i_ret = GetTracks( p_access, p_playlist, p_item );
210
211         if( p_playlist ) vlc_object_release( p_playlist );
212         if( i_ret < 0 ) goto error;
213     }
214     else
215     {
216         /* Build a WAV header for the output data */
217         memset( &p_sys->waveheader, 0, sizeof(WAVEHEADER) );
218         SetWLE( &p_sys->waveheader.Format, 1 ); /*WAVE_FORMAT_PCM*/
219         SetWLE( &p_sys->waveheader.BitsPerSample, 16);
220         p_sys->waveheader.MainChunkID = VLC_FOURCC('R', 'I', 'F', 'F');
221         p_sys->waveheader.Length = 0;               /* we just don't know */
222         p_sys->waveheader.ChunkTypeID = VLC_FOURCC('W', 'A', 'V', 'E');
223         p_sys->waveheader.SubChunkID = VLC_FOURCC('f', 'm', 't', ' ');
224         SetDWLE( &p_sys->waveheader.SubChunkLength, 16);
225         SetWLE( &p_sys->waveheader.Modus, 2);
226         SetDWLE( &p_sys->waveheader.SampleFreq, 44100);
227         SetWLE( &p_sys->waveheader.BytesPerSample,
228                     2 /*Modus*/ * 16 /*BitsPerSample*/ / 8 );
229         SetDWLE( &p_sys->waveheader.BytesPerSec,
230                     2*16/8 /*BytesPerSample*/ * 44100 /*SampleFreq*/ );
231         p_sys->waveheader.DataChunkID = VLC_FOURCC('d', 'a', 't', 'a');
232         p_sys->waveheader.DataLength = 0;           /* we just don't know */
233
234         p_sys->i_first_sector = var_CreateGetInteger( p_access,
235                                                       "cdda-first-sector" );
236         p_sys->i_last_sector  = var_CreateGetInteger( p_access,
237                                                       "cdda-last-sector" );
238         /* Tracknumber in MRL */
239         if( p_sys->i_first_sector < 0 || p_sys->i_last_sector < 0 )
240         {
241             int i_titles;
242             if( i_mrl_tracknum <= 0 )
243             {
244                 msg_Err( p_access, "wrong sector information" );
245                 goto error;
246             }
247             i_titles = ioctl_GetTracksMap( VLC_OBJECT(p_access),
248                                             p_sys->vcddev, &p_sys->p_sectors );
249         }
250
251
252         p_sys->i_sector = p_sys->i_first_sector;
253         p_access->info.i_size = (p_sys->i_last_sector - p_sys->i_first_sector)
254                                      * (int64_t)CDDA_DATA_SIZE;
255     }
256
257     /* PTS delay */
258     var_Create( p_access, "cdda-caching", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
259
260     return VLC_SUCCESS;
261
262 error:
263     ioctl_Close( VLC_OBJECT(p_access), p_sys->vcddev );
264     free( p_sys );
265     if( p_playlist ) vlc_object_release( p_playlist );
266     return VLC_EGENERIC;
267 }
268
269 /*****************************************************************************
270  * Close: closes cdda
271  *****************************************************************************/
272 static void Close( vlc_object_t *p_this )
273 {
274     access_t     *p_access = (access_t *)p_this;
275     access_sys_t *p_sys = p_access->p_sys;
276     ioctl_Close( p_this, p_sys->vcddev );
277     free( p_sys );
278 }
279
280 /*****************************************************************************
281  * Block: read data (CDDA_DATA_ONCE)
282  *****************************************************************************/
283 static block_t *Block( access_t *p_access )
284 {
285     access_sys_t *p_sys = p_access->p_sys;
286     int i_blocks = CDDA_BLOCKS_ONCE;
287     block_t *p_block;
288
289     if( p_sys->i_track < 0 ) p_access->info.b_eof = VLC_TRUE;
290
291     /* Check end of file */
292     if( p_access->info.b_eof ) return NULL;
293
294     if( !p_sys->b_header )
295     {
296         /* Return only the header */
297         p_block = block_New( p_access, sizeof( WAVEHEADER ) );
298         memcpy( p_block->p_buffer, &p_sys->waveheader, sizeof(WAVEHEADER) );
299         p_sys->b_header = VLC_TRUE;
300         return p_block;
301     }
302
303     if( p_sys->i_sector >= p_sys->i_last_sector )
304     {
305         p_access->info.b_eof = VLC_TRUE;
306         return NULL;
307     }
308
309     /* Don't read too far */
310     if( p_sys->i_sector + i_blocks >= p_sys->i_last_sector )
311         i_blocks = p_sys->i_last_sector - p_sys->i_sector;
312
313     /* Do the actual reading */
314     if( !( p_block = block_New( p_access, i_blocks * CDDA_DATA_SIZE ) ) )
315     {
316         msg_Err( p_access, "cannot get a new block of size: %i",
317                  i_blocks * CDDA_DATA_SIZE );
318         return NULL;
319     }
320
321     if( ioctl_ReadSectors( VLC_OBJECT(p_access), p_sys->vcddev,
322             p_sys->i_sector, p_block->p_buffer, i_blocks, CDDA_TYPE ) < 0 )
323     {
324         msg_Err( p_access, "cannot read sector %i", p_sys->i_sector );
325         block_Release( p_block );
326
327         /* Try to skip one sector (in case of bad sectors) */
328         p_sys->i_sector++;
329         p_access->info.i_pos += CDDA_DATA_SIZE;
330         return NULL;
331     }
332
333     /* Update a few values */
334     p_sys->i_sector += i_blocks;
335     p_access->info.i_pos += p_block->i_buffer;
336
337     return p_block;
338 }
339
340 /****************************************************************************
341  * Seek
342  ****************************************************************************/
343 static int Seek( access_t *p_access, int64_t i_pos )
344 {
345     access_sys_t *p_sys = p_access->p_sys;
346
347     /* Next sector to read */
348     p_sys->i_sector = p_sys->i_first_sector + i_pos / CDDA_DATA_SIZE;
349     p_access->info.i_pos = i_pos;
350
351     return VLC_SUCCESS;
352 }
353
354 /*****************************************************************************
355  * Control:
356  *****************************************************************************/
357 static int Control( access_t *p_access, int i_query, va_list args )
358 {
359     vlc_bool_t   *pb_bool;
360     int          *pi_int;
361     int64_t      *pi_64;
362
363     switch( i_query )
364     {
365         case ACCESS_CAN_SEEK:
366         case ACCESS_CAN_FASTSEEK:
367         case ACCESS_CAN_PAUSE:
368         case ACCESS_CAN_CONTROL_PACE:
369             pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
370             *pb_bool = VLC_TRUE;
371             break;
372
373         case ACCESS_GET_MTU:
374             pi_int = (int*)va_arg( args, int * );
375             *pi_int = CDDA_DATA_ONCE;
376             break;
377
378         case ACCESS_GET_PTS_DELAY:
379             pi_64 = (int64_t*)va_arg( args, int64_t * );
380             *pi_64 = var_GetInteger( p_access, "cdda-caching" ) * 1000;
381             break;
382
383         case ACCESS_SET_PAUSE_STATE:
384         case ACCESS_GET_TITLE_INFO:
385         case ACCESS_SET_TITLE:
386         case ACCESS_GET_META:
387         case ACCESS_SET_SEEKPOINT:
388         case ACCESS_SET_PRIVATE_ID_STATE:
389             return VLC_EGENERIC;
390
391         default:
392             msg_Warn( p_access, "unimplemented query in control" );
393             return VLC_EGENERIC;
394
395     }
396     return VLC_SUCCESS;
397 }
398
399 static int GetTracks( access_t *p_access,
400                       playlist_t *p_playlist, playlist_item_t *p_parent )
401 {
402     access_sys_t *p_sys = p_access->p_sys;
403     int i, i_titles;
404     input_item_t *p_input_item;
405     playlist_item_t *p_item_in_category;
406     char *psz_name;
407     i_titles = ioctl_GetTracksMap( VLC_OBJECT(p_access),
408                                    p_sys->vcddev, &p_sys->p_sectors );
409     if( i_titles < 0 )
410     {
411         msg_Err( p_access, "unable to count tracks" );
412         return VLC_EGENERIC;;
413     }
414     else if( i_titles <= 0 )
415     {
416         msg_Err( p_access, "no audio tracks found" );
417         return VLC_EGENERIC;
418     }
419
420     p_item_in_category = playlist_LockItemToNode( p_playlist, p_parent );
421     psz_name = strdup( "Audio CD" );
422     vlc_mutex_lock( &p_playlist->object_lock );
423     playlist_ItemSetName( p_parent, psz_name );
424     vlc_mutex_unlock( &p_playlist->object_lock );
425     var_SetInteger( p_playlist, "item-change", p_parent->p_input->i_id );
426     free( psz_name );
427
428 #ifdef HAVE_LIBCDDB
429     GetCDDBInfo( p_access, i_titles, p_sys->p_sectors );
430     if( p_sys->p_disc )
431     {
432         if( cddb_disc_get_title( p_sys->p_disc ) )
433         {
434             asprintf( &psz_name, "%s", cddb_disc_get_title( p_sys->p_disc ) );
435             vlc_mutex_lock( &p_playlist->object_lock );
436             playlist_ItemSetName( p_parent, psz_name );
437             vlc_mutex_unlock( &p_playlist->object_lock );
438             var_SetInteger( p_playlist, "item-change",
439                             p_parent->p_input->i_id );
440             free( psz_name );
441         }
442     }
443 #endif
444
445     /* Build title table */
446     for( i = 0; i < i_titles; i++ )
447     {
448         msg_Dbg( p_access, "track[%d] start=%d", i, p_sys->p_sectors[i] );
449         char *psz_uri, *psz_opt, *psz_first, *psz_last;
450         int i_path_len = p_access->psz_path ? strlen( p_access->psz_path ) : 0;
451
452         psz_name = (char*)malloc( strlen( _("Audio CD - Track ") ) + 5 );
453         psz_opt = (char*)malloc( strlen( "cdda-track=" ) + 3 );
454         psz_first = (char*)malloc( strlen( "cdda-first-sector=" ) + 7 );
455         psz_last = (char*)malloc( strlen( "cdda-last-sector=" ) + 7 );
456         psz_uri = (char*)malloc( i_path_len + 13 );
457
458         snprintf( psz_uri, i_path_len + 13, "cdda://%s",
459                            p_access->psz_path ? p_access->psz_path : "" );
460         sprintf( psz_opt, "cdda-track=%i", i+1 );
461         sprintf( psz_first, "cdda-first-sector=%i",p_sys->p_sectors[i] );
462
463 //        if( i != i_titles -1 )
464             sprintf( psz_last, "cdda-last-sector=%i", p_sys->p_sectors[i+1] );
465 //         else
466 //            sprintf( psz_last, "cdda-last-sector=%i", 1242 /* FIXME */);
467
468         /* Define a "default name" */
469         sprintf( psz_name, _("Audio CD - Track %i"), (i+1) );
470
471         /* Create playlist items */
472         p_input_item = input_ItemNewWithType( VLC_OBJECT( p_playlist ),
473                                               psz_uri, psz_name, 0, NULL, -1,
474                                               ITEM_TYPE_DISC );
475         vlc_input_item_AddOption( p_input_item, psz_first );
476         vlc_input_item_AddOption( p_input_item, psz_last );
477         vlc_input_item_AddOption( p_input_item, psz_opt );
478
479 #ifdef HAVE_LIBCDDB
480         /* If we have CDDB info, change the name */
481         if( p_sys->p_disc )
482         {
483             char *psz_result;
484             cddb_track_t *t = cddb_disc_get_track( p_sys->p_disc, i );
485             if( t!= NULL )
486             {
487                 if( cddb_track_get_title( t )  != NULL )
488                 {
489                     vlc_input_item_AddInfo( p_input_item, _(VLC_META_INFO_CAT),
490                                             _(VLC_META_TITLE),
491                                             cddb_track_get_title( t ) );
492                     if( p_input_item->psz_name )
493                         free( p_input_item->psz_name );
494                     asprintf( &p_input_item->psz_name, "%s",
495                               cddb_track_get_title( t ) );
496                 }
497                 psz_result = cddb_track_get_artist( t );
498                 if( psz_result )
499                 {
500                     vlc_input_item_AddInfo( p_input_item, _(VLC_META_INFO_CAT),
501                                             _(VLC_META_ARTIST), psz_result );
502                 }
503             }
504         }
505 #endif
506         playlist_AddWhereverNeeded( p_playlist, p_input_item, p_parent,
507                                p_item_in_category, VLC_FALSE, PLAYLIST_APPEND );
508         free( psz_uri ); free( psz_opt ); free( psz_name );
509         free( psz_first ); free( psz_last );
510     }
511     return VLC_SUCCESS;
512 }
513
514 #ifdef HAVE_LIBCDDB
515 static void GetCDDBInfo( access_t *p_access, int i_titles, int *p_sectors )
516 {
517     int i, i_matches;
518     int64_t  i_length = 0, i_size = 0;
519     cddb_conn_t  *p_cddb = cddb_new();
520
521     if( !p_cddb )
522     {
523         msg_Warn( p_access, "unable to use CDDB" );
524         goto cddb_destroy;
525     }
526
527     cddb_set_email_address( p_cddb, "vlc@videolan.org" );
528     cddb_set_server_name( p_cddb, config_GetPsz( p_access, "cddb-server" ) );
529     cddb_set_server_port( p_cddb, config_GetInt( p_access, "cddb-port" ) );
530
531     /// \todo
532     cddb_cache_disable( p_cddb );
533
534 //    cddb_cache_set_dir( p_cddb,
535 //                     config_GetPsz( p_access,
536 //                                    MODULE_STRING "-cddb-cachedir") );
537
538     cddb_set_timeout( p_cddb, 10 );
539
540     /// \todo
541     cddb_http_disable( p_cddb);
542
543     p_access->p_sys->p_disc = cddb_disc_new();
544
545     if(! p_access->p_sys->p_disc )
546     {
547         msg_Err( p_access, "unable to create CDDB disc structure." );
548         goto cddb_end;
549     }
550
551     for(i = 0; i < i_titles ; i++ )
552     {
553         cddb_track_t *t = cddb_track_new();
554         cddb_track_set_frame_offset(t, p_sectors[i] );
555         cddb_disc_add_track( p_access->p_sys->p_disc, t );
556         i_size = ( p_sectors[i+1] - p_sectors[i] ) *
557                    (int64_t)CDDA_DATA_SIZE;
558         i_length += I64C(1000000) * i_size / 44100 / 4  ;
559     }
560
561     cddb_disc_set_length( p_access->p_sys->p_disc, (int)(i_length/1000000) );
562
563     if (!cddb_disc_calc_discid(p_access->p_sys->p_disc ))
564     {
565         msg_Err( p_access, "CDDB disc ID calculation failed" );
566         goto cddb_destroy;
567     }
568
569     i_matches = cddb_query( p_cddb, p_access->p_sys->p_disc);
570
571     if (i_matches > 0)
572     {
573         if (i_matches > 1)
574              msg_Warn( p_access, "found %d matches in CDDB. Using first one.",
575                                  i_matches);
576         cddb_read( p_cddb, p_access->p_sys->p_disc );
577     }
578     else
579         msg_Warn( p_access, "CDDB error: %s", cddb_error_str(errno));
580
581 cddb_destroy:
582     cddb_destroy( p_cddb);
583
584 cddb_end: ;
585 }
586 #endif /*HAVE_LIBCDDB*/