Mercurial > libdvdnav.hg
comparison dvdnav_events.h @ 43:0ba15bf3dc25 src
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.
author | richwareham |
---|---|
date | Thu, 06 Jun 2002 15:03:09 +0000 |
parents | 3c1df0cb3aee |
children | 5674fbd44f26 |
comparison
equal
deleted
inserted
replaced
42:131ad65a2398 | 43:0ba15bf3dc25 |
---|---|
26 | 26 |
27 #include <dvdread/ifo_types.h> | 27 #include <dvdread/ifo_types.h> |
28 #include <dvdread/nav_types.h> | 28 #include <dvdread/nav_types.h> |
29 #include <dvdread/dvd_reader.h> | 29 #include <dvdread/dvd_reader.h> |
30 | 30 |
31 /* This header defines events and event types */ | 31 /** |
32 * \file dvdnav_events.h | |
33 * This header defines events and event types | |
34 */ | |
32 | 35 |
33 /*** EVENTS ***/ | 36 /*** EVENTS ***/ |
34 | 37 |
35 #define DVDNAV_BLOCK_OK 0 /* The next black was returned */ | 38 #define DVDNAV_BLOCK_OK 0 /*!< The next black was returned */ |
36 #define DVDNAV_NOP 1 /* No action should be taken */ | 39 #define DVDNAV_NOP 1 /*!< No action should be taken */ |
37 #define DVDNAV_STILL_FRAME 2 /* The preceeding block was the last in a | 40 #define DVDNAV_STILL_FRAME 2 /*!< The preceeding block was the last in a |
38 still frame. */ | 41 still frame. */ |
39 #define DVDNAV_SPU_STREAM_CHANGE 3 /* The SPU stream was changed */ | 42 #define DVDNAV_SPU_STREAM_CHANGE 3 /*!< The SPU stream was changed */ |
40 #define DVDNAV_AUDIO_STREAM_CHANGE 4 /* The Audio stream was changed */ | 43 #define DVDNAV_AUDIO_STREAM_CHANGE 4 /*!< The Audio stream was changed */ |
41 #define DVDNAV_VTS_CHANGE 5 /* We have changed VTS */ | 44 #define DVDNAV_VTS_CHANGE 5 /*!< We have changed VTS */ |
42 #define DVDNAV_CELL_CHANGE 6 /* We have jumped to a new cell */ | 45 #define DVDNAV_CELL_CHANGE 6 /*!< We have jumped to a new cell */ |
43 #define DVDNAV_NAV_PACKET 7 /* The packet just passed was the NAV packet */ | 46 #define DVDNAV_NAV_PACKET 7 /*!< The packet just passed was the NAV packet */ |
44 #define DVDNAV_STOP 8 /* The last block was final, no more are coming */ | 47 #define DVDNAV_STOP 8 /*!< The last block was final, no more are coming */ |
45 #define DVDNAV_HIGHLIGHT 9 /* Change highlight region */ | 48 #define DVDNAV_HIGHLIGHT 9 /*!< Change highlight region */ |
46 #define DVDNAV_SPU_CLUT_CHANGE 10 /* SPU CLUT */ | 49 #define DVDNAV_SPU_CLUT_CHANGE 10 /*!< SPU CLUT */ |
47 #define DVDNAV_SEEK_DONE 11 /* Seek done, subtitles should be reset */ | 50 #define DVDNAV_SEEK_DONE 11 /*!< Seek done, subtitles should be reset */ |
48 #define DVDNAV_HOP_CHANNEL 12 /* Sent when non-seemless stream change has happed */ | 51 #define DVDNAV_HOP_CHANNEL 12 /*!< Sent when non-seemless stream change has happed |
49 /* E.g. Menu button pressed causing change in menu */ | 52 E.g. Menu button pressed causing change in menu */ |
50 | 53 |
51 /*** EVENT TYPES ***/ | 54 /*** EVENT TYPES ***/ |
52 | 55 |
56 /** | |
57 * Structure providing information on DVDNAV_STILL_FRAME events. | |
58 */ | |
53 typedef struct { | 59 typedef struct { |
54 int length; /* The length (in seconds) the still frame | 60 int length; /*!< |
55 * should be displayed for, or 0xff if | 61 The length (in seconds) the still frame |
56 * indefinate. */ | 62 should be displayed for, or 0xff if |
63 indefinate. */ | |
57 } dvdnav_still_event_t; | 64 } dvdnav_still_event_t; |
58 | 65 |
66 /** | |
67 * Structure providing information on DVDNAV_*_STREAM_CHANGE events. | |
68 */ | |
59 typedef struct { | 69 typedef struct { |
60 int physical; /* The physical (MPEG) stream number. */ | 70 int physical; /*!< The physical (MPEG) stream number. */ |
61 int logical; /* The logical (DVD) stream number. */ | 71 int logical; /*!< The logical (DVD) stream number. */ |
62 } dvdnav_stream_change_event_t; | 72 } dvdnav_stream_change_event_t; |
63 | 73 |
74 /** | |
75 * Structure providing information on DVDNAV_VTS_CHANGE events. | |
76 */ | |
64 typedef struct { | 77 typedef struct { |
65 int old_vtsN; /* The old VTS number */ | 78 int old_vtsN; /*!< The old VTS number */ |
66 dvd_read_domain_t old_domain; /* The old domain */ | 79 dvd_read_domain_t old_domain; /*!< The old domain */ |
67 int new_vtsN; /* The new one */ | 80 int new_vtsN; /*!< The new VTS number */ |
68 dvd_read_domain_t new_domain; | 81 dvd_read_domain_t new_domain; /*!< The new domain */ |
69 } dvdnav_vts_change_event_t; | 82 } dvdnav_vts_change_event_t; |
70 | 83 |
84 /** | |
85 * Structure providing information on DVDNAV_CELL_CHANGE events. | |
86 */ | |
71 typedef struct { | 87 typedef struct { |
72 cell_playback_t *old_cell; /* The old cell (or NULL if this is | 88 cell_playback_t *old_cell; /*!< The old cell (or NULL if this is |
73 the first cell) */ | 89 the first cell) */ |
74 cell_playback_t *new_cell; /* The cell_playback_t for the new cell */ | 90 cell_playback_t *new_cell; /*!< The cell_playback_t for the new cell */ |
75 } dvdnav_cell_change_event_t; | 91 } dvdnav_cell_change_event_t; |
76 | 92 |
93 /** | |
94 * Structure providing information on DVDNAV_NAV_PACKET events. | |
95 */ | |
77 typedef struct { | 96 typedef struct { |
78 pci_t *pci; | 97 pci_t *pci; |
79 dsi_t *dsi; | 98 dsi_t *dsi; |
80 } dvdnav_nav_packet_event_t; | 99 } dvdnav_nav_packet_event_t; |
81 | 100 |
101 /** | |
102 * Structure providing information on DVDNAV_HIGHLIGHT events. | |
103 */ | |
82 typedef struct { | 104 typedef struct { |
83 int display; /* 0 - hide, 1 - show, entries below only guaranteed useful | 105 int display; /*!< 0 - hide, 1 - show, entries below only guaranteed useful |
84 if this is '1' */ | 106 if this is '1' */ |
85 uint32_t palette; /* The CLUT entries for the highlight palette | 107 uint32_t palette; /*!< The CLUT entries for the highlight palette |
86 (4-bits per entry -> 4 entries) */ | 108 (4-bits per entry -> 4 entries) */ |
87 uint16_t sx,sy,ex,ey; /* The start/end x,y positions */ | 109 uint16_t sx,sy,ex,ey; /*!< The start/end x,y positions */ |
88 uint32_t pts; /* Highlight PTS to match with SPU */ | 110 uint32_t pts; /*!< Highlight PTS to match with SPU */ |
89 uint32_t buttonN; /* Button number for the SPU decoder. */ | 111 uint32_t buttonN; /*!< Button number for the SPU decoder. */ |
90 } dvdnav_highlight_event_t; | 112 } dvdnav_highlight_event_t; |
91 | 113 |
92 #endif /* DVDNAV_EVENTS_H_INCLUDED */ | 114 #endif /* DVDNAV_EVENTS_H_INCLUDED */ |