DVB: privatize scan_t
[vlc.git] / modules / access / dvb / dvb.h
1 /*****************************************************************************
2  * dvb.h : functions to control a DVB card under Linux with v4l2
3  *****************************************************************************
4  * Copyright (C) 1998-2005 the VideoLAN team
5  *
6  * Authors: Johan Bilien <jobi@via.ecp.fr>
7  *          Jean-Paul Saman <jpsaman _at_ videolan _dot_ org>
8  *          Christopher Ross <chris@tebibyte.org>
9  *          Christophe Massiot <massiot@via.ecp.fr>
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.    See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA    02111, USA.
24  *****************************************************************************/
25
26 /*****************************************************************************
27  * Local structures
28  *****************************************************************************/
29 typedef struct demux_handle_t
30 {
31     int i_pid;
32     int i_handle;
33     int i_type;
34 } demux_handle_t;
35
36 typedef struct frontend_t frontend_t;
37 typedef struct
38 {
39     int i_snr;              /**< Signal Noise ratio */
40     int i_ber;              /**< Bitrate error ratio */
41     int i_signal_strenth;   /**< Signal strength */
42 } frontend_statistic_t;
43
44 typedef struct
45 {
46     bool b_has_signal;
47     bool b_has_carrier;
48     bool b_has_lock;
49 } frontend_status_t;
50
51 typedef struct scan_parameter_t scan_parameter_t;
52 typedef struct scan_t scan_t;
53
54 typedef struct en50221_session_t
55 {
56     int i_slot;
57     int i_resource_id;
58     void (* pf_handle)( access_t *, int, uint8_t *, int );
59     void (* pf_close)( access_t *, int );
60     void (* pf_manage)( access_t *, int );
61     void *p_sys;
62 } en50221_session_t;
63
64 #define EN50221_MMI_NONE 0
65 #define EN50221_MMI_ENQ 1
66 #define EN50221_MMI_ANSW 2
67 #define EN50221_MMI_MENU 3
68 #define EN50221_MMI_MENU_ANSW 4
69 #define EN50221_MMI_LIST 5
70
71 typedef struct en50221_mmi_object_t
72 {
73     int i_object_type;
74
75     union
76     {
77         struct
78         {
79             bool b_blind;
80             char *psz_text;
81         } enq;
82
83         struct
84         {
85             bool b_ok;
86             char *psz_answ;
87         } answ;
88
89         struct
90         {
91             char *psz_title, *psz_subtitle, *psz_bottom;
92             char **ppsz_choices;
93             int i_choices;
94         } menu; /* menu and list are the same */
95
96         struct
97         {
98             int i_choice;
99         } menu_answ;
100     } u;
101 } en50221_mmi_object_t;
102
103 static inline void en50221_MMIFree( en50221_mmi_object_t *p_object )
104 {
105     int i;
106
107     switch ( p_object->i_object_type )
108     {
109     case EN50221_MMI_ENQ:
110         FREENULL( p_object->u.enq.psz_text );
111         break;
112
113     case EN50221_MMI_ANSW:
114         if ( p_object->u.answ.b_ok )
115         {
116             FREENULL( p_object->u.answ.psz_answ );
117         }
118         break;
119
120     case EN50221_MMI_MENU:
121     case EN50221_MMI_LIST:
122         FREENULL( p_object->u.menu.psz_title );
123         FREENULL( p_object->u.menu.psz_subtitle );
124         FREENULL( p_object->u.menu.psz_bottom );
125         for ( i = 0; i < p_object->u.menu.i_choices; i++ )
126         {
127             free( p_object->u.menu.ppsz_choices[i] );
128         }
129         FREENULL( p_object->u.menu.ppsz_choices );
130         break;
131
132     default:
133         break;
134     }
135 }
136
137 #define MAX_DEMUX 256
138 #define MAX_CI_SLOTS 16
139 #define MAX_SESSIONS 32
140 #define MAX_PROGRAMS 24
141
142 struct access_sys_t
143 {
144     int i_handle, i_frontend_handle;
145     demux_handle_t p_demux_handles[MAX_DEMUX];
146     frontend_t *p_frontend;
147     bool b_budget_mode;
148
149     /* CA management */
150     int i_ca_handle;
151     int i_ca_type;
152     int i_nb_slots;
153     bool pb_active_slot[MAX_CI_SLOTS];
154     bool pb_tc_has_data[MAX_CI_SLOTS];
155     bool pb_slot_mmi_expected[MAX_CI_SLOTS];
156     bool pb_slot_mmi_undisplayed[MAX_CI_SLOTS];
157     en50221_session_t p_sessions[MAX_SESSIONS];
158     mtime_t i_ca_timeout, i_ca_next_event, i_frontend_timeout;
159     dvbpsi_pmt_t *pp_selected_programs[MAX_PROGRAMS];
160     int i_selected_programs;
161
162     /* */
163     int i_read_once;
164
165     int i_stat_counter;
166
167 #ifdef ENABLE_HTTPD
168     /* Local HTTP server */
169     httpd_host_t        *p_httpd_host;
170     httpd_file_sys_t    *p_httpd_file;
171     httpd_redirect_t    *p_httpd_redir;
172
173     vlc_mutex_t         httpd_mutex;
174     vlc_cond_t          httpd_cond;
175     mtime_t             i_httpd_timeout;
176     bool                b_request_frontend_info, b_request_mmi_info;
177     char                *psz_frontend_info, *psz_mmi_info;
178     char                *psz_request;
179 #endif
180
181     /* Scan */
182     scan_t *scan;
183 };
184
185 #define VIDEO0_TYPE     1
186 #define AUDIO0_TYPE     2
187 #define TELETEXT0_TYPE  3
188 #define SUBTITLE0_TYPE  4
189 #define PCR0_TYPE       5
190 #define TYPE_INTERVAL   5
191 #define OTHER_TYPE     21
192
193 /*****************************************************************************
194  * Prototypes
195  *****************************************************************************/
196
197 int  FrontendOpen( access_t * );
198 void FrontendPoll( access_t *p_access );
199 int  FrontendSet( access_t * );
200 void FrontendClose( access_t * );
201 #ifdef ENABLE_HTTPD
202 void FrontendStatus( access_t * );
203 #endif
204
205 int  FrontendGetStatistic( access_t *, frontend_statistic_t * );
206 void FrontendGetStatus( access_t *, frontend_status_t * );
207 int  FrontendGetScanParameter( access_t *, scan_parameter_t * );
208
209 int DMXSetFilter( access_t *, int i_pid, int * pi_fd, int i_type );
210 int DMXUnsetFilter( access_t *, int i_fd );
211
212 int  DVROpen( access_t * );
213 void DVRClose( access_t * );
214
215 int  CAMOpen( access_t * );
216 int  CAMPoll( access_t * );
217 int  CAMSet( access_t *, dvbpsi_pmt_t * );
218 void CAMClose( access_t * );
219 #ifdef ENABLE_HTTPD
220 void CAMStatus( access_t * );
221 #endif
222
223 int en50221_Init( access_t * );
224 int en50221_Poll( access_t * );
225 int en50221_SetCAPMT( access_t *, dvbpsi_pmt_t * );
226 int en50221_OpenMMI( access_t * p_access, int i_slot );
227 int en50221_CloseMMI( access_t * p_access, int i_slot );
228 en50221_mmi_object_t *en50221_GetMMIObject( access_t * p_access,
229                                                 int i_slot );
230 void en50221_SendMMIObject( access_t * p_access, int i_slot,
231                                 en50221_mmi_object_t *p_object );
232 void en50221_End( access_t * );
233
234 char *dvbsi_to_utf8( const char *psz_instring, size_t i_length );
235
236 #ifdef ENABLE_HTTPD
237 int HTTPOpen( access_t *p_access );
238 void HTTPClose( access_t *p_access );
239 const char *HTTPExtractValue( const char *psz_uri, const char *psz_name,
240                               char *psz_value, int i_value_max );
241 #endif
242 /*****************************************************************************
243  * Hacks
244  *****************************************************************************/
245 #define STRINGIFY( z )   UGLY_KLUDGE( z )
246 #define UGLY_KLUDGE( z ) #z
247