libmpdvdkit2/dvd_reader.h

   1 #ifndef DVD_READER_H_INCLUDED
   2 #define DVD_READER_H_INCLUDED
   3
   4 /*
   5  * Copyright (C) 2001, 2002 Billy Biggs <vektor@dumbterm.net>,
   6  *                          Håkan Hjort <d95hjort@dtek.chalmers.se>
   7  *
   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 (at
  11  * your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  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-1307  USA
  21  */
  22
  23 #include <sys/types.h>
  24
  25 /**
  26  * The length of one Logical Block of a DVD Video.
  27  */
  28 #define DVD_VIDEO_LB_LEN 2048
  29
  30 /**
  31  * Maximum length of filenames for UDF.
  32  */
  33 #define MAX_UDF_FILE_NAME_LEN 2048
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 typedef struct dvd_reader_s dvd_reader_t;
  40 typedef struct dvd_file_s dvd_file_t;
  41
  42 /**
  43  * dvd = DVDOpen(path);
  44  *
  45  * Opens a block device of a DVD-ROM file, or an image file, or a directory
  46  * name for a mounted DVD or HD copy of a DVD.  Returns 0 if we can't get any
  47  * of those methods to work.
  48  *
  49  * If the given file is a block device, or is the mountpoint for a block
  50  * device, then that device is used for CSS authentication using libdvdcss.
  51  * If no device is available, then no CSS authentication is performed,
  52  * and we hope that the image is decrypted.
  53  *
  54  * If the path given is a directory, then the files in that directory may be in
  55  * any one of these formats:
  56  *
  57  *   path/VIDEO_TS/VTS_01_1.VOB
  58  *   path/video_ts/vts_01_1.vob
  59  *   path/VTS_01_1.VOB
  60  *   path/vts_01_1.vob
  61  */
  62 dvd_reader_t *DVDOpen( const char * );
  63
  64 /**
  65  * DVDClose(dvd);
  66  *
  67  * Closes and cleans up the DVD reader object.  You must close all open files
  68  * before calling this function.
  69  */
  70 void DVDClose( dvd_reader_t * );
  71
  72 /**
  73  * INFO_FILE       : VIDEO_TS.IFO     (manager)
  74  *                   VTS_XX_0.IFO     (title)
  75  *
  76  * INFO_BACKUP_FILE: VIDEO_TS.BUP     (manager)
  77  *                   VTS_XX_0.BUP     (title)
  78  *
  79  * MENU_VOBS       : VIDEO_TS.VOB     (manager)
  80  *                   VTS_XX_0.VOB     (title)
  81  *
  82  * TITLE_VOBS      : VTS_XX_[1-9].VOB (title)
  83  *                   All files in the title set are opened and
  84  *                   read as a single file.
  85  */
  86 typedef enum {
  87     DVD_READ_INFO_FILE,
  88     DVD_READ_INFO_BACKUP_FILE,
  89     DVD_READ_MENU_VOBS,
  90     DVD_READ_TITLE_VOBS
  91 } dvd_read_domain_t;
  92
  93 /**
  94  * dvd_file = DVDOpenFile(dvd, titlenum, domain);
  95  *
  96  * Opens a file on the DVD given the title number and domain.  If the title
  97  * number is 0, the video manager information is opened
  98  * (VIDEO_TS.[IFO,BUP,VOB]).  Returns a file structure which may be used for
  99  * reads, or 0 if the file was not found.
 100  */
 101 dvd_file_t *DVDOpenFile( dvd_reader_t *, int,
 102                          dvd_read_domain_t );
 103
 104 /**
 105  * DVDCloseFile(dvd_file);
 106  *
 107  * Closes a file and frees the associated structure.
 108  */
 109 void DVDCloseFile( dvd_file_t * );
 110
 111 /**
 112  * blocks_read = DVDReadBlocks(dvd_file, offset, block_count, data);
 113  *
 114  * Reads block_count number of blocks from the file at the given block offset.
 115  * Returns number of blocks read on success, -1 on error.  This call is only
 116  * for reading VOB data, and should not be used when reading the IFO files.
 117  * When reading from an encrypted drive, blocks are decrypted using libdvdcss
 118  * where required.
 119  */
 120 ssize_t DVDReadBlocks( dvd_file_t *, int, size_t, unsigned char * );
 121
 122 /**
 123  * offset_set = DVDFileSeek(dvd_file, seek_offset);
 124  *
 125  * Seek to the given position in the file.  Returns the resulting position in
 126  * bytes from the beginning of the file.  The seek position is only used for
 127  * byte reads from the file, the block read call always reads from the given
 128  * offset.
 129  */
 130 int DVDFileSeek( dvd_file_t *, int );
 131
 132 /**
 133  * bytes_read = DVDReadBytes(dvd_file, data, bytes);
 134  *
 135  * Reads the given number of bytes from the file.  This call can only be used
 136  * on the information files, and may not be used for reading from a VOB.  This
 137  * reads from and increments the currrent seek position for the file.
 138  */
 139 ssize_t DVDReadBytes( dvd_file_t *, void *, size_t );
 140
 141 /**
 142  * blocks = DVDFileSize(dvd_file);
 143  *
 144  * Returns the file size in blocks.
 145  */
 146 ssize_t DVDFileSize( dvd_file_t * );
 147
 148 #ifdef __cplusplus
 149 };
 150 #endif
 151 #endif /* DVD_READER_H_INCLUDED */