-adding functions for resuming dvds
[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 // set resume postion for dvd start
76 void ddvd_set_resume_pos(struct ddvd *pconfig, int title, int chapter, uint32_t block);
77
78 /* 
79  * functions for starting the dvd player
80  */
81
82 // starting playback, this function should be started inside a thread, because it only comes back after
83 // stopping the dvd player
84 enum ddvd_result ddvd_run(struct ddvd *pconfig);
85
86
87 /* 
88  * functions for controlling the player while running, these functions are THREAD SAFE (or lets say I hope so ;-)
89  */
90
91 // send a remote control key or command to the player, see send_key enum for possible commands
92 void ddvd_send_key(struct ddvd *pconfig, int key);
93
94 // skip n seconds in playing n>0 forward - n<0 backward
95 void ddvd_skip_seconds(struct ddvd *pconfig, int seconds);
96
97 // jump to beginning of given title
98 void ddvd_set_title(struct ddvd *pconfig, int title);
99
100 // jump to beginning of given chapter
101 void ddvd_set_chapter(struct ddvd *pconfig, int chapter);
102
103 // get and process the next message from the main player
104 // use blocked=1 if the function should wait till a message has received, blocked=0 will return
105 // immediatly and give you DDVD_NULL if there was no messag in the pipe
106 // blocked=0 will be usefull if the main programm runs a loop, blocked=1 if you use fd-polling 
107 int ddvd_get_next_message(struct ddvd*pconfig, int blocked);
108
109 // get last colortable for 8bit mode (4 colors)
110 // will give you 4 color structs as array, remember to use the offset (see state enum)
111 // struct ddvd_color colortable[4] 
112 void ddvd_get_last_colortable(struct ddvd*pconfig, void *colortable);
113
114 // get last received playing time
115 // struct ddvd_time timestamp
116 void ddvd_get_last_time(struct ddvd*pconfig, void *timestamp);
117
118 // get the actual trickspeed (2-64x) when in trickmode
119 // int trickspeed
120 void ddvd_get_last_trickspeed(struct ddvd*pconfig, void *trickspeed);
121
122 // get last text message from player
123 // char text[512]
124 void ddvd_get_last_string(struct ddvd*pconfig, void *text);
125
126 // get the active audio track
127 // int id -> logical track number
128 // uint16_t lang -> audio language in 2 letter iso code
129 // int type -> audio type, see audio type enum (ac3,mpeg,...)
130 void ddvd_get_last_audio(struct ddvd*pconfig, void *id, void *lang, void *type);
131
132 // get the active subtitle track
133 // int id -> logical track number
134 // uint16_t lang -> subtitle language in 2 letter iso code
135 // id=-1 means no subtitle track active
136 void ddvd_get_last_spu(struct ddvd*pconfig, void *id, void *lang);
137
138 // get dvd title string
139 void ddvd_get_title_string(struct ddvd*pconfig, char *title_string);
140
141 // get last received position for resume
142 void ddvd_get_resume_pos(struct ddvd*pconfig, int *title, int *chapter, uint32_t *block);
143
144 /* 
145  * functions for clean up AFTER the player had stopped
146  */
147
148 // destroy ddvd handle, do NOT call this while the player is still running
149 // to stop the player you can send the DDVD_KEY_EXIT command via ddvd_send_key
150 void ddvd_close(struct ddvd *pconfig);
151
152
153 /* 
154  * messages recieved from ddvd_get_next_message
155  */
156
157 enum { // state
158         DDVD_NULL,                                      // nothing to do
159         DDVD_COLORTABLE_UPDATE,         // if we are in 8bit graphics mode we have to renew the color table, the color table can be grabbed with
160                                                                 // ddvd_get_last_colortable function, we need an offset of 252d, means the first struct in the array should be set to 252d in 
161                                                                 // the real colortable, the second struct to 253d and so on, this message will never been send in 32bit mode 
162                                                                 // ATTENTION to clear screen, libdreamdvd uses color 0, so be sure to set color 0 in the host-application to full transparency
163         DDVD_SCREEN_UPDATE,                     // libdreamdvd rendered something to the given framebuffer, so if we are working with a backbuffer in the host app,
164                                                                 // we have to update our screen. can be ignored if libdreamdvd renders directly to the real framebuffer
165         DDVD_SHOWOSD_STATE_PLAY,        // we should display a state icon or text (play, pause, ...) on osd 
166         DDVD_SHOWOSD_STATE_PAUSE,
167         DDVD_SHOWOSD_TIME,                      // we should display the playing time on osd you can get the time with ddvd_get_last_time
168         DDVD_SHOWOSD_STATE_FFWD,        // we should display FFWD/FBWD trickmode on osd you can grab the actual time with ddvd_get_last_time
169         DDVD_SHOWOSD_STATE_FBWD,        // and the trickspeed with ddvd_get_last_trickspeed
170         DDVD_SHOWOSD_STRING,            // we should display a text on osd (errors, ...) the text can be read with ddvd_get_last_string
171         DDVD_SHOWOSD_AUDIO,                     // new audio track selected you can get the audio id, language, type with ddvd_get_last_audio
172         DDVD_SHOWOSD_SUBTITLE,          // new subtitle track selected you can get the spu id, language with ddvd_get_last_spu
173         DDVD_SHOWOSD_TITLESTRING,       
174         DDVD_EOF_REACHED,
175         DDVD_SOF_REACHED,
176         DDVD_MENU_OPENED,
177         DDVD_MENU_CLOSED,
178 };
179
180
181 /* 
182  * key/commands to send with ddvd_send_key
183  */
184
185 enum { // send_key
186         DDVD_KEY_NULL,                          // will be ignored
187         DDVD_KEY_EXIT,                          // stop end exit the player as fast as possible
188         
189                                                                 /* menus*/
190         DDVD_KEY_LEFT,                          // cursor control
191         DDVD_KEY_RIGHT,
192         DDVD_KEY_UP,
193         DDVD_KEY_DOWN,
194         DDVD_KEY_OK,                            // activate button
195
196                                                                 /* inside movie */
197         DDVD_KEY_PLAY,                          // resume playing if we are "paused" or used any ffwd/fbwd before
198         DDVD_KEY_PAUSE,                         // pause playing (still picture)
199         DDVD_KEY_NEXT_CHAPTER,                  // jump to next chapter
200         DDVD_KEY_PREV_CHAPTER,                  // jump to previous chapter
201         DDVD_KEY_NEXT_TITLE,                    // jump to next title
202         DDVD_KEY_PREV_TITLE,                    // jump to previous title
203         DDVD_KEY_FFWD,                          // start or speed up fast forward mode 
204         DDVD_KEY_FBWD,                          // start or speed up fast backward mode 
205         DDVD_KEY_MENU,                          // jump into the dvd menu 
206         DDVD_KEY_AUDIOMENU,                     // jump into the dvd audio menu
207         DDVD_KEY_AUDIO,                         // change audio track on the fly 
208         DDVD_KEY_SUBTITLE,                      // change subtitle track on the fly 
209         DDVD_GET_TIME,                          // get actual playing time (see struct ddvd_time) 
210         DDVD_SKIP_FWD,                          // jump forward in playing SHOULD NOT BE USED DIRECTLY, USE ddvd_skip_seconds FOR SKIPPING
211         DDVD_SKIP_BWD,                          // jump backward in playing SHOULD NOT BE USED DIRECTLY, USE ddvd_skip_seconds FOR SKIPPING 
212         DDVD_SET_TITLE,                         // jump to given title
213         DDVD_SET_CHAPTER,                       // jump to given chapter
214         DDVD_SEEK_ABS,                          // seek to given absolute seconds (from beginning of current title)
215         DDVD_SET_MUTE,                          // just telling dreamdvd that the sound has been muted, libdreamdvd does not mute for you, but has to know
216                                                                 // the mute state for sound handling on ffwd/fbwd trick mode
217         DDVD_UNSET_MUTE,                        // sound is not muted any more (see DDVD_SET_MUTE)
218 };
219
220 // if you use the same keys for different functions in different contexts (menu/movie) just send both commands, the player will 
221 // 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,
222 // 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
223
224
225 /* 
226  * config and state enums
227  */
228
229 enum { // audio types
230         DDVD_AC3,
231         DDVD_MPEG,
232         DDVD_DTS,
233         DDVD_LPCM,
234 };
235
236 enum { // tv system
237         DDVD_PAL,
238         DDVD_NTSC,
239 };
240
241 enum { // aspect
242         DDVD_4_3_LETTERBOX,
243         DDVD_4_3_PAN_SCAN,
244         DDVD_16_9,
245         DDVD_16_9_ALWAYS,
246 };
247
248
249 /* 
250  * structs for color palette and osd time 
251  */
252
253 struct ddvd_color { 
254         unsigned short red;     
255         unsigned short green;
256         unsigned short blue;
257         unsigned short trans;
258 };
259
260 struct ddvd_time {
261         int pos_hours;                          // pos_hours:pos_minutes:pos_seconds -> time already played
262         int pos_minutes;                        // end_hours:end_minutes:end_seconds -> total time of the playing programm
263         int pos_seconds;                        // pos_chapter -> chapter no. we are just playing
264         int pos_chapter;                        // end_chapter -> total chapters of the playing programm
265         int pos_title;
266         int end_hours;
267         int end_minutes;
268         int end_seconds;
269         int end_chapter;
270         int end_title;
271 };