1 /*****************************************************************************
2 * imem.c : Memory input for VLC
3 *****************************************************************************
4 * Copyright (C) 2009-2010 Laurent Aimar
7 * Author: Laurent Aimar <fenrir _AT_ videolan _DOT org>
9 * This program 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.
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 General Public License for more details.
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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
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>
40 /*****************************************************************************
42 *****************************************************************************/
43 static int OpenAccess (vlc_object_t *);
44 static void CloseAccess(vlc_object_t *);
46 static int OpenDemux (vlc_object_t *);
47 static void CloseDemux(vlc_object_t *);
49 #define CACHING_TEXT N_("Caching value in ms")
50 #define CACHING_LONGTEXT N_(\
51 "Caching value for imem streams. This " \
52 "value should be set in milliseconds.")
54 #define ID_TEXT N_("ID")
55 #define ID_LONGTEXT N_(\
56 "Set the ID of the elementary stream")
58 #define GROUP_TEXT N_("Group")
59 #define GROUP_LONGTEXT N_(\
60 "Set the group of the elementary stream")
62 #define CAT_TEXT N_("Category")
63 #define CAT_LONGTEXT N_(\
64 "Set the category of the elementary stream")
65 static const int cat_values[] = {
68 static const char *cat_texts[] = {
69 N_("Unknown"), N_("Audio"), N_("Video"), N_("Subtitle"), N_("Data")
72 #define CODEC_TEXT N_("Codec")
73 #define CODEC_LONGTEXT N_(\
74 "Set the codec of the elementary stream")
76 #define LANGUAGE_TEXT N_("Language")
77 #define LANGUAGE_LONGTEXT N_(\
78 "Language of the elementary stream as described by ISO639")
80 #define SAMPLERATE_TEXT N_("Sample rate")
81 #define SAMPLERATE_LONGTEXT N_(\
82 "Sample rate of an audio elementary stream")
84 #define CHANNELS_TEXT N_("Channels count")
85 #define CHANNELS_LONGTEXT N_(\
86 "Channels count of an audio elementary stream")
88 #define WIDTH_TEXT N_("Width")
89 #define WIDTH_LONGTEXT N_("Width of video or subtitle elementary streams")
91 #define HEIGHT_TEXT N_("Height")
92 #define HEIGHT_LONGTEXT N_("Height of video or subtitle elementary streams")
94 #define DAR_TEXT N_("Display aspect ratio")
95 #define DAR_LONGTEXT N_(\
96 "Display aspect ratio of a video elementary stream")
98 #define FPS_TEXT N_("Frame rate")
99 #define FPS_LONGTEXT N_(\
100 "Frame rate of a video elementary stream")
102 #define COOKIE_TEXT N_("Callback cookie string")
103 #define COOKIE_LONGTEXT N_(\
104 "Text identifier for the callback functions")
106 #define DATA_TEXT N_("Callback data")
107 #define DATA_LONGTEXT N_(\
108 "Data for the get and release functions")
110 #define GET_TEXT N_("Get function")
111 #define GET_LONGTEXT N_(\
112 "Address of the get callback function")
114 #define RELEASE_TEXT N_("Release function")
115 #define RELEASE_LONGTEXT N_(\
116 "Address of the release callback function")
119 set_shortname(N_("Memory input"))
120 set_description(N_("Memory input"))
121 set_category(CAT_INPUT)
122 set_subcategory(SUBCAT_INPUT_ACCESS)
124 add_integer("imem-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, true)
126 add_string ("imem-get", "0", NULL, GET_TEXT, GET_LONGTEXT, true)
128 add_string ("imem-release", "0", NULL, RELEASE_TEXT, RELEASE_LONGTEXT, true)
130 add_string ("imem-cookie", NULL, NULL, COOKIE_TEXT, COOKIE_LONGTEXT, true)
133 add_string ("imem-data", "0", NULL, DATA_TEXT, DATA_LONGTEXT, true)
136 add_integer("imem-id", -1, NULL, ID_TEXT, ID_LONGTEXT, true)
139 add_integer("imem-group", 0, NULL, GROUP_TEXT, GROUP_LONGTEXT, true)
142 add_integer("imem-cat", 0, NULL, CAT_TEXT, CAT_LONGTEXT, true)
143 change_integer_list(cat_values, cat_texts, NULL)
146 add_string ("imem-codec", NULL, NULL, CODEC_TEXT, CODEC_LONGTEXT, true)
149 add_string( "imem-language", NULL, NULL, LANGUAGE_TEXT, LANGUAGE_LONGTEXT, false)
153 add_integer("imem-samplerate", 0, NULL, SAMPLERATE_TEXT, SAMPLERATE_LONGTEXT, true)
156 add_integer("imem-channels", 0, NULL, CHANNELS_TEXT, CHANNELS_LONGTEXT, true)
160 add_integer("imem-width", 0, NULL, WIDTH_TEXT, WIDTH_LONGTEXT, true)
163 add_integer("imem-height", 0, NULL, HEIGHT_TEXT, HEIGHT_LONGTEXT, true)
166 add_string ("imem-dar", NULL, NULL, DAR_TEXT, DAR_LONGTEXT, true)
169 add_string ("imem-fps", NULL, NULL, FPS_TEXT, FPS_LONGTEXT, true)
174 set_capability("access_demux", 0)
175 set_callbacks(OpenDemux, CloseDemux)
179 set_capability("access", 0)
180 set_callbacks(OpenAccess, CloseAccess)
183 /*****************************************************************************
185 *****************************************************************************/
187 /* The clock origin for the DTS and PTS is assumed to be 0.
188 * A negative value means unknown.
192 typedef int (*imem_get_t)(void *data, const char *cookie,
193 int64_t *dts, int64_t *pts, unsigned *flags,
195 typedef void (*imem_release_t)(void *data, const char *cookie, size_t, void *);
197 /*****************************************************************************
199 *****************************************************************************/
202 static block_t *Block(access_t *);
203 static int ControlAccess(access_t *, int, va_list);
205 static int Demux(demux_t *);
206 static int ControlDemux(demux_t *, int, va_list);
212 imem_release_t release;
226 static void ParseMRL(vlc_object_t *, const char *);
229 * It closes the common part of the access and access_demux
231 static void CloseCommon(imem_sys_t *sys)
233 free(sys->source.cookie);
238 * It initializes the common part for imem access/access_demux.
240 static int OpenCommon(vlc_object_t *object, imem_sys_t **sys_ptr, const char *psz_path)
245 imem_sys_t *sys = calloc(1, sizeof(*sys));
249 /* Read the user functions */
250 tmp = var_InheritString(object, "imem-get");
252 sys->source.get = (imem_get_t)(intptr_t)strtoll(tmp, NULL, 0);
255 tmp = var_InheritString(object, "imem-release");
257 sys->source.release = (imem_release_t)(intptr_t)strtoll(tmp, NULL, 0);
260 if (!sys->source.get || !sys->source.release) {
261 msg_Err(object, "Invalid get/release function pointers");
266 tmp = var_InheritString(object, "imem-data");
268 sys->source.data = (void *)(uintptr_t)strtoull(tmp, NULL, 0);
271 /* Now we can parse the MRL (get/release must not be parsed to avoid
274 ParseMRL(object, psz_path);
276 sys->source.cookie = var_InheritString(object, "imem-cookie");
278 msg_Dbg(object, "Using get(%p), release(%p), data(%p), cookie(%s)",
279 sys->source.get, sys->source.release, sys->source.data,
280 sys->source.cookie ? sys->source.cookie : "(null)");
283 sys->pts_delay = var_InheritInteger(object, "imem-caching") * INT64_C(1000);
285 sys->deadline = VLC_TS_INVALID;
292 * It opens an imem access.
294 static int OpenAccess(vlc_object_t *object)
296 access_t *access = (access_t *)object;
299 if (OpenCommon(object, &sys, access->psz_location))
302 if (var_InheritInteger(object, "imem-cat") != 4) {
308 access_InitFields(access);
309 access->pf_control = ControlAccess;
310 access->pf_read = NULL;
311 access->pf_block = Block;
312 access->pf_seek = NULL;
313 access->p_sys = (access_sys_t*)sys;
319 * It closes an imem access
321 static void CloseAccess(vlc_object_t *object)
323 access_t *access = (access_t *)object;
325 CloseCommon((imem_sys_t*)access->p_sys);
329 * It controls an imem access
331 static int ControlAccess(access_t *access, int i_query, va_list args)
333 imem_sys_t *sys = (imem_sys_t*)access->p_sys;
337 case ACCESS_CAN_SEEK:
338 case ACCESS_CAN_FASTSEEK: {
339 bool *b = va_arg( args, bool* );
343 case ACCESS_CAN_PAUSE:
344 case ACCESS_CAN_CONTROL_PACE: {
345 bool *b = va_arg( args, bool* );
349 case ACCESS_GET_PTS_DELAY: {
350 int64_t *delay = va_arg(args, int64_t *);
351 *delay = sys->pts_delay;
354 case ACCESS_SET_PAUSE_STATE:
357 case ACCESS_GET_TITLE_INFO:
358 case ACCESS_SET_TITLE:
359 case ACCESS_SET_SEEKPOINT:
360 case ACCESS_SET_PRIVATE_ID_STATE:
361 case ACCESS_GET_META:
362 case ACCESS_GET_PRIVATE_ID_STATE:
363 case ACCESS_GET_CONTENT_TYPE:
370 * It retreives data using the get() callback, copies them,
371 * and then release them using the release() callback.
373 static block_t *Block(access_t *access)
375 imem_sys_t *sys = (imem_sys_t*)access->p_sys;
381 if (sys->source.get(sys->source.data, sys->source.cookie,
382 NULL, NULL, &flags, &buffer_size, &buffer)) {
383 access->info.b_eof = true;
387 block_t *block = NULL;
388 if (buffer_size > 0) {
389 block = block_New(access, buffer_size);
391 memcpy(block->p_buffer, buffer, buffer_size);
394 sys->source.release(sys->source.data, sys->source.cookie,
395 buffer_size, buffer);
400 * It opens an imem access_demux.
402 static int OpenDemux(vlc_object_t *object)
404 demux_t *demux = (demux_t *)object;
407 if (OpenCommon(object, &sys, demux->psz_location))
412 es_format_Init(&fmt, UNKNOWN_ES, 0);
414 fmt.i_id = var_InheritInteger(object, "imem-id");
415 fmt.i_group = var_InheritInteger(object, "imem-group");
417 char *tmp = var_InheritString(object, "imem-codec");
419 fmt.i_codec = vlc_fourcc_GetCodecFromString(UNKNOWN_ES, tmp);
422 const int cat = var_InheritInteger(object, "imem-cat");
425 fmt.i_cat = AUDIO_ES;
426 fmt.audio.i_channels = var_InheritInteger(object, "imem-channels");
427 fmt.audio.i_rate = var_InheritInteger(object, "imem-samplerate");
429 msg_Dbg(object, "Audio %4.4s %d channels %d Hz",
430 (const char *)&fmt.i_codec,
431 fmt.audio.i_channels, fmt.audio.i_rate);
435 fmt.i_cat = VIDEO_ES;
436 fmt.video.i_width = var_InheritInteger(object, "imem-width");
437 fmt.video.i_height = var_InheritInteger(object, "imem-height");
439 if (!var_InheritURational(object, &num, &den, "imem-dar") && num > 0 && den > 0) {
440 if (fmt.video.i_width > 0 && fmt.video.i_height > 0) {
441 fmt.video.i_sar_num = num * fmt.video.i_height;
442 fmt.video.i_sar_den = den * fmt.video.i_width;
445 if (!var_InheritURational(object, &num, &den, "imem-fps") && num > 0 && den > 0) {
446 fmt.video.i_frame_rate = num;
447 fmt.video.i_frame_rate_base = den;
450 msg_Dbg(object, "Video %4.4s %dx%d SAR %d:%d frame rate %u/%u",
451 (const char *)&fmt.i_codec,
452 fmt.video.i_width, fmt.video.i_height,
453 fmt.video.i_sar_num, fmt.video.i_sar_den,
454 fmt.video.i_frame_rate, fmt.video.i_frame_rate_base);
459 fmt.subs.spu.i_original_frame_width =
460 var_InheritInteger(object, "imem-width");
461 fmt.subs.spu.i_original_frame_height =
462 var_InheritInteger(object, "imem-height");
464 msg_Dbg(object, "Subtitle %4.4s",
465 (const char *)&fmt.i_codec);
470 msg_Err(object, "Invalid ES category");
471 es_format_Clean(&fmt);
476 fmt.psz_language = var_InheritString(object, "imem-language");
478 sys->es = es_out_Add(demux->out, &fmt);
479 es_format_Clean(&fmt);
487 demux->pf_control = ControlDemux;
488 demux->pf_demux = Demux;
489 demux->p_sys = (demux_sys_t*)sys;
491 demux->info.i_update = 0;
492 demux->info.i_title = 0;
493 demux->info.i_seekpoint = 0;
498 * It closes an imem access_demux
500 static void CloseDemux(vlc_object_t *object)
502 demux_t *demux = (demux_t *)object;
504 CloseCommon((imem_sys_t*)demux->p_sys);
508 * It controls an imem access_demux
510 static int ControlDemux(demux_t *demux, int i_query, va_list args)
512 imem_sys_t *sys = (imem_sys_t*)demux->p_sys;
516 case DEMUX_CAN_PAUSE:
517 case DEMUX_CAN_CONTROL_PACE: {
518 bool *b = va_arg(args, bool *);
522 case DEMUX_SET_PAUSE_STATE:
525 case DEMUX_GET_PTS_DELAY: {
526 int64_t *delay = va_arg(args, int64_t *);
527 *delay = sys->pts_delay;
530 case DEMUX_GET_POSITION: {
531 double *position = va_arg(args, double *);
535 case DEMUX_GET_TIME: {
536 int64_t *t = va_arg(args, int64_t *);
540 case DEMUX_GET_LENGTH: {
541 int64_t *l = va_arg(args, int64_t *);
545 case DEMUX_SET_NEXT_DEMUX_TIME:
546 sys->deadline = va_arg(args, int64_t);
551 case DEMUX_SET_POSITION:
561 * It retreives data using the get() callback, sends them to es_out
562 * and the release it using the release() callback.
564 static int Demux(demux_t *demux)
566 imem_sys_t *sys = (imem_sys_t*)demux->p_sys;
568 if (sys->deadline == VLC_TS_INVALID)
569 sys->deadline = sys->dts + 1;
572 if (sys->deadline <= sys->dts)
581 if (sys->source.get(sys->source.data, sys->source.cookie,
582 &dts, &pts, &flags, &buffer_size, &buffer))
588 if (buffer_size > 0) {
589 block_t *block = block_New(demux, buffer_size);
591 block->i_dts = dts >= 0 ? (1 + dts) : VLC_TS_INVALID;
592 block->i_pts = pts >= 0 ? (1 + pts) : VLC_TS_INVALID;
593 memcpy(block->p_buffer, buffer, buffer_size);
595 es_out_Control(demux->out, ES_OUT_SET_PCR, block->i_dts);
596 es_out_Send(demux->out, sys->es, block);
602 sys->source.release(sys->source.data, sys->source.cookie,
603 buffer_size, buffer);
605 sys->deadline = VLC_TS_INVALID;
610 * Parse the MRL and extract configuration from it.
612 * Syntax: option1=value1[:option2=value2[...]]
614 * XXX get and release are not supported on purpose.
616 static void ParseMRL(vlc_object_t *object, const char *psz_path)
618 static const struct {
622 { "caching", VLC_VAR_INTEGER },
623 { "id", VLC_VAR_INTEGER },
624 { "group", VLC_VAR_INTEGER },
625 { "cat", VLC_VAR_INTEGER },
626 { "samplerate", VLC_VAR_INTEGER },
627 { "channels", VLC_VAR_INTEGER },
628 { "width", VLC_VAR_INTEGER },
629 { "height", VLC_VAR_INTEGER },
630 { "cookie", VLC_VAR_STRING },
631 { "codec", VLC_VAR_STRING },
632 { "language", VLC_VAR_STRING },
633 { "dar", VLC_VAR_STRING },
634 { "fps", VLC_VAR_STRING },
638 char *dup = strdup(psz_path);
644 char *next = strchr(current, ':');
648 char *option = current;
649 char *value = strchr(current, '=');
652 msg_Dbg(object, "option '%s' value '%s'", option, value);
654 msg_Dbg(object, "option '%s' without value (unsupported)", option);
658 if (asprintf(&name, "imem-%s", option) < 0)
660 for (unsigned i = 0; name && options[i].name; i++) {
661 if (strcmp(options[i].name, option))
664 var_Create(object, name, options[i].type | VLC_VAR_DOINHERIT);
665 if (options[i].type == VLC_VAR_INTEGER && value) {
666 var_SetInteger(object, name, strtol(value, NULL, 0));
667 } else if (options[i].type == VLC_VAR_STRING && value) {
668 var_SetString(object, name, value);