Mercurial > mplayer.hg
annotate dvdread/dvd_reader.h @ 24047:de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
author | diego |
---|---|
date | Wed, 15 Aug 2007 11:47:22 +0000 |
parents | 22cb9d5f1e21 |
children | 1542693b2a30 |
rev | line source |
---|---|
7029 | 1 #ifndef DVD_READER_H_INCLUDED |
2 #define DVD_READER_H_INCLUDED | |
3 | |
4 /* | |
5 * Copyright (C) 2001, 2002 Billy Biggs <vektor@dumbterm.net>, | |
15874 | 6 * Håkan Hjort <d95hjort@dtek.chalmers.se>, |
7 * Björn Englund <d4bjorn@dtek.chalmers.se> | |
7029 | 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 #include <sys/types.h> | |
25 | |
26 /** | |
15874 | 27 * The DVD access interface. |
28 * | |
29 * This file contains the functions that form the interface to to | |
30 * reading files located on a DVD. | |
31 */ | |
32 | |
33 /** | |
24047
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
34 * The current version. (0.9.4 => 904, 1.2.3 => 10203) |
15874 | 35 */ |
24047
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
36 #define DVDREAD_VERSION 905 |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
37 |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
38 /** |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
39 * Returns the compiled version. (DVDREAD_VERSION as an int) |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
40 */ |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
41 int DVDVersion(void); |
15874 | 42 |
43 /** | |
44 * The length of one Logical Block of a DVD. | |
7029 | 45 */ |
46 #define DVD_VIDEO_LB_LEN 2048 | |
47 | |
48 /** | |
15874 | 49 * Maximum length of filenames allowed in UDF. |
7029 | 50 */ |
51 #define MAX_UDF_FILE_NAME_LEN 2048 | |
52 | |
53 #ifdef __cplusplus | |
54 extern "C" { | |
55 #endif | |
15874 | 56 |
57 /** | |
58 * Opaque type that is used as a handle for one instance of an opened DVD. | |
59 */ | |
7029 | 60 typedef struct dvd_reader_s dvd_reader_t; |
15874 | 61 |
62 /** | |
63 * Opaque type for a file read handle, much like a normal fd or FILE *. | |
64 */ | |
7029 | 65 typedef struct dvd_file_s dvd_file_t; |
66 | |
67 /** | |
68 * Opens a block device of a DVD-ROM file, or an image file, or a directory | |
15874 | 69 * name for a mounted DVD or HD copy of a DVD. |
7029 | 70 * |
71 * If the given file is a block device, or is the mountpoint for a block | |
72 * device, then that device is used for CSS authentication using libdvdcss. | |
73 * If no device is available, then no CSS authentication is performed, | |
74 * and we hope that the image is decrypted. | |
75 * | |
15874 | 76 * If the path given is a directory, then the files in that directory may be |
77 * in any one of these formats: | |
7029 | 78 * |
79 * path/VIDEO_TS/VTS_01_1.VOB | |
80 * path/video_ts/vts_01_1.vob | |
81 * path/VTS_01_1.VOB | |
82 * path/vts_01_1.vob | |
15874 | 83 * |
84 * @param path Specifies the the device, file or directory to be used. | |
85 * @return If successful a a read handle is returned. Otherwise 0 is returned. | |
86 * | |
87 * dvd = DVDOpen(path); | |
24047
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
88 * |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
89 * Threads: this function uses chdir() and getcwd(). |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
90 * The current working directory is global to all threads, |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
91 * so using chdir/getcwd in another thread could give unexpected results. |
7029 | 92 */ |
93 dvd_reader_t *DVDOpen( const char * ); | |
94 | |
95 /** | |
15874 | 96 * Closes and cleans up the DVD reader object. |
97 * | |
98 * You must close all open files before calling this function. | |
7029 | 99 * |
15874 | 100 * @param dvd A read handle that should be closed. |
101 * | |
102 * DVDClose(dvd); | |
7029 | 103 */ |
104 void DVDClose( dvd_reader_t * ); | |
105 | |
106 /** | |
24047
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
107 * Initializes libdvdread to be used with multithreading apps. |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
108 * |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
109 * You must call this function before using any other functions of libdvdread |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
110 * if you are going to use libdvdread in multiple threads in your program. |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
111 * If you are not using threads, or using libdvdread from just one thread, |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
112 * you do not need to call this, but you are allowed to do so anyway. |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
113 * |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
114 * There are several restrictions on how you can use libdvdread in |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
115 * multithreading apps, see further documentation. |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
116 * |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
117 * If you have called DVDFinish() you need to call DVDInit again to use |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
118 * libdvdread in multiple threads. |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
119 * |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
120 * DVDInit(void); |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
121 */ |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
122 void DVDInit(void); |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
123 |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
124 /** |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
125 * frees any dlopened objects. |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
126 * |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
127 * You must DVDClose all handles opened with DVDOpen before calling this. |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
128 * Use this function if you need to close the dlopened libs and any other |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
129 * objects that have been dynamically allocated by libdvdread. |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
130 * |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
131 * DVDFinish(void); |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
132 */ |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
133 void DVDFinish(void); |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
134 |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
135 /** |
15874 | 136 * |
7029 | 137 */ |
138 typedef enum { | |
15874 | 139 DVD_READ_INFO_FILE, /**< VIDEO_TS.IFO or VTS_XX_0.IFO (title) */ |
140 DVD_READ_INFO_BACKUP_FILE, /**< VIDEO_TS.BUP or VTS_XX_0.BUP (title) */ | |
141 DVD_READ_MENU_VOBS, /**< VIDEO_TS.VOB or VTS_XX_0.VOB (title) */ | |
142 DVD_READ_TITLE_VOBS /**< VTS_XX_[1-9].VOB (title). All files in | |
143 the title set are opened and read as a | |
144 single file. */ | |
7029 | 145 } dvd_read_domain_t; |
146 | |
147 /** | |
15874 | 148 * Opens a file on the DVD given the title number and domain. |
149 * | |
150 * If the title number is 0, the video manager information is opened | |
151 * (VIDEO_TS.[IFO,BUP,VOB]). Returns a file structure which may be | |
152 * used for reads, or 0 if the file was not found. | |
7029 | 153 * |
15874 | 154 * @param dvd A dvd read handle. |
155 * @param titlenum Which Video Title Set should be used, VIDEO_TS is 0. | |
156 * @param domain Which domain. | |
157 * @return If successful a a file read handle is returned, otherwise 0. | |
158 * | |
159 * dvd_file = DVDOpenFile(dvd, titlenum, domain); */ | |
160 dvd_file_t *DVDOpenFile( dvd_reader_t *, int, dvd_read_domain_t ); | |
7029 | 161 |
162 /** | |
15874 | 163 * Closes a file and frees the associated structure. |
7029 | 164 * |
15874 | 165 * @param dvd_file The file read handle to be closed. |
166 * | |
167 * DVDCloseFile(dvd_file); | |
7029 | 168 */ |
169 void DVDCloseFile( dvd_file_t * ); | |
170 | |
171 /** | |
172 * Reads block_count number of blocks from the file at the given block offset. | |
173 * Returns number of blocks read on success, -1 on error. This call is only | |
174 * for reading VOB data, and should not be used when reading the IFO files. | |
175 * When reading from an encrypted drive, blocks are decrypted using libdvdcss | |
176 * where required. | |
15874 | 177 * |
178 * @param dvd_file A file read handle. | |
179 * @param offset Block offset from the start of the file to start reading at. | |
180 * @param block_count Number of block to read. | |
181 * @param data Pointer to a buffer to write the data into. | |
24047
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
182 * It must be aligned to the logical block size of the device when |
de28f9e8cb00
Sync libdvdread with version 0.9.5 (functional changes).
diego
parents:
20981
diff
changeset
|
183 * reading from a raw/O_DIRECT device (2048 bytes for DVD) |
15874 | 184 * @return Returns number of blocks read on success, -1 on error. |
185 * | |
186 * blocks_read = DVDReadBlocks(dvd_file, offset, block_count, data); | |
7029 | 187 */ |
188 ssize_t DVDReadBlocks( dvd_file_t *, int, size_t, unsigned char * ); | |
189 | |
190 /** | |
191 * Seek to the given position in the file. Returns the resulting position in | |
192 * bytes from the beginning of the file. The seek position is only used for | |
193 * byte reads from the file, the block read call always reads from the given | |
194 * offset. | |
15874 | 195 * |
196 * @param dvd_file A file read handle. | |
197 * @param seek_offset Byte offset from the start of the file to seek to. | |
198 * @return The resulting position in bytes from the beginning of the file. | |
199 * | |
200 * offset_set = DVDFileSeek(dvd_file, seek_offset); | |
7029 | 201 */ |
202 int DVDFileSeek( dvd_file_t *, int ); | |
203 | |
204 /** | |
205 * Reads the given number of bytes from the file. This call can only be used | |
206 * on the information files, and may not be used for reading from a VOB. This | |
207 * reads from and increments the currrent seek position for the file. | |
15874 | 208 * |
209 * @param dvd_file A file read handle. | |
210 * @param data Pointer to a buffer to write the data into. | |
211 * @param bytes Number of bytes to read. | |
212 * @return Returns number of bytes read on success, -1 on error. | |
213 * | |
214 * bytes_read = DVDReadBytes(dvd_file, data, bytes); | |
7029 | 215 */ |
216 ssize_t DVDReadBytes( dvd_file_t *, void *, size_t ); | |
217 | |
218 /** | |
15874 | 219 * Returns the file size in blocks. |
7029 | 220 * |
15874 | 221 * @param dvd_file A file read handle. |
222 * @return The size of the file in blocks, -1 on error. | |
223 * | |
224 * blocks = DVDFileSize(dvd_file); | |
7029 | 225 */ |
226 ssize_t DVDFileSize( dvd_file_t * ); | |
227 | |
15874 | 228 /** |
229 * Get a unique 128 bit disc ID. | |
230 * This is the MD5 sum of VIDEO_TS.IFO and the VTS_0?_0.IFO files | |
231 * in title order (those that exist). | |
232 * If you need a 'text' representation of the id, print it as a | |
233 * hexadecimal number, using lowercase letters, discid[0] first. | |
234 * I.e. the same format as the command-line 'md5sum' program uses. | |
235 * | |
236 * @param dvd A read handle to get the disc ID from | |
237 * @param discid The buffer to put the disc ID into. The buffer must | |
238 * have room for 128 bits (16 chars). | |
239 * @return 0 on success, -1 on error. | |
240 */ | |
241 int DVDDiscID( dvd_reader_t *, unsigned char * ); | |
242 | |
243 /** | |
244 * Get the UDF VolumeIdentifier and VolumeSetIdentifier | |
245 * from the PrimaryVolumeDescriptor. | |
246 * | |
247 * @param dvd A read handle to get the disc ID from | |
248 * @param volid The buffer to put the VolumeIdentifier into. | |
249 * The VolumeIdentifier is latin-1 encoded (8bit unicode) | |
250 * null terminated and max 32 bytes (including '\0') | |
251 * @param volid_size No more than volid_size bytes will be copied to volid. | |
252 * If the VolumeIdentifier is truncated because of this | |
253 * it will still be null terminated. | |
254 * @param volsetid The buffer to put the VolumeSetIdentifier into. | |
255 * The VolumeIdentifier is 128 bytes as | |
256 * stored in the UDF PrimaryVolumeDescriptor. | |
257 * Note that this is not a null terminated string. | |
258 * @param volsetid_size At most volsetid_size bytes will be copied to volsetid. | |
259 * @return 0 on success, -1 on error. | |
260 */ | |
261 int DVDUDFVolumeInfo( dvd_reader_t *, char *, unsigned int, | |
262 unsigned char *, unsigned int ); | |
263 | |
264 /** | |
265 * Get the ISO9660 VolumeIdentifier and VolumeSetIdentifier | |
266 * | |
267 * * Only use this function as fallback if DVDUDFVolumeInfo returns 0 * | |
268 * * this will happen on a disc mastered only with a iso9660 filesystem * | |
269 * * All video DVD discs have UDF filesystem * | |
270 * | |
271 * @param dvd A read handle to get the disc ID from | |
272 * @param volid The buffer to put the VolumeIdentifier into. | |
273 * The VolumeIdentifier is coded with '0-9','A-Z','_' | |
274 * null terminated and max 33 bytes (including '\0') | |
275 * @param volid_size No more than volid_size bytes will be copied to volid. | |
276 * If the VolumeIdentifier is truncated because of this | |
277 * it will still be null terminated. | |
278 * @param volsetid The buffer to put the VolumeSetIdentifier into. | |
279 * The VolumeIdentifier is 128 bytes as | |
280 * stored in the ISO9660 PrimaryVolumeDescriptor. | |
281 * Note that this is not a null terminated string. | |
282 * @param volsetid_size At most volsetid_size bytes will be copied to volsetid. | |
283 * @return 0 on success, -1 on error. | |
284 */ | |
285 int DVDISOVolumeInfo( dvd_reader_t *, char *, unsigned int, | |
286 unsigned char *, unsigned int ); | |
287 | |
288 /** | |
289 * Sets the level of caching that is done when reading from a device | |
290 * | |
291 * @param dvd A read handle to get the disc ID from | |
292 * @param level The level of caching wanted. | |
293 * -1 - returns the current setting. | |
294 * 0 - UDF Cache turned off. | |
295 * 1 - (default level) Pointers to IFO files and some data from | |
296 * PrimaryVolumeDescriptor are cached. | |
297 * | |
298 * @return The level of caching. | |
299 */ | |
300 int DVDUDFCacheLevel( dvd_reader_t *, int ); | |
301 | |
7029 | 302 #ifdef __cplusplus |
303 }; | |
304 #endif | |
305 #endif /* DVD_READER_H_INCLUDED */ |