dvb: don't preparse
[vlc.git] / modules / access / imem.c
1 /*****************************************************************************
2  * imem.c : Memory input for VLC
3  *****************************************************************************
4  * Copyright (C) 2009-2010 Laurent Aimar
5  * $Id$
6  *
7  * Author: Laurent Aimar <fenrir _AT_ videolan _DOT org>
8  *
9  * This program is free software; you can redistribute it and/or modify it
10  * under the terms of the GNU Lesser General Public License as published by
11  * the Free Software Foundation; either version 2.1 of the License, or
12  * (at your option) any later version.
13  *
14  * This program 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 Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27
28 #ifdef HAVE_CONFIG_H
29 # include "config.h"
30 #endif
31 #include <limits.h>
32 #include <math.h>
33
34 #include <vlc_common.h>
35 #include <vlc_plugin.h>
36 #include <vlc_access.h>
37 #include <vlc_demux.h>
38 #include <vlc_charset.h>
39
40 /*****************************************************************************
41  * Module descriptior
42  *****************************************************************************/
43 static int  OpenAccess (vlc_object_t *);
44 static void CloseAccess(vlc_object_t *);
45
46 static int  OpenDemux (vlc_object_t *);
47 static void CloseDemux(vlc_object_t *);
48
49 #define ID_TEXT N_("ID")
50 #define ID_LONGTEXT N_(\
51     "Set the ID of the elementary stream")
52
53 #define GROUP_TEXT N_("Group")
54 #define GROUP_LONGTEXT N_(\
55     "Set the group of the elementary stream")
56
57 #define CAT_TEXT N_("Category")
58 #define CAT_LONGTEXT N_(\
59     "Set the category of the elementary stream")
60 static const int cat_values[] = {
61     0, 1, 2, 3, 4,
62 };
63 static const char *cat_texts[] = {
64     N_("Unknown"), N_("Audio"), N_("Video"), N_("Subtitle"), N_("Data")
65 };
66
67 #define CODEC_TEXT N_("Codec")
68 #define CODEC_LONGTEXT N_(\
69     "Set the codec of the elementary stream")
70
71 #define LANGUAGE_TEXT N_("Language")
72 #define LANGUAGE_LONGTEXT N_(\
73     "Language of the elementary stream as described by ISO639")
74
75 #define SAMPLERATE_TEXT N_("Sample rate")
76 #define SAMPLERATE_LONGTEXT N_(\
77     "Sample rate of an audio elementary stream")
78
79 #define CHANNELS_TEXT N_("Channels count")
80 #define CHANNELS_LONGTEXT N_(\
81     "Channels count of an audio elementary stream")
82
83 #define WIDTH_TEXT N_("Width")
84 #define WIDTH_LONGTEXT N_("Width of video or subtitle elementary streams")
85
86 #define HEIGHT_TEXT N_("Height")
87 #define HEIGHT_LONGTEXT N_("Height of video or subtitle elementary streams")
88
89 #define DAR_TEXT N_("Display aspect ratio")
90 #define DAR_LONGTEXT N_(\
91     "Display aspect ratio of a video elementary stream")
92
93 #define FPS_TEXT N_("Frame rate")
94 #define FPS_LONGTEXT N_(\
95     "Frame rate of a video elementary stream")
96
97 #define COOKIE_TEXT N_("Callback cookie string")
98 #define COOKIE_LONGTEXT N_(\
99     "Text identifier for the callback functions")
100
101 #define DATA_TEXT N_("Callback data")
102 #define DATA_LONGTEXT N_(\
103     "Data for the get and release functions")
104
105 #define GET_TEXT N_("Get function")
106 #define GET_LONGTEXT N_(\
107     "Address of the get callback function")
108
109 #define RELEASE_TEXT N_("Release function")
110 #define RELEASE_LONGTEXT N_(\
111     "Address of the release callback function")
112
113 #define SIZE_TEXT N_("Size")
114 #define SIZE_LONGTEXT N_(\
115     "Size of stream in bytes")
116
117 vlc_module_begin()
118     set_shortname(N_("Memory input"))
119     set_description(N_("Memory input"))
120     set_category(CAT_INPUT)
121     set_subcategory(SUBCAT_INPUT_ACCESS)
122
123     add_string ("imem-get", "0", GET_TEXT, GET_LONGTEXT, true)
124         change_volatile()
125     add_string ("imem-release", "0", RELEASE_TEXT, RELEASE_LONGTEXT, true)
126         change_volatile()
127     add_string ("imem-cookie", NULL, COOKIE_TEXT, COOKIE_LONGTEXT, true)
128         change_volatile()
129         change_safe()
130     add_string ("imem-data", "0", DATA_TEXT, DATA_LONGTEXT, true)
131         change_volatile()
132
133     add_integer("imem-id", -1, ID_TEXT, ID_LONGTEXT, true)
134         change_private()
135         change_safe()
136     add_integer("imem-group", 0, GROUP_TEXT, GROUP_LONGTEXT, true)
137         change_private()
138         change_safe()
139     add_integer("imem-cat", 0, CAT_TEXT, CAT_LONGTEXT, true)
140         change_integer_list(cat_values, cat_texts)
141         change_private()
142         change_safe()
143     add_string ("imem-codec", NULL, CODEC_TEXT, CODEC_LONGTEXT, true)
144         change_private()
145         change_safe()
146     add_string( "imem-language", NULL, LANGUAGE_TEXT, LANGUAGE_LONGTEXT, false)
147         change_private()
148         change_safe()
149
150     add_integer("imem-samplerate", 0, SAMPLERATE_TEXT, SAMPLERATE_LONGTEXT, true)
151         change_private()
152         change_safe()
153     add_integer("imem-channels", 0, CHANNELS_TEXT, CHANNELS_LONGTEXT, true)
154         change_private()
155         change_safe()
156
157     add_integer("imem-width", 0, WIDTH_TEXT, WIDTH_LONGTEXT, true)
158         change_private()
159         change_safe()
160     add_integer("imem-height", 0, HEIGHT_TEXT, HEIGHT_LONGTEXT, true)
161         change_private()
162         change_safe()
163     add_string ("imem-dar", NULL, DAR_TEXT, DAR_LONGTEXT, true)
164         change_private()
165         change_safe()
166     add_string ("imem-fps", NULL, FPS_TEXT, FPS_LONGTEXT, true)
167         change_private()
168         change_safe()
169
170     add_integer ("imem-size", 0, SIZE_TEXT, SIZE_LONGTEXT, true)
171         change_private()
172         change_safe()
173
174     add_shortcut("imem")
175     set_capability("access_demux", 0)
176     set_callbacks(OpenDemux, CloseDemux)
177
178     add_submodule()
179         add_shortcut("imem")
180         set_capability("access", 0)
181         set_callbacks(OpenAccess, CloseAccess)
182 vlc_module_end()
183
184 /*****************************************************************************
185  * Exported API
186  *****************************************************************************/
187
188 /* The clock origin for the DTS and PTS is assumed to be 0.
189  * A negative value means unknown.
190  *
191  * TODO define flags
192  */
193 typedef int  (*imem_get_t)(void *data, const char *cookie,
194                            int64_t *dts, int64_t *pts, unsigned *flags,
195                            size_t *, void **);
196 typedef void (*imem_release_t)(void *data, const char *cookie, size_t, void *);
197
198 /*****************************************************************************
199  * Local prototypes
200  *****************************************************************************/
201
202 /* */
203 static block_t *Block(access_t *);
204 static int ControlAccess(access_t *, int, va_list);
205
206 static int Demux(demux_t *);
207 static int ControlDemux(demux_t *, int, va_list);
208
209 /* */
210 typedef struct {
211     struct {
212         imem_get_t      get;
213         imem_release_t  release;
214         void           *data;
215         char           *cookie;
216     } source;
217
218     es_out_id_t  *es;
219
220     mtime_t      dts;
221
222     mtime_t      deadline;
223 } imem_sys_t;
224
225 static void ParseMRL(vlc_object_t *, const char *);
226
227 /**
228  * It closes the common part of the access and access_demux
229  */
230 static void CloseCommon(imem_sys_t *sys)
231 {
232     free(sys->source.cookie);
233     free(sys);
234 }
235
236 /**
237  * It initializes the common part for imem access/access_demux.
238  */
239 static int OpenCommon(vlc_object_t *object, imem_sys_t **sys_ptr, const char *psz_path)
240 {
241     char *tmp;
242
243     /* */
244     imem_sys_t *sys = calloc(1, sizeof(*sys));
245     if (!sys)
246         return VLC_ENOMEM;
247
248     /* Read the user functions */
249     tmp = var_InheritString(object, "imem-get");
250     if (tmp)
251         sys->source.get = (imem_get_t)(intptr_t)strtoll(tmp, NULL, 0);
252     free(tmp);
253
254     tmp = var_InheritString(object, "imem-release");
255     if (tmp)
256         sys->source.release = (imem_release_t)(intptr_t)strtoll(tmp, NULL, 0);
257     free(tmp);
258
259     if (!sys->source.get || !sys->source.release) {
260         msg_Err(object, "Invalid get/release function pointers");
261         free(sys);
262         return VLC_EGENERIC;
263     }
264
265     tmp = var_InheritString(object, "imem-data");
266     if (tmp)
267         sys->source.data = (void *)(uintptr_t)strtoull(tmp, NULL, 0);
268     free(tmp);
269
270     /* Now we can parse the MRL (get/release must not be parsed to avoid
271      * security risks) */
272     if (*psz_path)
273         ParseMRL(object, psz_path);
274
275     sys->source.cookie = var_InheritString(object, "imem-cookie");
276
277     msg_Dbg(object, "Using get(%p), release(%p), data(%p), cookie(%s)",
278             (void *)sys->source.get, (void *)sys->source.release,
279             sys->source.data,
280             sys->source.cookie ? sys->source.cookie : "(null)");
281
282     /* */
283     sys->dts       = 0;
284     sys->deadline  = VLC_TS_INVALID;
285
286     *sys_ptr = sys;
287     return VLC_SUCCESS;
288 }
289
290 /**
291  * It opens an imem access.
292  */
293 static int OpenAccess(vlc_object_t *object)
294 {
295     access_t   *access = (access_t *)object;
296     imem_sys_t *sys;
297
298     if (OpenCommon(object, &sys, access->psz_location))
299         return VLC_EGENERIC;
300
301     if (var_InheritInteger(object, "imem-cat") != 4) {
302         CloseCommon(sys);
303         return VLC_EGENERIC;
304     }
305
306     /* */
307     access_InitFields(access);
308     access->pf_control = ControlAccess;
309     access->pf_read    = NULL;
310     access->pf_block   = Block;
311     access->pf_seek    = NULL;
312     access->p_sys      = (access_sys_t*)sys;
313
314     return VLC_SUCCESS;
315 }
316
317 /**
318  * It closes an imem access
319  */
320 static void CloseAccess(vlc_object_t *object)
321 {
322     access_t *access = (access_t *)object;
323
324     CloseCommon((imem_sys_t*)access->p_sys);
325 }
326
327 /**
328  * It controls an imem access
329  */
330 static int ControlAccess(access_t *access, int i_query, va_list args)
331 {
332     (void) access;
333     switch (i_query)
334     {
335     case ACCESS_CAN_SEEK:
336     case ACCESS_CAN_FASTSEEK: {
337         bool *b = va_arg( args, bool* );
338         *b = false;
339         return VLC_SUCCESS;
340     }
341     case ACCESS_CAN_PAUSE:
342     case ACCESS_CAN_CONTROL_PACE: {
343         bool *b = va_arg( args, bool* );
344         *b = true;
345         return VLC_SUCCESS;
346     }
347     case ACCESS_GET_SIZE: {
348         uint64_t *s = va_arg(args, uint64_t *);
349         *s = var_InheritInteger(access, "imem-size");
350         return *s ? VLC_SUCCESS : VLC_EGENERIC;
351     }
352     case ACCESS_GET_PTS_DELAY: {
353         int64_t *delay = va_arg(args, int64_t *);
354         *delay = DEFAULT_PTS_DELAY; /* FIXME? */
355         return VLC_SUCCESS;
356     }
357     case ACCESS_SET_PAUSE_STATE:
358         return VLC_SUCCESS;
359
360     default:
361         return VLC_EGENERIC;
362     }
363 }
364
365 /**
366  * It retreives data using the get() callback, copies them,
367  * and then release them using the release() callback.
368  */
369 static block_t *Block(access_t *access)
370 {
371     imem_sys_t *sys = (imem_sys_t*)access->p_sys;
372
373     unsigned flags;
374     size_t buffer_size;
375     void   *buffer;
376
377     if (sys->source.get(sys->source.data, sys->source.cookie,
378                         NULL, NULL, &flags, &buffer_size, &buffer)) {
379         access->info.b_eof = true;
380         return NULL;
381     }
382
383     block_t *block = NULL;
384     if (buffer_size > 0) {
385         block = block_Alloc(buffer_size);
386         if (block)
387             memcpy(block->p_buffer, buffer, buffer_size);
388     }
389
390     sys->source.release(sys->source.data, sys->source.cookie,
391                         buffer_size, buffer);
392     return block;
393 }
394
395 /**
396  * It opens an imem access_demux.
397  */
398 static int OpenDemux(vlc_object_t *object)
399 {
400     demux_t    *demux = (demux_t *)object;
401     imem_sys_t *sys;
402
403     if (OpenCommon(object, &sys, demux->psz_location))
404         return VLC_EGENERIC;
405
406     /* ES format */
407     es_format_t fmt;
408     es_format_Init(&fmt, UNKNOWN_ES, 0);
409
410     fmt.i_id = var_InheritInteger(object, "imem-id");
411     fmt.i_group = var_InheritInteger(object, "imem-group");
412
413     char *tmp = var_InheritString(object, "imem-codec");
414     if (tmp)
415         fmt.i_codec = vlc_fourcc_GetCodecFromString(UNKNOWN_ES, tmp);
416     free(tmp);
417
418     const int cat = var_InheritInteger(object, "imem-cat");
419     switch (cat) {
420     case 1: {
421         fmt.i_cat = AUDIO_ES;
422         fmt.audio.i_channels = var_InheritInteger(object, "imem-channels");
423         fmt.audio.i_rate = var_InheritInteger(object, "imem-samplerate");
424
425         msg_Dbg(object, "Audio %4.4s %d channels %d Hz",
426                 (const char *)&fmt.i_codec,
427                 fmt.audio.i_channels, fmt.audio.i_rate);
428         break;
429     }
430     case 2: {
431         fmt.i_cat = VIDEO_ES;
432         fmt.video.i_width  = var_InheritInteger(object, "imem-width");
433         fmt.video.i_height = var_InheritInteger(object, "imem-height");
434         unsigned num, den;
435         if (!var_InheritURational(object, &num, &den, "imem-dar") && num > 0 && den > 0) {
436             if (fmt.video.i_width > 0 && fmt.video.i_height > 0) {
437                 fmt.video.i_sar_num = num * fmt.video.i_height;
438                 fmt.video.i_sar_den = den * fmt.video.i_width;
439             }
440         }
441         if (!var_InheritURational(object, &num, &den, "imem-fps") && num > 0 && den > 0) {
442             fmt.video.i_frame_rate      = num;
443             fmt.video.i_frame_rate_base = den;
444         }
445
446         msg_Dbg(object, "Video %4.4s %dx%d  SAR %d:%d frame rate %u/%u",
447                 (const char *)&fmt.i_codec,
448                 fmt.video.i_width, fmt.video.i_height,
449                 fmt.video.i_sar_num, fmt.video.i_sar_den,
450                 fmt.video.i_frame_rate, fmt.video.i_frame_rate_base);
451         break;
452     }
453     case 3: {
454         fmt.i_cat = SPU_ES;
455         fmt.subs.spu.i_original_frame_width =
456             var_InheritInteger(object, "imem-width");
457         fmt.subs.spu.i_original_frame_height =
458             var_InheritInteger(object, "imem-height");
459
460         msg_Dbg(object, "Subtitle %4.4s",
461                 (const char *)&fmt.i_codec);
462         break;
463     }
464     default:
465         if (cat != 4)
466             msg_Err(object, "Invalid ES category");
467         es_format_Clean(&fmt);
468         CloseCommon(sys);
469         return VLC_EGENERIC;
470     }
471
472     fmt.psz_language = var_InheritString(object, "imem-language");
473
474     sys->es = es_out_Add(demux->out, &fmt);
475     es_format_Clean(&fmt);
476
477     if (!sys->es) {
478         CloseCommon(sys);
479         return VLC_EGENERIC;
480     }
481
482     /* */
483     demux->pf_control = ControlDemux;
484     demux->pf_demux   = Demux;
485     demux->p_sys      = (demux_sys_t*)sys;
486
487     demux->info.i_update = 0;
488     demux->info.i_title = 0;
489     demux->info.i_seekpoint = 0;
490     return VLC_SUCCESS;
491 }
492
493 /**
494  * It closes an imem access_demux
495  */
496 static void CloseDemux(vlc_object_t *object)
497 {
498     demux_t *demux = (demux_t *)object;
499
500     CloseCommon((imem_sys_t*)demux->p_sys);
501 }
502
503 /**
504  * It controls an imem access_demux
505  */
506 static int ControlDemux(demux_t *demux, int i_query, va_list args)
507 {
508     imem_sys_t *sys = (imem_sys_t*)demux->p_sys;
509
510     switch (i_query)
511     {
512     case DEMUX_CAN_PAUSE:
513     case DEMUX_CAN_CONTROL_PACE: {
514         bool *b = va_arg(args, bool *);
515         *b = true;
516         return VLC_SUCCESS;
517     }
518     case DEMUX_SET_PAUSE_STATE:
519         return VLC_SUCCESS;
520
521     case DEMUX_GET_PTS_DELAY: {
522         int64_t *delay = va_arg(args, int64_t *);
523         *delay = DEFAULT_PTS_DELAY; /* FIXME? */
524         return VLC_SUCCESS;
525     }
526     case DEMUX_GET_POSITION: {
527         double *position = va_arg(args, double *);
528         *position = 0.0;
529         return VLC_SUCCESS;
530     }
531     case DEMUX_GET_TIME: {
532         int64_t *t = va_arg(args, int64_t *);
533         *t = sys->dts;
534         return VLC_SUCCESS;
535     }
536     case DEMUX_GET_LENGTH: {
537         int64_t *l = va_arg(args, int64_t *);
538         *l = 0;
539         return VLC_SUCCESS;
540     }
541     case DEMUX_SET_NEXT_DEMUX_TIME:
542         sys->deadline = va_arg(args, int64_t);
543         return VLC_SUCCESS;
544
545     /* */
546     case DEMUX_CAN_SEEK:
547     case DEMUX_SET_POSITION:
548     case DEMUX_SET_TIME:
549     default:
550         return VLC_EGENERIC;
551     }
552
553     return VLC_EGENERIC;
554 }
555
556 /**
557  * It retreives data using the get() callback, sends them to es_out
558  * and the release it using the release() callback.
559  */
560 static int Demux(demux_t *demux)
561 {
562     imem_sys_t *sys = (imem_sys_t*)demux->p_sys;
563
564     if (sys->deadline == VLC_TS_INVALID)
565         sys->deadline = sys->dts + 1;
566
567     for (;;) {
568         if (sys->deadline <= sys->dts)
569             break;
570
571         /* */
572         int64_t dts, pts;
573         unsigned flags;
574         size_t buffer_size;
575         void   *buffer;
576
577         if (sys->source.get(sys->source.data, sys->source.cookie,
578                             &dts, &pts, &flags, &buffer_size, &buffer))
579             return 0;
580
581         if (dts < 0)
582             dts = pts;
583
584         if (buffer_size > 0) {
585             block_t *block = block_Alloc(buffer_size);
586             if (block) {
587                 block->i_dts = dts >= 0 ? (1 + dts) : VLC_TS_INVALID;
588                 block->i_pts = pts >= 0 ? (1 + pts) : VLC_TS_INVALID;
589                 memcpy(block->p_buffer, buffer, buffer_size);
590
591                 es_out_Control(demux->out, ES_OUT_SET_PCR, block->i_dts);
592                 es_out_Send(demux->out, sys->es, block);
593             }
594         }
595
596         sys->dts = dts;
597
598         sys->source.release(sys->source.data, sys->source.cookie,
599                             buffer_size, buffer);
600     }
601     sys->deadline = VLC_TS_INVALID;
602     return 1;
603 }
604
605 /**
606  * Parse the MRL and extract configuration from it.
607  *
608  * Syntax: option1=value1[:option2=value2[...]]
609  *
610  * XXX get and release are not supported on purpose.
611  */
612 static void ParseMRL(vlc_object_t *object, const char *psz_path)
613 {
614     static const struct {
615         const char *name;
616         int        type;
617     } options[] = {
618         { "id",         VLC_VAR_INTEGER },
619         { "group",      VLC_VAR_INTEGER },
620         { "cat",        VLC_VAR_INTEGER },
621         { "samplerate", VLC_VAR_INTEGER },
622         { "channels",   VLC_VAR_INTEGER },
623         { "width",      VLC_VAR_INTEGER },
624         { "height",     VLC_VAR_INTEGER },
625         { "cookie",     VLC_VAR_STRING },
626         { "codec",      VLC_VAR_STRING },
627         { "language",   VLC_VAR_STRING },
628         { "dar",        VLC_VAR_STRING },
629         { "fps",        VLC_VAR_STRING },
630         { NULL, -1 }
631     };
632
633     char *dup = strdup(psz_path);
634     if (!dup)
635         return;
636     char *current = dup;
637
638     while (current) {
639         char *next = strchr(current, ':');
640         if (next)
641             *next++ = '\0';
642
643         char *option = current;
644         char *value = strchr(current, '=');
645         if (value) {
646             *value++ = '\0';
647             msg_Dbg(object, "option '%s' value '%s'", option, value);
648         } else {
649             msg_Dbg(object, "option '%s' without value (unsupported)", option);
650         }
651
652         char *name;
653         if (asprintf(&name, "imem-%s", option) < 0)
654             name = NULL;
655         for (unsigned i = 0; name && options[i].name; i++) {
656             if (strcmp(options[i].name, option))
657                 continue;
658             /* */
659             var_Create(object, name, options[i].type | VLC_VAR_DOINHERIT);
660             if (options[i].type == VLC_VAR_INTEGER && value) {
661                 var_SetInteger(object, name, strtol(value, NULL, 0));
662             } else if (options[i].type == VLC_VAR_STRING && value) {
663                 var_SetString(object, name, value);
664             }
665             break;
666         }
667         free(name);
668
669         /* */
670         current = next;
671     }
672     free(dup);
673 }