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