Contribs: update dvbpsi to 1.3.2
[vlc.git] / modules / access / cdda.c
blobf6f6770fef8bb534375a315017990c67133a9cd1
1 /*****************************************************************************
2 * cdda.c : CD digital audio input module for vlc
3 *****************************************************************************
4 * Copyright (C) 2000, 2003-2006, 2008-2009 VLC authors and VideoLAN
5 * $Id$
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 it
11 * under the terms of the GNU Lesser General Public License as published by
12 * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public License
21 * along with this program; if not, write to the Free Software Foundation,
22 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
25 /**
26 * Todo:
27 * - Improve CDDB support (non-blocking, ...)
28 * - Fix tracknumber in MRL
31 /*****************************************************************************
32 * Preamble
33 *****************************************************************************/
35 #ifdef HAVE_CONFIG_H
36 # include "config.h"
37 #endif
39 #include <assert.h>
40 #include <math.h>
41 #include <stdlib.h>
42 #include <string.h>
44 #include <vlc_common.h>
45 #include <vlc_demux.h>
46 #include <vlc_plugin.h>
47 #include <vlc_input.h>
48 #include <vlc_access.h>
49 #include <vlc_meta.h>
50 #include <vlc_charset.h> /* ToLocaleDup */
51 #include <vlc_url.h>
53 #include "vcd/cdrom.h" /* For CDDA_DATA_SIZE */
55 #ifdef HAVE_LIBCDDB
56 #include <cddb/cddb.h>
57 #include <errno.h>
58 #endif
60 static vcddev_t *DiscOpen(vlc_object_t *obj, const char *location,
61 const char *path, unsigned *restrict trackp)
63 char *devpath;
65 *trackp = var_InheritInteger(obj, "cdda-track");
67 if (path != NULL)
68 devpath = ToLocaleDup(path);
69 else if (location[0] != '\0')
71 #if (DIR_SEP_CHAR == '/')
72 char *dec = vlc_uri_decode_duplicate(location);
73 if (dec == NULL)
74 return NULL;
76 /* GNOME CDDA syntax */
77 const char *sl = strrchr(dec, '/');
78 if (sl != NULL)
80 if (sscanf(sl, "/Track %2u", trackp) == 1)
81 dec[sl - dec] = '\0';
82 else
83 *trackp = 0;
86 if (unlikely(asprintf(&devpath, "/dev/%s", dec) == -1))
87 devpath = NULL;
88 free(dec);
89 #else
90 (void) location;
91 return NULL;
92 #endif
94 else
95 devpath = var_InheritString(obj, "cd-audio");
97 if (devpath == NULL)
98 return NULL;
100 #if defined (_WIN32) || defined (__OS2__)
101 /* Trim backslash after drive letter */
102 if (devpath[0] != '\0' && !strcmp(&devpath[1], ":" DIR_SEP))
103 devpath[2] = '\0';
104 #endif
106 /* Open CDDA */
107 vcddev_t *dev = ioctl_Open(obj, devpath);
108 if (dev == NULL)
109 msg_Warn(obj, "cannot open disc %s", devpath);
110 free(devpath);
112 return dev;
115 /* how many blocks Demux() will read in each iteration */
116 #define CDDA_BLOCKS_ONCE 20
118 typedef struct
120 vcddev_t *vcddev; /* vcd device descriptor */
121 es_out_id_t *es;
122 date_t pts;
124 unsigned start; /**< Track first sector */
125 unsigned length; /**< Track total sectors */
126 unsigned position; /**< Current offset within track sectors */
127 } demux_sys_t;
129 static int Demux(demux_t *demux)
131 demux_sys_t *sys = demux->p_sys;
132 unsigned count = CDDA_BLOCKS_ONCE;
134 if (sys->position >= sys->length)
135 return VLC_DEMUXER_EOF;
137 if (sys->position + count >= sys->length)
138 count = sys->length - sys->position;
140 block_t *block = block_Alloc(count * CDDA_DATA_SIZE);
141 if (unlikely(block == NULL))
142 return VLC_DEMUXER_EOF;
144 if (ioctl_ReadSectors(VLC_OBJECT(demux), sys->vcddev,
145 sys->start + sys->position,
146 block->p_buffer, count, CDDA_TYPE) < 0)
148 msg_Err(demux, "cannot read sector %u", sys->position);
149 block_Release(block);
151 /* Skip potentially bad sector */
152 sys->position++;
153 return VLC_DEMUXER_SUCCESS;
156 sys->position += count;
158 block->i_nb_samples = block->i_buffer / 4;
159 block->i_dts = block->i_pts = VLC_TS_0 + date_Get(&sys->pts);
160 date_Increment(&sys->pts, block->i_nb_samples);
162 es_out_Send(demux->out, sys->es, block);
163 es_out_SetPCR(demux->out, VLC_TS_0 + date_Get(&sys->pts));
164 return VLC_DEMUXER_SUCCESS;
167 static int DemuxControl(demux_t *demux, int query, va_list args)
169 demux_sys_t *sys = demux->p_sys;
171 /* One sector is 40000/3 µs */
172 static_assert (CDDA_DATA_SIZE * CLOCK_FREQ * 3 ==
173 4 * 44100 * INT64_C(40000), "Wrong time/sector ratio");
175 switch (query)
177 case DEMUX_CAN_SEEK:
178 case DEMUX_CAN_PAUSE:
179 case DEMUX_CAN_CONTROL_PACE:
180 *va_arg(args, bool*) = true;
181 break;
182 case DEMUX_GET_PTS_DELAY:
183 *va_arg(args, int64_t *) =
184 INT64_C(1000) * var_InheritInteger(demux, "disc-caching");
185 break;
187 case DEMUX_SET_PAUSE_STATE:
188 break;
190 case DEMUX_GET_POSITION:
191 *va_arg(args, double *) = (double)(sys->position)
192 / (double)(sys->length);
193 break;
195 case DEMUX_SET_POSITION:
196 sys->position = lround(va_arg(args, double) * sys->length);
197 break;
199 case DEMUX_GET_LENGTH:
200 *va_arg(args, mtime_t *) = (INT64_C(40000) * sys->length) / 3;
201 break;
202 case DEMUX_GET_TIME:
203 *va_arg(args, mtime_t *) = (INT64_C(40000) * sys->position) / 3;
204 break;
205 case DEMUX_SET_TIME:
206 sys->position = (va_arg(args, mtime_t) * 3) / INT64_C(40000);
207 break;
209 default:
210 return VLC_EGENERIC;
212 return VLC_SUCCESS;
215 static int DemuxOpen(vlc_object_t *obj, vcddev_t *dev, unsigned track)
217 demux_t *demux = (demux_t *)obj;
219 if (demux->out == NULL)
220 goto error;
222 demux_sys_t *sys = vlc_obj_malloc(obj, sizeof (*sys));
223 if (unlikely(sys == NULL))
224 goto error;
226 demux->p_sys = sys;
227 sys->vcddev = dev;
228 sys->start = var_InheritInteger(obj, "cdda-first-sector");
229 sys->length = var_InheritInteger(obj, "cdda-last-sector") - sys->start;
231 /* Track number in input item */
232 if (sys->start == (unsigned)-1 || sys->length == (unsigned)-1)
234 int *sectors = NULL; /* Track sectors */
235 unsigned titles = ioctl_GetTracksMap(obj, dev, &sectors);
237 if (track > titles)
239 msg_Err(obj, "invalid track number: %u/%u", track, titles);
240 free(sectors);
241 goto error;
244 sys->start = sectors[track - 1];
245 sys->length = sectors[track] - sys->start;
246 free(sectors);
249 es_format_t fmt;
251 es_format_Init(&fmt, AUDIO_ES, VLC_CODEC_S16L);
252 fmt.audio.i_rate = 44100;
253 fmt.audio.i_channels = 2;
254 sys->es = es_out_Add(demux->out, &fmt);
256 date_Init(&sys->pts, 44100, 1);
258 sys->position = 0;
259 demux->pf_demux = Demux;
260 demux->pf_control = DemuxControl;
261 return VLC_SUCCESS;
263 error:
264 ioctl_Close(obj, dev);
265 return VLC_EGENERIC;
268 /*****************************************************************************
269 * Access: local prototypes
270 *****************************************************************************/
271 typedef struct
273 vcddev_t *vcddev; /* vcd device descriptor */
274 int *p_sectors; /* Track sectors */
275 int titles;
276 int cdtextc;
277 vlc_meta_t **cdtextv;
278 #ifdef HAVE_LIBCDDB
279 cddb_disc_t *cddb;
280 #endif
281 } access_sys_t;
283 #ifdef HAVE_LIBCDDB
284 static cddb_disc_t *GetCDDBInfo( vlc_object_t *obj, int i_titles, int *p_sectors )
286 if( !var_InheritBool( obj, "metadata-network-access" ) )
288 msg_Dbg( obj, "album art policy set to manual: not fetching" );
289 return NULL;
292 /* */
293 cddb_conn_t *p_cddb = cddb_new();
294 if( !p_cddb )
296 msg_Warn( obj, "unable to use CDDB" );
297 return NULL;
300 /* */
302 cddb_http_enable( p_cddb );
304 char *psz_tmp = var_InheritString( obj, "cddb-server" );
305 if( psz_tmp )
307 cddb_set_server_name( p_cddb, psz_tmp );
308 free( psz_tmp );
311 cddb_set_server_port( p_cddb, var_InheritInteger( obj, "cddb-port" ) );
313 cddb_set_email_address( p_cddb, "vlc@videolan.org" );
315 cddb_set_http_path_query( p_cddb, "/~cddb/cddb.cgi" );
316 cddb_set_http_path_submit( p_cddb, "/~cddb/submit.cgi" );
319 char *psz_cachedir;
320 char *psz_temp = config_GetUserDir( VLC_CACHE_DIR );
322 if( asprintf( &psz_cachedir, "%s" DIR_SEP "cddb", psz_temp ) > 0 ) {
323 cddb_cache_enable( p_cddb );
324 cddb_cache_set_dir( p_cddb, psz_cachedir );
325 free( psz_cachedir );
327 free( psz_temp );
329 cddb_set_timeout( p_cddb, 10 );
331 /* */
332 cddb_disc_t *p_disc = cddb_disc_new();
333 if( !p_disc )
335 msg_Err( obj, "unable to create CDDB disc structure." );
336 goto error;
339 int64_t i_length = 2000000; /* PreGap */
340 for( int i = 0; i < i_titles; i++ )
342 cddb_track_t *t = cddb_track_new();
343 cddb_track_set_frame_offset( t, p_sectors[i] + 150 ); /* Pregap offset */
345 cddb_disc_add_track( p_disc, t );
346 const int64_t i_size = ( p_sectors[i+1] - p_sectors[i] ) *
347 (int64_t)CDDA_DATA_SIZE;
348 i_length += INT64_C(1000000) * i_size / 44100 / 4 ;
350 msg_Dbg( obj, "Track %i offset: %i", i, p_sectors[i] + 150 );
353 msg_Dbg( obj, "Total length: %i", (int)(i_length/1000000) );
354 cddb_disc_set_length( p_disc, (int)(i_length/1000000) );
356 if( !cddb_disc_calc_discid( p_disc ) )
358 msg_Err( obj, "CDDB disc ID calculation failed" );
359 goto error;
362 const int i_matches = cddb_query( p_cddb, p_disc );
363 if( i_matches < 0 )
365 msg_Warn( obj, "CDDB error: %s", cddb_error_str(errno) );
366 goto error;
368 else if( i_matches == 0 )
370 msg_Dbg( obj, "Couldn't find any matches in CDDB." );
371 goto error;
373 else if( i_matches > 1 )
374 msg_Warn( obj, "found %d matches in CDDB. Using first one.", i_matches );
376 cddb_read( p_cddb, p_disc );
378 cddb_destroy( p_cddb);
379 return p_disc;
381 error:
382 if( p_disc )
383 cddb_disc_destroy( p_disc );
384 cddb_destroy( p_cddb );
385 return NULL;
387 #endif /* HAVE_LIBCDDB */
389 static void AccessGetMeta(stream_t *access, vlc_meta_t *meta)
391 access_sys_t *sys = access->p_sys;
393 vlc_meta_SetTitle(meta, "Audio CD");
395 /* Retrieve CD-TEXT information */
396 if (sys->cdtextc > 0 && sys->cdtextv[0] != NULL)
397 vlc_meta_Merge(meta, sys->cdtextv[0]);
399 /* Return true if the given string is not NULL and not empty */
400 #define NONEMPTY( psz ) ( (psz) && *(psz) )
401 /* If the given string is NULL or empty, fill it by the return value of 'code' */
402 #define ON_EMPTY( psz, code ) do { if( !NONEMPTY( psz) ) { (psz) = code; } } while(0)
404 /* Retrieve CDDB information (preferred over CD-TEXT) */
405 #ifdef HAVE_LIBCDDB
406 if (sys->cddb != NULL)
408 const char *str = cddb_disc_get_title(sys->cddb);
409 if (NONEMPTY(str))
410 vlc_meta_SetTitle(meta, str);
412 str = cddb_disc_get_genre(sys->cddb);
413 if (NONEMPTY(str))
414 vlc_meta_SetGenre(meta, str);
416 const unsigned year = cddb_disc_get_year(sys->cddb);
417 if (year != 0)
419 char yearbuf[5];
421 snprintf(yearbuf, sizeof (yearbuf), "%u", year);
422 vlc_meta_SetDate(meta, yearbuf);
425 /* Set artist only if identical across tracks */
426 str = cddb_disc_get_artist(sys->cddb);
427 if (NONEMPTY(str))
429 for (int i = 0; i < sys->titles; i++)
431 cddb_track_t *t = cddb_disc_get_track(sys->cddb, i);
432 if (t == NULL)
433 continue;
435 const char *track_artist = cddb_track_get_artist(t);
436 if (NONEMPTY(track_artist))
438 if (str == NULL)
439 str = track_artist;
440 else
441 if (strcmp(str, track_artist))
443 str = NULL;
444 break;
450 #endif
453 static int ReadDir(stream_t *access, input_item_node_t *node)
455 access_sys_t *sys = access->p_sys;
457 /* Build title table */
458 for (int i = 0; i < sys->titles; i++)
460 msg_Dbg(access, "track[%d] start=%d", i, sys->p_sectors[i]);
462 /* Initial/default name */
463 char *name;
465 if (unlikely(asprintf(&name, _("Audio CD - Track %02i"), i + 1) == -1))
466 name = NULL;
468 /* Create playlist items */
469 const mtime_t duration =
470 (mtime_t)(sys->p_sectors[i + 1] - sys->p_sectors[i])
471 * CDDA_DATA_SIZE * CLOCK_FREQ / 44100 / 2 / 2;
473 input_item_t *item = input_item_NewDisc(access->psz_url,
474 (name != NULL) ? name :
475 access->psz_url, duration);
476 free(name);
478 if (unlikely(item == NULL))
479 continue;
481 char *opt;
482 if (likely(asprintf(&opt, "cdda-track=%i", i + 1) != -1))
484 input_item_AddOption(item, opt, VLC_INPUT_OPTION_TRUSTED);
485 free(opt);
488 if (likely(asprintf(&opt, "cdda-first-sector=%i",
489 sys->p_sectors[i]) != -1))
491 input_item_AddOption(item, opt, VLC_INPUT_OPTION_TRUSTED);
492 free(opt);
495 if (likely(asprintf(&opt, "cdda-last-sector=%i",
496 sys->p_sectors[i + 1]) != -1))
498 input_item_AddOption(item, opt, VLC_INPUT_OPTION_TRUSTED);
499 free(opt);
502 const char *title = NULL;
503 const char *artist = NULL;
504 const char *album = NULL;
505 const char *genre = NULL;
506 const char *description = NULL;
507 int year = 0;
509 #ifdef HAVE_LIBCDDB
510 if (sys->cddb != NULL)
512 cddb_track_t *t = cddb_disc_get_track(sys->cddb, i);
513 if (t != NULL)
515 title = cddb_track_get_title(t);
516 artist = cddb_track_get_artist(t);
519 ON_EMPTY(artist, cddb_disc_get_artist(sys->cddb));
520 album = cddb_disc_get_title(sys->cddb);
521 genre = cddb_disc_get_genre(sys->cddb);
522 year = cddb_disc_get_year(sys->cddb);
524 #endif
525 const vlc_meta_t *m;
527 if (sys->cdtextc > 0 && (m = sys->cdtextv[0]) != NULL)
529 ON_EMPTY(artist, vlc_meta_Get(m, vlc_meta_Artist));
530 ON_EMPTY(album, vlc_meta_Get(m, vlc_meta_Album));
531 ON_EMPTY(genre, vlc_meta_Get(m, vlc_meta_Genre));
532 description = vlc_meta_Get(m, vlc_meta_Description);
535 if (i + 1 < sys->cdtextc && (m = sys->cdtextv[i + 1]) != NULL)
537 ON_EMPTY(title, vlc_meta_Get(m, vlc_meta_Title));
538 ON_EMPTY(artist, vlc_meta_Get(m, vlc_meta_Artist));
539 ON_EMPTY(genre, vlc_meta_Get(m, vlc_meta_Genre));
540 ON_EMPTY(description, vlc_meta_Get(m, vlc_meta_Description));
543 if (NONEMPTY(title))
545 input_item_SetName(item, title);
546 input_item_SetTitle(item, title);
549 if (NONEMPTY(artist))
550 input_item_SetArtist(item, artist);
552 if (NONEMPTY(genre))
553 input_item_SetGenre(item, genre);
555 if (NONEMPTY(description))
556 input_item_SetDescription(item, description);
558 if (NONEMPTY(album))
559 input_item_SetAlbum(item, album);
561 if (year != 0)
563 char yearbuf[5];
565 snprintf(yearbuf, sizeof (yearbuf), "%u", year);
566 input_item_SetDate(item, yearbuf);
569 char num[4];
570 snprintf(num, sizeof (num), "%d", i + 1);
571 input_item_SetTrackNum(item, num);
573 input_item_node_AppendItem(node, item);
574 input_item_Release(item);
576 #undef ON_EMPTY
577 #undef NONEMPTY
578 return VLC_SUCCESS;
581 static int AccessControl(stream_t *access, int query, va_list args)
583 if (query == STREAM_GET_META)
585 AccessGetMeta(access, va_arg(args, vlc_meta_t *));
586 return VLC_SUCCESS;
588 return access_vaDirectoryControlHelper(access, query, args);
591 static int AccessOpen(vlc_object_t *obj, vcddev_t *dev)
593 stream_t *access = (stream_t *)obj;
594 /* Only whole discs here */
595 access_sys_t *sys = vlc_obj_malloc(obj, sizeof (*sys));
596 if (unlikely(sys == NULL))
598 ioctl_Close(obj, dev);
599 return VLC_ENOMEM;
602 sys->vcddev = dev;
603 sys->p_sectors = NULL;
605 sys->titles = ioctl_GetTracksMap(obj, dev, &sys->p_sectors);
606 if (sys->titles < 0)
608 msg_Err(obj, "cannot count tracks");
609 goto error;
612 if (sys->titles == 0)
614 msg_Err(obj, "no audio tracks found");
615 goto error;
618 #ifdef HAVE_LIBCDDB
619 msg_Dbg(obj, "retrieving metadata with CDDB");
621 sys->cddb = GetCDDBInfo(obj, sys->titles, sys->p_sectors);
622 if (sys->cddb != NULL)
623 msg_Dbg(obj, "disc ID: 0x%08x", cddb_disc_get_discid(sys->cddb));
624 else
625 msg_Dbg(obj, "CDDB failure");
626 #endif
628 if (ioctl_GetCdText(obj, dev, &sys->cdtextv, &sys->cdtextc))
630 msg_Dbg(obj, "CD-TEXT information missing");
631 sys->cdtextv = NULL;
632 sys->cdtextc = 0;
635 access->p_sys = sys;
636 access->pf_read = NULL;
637 access->pf_block = NULL;
638 access->pf_readdir = ReadDir;
639 access->pf_seek = NULL;
640 access->pf_control = AccessControl;
641 return VLC_SUCCESS;
643 error:
644 free(sys->p_sectors);
645 ioctl_Close(obj, dev);
646 return VLC_EGENERIC;
649 static void AccessClose(access_sys_t *sys)
651 for (int i = 0; i < sys->cdtextc; i++)
653 vlc_meta_t *meta = sys->cdtextv[i];
654 if (meta != NULL)
655 vlc_meta_Delete(meta);
657 free(sys->cdtextv);
659 #ifdef HAVE_LIBCDDB
660 if (sys->cddb != NULL)
661 cddb_disc_destroy(sys->cddb);
662 #endif
664 free(sys->p_sectors);
667 static int Open(vlc_object_t *obj)
669 stream_t *stream = (stream_t *)obj;
670 unsigned track;
672 vcddev_t *dev = DiscOpen(obj, stream->psz_location, stream->psz_filepath,
673 &track);
674 if (dev == NULL)
675 return VLC_EGENERIC;
677 if (track == 0)
678 return AccessOpen(obj, dev);
679 else
680 return DemuxOpen(obj, dev, track);
683 static void Close(vlc_object_t *obj)
685 stream_t *stream = (stream_t *)obj;
686 void *sys = stream->p_sys;
688 if (stream->pf_readdir != NULL)
689 AccessClose(sys);
691 static_assert(offsetof(demux_sys_t, vcddev) == 0, "Invalid cast");
692 static_assert(offsetof(access_sys_t, vcddev) == 0, "Invalid cast");
693 ioctl_Close(obj, *(vcddev_t **)sys);
696 /*****************************************************************************
697 * Module descriptior
698 *****************************************************************************/
699 #define CDAUDIO_DEV_TEXT N_("Audio CD device")
700 #if defined( _WIN32 ) || defined( __OS2__ )
701 # define CDAUDIO_DEV_LONGTEXT N_( \
702 "This is the default Audio CD drive (or file) to use. Don't forget the " \
703 "colon after the drive letter (e.g. D:)")
704 # define CD_DEVICE "D:"
705 #else
706 # define CDAUDIO_DEV_LONGTEXT N_( \
707 "This is the default Audio CD device to use." )
708 # if defined(__OpenBSD__)
709 # define CD_DEVICE "/dev/cd0c"
710 # elif defined(__linux__)
711 # define CD_DEVICE "/dev/sr0"
712 # else
713 # define CD_DEVICE "/dev/cdrom"
714 # endif
715 #endif
717 vlc_module_begin ()
718 set_shortname( N_("Audio CD") )
719 set_description( N_("Audio CD input") )
720 set_capability( "access", 0 )
721 set_category( CAT_INPUT )
722 set_subcategory( SUBCAT_INPUT_ACCESS )
723 set_callbacks(Open, Close)
725 add_loadfile("cd-audio", CD_DEVICE, CDAUDIO_DEV_TEXT, CDAUDIO_DEV_LONGTEXT)
727 add_usage_hint( N_("[cdda:][device][@[track]]") )
728 add_integer( "cdda-track", 0 , NULL, NULL, true )
729 change_volatile ()
730 add_integer( "cdda-first-sector", -1, NULL, NULL, true )
731 change_volatile ()
732 add_integer( "cdda-last-sector", -1, NULL, NULL, true )
733 change_volatile ()
735 #ifdef HAVE_LIBCDDB
736 add_string( "cddb-server", "freedb.videolan.org", N_( "CDDB Server" ),
737 N_( "Address of the CDDB server to use." ), true )
738 add_integer( "cddb-port", 80, N_( "CDDB port" ),
739 N_( "CDDB Server port to use." ), true )
740 change_integer_range( 1, 65535 )
741 #endif
743 add_shortcut( "cdda", "cddasimple" )
744 vlc_module_end ()