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
 103                 Known Bugs
 104
 105                         Can be problematic with source NTSC DV files? really?
 106
 107         mcmpeg
 108
 109                 Description
 110
 111                         Mainconcept based mpeg decoder for video and audio.
 112
 113                 Constructor Argument
 114
 115                         'file'  - produce a/v from file
 116
 117                 Initialisation Properties
 118
 119                         timecode in - in point
 120                         timecode out - out point
 121
 122                 Read Only Properties
 123
 124                         string resource - file location
 125                         double fps - output frames per second
 126                         double aspect_ratio - aspect ratio of video
 127
 128                 Dependencies
 129
 130                         mainconcept mpeg sdk.
 131
 132                 Known Bugs
 133
 134                         None.
 135
 136         pango
 137
 138                 Description
 139
 140                         A title generator that uses the Pango international text layout
 141                         and Freetype2 font renderer.
 142
 143                 Constructor Argument
 144
 145                         'markup' - a string containing Pango markup see:
 146                                    http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.html
 147                                    - requires xml-like encoding special chars: <, > ( and '&' and '"' ?)
 148
 149                 Initialisation Properties
 150
 151                         timecode in - in point
 152                         timecode out - out point
 153                         int video_standard - enum mlt_video_standard from mlt_frame.h
 154                                              PAL = 0, NTSC = 1
 155                                              this determines proper pixel aspect ratio
 156
 157                         int fgcolor - an rgba color specification of the text (i.e. 0xrrggbbaa)
 158                         int bgcolor - an rgba color of the background rectangle
 159                         int align - paragraph alignment: 0 = left, 1 = center, 2 = right
 160                         int pad - the number of pixels to pad the background rectangle beyond edges of text
 161                                   default 0
 162                         string markup - see constructor argument
 163                         string text - non-markup text (can contain markup chars un-encoded)
 164                         string font - the default typeface to use when not using markup
 165                                       default "Sans 48"
 166                         int x - the horizontal position of the title on the frame
 167                                 default 0
 168                         int y - the vertical position of the title on the frame
 169                                 default 0
 170                         double mix - the overall opacity control of the generated title
 171                                      default 1.0
 172
 173                 Read Only Properties
 174
 175                         string resource - "pango"
 176
 177                 Dependencies
 178
 179                         libpango-1.0, libpangoft2-1.0, libfreetype, libgdk_pixbuf-2.0, libglib-2.0,
 180                         libgobject-2.0, libgmodule-2.0, libfontconfig
 181
 182                 Known Bugs
 183
 184                         no frame-alignment functionality
 185
 186         pixbuf
 187
 188                 Description
 189
 190                         A graphics overlay generator using gdk-pixbuf
 191
 192                 Constructor Argument
 193
 194                         'file' - The name of a graphics file loadable by
 195                                  a gdk-pixbuf loader. see /usr/lib/gdk-pixbuf/loaders
 196                                  definitely png, jpeg, tiff, pnm, and xpm
 197                                - If "%" in filename, the filename is used with sprintf
 198                                  generate a filename from a counter for multi-file/flipbook animation.
 199                                  The file sequence ends when numeric discontinuity >100.
 200                                - If filename contains "/.all.", suffix with an extension to load
 201                                  all pictures with matching extension from a directory
 202
 203                 Initialisation Properties
 204
 205                         timecode in - in point
 206                         timecode out - out point
 207                         int video_standard - enum mlt_video_standard from mlt_frame.h
 208                                              PAL = 0, NTSC = 1
 209                                              this determines proper pixel aspect ratio
 210                         double ttl - how long (seconds) to repeat each picture in file sequences
 211
 212                 Read Only Properties
 213
 214                         string resource - file location
 215
 216                 Dependencies
 217
 218                         libgdk_pixbuf-2.0, libglib-2.0, libgobject-2.0, libgmodule-2.0
 219
 220                 Known Bugs
 221
 222                         none
 223
 224         ppm
 225                 Description
 226                 Constructor Argument
 227                 Initialisation Properties
 228                 Read Only Properties
 229                 Dependencies
 230                 Known Bugs
 231
 232
 233 Filters
 234 -------
 235
 236         deinterlace
 237
 238                 Description
 239                 Constructor Argument
 240                 Initialisation Properties
 241                 Read Only Properties
 242                 Dependencies
 243                 Known Bugs
 244
 245         ffmpeg_dub
 246
 247                 Description
 248                 Constructor Argument
 249                 Initialisation Properties
 250                 Read Only Properties
 251                 Dependencies
 252                 Known Bugs
 253
 254         gamma
 255
 256                 Description
 257                 Constructor Argument
 258                 Initialisation Properties
 259                 Read Only Properties
 260                 Dependencies
 261                 Known Bugs
 262
 263         greyscale
 264
 265                 Description
 266                 Constructor Argument
 267                 Initialisation Properties
 268                 Read Only Properties
 269                 Dependencies
 270                 Known Bugs
 271
 272         resize
 273
 274                 Description
 275                 Constructor Argument
 276                 Initialisation Properties
 277                 Read Only Properties
 278                 Dependencies
 279                 Known Bugs
 280
 281 Transitions
 282 -----------
 283
 284         composite
 285
 286                 Description
 287                 Constructor Argument
 288                 Initialisation Properties
 289                 Read Only Properties
 290                 Dependencies
 291                 Known Bugs
 292
 293         luma
 294
 295                 Description
 296                 Constructor Argument
 297                 Initialisation Properties
 298                 Read Only Properties
 299                 Dependencies
 300                 Known Bugs
 301
 302 Consumers
 303 ---------
 304
 305         bluefish
 306
 307                 Description
 308                 Constructor Argument
 309                 Initialisation Properties
 310                 Read Only Properties
 311                 Dependencies
 312                 Known Bugs
 313
 314         ffmpeg
 315
 316                 Description
 317                 Constructor Argument
 318                 Initialisation Properties
 319                 Read Only Properties
 320                 Dependencies
 321                 Known Bugs
 322
 323         sdl
 324                 Description
 325                 Constructor Argument
 326                 Initialisation Properties
 327                 Read Only Properties
 328                 Dependencies
 329                 Known Bugs