Mercurial > libdvdnav.hg
annotate dvdnav.h @ 147:26334f5fac2b src
since noone objected, I will get serious with that:
review dvdnav.h and remove doxygen-style comments
author | mroi |
---|---|
date | Thu, 03 Apr 2003 12:57:41 +0000 |
parents | f7a26cd00c93 |
children | 58c914a3ccbd |
rev | line source |
---|---|
0 | 1 /* |
2 * Copyright (C) 2001 Rich Wareham <richwareham@users.sourceforge.net> | |
3 * | |
4 * This file is part of libdvdnav, a DVD navigation library. | |
5 * | |
6 * libdvdnav is free software; you can redistribute it and/or modify | |
7 * it under the terms of the GNU General Public License as published by | |
8 * the Free Software Foundation; either version 2 of the License, or | |
9 * (at your option) any later version. | |
10 * | |
11 * libdvdnav is distributed in the hope that it will be useful, | |
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 * GNU General Public License for more details. | |
15 * | |
16 * You should have received a copy of the GNU General Public License | |
17 * along with this program; if not, write to the Free Software | |
18 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA | |
19 * | |
20 * $Id$ | |
21 * | |
22 */ | |
23 | |
147 | 24 /* |
25 * This is the main header file applications should include if they want | |
26 * to access dvdnav functionality. | |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
27 */ |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
28 |
0 | 29 #ifndef DVDNAV_H_INCLUDED |
30 #define DVDNAV_H_INCLUDED | |
31 | |
5
c1b55dc1bfed
Add API call to get number of programmes in current title.
richwareham
parents:
4
diff
changeset
|
32 #ifdef __cplusplus |
c1b55dc1bfed
Add API call to get number of programmes in current title.
richwareham
parents:
4
diff
changeset
|
33 extern "C" { |
c1b55dc1bfed
Add API call to get number of programmes in current title.
richwareham
parents:
4
diff
changeset
|
34 #endif |
c1b55dc1bfed
Add API call to get number of programmes in current title.
richwareham
parents:
4
diff
changeset
|
35 |
139
f7a26cd00c93
* only install the headers that really are intended for public use
mroi
parents:
132
diff
changeset
|
36 #ifdef DVDNAV_COMPILE |
f7a26cd00c93
* only install the headers that really are intended for public use
mroi
parents:
132
diff
changeset
|
37 # include "dvdnav_events.h" |
f7a26cd00c93
* only install the headers that really are intended for public use
mroi
parents:
132
diff
changeset
|
38 # include "dvd_types.h" |
f7a26cd00c93
* only install the headers that really are intended for public use
mroi
parents:
132
diff
changeset
|
39 #else |
f7a26cd00c93
* only install the headers that really are intended for public use
mroi
parents:
132
diff
changeset
|
40 # include <dvdnav/dvdnav_events.h> |
f7a26cd00c93
* only install the headers that really are intended for public use
mroi
parents:
132
diff
changeset
|
41 # include <dvdnav/dvd_types.h> |
f7a26cd00c93
* only install the headers that really are intended for public use
mroi
parents:
132
diff
changeset
|
42 #endif |
0 | 43 |
44 #include <dvdread/dvd_reader.h> | |
91
df9712507b30
Add a new API function, to allow for more flexible menu button control.
jcdutton
parents:
90
diff
changeset
|
45 #include <dvdread/ifo_types.h> /* For vm_cmd_t */ |
0 | 46 |
147 | 47 |
48 /********************************************************************* | |
49 * dvdnav data types * | |
50 *********************************************************************/ | |
51 | |
52 /* | |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
53 * Opaque data-type can be viewed as a 'DVD handle'. You should get |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
54 * a pointer to a dvdnav_t from the dvdnav_open() function. |
147 | 55 * Never call free() on the pointer, you have to give it back with |
56 * dvdnav_close(). | |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
57 */ |
0 | 58 typedef struct dvdnav_s dvdnav_t; |
59 | |
147 | 60 /* Status as reported by most of libdvdnav's functions */ |
0 | 61 typedef int dvdnav_status_t; |
62 | |
147 | 63 /* |
64 * Unless otherwise stated, all functions return DVDNAV_STATUS_OK if | |
65 * they succeeded, otherwise DVDNAV_STATUS_ERR is returned and the error may | |
66 * be obtained by calling dvdnav_err_to_string(). | |
67 */ | |
0 | 68 #define DVDNAV_STATUS_ERR 0 |
69 #define DVDNAV_STATUS_OK 1 | |
70 | |
147 | 71 |
72 /********************************************************************* | |
73 * initialisation & housekeeping functions * | |
74 *********************************************************************/ | |
75 | |
76 /* | |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
77 * These functions allow you to open a DVD device and associate it |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
78 * with a dvdnav_t. |
0 | 79 */ |
80 | |
147 | 81 /* |
82 * Attempts to open the DVD drive at the specified path and pre-cache | |
83 * the CSS-keys. libdvdread is used to access the DVD, so any source | |
84 * supported by libdvdread can be given with "path". Currently, | |
85 * libdvdread can access: DVD drives, DVD image files, DVD file-by-file | |
86 * copies. | |
0 | 87 * |
147 | 88 * The resulting dvdnav_t handle will be written to *dest. |
0 | 89 */ |
147 | 90 dvdnav_status_t dvdnav_open(dvdnav_t **dest, const char *path); |
0 | 91 |
147 | 92 /* |
0 | 93 * Closes a dvdnav_t previously opened with dvdnav_open(), freeing any |
94 * memory associated with it. | |
95 */ | |
96 dvdnav_status_t dvdnav_close(dvdnav_t *self); | |
97 | |
147 | 98 /* |
99 * Resets the DVD virtual machine and cache buffers. | |
4
99bed5d6db2f
Added reset patch from Kees Cook <kees@outflux.net>
richwareham
parents:
0
diff
changeset
|
100 */ |
99bed5d6db2f
Added reset patch from Kees Cook <kees@outflux.net>
richwareham
parents:
0
diff
changeset
|
101 dvdnav_status_t dvdnav_reset(dvdnav_t *self); |
99bed5d6db2f
Added reset patch from Kees Cook <kees@outflux.net>
richwareham
parents:
0
diff
changeset
|
102 |
147 | 103 /* |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
104 * Fills a pointer with a value pointing to a string describing |
147 | 105 * the path associated with an open dvdnav_t. It assigns *path to NULL |
0 | 106 * on error. |
107 */ | |
147 | 108 dvdnav_status_t dvdnav_path(dvdnav_t *self, const char **path); |
0 | 109 |
147 | 110 /* |
0 | 111 * Returns a human-readable string describing the last error. |
112 */ | |
114 | 113 const char* dvdnav_err_to_string(dvdnav_t *self); |
0 | 114 |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
115 |
147 | 116 /********************************************************************* |
117 * changing and reading DVD player characteristics * | |
118 *********************************************************************/ | |
119 | |
120 /* | |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
121 * These functions allow you to manipulate the various global characteristics |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
122 * of the DVD playback engine. |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
123 */ |
0 | 124 |
147 | 125 /* |
126 * Sets the region mask (bit 0 set implies region 1, bit 1 set implies | |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
127 * region 2, etc) of the virtual machine. Generally you will only need to set |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
128 * this if you are playing RCE discs which query the virtual machine as to its |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
129 * region setting. |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
130 * |
147 | 131 * This has _nothing_ to do with the region setting of the DVD drive. |
0 | 132 */ |
147 | 133 dvdnav_status_t dvdnav_set_region_mask(dvdnav_t *self, int region_mask); |
0 | 134 |
147 | 135 /* |
136 * Returns the region mask (bit 0 set implies region 1, bit 1 set implies | |
137 * region 2, etc) of the virtual machine. | |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
138 * |
147 | 139 * This has _nothing_ to do with the region setting of the DVD drive. |
0 | 140 */ |
147 | 141 dvdnav_status_t dvdnav_get_region_mask(dvdnav_t *self, int *region_mask); |
0 | 142 |
147 | 143 /* |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
144 * Specify whether read-ahead caching should be used. You may not want this if your |
114 | 145 * decoding engine does its own buffering. |
147 | 146 * |
147 * The default read-ahead cache does not use an additional thread for the reading | |
148 * (see read_cache.c for a threaded cache, but note that this code is currently | |
149 * unmaintained). It prebuffers on VOBU level by reading ahead several buffers | |
150 * on every read request. The speed of this prebuffering has been optimized to | |
151 * also work on slow DVD drives. | |
0 | 152 * |
147 | 153 * If in addition you want to prevent memcpy's to improve performance, have a look |
154 * at dvdnav_get_next_cache_block(). | |
0 | 155 */ |
147 | 156 dvdnav_status_t dvdnav_set_readahead_flag(dvdnav_t *self, int read_ahead_flag); |
0 | 157 |
147 | 158 /* |
159 * Query whether read-ahead caching/buffering will be used. | |
160 */ | |
161 dvdnav_status_t dvdnav_get_readahead_flag(dvdnav_t *self, int *read_ahead_flag); | |
162 | |
163 /* | |
132 | 164 * Specify whether the positioning works PGC or PG based. |
147 | 165 * Programs (PGs) on DVDs are similar to Chapters and a program chain (PGC) |
132 | 166 * usually covers a whole feature. This affects the behaviour of the |
147 | 167 * functions dvdnav_get_position() and dvdnav_sector_search(). See there. |
132 | 168 * Default is PG based positioning. |
169 */ | |
147 | 170 dvdnav_status_t dvdnav_set_PGC_positioning_flag(dvdnav_t *self, int pgc_based_flag); |
132 | 171 |
147 | 172 /* |
132 | 173 * Query whether positioning is PG or PGC based. |
174 */ | |
147 | 175 dvdnav_status_t dvdnav_get_PGC_positioning_flag(dvdnav_t *self, int *pgc_based_flag); |
176 | |
132 | 177 |
147 | 178 /********************************************************************* |
179 * reading data * | |
180 *********************************************************************/ | |
181 | |
182 /* | |
183 * These functions are used to poll the playback enginge and actually get data | |
184 * off the DVD. | |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
185 */ |
0 | 186 |
147 | 187 /* |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
188 * Attempts to get the next block off the DVD and copies it into the buffer 'buf'. |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
189 * If there is any special actions that may need to be performed, the value |
147 | 190 * pointed to by 'event' gets set accordingly. |
0 | 191 * |
192 * If 'event' is DVDNAV_BLOCK_OK then 'buf' is filled with the next block | |
193 * (note that means it has to be at /least/ 2048 bytes big). 'len' is | |
194 * then set to 2048. | |
195 * | |
196 * Otherwise, buf is filled with an appropriate event structure and | |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
197 * len is set to the length of that structure. |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
198 * |
147 | 199 * See the dvdnav_events.h header for information on the various events. |
0 | 200 */ |
201 dvdnav_status_t dvdnav_get_next_block(dvdnav_t *self, unsigned char *buf, | |
202 int *event, int *len); | |
203 | |
147 | 204 /* |
60 | 205 * This basically does the same as dvdnav_get_next_block. The only difference is |
206 * that it avoids a memcopy, when the requested block was found in the cache. | |
207 * I such a case (cache hit) this function will return a different pointer than | |
208 * the one handed in, pointing directly into the relevant block in the cache. | |
147 | 209 * Those pointers must _never_ be freed but instead returned to the library via |
114 | 210 * dvdnav_free_cache_block(). |
60 | 211 */ |
212 dvdnav_status_t dvdnav_get_next_cache_block(dvdnav_t *self, unsigned char **buf, | |
213 int *event, int *len); | |
214 | |
147 | 215 /* |
114 | 216 * All buffers which came from the internal cache (when dvdnav_get_next_cache_block() |
60 | 217 * returned a buffer different from the one handed in) have to be freed with this |
218 * function. Although handing in other buffers not from the cache doesn't cause any harm. | |
219 */ | |
220 dvdnav_status_t dvdnav_free_cache_block(dvdnav_t *self, unsigned char *buf); | |
221 | |
147 | 222 /* |
223 * If we are currently in a still-frame this function skips it. | |
55
5674fbd44f26
report all spu types (widescreen, letterbox and pan&scan), not widescreen
mroi
parents:
44
diff
changeset
|
224 * |
147 | 225 * See also the DVDNAV_STILL_FRAME event. |
0 | 226 */ |
227 dvdnav_status_t dvdnav_still_skip(dvdnav_t *self); | |
228 | |
147 | 229 /* |
116 | 230 * If we are currently in WAIT state, that is: the application is required to |
231 * wait for its fifos to become empty, calling this signals libdvdnav that this | |
232 * is achieved and that it can continue. | |
233 * | |
147 | 234 * See also the DVDNAV_WAIT event. |
116 | 235 */ |
236 dvdnav_status_t dvdnav_wait_skip(dvdnav_t *self); | |
237 | |
147 | 238 /* |
239 * Returns the still time from the currently playing cell. | |
240 * The still time is given in seconds with 0xff meaning an indefinite still. | |
114 | 241 * |
147 | 242 * This function can be used to detect still frames before they are reached. |
243 * Some players might need this to prepare for a frame to be shown for a | |
244 * longer time than usual. | |
114 | 245 */ |
246 uint32_t dvdnav_get_next_still_flag(dvdnav_t *self); | |
247 | |
147 | 248 /* |
249 * Stops playback. The next event obtained with one of the get_next_block | |
250 * functions will be a DVDNAV_STOP event. | |
0 | 251 * |
147 | 252 * It is not required to call this before dvdnav_close(). |
253 */ | |
254 dvdnav_status_t dvdnav_stop(dvdnav_t *self); | |
255 | |
256 | |
257 /********************************************************************* | |
258 * title/part navigation * | |
259 *********************************************************************/ | |
260 | |
261 /* | |
262 * Returns the number of titles on the disk. | |
263 */ | |
264 dvdnav_status_t dvdnav_get_number_of_titles(dvdnav_t *self, int *titles); | |
265 | |
266 /* | |
267 * Returns the number of parts within the given title. | |
268 */ | |
269 dvdnav_status_t dvdnav_get_number_of_parts(dvdnav_t *self, int title, int *parts); | |
270 | |
271 /* | |
272 * Plays the specified title of the DVD from its beginning (that is: part 1). | |
0 | 273 */ |
274 dvdnav_status_t dvdnav_title_play(dvdnav_t *self, int title); | |
275 | |
147 | 276 /* |
277 * Plays the specified title, starting from the specified part. | |
0 | 278 */ |
279 dvdnav_status_t dvdnav_part_play(dvdnav_t *self, int title, int part); | |
280 | |
147 | 281 /* |
0 | 282 * Play the specified amount of parts of the specified title of |
283 * the DVD then STOP. | |
284 * | |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
285 * Currently unimplemented! |
0 | 286 */ |
287 dvdnav_status_t dvdnav_part_play_auto_stop(dvdnav_t *self, int title, | |
114 | 288 int part, int parts_to_play); |
0 | 289 |
147 | 290 /* |
291 * Play the specified title starting from the specified time. | |
0 | 292 * |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
293 * Currently unimplemented! |
0 | 294 */ |
295 dvdnav_status_t dvdnav_time_play(dvdnav_t *self, int title, | |
114 | 296 unsigned long int time); |
0 | 297 |
147 | 298 /* |
123 | 299 * Stop playing the current position and jump to the specified menu. |
114 | 300 * |
147 | 301 * See also DVDMenuID_t from libdvdread |
114 | 302 */ |
303 dvdnav_status_t dvdnav_menu_call(dvdnav_t *self, DVDMenuID_t menu); | |
304 | |
147 | 305 /* |
114 | 306 * Return the title number and part currently being played or |
307 * -1 if in a menu. | |
308 */ | |
309 dvdnav_status_t dvdnav_current_title_info(dvdnav_t *self, int *title, | |
147 | 310 int *part); |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
311 |
147 | 312 /* |
313 * Return the current position (in blocks) within the current | |
314 * title and the length (in blocks) of said title. | |
315 * | |
316 * Current implementation is wrong and likely to behave unpredictably! | |
317 * Use is discouraged! | |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
318 */ |
147 | 319 dvdnav_status_t dvdnav_get_position_in_title(dvdnav_t *self, |
320 unsigned int *pos, | |
321 unsigned int *len); | |
0 | 322 |
147 | 323 /* |
324 * This function is only available for compatibility reasons. | |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
325 * |
147 | 326 * Stop playing the current position and start playback of the current title |
327 * from the specified part. | |
0 | 328 */ |
147 | 329 dvdnav_status_t dvdnav_part_search(dvdnav_t *self, int part); |
330 | |
0 | 331 |
147 | 332 /********************************************************************* |
333 * program chain/program navigation * | |
334 *********************************************************************/ | |
335 | |
336 /* | |
123 | 337 * Stop playing the current position and start playback from the last |
338 * VOBU boundary before the given sector. The sector number is not | |
339 * meant to be an absolute physical DVD sector, but a relative sector | |
340 * in the current program. This function cannot leave the current | |
341 * program and will fail, if asked to do so. | |
0 | 342 * |
147 | 343 * If program chain based positioning is enabled |
344 * (see dvdnav_set_PGC_positioning_flag()), this will seek to the relative | |
345 * sector inside the current program chain. | |
346 * | |
347 * 'origin' can be one of SEEK_SET, SEEK_CUR, SEEK_END as defined in | |
348 * fcntl.h. | |
0 | 349 */ |
350 dvdnav_status_t dvdnav_sector_search(dvdnav_t *self, | |
114 | 351 unsigned long int offset, int origin); |
0 | 352 |
147 | 353 /* |
354 * Stop playing the current position and start playback of the title | |
355 * from the specified timecode. | |
0 | 356 * |
147 | 357 * Currently unimplemented! |
0 | 358 */ |
147 | 359 dvdnav_status_t dvdnav_time_search(dvdnav_t *self, |
360 unsigned long int time); | |
0 | 361 |
147 | 362 /* |
363 * Stop playing current position and play the "GoUp"-program chain. | |
364 * (which generally leads to the title menu or a higer-level menu). | |
365 */ | |
366 dvdnav_status_t dvdnav_go_up(dvdnav_t *self); | |
367 | |
368 /* | |
123 | 369 * Stop playing the current position and start playback at the |
370 * previous program (if it exists). | |
0 | 371 */ |
372 dvdnav_status_t dvdnav_prev_pg_search(dvdnav_t *self); | |
373 | |
147 | 374 /* |
123 | 375 * Stop playing the current position and start playback at the |
376 * first program. | |
0 | 377 */ |
378 dvdnav_status_t dvdnav_top_pg_search(dvdnav_t *self); | |
379 | |
147 | 380 /* |
123 | 381 * Stop playing the current position and start playback at the |
382 * next program (if it exists). | |
0 | 383 */ |
384 dvdnav_status_t dvdnav_next_pg_search(dvdnav_t *self); | |
385 | |
147 | 386 /* |
0 | 387 * Return the current position (in blocks) within the current |
123 | 388 * program and the length (in blocks) of current program. |
147 | 389 * |
390 * If program chain based positioning is enabled | |
391 * (see dvdnav_set_PGC_positioning_flag()), this will return the | |
392 * relative position in and the length of the current program chain. | |
0 | 393 */ |
114 | 394 dvdnav_status_t dvdnav_get_position(dvdnav_t *self, unsigned int *pos, |
8
66708b4a1b5e
Stop C++ bitching about some things and extend the menus example
richwareham
parents:
5
diff
changeset
|
395 unsigned int *len); |
66708b4a1b5e
Stop C++ bitching about some things and extend the menus example
richwareham
parents:
5
diff
changeset
|
396 |
0 | 397 |
147 | 398 /********************************************************************* |
399 * menu highlights * | |
400 *********************************************************************/ | |
0 | 401 |
147 | 402 /* |
114 | 403 * Most functions related to highlights take a NAV PCI packet as a parameter. |
404 * While you can get the such a packet from libdvdnav, for players with internal | |
405 * FIFOs, this will result in errors, because due to the FIFO length, libdvdnav will | |
406 * be ahead in the stream compared to what the user is seeing on screen. | |
407 * Therefore, player applications who have a NAV packet available, which is | |
408 * better in sync with the actual playback should always pass this one to these | |
409 * functions. | |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
410 */ |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
411 |
147 | 412 /* |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
413 * Get the currently highlighted button |
147 | 414 * number (1..36) or 0 if no button is highlighted. |
0 | 415 */ |
147 | 416 dvdnav_status_t dvdnav_get_current_highlight(dvdnav_t *self, int *button); |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
417 |
147 | 418 /* |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
419 * Returns the Presentation Control Information (PCI) structure associated |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
420 * with the current position. |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
421 * |
147 | 422 * Read the general notes above. |
423 * See also libdvdreads nav_types.h for definition of pci_t. | |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
424 */ |
22
3c1df0cb3aee
Start of rewrite of libdvdnav. Still need to re-implement seeking.
jcdutton
parents:
21
diff
changeset
|
425 pci_t* dvdnav_get_current_nav_pci(dvdnav_t *self); |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
426 |
147 | 427 /* |
428 * Returns the DSI (data search information) structure associated | |
66
2bd4a78eefce
Patch from aschultz@cs.uni-magdeburg.de to allow for still-frame 'peek-ahead'
richwareham
parents:
60
diff
changeset
|
429 * with the current position. |
2bd4a78eefce
Patch from aschultz@cs.uni-magdeburg.de to allow for still-frame 'peek-ahead'
richwareham
parents:
60
diff
changeset
|
430 * |
147 | 431 * Read the general notes above. |
432 * See also libdvdreads nav_types.h for definition of dsi_t. | |
66
2bd4a78eefce
Patch from aschultz@cs.uni-magdeburg.de to allow for still-frame 'peek-ahead'
richwareham
parents:
60
diff
changeset
|
433 */ |
2bd4a78eefce
Patch from aschultz@cs.uni-magdeburg.de to allow for still-frame 'peek-ahead'
richwareham
parents:
60
diff
changeset
|
434 dsi_t* dvdnav_get_current_nav_dsi(dvdnav_t *self); |
2bd4a78eefce
Patch from aschultz@cs.uni-magdeburg.de to allow for still-frame 'peek-ahead'
richwareham
parents:
60
diff
changeset
|
435 |
147 | 436 /* |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
437 * Get the area associated with a certain button. |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
438 */ |
147 | 439 dvdnav_status_t dvdnav_get_highlight_area(pci_t *nav_pci , int32_t button, int32_t mode, |
440 dvdnav_highlight_area_t *highlight); | |
0 | 441 |
147 | 442 /* |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
443 * Move button highlight around as suggested by function name (e.g. with arrow keys). |
0 | 444 */ |
98 | 445 dvdnav_status_t dvdnav_upper_button_select(dvdnav_t *self, pci_t *pci); |
446 dvdnav_status_t dvdnav_lower_button_select(dvdnav_t *self, pci_t *pci); | |
447 dvdnav_status_t dvdnav_right_button_select(dvdnav_t *self, pci_t *pci); | |
448 dvdnav_status_t dvdnav_left_button_select(dvdnav_t *self, pci_t *pci); | |
0 | 449 |
147 | 450 /* |
451 * Activate ("press") the currently highlighted button. | |
0 | 452 */ |
98 | 453 dvdnav_status_t dvdnav_button_activate(dvdnav_t *self, pci_t *pci); |
0 | 454 |
147 | 455 /* |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
456 * Highlight a specific button. |
0 | 457 */ |
98 | 458 dvdnav_status_t dvdnav_button_select(dvdnav_t *self, pci_t *pci, int button); |
0 | 459 |
147 | 460 /* |
461 * Activate ("press") specified button. | |
0 | 462 */ |
98 | 463 dvdnav_status_t dvdnav_button_select_and_activate(dvdnav_t *self, pci_t *pci, int button); |
0 | 464 |
147 | 465 /* |
91
df9712507b30
Add a new API function, to allow for more flexible menu button control.
jcdutton
parents:
90
diff
changeset
|
466 * Activate (press) a button and execute specified command. |
df9712507b30
Add a new API function, to allow for more flexible menu button control.
jcdutton
parents:
90
diff
changeset
|
467 */ |
df9712507b30
Add a new API function, to allow for more flexible menu button control.
jcdutton
parents:
90
diff
changeset
|
468 dvdnav_status_t dvdnav_button_activate_cmd(dvdnav_t *self, int32_t button, vm_cmd_t *cmd); |
df9712507b30
Add a new API function, to allow for more flexible menu button control.
jcdutton
parents:
90
diff
changeset
|
469 |
147 | 470 /* |
471 * Select button at specified video frame coordinates. | |
0 | 472 */ |
98 | 473 dvdnav_status_t dvdnav_mouse_select(dvdnav_t *self, pci_t *pci, int x, int y); |
0 | 474 |
147 | 475 /* |
476 * Activate ("press") button at specified video frame coordinates. | |
0 | 477 */ |
98 | 478 dvdnav_status_t dvdnav_mouse_activate(dvdnav_t *self, pci_t *pci, int x, int y); |
0 | 479 |
147 | 480 |
481 /********************************************************************* | |
482 * languages * | |
483 *********************************************************************/ | |
484 | |
485 /* | |
486 * The language codes expected by these functions are two character | |
487 * codes as defined in ISO639. | |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
488 */ |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
489 |
147 | 490 /* |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
491 * Set which menu language we should use. |
0 | 492 */ |
44 | 493 dvdnav_status_t dvdnav_menu_language_select(dvdnav_t *self, |
494 char *code); | |
495 | |
147 | 496 /* |
44 | 497 * Set which audio language we should use. |
498 */ | |
499 dvdnav_status_t dvdnav_audio_language_select(dvdnav_t *self, | |
500 char *code); | |
501 | |
147 | 502 /* |
44 | 503 * Set which spu language we should use. |
504 */ | |
505 dvdnav_status_t dvdnav_spu_language_select(dvdnav_t *self, | |
0 | 506 char *code); |
507 | |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
508 |
147 | 509 /********************************************************************* |
510 * obtaining stream attributes * | |
511 *********************************************************************/ | |
0 | 512 |
147 | 513 /* |
514 * Return a string describing the title of the DVD. | |
515 * This is an ID string encoded on the disc by the author. In many cases | |
516 * this is a descriptive string such as `THE_MATRIX' but sometimes is sigularly | |
517 * uninformative such as `PDVD-011421'. Some DVD authors even forget to set this, | |
518 * so you may also read the default of the authoring software they used, like | |
519 * `DVDVolume'. | |
0 | 520 */ |
147 | 521 dvdnav_status_t dvdnav_get_title_string(dvdnav_t *self, const char **title_str); |
0 | 522 |
147 | 523 /* |
524 * Get video aspect code. | |
525 * The aspect code does only change on VTS boundaries. | |
526 * See the DVDNAV_VTS_CHANGE event. | |
527 * | |
528 * 0 -- 4:3, 2 -- 16:9 | |
0 | 529 */ |
147 | 530 uint8_t dvdnav_get_video_aspect(dvdnav_t *self); |
0 | 531 |
147 | 532 /* |
533 * Get video scaling permissions. | |
534 * The scaling permission does only change on VTS boundaries. | |
535 * See the DVDNAV_VTS_CHANGE event. | |
0 | 536 * |
147 | 537 * bit0 set = deny letterboxing, bit1 set = deny pan&scan |
0 | 538 */ |
147 | 539 uint8_t dvdnav_get_video_scale_permission(dvdnav_t *self); |
0 | 540 |
147 | 541 /* |
542 * Converts a *logical* audio stream id into language code | |
543 * (returns 0xffff if no such stream). | |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
544 */ |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
545 uint16_t dvdnav_audio_stream_to_lang(dvdnav_t *self, uint8_t stream); |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
546 |
147 | 547 /* |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
548 * Converts a *logical* subpicture stream id into country code |
147 | 549 * (returns 0xffff if no such stream). |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
550 */ |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
551 uint16_t dvdnav_spu_stream_to_lang(dvdnav_t *self, uint8_t stream); |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
552 |
147 | 553 /* |
554 * Converts a *physical* (MPEG) audio stream id into a logical stream number. | |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
555 */ |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
556 int8_t dvdnav_get_audio_logical_stream(dvdnav_t *self, uint8_t audio_num); |
0 | 557 |
147 | 558 /* |
559 * Converts a *physical* (MPEG) subpicture stream id into a logical stream number. | |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
560 */ |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
561 int8_t dvdnav_get_spu_logical_stream(dvdnav_t *self, uint8_t subp_num); |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
562 |
147 | 563 /* |
114 | 564 * Get active audio stream. |
565 */ | |
566 int8_t dvdnav_get_active_audio_stream(dvdnav_t *self); | |
567 | |
147 | 568 /* |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
569 * Get active spu stream. |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
570 */ |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
571 int8_t dvdnav_get_active_spu_stream(dvdnav_t *self); |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
572 |
147 | 573 |
574 /********************************************************************* | |
575 * multiple angles * | |
576 *********************************************************************/ | |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
577 |
147 | 578 /* |
579 * The libdvdnav library abstracts away the difference between seamless and | |
580 * non-seamless angles. From the point of view of the programmer you just set the | |
581 * angle number and all is well in the world. You will always see only the | |
582 * selected angle coming from the get_next_block functions. | |
0 | 583 * |
147 | 584 * Note: |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
585 * It is quite possible that some tremendously strange DVD feature might change the |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
586 * angle number from under you. Generally you should always view the results from |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
587 * dvdnav_get_angle_info() as definitive only up to the next time you call |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
588 * dvdnav_get_next_block(). |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
589 */ |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
590 |
147 | 591 /* |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
592 * Sets the current angle. If you try to follow a non existant angle |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
593 * the call fails. |
0 | 594 */ |
595 dvdnav_status_t dvdnav_angle_change(dvdnav_t *self, int angle); | |
596 | |
147 | 597 /* |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
598 * Returns the current angle and number of angles present. |
0 | 599 */ |
147 | 600 dvdnav_status_t dvdnav_get_angle_info(dvdnav_t *self, int *current_angle, |
114 | 601 int *number_of_angles); |
66
2bd4a78eefce
Patch from aschultz@cs.uni-magdeburg.de to allow for still-frame 'peek-ahead'
richwareham
parents:
60
diff
changeset
|
602 |
147 | 603 /********************************************************************* |
604 * domain queries * | |
605 *********************************************************************/ | |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
606 |
147 | 607 /* |
608 * Are we in the First Play domain? | |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
609 */ |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
610 int8_t dvdnav_is_domain_fp(dvdnav_t *self); |
114 | 611 |
147 | 612 /* |
613 * Are we in the Video management Menu domain? | |
0 | 614 */ |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
615 int8_t dvdnav_is_domain_vmgm(dvdnav_t *self); |
114 | 616 |
147 | 617 /* |
618 * Are we in the Video Title Menu domain? | |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
619 */ |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
620 int8_t dvdnav_is_domain_vtsm(dvdnav_t *self); |
114 | 621 |
147 | 622 /* |
623 * Are we in the Video Title Set domain? | |
43
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
624 */ |
0ba15bf3dc25
Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.
richwareham
parents:
22
diff
changeset
|
625 int8_t dvdnav_is_domain_vts(dvdnav_t *self); |
0 | 626 |
627 | |
5
c1b55dc1bfed
Add API call to get number of programmes in current title.
richwareham
parents:
4
diff
changeset
|
628 #ifdef __cplusplus |
c1b55dc1bfed
Add API call to get number of programmes in current title.
richwareham
parents:
4
diff
changeset
|
629 } |
c1b55dc1bfed
Add API call to get number of programmes in current title.
richwareham
parents:
4
diff
changeset
|
630 #endif |
c1b55dc1bfed
Add API call to get number of programmes in current title.
richwareham
parents:
4
diff
changeset
|
631 |
0 | 632 #endif /* DVDNAV_H_INCLUDED */ |