add a return code to ddvd_run()
[libdreamdvd.git] / ddvdlib.h
1 /* 
2  * DreamDVD V0.9 - DVD-Player for Dreambox
3  * Copyright (C) 2007 by Seddi
4  * 
5  * This DVD Player is based upon the great work from the libdvdnav project,
6  * a52dec library, ffmpeg and the knowledge from all the people who made 
7  * watching DVD within linux possible.
8  * 
9  * DreamDVD is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  * 
14  * DreamDVD is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  * 
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA
22  *
23  * part of libdreamdvd
24  */
25
26
27 /*
28  * main struct for ddvd handle
29  */
30 struct ddvd; 
31
32 enum ddvd_result {
33         DDVD_OK = 0,
34         DDVD_INVAL,
35         DDVD_NOMEM,
36         DDVD_BUSY,
37         DDVD_FAIL_OPEN,
38         DDVD_FAIL_PREFS,
39         DDVD_FAIL_READ,
40         DDVD_RESULT_MAX,
41 };
42
43 /* 
44  * functions for initialization and setting options DONT USE THIS FUNCTIONS AFTER STARTING WITH ddvd_run !!!
45  */
46
47 // create a ddvd handle with default options PAL, 4:3 LB, EN, AC3 decoding internal (if liba52 is available)
48 struct ddvd *ddvd_create(void);
49
50 // get message_pipe fd to make polling possible
51 int ddvd_get_messagepipe_fd(struct ddvd *pconfig);
52
53 // set framebuffer and options libdreamdvd should render buttons and subtitles
54 // until this option ist set, ddvd_run will not start playing
55 // lfb-> needs a pointer to the real framebuffer or to a backbuffer
56 // xres, yres-> screen resolution, normally 720x576 libdreamdvd will NOT scale inside 
57 // bypp-> bytes per pixel, only 1 (8bit) or 4 (32bit argb) is supported
58 // stride-> line length in bytes, normally xres*bypp but not always like on the DM7025
59 void ddvd_set_lfb(struct ddvd *pconfig, unsigned char *lfb, int xres, int yres, int bypp, int stride);
60
61 // set path to a dvd block device, a dvd file structure or an dvd iso-file ("/dev/dvd" ...)
62 void ddvd_set_dvd_path(struct ddvd *pconfig, const char *path);
63
64 // set preferred dvd language in 2 letter iso code (en,de, ...)
65 void ddvd_set_language(struct ddvd *pconfig, const char lang[2]);
66
67 // set external/internal AC3 decoding 0-> external 1-> internal
68 // internal decoding needs liba52 which will be loaded dynamically if available
69 // if set to "internal" and liba52 will not be found, the AC3 data will be passed thru 
70 void ddvd_set_ac3thru(struct ddvd *pconfig, int ac3thru);
71
72 // set video options for aspect and the tv system, see enums for possible options
73 void ddvd_set_video(struct ddvd *pconfig, int aspect, int tv_system);
74
75
76 /* 
77  * functions for starting the dvd player
78  */
79
80 // starting playback, this function should be started inside a thread, because it only comes back after
81 // stopping the dvd player
82 enum ddvd_result ddvd_run(struct ddvd *pconfig);
83
84
85 /* 
86  * functions for controlling the player while running, these functions are THREAD SAFE (or lets say I hope so ;-)
87  */
88
89 // send a remote control key or command to the player, see send_key enum for possible commands
90 void ddvd_send_key(struct ddvd *pconfig, int key);
91
92 // skip n seconds in playing n>0 forward - n<0 backward
93 void ddvd_skip_seconds(struct ddvd *pconfig, int seconds);
94
95 // jump to beginning of given title
96 void ddvd_set_title(struct ddvd *pconfig, int title);
97
98 // jump to beginning of given chapter
99 void ddvd_set_chapter(struct ddvd *pconfig, int chapter);
100
101 // get and process the next message from the main player
102 // use blocked=1 if the function should wait till a message has received, blocked=0 will return
103 // immediatly and give you DDVD_NULL if there was no messag in the pipe
104 // blocked=0 will be usefull if the main programm runs a loop, blocked=1 if you use fd-polling 
105 int ddvd_get_next_message(struct ddvd*pconfig, int blocked);
106
107 // get last colortable for 8bit mode (4 colors)
108 // will give you 4 color structs as array, remember to use the offset (see state enum)
109 // struct ddvd_color colortable[4] 
110 void ddvd_get_last_colortable(struct ddvd*pconfig, void *colortable);
111
112 // get last received playing time
113 // struct ddvd_time timestamp
114 void ddvd_get_last_time(struct ddvd*pconfig, void *timestamp);
115
116 // get the actual trickspeed (2-64x) when in trickmode
117 // int trickspeed
118 void ddvd_get_last_trickspeed(struct ddvd*pconfig, void *trickspeed);
119
120 // get last text message from player
121 // char text[512]
122 void ddvd_get_last_string(struct ddvd*pconfig, void *text);
123
124 // get the active audio track
125 // int id -> logical track number
126 // uint16_t lang -> audio language in 2 letter iso code
127 // int type -> audio type, see audio type enum (ac3,mpeg,...)
128 void ddvd_get_last_audio(struct ddvd*pconfig, void *id, void *lang, void *type);
129
130 // get the active subtitle track
131 // int id -> logical track number
132 // uint16_t lang -> subtitle language in 2 letter iso code
133 // id=-1 means no subtitle track active
134 void ddvd_get_last_spu(struct ddvd*pconfig, void *id, void *lang);
135
136 void ddvd_get_title_string(struct ddvd*pconfig, char *title_string);
137
138 /* 
139  * functions for clean up AFTER the player had stopped
140  */
141
142 // destroy ddvd handle, do NOT call this while the player is still running
143 // to stop the player you can send the DDVD_KEY_EXIT command via ddvd_send_key
144 void ddvd_close(struct ddvd *pconfig);
145
146
147 /* 
148  * messages recieved from ddvd_get_next_message
149  */
150
151 enum { // state
152         DDVD_NULL,                                      // nothing to do
153         DDVD_COLORTABLE_UPDATE,         // if we are in 8bit graphics mode we have to renew the color table, the color table can be grabbed with
154                                                                 // ddvd_get_last_colortable function, we need an offset of 252d, means the first struct in the array should be set to 252d in 
155                                                                 // the real colortable, the second struct to 253d and so on, this message will never been send in 32bit mode 
156                                                                 // ATTENTION to clear screen, libdreamdvd uses color 0, so be sure to set color 0 in the host-application to full transparency
157         DDVD_SCREEN_UPDATE,                     // libdreamdvd rendered something to the given framebuffer, so if we are working with a backbuffer in the host app,
158                                                                 // we have to update our screen. can be ignored if libdreamdvd renders directly to the real framebuffer
159         DDVD_SHOWOSD_STATE_PLAY,        // we should display a state icon or text (play, pause, ...) on osd 
160         DDVD_SHOWOSD_STATE_PAUSE,
161         DDVD_SHOWOSD_TIME,                      // we should display the playing time on osd you can get the time with ddvd_get_last_time
162         DDVD_SHOWOSD_STATE_FFWD,        // we should display FFWD/FBWD trickmode on osd you can grab the actual time with ddvd_get_last_time
163         DDVD_SHOWOSD_STATE_FBWD,        // and the trickspeed with ddvd_get_last_trickspeed
164         DDVD_SHOWOSD_STRING,            // we should display a text on osd (errors, ...) the text can be read with ddvd_get_last_string
165         DDVD_SHOWOSD_AUDIO,                     // new audio track selected you can get the audio id, language, type with ddvd_get_last_audio
166         DDVD_SHOWOSD_SUBTITLE,          // new subtitle track selected you can get the spu id, language with ddvd_get_last_spu
167         DDVD_SHOWOSD_TITLESTRING,       
168         DDVD_EOF_REACHED,
169         DDVD_SOF_REACHED,
170         DDVD_MENU_OPENED,
171         DDVD_MENU_CLOSED,
172 };
173
174
175 /* 
176  * key/commands to send with ddvd_send_key
177  */
178
179 enum { // send_key
180         DDVD_KEY_NULL,                          // will be ignored
181         DDVD_KEY_EXIT,                          // stop end exit the player as fast as possible
182         
183                                                                 /* menus*/
184         DDVD_KEY_LEFT,                          // cursor control
185         DDVD_KEY_RIGHT,
186         DDVD_KEY_UP,
187         DDVD_KEY_DOWN,
188         DDVD_KEY_OK,                            // activate button
189
190                                                                 /* inside movie */
191         DDVD_KEY_PLAY,                          // resume playing if we are "paused" or used any ffwd/fbwd before
192         DDVD_KEY_PAUSE,                         // pause playing (still picture)
193         DDVD_KEY_NEXT_CHAPTER,                  // jump to next chapter
194         DDVD_KEY_PREV_CHAPTER,                  // jump to previous chapter
195         DDVD_KEY_NEXT_TITLE,                    // jump to next title
196         DDVD_KEY_PREV_TITLE,                    // jump to previous title
197         DDVD_KEY_FFWD,                          // start or speed up fast forward mode 
198         DDVD_KEY_FBWD,                          // start or speed up fast backward mode 
199         DDVD_KEY_MENU,                          // jump into the dvd menu 
200         DDVD_KEY_AUDIOMENU,                     // jump into the dvd audio menu
201         DDVD_KEY_AUDIO,                         // change audio track on the fly 
202         DDVD_KEY_SUBTITLE,                      // change subtitle track on the fly 
203         DDVD_GET_TIME,                          // get actual playing time (see struct ddvd_time) 
204         DDVD_SKIP_FWD,                          // jump forward in playing SHOULD NOT BE USED DIRECTLY, USE ddvd_skip_seconds FOR SKIPPING
205         DDVD_SKIP_BWD,                          // jump backward in playing SHOULD NOT BE USED DIRECTLY, USE ddvd_skip_seconds FOR SKIPPING 
206         DDVD_SET_TITLE,                         // jump to given title
207         DDVD_SET_CHAPTER,                       // jump to given chapter
208         DDVD_SEEK_ABS,                          // seek to given absolute seconds (from beginning of current title)
209         DDVD_SET_MUTE,                          // just telling dreamdvd that the sound has been muted, libdreamdvd does not mute for you, but has to know
210                                                                 // the mute state for sound handling on ffwd/fbwd trick mode
211         DDVD_UNSET_MUTE,                        // sound is not muted any more (see DDVD_SET_MUTE)
212 };
213
214 // if you use the same keys for different functions in different contexts (menu/movie) just send both commands, the player will 
215 // choose the right one and ignore the other. For example you want to use the right cursor key for "right" in menu and "next chapter" in movie,
216 // so you have to send both when you received the key event for your "right cursor key": DDVD_KEY_RIGHT and DDVD_KEY_NEXT_CHAPTER
217
218
219 /* 
220  * config and state enums
221  */
222
223 enum { // audio types
224         DDVD_AC3,
225         DDVD_MPEG,
226         DDVD_DTS,
227         DDVD_LPCM,
228 };
229
230 enum { // tv system
231         DDVD_PAL,
232         DDVD_NTSC,
233 };
234
235 enum { // aspect
236         DDVD_4_3_LETTERBOX,
237         DDVD_4_3_PAN_SCAN,
238         DDVD_16_9,
239         DDVD_16_9_ALWAYS,
240 };
241
242
243 /* 
244  * structs for color palette and osd time 
245  */
246
247 struct ddvd_color { 
248         unsigned short red;     
249         unsigned short green;
250         unsigned short blue;
251         unsigned short trans;
252 };
253
254 struct ddvd_time {
255         int pos_hours;                          // pos_hours:pos_minutes:pos_seconds -> time already played
256         int pos_minutes;                        // end_hours:end_minutes:end_seconds -> total time of the playing programm
257         int pos_seconds;                        // pos_chapter -> chapter no. we are just playing
258         int pos_chapter;                        // end_chapter -> total chapters of the playing programm
259         int pos_title;
260         int end_hours;
261         int end_minutes;
262         int end_seconds;
263         int end_chapter;
264         int end_title;
265 };