Mercurial > libdvdnav.hg
comparison dvdnav/dvdnav.h @ 414:a67a8292eefe src
Fix grammar in dvdnav.h
Mike Castle <dalgoda PLUS mplayer AT gmail DOT com> found a few grammar
issues in dvdnav.h.
author | erik |
---|---|
date | Sat, 26 Feb 2011 20:32:32 +0000 |
parents | f30f443d3841 |
children | d7720a050e67 |
comparison
equal
deleted
inserted
replaced
413:f30f443d3841 | 414:a67a8292eefe |
---|---|
202 int32_t *event, int32_t *len); | 202 int32_t *event, int32_t *len); |
203 | 203 |
204 /* | 204 /* |
205 * This basically does the same as dvdnav_get_next_block. The only difference is | 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. | 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 | 207 * In 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. | 208 * the one handed in, pointing directly into the relevant block in the cache. |
209 * Those pointers must _never_ be freed but instead returned to the library via | 209 * Those pointers must _never_ be freed but instead returned to the library via |
210 * dvdnav_free_cache_block(). | 210 * dvdnav_free_cache_block(). |
211 */ | 211 */ |
212 dvdnav_status_t dvdnav_get_next_cache_block(dvdnav_t *self, uint8_t **buf, | 212 dvdnav_status_t dvdnav_get_next_cache_block(dvdnav_t *self, uint8_t **buf, |
316 */ | 316 */ |
317 dvdnav_status_t dvdnav_menu_call(dvdnav_t *self, DVDMenuID_t menu); | 317 dvdnav_status_t dvdnav_menu_call(dvdnav_t *self, DVDMenuID_t menu); |
318 | 318 |
319 /* | 319 /* |
320 * Return the title number and part currently being played. | 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 | 321 * A title of 0 indicates we are in a menu. In this case, part |
322 * is set to the current menu's ID. | 322 * is set to the current menu's ID. |
323 */ | 323 */ |
324 dvdnav_status_t dvdnav_current_title_info(dvdnav_t *self, int32_t *title, | 324 dvdnav_status_t dvdnav_current_title_info(dvdnav_t *self, int32_t *title, |
325 int32_t *part); | 325 int32_t *part); |
326 | 326 |
358 /* | 358 /* |
359 * Stop playing the current position and start playback from the last | 359 * Stop playing the current position and start playback from the last |
360 * VOBU boundary before the given sector. The sector number is not | 360 * VOBU boundary before the given sector. The sector number is not |
361 * meant to be an absolute physical DVD sector, but a relative sector | 361 * meant to be an absolute physical DVD sector, but a relative sector |
362 * in the current program. This function cannot leave the current | 362 * in the current program. This function cannot leave the current |
363 * program and will fail, if asked to do so. | 363 * program and will fail if asked to do so. |
364 * | 364 * |
365 * If program chain based positioning is enabled | 365 * If program chain based positioning is enabled |
366 * (see dvdnav_set_PGC_positioning_flag()), this will seek to the relative | 366 * (see dvdnav_set_PGC_positioning_flag()), this will seek to the relative |
367 * sector inside the current program chain. | 367 * sector inside the current program chain. |
368 * | 368 * |
427 * menu highlights * | 427 * menu highlights * |
428 *********************************************************************/ | 428 *********************************************************************/ |
429 | 429 |
430 /* | 430 /* |
431 * Most functions related to highlights take a NAV PCI packet as a parameter. | 431 * Most functions related to highlights take a NAV PCI packet as a parameter. |
432 * While you can get the such a packet from libdvdnav, for players with internal | 432 * While you can get such a packet from libdvdnav, this will result in |
433 * FIFOs, this will result in errors, because due to the FIFO length, libdvdnav will | 433 * errors for players with internal FIFOs because due to the FIFO length, |
434 * be ahead in the stream compared to what the user is seeing on screen. | 434 * libdvdnav will be ahead in the stream compared to what the user is |
435 * Therefore, player applications who have a NAV packet available, which is | 435 * seeing on screen. Therefore, player applications who have a NAV |
436 * better in sync with the actual playback should always pass this one to these | 436 * packet available, which is better in sync with the actual playback, |
437 * functions. | 437 * should always pass this one to these functions. |
438 */ | 438 */ |
439 | 439 |
440 /* | 440 /* |
441 * Get the currently highlighted button | 441 * Get the currently highlighted button |
442 * number (1..36) or 0 if no button is highlighted. | 442 * number (1..36) or 0 if no button is highlighted. |
489 * Activate ("press") specified button. | 489 * Activate ("press") specified button. |
490 */ | 490 */ |
491 dvdnav_status_t dvdnav_button_select_and_activate(dvdnav_t *self, pci_t *pci, int32_t button); | 491 dvdnav_status_t dvdnav_button_select_and_activate(dvdnav_t *self, pci_t *pci, int32_t button); |
492 | 492 |
493 /* | 493 /* |
494 * Activate (press) a button and execute specified command. | 494 * Activate ("press") a button and execute specified command. |
495 */ | 495 */ |
496 dvdnav_status_t dvdnav_button_activate_cmd(dvdnav_t *self, int32_t button, vm_cmd_t *cmd); | 496 dvdnav_status_t dvdnav_button_activate_cmd(dvdnav_t *self, int32_t button, vm_cmd_t *cmd); |
497 | 497 |
498 /* | 498 /* |
499 * Select button at specified video frame coordinates. | 499 * Select button at specified video frame coordinates. |