]> git.sesse.net Git - vlc/blob - modules/access/cdda.c
Prepare GetTracks for CD-TEXT (cdda).
[vlc] / 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 #ifdef HAVE_LIBCDDB
50 #include <cddb/cddb.h>
51 #endif
52
53 #ifdef HAVE_ERRNO_H
54 #include <errno.h>
55 #endif
56
57 /*****************************************************************************
58  * Module descriptior
59  *****************************************************************************/
60 static int  Open ( vlc_object_t * );
61 static void Close( vlc_object_t * );
62
63 #define CACHING_TEXT N_("Caching value in ms")
64 #define CACHING_LONGTEXT N_( \
65     "Default caching value for Audio CDs. This " \
66     "value should be set in milliseconds." )
67
68 vlc_module_begin ()
69     set_shortname( N_("Audio CD"))
70     set_description( N_("Audio CD input") )
71     set_capability( "access", 10 )
72     set_category( CAT_INPUT )
73     set_subcategory( SUBCAT_INPUT_ACCESS )
74     set_callbacks( Open, Close )
75
76     add_usage_hint( N_("[cdda:][device][@[track]]") )
77     add_integer( "cdda-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT,
78                  CACHING_LONGTEXT, true )
79
80     add_integer( "cdda-track", 0 , NULL, NULL, NULL, true )
81         change_internal ()
82     add_integer( "cdda-first-sector", -1, NULL, NULL, NULL, true )
83         change_internal ()
84     add_integer( "cdda-last-sector", -1, NULL, NULL, NULL, true )
85         change_internal ()
86
87     add_string( "cddb-server", "freedb.freedb.org", NULL,
88                 N_( "CDDB Server" ), N_( "Address of the CDDB server to use." ),
89                 true )
90     add_integer( "cddb-port", 8880, NULL,
91                 N_( "CDDB port" ), N_( "CDDB Server port to use." ),
92                 true )
93     add_shortcut( "cdda" )
94     add_shortcut( "cddasimple" )
95 vlc_module_end ()
96
97
98 /* how many blocks VCDRead will read in each loop */
99 #define CDDA_BLOCKS_ONCE 20
100 #define CDDA_DATA_ONCE   (CDDA_BLOCKS_ONCE * CDDA_DATA_SIZE)
101
102 /*****************************************************************************
103  * Access: local prototypes
104  *****************************************************************************/
105 struct access_sys_t
106 {
107     vcddev_t    *vcddev;                            /* vcd device descriptor */
108
109     /* Current position */
110     int         i_sector;                                  /* Current Sector */
111     int *       p_sectors;                                  /* Track sectors */
112
113     /* Wave header for the output data */
114     WAVEHEADER  waveheader;
115     bool  b_header;
116
117     int         i_track;
118     int         i_first_sector;
119     int         i_last_sector;
120 };
121
122 static block_t *Block( access_t * );
123 static int      Seek( access_t *, int64_t );
124 static int      Control( access_t *, int, va_list );
125
126 static int GetTracks( access_t *p_access, input_item_t *p_current );
127
128 #ifdef HAVE_LIBCDDB
129 static cddb_disc_t *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_ret;
142
143     if( !p_access->psz_path || !*p_access->psz_path )
144     {
145         /* Only when selected */
146         if( !p_this->b_force ) return VLC_EGENERIC;
147
148         psz_name = var_CreateGetString( p_this, "cd-audio" );
149         if( !psz_name || !*psz_name )
150         {
151             free( psz_name );
152             return VLC_EGENERIC;
153         }
154     }
155     else psz_name = ToLocaleDup( p_access->psz_path );
156
157 #ifdef WIN32
158     if( psz_name[0] && psz_name[1] == ':' &&
159         psz_name[2] == '\\' && psz_name[3] == '\0' ) psz_name[2] = '\0';
160 #endif
161
162     /* Open CDDA */
163     if( (vcddev = ioctl_Open( VLC_OBJECT(p_access), psz_name )) == NULL )
164     {
165         msg_Warn( p_access, "could not open %s", psz_name );
166         free( psz_name );
167         return VLC_EGENERIC;
168     }
169     free( psz_name );
170
171     /* Set up p_access */
172     STANDARD_BLOCK_ACCESS_INIT
173     p_sys->vcddev = vcddev;
174
175    /* Do we play a single track ? */
176    p_sys->i_track = var_CreateGetInteger( p_access, "cdda-track" ) - 1;
177
178    if( p_sys->i_track < 0 )
179    {
180         /* We only do separate items if the whole disc is requested */
181         input_thread_t *p_input = (input_thread_t*)vlc_object_find( p_access, VLC_OBJECT_INPUT, FIND_PARENT );
182
183         i_ret = -1;
184         if( p_input )
185         {
186             input_item_t *p_current = input_GetItem( p_input );
187             if( p_current )
188                 i_ret = GetTracks( p_access, p_current );
189
190             vlc_object_release( p_input );
191         }
192         if( i_ret < 0 )
193             goto error;
194     }
195     else
196     {
197         /* Build a WAV header for the output data */
198         memset( &p_sys->waveheader, 0, sizeof(WAVEHEADER) );
199         SetWLE( &p_sys->waveheader.Format, 1 ); /*WAVE_FORMAT_PCM*/
200         SetWLE( &p_sys->waveheader.BitsPerSample, 16);
201         p_sys->waveheader.MainChunkID = VLC_FOURCC('R', 'I', 'F', 'F');
202         p_sys->waveheader.Length = 0;               /* we just don't know */
203         p_sys->waveheader.ChunkTypeID = VLC_FOURCC('W', 'A', 'V', 'E');
204         p_sys->waveheader.SubChunkID = VLC_FOURCC('f', 'm', 't', ' ');
205         SetDWLE( &p_sys->waveheader.SubChunkLength, 16);
206         SetWLE( &p_sys->waveheader.Modus, 2);
207         SetDWLE( &p_sys->waveheader.SampleFreq, 44100);
208         SetWLE( &p_sys->waveheader.BytesPerSample,
209                     2 /*Modus*/ * 16 /*BitsPerSample*/ / 8 );
210         SetDWLE( &p_sys->waveheader.BytesPerSec,
211                     2*16/8 /*BytesPerSample*/ * 44100 /*SampleFreq*/ );
212         p_sys->waveheader.DataChunkID = VLC_FOURCC('d', 'a', 't', 'a');
213         p_sys->waveheader.DataLength = 0;           /* we just don't know */
214
215         p_sys->i_first_sector = var_CreateGetInteger( p_access,
216                                                       "cdda-first-sector" );
217         p_sys->i_last_sector  = var_CreateGetInteger( p_access,
218                                                       "cdda-last-sector" );
219         /* Tracknumber in MRL */
220         if( p_sys->i_first_sector < 0 || p_sys->i_last_sector < 0 )
221         {
222             const int i_titles = ioctl_GetTracksMap( VLC_OBJECT(p_access),
223                                                      p_sys->vcddev, &p_sys->p_sectors );
224             if( p_sys->i_track >= i_titles )
225             {
226                 msg_Err( p_access, "invalid track number" );
227                 goto error;
228             }
229             p_sys->i_first_sector = p_sys->p_sectors[p_sys->i_track];
230             p_sys->i_last_sector = p_sys->p_sectors[p_sys->i_track+1];
231         }
232
233         p_sys->i_sector = p_sys->i_first_sector;
234         p_access->info.i_size = (p_sys->i_last_sector - p_sys->i_first_sector)
235                                      * (int64_t)CDDA_DATA_SIZE;
236     }
237
238     /* PTS delay */
239     var_Create( p_access, "cdda-caching", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
240
241     return VLC_SUCCESS;
242
243 error:
244     free( p_sys->p_sectors );
245     ioctl_Close( VLC_OBJECT(p_access), p_sys->vcddev );
246     free( p_sys );
247     return VLC_EGENERIC;
248 }
249
250 /*****************************************************************************
251  * Close: closes cdda
252  *****************************************************************************/
253 static void Close( vlc_object_t *p_this )
254 {
255     access_t     *p_access = (access_t *)p_this;
256     access_sys_t *p_sys = p_access->p_sys;
257
258     free( p_sys->p_sectors );
259     ioctl_Close( p_this, p_sys->vcddev );
260     free( p_sys );
261 }
262
263 /*****************************************************************************
264  * Block: read data (CDDA_DATA_ONCE)
265  *****************************************************************************/
266 static block_t *Block( access_t *p_access )
267 {
268     access_sys_t *p_sys = p_access->p_sys;
269     int i_blocks = CDDA_BLOCKS_ONCE;
270     block_t *p_block;
271
272     if( p_sys->i_track < 0 ) p_access->info.b_eof = true;
273
274     /* Check end of file */
275     if( p_access->info.b_eof ) return NULL;
276
277     if( !p_sys->b_header )
278     {
279         /* Return only the header */
280         p_block = block_New( p_access, sizeof( WAVEHEADER ) );
281         memcpy( p_block->p_buffer, &p_sys->waveheader, sizeof(WAVEHEADER) );
282         p_sys->b_header = true;
283         return p_block;
284     }
285
286     if( p_sys->i_sector >= p_sys->i_last_sector )
287     {
288         p_access->info.b_eof = true;
289         return NULL;
290     }
291
292     /* Don't read too far */
293     if( p_sys->i_sector + i_blocks >= p_sys->i_last_sector )
294         i_blocks = p_sys->i_last_sector - p_sys->i_sector;
295
296     /* Do the actual reading */
297     if( !( p_block = block_New( p_access, i_blocks * CDDA_DATA_SIZE ) ) )
298     {
299         msg_Err( p_access, "cannot get a new block of size: %i",
300                  i_blocks * CDDA_DATA_SIZE );
301         return NULL;
302     }
303
304     if( ioctl_ReadSectors( VLC_OBJECT(p_access), p_sys->vcddev,
305             p_sys->i_sector, p_block->p_buffer, i_blocks, CDDA_TYPE ) < 0 )
306     {
307         msg_Err( p_access, "cannot read sector %i", p_sys->i_sector );
308         block_Release( p_block );
309
310         /* Try to skip one sector (in case of bad sectors) */
311         p_sys->i_sector++;
312         p_access->info.i_pos += CDDA_DATA_SIZE;
313         return NULL;
314     }
315
316     /* Update a few values */
317     p_sys->i_sector += i_blocks;
318     p_access->info.i_pos += p_block->i_buffer;
319
320     return p_block;
321 }
322
323 /****************************************************************************
324  * Seek
325  ****************************************************************************/
326 static int Seek( access_t *p_access, int64_t i_pos )
327 {
328     access_sys_t *p_sys = p_access->p_sys;
329
330     /* Next sector to read */
331     p_sys->i_sector = p_sys->i_first_sector + i_pos / CDDA_DATA_SIZE;
332     p_access->info.i_pos = i_pos;
333
334     return VLC_SUCCESS;
335 }
336
337 /*****************************************************************************
338  * Control:
339  *****************************************************************************/
340 static int Control( access_t *p_access, int i_query, va_list args )
341 {
342     bool    *pb_bool;
343     int64_t *pi_64;
344
345     switch( i_query )
346     {
347         case ACCESS_CAN_SEEK:
348         case ACCESS_CAN_FASTSEEK:
349         case ACCESS_CAN_PAUSE:
350         case ACCESS_CAN_CONTROL_PACE:
351             pb_bool = (bool*)va_arg( args, bool* );
352             *pb_bool = true;
353             break;
354
355         case ACCESS_GET_PTS_DELAY:
356             pi_64 = (int64_t*)va_arg( args, int64_t * );
357             *pi_64 = var_GetInteger( p_access, "cdda-caching" ) * INT64_C(1000);
358             break;
359
360         case ACCESS_SET_PAUSE_STATE:
361             break;
362
363         case ACCESS_GET_TITLE_INFO:
364         case ACCESS_SET_TITLE:
365         case ACCESS_GET_META:
366         case ACCESS_SET_SEEKPOINT:
367         case ACCESS_SET_PRIVATE_ID_STATE:
368         case ACCESS_GET_CONTENT_TYPE:
369             return VLC_EGENERIC;
370
371         default:
372             msg_Warn( p_access, "unimplemented query in control" );
373             return VLC_EGENERIC;
374     }
375     return VLC_SUCCESS;
376 }
377
378 static int GetTracks( access_t *p_access, input_item_t *p_current )
379 {
380     access_sys_t *p_sys = p_access->p_sys;
381
382     const int i_titles = ioctl_GetTracksMap( VLC_OBJECT(p_access),
383                                              p_sys->vcddev, &p_sys->p_sectors );
384     if( i_titles <= 0 )
385     {
386         if( i_titles < 0 )
387             msg_Err( p_access, "unable to count tracks" );
388         else if( i_titles <= 0 )
389             msg_Err( p_access, "no audio tracks found" );
390         return VLC_EGENERIC;;
391     }
392
393     input_item_SetName( p_current, "Audio CD" );
394
395     const char *psz_album = NULL;
396     const char *psz_year = NULL;
397     const char *psz_genre = NULL;
398     const char *psz_artist = NULL;
399     const char *psz_description = NULL;
400     char psz_year_buffer[4+1];
401
402 /* Return true if the given string is not NULL and not empty */
403 #define NONEMPTY( psz ) ( (psz) && *(psz) )
404 /* If the given string is NULL or empty, fill it by the return value of 'code' */
405 #define ON_EMPTY( psz, code ) do { if( !NONEMPTY( psz) ) { (psz) = code; } } while(0)
406
407     /* Retreive CDDB informations */
408 #ifdef HAVE_LIBCDDB
409     cddb_disc_t *p_disc = GetCDDBInfo( p_access, i_titles, p_sys->p_sectors );
410     if( p_disc )
411     {
412         psz_album = cddb_disc_get_title( p_disc );
413         psz_genre = cddb_disc_get_genre( p_disc );
414
415         /* */
416         const unsigned i_year = cddb_disc_get_year( p_disc );
417         if( i_year > 0 )
418         {
419             psz_year = psz_year_buffer;
420             snprintf( psz_year_buffer, sizeof(psz_year_buffer), "%u", i_year );
421         }
422
423         /* Set artist only if unique */
424         for( int i = 0; i < i_titles; i++ )
425         {
426             cddb_track_t *t = cddb_disc_get_track( p_disc, i );
427             if( !t )
428                 continue;
429             const char *psz_track_artist = cddb_track_get_artist( t );
430             if( psz_artist && psz_track_artist &&
431                 strcmp( psz_artist, psz_track_artist ) )
432             {
433                 psz_artist = NULL;
434                 break;
435             }
436             psz_artist = psz_track_artist;
437         }
438     }
439 #endif
440
441     if( NONEMPTY( psz_album ) )
442     {
443         input_item_SetName( p_current, psz_album );
444         input_item_SetAlbum( p_current, psz_album );
445     }
446
447     if( NONEMPTY( psz_genre ) )
448         input_item_SetGenre( p_current, psz_genre );
449
450     if( NONEMPTY( psz_artist ) )
451         input_item_SetArtist( p_current, psz_artist );
452
453     if( NONEMPTY( psz_year ) )
454         input_item_SetDate( p_current, psz_year );
455
456     if( NONEMPTY( psz_description ) )
457         input_item_SetDescription( p_current, psz_description );
458
459     const mtime_t i_duration = (int64_t)( p_sys->p_sectors[i_titles] - p_sys->p_sectors[0] ) *
460                                CDDA_DATA_SIZE * 1000000 / 44100 / 2 / 2;
461     input_item_SetDuration( p_current, i_duration );
462
463     /* Build title table */
464     for( int i = 0; i < i_titles; i++ )
465     {
466         input_item_t *p_input_item;
467
468         char *psz_uri, *psz_opt, *psz_first, *psz_last;
469         char *psz_name;
470
471         msg_Dbg( p_access, "track[%d] start=%d", i, p_sys->p_sectors[i] );
472
473         /* */
474         if( asprintf( &psz_uri, "cdda://%s", p_access->psz_path ) == -1 )
475             psz_uri = NULL;
476         if( asprintf( &psz_opt, "cdda-track=%i", i+1 ) == -1 )
477             psz_opt = NULL;
478         if( asprintf( &psz_first, "cdda-first-sector=%i",p_sys->p_sectors[i] ) == -1 )
479             psz_first = NULL;
480         if( asprintf( &psz_last, "cdda-last-sector=%i", p_sys->p_sectors[i+1] ) == -1 )
481             psz_last = NULL;
482
483         /* Define a "default name" */
484         if( asprintf( &psz_name, _("Audio CD - Track %02i"), (i+1) ) == -1 )
485             psz_name = NULL;
486
487         /* Create playlist items */
488         const mtime_t i_duration = (int64_t)( p_sys->p_sectors[i+1] - p_sys->p_sectors[i] ) *
489                                    CDDA_DATA_SIZE * 1000000 / 44100 / 2 / 2;
490         p_input_item = input_item_NewWithType( VLC_OBJECT( p_access ),
491                                               psz_uri, psz_name, 0, NULL, 0, i_duration,
492                                               ITEM_TYPE_DISC );
493         input_item_CopyOptions( p_current, p_input_item );
494         input_item_AddOption( p_input_item, psz_first, VLC_INPUT_OPTION_TRUSTED );
495         input_item_AddOption( p_input_item, psz_last, VLC_INPUT_OPTION_TRUSTED );
496         input_item_AddOption( p_input_item, psz_opt, VLC_INPUT_OPTION_TRUSTED );
497
498         const char *psz_track_title = NULL;
499         const char *psz_track_artist = NULL;
500         const char *psz_track_genre = NULL;
501         const char *psz_track_description = NULL;
502
503 #ifdef HAVE_LIBCDDB
504         /* Retreive CDDB informations */
505         if( p_disc )
506         {
507             cddb_track_t *t = cddb_disc_get_track( p_disc, i );
508             if( t != NULL )
509             {
510                 psz_track_title = cddb_track_get_title( t );
511                 psz_track_artist = cddb_track_get_artist( t );
512             }
513         }
514 #endif
515
516         /* */
517         ON_EMPTY( psz_track_artist,       psz_artist );
518         ON_EMPTY( psz_track_genre,        psz_genre );
519         ON_EMPTY( psz_track_description,  psz_description );
520
521         /* */
522         if( NONEMPTY( psz_track_title ) )
523         {
524             input_item_SetName( p_input_item, psz_track_title );
525             input_item_SetTitle( p_input_item, psz_track_title );
526         }
527
528         if( NONEMPTY( psz_track_artist ) )
529             input_item_SetArtist( p_input_item, psz_track_artist );
530
531         if( NONEMPTY( psz_track_genre ) )
532             input_item_SetGenre( p_input_item, psz_track_genre );
533
534         if( NONEMPTY( psz_track_description ) )
535             input_item_SetDescription( p_input_item, psz_track_description );
536
537         if( NONEMPTY( psz_album ) )
538             input_item_SetAlbum( p_input_item, psz_album );
539
540         if( NONEMPTY( psz_year ) )
541             input_item_SetDate( p_input_item, psz_year );
542
543         char psz_num[3+1];
544         snprintf( psz_num, sizeof(psz_num), "%d", 1+i );
545         input_item_SetTrackNum( p_input_item, psz_num );
546
547         input_item_AddSubItem( p_current, p_input_item );
548         vlc_gc_decref( p_input_item );
549         free( psz_uri ); free( psz_opt ); free( psz_name );
550         free( psz_first ); free( psz_last );
551     }
552 #undef ON_EMPTY
553 #undef NONEMPTY
554
555
556 #ifdef HAVE_LIBCDDB
557     if( p_disc )
558         cddb_disc_destroy( p_disc );
559 #endif
560     return VLC_SUCCESS;
561 }
562
563 #ifdef HAVE_LIBCDDB
564 static cddb_disc_t *GetCDDBInfo( access_t *p_access, int i_titles, int *p_sectors )
565 {
566     /* */
567     cddb_conn_t *p_cddb = cddb_new();
568     if( !p_cddb )
569     {
570         msg_Warn( p_access, "unable to use CDDB" );
571         return NULL;
572     }
573
574     /* */
575     char *psz_tmp = config_GetPsz( p_access, "cddb-server" );
576     cddb_set_server_name( p_cddb, psz_tmp );
577     free( psz_tmp );
578
579     cddb_set_server_port( p_cddb, config_GetInt( p_access, "cddb-port" ) );
580
581     cddb_set_email_address( p_cddb, "vlc@videolan.org" );
582
583     /// \todo
584     cddb_cache_disable( p_cddb );
585
586 //    cddb_cache_set_dir( p_cddb,
587 //                     config_GetPsz( p_access,
588 //                                    MODULE_STRING "-cddb-cachedir") );
589
590     cddb_set_timeout( p_cddb, 10 );
591
592     /// \todo
593     cddb_http_disable( p_cddb);
594
595     /* */
596     cddb_disc_t *p_disc = cddb_disc_new();
597     if( !p_disc )
598     {
599         msg_Err( p_access, "unable to create CDDB disc structure." );
600         goto error;
601     }
602
603     int64_t i_length = 0;
604     for( int i = 0; i < i_titles; i++ )
605     {
606         cddb_track_t *t = cddb_track_new();
607         cddb_track_set_frame_offset( t, p_sectors[i] );
608         cddb_disc_add_track( p_disc, t );
609         const int64_t i_size = ( p_sectors[i+1] - p_sectors[i] ) *
610                                (int64_t)CDDA_DATA_SIZE;
611         i_length += INT64_C(1000000) * i_size / 44100 / 4  ;
612     }
613
614     cddb_disc_set_length( p_disc, (int)(i_length/1000000) );
615
616     if( !cddb_disc_calc_discid( p_disc ) )
617     {
618         msg_Err( p_access, "CDDB disc ID calculation failed" );
619         goto error;
620     }
621
622     const int i_matches = cddb_query( p_cddb, p_disc );
623     if( i_matches <= 0 )
624     {
625         msg_Warn( p_access, "CDDB error: %s", cddb_error_str(errno));
626         goto error;
627     }
628
629     if( i_matches > 1 )
630         msg_Warn( p_access, "found %d matches in CDDB. Using first one.", i_matches );
631     cddb_read( p_cddb, p_disc );
632
633     cddb_destroy( p_cddb);
634     return p_disc;
635
636 error:
637     if( p_disc )
638         cddb_disc_destroy( p_disc );
639     cddb_destroy( p_cddb );
640     return NULL;
641 }
642 #endif /*HAVE_LIBCDDB*/
643