1 /*****************************************************************************
2 * vcdplayer.c : VCD input module for vlc
3 * using libcdio, libvcd and libvcdinfo
4 *****************************************************************************
5 * Copyright (C) 2003, 2004 Rocky Bernstein <rocky@panix.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
21 *****************************************************************************/
24 This contains more of the vlc-independent parts that might be used
25 in any VCD input module for a media player. However at present there
26 are vlc-specific structures. See also vcdplayer.c of the xine plugin.
28 /*****************************************************************************
30 *****************************************************************************/
33 #include <vlc/input.h>
37 #include "vcdplayer.h"
42 #include <cdio/cdio.h>
43 #include <cdio/util.h>
44 #include <libvcd/info.h>
47 #define sleep(A) Sleep((A)*1000)
51 Return VLC_TRUE if playback control (PBC) is on
54 vcdplayer_pbc_is_on( const vcdplayer_t *p_vcd )
56 return VCDINFO_INVALID_ENTRY != p_vcd->i_lid;
59 /* Given an itemid, return the size for the object (via information
60 previously stored when opening the vcd). */
62 vcdplayer_get_item_size(access_t * p_access, vcdinfo_itemid_t itemid)
64 vcdplayer_t *p_vcd= (vcdplayer_t *)p_access->p_sys;
66 switch (itemid.type) {
67 case VCDINFO_ITEM_TYPE_ENTRY:
68 return p_vcd->entry[itemid.num].size;
70 case VCDINFO_ITEM_TYPE_SEGMENT:
71 return p_vcd->segment[itemid.num].size;
73 case VCDINFO_ITEM_TYPE_TRACK:
74 return p_vcd->track[itemid.num-1].size;
76 case VCDINFO_ITEM_TYPE_LID:
77 /* Play list number (LID) */
80 case VCDINFO_ITEM_TYPE_NOTFOUND:
81 case VCDINFO_ITEM_TYPE_SPAREID2:
83 LOG_ERR("%s %d\n", _("bad item type"), itemid.type);
89 vcdplayer_update_entry( access_t * p_access, uint16_t ofs,
90 uint16_t *entry, const char *label)
92 vcdplayer_t *p_vcd= (vcdplayer_t *)p_access->p_sys;
94 if ( ofs == VCDINFO_INVALID_OFFSET ) {
95 *entry = VCDINFO_INVALID_ENTRY;
97 vcdinfo_offset_t *off = vcdinfo_get_offset_t(p_vcd->vcd, ofs);
100 dbg_print(INPUT_DBG_PBC, "%s: LID %d\n", label, off->lid);
102 *entry = VCDINFO_INVALID_ENTRY;
106 /* Handles navigation when NOT in PBC reaching the end of a play item.
108 The navigations rules here may be sort of made up, but the intent
109 is to do something that's probably right or helpful.
111 return VLC_TRUE if the caller should return.
113 vcdplayer_read_status_t
114 vcdplayer_non_pbc_nav ( access_t * p_access )
116 vcdplayer_t *p_vcd= (vcdplayer_t *)p_access->p_sys;
118 /* Not in playback control. Do we advance automatically or stop? */
119 switch (p_vcd->play_item.type) {
120 case VCDINFO_ITEM_TYPE_TRACK:
121 case VCDINFO_ITEM_TYPE_ENTRY: {
123 dbg_print( INPUT_DBG_LSN, "new track %d, lsn %d", p_vcd->i_track+1,
124 vcdinfo_get_track_lsn(p_vcd->vcd, p_vcd->i_track+1) );
128 case VCDINFO_ITEM_TYPE_SPAREID2:
129 dbg_print( (INPUT_DBG_STILL|INPUT_DBG_LSN),
134 return READ_STILL_FRAME ;
137 case VCDINFO_ITEM_TYPE_NOTFOUND:
138 LOG_ERR ("NOTFOUND outside PBC -- not supposed to happen");
140 case VCDINFO_ITEM_TYPE_LID:
141 LOG_ERR ("LID outside PBC -- not supposed to happen");
143 case VCDINFO_ITEM_TYPE_SEGMENT:
144 /* Hack: Just go back and do still again */
148 dbg_print( (INPUT_DBG_STILL|INPUT_DBG_LSN),
149 "End of Segment - looping" );
150 return READ_STILL_FRAME;
159 Set reading to play an entire track.
162 _vcdplayer_set_track(access_t * p_access, track_t i_track)
164 vcdplayer_t *p_vcd = (vcdplayer_t *)p_access->p_sys;
165 if (i_track < 1 || i_track > p_vcd->i_tracks)
168 vcdinfo_obj_t *p_obj = p_vcd->vcd;
169 vcdinfo_itemid_t itemid;
171 itemid.num = i_track;
172 itemid.type = VCDINFO_ITEM_TYPE_TRACK;
174 p_vcd->i_lsn = vcdinfo_get_track_lsn(p_obj, i_track);
175 p_vcd->play_item = itemid;
176 p_vcd->i_track = i_track;
177 p_vcd->track_lsn = p_vcd->i_lsn;
179 vcdplayer_set_origin(p_access);
181 dbg_print(INPUT_DBG_LSN, "LSN: %u\n", p_vcd->i_lsn);
186 Set reading to play an entry
189 _vcdplayer_set_entry(access_t * p_access, unsigned int num)
191 vcdplayer_t *p_vcd = (vcdplayer_t *)p_access->p_sys;
192 vcdinfo_obj_t *p_obj = p_vcd->vcd;
193 unsigned int num_entries = vcdinfo_get_num_entries(p_obj);
195 if (num >= num_entries) {
196 LOG_ERR("%s %d\n", _("bad entry number"), num);
199 vcdinfo_itemid_t itemid;
202 itemid.type = VCDINFO_ITEM_TYPE_ENTRY;
204 p_vcd->i_lsn = vcdinfo_get_entry_lsn(p_obj, num);
205 p_vcd->play_item = itemid;
206 p_vcd->i_track = vcdinfo_get_track(p_obj, num);
207 p_vcd->track_lsn = vcdinfo_get_track_lsn(p_obj, p_vcd->i_track);
208 p_vcd->track_end_lsn = p_vcd->track_lsn +
209 p_vcd->track[p_vcd->i_track-1].size;
211 vcdplayer_set_origin(p_access);
213 dbg_print(INPUT_DBG_LSN, "LSN: %u, track_end LSN: %u\n",
214 p_vcd->i_lsn, p_vcd->track_end_lsn);
219 Set reading to play an segment (e.g. still frame)
222 _vcdplayer_set_segment(access_t * p_access, unsigned int num)
224 vcdplayer_t *p_vcd = (vcdplayer_t *)p_access->p_sys;
225 vcdinfo_obj_t *p_obj = p_vcd->vcd;
226 segnum_t num_segs = vcdinfo_get_num_segments(p_obj);
228 if (num >= num_segs) {
229 LOG_ERR("%s %d\n", _("bad segment number"), num);
232 vcdinfo_itemid_t itemid;
234 p_vcd->i_lsn = vcdinfo_get_seg_lsn(p_obj, num);
237 if (VCDINFO_NULL_LSN==p_vcd->i_lsn) {
239 _("Error in getting current segment number"), num);
244 itemid.type = VCDINFO_ITEM_TYPE_SEGMENT;
245 p_vcd->play_item = itemid;
247 vcdplayer_set_origin(p_access);
249 dbg_print(INPUT_DBG_LSN, "LSN: %u\n", p_vcd->i_lsn);
252 #endif /* FINISHED */
255 Set's start origin and size for subsequent seeks.
256 input: p_vcd->i_lsn, p_vcd->play_item
257 changed: p_vcd->origin_lsn, p_vcd->end_lsn
260 vcdplayer_set_origin(access_t *p_access)
262 vcdplayer_t *p_vcd = (vcdplayer_t *)p_access->p_sys;
263 size_t i_size= vcdplayer_get_item_size(p_access, p_vcd->play_item);
265 p_vcd->end_lsn = p_vcd->i_lsn + i_size;
266 p_vcd->origin_lsn = p_vcd->i_lsn;
268 dbg_print((INPUT_DBG_CALL|INPUT_DBG_LSN), "end LSN: %u\n", p_vcd->end_lsn);
271 /* Handles PBC navigation when reaching the end of a play item. */
272 vcdplayer_read_status_t
273 vcdplayer_pbc_nav ( access_t * p_access )
275 vcdplayer_t *p_vcd= (vcdplayer_t *)p_access->p_sys;
277 /* We are in playback control. */
278 vcdinfo_itemid_t itemid;
280 /* The end of an entry is really the end of the associated
281 sequence (or track). */
283 if ( (VCDINFO_ITEM_TYPE_ENTRY == p_vcd->play_item.type) &&
284 (p_vcd->i_lsn < p_vcd->end_lsn) ) {
285 /* Set up to just continue to the next entry */
286 p_vcd->play_item.num++;
287 dbg_print( (INPUT_DBG_LSN|INPUT_DBG_PBC),
288 "continuing into next entry: %u", p_vcd->play_item.num);
289 VCDPlay( p_access, p_vcd->play_item );
290 /* p_vcd->update_title(); */
294 switch (p_vcd->pxd.descriptor_type) {
295 case PSD_TYPE_END_LIST:
298 case PSD_TYPE_PLAY_LIST: {
299 int wait_time = vcdinf_get_wait_time(p_vcd->pxd.pld);
301 dbg_print(INPUT_DBG_PBC, "playlist wait_time: %d", wait_time);
303 if (vcdplayer_inc_play_item(p_access))
306 /* Handle any wait time given. */
308 if (p_vcd->in_still) {
309 vcdIntfStillTime( p_vcd->p_intf, wait_time );
310 return READ_STILL_FRAME;
314 vcdplayer_update_entry( p_access,
315 vcdinf_pld_get_next_offset(p_vcd->pxd.pld),
316 &itemid.num, "next" );
317 itemid.type = VCDINFO_ITEM_TYPE_LID;
318 VCDPlay( p_access, itemid );
321 case PSD_TYPE_SELECTION_LIST: /* Selection List (+Ext. for SVCD) */
322 case PSD_TYPE_EXT_SELECTION_LIST: /* Extended Selection List (VCD2.0) */
324 int wait_time = vcdinf_get_timeout_time(p_vcd->pxd.psd);
325 uint16_t timeout_offs = vcdinf_get_timeout_offset(p_vcd->pxd.psd);
326 uint16_t max_loop = vcdinf_get_loop_count(p_vcd->pxd.psd);
327 vcdinfo_offset_t *offset_timeout_LID =
328 vcdinfo_get_offset_t(p_vcd->vcd, timeout_offs);
330 dbg_print(INPUT_DBG_PBC, "wait_time: %d, looped: %d, max_loop %d",
331 wait_time, p_vcd->loop_count, max_loop);
333 /* Handle any wait time given */
335 if (p_vcd->in_still) {
336 vcdIntfStillTime( p_vcd->p_intf, wait_time );
337 return READ_STILL_FRAME;
341 /* Handle any looping given. */
342 if ( max_loop == 0 || p_vcd->loop_count < max_loop ) {
344 if (p_vcd->loop_count == 0x7f) p_vcd->loop_count = 0;
345 VCDSeek( p_access, 0 );
346 /* if (p_vcd->in_still) p_vcd->force_redisplay();*/
350 /* Looping finished and wait finished. Move to timeout
351 entry or next entry, or handle still. */
353 if (NULL != offset_timeout_LID) {
354 /* Handle timeout_LID */
355 itemid.num = offset_timeout_LID->lid;
356 itemid.type = VCDINFO_ITEM_TYPE_LID;
357 dbg_print(INPUT_DBG_PBC, "timeout to: %d", itemid.num);
358 VCDPlay( p_access, itemid );
361 int num_selections = vcdinf_get_num_selections(p_vcd->pxd.psd);
362 if (num_selections > 0) {
363 /* Pick a random selection. */
364 unsigned int bsn=vcdinf_get_bsn(p_vcd->pxd.psd);
365 int rand_selection=bsn +
366 (int) ((num_selections+0.0)*rand()/(RAND_MAX+1.0));
367 lid_t rand_lid=vcdinfo_selection_get_lid (p_vcd->vcd,
370 itemid.num = rand_lid;
371 itemid.type = VCDINFO_ITEM_TYPE_LID;
372 dbg_print(INPUT_DBG_PBC, "random selection %d, lid: %d",
373 rand_selection - bsn, rand_lid);
374 VCDPlay( p_access, itemid );
376 } else if (p_vcd->in_still) {
377 /* Hack: Just go back and do still again */
379 return READ_STILL_FRAME;
384 case VCDINFO_ITEM_TYPE_NOTFOUND:
385 LOG_ERR( "NOTFOUND in PBC -- not supposed to happen" );
387 case VCDINFO_ITEM_TYPE_SPAREID2:
388 LOG_ERR( "SPAREID2 in PBC -- not supposed to happen" );
390 case VCDINFO_ITEM_TYPE_LID:
391 LOG_ERR( "LID in PBC -- not supposed to happen" );
397 /* FIXME: Should handle autowait ... */
403 Get the next play-item in the list given in the LIDs. Note play-item
404 here refers to list of play-items for a single LID It shouldn't be
405 confused with a user's list of favorite things to play or the
406 "next" field of a LID which moves us to a different LID.
409 vcdplayer_inc_play_item( access_t *p_access )
411 vcdplayer_t *p_vcd= (vcdplayer_t *)p_access->p_sys;
415 dbg_print(INPUT_DBG_CALL, "called pli: %d", p_vcd->pdi);
417 if ( NULL == p_vcd || NULL == p_vcd->pxd.pld ) return VLC_FALSE;
419 noi = vcdinf_pld_get_noi(p_vcd->pxd.pld);
421 if ( noi <= 0 ) return VLC_FALSE;
423 /* Handle delays like autowait or wait here? */
427 if ( p_vcd->pdi < 0 || p_vcd->pdi >= noi ) return VLC_FALSE;
430 uint16_t trans_itemid_num=vcdinf_pld_get_play_item(p_vcd->pxd.pld,
432 vcdinfo_itemid_t trans_itemid;
434 if (VCDINFO_INVALID_ITEMID == trans_itemid_num) return VLC_FALSE;
436 vcdinfo_classify_itemid(trans_itemid_num, &trans_itemid);
437 dbg_print(INPUT_DBG_PBC, " play-item[%d]: %s",
438 p_vcd->pdi, vcdinfo_pin2str (trans_itemid_num));
439 return VLC_SUCCESS == VCDPlay( p_access, trans_itemid );
444 Play item assocated with the "default" selection.
446 Return VLC_FALSE if there was some problem.
449 vcdplayer_play_default( access_t * p_access )
451 vcdplayer_t *p_vcd= (vcdplayer_t *)p_access->p_sys;
453 vcdinfo_itemid_t itemid;
456 dbg_print( (INPUT_DBG_CALL|INPUT_DBG_PBC),
462 dbg_print( (INPUT_DBG_CALL|INPUT_DBG_PBC),
463 "current: %d" , p_vcd->play_item.num);
465 itemid.type = p_vcd->play_item.type;
467 if (vcdplayer_pbc_is_on(p_vcd)) {
469 #if defined(LIBVCD_VERSION)
470 lid_t lid=vcdinfo_get_multi_default_lid(p_vcd->vcd, p_vcd->i_lid,
473 if (VCDINFO_INVALID_LID != lid) {
475 itemid.type = VCDINFO_ITEM_TYPE_LID;
476 dbg_print(INPUT_DBG_PBC, "DEFAULT to %d\n", itemid.num);
478 dbg_print(INPUT_DBG_PBC, "no DEFAULT for LID %d\n", p_vcd->i_lid);
482 vcdinfo_lid_get_pxd(p_vcd->vcd, &(p_vcd->pxd), p_vcd->i_lid);
484 switch (p_vcd->pxd.descriptor_type) {
485 case PSD_TYPE_SELECTION_LIST:
486 case PSD_TYPE_EXT_SELECTION_LIST:
487 if (p_vcd->pxd.psd == NULL) return VLC_FALSE;
488 vcdplayer_update_entry( p_access,
489 vcdinfo_get_default_offset(p_vcd->vcd,
491 &itemid.num, "default");
494 case PSD_TYPE_PLAY_LIST:
495 case PSD_TYPE_END_LIST:
496 case PSD_TYPE_COMMAND_LIST:
497 LOG_WARN( "There is no PBC 'default' selection here" );
500 #endif /* LIBVCD_VERSION (< 0.7.21) */
505 /* PBC is not on. "default" selection beginning of current
508 p_vcd->play_item.num = p_vcd->play_item.num;
512 /** ??? p_vcd->update_title(); ***/
513 return VLC_SUCCESS == VCDPlay( p_access, itemid );
518 Play item assocated with the "next" selection.
520 Return VLC_FALSE if there was some problem.
523 vcdplayer_play_next( access_t * p_access )
525 vcdplayer_t *p_vcd= (vcdplayer_t *)p_access->p_sys;
527 vcdinfo_obj_t *p_obj;
528 vcdinfo_itemid_t itemid;
530 if (!p_vcd) return VLC_FALSE;
532 dbg_print( (INPUT_DBG_CALL|INPUT_DBG_PBC),
533 "current: %d" , p_vcd->play_item.num);
537 itemid.type = p_vcd->play_item.type;
539 if (vcdplayer_pbc_is_on(p_vcd)) {
541 vcdinfo_lid_get_pxd(p_obj, &(p_vcd->pxd), p_vcd->i_lid);
543 switch (p_vcd->pxd.descriptor_type) {
544 case PSD_TYPE_SELECTION_LIST:
545 case PSD_TYPE_EXT_SELECTION_LIST:
546 if (p_vcd->pxd.psd == NULL) return VLC_FALSE;
547 vcdplayer_update_entry( p_access,
548 vcdinf_psd_get_next_offset(p_vcd->pxd.psd),
549 &itemid.num, "next");
550 itemid.type = VCDINFO_ITEM_TYPE_LID;
553 case PSD_TYPE_PLAY_LIST:
554 if (p_vcd->pxd.pld == NULL) return VLC_FALSE;
555 vcdplayer_update_entry( p_access,
556 vcdinf_pld_get_next_offset(p_vcd->pxd.pld),
557 &itemid.num, "next");
558 itemid.type = VCDINFO_ITEM_TYPE_LID;
561 case PSD_TYPE_END_LIST:
562 case PSD_TYPE_COMMAND_LIST:
563 LOG_WARN( "There is no PBC 'next' selection here" );
568 /* PBC is not on. "Next" selection is play_item.num+1 if possible. */
572 switch (p_vcd->play_item.type) {
573 case VCDINFO_ITEM_TYPE_ENTRY:
574 case VCDINFO_ITEM_TYPE_SEGMENT:
575 case VCDINFO_ITEM_TYPE_TRACK:
577 switch (p_vcd->play_item.type) {
578 case VCDINFO_ITEM_TYPE_ENTRY:
579 max_entry = p_vcd->i_entries;
581 case VCDINFO_ITEM_TYPE_SEGMENT:
582 max_entry = p_vcd->i_segments;
584 case VCDINFO_ITEM_TYPE_TRACK:
585 max_entry = p_vcd->i_tracks;
587 default: ; /* Handle exceptional cases below */
590 if (p_vcd->play_item.num+1 < max_entry) {
591 itemid.num = p_vcd->play_item.num+1;
593 LOG_WARN( "At the end - non-PBC 'next' not possible here" );
599 case VCDINFO_ITEM_TYPE_LID:
601 /* Should have handled above. */
602 LOG_WARN( "Internal inconsistency - should not have gotten here." );
610 /** ??? p_vcd->update_title(); ***/
611 return VLC_SUCCESS == VCDPlay( p_access, itemid );
616 Play item assocated with the "prev" selection.
618 Return VLC_FALSE if there was some problem.
621 vcdplayer_play_prev( access_t * p_access )
623 vcdplayer_t *p_vcd= (vcdplayer_t *)p_access->p_sys;
624 vcdinfo_obj_t *p_obj = p_vcd->vcd;
625 vcdinfo_itemid_t itemid;
627 dbg_print( (INPUT_DBG_CALL|INPUT_DBG_PBC),
628 "current: %d" , p_vcd->play_item.num);
630 itemid.type = p_vcd->play_item.type;
632 if (vcdplayer_pbc_is_on(p_vcd)) {
634 vcdinfo_lid_get_pxd(p_obj, &(p_vcd->pxd), p_vcd->i_lid);
636 switch (p_vcd->pxd.descriptor_type) {
637 case PSD_TYPE_SELECTION_LIST:
638 case PSD_TYPE_EXT_SELECTION_LIST:
639 if (p_vcd->pxd.psd == NULL) return VLC_FALSE;
640 vcdplayer_update_entry( p_access,
641 vcdinf_psd_get_prev_offset(p_vcd->pxd.psd),
642 &itemid.num, "prev");
643 itemid.type = VCDINFO_ITEM_TYPE_LID;
646 case PSD_TYPE_PLAY_LIST:
647 if (p_vcd->pxd.pld == NULL) return VLC_FALSE;
648 vcdplayer_update_entry( p_access,
649 vcdinf_pld_get_prev_offset(p_vcd->pxd.pld),
650 &itemid.num, "prev");
651 itemid.type = VCDINFO_ITEM_TYPE_LID;
654 case PSD_TYPE_END_LIST:
655 case PSD_TYPE_COMMAND_LIST:
656 LOG_WARN( "There is no PBC 'prev' selection here" );
661 /* PBC is not on. "Prev" selection is play_item.num-1 if possible. */
663 int min_entry = (VCDINFO_ITEM_TYPE_ENTRY == p_vcd->play_item.type)
666 if (p_vcd->play_item.num > min_entry) {
667 itemid.num = p_vcd->play_item.num-1;
669 LOG_WARN( "At the beginning - non-PBC 'prev' not possible here" );
675 /** ??? p_vcd->update_title(); ***/
676 return VLC_SUCCESS == VCDPlay( p_access, itemid );
681 Play item assocated with the "return" selection.
683 Return VLC_FALSE if there was some problem.
686 vcdplayer_play_return( access_t * p_access )
688 vcdplayer_t *p_vcd= (vcdplayer_t *)p_access->p_sys;
689 vcdinfo_obj_t *p_obj = p_vcd->vcd;
690 vcdinfo_itemid_t itemid;
692 dbg_print( (INPUT_DBG_CALL|INPUT_DBG_PBC),
693 "current: %d" , p_vcd->play_item.num);
695 itemid.type = p_vcd->play_item.type;
697 if (vcdplayer_pbc_is_on(p_vcd)) {
699 vcdinfo_lid_get_pxd(p_obj, &(p_vcd->pxd), p_vcd->i_lid);
701 switch (p_vcd->pxd.descriptor_type) {
702 case PSD_TYPE_SELECTION_LIST:
703 case PSD_TYPE_EXT_SELECTION_LIST:
704 if (p_vcd->pxd.psd == NULL) return VLC_FALSE;
705 vcdplayer_update_entry( p_access,
706 vcdinf_psd_get_return_offset(p_vcd->pxd.psd),
707 &itemid.num, "return");
708 itemid.type = VCDINFO_ITEM_TYPE_LID;
711 case PSD_TYPE_PLAY_LIST:
712 if (p_vcd->pxd.pld == NULL) return VLC_FALSE;
713 vcdplayer_update_entry( p_access,
714 vcdinf_pld_get_return_offset(p_vcd->pxd.pld),
715 &itemid.num, "return");
716 itemid.type = VCDINFO_ITEM_TYPE_LID;
719 case PSD_TYPE_END_LIST:
720 case PSD_TYPE_COMMAND_LIST:
721 LOG_WARN( "There is no PBC 'return' selection here" );
726 /* PBC is not on. "Return" selection is min_entry if possible. */
728 p_vcd->play_item.num = (VCDINFO_ITEM_TYPE_ENTRY == p_vcd->play_item.type)
733 /** ??? p_vcd->update_title(); ***/
734 return VLC_SUCCESS == VCDPlay( p_access, itemid );