research.m1stereo.tv/gitweb/ - melted/blob - docs/services.txt

   1 Producers
   2 ---------
   3
   4         ffmpeg
   5
   6                 Description
   7
   8                         Test case pipe based producer for video and audio.
   9
  10                 Constructor Argument
  11
  12                         'file'  - produce a/v from file
  13                         v4l             - produce a/v from video4linux and dsp device
  14
  15                 Initialisation Properties
  16
  17                         string video_type - "file" or "v4l"
  18                         string video_file - file or v4l device
  19                         string video_size - WxH of video to produce (default: "")
  20                         int video_loop - loop video until audio exhausted (default: 0)
  21                         string audio_type - "file" or "dsp"
  22                         string audio_file - file or dsp device
  23                         int audio_rate - audio frequency (default: 48000)
  24                         int audio_channels - audio channels (default: 2)
  25                         int audio_track - audio track to use (default: 0)
  26                         int audio_loop - loop audio until video exhausted (default: 0)
  27                         timecode in - in point
  28                         timecode out - out point
  29                         double fps - output frames per second (default: 25)
  30                         double aspect_ratio - aspect ratio of video
  31
  32                 Read Only Properties
  33
  34                         string resource - file or "v4l"
  35                         int end_of_clip - holds 1 when input is exhausted
  36
  37                 Dependencies
  38
  39                         ffmpeg executable.
  40
  41                 Known Bugs
  42
  43                         in point setting is broken.
  44
  45                         Implementation does not allow fast random access.
  46
  47         libdv
  48
  49                 Description
  50
  51                         libdv based decoder for video and audio.
  52
  53                 Constructor Argument
  54
  55                         'file'  - produce a/v from file
  56
  57                 Initialisation Properties
  58
  59                         timecode in - in point
  60                         timecode out - out point
  61
  62                 Read Only Properties
  63
  64                         string resource - file location
  65                         double fps - output frames per second
  66                         double aspect_ratio - aspect ratio of video]
  67                         timecode length - duration of resource (in seconds)
  68
  69                 Dependencies
  70
  71                         libdv.
  72
  73                 Known Bugs
  74
  75                         None.
  76
  77         mcdv
  78
  79                 Description
  80
  81                         Mainconcept based dv decoder for video and audio.
  82
  83                 Constructor Argument
  84
  85                         'file'  - produce a/v from file
  86
  87                 Initialisation Properties
  88
  89                         timecode in - in point
  90                         timecode out - out point
  91
  92                 Read Only Properties
  93
  94                         string resource - file location
  95                         double fps - output frames per second
  96                         double aspect_ratio - aspect ratio of video
  97                         timecode length - duration of resource (in seconds)
  98
  99                 Dependencies
 100
 101                         mainconcept dv sdk and libdv.
 102                         "dv_sdk" installed parallel to mlt.
 103
 104                 Known Bugs
 105
 106                         Can be problematic with source NTSC DV files? really? yes - try
 107                         playing pond.dv...
 108
 109         mcmpeg
 110
 111                 Description
 112
 113                         Mainconcept based mpeg decoder for video and audio.
 114
 115                 Constructor Argument
 116
 117                         'file'  - produce a/v from file
 118
 119                 Initialisation Properties
 120
 121                         timecode in - in point
 122                         timecode out - out point
 123
 124                 Read Only Properties
 125
 126                         string resource - file location
 127                         double fps - output frames per second
 128                         double aspect_ratio - aspect ratio of video
 129
 130                 Dependencies
 131
 132                         mainconcept mpeg sdk.
 133                         "mpeg_sdk_demo" installed parallel to mlt.
 134
 135                 Known Bugs
 136
 137                         None.
 138
 139         pango
 140
 141                 Description
 142
 143                         A title generator that uses the Pango international text layout
 144                         and Freetype2 font renderer.
 145
 146                 Constructor Argument
 147
 148                         string file - a text file containing Pango markup, see:
 149                                    http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.html
 150                                    - requires xml-like encoding special chars: <, >, & to &lt;, &gt;, &amp;
 151
 152                 Initialisation Properties
 153
 154                         timecode in - in point
 155                         timecode out - out point
 156
 157                 Mutable Properties
 158
 159                         int video_standard - enum mlt_video_standard from mlt_frame.h
 160                                              PAL = 0, NTSC = 1
 161                                              this determines proper pixel aspect ratio
 162
 163                         string markup - a string containing Pango markup see:
 164                                         http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.html
 165                                       - requires xml-like encoding special chars: <, >, & to &lt;, &gt;, &amp;
 166
 167                         int fgcolor - an rgba color specification of the text (i.e. 0xrrggbbaa)
 168                         int bgcolor - an rgba color of the background rectangle
 169                         int align - paragraph alignment: 0 = left, 1 = center, 2 = right
 170                         int pad - the number of pixels to pad the background rectangle beyond edges of text
 171                                   default 0
 172                         string markup - see constructor argument
 173                         string text - non-markup text (can contain markup chars un-encoded)
 174                         string font - the default typeface to use when not using markup
 175                                       default "Sans 48"
 176                         int x - the horizontal position of the title on the frame
 177                                 default 0
 178                         int y - the vertical position of the title on the frame
 179                                 default 0
 180                         double mix - the overall opacity control of the generated title
 181                                      default 1.0
 182
 183                 Read Only Properties
 184
 185                         string resource - the text/markup file or "pango" if no file
 186
 187                 Dependencies
 188
 189                         libpango-1.0, libpangoft2-1.0, libfreetype, libgdk_pixbuf-2.0, libglib-2.0,
 190                         libgobject-2.0, libgmodule-2.0, libfontconfig
 191
 192                 Known Bugs
 193
 194                         no frame-alignment functionality
 195
 196         pixbuf
 197
 198                 Description
 199
 200                         A graphics overlay generator using gdk-pixbuf
 201
 202                 Constructor Argument
 203
 204                         'file' - The name of a graphics file loadable by
 205                                  a gdk-pixbuf loader. see /usr/lib/gdk-pixbuf/loaders
 206                                  definitely png, jpeg, tiff, pnm, and xpm
 207                                - If "%" in filename, the filename is used with sprintf
 208                                  generate a filename from a counter for multi-file/flipbook animation.
 209                                  The file sequence ends when numeric discontinuity >100.
 210                                - If filename contains "/.all.", suffix with an extension to load
 211                                  all pictures with matching extension from a directory
 212
 213                 Initialisation Properties
 214
 215                         timecode in - in point
 216                         timecode out - out point
 217
 218                 Mutable Properties
 219
 220                         int video_standard - enum mlt_video_standard from mlt_frame.h
 221                                              PAL = 0, NTSC = 1
 222                                              this determines proper pixel aspect ratio
 223                         double ttl - how long (seconds) to repeat each picture in file sequences
 224                         int x - the horizontal offset from the left edge of the frame
 225                         int y - the vertical offset from the top edge of the frame
 226                         double mix - the opacity factor to apply to the second frame
 227                                      (used in addition to alpha channel).
 228
 229
 230                 Read Only Properties
 231
 232                         string resource - file location
 233
 234                 Dependencies
 235
 236                         libgdk_pixbuf-2.0, libglib-2.0, libgobject-2.0, libgmodule-2.0
 237
 238                 Known Bugs
 239
 240                         in/out settings are incorrectly handled.
 241
 242         ppm
 243                 Description
 244                 Constructor Argument
 245                 Initialisation Properties
 246                 Read Only Properties
 247                 Dependencies
 248                 Known Bugs
 249
 250
 251 Filters
 252 -------
 253
 254         deinterlace
 255
 256                 Description
 257                 Constructor Argument
 258                 Initialisation Properties
 259                 Read Only Properties
 260                 Dependencies
 261                 Known Bugs
 262
 263         ffmpeg_dub
 264
 265                 Description
 266                 Constructor Argument
 267                 Initialisation Properties
 268                 Read Only Properties
 269                 Dependencies
 270                 Known Bugs
 271
 272         gamma
 273
 274                 Description
 275                 Constructor Argument
 276                 Initialisation Properties
 277                 Read Only Properties
 278                 Dependencies
 279                 Known Bugs
 280
 281         greyscale
 282
 283                 Description
 284                 Constructor Argument
 285                 Initialisation Properties
 286                 Read Only Properties
 287                 Dependencies
 288                 Known Bugs
 289
 290         resize
 291
 292                 Description
 293                 Constructor Argument
 294                 Initialisation Properties
 295                 Read Only Properties
 296                 Dependencies
 297                 Known Bugs
 298
 299 Transitions
 300 -----------
 301
 302         composite
 303
 304                 Description
 305
 306                         An alpha-channel based compositor for two frames.
 307
 308                 Constructor Argument
 309
 310                         none
 311
 312                 Mutable Properties
 313
 314                         int x - the horizontal offset from the left edge of the frame
 315                         int y - the vertical offset from the top edge of the frame
 316                         double mix - the opacity factor to apply to the second frame
 317                                      (used in addition to alpha channel).
 318
 319                 Read Only Properties
 320
 321                         none
 322
 323                 Dependencies
 324
 325                         none
 326
 327                 Known Bugs
 328
 329                         Need to add field-based rendering.
 330
 331         luma
 332
 333                 Description
 334
 335                         A generic dissolve and wipe transition processor. It gets its name
 336                         from how it uses a grayscale "map" file. As the luma value varies
 337                         over time, a threshold filter is applied to the map to determine
 338                         what parts of frame A vs. frame B to show. It only reads PGM
 339                         files, but it does handle 16 bit PGM. This performs field-based
 340                         rendering.
 341
 342                 Constructor Argument
 343
 344                         string file - the luma map file name. If not supplied, a dissolve.
 345
 346                 Mutable Properties
 347
 348                         string filename - same as above
 349                         double softness - only when using a luma map, how soft to make the
 350                                           edges between A and B. 0.0 = no softness. 1.0 =
 351                                           too soft.
 352
 353                 Read Only Properties
 354
 355                         none
 356
 357                 Dependencies
 358
 359                         none
 360
 361                 Known Bugs
 362
 363                         The luma map must be the same size as the B frame.
 364
 365 Consumers
 366 ---------
 367
 368         bluefish
 369
 370                 Description
 371
 372                         BlueFish444 audio and video output module.
 373
 374                 Constructor Argument
 375
 376                         int video_standard - 0 = PAL, 1 = NTSC
 377
 378                 Initialisation Properties
 379
 380                         int video_standard - see above
 381
 382                 Read Only Properties
 383
 384                         none
 385
 386                 Dependencies
 387
 388                         BlueVelvet SDK installed parallel to mlt in "bluefish."
 389
 390                 Known Bugs
 391
 392                         If mlt crashes, you must reload the BlueDriver kernel module
 393                         due to unreleased DMA buffers.
 394                         Needs an argument or property for multi-card address.
 395
 396         ffmpeg
 397
 398                 Description
 399                 Constructor Argument
 400                 Initialisation Properties
 401                 Read Only Properties
 402                 Dependencies
 403                 Known Bugs
 404
 405         sdl
 406                 Description
 407
 408                         Simple DirectMedia Layer audio and video output module.
 409
 410                 Constructor Argument
 411
 412                         string video_standard - "PAL" (default), "NTSC", or "WxH"
 413
 414                 Mutable Properties
 415
 416                         double volume - audio level factor
 417                         int video_off - if 1, disable video output
 418                         int audio_off - if 1, disable audio output
 419                         int scale_overlay - if 1, resample video from source pixel aspect
 420                                             ratio to square pixels.
 421
 422                 Read Only Properties
 423
 424                         none
 425
 426                 Dependencies
 427
 428                         libSDL-1.2, libasound, libaudio, libXt, libX11, libXext, libSM, libICE
 429
 430                 Known Bugs
 431
 432                         NTSC handling needs tightening up - sdl:NTSC is the only valid
 433                         constructor for NTSC playback at the moment.
 434