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