git.sesse.net Git - vlc/blob - modules/access/vcdx/vcdplayer.h

   1 /*****************************************************************************
   2  * Copyright (C) 2003, 2004 Rocky Bernstein (for VideoLAN)
   3  * $Id$
   4  *
   5  * Authors: Rocky Bernstein <rocky@panix.com>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  20  *****************************************************************************/
  21
  22 /* VCD Player header. More or less media-player independent */
  23
  24 #ifndef _VCDPLAYER_H_
  25 #define _VCDPLAYER_H_
  26
  27 #include <libvcd/info.h>
  28 #include "vlc_meta.h"
  29
  30 #define INPUT_DBG_META        1 /* Meta information */
  31 #define INPUT_DBG_EVENT       2 /* input (keyboard/mouse) events */
  32 #define INPUT_DBG_MRL         4 /* MRL parsing */
  33 #define INPUT_DBG_EXT         8 /* Calls from external routines */
  34 #define INPUT_DBG_CALL       16 /* all calls */
  35 #define INPUT_DBG_LSN        32 /* LSN changes */
  36 #define INPUT_DBG_PBC        64 /* Playback control */
  37 #define INPUT_DBG_CDIO      128 /* Debugging from CDIO */
  38 #define INPUT_DBG_SEEK      256 /* Seeks to set location */
  39 #define INPUT_DBG_SEEK_CUR  512 /* Seeks to find current location */
  40 #define INPUT_DBG_STILL    1024 /* Still-frame */
  41 #define INPUT_DBG_VCDINFO  2048 /* Debugging from VCDINFO */
  42
  43 #define INPUT_DEBUG 1
  44 #if INPUT_DEBUG
  45 #define dbg_print(mask, s, args...) \
  46    if (p_vcd && p_vcd->i_debug & mask) \
  47      msg_Dbg(p_access, "%s: "s, __func__ , ##args)
  48 #else
  49 #define dbg_print(mask, s, args...)
  50 #endif
  51
  52 #define LOG_ERR(args...)  msg_Err( p_access, args )
  53 #define LOG_WARN(args...) msg_Warn( p_access, args )
  54
  55 /*------------------------------------------------------------------
  56   General definitions and structures.
  57 ---------------------------------------------------------------------*/
  58
  59 #define VCDPLAYER_IN_STILL  65535
  60
  61 typedef struct {
  62   lsn_t  start_LSN; /* LSN where play item starts */
  63   size_t size;      /* size in sector units of play item. */
  64 } vcdplayer_play_item_info_t;
  65
  66 /* vcdplayer_read return status */
  67 typedef enum {
  68   READ_BLOCK,
  69   READ_STILL_FRAME,
  70   READ_ERROR,
  71   READ_END,
  72 } vcdplayer_read_status_t;
  73
  74 /*****************************************************************************
  75  * vcdplayer_t: VCD information
  76  *****************************************************************************/
  77 typedef struct thread_vcd_data_s
  78 {
  79   vcdinfo_obj_t *vcd;                   /* CD device descriptor */
  80
  81   /* User-settable options */
  82   unsigned int i_debug;                 /* Debugging mask */
  83   unsigned int i_blocks_per_read;       /* number of blocks per read */
  84
  85   /* Current State: position */
  86   vlc_bool_t   in_still;                /* true if in still */
  87   int          i_lid;                   /* LID that play item is in. Implies
  88                                            PBC is on. VCDPLAYER_BAD_ENTRY if
  89                                            not none or not in PBC */
  90   PsdListDescriptor_t pxd;              /* If PBC is on, the relevant
  91                                             PSD/PLD */
  92   int          pdi;                     /* current pld index of pxd. -1 if
  93                                            no index*/
  94   vcdinfo_itemid_t play_item;           /* play-item, VCDPLAYER_BAD_ENTRY
  95                                            if none */
  96   vcdinfo_itemid_t loop_item;           /* Where do we loop back to?
  97                                            Meaningful only in a selection
  98                                            list */
  99   int          loop_count;              /* # of times play-item has been
 100                                            played. Meaningful only in a
 101                                            selection list.              */
 102   track_t      i_track;                 /* Current track number */
 103   lsn_t        i_lsn;                   /* Current logical sector number */
 104   lsn_t        end_lsn;                 /* LSN of end of current
 105                                            entry/segment/track. */
 106   lsn_t        origin_lsn;              /* LSN of start of seek/slider */
 107   lsn_t        track_lsn;               /* LSN of start track origin of track
 108                                            we are in. */
 109   lsn_t        track_end_lsn;           /* LSN of end of current track (if
 110                                            entry). */
 111   lsn_t *      p_entries;               /* Entry points */
 112   lsn_t *      p_segments;              /* Segments */
 113   vlc_bool_t   b_valid_ep;              /* Valid entry points flag */
 114   vlc_bool_t   b_end_of_track;          /* If the end of track was reached */
 115
 116   /* Information about (S)VCD */
 117   char *       psz_source;              /* (S)VCD drive or image filename */
 118   vlc_bool_t   b_svd;                   /* true if we have SVD info */
 119   vlc_meta_t  *p_meta;
 120   track_t      i_tracks;                /* # of playable MPEG tracks. This is
 121                                            generally one less than the number
 122                                            of CD tracks as the first CD track
 123                                            is an ISO-9660 track and is not
 124                                            playable.
 125                                         */
 126   unsigned int i_segments;              /* # of segments */
 127   unsigned int i_entries;               /* # of entries */
 128   unsigned int i_lids;                  /* # of List IDs */
 129
 130   /* Tracks, segment, and entry information. The number of entries for
 131      each is given by the corresponding num_* field above.  */
 132   vcdplayer_play_item_info_t *track;
 133   vcdplayer_play_item_info_t *segment;
 134   vcdplayer_play_item_info_t *entry;
 135
 136   unsigned int i_titles;                /* # of navigatable titles. */
 137
 138   /*
 139      # tracks + menu for segments + menu for LIDs
 140    */
 141   input_title_t *p_title[CDIO_CD_MAX_TRACKS+2];
 142
 143   /* Probably gets moved into another structure...*/
 144   intf_thread_t *p_intf;
 145   int            i_audio_nb;
 146   int            i_still_time;
 147   vlc_bool_t     b_end_of_cell;
 148   input_thread_t *p_input;
 149
 150 } vcdplayer_t;
 151
 152 /*!
 153   Get the next play-item in the list given in the LIDs. Note play-item
 154   here refers to list of play-items for a single LID It shouldn't be
 155   confused with a user's list of favorite things to play or the
 156   "next" field of a LID which moves us to a different LID.
 157  */
 158 vlc_bool_t vcdplayer_inc_play_item( access_t *p_access );
 159
 160 /*!
 161   Return true if playback control (PBC) is on
 162 */
 163 vlc_bool_t vcdplayer_pbc_is_on(const vcdplayer_t *p_this);
 164
 165 /*!
 166   Play item assocated with the "default" selection.
 167
 168   Return false if there was some problem.
 169 */
 170 vlc_bool_t vcdplayer_play_default( access_t * p_access );
 171
 172 /*!
 173   Play item assocated with the "next" selection.
 174
 175   Return false if there was some problem.
 176 */
 177 vlc_bool_t vcdplayer_play_next( access_t * p_access );
 178
 179 /*!
 180   Play item assocated with the "prev" selection.
 181
 182   Return false if there was some problem.
 183 */
 184 vlc_bool_t vcdplayer_play_prev( access_t * p_access );
 185
 186 /*!
 187   Play item assocated with the "return" selection.
 188
 189   Return false if there was some problem.
 190 */
 191 vlc_bool_t
 192 vcdplayer_play_return( access_t * p_access );
 193
 194 /*
 195    Set's start origin and size for subsequent seeks.
 196    input: p_vcd->i_lsn, p_vcd->play_item
 197    changed: p_vcd->origin_lsn, p_vcd->end_lsn
 198 */
 199 void vcdplayer_set_origin(access_t * p_access);
 200
 201 vcdplayer_read_status_t vcdplayer_pbc_nav     ( access_t * p_access );
 202 vcdplayer_read_status_t vcdplayer_non_pbc_nav ( access_t * p_access );
 203
 204 #endif /* _VCDPLAYER_H_ */
 205 /*
 206  * Local variables:
 207  *  c-file-style: "gnu"
 208  *  tab-width: 8
 209  *  indent-tabs-mode: nil
 210  * End:
 211  */