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, N_( "CDDB Server" ),
87 N_( "Address of the CDDB server to use." ), true )
88 add_integer( "cddb-port", 8880, NULL, N_( "CDDB port" ),
89 N_( "CDDB Server port to use." ), true )
92 add_shortcut( "cdda" )
93 add_shortcut( "cddasimple" )
97 /* how many blocks VCDRead will read in each loop */
98 #define CDDA_BLOCKS_ONCE 20
99 #define CDDA_DATA_ONCE (CDDA_BLOCKS_ONCE * CDDA_DATA_SIZE)
101 /*****************************************************************************
102 * Access: local prototypes
103 *****************************************************************************/
106 vcddev_t *vcddev; /* vcd device descriptor */
108 /* Current position */
109 int i_sector; /* Current Sector */
110 int *p_sectors; /* Track sectors */
112 /* Wave header for the output data */
113 WAVEHEADER waveheader;
121 static block_t *Block( access_t * );
122 static int Seek( access_t *, int64_t );
123 static int Control( access_t *, int, va_list );
125 static int GetTracks( access_t *p_access, input_item_t *p_current );
128 static cddb_disc_t *GetCDDBInfo( access_t *p_access, int i_titles, int *p_sectors );
131 /*****************************************************************************
133 *****************************************************************************/
134 static int Open( vlc_object_t *p_this )
136 access_t *p_access = (access_t*)p_this;
141 if( !p_access->psz_path || !*p_access->psz_path )
143 /* Only when selected */
144 if( !p_this->b_force ) return VLC_EGENERIC;
146 psz_name = var_CreateGetString( p_this, "cd-audio" );
147 if( !psz_name || !*psz_name )
153 else psz_name = ToLocaleDup( p_access->psz_path );
156 if( psz_name[0] && psz_name[1] == ':' &&
157 psz_name[2] == '\\' && psz_name[3] == '\0' ) psz_name[2] = '\0';
161 if( (vcddev = ioctl_Open( VLC_OBJECT(p_access), psz_name ) ) == NULL )
163 msg_Warn( p_access, "could not open %s", psz_name );
169 /* Set up p_access */
170 STANDARD_BLOCK_ACCESS_INIT
171 p_sys->vcddev = vcddev;
173 /* Do we play a single track ? */
174 p_sys->i_track = var_CreateGetInteger( p_access, "cdda-track" ) - 1;
176 if( p_sys->i_track < 0 )
178 /* We only do separate items if the whole disc is requested */
179 input_thread_t *p_input = access_GetParentInput( p_access );
184 input_item_t *p_current = input_GetItem( p_input );
186 i_ret = GetTracks( p_access, p_current );
188 vlc_object_release( p_input );
195 /* Build a WAV header for the output data */
196 memset( &p_sys->waveheader, 0, sizeof(WAVEHEADER) );
197 SetWLE( &p_sys->waveheader.Format, 1 ); /*WAVE_FORMAT_PCM*/
198 SetWLE( &p_sys->waveheader.BitsPerSample, 16);
199 p_sys->waveheader.MainChunkID = VLC_FOURCC('R', 'I', 'F', 'F');
200 p_sys->waveheader.Length = 0; /* we just don't know */
201 p_sys->waveheader.ChunkTypeID = VLC_FOURCC('W', 'A', 'V', 'E');
202 p_sys->waveheader.SubChunkID = VLC_FOURCC('f', 'm', 't', ' ');
203 SetDWLE( &p_sys->waveheader.SubChunkLength, 16);
204 SetWLE( &p_sys->waveheader.Modus, 2);
205 SetDWLE( &p_sys->waveheader.SampleFreq, 44100);
206 SetWLE( &p_sys->waveheader.BytesPerSample,
207 2 /*Modus*/ * 16 /*BitsPerSample*/ / 8 );
208 SetDWLE( &p_sys->waveheader.BytesPerSec,
209 2*16/8 /*BytesPerSample*/ * 44100 /*SampleFreq*/ );
210 p_sys->waveheader.DataChunkID = VLC_FOURCC('d', 'a', 't', 'a');
211 p_sys->waveheader.DataLength = 0; /* we just don't know */
213 p_sys->i_first_sector = var_CreateGetInteger( p_access,
214 "cdda-first-sector" );
215 p_sys->i_last_sector = var_CreateGetInteger( p_access,
216 "cdda-last-sector" );
217 /* Tracknumber in MRL */
218 if( p_sys->i_first_sector < 0 || p_sys->i_last_sector < 0 )
220 const int i_titles = ioctl_GetTracksMap( VLC_OBJECT(p_access),
221 p_sys->vcddev, &p_sys->p_sectors );
222 if( p_sys->i_track >= i_titles )
224 msg_Err( p_access, "invalid track number" );
227 p_sys->i_first_sector = p_sys->p_sectors[p_sys->i_track];
228 p_sys->i_last_sector = p_sys->p_sectors[p_sys->i_track+1];
231 p_sys->i_sector = p_sys->i_first_sector;
232 p_access->info.i_size = (p_sys->i_last_sector - p_sys->i_first_sector)
233 * (int64_t)CDDA_DATA_SIZE;
237 var_Create( p_access, "cdda-caching", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
242 free( p_sys->p_sectors );
243 ioctl_Close( VLC_OBJECT(p_access), p_sys->vcddev );
248 /*****************************************************************************
250 *****************************************************************************/
251 static void Close( vlc_object_t *p_this )
253 access_t *p_access = (access_t *)p_this;
254 access_sys_t *p_sys = p_access->p_sys;
256 free( p_sys->p_sectors );
257 ioctl_Close( p_this, p_sys->vcddev );
261 /*****************************************************************************
262 * Block: read data (CDDA_DATA_ONCE)
263 *****************************************************************************/
264 static block_t *Block( access_t *p_access )
266 access_sys_t *p_sys = p_access->p_sys;
267 int i_blocks = CDDA_BLOCKS_ONCE;
270 if( p_sys->i_track < 0 ) p_access->info.b_eof = true;
272 /* Check end of file */
273 if( p_access->info.b_eof ) return NULL;
275 if( !p_sys->b_header )
277 /* Return only the header */
278 p_block = block_New( p_access, sizeof( WAVEHEADER ) );
279 memcpy( p_block->p_buffer, &p_sys->waveheader, sizeof(WAVEHEADER) );
280 p_sys->b_header = true;
284 if( p_sys->i_sector >= p_sys->i_last_sector )
286 p_access->info.b_eof = true;
290 /* Don't read too far */
291 if( p_sys->i_sector + i_blocks >= p_sys->i_last_sector )
292 i_blocks = p_sys->i_last_sector - p_sys->i_sector;
294 /* Do the actual reading */
295 if( !( p_block = block_New( p_access, i_blocks * CDDA_DATA_SIZE ) ) )
297 msg_Err( p_access, "cannot get a new block of size: %i",
298 i_blocks * CDDA_DATA_SIZE );
302 if( ioctl_ReadSectors( VLC_OBJECT(p_access), p_sys->vcddev,
303 p_sys->i_sector, p_block->p_buffer, i_blocks, CDDA_TYPE ) < 0 )
305 msg_Err( p_access, "cannot read sector %i", p_sys->i_sector );
306 block_Release( p_block );
308 /* Try to skip one sector (in case of bad sectors) */
310 p_access->info.i_pos += CDDA_DATA_SIZE;
314 /* Update a few values */
315 p_sys->i_sector += i_blocks;
316 p_access->info.i_pos += p_block->i_buffer;
321 /****************************************************************************
323 ****************************************************************************/
324 static int Seek( access_t *p_access, int64_t i_pos )
326 access_sys_t *p_sys = p_access->p_sys;
328 /* Next sector to read */
329 p_sys->i_sector = p_sys->i_first_sector + i_pos / CDDA_DATA_SIZE;
330 p_access->info.i_pos = i_pos;
335 /*****************************************************************************
337 *****************************************************************************/
338 static int Control( access_t *p_access, int i_query, va_list args )
342 case ACCESS_CAN_SEEK:
343 case ACCESS_CAN_FASTSEEK:
344 case ACCESS_CAN_PAUSE:
345 case ACCESS_CAN_CONTROL_PACE:
346 *va_arg( args, bool* ) = true;
349 case ACCESS_GET_PTS_DELAY:
350 *va_arg( args, int64_t * ) =
351 var_GetInteger( p_access, "cdda-caching" ) * INT64_C(1000);
354 case ACCESS_SET_PAUSE_STATE:
357 case ACCESS_GET_TITLE_INFO:
358 case ACCESS_SET_TITLE:
359 case ACCESS_GET_META:
360 case ACCESS_SET_SEEKPOINT:
361 case ACCESS_SET_PRIVATE_ID_STATE:
362 case ACCESS_GET_CONTENT_TYPE:
366 msg_Warn( p_access, "unimplemented query in control" );
372 static int GetTracks( access_t *p_access, input_item_t *p_current )
374 access_sys_t *p_sys = p_access->p_sys;
376 const int i_titles = ioctl_GetTracksMap( VLC_OBJECT(p_access),
377 p_sys->vcddev, &p_sys->p_sectors );
381 msg_Err( p_access, "unable to count tracks" );
382 else if( i_titles <= 0 )
383 msg_Err( p_access, "no audio tracks found" );
384 return VLC_EGENERIC;;
388 input_item_SetName( p_current, "Audio CD" );
390 const char *psz_album = NULL;
391 const char *psz_year = NULL;
392 const char *psz_genre = NULL;
393 const char *psz_artist = NULL;
394 const char *psz_description = NULL;
396 /* Return true if the given string is not NULL and not empty */
397 #define NONEMPTY( psz ) ( (psz) && *(psz) )
398 /* If the given string is NULL or empty, fill it by the return value of 'code' */
399 #define ON_EMPTY( psz, code ) do { if( !NONEMPTY( psz) ) { (psz) = code; } } while(0)
401 /* Retreive CDDB informations */
403 char psz_year_buffer[4+1];
404 msg_Dbg( p_access, "fetching infos with CDDB" );
405 cddb_disc_t *p_disc = GetCDDBInfo( p_access, i_titles, p_sys->p_sectors );
408 psz_album = cddb_disc_get_title( p_disc );
409 psz_genre = cddb_disc_get_genre( p_disc );
412 const unsigned i_year = cddb_disc_get_year( p_disc );
415 psz_year = psz_year_buffer;
416 snprintf( psz_year_buffer, sizeof(psz_year_buffer), "%u", i_year );
419 /* Set artist only if unique */
420 for( int i = 0; i < i_titles; i++ )
422 cddb_track_t *t = cddb_disc_get_track( p_disc, i );
425 const char *psz_track_artist = cddb_track_get_artist( t );
426 if( psz_artist && psz_track_artist &&
427 strcmp( psz_artist, psz_track_artist ) )
432 psz_artist = psz_track_artist;
438 vlc_meta_t **pp_cd_text;
441 if( ioctl_GetCdText( VLC_OBJECT(p_access), p_sys->vcddev, &pp_cd_text, &i_cd_text ) )
443 msg_Dbg( p_access, "CD-TEXT information missing" );
448 /* Retrieve CD-TEXT informations but prefer CDDB */
449 if( i_cd_text > 0 && pp_cd_text[0] )
451 const vlc_meta_t *p_disc = pp_cd_text[0];
452 ON_EMPTY( psz_album, vlc_meta_Get( p_disc, vlc_meta_Album ) );
453 ON_EMPTY( psz_genre, vlc_meta_Get( p_disc, vlc_meta_Genre ) );
454 ON_EMPTY( psz_artist, vlc_meta_Get( p_disc, vlc_meta_Artist ) );
455 ON_EMPTY( psz_description, vlc_meta_Get( p_disc, vlc_meta_Description ) );
458 if( NONEMPTY( psz_album ) )
460 input_item_SetName( p_current, psz_album );
461 input_item_SetAlbum( p_current, psz_album );
464 if( NONEMPTY( psz_genre ) )
465 input_item_SetGenre( p_current, psz_genre );
467 if( NONEMPTY( psz_artist ) )
468 input_item_SetArtist( p_current, psz_artist );
470 if( NONEMPTY( psz_year ) )
471 input_item_SetDate( p_current, psz_year );
473 if( NONEMPTY( psz_description ) )
474 input_item_SetDescription( p_current, psz_description );
476 const mtime_t i_duration = (int64_t)( p_sys->p_sectors[i_titles] - p_sys->p_sectors[0] ) *
477 CDDA_DATA_SIZE * 1000000 / 44100 / 2 / 2;
478 input_item_SetDuration( p_current, i_duration );
480 /* Build title table */
481 for( int i = 0; i < i_titles; i++ )
483 input_item_t *p_input_item;
485 char *psz_uri, *psz_opt, *psz_first, *psz_last;
488 msg_Dbg( p_access, "track[%d] start=%d", i, p_sys->p_sectors[i] );
491 if( asprintf( &psz_uri, "cdda://%s", p_access->psz_path ) == -1 )
493 if( asprintf( &psz_opt, "cdda-track=%i", i+1 ) == -1 )
495 if( asprintf( &psz_first, "cdda-first-sector=%i",p_sys->p_sectors[i] ) == -1 )
497 if( asprintf( &psz_last, "cdda-last-sector=%i", p_sys->p_sectors[i+1] ) == -1 )
500 /* Define a "default name" */
501 if( asprintf( &psz_name, _("Audio CD - Track %02i"), (i+1) ) == -1 )
504 /* Create playlist items */
505 const mtime_t i_duration = (int64_t)( p_sys->p_sectors[i+1] - p_sys->p_sectors[i] ) *
506 CDDA_DATA_SIZE * 1000000 / 44100 / 2 / 2;
507 p_input_item = input_item_NewWithType( VLC_OBJECT( p_access ),
508 psz_uri, psz_name, 0, NULL, 0, i_duration,
510 input_item_CopyOptions( p_current, p_input_item );
511 input_item_AddOption( p_input_item, psz_first, VLC_INPUT_OPTION_TRUSTED );
512 input_item_AddOption( p_input_item, psz_last, VLC_INPUT_OPTION_TRUSTED );
513 input_item_AddOption( p_input_item, psz_opt, VLC_INPUT_OPTION_TRUSTED );
515 const char *psz_track_title = NULL;
516 const char *psz_track_artist = NULL;
517 const char *psz_track_genre = NULL;
518 const char *psz_track_description = NULL;
521 /* Retreive CDDB informations */
524 cddb_track_t *t = cddb_disc_get_track( p_disc, i );
527 psz_track_title = cddb_track_get_title( t );
528 psz_track_artist = cddb_track_get_artist( t );
533 /* Retreive CD-TEXT informations but prefer CDDB */
534 if( i+1 < i_cd_text && pp_cd_text[i+1] )
536 const vlc_meta_t *t = pp_cd_text[i+1];
538 ON_EMPTY( psz_track_title, vlc_meta_Get( t, vlc_meta_Title ) );
539 ON_EMPTY( psz_track_artist, vlc_meta_Get( t, vlc_meta_Artist ) );
540 ON_EMPTY( psz_track_genre, vlc_meta_Get( t, vlc_meta_Genre ) );
541 ON_EMPTY( psz_track_description, vlc_meta_Get( t, vlc_meta_Description ) );
545 ON_EMPTY( psz_track_artist, psz_artist );
546 ON_EMPTY( psz_track_genre, psz_genre );
547 ON_EMPTY( psz_track_description, psz_description );
550 if( NONEMPTY( psz_track_title ) )
552 input_item_SetName( p_input_item, psz_track_title );
553 input_item_SetTitle( p_input_item, psz_track_title );
556 if( NONEMPTY( psz_track_artist ) )
557 input_item_SetArtist( p_input_item, psz_track_artist );
559 if( NONEMPTY( psz_track_genre ) )
560 input_item_SetGenre( p_input_item, psz_track_genre );
562 if( NONEMPTY( psz_track_description ) )
563 input_item_SetDescription( p_input_item, psz_track_description );
565 if( NONEMPTY( psz_album ) )
566 input_item_SetAlbum( p_input_item, psz_album );
568 if( NONEMPTY( psz_year ) )
569 input_item_SetDate( p_input_item, psz_year );
572 snprintf( psz_num, sizeof(psz_num), "%d", 1+i );
573 input_item_SetTrackNum( p_input_item, psz_num );
575 input_item_AddSubItem( p_current, p_input_item );
576 vlc_gc_decref( p_input_item );
577 free( psz_uri ); free( psz_opt ); free( psz_name );
578 free( psz_first ); free( psz_last );
584 for( int i = 0; i < i_cd_text; i++ )
586 vlc_meta_t *p_meta = pp_cd_text[i];
589 vlc_meta_Delete( p_meta );
595 cddb_disc_destroy( p_disc );
601 static cddb_disc_t *GetCDDBInfo( access_t *p_access, int i_titles, int *p_sectors )
603 if( var_CreateGetInteger( p_access, "album-art" ) == ALBUM_ART_WHEN_ASKED )
607 cddb_conn_t *p_cddb = cddb_new();
610 msg_Warn( p_access, "unable to use CDDB" );
615 char *psz_tmp = var_InheritString( p_access, "cddb-server" );
618 cddb_set_server_name( p_cddb, psz_tmp );
622 cddb_set_server_port( p_cddb, var_InheritInteger( p_access, "cddb-port" ) );
624 cddb_set_email_address( p_cddb, "vlc@videolan.org" );
627 cddb_cache_disable( p_cddb );
629 // cddb_cache_set_dir( p_cddb,
630 // var_InheritString( p_access,
631 // MODULE_STRING "-cddb-cachedir") );
633 cddb_set_timeout( p_cddb, 10 );
636 cddb_http_disable( p_cddb );
639 cddb_disc_t *p_disc = cddb_disc_new();
642 msg_Err( p_access, "unable to create CDDB disc structure." );
646 int64_t i_length = 0;
647 for( int i = 0; i < i_titles; i++ )
649 cddb_track_t *t = cddb_track_new();
650 cddb_track_set_frame_offset( t, p_sectors[i] );
651 cddb_disc_add_track( p_disc, t );
652 const int64_t i_size = ( p_sectors[i+1] - p_sectors[i] ) *
653 (int64_t)CDDA_DATA_SIZE;
654 i_length += INT64_C(1000000) * i_size / 44100 / 4 ;
657 cddb_disc_set_length( p_disc, (int)(i_length/1000000) );
659 if( !cddb_disc_calc_discid( p_disc ) )
661 msg_Err( p_access, "CDDB disc ID calculation failed" );
665 const int i_matches = cddb_query( p_cddb, p_disc );
668 msg_Warn( p_access, "CDDB error: %s", cddb_error_str(errno) );
671 else if( i_matches == 0 )
673 msg_Dbg( p_access, "Couldn't find any matches in CDDB." );
676 else if( i_matches > 1 )
677 msg_Warn( p_access, "found %d matches in CDDB. Using first one.", i_matches );
679 cddb_read( p_cddb, p_disc );
681 cddb_destroy( p_cddb);
686 cddb_disc_destroy( p_disc );
687 cddb_destroy( p_cddb );
690 #endif /*HAVE_LIBCDDB*/