1 /*****************************************************************************
2 * cdda.c : CD digital audio input module for vlc
3 *****************************************************************************
4 * Copyright (C) 2000, 2003-2006, 2008-2009 the VideoLAN team
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
8 * Gildas Bazin <gbazin@netcourrier.com>
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.
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.
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 *****************************************************************************/
27 * - Improve CDDB support (non-blocking, cache, ...)
28 * - Fix tracknumber in MRL
31 /*****************************************************************************
33 *****************************************************************************/
39 #include <vlc_common.h>
40 #include <vlc_plugin.h>
41 #include <vlc_input.h>
42 #include <vlc_access.h>
44 #include <vlc_charset.h> /* ToLocaleDup */
46 #include <vlc_codecs.h> /* For WAVEHEADER */
47 #include "vcd/cdrom.h" /* For CDDA_DATA_SIZE */
50 #include <cddb/cddb.h>
54 /*****************************************************************************
56 *****************************************************************************/
57 static int Open ( vlc_object_t * );
58 static void Close( vlc_object_t * );
60 #define CACHING_TEXT N_("Caching value in ms")
61 #define CACHING_LONGTEXT N_( \
62 "Default caching value for Audio CDs. This " \
63 "value should be set in milliseconds." )
66 set_shortname( N_("Audio CD") )
67 set_description( N_("Audio CD input") )
68 set_capability( "access", 10 )
69 set_category( CAT_INPUT )
70 set_subcategory( SUBCAT_INPUT_ACCESS )
71 set_callbacks( Open, Close )
73 add_usage_hint( N_("[cdda:][device][@[track]]") )
74 add_integer( "cdda-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT,
75 CACHING_LONGTEXT, true )
78 add_integer( "cdda-track", 0 , NULL, NULL, NULL, true )
80 add_integer( "cdda-first-sector", -1, NULL, NULL, NULL, true )
82 add_integer( "cdda-last-sector", -1, NULL, NULL, NULL, true )
86 add_string( "cddb-server", "freedb.freedb.org", NULL,
87 N_( "CDDB Server" ), N_( "Address of the CDDB server to use." ),
89 add_integer( "cddb-port", 8880, NULL,
90 N_( "CDDB port" ), N_( "CDDB Server port to use." ), true )
93 add_shortcut( "cdda" )
94 add_shortcut( "cddasimple" )
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)
102 /*****************************************************************************
103 * Access: local prototypes
104 *****************************************************************************/
107 vcddev_t *vcddev; /* vcd device descriptor */
109 /* Current position */
110 int i_sector; /* Current Sector */
111 int *p_sectors; /* Track sectors */
113 /* Wave header for the output data */
114 WAVEHEADER waveheader;
122 static block_t *Block( access_t * );
123 static int Seek( access_t *, int64_t );
124 static int Control( access_t *, int, va_list );
126 static int GetTracks( access_t *p_access, input_item_t *p_current );
129 static cddb_disc_t *GetCDDBInfo( access_t *p_access, int i_titles, int *p_sectors );
132 /*****************************************************************************
134 *****************************************************************************/
135 static int Open( vlc_object_t *p_this )
137 access_t *p_access = (access_t*)p_this;
142 if( !p_access->psz_path || !*p_access->psz_path )
144 /* Only when selected */
145 if( !p_this->b_force ) return VLC_EGENERIC;
147 psz_name = var_CreateGetString( p_this, "cd-audio" );
148 if( !psz_name || !*psz_name )
154 else psz_name = ToLocaleDup( p_access->psz_path );
157 if( psz_name[0] && psz_name[1] == ':' &&
158 psz_name[2] == '\\' && psz_name[3] == '\0' ) psz_name[2] = '\0';
162 if( (vcddev = ioctl_Open( VLC_OBJECT(p_access), psz_name ) ) == NULL )
164 msg_Warn( p_access, "could not open %s", psz_name );
170 /* Set up p_access */
171 STANDARD_BLOCK_ACCESS_INIT
172 p_sys->vcddev = vcddev;
174 /* Do we play a single track ? */
175 p_sys->i_track = var_CreateGetInteger( p_access, "cdda-track" ) - 1;
177 if( p_sys->i_track < 0 )
179 /* We only do separate items if the whole disc is requested */
180 input_thread_t *p_input = access_GetParentInput( p_access );
185 input_item_t *p_current = input_GetItem( p_input );
187 i_ret = GetTracks( p_access, p_current );
189 vlc_object_release( p_input );
196 /* Build a WAV header for the output data */
197 memset( &p_sys->waveheader, 0, sizeof(WAVEHEADER) );
198 SetWLE( &p_sys->waveheader.Format, 1 ); /*WAVE_FORMAT_PCM*/
199 SetWLE( &p_sys->waveheader.BitsPerSample, 16);
200 p_sys->waveheader.MainChunkID = VLC_FOURCC('R', 'I', 'F', 'F');
201 p_sys->waveheader.Length = 0; /* we just don't know */
202 p_sys->waveheader.ChunkTypeID = VLC_FOURCC('W', 'A', 'V', 'E');
203 p_sys->waveheader.SubChunkID = VLC_FOURCC('f', 'm', 't', ' ');
204 SetDWLE( &p_sys->waveheader.SubChunkLength, 16);
205 SetWLE( &p_sys->waveheader.Modus, 2);
206 SetDWLE( &p_sys->waveheader.SampleFreq, 44100);
207 SetWLE( &p_sys->waveheader.BytesPerSample,
208 2 /*Modus*/ * 16 /*BitsPerSample*/ / 8 );
209 SetDWLE( &p_sys->waveheader.BytesPerSec,
210 2*16/8 /*BytesPerSample*/ * 44100 /*SampleFreq*/ );
211 p_sys->waveheader.DataChunkID = VLC_FOURCC('d', 'a', 't', 'a');
212 p_sys->waveheader.DataLength = 0; /* we just don't know */
214 p_sys->i_first_sector = var_CreateGetInteger( p_access,
215 "cdda-first-sector" );
216 p_sys->i_last_sector = var_CreateGetInteger( p_access,
217 "cdda-last-sector" );
218 /* Tracknumber in MRL */
219 if( p_sys->i_first_sector < 0 || p_sys->i_last_sector < 0 )
221 const int i_titles = ioctl_GetTracksMap( VLC_OBJECT(p_access),
222 p_sys->vcddev, &p_sys->p_sectors );
223 if( p_sys->i_track >= i_titles )
225 msg_Err( p_access, "invalid track number" );
228 p_sys->i_first_sector = p_sys->p_sectors[p_sys->i_track];
229 p_sys->i_last_sector = p_sys->p_sectors[p_sys->i_track+1];
232 p_sys->i_sector = p_sys->i_first_sector;
233 p_access->info.i_size = (p_sys->i_last_sector - p_sys->i_first_sector)
234 * (int64_t)CDDA_DATA_SIZE;
238 var_Create( p_access, "cdda-caching", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
243 free( p_sys->p_sectors );
244 ioctl_Close( VLC_OBJECT(p_access), p_sys->vcddev );
249 /*****************************************************************************
251 *****************************************************************************/
252 static void Close( vlc_object_t *p_this )
254 access_t *p_access = (access_t *)p_this;
255 access_sys_t *p_sys = p_access->p_sys;
257 free( p_sys->p_sectors );
258 ioctl_Close( p_this, p_sys->vcddev );
262 /*****************************************************************************
263 * Block: read data (CDDA_DATA_ONCE)
264 *****************************************************************************/
265 static block_t *Block( access_t *p_access )
267 access_sys_t *p_sys = p_access->p_sys;
268 int i_blocks = CDDA_BLOCKS_ONCE;
271 if( p_sys->i_track < 0 ) p_access->info.b_eof = true;
273 /* Check end of file */
274 if( p_access->info.b_eof ) return NULL;
276 if( !p_sys->b_header )
278 /* Return only the header */
279 p_block = block_New( p_access, sizeof( WAVEHEADER ) );
280 memcpy( p_block->p_buffer, &p_sys->waveheader, sizeof(WAVEHEADER) );
281 p_sys->b_header = true;
285 if( p_sys->i_sector >= p_sys->i_last_sector )
287 p_access->info.b_eof = true;
291 /* Don't read too far */
292 if( p_sys->i_sector + i_blocks >= p_sys->i_last_sector )
293 i_blocks = p_sys->i_last_sector - p_sys->i_sector;
295 /* Do the actual reading */
296 if( !( p_block = block_New( p_access, i_blocks * CDDA_DATA_SIZE ) ) )
298 msg_Err( p_access, "cannot get a new block of size: %i",
299 i_blocks * CDDA_DATA_SIZE );
303 if( ioctl_ReadSectors( VLC_OBJECT(p_access), p_sys->vcddev,
304 p_sys->i_sector, p_block->p_buffer, i_blocks, CDDA_TYPE ) < 0 )
306 msg_Err( p_access, "cannot read sector %i", p_sys->i_sector );
307 block_Release( p_block );
309 /* Try to skip one sector (in case of bad sectors) */
311 p_access->info.i_pos += CDDA_DATA_SIZE;
315 /* Update a few values */
316 p_sys->i_sector += i_blocks;
317 p_access->info.i_pos += p_block->i_buffer;
322 /****************************************************************************
324 ****************************************************************************/
325 static int Seek( access_t *p_access, int64_t i_pos )
327 access_sys_t *p_sys = p_access->p_sys;
329 /* Next sector to read */
330 p_sys->i_sector = p_sys->i_first_sector + i_pos / CDDA_DATA_SIZE;
331 p_access->info.i_pos = i_pos;
336 /*****************************************************************************
338 *****************************************************************************/
339 static int Control( access_t *p_access, int i_query, va_list args )
343 case ACCESS_CAN_SEEK:
344 case ACCESS_CAN_FASTSEEK:
345 case ACCESS_CAN_PAUSE:
346 case ACCESS_CAN_CONTROL_PACE:
347 *va_arg( args, bool* ) = true;
350 case ACCESS_GET_PTS_DELAY:
351 *va_arg( args, int64_t * ) =
352 var_GetInteger( p_access, "cdda-caching" ) * INT64_C(1000);
355 case ACCESS_SET_PAUSE_STATE:
358 case ACCESS_GET_TITLE_INFO:
359 case ACCESS_SET_TITLE:
360 case ACCESS_GET_META:
361 case ACCESS_SET_SEEKPOINT:
362 case ACCESS_SET_PRIVATE_ID_STATE:
363 case ACCESS_GET_CONTENT_TYPE:
367 msg_Warn( p_access, "unimplemented query in control" );
373 static int GetTracks( access_t *p_access, input_item_t *p_current )
375 access_sys_t *p_sys = p_access->p_sys;
377 const int i_titles = ioctl_GetTracksMap( VLC_OBJECT(p_access),
378 p_sys->vcddev, &p_sys->p_sectors );
382 msg_Err( p_access, "unable to count tracks" );
383 else if( i_titles <= 0 )
384 msg_Err( p_access, "no audio tracks found" );
385 return VLC_EGENERIC;;
389 input_item_SetName( p_current, "Audio CD" );
391 const char *psz_album = NULL;
392 const char *psz_year = NULL;
393 const char *psz_genre = NULL;
394 const char *psz_artist = NULL;
395 const char *psz_description = NULL;
397 /* Return true if the given string is not NULL and not empty */
398 #define NONEMPTY( psz ) ( (psz) && *(psz) )
399 /* If the given string is NULL or empty, fill it by the return value of 'code' */
400 #define ON_EMPTY( psz, code ) do { if( !NONEMPTY( psz) ) { (psz) = code; } } while(0)
402 /* Retreive CDDB informations */
404 char psz_year_buffer[4+1];
405 msg_Dbg( p_access, "fetching infos with CDDB" );
406 cddb_disc_t *p_disc = GetCDDBInfo( p_access, i_titles, p_sys->p_sectors );
409 psz_album = cddb_disc_get_title( p_disc );
410 psz_genre = cddb_disc_get_genre( p_disc );
413 const unsigned i_year = cddb_disc_get_year( p_disc );
416 psz_year = psz_year_buffer;
417 snprintf( psz_year_buffer, sizeof(psz_year_buffer), "%u", i_year );
420 /* Set artist only if unique */
421 for( int i = 0; i < i_titles; i++ )
423 cddb_track_t *t = cddb_disc_get_track( p_disc, i );
426 const char *psz_track_artist = cddb_track_get_artist( t );
427 if( psz_artist && psz_track_artist &&
428 strcmp( psz_artist, psz_track_artist ) )
433 psz_artist = psz_track_artist;
439 vlc_meta_t **pp_cd_text;
442 if( ioctl_GetCdText( VLC_OBJECT(p_access), p_sys->vcddev, &pp_cd_text, &i_cd_text ) )
444 msg_Dbg( p_access, "CD-TEXT information missing" );
449 /* Retreive CD-TEXT informations but prefer CDDB */
450 if( i_cd_text > 0 && pp_cd_text[0] )
452 const vlc_meta_t *p_disc = pp_cd_text[0];
453 ON_EMPTY( psz_album, vlc_meta_Get( p_disc, vlc_meta_Album ) );
454 ON_EMPTY( psz_genre, vlc_meta_Get( p_disc, vlc_meta_Genre ) );
455 ON_EMPTY( psz_artist, vlc_meta_Get( p_disc, vlc_meta_Artist ) );
456 ON_EMPTY( psz_description, vlc_meta_Get( p_disc, vlc_meta_Description ) );
459 if( NONEMPTY( psz_album ) )
461 input_item_SetName( p_current, psz_album );
462 input_item_SetAlbum( p_current, psz_album );
465 if( NONEMPTY( psz_genre ) )
466 input_item_SetGenre( p_current, psz_genre );
468 if( NONEMPTY( psz_artist ) )
469 input_item_SetArtist( p_current, psz_artist );
471 if( NONEMPTY( psz_year ) )
472 input_item_SetDate( p_current, psz_year );
474 if( NONEMPTY( psz_description ) )
475 input_item_SetDescription( p_current, psz_description );
477 const mtime_t i_duration = (int64_t)( p_sys->p_sectors[i_titles] - p_sys->p_sectors[0] ) *
478 CDDA_DATA_SIZE * 1000000 / 44100 / 2 / 2;
479 input_item_SetDuration( p_current, i_duration );
481 /* Build title table */
482 for( int i = 0; i < i_titles; i++ )
484 input_item_t *p_input_item;
486 char *psz_uri, *psz_opt, *psz_first, *psz_last;
489 msg_Dbg( p_access, "track[%d] start=%d", i, p_sys->p_sectors[i] );
492 if( asprintf( &psz_uri, "cdda://%s", p_access->psz_path ) == -1 )
494 if( asprintf( &psz_opt, "cdda-track=%i", i+1 ) == -1 )
496 if( asprintf( &psz_first, "cdda-first-sector=%i",p_sys->p_sectors[i] ) == -1 )
498 if( asprintf( &psz_last, "cdda-last-sector=%i", p_sys->p_sectors[i+1] ) == -1 )
501 /* Define a "default name" */
502 if( asprintf( &psz_name, _("Audio CD - Track %02i"), (i+1) ) == -1 )
505 /* Create playlist items */
506 const mtime_t i_duration = (int64_t)( p_sys->p_sectors[i+1] - p_sys->p_sectors[i] ) *
507 CDDA_DATA_SIZE * 1000000 / 44100 / 2 / 2;
508 p_input_item = input_item_NewWithType( VLC_OBJECT( p_access ),
509 psz_uri, psz_name, 0, NULL, 0, i_duration,
511 input_item_CopyOptions( p_current, p_input_item );
512 input_item_AddOption( p_input_item, psz_first, VLC_INPUT_OPTION_TRUSTED );
513 input_item_AddOption( p_input_item, psz_last, VLC_INPUT_OPTION_TRUSTED );
514 input_item_AddOption( p_input_item, psz_opt, VLC_INPUT_OPTION_TRUSTED );
516 const char *psz_track_title = NULL;
517 const char *psz_track_artist = NULL;
518 const char *psz_track_genre = NULL;
519 const char *psz_track_description = NULL;
522 /* Retreive CDDB informations */
525 cddb_track_t *t = cddb_disc_get_track( p_disc, i );
528 psz_track_title = cddb_track_get_title( t );
529 psz_track_artist = cddb_track_get_artist( t );
534 /* Retreive CD-TEXT informations but prefer CDDB */
535 if( i+1 < i_cd_text && pp_cd_text[i+1] )
537 const vlc_meta_t *t = pp_cd_text[i+1];
539 ON_EMPTY( psz_track_title, vlc_meta_Get( t, vlc_meta_Title ) );
540 ON_EMPTY( psz_track_artist, vlc_meta_Get( t, vlc_meta_Artist ) );
541 ON_EMPTY( psz_track_genre, vlc_meta_Get( t, vlc_meta_Genre ) );
542 ON_EMPTY( psz_track_description, vlc_meta_Get( t, vlc_meta_Description ) );
546 ON_EMPTY( psz_track_artist, psz_artist );
547 ON_EMPTY( psz_track_genre, psz_genre );
548 ON_EMPTY( psz_track_description, psz_description );
551 if( NONEMPTY( psz_track_title ) )
553 input_item_SetName( p_input_item, psz_track_title );
554 input_item_SetTitle( p_input_item, psz_track_title );
557 if( NONEMPTY( psz_track_artist ) )
558 input_item_SetArtist( p_input_item, psz_track_artist );
560 if( NONEMPTY( psz_track_genre ) )
561 input_item_SetGenre( p_input_item, psz_track_genre );
563 if( NONEMPTY( psz_track_description ) )
564 input_item_SetDescription( p_input_item, psz_track_description );
566 if( NONEMPTY( psz_album ) )
567 input_item_SetAlbum( p_input_item, psz_album );
569 if( NONEMPTY( psz_year ) )
570 input_item_SetDate( p_input_item, psz_year );
573 snprintf( psz_num, sizeof(psz_num), "%d", 1+i );
574 input_item_SetTrackNum( p_input_item, psz_num );
576 input_item_AddSubItem( p_current, p_input_item );
577 vlc_gc_decref( p_input_item );
578 free( psz_uri ); free( psz_opt ); free( psz_name );
579 free( psz_first ); free( psz_last );
585 for( int i = 0; i < i_cd_text; i++ )
587 vlc_meta_t *p_meta = pp_cd_text[i];
590 vlc_meta_Delete( p_meta );
596 cddb_disc_destroy( p_disc );
602 static cddb_disc_t *GetCDDBInfo( access_t *p_access, int i_titles, int *p_sectors )
604 if( var_CreateGetInteger( p_access, "album-art" ) == ALBUM_ART_WHEN_ASKED )
608 cddb_conn_t *p_cddb = cddb_new();
611 msg_Warn( p_access, "unable to use CDDB" );
616 char *psz_tmp = config_GetPsz( p_access, "cddb-server" );
617 cddb_set_server_name( p_cddb, psz_tmp );
620 cddb_set_server_port( p_cddb, config_GetInt( p_access, "cddb-port" ) );
622 cddb_set_email_address( p_cddb, "vlc@videolan.org" );
625 cddb_cache_disable( p_cddb );
627 // cddb_cache_set_dir( p_cddb,
628 // config_GetPsz( p_access,
629 // MODULE_STRING "-cddb-cachedir") );
631 cddb_set_timeout( p_cddb, 10 );
634 cddb_http_disable( p_cddb );
637 cddb_disc_t *p_disc = cddb_disc_new();
640 msg_Err( p_access, "unable to create CDDB disc structure." );
644 int64_t i_length = 0;
645 for( int i = 0; i < i_titles; i++ )
647 cddb_track_t *t = cddb_track_new();
648 cddb_track_set_frame_offset( t, p_sectors[i] );
649 cddb_disc_add_track( p_disc, t );
650 const int64_t i_size = ( p_sectors[i+1] - p_sectors[i] ) *
651 (int64_t)CDDA_DATA_SIZE;
652 i_length += INT64_C(1000000) * i_size / 44100 / 4 ;
655 cddb_disc_set_length( p_disc, (int)(i_length/1000000) );
657 if( !cddb_disc_calc_discid( p_disc ) )
659 msg_Err( p_access, "CDDB disc ID calculation failed" );
663 const int i_matches = cddb_query( p_cddb, p_disc );
666 msg_Warn( p_access, "CDDB error: %s", cddb_error_str(errno) );
669 else if( i_matches == 0 )
671 msg_Dbg( p_access, "Couldn't find any matches in CDDB." );
674 else if( i_matches > 1 )
675 msg_Warn( p_access, "found %d matches in CDDB. Using first one.", i_matches );
677 cddb_read( p_cddb, p_disc );
679 cddb_destroy( p_cddb);
684 cddb_disc_destroy( p_disc );
685 cddb_destroy( p_cddb );
688 #endif /*HAVE_LIBCDDB*/