comparison libdvdread/dvd_reader.h @ 367:1274107d0eac src

moved dvdread to libdvdread; it's the first step for the separation of the lib from dvdnav
author nicodvb
date Sat, 31 May 2008 12:29:19 +0000
parents dvdread/dvd_reader.h@5b8539cacebf
children
comparison
equal deleted inserted replaced
366:5b8539cacebf 367:1274107d0eac
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 * Björn Englund <d4bjorn@dtek.chalmers.se>
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or (at
12 * your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 */
23
24 #ifdef _MSC_VER
25 #include <config.h>
26
27 #include <stdio.h>
28 #include <stdlib.h>
29 #endif
30
31 #include <sys/types.h>
32 #include <inttypes.h>
33
34 /**
35 * The DVD access interface.
36 *
37 * This file contains the functions that form the interface to to
38 * reading files located on a DVD.
39 */
40
41 /**
42 * The current version.
43 */
44 #define DVDREAD_VERSION 904
45
46 /**
47 * The length of one Logical Block of a DVD.
48 */
49 #define DVD_VIDEO_LB_LEN 2048
50
51 /**
52 * Maximum length of filenames allowed in UDF.
53 */
54 #define MAX_UDF_FILE_NAME_LEN 2048
55
56 #ifdef __cplusplus
57 extern "C" {
58 #endif
59
60 /**
61 * Opaque type that is used as a handle for one instance of an opened DVD.
62 */
63 typedef struct dvd_reader_s dvd_reader_t;
64
65 /**
66 * Opaque type for a file read handle, much like a normal fd or FILE *.
67 */
68 typedef struct dvd_file_s dvd_file_t;
69
70 /**
71 * Opens a block device of a DVD-ROM file, or an image file, or a directory
72 * name for a mounted DVD or HD copy of a DVD.
73 *
74 * If the given file is a block device, or is the mountpoint for a block
75 * device, then that device is used for CSS authentication using libdvdcss.
76 * If no device is available, then no CSS authentication is performed,
77 * and we hope that the image is decrypted.
78 *
79 * If the path given is a directory, then the files in that directory may be
80 * in any one of these formats:
81 *
82 * path/VIDEO_TS/VTS_01_1.VOB
83 * path/video_ts/vts_01_1.vob
84 * path/VTS_01_1.VOB
85 * path/vts_01_1.vob
86 *
87 * @param path Specifies the the device, file or directory to be used.
88 * @return If successful a a read handle is returned. Otherwise 0 is returned.
89 *
90 * dvd = DVDOpen(path);
91 */
92 dvd_reader_t *DVDOpen( const char * );
93
94 /**
95 * Closes and cleans up the DVD reader object.
96 *
97 * You must close all open files before calling this function.
98 *
99 * @param dvd A read handle that should be closed.
100 *
101 * DVDClose(dvd);
102 */
103 void DVDClose( dvd_reader_t * );
104
105 /**
106 *
107 */
108 typedef enum {
109 DVD_READ_INFO_FILE, /**< VIDEO_TS.IFO or VTS_XX_0.IFO (title) */
110 DVD_READ_INFO_BACKUP_FILE, /**< VIDEO_TS.BUP or VTS_XX_0.BUP (title) */
111 DVD_READ_MENU_VOBS, /**< VIDEO_TS.VOB or VTS_XX_0.VOB (title) */
112 DVD_READ_TITLE_VOBS /**< VTS_XX_[1-9].VOB (title). All files in
113 the title set are opened and read as a
114 single file. */
115 } dvd_read_domain_t;
116
117 /**
118 * Opens a file on the DVD given the title number and domain.
119 *
120 * If the title number is 0, the video manager information is opened
121 * (VIDEO_TS.[IFO,BUP,VOB]). Returns a file structure which may be
122 * used for reads, or 0 if the file was not found.
123 *
124 * @param dvd A dvd read handle.
125 * @param titlenum Which Video Title Set should be used, VIDEO_TS is 0.
126 * @param domain Which domain.
127 * @return If successful a a file read handle is returned, otherwise 0.
128 *
129 * dvd_file = DVDOpenFile(dvd, titlenum, domain); */
130 dvd_file_t *DVDOpenFile( dvd_reader_t *, int, dvd_read_domain_t );
131
132 /**
133 * Closes a file and frees the associated structure.
134 *
135 * @param dvd_file The file read handle to be closed.
136 *
137 * DVDCloseFile(dvd_file);
138 */
139 void DVDCloseFile( dvd_file_t * );
140
141 /**
142 * Reads block_count number of blocks from the file at the given block offset.
143 * Returns number of blocks read on success, -1 on error. This call is only
144 * for reading VOB data, and should not be used when reading the IFO files.
145 * When reading from an encrypted drive, blocks are decrypted using libdvdcss
146 * where required.
147 *
148 * @param dvd_file A file read handle.
149 * @param offset Block offset from the start of the file to start reading at.
150 * @param block_count Number of block to read.
151 * @param data Pointer to a buffer to write the data into.
152 * @return Returns number of blocks read on success, -1 on error.
153 *
154 * blocks_read = DVDReadBlocks(dvd_file, offset, block_count, data);
155 */
156 ssize_t DVDReadBlocks( dvd_file_t *, int, size_t, unsigned char * );
157
158 /**
159 * Seek to the given position in the file. Returns the resulting position in
160 * bytes from the beginning of the file. The seek position is only used for
161 * byte reads from the file, the block read call always reads from the given
162 * offset.
163 *
164 * @param dvd_file A file read handle.
165 * @param seek_offset Byte offset from the start of the file to seek to.
166 * @return The resulting position in bytes from the beginning of the file.
167 *
168 * offset_set = DVDFileSeek(dvd_file, seek_offset);
169 */
170 int32_t DVDFileSeek( dvd_file_t *, int32_t );
171
172 /**
173 * Reads the given number of bytes from the file. This call can only be used
174 * on the information files, and may not be used for reading from a VOB. This
175 * reads from and increments the currrent seek position for the file.
176 *
177 * @param dvd_file A file read handle.
178 * @param data Pointer to a buffer to write the data into.
179 * @param bytes Number of bytes to read.
180 * @return Returns number of bytes read on success, -1 on error.
181 *
182 * bytes_read = DVDReadBytes(dvd_file, data, bytes);
183 */
184 ssize_t DVDReadBytes( dvd_file_t *, void *, size_t );
185
186 /**
187 * Returns the file size in blocks.
188 *
189 * @param dvd_file A file read handle.
190 * @return The size of the file in blocks, -1 on error.
191 *
192 * blocks = DVDFileSize(dvd_file);
193 */
194 ssize_t DVDFileSize( dvd_file_t * );
195
196 /**
197 * Get a unique 128 bit disc ID.
198 * This is the MD5 sum of VIDEO_TS.IFO and the VTS_0?_0.IFO files
199 * in title order (those that exist).
200 * If you need a 'text' representation of the id, print it as a
201 * hexadecimal number, using lowercase letters, discid[0] first.
202 * I.e. the same format as the command-line 'md5sum' program uses.
203 *
204 * @param dvd A read handle to get the disc ID from
205 * @param discid The buffer to put the disc ID into. The buffer must
206 * have room for 128 bits (16 chars).
207 * @return 0 on success, -1 on error.
208 */
209 int DVDDiscID( dvd_reader_t *, unsigned char * );
210
211 /**
212 * Get the UDF VolumeIdentifier and VolumeSetIdentifier
213 * from the PrimaryVolumeDescriptor.
214 *
215 * @param dvd A read handle to get the disc ID from
216 * @param volid The buffer to put the VolumeIdentifier into.
217 * The VolumeIdentifier is latin-1 encoded (8bit unicode)
218 * null terminated and max 32 bytes (including '\0')
219 * @param volid_size No more than volid_size bytes will be copied to volid.
220 * If the VolumeIdentifier is truncated because of this
221 * it will still be null terminated.
222 * @param volsetid The buffer to put the VolumeSetIdentifier into.
223 * The VolumeIdentifier is 128 bytes as
224 * stored in the UDF PrimaryVolumeDescriptor.
225 * Note that this is not a null terminated string.
226 * @param volsetid_size At most volsetid_size bytes will be copied to volsetid.
227 * @return 0 on success, -1 on error.
228 */
229 int DVDUDFVolumeInfo( dvd_reader_t *, char *, unsigned int,
230 unsigned char *, unsigned int );
231
232 int DVDFileSeekForce( dvd_file_t *, int offset, int force_size);
233
234 /**
235 * Get the ISO9660 VolumeIdentifier and VolumeSetIdentifier
236 *
237 * * Only use this function as fallback if DVDUDFVolumeInfo returns 0 *
238 * * this will happen on a disc mastered only with a iso9660 filesystem *
239 * * All video DVD discs have UDF filesystem *
240 *
241 * @param dvd A read handle to get the disc ID from
242 * @param volid The buffer to put the VolumeIdentifier into.
243 * The VolumeIdentifier is coded with '0-9','A-Z','_'
244 * null terminated and max 33 bytes (including '\0')
245 * @param volid_size No more than volid_size bytes will be copied to volid.
246 * If the VolumeIdentifier is truncated because of this
247 * it will still be null terminated.
248 * @param volsetid The buffer to put the VolumeSetIdentifier into.
249 * The VolumeIdentifier is 128 bytes as
250 * stored in the ISO9660 PrimaryVolumeDescriptor.
251 * Note that this is not a null terminated string.
252 * @param volsetid_size At most volsetid_size bytes will be copied to volsetid.
253 * @return 0 on success, -1 on error.
254 */
255 int DVDISOVolumeInfo( dvd_reader_t *, char *, unsigned int,
256 unsigned char *, unsigned int );
257
258 /**
259 * Sets the level of caching that is done when reading from a device
260 *
261 * @param dvd A read handle to get the disc ID from
262 * @param level The level of caching wanted.
263 * -1 - returns the current setting.
264 * 0 - UDF Cache turned off.
265 * 1 - (default level) Pointers to IFO files and some data from
266 * PrimaryVolumeDescriptor are cached.
267 *
268 * @return The level of caching.
269 */
270 int DVDUDFCacheLevel( dvd_reader_t *, int );
271
272 #ifdef __cplusplus
273 };
274 #endif
275 #endif /* DVD_READER_H_INCLUDED */