git.sesse.net Git - vlc/blob - modules/access/imem.c

   1 /*****************************************************************************
   2  * imem.c : Memory input for VLC
   3  *****************************************************************************
   4  * Copyright (C) 2009 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
  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  * 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.
  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., 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_demux.h>
  37 #include <vlc_charset.h>
  38
  39 /*****************************************************************************
  40  * Module descriptior
  41  *****************************************************************************/
  42 static int  Open (vlc_object_t *);
  43 static void Close(vlc_object_t *);
  44
  45 #define CACHING_TEXT N_("Caching value in ms")
  46 #define CACHING_LONGTEXT N_(\
  47     "Caching value for imem streams. This " \
  48     "value should be set in milliseconds.")
  49
  50 #define ID_TEXT N_("ID")
  51 #define ID_LONGTEXT N_(\
  52     "Set the ID of the elementary stream")
  53
  54 #define GROUP_TEXT N_("Group")
  55 #define GROUP_LONGTEXT N_(\
  56     "Set the group of the elementary stream")
  57
  58 #define CAT_TEXT N_("Category")
  59 #define CAT_LONGTEXT N_(\
  60     "Set the category of the elementary stream")
  61 static const int cat_values[] = {
  62     0, 1, 2, 3
  63 };
  64 static const char *cat_texts[] = {
  65     N_("Unknown"), N_("Audio"), N_("Video"), N_("Subtitle")
  66 };
  67
  68 #define CODEC_TEXT N_("Codec")
  69 #define CODEC_LONGTEXT N_(\
  70     "Set the codec of the elementary stream")
  71
  72 #define LANGUAGE_TEXT N_("Language")
  73 #define LANGUAGE_LONGTEXT N_(\
  74     "Language of the elementary stream as described by ISO639")
  75
  76 #define SAMPLERATE_TEXT N_("Sample rate")
  77 #define SAMPLERATE_LONGTEXT N_(\
  78     "Sample rate of an audio elementary stream")
  79
  80 #define CHANNELS_TEXT N_("Channels count")
  81 #define CHANNELS_LONGTEXT N_(\
  82     "Channels count of an audio elementary stream")
  83
  84 #define WIDTH_TEXT N_("Width")
  85 #define WIDTH_LONGTEXT N_("Width of video or subtitle elementary streams")
  86
  87 #define HEIGHT_TEXT N_("Height")
  88 #define HEIGHT_LONGTEXT N_("Height of video or subtitle elementary streams")
  89
  90 #define DAR_TEXT N_("Display aspect ratio")
  91 #define DAR_LONGTEXT N_(\
  92     "Display aspect ratio of a video elementary stream")
  93
  94 #define FPS_TEXT N_("Frame rate")
  95 #define FPS_LONGTEXT N_(\
  96     "Frame rate of a video elementary stream")
  97
  98 #define DATA_TEXT N_("Callback data")
  99 #define DATA_LONGTEXT N_(\
 100     "Data for the get and release functions")
 101
 102 #define GET_TEXT N_("Get function")
 103 #define GET_LONGTEXT N_(\
 104     "Address of the get callback function")
 105
 106 #define RELEASE_TEXT N_("Release function")
 107 #define RELEASE_LONGTEXT N_(\
 108     "Address of the release callback function")
 109
 110 vlc_module_begin()
 111     set_shortname(N_("Memory input"))
 112     set_description(N_("Memory input"))
 113     set_category(CAT_INPUT)
 114     set_subcategory(SUBCAT_INPUT_ACCESS)
 115
 116     add_integer("imem-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, true)
 117     add_string ("imem-get", "0", NULL, GET_TEXT, GET_LONGTEXT, true)
 118     add_string ("imem-release", "0", NULL, RELEASE_TEXT, RELEASE_LONGTEXT, true)
 119     add_string ("imem-data", "0", NULL, DATA_TEXT, DATA_LONGTEXT, true)
 120
 121     add_integer("imem-id", -1, NULL, ID_TEXT, ID_LONGTEXT, true)
 122     add_integer("imem-group", 0, NULL, GROUP_TEXT, GROUP_LONGTEXT, true)
 123     add_integer("imem-cat", 0, NULL, CAT_TEXT, CAT_LONGTEXT, true)
 124         change_integer_list(cat_values, cat_texts, NULL)
 125     add_string ("imem-codec", NULL, NULL, CODEC_TEXT, CODEC_LONGTEXT, true)
 126     add_string( "imem-language", NULL, NULL, LANGUAGE_TEXT, LANGUAGE_LONGTEXT, false);
 127
 128     add_integer("imem-samplerate", 0, NULL, SAMPLERATE_TEXT, SAMPLERATE_LONGTEXT, true)
 129     add_integer("imem-channels", 0, NULL, CHANNELS_TEXT, CHANNELS_LONGTEXT, true)
 130
 131     add_integer("imem-width", 0, NULL, WIDTH_TEXT, WIDTH_LONGTEXT, true)
 132     add_integer("imem-height", 0, NULL, HEIGHT_TEXT, HEIGHT_LONGTEXT, true)
 133     add_string ("imem-dar", NULL, NULL, DAR_TEXT, DAR_LONGTEXT, true)
 134     add_string ("imem-fps", NULL, NULL, FPS_TEXT, FPS_LONGTEXT, true)
 135
 136     add_shortcut("imem")
 137     set_capability("access_demux", 0)
 138     set_callbacks(Open, Close)
 139 vlc_module_end()
 140
 141 /*****************************************************************************
 142  * Exported API
 143  *****************************************************************************/
 144
 145 /* The clock origin for the DTS and PTS is assumed to be 0.
 146  * A negative value means unknown.
 147  *
 148  * TODO define flags
 149  */
 150 typedef int  (*imem_get_t)(void *data,
 151                            int64_t *dts, int64_t *pts, unsigned *flags,
 152                            size_t *, void **);
 153 typedef void (*imem_release_t)(void *data, size_t, void *);
 154
 155 /*****************************************************************************
 156  * Local prototypes
 157  *****************************************************************************/
 158
 159 /* */
 160 static int Demux(demux_t *);
 161 static int Control(demux_t *, int, va_list);
 162
 163 /* */
 164 struct demux_sys_t {
 165     struct {
 166         imem_get_t      get;
 167         imem_release_t  release;
 168         void            *data;
 169     } source;
 170
 171     es_out_id_t  *es;
 172
 173     mtime_t      pts_delay;
 174
 175     mtime_t      dts;
 176
 177     mtime_t      deadline;
 178 };
 179
 180 static void ParseMRL(demux_t *);
 181 static int var_CreateGetRational(demux_t *,
 182                                  unsigned *num, unsigned *den,
 183                                  const char *var);
 184
 185 /**
 186  * It opens an imem access_demux
 187  */
 188 static int Open(vlc_object_t *object)
 189 {
 190     demux_t     *demux = (demux_t*)object;
 191     char *tmp;
 192
 193         /* */
 194     demux_sys_t *sys = calloc(1, sizeof(*sys));
 195         if (!sys)
 196                 return VLC_ENOMEM;
 197
 198     /* Read the user functions */
 199     tmp = var_CreateGetString(demux, "imem-get");
 200     if (tmp)
 201         sys->source.get = (imem_get_t)(intptr_t)strtoll(tmp, NULL, 0);
 202     free(tmp);
 203
 204     tmp = var_CreateGetString(demux, "imem-release");
 205     if (tmp)
 206         sys->source.release = (imem_release_t)(intptr_t)strtoll(tmp, NULL, 0);
 207     free(tmp);
 208
 209     if (!sys->source.get || !sys->source.release) {
 210         msg_Err(demux, "Invalid get/release function pointers");
 211         free(sys);
 212         return VLC_EGENERIC;
 213     }
 214
 215     /* Now we can parse the MRL (get/release must not be parsed to avoid
 216      * security risks) */
 217     if (*demux->psz_path)
 218         ParseMRL(demux);
 219
 220     tmp = var_CreateGetString(demux, "imem-data");
 221     if (tmp)
 222         sys->source.data = (void*)(intptr_t)strtoll(tmp, NULL, 0);
 223     free(tmp);
 224
 225     msg_Dbg(demux, "Using get(%p) release(%p) and data(%p)",
 226             sys->source.get, sys->source.release, sys->source.data);
 227
 228         /* ES format */
 229     es_format_t fmt;
 230         es_format_Init(&fmt, UNKNOWN_ES, 0);
 231
 232     fmt.i_id = var_CreateGetInteger(demux, "imem-id");
 233     fmt.i_group = var_CreateGetInteger(demux, "imem-group");
 234
 235     tmp = var_CreateGetString(demux, "imem-codec");
 236     if (tmp)
 237         fmt.i_codec = vlc_fourcc_GetCodecFromString(UNKNOWN_ES, tmp);
 238     free(tmp);
 239
 240     switch (var_CreateGetInteger(demux, "imem-cat")) {
 241     case 1: {
 242         fmt.i_cat = AUDIO_ES;
 243         fmt.audio.i_channels = var_CreateGetInteger(demux, "imem-channels");
 244         fmt.audio.i_rate = var_CreateGetInteger(demux, "imem-samplerate");
 245
 246         msg_Dbg(demux, "Audio %4.4s %d channels %d Hz",
 247                 (const char *)&fmt.i_codec,
 248                 fmt.audio.i_channels, fmt.audio.i_rate);
 249         break;
 250     }
 251     case 2: {
 252         fmt.i_cat = VIDEO_ES;
 253         fmt.video.i_width  = var_CreateGetInteger(demux, "imem-width");
 254         fmt.video.i_height = var_CreateGetInteger(demux, "imem-height");
 255         unsigned num, den;
 256         if (!var_CreateGetRational(demux, &num, &den, "imem-dar") && num > 0 && den > 0) {
 257             if (fmt.video.i_width > 0 && fmt.video.i_height > 0) {
 258                 fmt.video.i_sar_num = num * fmt.video.i_height;
 259                 fmt.video.i_sar_den = den * fmt.video.i_width;
 260             }
 261         }
 262         if (!var_CreateGetRational(demux, &num, &den, "imem-fps") && num > 0 && den > 0) {
 263             fmt.video.i_frame_rate      = num;
 264             fmt.video.i_frame_rate_base = den;
 265         }
 266
 267         msg_Dbg(demux, "Video %4.4s %dx%d  SAR %d:%d frame rate %u/%u",
 268                 (const char *)&fmt.i_codec,
 269                 fmt.video.i_width, fmt.video.i_height,
 270                 fmt.video.i_sar_num, fmt.video.i_sar_den,
 271                 fmt.video.i_frame_rate, fmt.video.i_frame_rate_base);
 272         break;
 273     }
 274     case 3: {
 275         fmt.i_cat = SPU_ES;
 276         fmt.subs.spu.i_original_frame_width =
 277             var_CreateGetInteger(demux, "imem-width");
 278         fmt.subs.spu.i_original_frame_height =
 279             var_CreateGetInteger(demux, "imem-height");
 280
 281         msg_Dbg(demux, "Subtitle %4.4s",
 282                 (const char *)&fmt.i_codec);
 283         break;
 284     }
 285     default:
 286         msg_Err(demux, "Invalid ES category");
 287         es_format_Clean(&fmt);
 288         free(sys);
 289         return VLC_EGENERIC;
 290     }
 291
 292     fmt.psz_language = var_CreateGetString(demux, "imem-language");
 293
 294     /* */
 295         sys->es = es_out_Add(demux->out, &fmt);
 296     es_format_Clean(&fmt);
 297
 298     if (!sys->es) {
 299         free(sys);
 300         return VLC_EGENERIC;
 301     }
 302
 303     /* */
 304     sys->pts_delay = var_CreateGetInteger(demux, "imem-caching") * INT64_C(1000);
 305     sys->dts       = 0;
 306     sys->deadline  = VLC_TS_INVALID;
 307
 308     /* Set up demux */
 309     demux->pf_control = Control;
 310     demux->pf_demux   = Demux;
 311     demux->p_sys      = sys;
 312
 313     demux->info.i_update = 0;
 314     demux->info.i_title = 0;
 315     demux->info.i_seekpoint = 0;
 316     return VLC_SUCCESS;
 317 }
 318
 319 /**
 320  * It closes an imem access_demux
 321  */
 322 static void Close(vlc_object_t *object)
 323 {
 324     demux_t     *demux = (demux_t *)object;
 325
 326     free(demux->p_sys);
 327 }
 328
 329 /**
 330  * It controls imem
 331  */
 332 static int Control(demux_t *demux, int i_query, va_list args)
 333 {
 334     demux_sys_t *sys = demux->p_sys;
 335
 336     switch (i_query)
 337     {
 338     case DEMUX_CAN_PAUSE:
 339     case DEMUX_CAN_CONTROL_PACE: {
 340         bool *b = va_arg(args, bool *);
 341         *b = true;
 342         return VLC_SUCCESS;
 343     }
 344     case DEMUX_SET_PAUSE_STATE:
 345         return VLC_SUCCESS;
 346
 347     case DEMUX_GET_PTS_DELAY: {
 348         int64_t *delay = va_arg(args, int64_t *);
 349         *delay = sys->pts_delay;
 350         return VLC_SUCCESS;
 351     }
 352     case DEMUX_GET_POSITION: {
 353         double *position = va_arg(args, double *);
 354         *position = 0.0;
 355         return VLC_SUCCESS;
 356     }
 357     case DEMUX_GET_TIME: {
 358         int64_t *t = va_arg(args, int64_t *);
 359         *t = sys->dts;
 360         return VLC_SUCCESS;
 361     }
 362     case DEMUX_GET_LENGTH: {
 363         int64_t *l = va_arg(args, int64_t *);
 364         *l = 0;
 365         return VLC_SUCCESS;
 366     }
 367     case DEMUX_SET_NEXT_DEMUX_TIME:
 368         sys->deadline = va_arg(args, int64_t);
 369         return VLC_SUCCESS;
 370
 371     /* */
 372     case DEMUX_CAN_SEEK:
 373     case DEMUX_SET_POSITION:
 374     case DEMUX_SET_TIME:
 375     default:
 376         return VLC_EGENERIC;
 377     }
 378
 379     return VLC_EGENERIC;
 380 }
 381
 382 /**
 383  * It retreives data using the get() callback, sends them to es_out
 384  * and the release it using the release() callback.
 385  */
 386 static int Demux(demux_t *demux)
 387 {
 388     demux_sys_t *sys = demux->p_sys;
 389
 390     if (sys->deadline == VLC_TS_INVALID)
 391         sys->deadline = sys->dts + 1;
 392
 393     for (;;) {
 394         if (sys->deadline <= sys->dts)
 395             break;
 396
 397         /* */
 398         int64_t dts, pts;
 399         unsigned flags;
 400         size_t buffer_size;
 401         void   *buffer;
 402
 403         if (sys->source.get(sys->source.data, &dts, &pts, &flags, &buffer_size, &buffer))
 404             return 0;
 405
 406         if (dts < 0)
 407             dts = pts;
 408
 409         if (buffer_size > 0) {
 410             block_t *block = block_New(demux, buffer_size);
 411             if (block) {
 412                 block->i_dts = dts >= 0 ? (1 + dts) : VLC_TS_INVALID;
 413                 block->i_pts = pts >= 0 ? (1 + pts) : VLC_TS_INVALID;
 414                 memcpy(block->p_buffer, buffer, buffer_size);
 415
 416                 es_out_Control(demux->out, ES_OUT_SET_PCR, block->i_dts);
 417                 es_out_Send(demux->out, sys->es, block);
 418             }
 419         }
 420
 421         sys->dts = dts;
 422
 423         sys->source.release(sys->source.data, buffer_size, buffer);
 424     }
 425     sys->deadline = VLC_TS_INVALID;
 426     return 1;
 427 }
 428
 429 /**
 430  * It parses a rational number (it also accepts basic float number).
 431  *
 432  * It returns an error if the rational number cannot be parsed (0/0 is valid).
 433  */
 434 static int var_CreateGetRational(demux_t *demux,
 435                                  unsigned *num, unsigned *den,
 436                                  const char *var)
 437 {
 438     /* */
 439     *num = 0;
 440     *den = 0;
 441
 442     /* */
 443     char *tmp = var_CreateGetString(demux, var);
 444     if (!tmp)
 445         goto error;
 446
 447     char *next;
 448     unsigned n = strtol(tmp,  &next, 0);
 449     unsigned d = strtol(*next ? &next[1] : "0", NULL, 0);
 450
 451     if (*next == '.') {
 452         /* Interpret as a float number */
 453         double r = us_atof(tmp);
 454         double c = ceil(r);
 455         if (c >= UINT_MAX)
 456             goto error;
 457         unsigned m = c;
 458         if (m > 0) {
 459             d = UINT_MAX / m;
 460             n = r * d;
 461         } else {
 462             n = 0;
 463             d = 0;
 464         }
 465     }
 466
 467     if (n > 0 && d > 0)
 468         vlc_ureduce(num, den, n, d, 0);
 469
 470     free(tmp);
 471     return VLC_SUCCESS;
 472
 473 error:
 474     free(tmp);
 475     return VLC_EGENERIC;
 476 }
 477
 478 /**
 479  * Parse the MRL and extract configuration from it.
 480  *
 481  * Syntax: option1=value1[:option2=value2[...]]
 482  *
 483  * XXX get and release are not supported on purpose.
 484  */
 485 static void ParseMRL(demux_t *demux)
 486 {
 487     static const struct {
 488         const char *name;
 489         int        type;
 490     } options[] = {
 491         { "caching",    VLC_VAR_INTEGER },
 492         { "id",         VLC_VAR_INTEGER },
 493         { "group",      VLC_VAR_INTEGER },
 494         { "cat",        VLC_VAR_INTEGER },
 495         { "samplerate", VLC_VAR_INTEGER },
 496         { "channels",   VLC_VAR_INTEGER },
 497         { "width",      VLC_VAR_INTEGER },
 498         { "height",     VLC_VAR_INTEGER },
 499         { "data",       VLC_VAR_STRING },
 500         { "codec",      VLC_VAR_STRING },
 501         { "language",   VLC_VAR_STRING },
 502         { "dar",        VLC_VAR_STRING },
 503         { "fps",        VLC_VAR_STRING },
 504         { NULL, -1 }
 505     };
 506
 507     char *dup = strdup(demux->psz_path);
 508     if (!dup)
 509         return;
 510     char *current = dup;
 511
 512     while (current) {
 513         char *next = strchr(current, ':');
 514         if (next)
 515             *next++ = '\0';
 516
 517         char *option = current;
 518         char *value = strchr(current, '=');
 519         if (value) {
 520             *value++ = '\0';
 521             msg_Dbg(demux, "option '%s' value '%s'", option, value);
 522         } else {
 523             msg_Dbg(demux, "option '%s' without value (unsupported)", option);
 524         }
 525
 526         char *name;
 527         if (asprintf(&name, "imem-%s", option) < 0)
 528             name = NULL;
 529         for (unsigned i = 0; name && options[i].name; i++) {
 530             if (strcmp(options[i].name, option))
 531                 continue;
 532             /* */
 533             var_Create(demux, name, options[i].type | VLC_VAR_DOINHERIT);
 534             if (options[i].type == VLC_VAR_INTEGER && value) {
 535                 var_SetInteger(demux, name, strtol(value, NULL, 0));
 536             } else if (options[i].type == VLC_VAR_STRING && value) {
 537                 var_SetString(demux, name, value);
 538             }
 539             break;
 540         }
 541         free(name);
 542
 543         /* */
 544         current = next;
 545     }
 546     free(dup);
 547 }