simple.c 18.3 KB
Newer Older
1
2
3
/*****************************************************************************
 * simple.c - The OSD Menu simple parser code.
 *****************************************************************************
4
 * Copyright (C) 2005-2008 M2X
Christophe Mutricy's avatar
Christophe Mutricy committed
5
 * $Id$
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 *
 * Authors: Jean-Paul Saman
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/

28
29
30
31
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

32
#include <vlc_common.h>
33
34
35
36
37
38
39
40
#include <vlc_vout.h>
#include <vlc_config.h>

#include <vlc_keys.h>
#include <vlc_image.h>
#include <vlc_osd.h>
#include <vlc_charset.h>

41
42
#include <limits.h>

43
44
45
46
#include "osd_menu.h"

int osd_parser_simpleOpen( vlc_object_t *p_this );

47
/*****************************************************************************
48
 * Simple parser open function
49
 *****************************************************************************/
50
int osd_parser_simpleOpen( vlc_object_t *p_this )
51
{
52
    osd_menu_t     *p_menu = (osd_menu_t *) p_this;
53
54
55
56
57
58
    osd_button_t   *p_current = NULL; /* button currently processed */
    osd_button_t   *p_prev = NULL;    /* previous processed button */

    FILE       *fd = NULL;
    int        result = 0;

59
60
    if( !p_menu ) return VLC_ENOOBJ;

61
62
63
64
    msg_Dbg( p_this, "opening osdmenu definition file %s", p_menu->psz_file );
    fd = utf8_fopen( p_menu->psz_file, "r" );
    if( !fd )
    {
65
66
        msg_Err( p_this, "failed to open osdmenu definition file %s",
                p_menu->psz_file );
67
68
69
70
71
72
73
74
        return VLC_EGENERIC;
    }

    /* Read first line */
    if( !feof( fd ) )
    {
        char action[25] = "";
        char cmd[25] = "";
75
        char path[PATH_MAX] = "";
76
77
78
79
80
81
82
83
84
85
86
87
88
        char *psz_path = NULL;
        size_t i_len = 0;
        long pos = 0;

        result = fscanf(fd, "%24s %255s", &action[0], &path[0] );

        /* override images path ? */
        psz_path = config_GetPsz( p_this, "osdmenu-file-path" );
        if( psz_path )
        {
            /* psz_path is not null and therefor &path[0] cannot be NULL
             * it might be null terminated.
             */
89
            strncpy( &path[0], psz_path, PATH_MAX );
90
91
92
93
            free( psz_path );
            psz_path = NULL;
        }
        /* NULL terminate before asking the length of path[] */
94
        path[PATH_MAX-1] = '\0';
95
        i_len = strlen(&path[0]);
96
97
98
99
100
        /* Protect against buffer overflow:
         * max index is PATH_MAX-1 and we increment by 1 after
         * so PATH_MAX-2 is the bigest we can have */
        if( i_len > PATH_MAX - 2 )
            i_len = PATH_MAX - 2;
101
102
103
104
105
106
107
108
109
110
111
112
113
#if defined(WIN32) || defined(UNDER_CE)
        if( (i_len > 0) && path[i_len] != '\\' )
            path[i_len] = '\\';
#else
        if( (i_len > 0) && path[i_len] != '/' )
            path[i_len] = '/';
#endif
        path[i_len+1] = '\0';
        if( result == 0 || result == EOF )
            goto error;
        msg_Dbg( p_this, "osdmenu dir %s", &path[0] );

        if( i_len == 0 )
114
            p_menu = osd_MenuNew( p_menu, NULL, 0, 0 );
115
        else
116
            p_menu = osd_MenuNew( p_menu, &path[0], 0, 0 );
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

        /* Peek for 'style' argument */
        pos = ftell( fd );
        if( pos < 0 )
                goto error;

        result = fscanf(fd, "%24s %24s", &cmd[0], &action[0] );
        if( result == 0 || result == EOF )
            goto error;

        msg_Dbg( p_this, "osdmenu %s %s", &cmd[0], &action[0] );
        if( strncmp( &cmd[0], "style", 5 ) == 0 )
        {
            if( strncmp( &action[0], "default", 7) == 0 )
            {
132
                p_menu->i_style = OSD_MENU_STYLE_SIMPLE;
133
134
135
            }
            else if( strncmp( &action[0], "concat", 6) == 0 )
            {
136
                p_menu->i_style = OSD_MENU_STYLE_CONCAT;
137
138
139
140
141
142
143
144
145
146
            }
        }
        else
        {
            result = fseek( fd, pos, SEEK_SET );
            if( result < 0 )
                goto error;
        }
    }

147
    if( !p_menu )
148
149
150
151
152
153
154
155
156
157
158
159
        goto error;

    /* read successive lines */
    while( !feof( fd ) )
    {
        osd_state_t   *p_state_current = NULL; /* button state currently processed */
        osd_state_t   *p_state_prev = NULL;    /* previous state processed button */

        char cmd[25] = "";
        char action[25] = "";
        char state[25]  = "";
        char file[256]  = "";
160
        char path[PATH_MAX]  = "";
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
        int  i_x = 0;
        int  i_y = 0;

        result = fscanf( fd, "%24s %24s (%d,%d)", &cmd[0], &action[0], &i_x, &i_y );
        if( result == 0 )
            goto error;
        if( strncmp( &cmd[0], "action", 6 ) != 0 )
            break;
        msg_Dbg( p_this, " + %s hotkey=%s (%d,%d)", &cmd[0], &action[0], i_x, i_y );

        p_prev = p_current;
        p_current = osd_ButtonNew( &action[0], i_x, i_y );
        if( !p_current )
            goto error;

        if( p_prev )
            p_prev->p_next = p_current;
        else
179
            p_menu->p_button = p_current;
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
        p_current->p_prev = p_prev;

        /* parse all states */
        while( !feof( fd ) )
        {
            char type[25] = "";

            result = fscanf( fd, "\t%24s", &state[0] );
            if( result == 0 )
                goto error;

            /* FIXME: We only parse one level deep now */
            if( strncmp( &state[0], "action", 6 ) == 0 )
            {
                osd_button_t   *p_up = NULL;

                result = fscanf( fd, "%24s (%d,%d)", &action[0], &i_x, &i_y );
                if( result == 0 )
                    goto error;
                /* create new button */
                p_up = osd_ButtonNew( &action[0], i_x, i_y );
                if( !p_up )
                    goto error;
                /* Link to list */
                p_up->p_down = p_current;
                p_current->p_up = p_up;
                msg_Dbg( p_this, " + (menu up) hotkey=%s (%d,%d)", &action[0], i_x, i_y );
                /* Parse type state */
                result = fscanf( fd, "\t%24s %24s", &cmd[0], &type[0] );
                if( result == 0 )
                    goto error;
                if( strncmp( &cmd[0], "type", 4 ) == 0 )
                {
                    if( strncmp( &type[0], "volume", 6 ) == 0 )
                    {
215
                        p_menu->p_state->p_volume = p_up;
216
217
218
219
220
221
222
223
224
225
226
227
228
229
                        msg_Dbg( p_this, " + type=%s", &type[0] );
                    }
                }
                /* Parse range state */
                result = fscanf( fd, "\t%24s", &state[0] );
                if( result == 0 )
                    goto error;
                /* Parse the range state */
                if( strncmp( &state[0], "range", 5 ) == 0 )
                {
                    osd_state_t   *p_range_current = NULL; /* range state currently processed */
                    osd_state_t   *p_range_prev = NULL;    /* previous state processed range */
                    int i_index = 0;

230
                    p_up->b_range = true;
231
232
233
234
235
236
237
238
239
240

                    result = fscanf( fd, "\t%24s", &action[0] );
                    if( result == 0 )
                        goto error;

                    result = fscanf( fd, "\t%d", &i_index );
                    if( result == 0 )
                        goto error;

                    msg_Dbg( p_this, " + (menu up) hotkey down %s, file=%s%s",
241
                             &action[0], p_menu->psz_path, &file[0] );
242

ivoire's avatar
ivoire committed
243
                    free( p_up->psz_action_down );
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
                    p_up->psz_action_down = strdup( &action[0] );

                    /* Parse range contstruction :
                     * range <hotkey>
                     *      <state1> <file1>
                     *
                     *      <stateN> <fileN>
                     * end
                     */
                    while( !feof( fd ) )
                    {
                        result = fscanf( fd, "\t%255s", &file[0] );
                        if( result == 0 )
                            goto error;
                        if( strncmp( &file[0], "end", 3 ) == 0 )
                            break;

                        p_range_prev = p_range_current;

263
                        if( p_menu->psz_path )
264
                        {
265
                            size_t i_path_size = strlen( p_menu->psz_path );
266
267
                            size_t i_file_size = strlen( &file[0] );

268
269
270
271
                            if( (i_path_size + i_file_size >= PATH_MAX) ||
                                (i_path_size >= PATH_MAX) )
                                goto error;

272
                            strncpy( &path[0], p_menu->psz_path, i_path_size );
273
274
                            strncpy( &path[i_path_size], &file[0],
                                     PATH_MAX - (i_path_size + i_file_size) );
275
276
                            path[ i_path_size + i_file_size ] = '\0';

277
                            p_range_current = osd_StateNew( p_menu, &path[0], "pressed" );
278
279
                        }
                        else /* absolute paths are used. */
280
                            p_range_current = osd_StateNew( p_menu, &file[0], "pressed" );
281

282
                        if( !p_range_current )
283
284
                            goto error;

285
286
287
288
289
290
                        if( !p_range_current->p_pic )
                        {
                            osd_StatesFree( p_menu, p_range_current );
                            goto error;
                        }

291
292
293
                        p_range_current->i_x = i_x;
                        p_range_current->i_y = i_y;

294
295
296
297
298
299
300
301
302
303
                        /* increment the number of ranges for this button */
                        p_up->i_ranges++;

                        if( p_range_prev )
                            p_range_prev->p_next = p_range_current;
                        else
                            p_up->p_states = p_range_current;
                        p_range_current->p_prev = p_range_prev;

                        msg_Dbg( p_this, "  |- range=%d, file=%s%s",
304
305
                                 p_up->i_ranges,
                                 p_menu->psz_path, &file[0] );
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
                    }
                    if( i_index > 0 )
                    {
                        osd_state_t *p_range = NULL;

                        /* Find the default index for state range */
                        p_range = p_up->p_states;
                        while( (--i_index > 0) && p_range->p_next )
                        {
                            osd_state_t *p_temp = NULL;
                            p_temp = p_range->p_next;
                            p_range = p_temp;
                        }
                        p_up->p_current_state = p_range;
                    }
                    else p_up->p_current_state = p_up->p_states;

                }
                result = fscanf( fd, "\t%24s", &state[0] );
                if( result == 0 )
                    goto error;
                if( strncmp( &state[0], "end", 3 ) != 0 )
                    goto error;

                /* Continue at the beginning of the while() */
                continue;
            }

            /* Parse the range state */
            if( strncmp( &state[0], "range", 5 ) == 0 )
            {
                osd_state_t   *p_range_current = NULL; /* range state currently processed */
                osd_state_t   *p_range_prev = NULL;    /* previous state processed range */
                int i_index = 0;

341
                p_current->b_range = true;
342
343
344
345
346
347
348
349
350

                result = fscanf( fd, "\t%24s", &action[0] );
                if( result == 0 )
                    goto error;

                result = fscanf( fd, "\t%d", &i_index );
                if( result == 0 )
                    goto error;

351
352
                msg_Dbg( p_this, " + hotkey down %s, file=%s%s", 
                         &action[0], p_menu->psz_path, &file[0] );
ivoire's avatar
ivoire committed
353
                free( p_current->psz_action_down );
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
                p_current->psz_action_down = strdup( &action[0] );

                /* Parse range contstruction :
                 * range <hotkey>
                 *      <state1> <file1>
                 *
                 *      <stateN> <fileN>
                 * end
                 */
                while( !feof( fd ) )
                {
                    result = fscanf( fd, "\t%255s", &file[0] );
                    if( result == 0 )
                        goto error;
                    if( strncmp( &file[0], "end", 3 ) == 0 )
                        break;

                    p_range_prev = p_range_current;

373
                    if( p_menu->psz_path )
374
                    {
375
                        size_t i_path_size = strlen( p_menu->psz_path );
376
377
                        size_t i_file_size = strlen( &file[0] );

378
379
380
381
                        if( (i_path_size + i_file_size >= PATH_MAX) ||
                            (i_path_size >= PATH_MAX) )
                            goto error;

382
                        strncpy( &path[0], p_menu->psz_path, i_path_size );
383
384
                        strncpy( &path[i_path_size], &file[0],
                                 PATH_MAX - (i_path_size + i_file_size) );
385
386
                        path[ i_path_size + i_file_size ] = '\0';

387
                        p_range_current = osd_StateNew( p_menu, &path[0], "pressed" );
388
389
                    }
                    else /* absolute paths are used. */
390
                        p_range_current = osd_StateNew( p_menu, &file[0], "pressed" );
391

392
393
394
395
396
397
                    if( !p_range_current )
                        goto error;

                    if( !p_range_current->p_pic )
                    {
                        osd_StatesFree( p_menu, p_range_current );
398
                        goto error;
399
                    }
400

401
402
403
                    p_range_current->i_x = i_x;
                    p_range_current->i_y = i_y;

404
405
406
407
408
409
410
411
412
413
                    /* increment the number of ranges for this button */
                    p_current->i_ranges++;

                    if( p_range_prev )
                        p_range_prev->p_next = p_range_current;
                    else
                        p_current->p_states = p_range_current;
                    p_range_current->p_prev = p_range_prev;

                    msg_Dbg( p_this, "  |- range=%d, file=%s%s",
414
415
                             p_current->i_ranges,
                             p_menu->psz_path, &file[0] );
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
                }
                if( i_index > 0 )
                {
                    osd_state_t *p_range = NULL;

                    /* Find the default index for state range */
                    p_range = p_current->p_states;
                    while( (--i_index > 0) && p_range->p_next )
                    {
                        osd_state_t *p_temp = NULL;
                        p_temp = p_range->p_next;
                        p_range = p_temp;
                    }
                    p_current->p_current_state = p_range;
                }
                else p_current->p_current_state = p_current->p_states;
                /* Continue at the beginning of the while() */
                continue;
            }
            if( strncmp( &state[0], "end", 3 ) == 0 )
                break;

            result = fscanf( fd, "\t%255s", &file[0] );
            if( result == 0 )
                goto error;

            p_state_prev = p_state_current;

            if( ( strncmp( ppsz_button_states[0], &state[0], strlen(ppsz_button_states[0]) ) != 0 ) &&
                ( strncmp( ppsz_button_states[1], &state[0], strlen(ppsz_button_states[1]) ) != 0 ) &&
                ( strncmp( ppsz_button_states[2], &state[0], strlen(ppsz_button_states[2]) ) != 0 ) )
            {
                msg_Err( p_this, "invalid button state %s for button %s "
                         "expected %u: unselect, select or pressed)",
                         &state[0], &action[0], (unsigned)strlen(&state[0]));
                goto error;
            }

454
            if( p_menu->psz_path )
455
            {
456
                size_t i_path_size = strlen( p_menu->psz_path );
457
458
                size_t i_file_size = strlen( &file[0] );

459
460
461
462
                if( (i_path_size + i_file_size >= PATH_MAX) ||
                    (i_path_size >= PATH_MAX) )
                    goto error;

463
                strncpy( &path[0], p_menu->psz_path, i_path_size );
464
465
                strncpy( &path[i_path_size], &file[0],
                         PATH_MAX - (i_path_size + i_file_size) );
466
467
                path[ i_path_size + i_file_size ] = '\0';

468
                p_state_current = osd_StateNew( p_menu, &path[0], &state[0] );
469
470
            }
            else /* absolute paths are used. */
471
                p_state_current = osd_StateNew( p_menu, &file[0], &state[0] );
472

473
474
475
476
477
478
            if( !p_state_current )
                goto error;

            if( !p_state_current->p_pic )
            {
                osd_StatesFree( p_menu, p_state_current );
479
                goto error;
480
            }
481

482
483
484
            p_state_current->i_x = i_x;
            p_state_current->i_y = i_y;

485
486
487
488
489
490
            if( p_state_prev )
                p_state_prev->p_next = p_state_current;
            else
                p_current->p_states = p_state_current;
            p_state_current->p_prev = p_state_prev;

491
492
            msg_Dbg( p_this, " |- state=%s, file=%s%s", &state[0],
                     p_menu->psz_path, &file[0] );
493
494
495
496
497
498
499
        }
        p_current->p_current_state = p_current->p_states;
    }

    /* Find the last button and store its pointer.
     * The OSD menu behaves like a roundrobin list.
     */
500
    p_current = p_menu->p_button;
501
502
503
504
505
506
    while( p_current && p_current->p_next )
    {
        osd_button_t *p_temp = NULL;
        p_temp = p_current->p_next;
        p_current = p_temp;
    }
507
    p_menu->p_last_button = p_current;
508
509
510
511
    fclose( fd );
    return VLC_SUCCESS;

error:
512
513
    msg_Err( p_menu, "parsing file failed (returned %d)", result );
    osd_MenuFree( p_menu );
514
515
516
    fclose( fd );
    return VLC_EGENERIC;
}