cae73673469e47d9ac38e2df39f36e30e60ecd55
[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
35 #ifdef HAVE_CONFIG_H
36 # include "config.h"
37 #endif
38
39 #include <vlc_common.h>
40 #include <vlc_plugin.h>
41 #include <vlc_input.h>
42 #include <vlc_access.h>
43 #include <vlc_meta.h>
44 #include <vlc_charset.h>
45
46 #include <vlc_codecs.h> /* For WAVEHEADER */
47 #include "vcd/cdrom.h"
48
49 #warning playlist code must not be used here.
50 #include <vlc_playlist.h>
51
52 #ifdef HAVE_LIBCDDB
53 #include <cddb/cddb.h>
54 #endif
55
56 #ifdef HAVE_ERRNO_H
57 #include <errno.h>
58 #endif
59
60 /*****************************************************************************
61  * Module descriptior
62  *****************************************************************************/
63 static int  Open ( vlc_object_t * );
64 static void Close( vlc_object_t * );
65
66 #define CACHING_TEXT N_("Caching value in ms")
67 #define CACHING_LONGTEXT N_( \
68     "Default caching value for Audio CDs. This " \
69     "value should be set in milliseconds." )
70
71 vlc_module_begin ()
72     set_shortname( N_("Audio CD"))
73     set_description( N_("Audio CD input") )
74     set_capability( "access", 10 )
75     set_category( CAT_INPUT )
76     set_subcategory( SUBCAT_INPUT_ACCESS )
77     set_callbacks( Open, Close )
78
79     add_usage_hint( N_("[cdda:][device][@[track]]") )
80     add_integer( "cdda-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT,
81                  CACHING_LONGTEXT, true );
82
83     add_integer( "cdda-track", -1 , NULL, NULL, NULL, true )
84         change_internal ()
85     add_integer( "cdda-first-sector", -1, NULL, NULL, NULL, true )
86         change_internal ()
87     add_integer( "cdda-last-sector", -1, NULL, NULL, NULL, true )
88         change_internal ()
89
90     add_string( "cddb-server", "freedb.freedb.org", NULL,
91                 N_( "CDDB Server" ), N_( "Address of the CDDB server to use." ),
92                 true );
93     add_integer( "cddb-port", 8880, NULL,
94                 N_( "CDDB port" ), N_( "CDDB Server port to use." ),
95                 true );
96     add_shortcut( "cdda" )
97     add_shortcut( "cddasimple" )
98 vlc_module_end ()
99
100
101 /* how many blocks VCDRead will read in each loop */
102 #define CDDA_BLOCKS_ONCE 20
103 #define CDDA_DATA_ONCE   (CDDA_BLOCKS_ONCE * CDDA_DATA_SIZE)
104
105 /*****************************************************************************
106  * Access: local prototypes
107  *****************************************************************************/
108 struct access_sys_t
109 {
110     vcddev_t    *vcddev;                            /* vcd device descriptor */
111
112     /* Current position */
113     int         i_sector;                                  /* Current Sector */
114     int *       p_sectors;                                  /* Track sectors */
115
116     /* Wave header for the output data */
117     WAVEHEADER  waveheader;
118     bool  b_header;
119
120     int         i_track;
121     int         i_first_sector;
122     int         i_last_sector;
123
124 #ifdef HAVE_LIBCDDB
125     cddb_disc_t *p_disc;
126 #endif
127 };
128
129 static block_t *Block( access_t * );
130 static int      Seek( access_t *, int64_t );
131 static int      Control( access_t *, int, va_list );
132
133 static int GetTracks( access_t *p_access, playlist_t *p_playlist,
134                       playlist_item_t *p_parent );
135
136 #ifdef HAVE_LIBCDDB
137 static void GetCDDBInfo( access_t *p_access, int i_titles, int *p_sectors );
138 #endif
139
140 /*****************************************************************************
141  * Open: open cdda
142  *****************************************************************************/
143 static int Open( vlc_object_t *p_this )
144 {
145     access_t     *p_access = (access_t*)p_this;
146     access_sys_t *p_sys;
147     vcddev_t *vcddev;
148     char *psz_name;
149     int i_mrl_tracknum = -1;
150     int i_ret;
151
152     if( !p_access->psz_path || !*p_access->psz_path )
153     {
154         /* Only when selected */
155         if( !p_this->b_force ) return VLC_EGENERIC;
156
157         psz_name = var_CreateGetString( p_this, "cd-audio" );
158         if( !psz_name || !*psz_name )
159         {
160             free( psz_name );
161             return VLC_EGENERIC;
162         }
163     }
164     else psz_name = ToLocaleDup( p_access->psz_path );
165
166 #ifdef WIN32
167     if( psz_name[0] && psz_name[1] == ':' &&
168         psz_name[2] == '\\' && psz_name[3] == '\0' ) psz_name[2] = '\0';
169 #endif
170
171     /* Open CDDA */
172     if( (vcddev = ioctl_Open( VLC_OBJECT(p_access), psz_name )) == NULL )
173     {
174         msg_Warn( p_access, "could not open %s", psz_name );
175         free( psz_name );
176         return VLC_EGENERIC;
177     }
178     free( psz_name );
179
180     /* Set up p_access */
181     STANDARD_BLOCK_ACCESS_INIT
182     p_sys->vcddev = vcddev;
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         /* We only do separate items if the whole disc is requested */
190         playlist_t *p_playlist = pl_Hold( p_access );
191
192         i_ret = -1;
193         if( p_playlist )
194         {
195             input_thread_t *p_input = (input_thread_t*)vlc_object_find( p_access, VLC_OBJECT_INPUT, FIND_PARENT );
196             if( p_input )
197             {
198                 input_item_t *p_current = input_GetItem( p_input );
199                 playlist_item_t *p_item;
200
201                 if( playlist_CurrentPlayingItem(p_playlist)->p_input == p_current )
202                     p_item = playlist_CurrentPlayingItem(p_playlist);
203                 else
204                     p_item = playlist_ItemGetByInput( p_playlist, p_current, pl_Unlocked );
205
206                 if( p_item )
207                     i_ret = GetTracks( p_access, p_playlist, p_item );
208                 else
209                     msg_Dbg( p_playlist, "unable to find item in playlist");
210                 vlc_object_release( p_input );
211             }
212             pl_Release( p_access );
213         }
214         if( i_ret < 0 )
215             goto error;
216     }
217     else
218     {
219         /* Build a WAV header for the output data */
220         memset( &p_sys->waveheader, 0, sizeof(WAVEHEADER) );
221         SetWLE( &p_sys->waveheader.Format, 1 ); /*WAVE_FORMAT_PCM*/
222         SetWLE( &p_sys->waveheader.BitsPerSample, 16);
223         p_sys->waveheader.MainChunkID = VLC_FOURCC('R', 'I', 'F', 'F');
224         p_sys->waveheader.Length = 0;               /* we just don't know */
225         p_sys->waveheader.ChunkTypeID = VLC_FOURCC('W', 'A', 'V', 'E');
226         p_sys->waveheader.SubChunkID = VLC_FOURCC('f', 'm', 't', ' ');
227         SetDWLE( &p_sys->waveheader.SubChunkLength, 16);
228         SetWLE( &p_sys->waveheader.Modus, 2);
229         SetDWLE( &p_sys->waveheader.SampleFreq, 44100);
230         SetWLE( &p_sys->waveheader.BytesPerSample,
231                     2 /*Modus*/ * 16 /*BitsPerSample*/ / 8 );
232         SetDWLE( &p_sys->waveheader.BytesPerSec,
233                     2*16/8 /*BytesPerSample*/ * 44100 /*SampleFreq*/ );
234         p_sys->waveheader.DataChunkID = VLC_FOURCC('d', 'a', 't', 'a');
235         p_sys->waveheader.DataLength = 0;           /* we just don't know */
236
237         p_sys->i_first_sector = var_CreateGetInteger( p_access,
238                                                       "cdda-first-sector" );
239         p_sys->i_last_sector  = var_CreateGetInteger( p_access,
240                                                       "cdda-last-sector" );
241         /* Tracknumber in MRL */
242         if( p_sys->i_first_sector < 0 || p_sys->i_last_sector < 0 )
243         {
244             int i_titles;
245             if( i_mrl_tracknum <= 0 )
246             {
247                 msg_Err( p_access, "wrong sector information" );
248                 goto error;
249             }
250             i_titles = ioctl_GetTracksMap( VLC_OBJECT(p_access),
251                                             p_sys->vcddev, &p_sys->p_sectors );
252         }
253
254
255         p_sys->i_sector = p_sys->i_first_sector;
256         p_access->info.i_size = (p_sys->i_last_sector - p_sys->i_first_sector)
257                                      * (int64_t)CDDA_DATA_SIZE;
258     }
259
260     /* PTS delay */
261     var_Create( p_access, "cdda-caching", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
262
263     return VLC_SUCCESS;
264
265 error:
266     ioctl_Close( VLC_OBJECT(p_access), p_sys->vcddev );
267     free( p_sys );
268     return VLC_EGENERIC;
269 }
270
271 /*****************************************************************************
272  * Close: closes cdda
273  *****************************************************************************/
274 static void Close( vlc_object_t *p_this )
275 {
276     access_t     *p_access = (access_t *)p_this;
277     access_sys_t *p_sys = p_access->p_sys;
278     ioctl_Close( p_this, p_sys->vcddev );
279     free( p_sys );
280 }
281
282 /*****************************************************************************
283  * Block: read data (CDDA_DATA_ONCE)
284  *****************************************************************************/
285 static block_t *Block( access_t *p_access )
286 {
287     access_sys_t *p_sys = p_access->p_sys;
288     int i_blocks = CDDA_BLOCKS_ONCE;
289     block_t *p_block;
290
291     if( p_sys->i_track < 0 ) p_access->info.b_eof = true;
292
293     /* Check end of file */
294     if( p_access->info.b_eof ) return NULL;
295
296     if( !p_sys->b_header )
297     {
298         /* Return only the header */
299         p_block = block_New( p_access, sizeof( WAVEHEADER ) );
300         memcpy( p_block->p_buffer, &p_sys->waveheader, sizeof(WAVEHEADER) );
301         p_sys->b_header = true;
302         return p_block;
303     }
304
305     if( p_sys->i_sector >= p_sys->i_last_sector )
306     {
307         p_access->info.b_eof = true;
308         return NULL;
309     }
310
311     /* Don't read too far */
312     if( p_sys->i_sector + i_blocks >= p_sys->i_last_sector )
313         i_blocks = p_sys->i_last_sector - p_sys->i_sector;
314
315     /* Do the actual reading */
316     if( !( p_block = block_New( p_access, i_blocks * CDDA_DATA_SIZE ) ) )
317     {
318         msg_Err( p_access, "cannot get a new block of size: %i",
319                  i_blocks * CDDA_DATA_SIZE );
320         return NULL;
321     }
322
323     if( ioctl_ReadSectors( VLC_OBJECT(p_access), p_sys->vcddev,
324             p_sys->i_sector, p_block->p_buffer, i_blocks, CDDA_TYPE ) < 0 )
325     {
326         msg_Err( p_access, "cannot read sector %i", p_sys->i_sector );
327         block_Release( p_block );
328
329         /* Try to skip one sector (in case of bad sectors) */
330         p_sys->i_sector++;
331         p_access->info.i_pos += CDDA_DATA_SIZE;
332         return NULL;
333     }
334
335     /* Update a few values */
336     p_sys->i_sector += i_blocks;
337     p_access->info.i_pos += p_block->i_buffer;
338
339     return p_block;
340 }
341
342 /****************************************************************************
343  * Seek
344  ****************************************************************************/
345 static int Seek( access_t *p_access, int64_t i_pos )
346 {
347     access_sys_t *p_sys = p_access->p_sys;
348
349     /* Next sector to read */
350     p_sys->i_sector = p_sys->i_first_sector + i_pos / CDDA_DATA_SIZE;
351     p_access->info.i_pos = i_pos;
352
353     return VLC_SUCCESS;
354 }
355
356 /*****************************************************************************
357  * Control:
358  *****************************************************************************/
359 static int Control( access_t *p_access, int i_query, va_list args )
360 {
361     bool   *pb_bool;
362     int          *pi_int;
363     int64_t      *pi_64;
364
365     switch( i_query )
366     {
367         case ACCESS_CAN_SEEK:
368         case ACCESS_CAN_FASTSEEK:
369         case ACCESS_CAN_PAUSE:
370         case ACCESS_CAN_CONTROL_PACE:
371             pb_bool = (bool*)va_arg( args, bool* );
372             *pb_bool = true;
373             break;
374
375         case ACCESS_GET_MTU:
376             pi_int = (int*)va_arg( args, int * );
377             *pi_int = CDDA_DATA_ONCE;
378             break;
379
380         case ACCESS_GET_PTS_DELAY:
381             pi_64 = (int64_t*)va_arg( args, int64_t * );
382             *pi_64 = var_GetInteger( p_access, "cdda-caching" ) * 1000;
383             break;
384
385         case ACCESS_SET_PAUSE_STATE:
386             break;
387
388         case ACCESS_GET_TITLE_INFO:
389         case ACCESS_SET_TITLE:
390         case ACCESS_GET_META:
391         case ACCESS_SET_SEEKPOINT:
392         case ACCESS_SET_PRIVATE_ID_STATE:
393         case ACCESS_GET_CONTENT_TYPE:
394             return VLC_EGENERIC;
395
396         default:
397             msg_Warn( p_access, "unimplemented query in control" );
398             return VLC_EGENERIC;
399
400     }
401     return VLC_SUCCESS;
402 }
403
404 static int GetTracks( access_t *p_access,
405                       playlist_t *p_playlist, playlist_item_t *p_parent )
406 {
407     access_sys_t *p_sys = p_access->p_sys;
408     int i, i_titles;
409     input_item_t *p_input_item;
410     playlist_item_t *p_item_in_category;
411     char *psz_name;
412     i_titles = ioctl_GetTracksMap( VLC_OBJECT(p_access),
413                                    p_sys->vcddev, &p_sys->p_sectors );
414     if( i_titles < 0 )
415     {
416         msg_Err( p_access, "unable to count tracks" );
417         return VLC_EGENERIC;;
418     }
419     else if( i_titles <= 0 )
420     {
421         msg_Err( p_access, "no audio tracks found" );
422         return VLC_EGENERIC;
423     }
424
425     p_item_in_category = playlist_ItemToNode( p_playlist, p_parent, pl_Unlocked );
426     playlist_ItemSetName( p_parent, "Audio CD" );
427     var_SetInteger( p_playlist, "item-change", p_parent->p_input->i_id );
428
429 #ifdef HAVE_LIBCDDB
430     GetCDDBInfo( p_access, i_titles, p_sys->p_sectors );
431     if( p_sys->p_disc )
432     {
433         if( cddb_disc_get_title( p_sys->p_disc ) )
434         {
435             const char *psz_name = cddb_disc_get_title( p_sys->p_disc );
436             playlist_ItemSetName( p_parent, psz_name );
437             var_SetInteger( p_playlist, "item-change",
438                             p_parent->p_input->i_id );
439         }
440     }
441 #endif
442
443     /* Build title table */
444     for( i = 0; i < i_titles; i++ )
445     {
446         msg_Dbg( p_access, "track[%d] start=%d", i, p_sys->p_sectors[i] );
447         char *psz_uri, *psz_opt, *psz_first, *psz_last;
448
449         if( asprintf( &psz_uri, "cdda://%s", p_access->psz_path ? p_access->psz_path : "" ) == -1 )
450             psz_uri = NULL;
451         if( asprintf( &psz_opt, "cdda-track=%i", i+1 ) == -1 )
452             psz_opt = NULL;
453         if( asprintf( &psz_first, "cdda-first-sector=%i",p_sys->p_sectors[i] ) == -1 )
454             psz_first = NULL;
455
456 //        if( i != i_titles -1 )
457 //        {
458             if( asprintf( &psz_last, "cdda-last-sector=%i", p_sys->p_sectors[i+1] ) == -1 )
459                 psz_last = NULL;
460 //        }
461 //        else
462 //        {
463 //            if( asprintf( &psz_last, "cdda-last-sector=%i", 1242 /* FIXME */) == -1 )
464 //                psz_last = NULL;
465 //        }
466
467         /* Define a "default name" */
468         if( asprintf( &psz_name, _("Audio CD - Track %i"), (i+1) ) == -1 )
469             psz_name = NULL;
470
471         /* Create playlist items */
472         p_input_item = input_item_NewWithType( VLC_OBJECT( p_playlist ),
473                                               psz_uri, psz_name, 0, NULL, -1,
474                                               ITEM_TYPE_DISC );
475         input_item_AddOption( p_input_item, psz_first );
476         input_item_AddOption( p_input_item, psz_last );
477         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             cddb_track_t *t = cddb_disc_get_track( p_sys->p_disc, i );
484             if( t!= NULL )
485             {
486                 if( cddb_track_get_title( t )  != NULL )
487                 {
488                     free( p_input_item->psz_name );
489                     p_input_item->psz_name = strdup( cddb_track_get_title( t ) );
490                     input_item_SetTitle( p_input_item, cddb_track_get_title( t ) );
491                 }
492                 if( cddb_track_get_artist( t ) != NULL )
493                 {
494                     input_item_SetArtist( p_input_item, cddb_track_get_artist( t ) );
495                 }
496             }
497         }
498 #endif
499         int i_ret = playlist_BothAddInput( p_playlist, p_input_item,
500                                p_item_in_category,
501                                PLAYLIST_APPEND, PLAYLIST_END, NULL, NULL,
502                                pl_Unlocked );
503         vlc_gc_decref( p_input_item );
504         free( psz_uri ); free( psz_opt ); free( psz_name );
505         free( psz_first ); free( psz_last );
506         if( i_ret != VLC_SUCCESS )
507             return VLC_EGENERIC;
508     }
509     return VLC_SUCCESS;
510 }
511
512 #ifdef HAVE_LIBCDDB
513 static void GetCDDBInfo( access_t *p_access, int i_titles, int *p_sectors )
514 {
515     int i, i_matches;
516     int64_t  i_length = 0, i_size = 0;
517     cddb_conn_t  *p_cddb = cddb_new();
518
519     if( !p_cddb )
520     {
521         msg_Warn( p_access, "unable to use CDDB" );
522         goto cddb_destroy;
523     }
524
525     char* psz_tmp = config_GetPsz( p_access, "cddb-server" );
526     cddb_set_email_address( p_cddb, "vlc@videolan.org" );
527     cddb_set_server_name( p_cddb, psz_tmp );
528     cddb_set_server_port( p_cddb, config_GetInt( p_access, "cddb-port" ) );
529     free( psz_tmp );
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 += INT64_C(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*/