git.sesse.net Git - vlc/blob - share/lua/README.txt

   1 Instructions to code your own VLC Lua scripts and extensions
   2 $Id$
   3
   4 1 - About Lua
   5 =============
   6
   7 Lua documentation is available on http://www.lua.org/ . The reference manual
   8 is very useful: http://www.lua.org/manual/5.1/ .
   9 VLC uses Lua 5.1
  10 All the Lua standard libraries are available.
  11
  12
  13 2 - Lua in VLC
  14 ==============
  15
  16 Several types of VLC Lua scripts can currently be coded:
  17  * Playlist and websites parsers (see playlist/README.txt)
  18  * Art fetchers (see meta/README.txt)
  19  * Interfaces (see intf/README.txt)
  20  * Extensions (see extensions/README.txt)
  21  * Services Discovery (see sd/README.txt)
  22
  23 Lua scripts are tried in alphabetical order in the user's VLC config
  24 directory lua/{playlist,meta,intf}/ subdirectory on Windows and Mac OS X or
  25 in the user's local share directory (~/.local/share/vlc/lua/... on linux),
  26 then in the global VLC lua/{playlist,meta,intf}/ directory.
  27
  28
  29 3 - VLC specific Lua modules
  30 ============================
  31
  32 All VLC specifics modules are in the "vlc" object. For example, if you want
  33 to use the "info" function of the "msg" VLC specific Lua module:
  34 vlc.msg.info( "This is an info message and will be displayed in the console" )
  35
  36 Note: availability of the different VLC specific Lua modules depends on
  37 the type of VLC Lua script your are in.
  38
  39 Configuration
  40 -------------
  41 config.get( name ): Get the VLC configuration option "name"'s value.
  42 config.set( name, value ): Set the VLC configuration option "name"'s value.
  43 config.datadir(): Get the VLC data directory.
  44 config.userdatadir(): Get the user's VLC data directory.
  45 config.homedir(): Get the user's home directory.
  46 config.configdir(): Get the user's VLC config directory.
  47 config.cachedir(): Get the user's VLC cache directory.
  48
  49 config.datadir_list( name ): Get the list of possible data directories in
  50                              order of priority, appended by "name"
  51
  52 Dialog
  53 ------
  54 local d = vlc.dialog( "My VLC Extension" ): Create a new UI dialog, with a human-readable title: "My VLC Extension"
  55 d:show(): Show this dialog.
  56 d:hide(): Hide (but not close) this dialog.
  57 d:delete(): Close and delete this dialog.
  58 d:set_title( title ): set the title of this dialog.
  59 d:update(): Update the dialog immediately (don't wait for the current function to return)
  60 d:del_widget( widget ): Delete 'widget'. It disappears from the dialog and repositioning may occur.
  61
  62 In the following functions, you can always add some optional parameters: col, row, col_span, row_span, width, height.
  63 They define the position of a widget in the dialog:
  64 - row, col are the absolute positions on a grid of widgets. First row, col are 1.
  65 - row_span, col_span represent the relative size of a widget on the grid. A widget with col_span = 4 will be displayed as wide as 4 widgets of col_span = 1.
  66 - width and height are size hints (in pixels) but may be discarded by the GUI module
  67 Example: w = d:add_label( "My Label", 2, 3, 4, 5 ) will create a label at row 3, col 2, with a relative width of 4, height of 5.
  68
  69 d:add_button( text, func, ... ): Create a button with caption "text" (string). When clicked, call function "func". func is a function reference.
  70 d:add_label( text, ... ): Create a text label with caption "text" (string).
  71 d:add_html( text, ... ): Create a rich text label with caption "text" (string), that supports basic HTML formatting (such as <i> or <h1> for instance).
  72 d:add_text_input( text, ... ): Create an editable text field, in order to read user input.
  73 d:add_password( text, ... ): Create an editable text field, in order to read user input. Text entered in this box will not be readable (replaced by asterisks).
  74 d:add_check_box( text, ... ): Create a check box with a text. They have a boolean state (true/false).
  75 d:add_dropdown( ... ): Create a drop-down widget. Only 1 element can be selected the same time.
  76 d:add_list( ... ): Create a list widget. Allows multiple or empty selections.
  77 d:add_image( path, ... ): Create an image label. path is a relative or absolute path to the image on the local computer.
  78
  79 Some functions can also be applied on widgets:
  80 w:set_text( text ): Change text displayed by the widget. Applies to: button, label, html, text_input, password, check_box.
  81 w:get_text(): Read text displayed by the widget. Returns a string. Applies to: button, label, html, text_input, password, check_box.
  82 w:set_checked( bool ): Set check state of a check box. Applies to: check_box.
  83 w:get_checked(): Read check state of a check box. Returns a boolean. Applies to: check_box.
  84 w:add_value( text, id ): Add a value with identifier 'id' (integer) and text 'text'. It's always best to have unique identifiers. Applies to: drop_down.
  85 w:get_value(): Return identifier of the selected item. Corresponds to the text value chosen by the user. Applies to: drop_down.
  86 w:clear(): Clear a list or drop_down widget. After that, all values previously added are lost.
  87 w:get_selection(): Retrieve a table representing the current selection. Keys are the ids, values are the texts associated. Applies to: list.
  88
  89
  90 Extension
  91 ---------
  92 deactivate(): Deactivate current extension (after the end of the current function).
  93
  94 HTTPd
  95 -----
  96 http( host, port, [cert, key, ca, crl]): create a new HTTP (SSL) daemon.
  97
  98 local h = vlc.httpd( "localhost", 8080 )
  99 h:handler( url, user, password, callback, data ) -- add a handler for given url. If user and password are non nil, they will be used to authenticate connecting clients. callback will be called to handle connections. The callback function takes 7 arguments: data, url, request, type, in, addr, host. It returns the reply as a string.
 100 h:file( url, mime, user, password, callback, data ) -- add a file for given url with given mime type. If user and password are non nil, they will be used to authenticate connecting clients. callback will be called to handle connections. The callback function takes 2 arguments: data and request. It returns the reply as a string.
 101 h:redirect( url_dst, url_src ): Redirect all connections from url_src to url_dst.
 102
 103 Input
 104 -----
 105 input.is_playing(): Return true if input exists.
 106 input.add_subtitle(url): Add a subtitle to the current input
 107 input.item(): Get the current input item. Input item methods are:
 108   :uri(): Get item's URI.
 109   :name(): Get item's name.
 110   :duration(): Get item's duration in seconds or negative value if unavailable.
 111   :is_preparsed(): Return true if meta data has been preparsed
 112   :metas(): Get meta data as a table.
 113   :set_meta(key, value): Set meta data.
 114   :info(): Get the current input's info. Return value is a table of tables. Keys of the top level table are info category labels.
 115   :stats(): Get statistics about the input. This is a table with the following fields:
 116     .read_packets
 117     .read_bytes
 118     .input_bitrate
 119     .average_input_bitrate
 120     .demux_read_packets
 121     .demux_read_bytes
 122     .demux_bitrate
 123     .average_demux_bitrate
 124     .demux_corrupted
 125     .demux_discontinuity
 126     .decoded_audio
 127     .decoded_video
 128     .displayed_pictures
 129     .lost_pictures
 130     .sent_packets
 131     .sent_bytes
 132     .send_bitrate
 133     .played_abuffers
 134     .lost_abuffers
 135
 136 Messages
 137 --------
 138 msg.dbg( [str1, [str2, [...]]] ): Output debug messages (-vv).
 139 msg.warn( [str1, [str2, [...]]] ): Output warning messages (-v).
 140 msg.err( [str1, [str2, [...]]] ): Output error messages.
 141 msg.info( [str1, [str2, [...]]] ): Output info messages.
 142
 143 Misc (Interfaces only)
 144 ----------------------
 145 ----------------------------------------------------------------
 146 /!\ NB: this namespace is ONLY usable for interfaces.
 147 ---
 148 ----------------------------------------------------------------
 149 misc.version(): Get the VLC version string.
 150 misc.copyright(): Get the VLC copyright statement.
 151 misc.license(): Get the VLC license.
 152
 153 misc.action_id( name ): get the id of the given action.
 154
 155 misc.mdate(): Get the current date (in microseconds).
 156 misc.mwait(): Wait for the given date (in microseconds).
 157
 158 misc.quit(): Quit VLC.
 159
 160 Net
 161 ---
 162 net.url_parse( url, [option delimiter] ): Parse URL. Returns a table with
 163   fields "protocol", "username", "password", "host", "port", path" and
 164   "option".
 165 net.listen_tcp( host, port ): Listen to TCP connections. This returns an
 166   object with an accept and an fds method. accept is blocking (Poll on the
 167   fds with the net.POLLIN flag if you want to be non blocking).
 168   The fds method returns a list of fds you can call poll on before using
 169   the accept method. For example:
 170 local l = vlc.net.listen_tcp( "localhost", 1234 )
 171 while true do
 172   local fd = l:accept()
 173   if fd >= 0 do
 174     net.send( fd, "blabla" )
 175     net.close( fd )
 176   end
 177 end
 178 net.connect_tcp( host, port ): open a connection to the given host:port (TCP).
 179 net.close( fd ): Close file descriptor.
 180 net.send( fd, string, [length] ): Send data on fd.
 181 net.recv( fd, [max length] ): Receive data from fd.
 182 net.poll( { fd = events } ): Implement poll function.
 183   Returns the numbers of file descriptors with a non 0 revent. The function
 184   modifies the input table to { fd = revents }. See "man poll".
 185 net.POLLIN/POLLPRI/POLLOUT/POLLRDHUP/POLLERR/POLLHUP/POLLNVAL: poll event flags
 186 net.read( fd, [max length] ): Read data from fd.
 187 net.write( fd, string, [length] ): Write data to fd.
 188 net.stat( path ): Stat a file. Returns a table with the following fields:
 189     .type
 190     .mode
 191     .uid
 192     .gid
 193     .size
 194     .access_time
 195     .modification_time
 196     .creation_time
 197 net.opendir( path ): List a directory's contents.
 198
 199 Objects
 200 -------
 201 object.input(): Get the current input object.
 202 object.playlist(): Get the playlist object.
 203 object.libvlc(): Get the libvlc object.
 204 object.aout(): Get the audio output object.
 205 object.vout(): Get the video output object.
 206
 207 object.find( object, type, mode ): Return nil. DO NOT USE.
 208
 209 OSD
 210 ---
 211 osd.icon( type, [id] ): Display an icon on the given OSD channel. Uses the
 212   default channel is none is given. Icon types are: "pause", "play",
 213   "speaker" and "mute".
 214 osd.message( string, [id], [position], [duration] ): Display the text message on
 215   the given OSD channel. Position types are: "center", "left", "right", "top",
 216   "bottom", "top-left", "top-right", "bottom-left" or "bottom-right". The
 217   duration is set in microseconds.
 218 osd.slider( position, type, [id] ): Display slider. Position is an integer
 219   from 0 to 100. Type can be "horizontal" or "vertical".
 220 osd.channel_register(): Register a new OSD channel. Returns the channel id.
 221 osd.channel_clear( id ): Clear OSD channel.
 222
 223 Playlist
 224 --------
 225 playlist.prev(): Play previous track.
 226 playlist.next(): Play next track.
 227 playlist.skip( n ): Skip n tracks.
 228 playlist.play(): Play.
 229 playlist.pause(): Pause.
 230 playlist.stop(): Stop.
 231 playlist.clear(): Clear the playlist.
 232 playlist.repeat_( [status] ): Toggle item repeat or set to specified value.
 233 playlist.loop( [status] ): Toggle playlist loop or set to specified value.
 234 playlist.random( [status] ): Toggle playlist random or set to specified value.
 235 playlist.goto( id ): Go to specified track.
 236 playlist.add( ... ): Add a bunch of items to the playlist.
 237   The playlist is a table of playlist objects.
 238   A playlist object has the following members:
 239       .path: the item's full path / URL
 240       .name: the item's name in playlist (OPTIONAL)
 241       .title: the item's Title (OPTIONAL, meta data)
 242       .artist: the item's Artist (OPTIONAL, meta data)
 243       .genre: the item's Genre (OPTIONAL, meta data)
 244       .copyright: the item's Copyright (OPTIONAL, meta data)
 245       .album: the item's Album (OPTIONAL, meta data)
 246       .tracknum: the item's Tracknum (OPTIONAL, meta data)
 247       .description: the item's Description (OPTIONAL, meta data)
 248       .rating: the item's Rating (OPTIONAL, meta data)
 249       .date: the item's Date (OPTIONAL, meta data)
 250       .setting: the item's Setting (OPTIONAL, meta data)
 251       .url: the item's URL (OPTIONAL, meta data)
 252       .language: the item's Language (OPTIONAL, meta data)
 253       .nowplaying: the item's NowPlaying (OPTIONAL, meta data)
 254       .publisher: the item's Publisher (OPTIONAL, meta data)
 255       .encodedby: the item's EncodedBy (OPTIONAL, meta data)
 256       .arturl: the item's ArtURL (OPTIONAL, meta data)
 257       .trackid: the item's TrackID (OPTIONAL, meta data)
 258       .options: a list of VLC options (OPTIONAL)
 259                 example: .options = { "fullscreen" }
 260       .duration: stream duration in seconds (OPTIONAL)
 261       .meta: custom meta data (OPTIONAL, meta data)
 262              A .meta field is a table of custom meta key value pairs.
 263              example: .meta = { ["GVP docid"] = "-5784010886294950089", ["GVP version] = "1.1", Hello = "World!" }
 264   Invalid playlist items will be discarded by VLC.
 265 playlist.enqueue( ... ): like playlist.add() except that track isn't played.
 266 playlist.get( [what, [tree]] ): Get the playlist.
 267   If "what" is a number, then this will return the corresponding playlist
 268   item's playlist hierarchy. If it is "normal" or "playlist", it will
 269   return the normal playlist. If it is "ml" or "media library", it will
 270   return the media library. If it is "root" it will return the full playlist.
 271   If it is a service discovery module's name, it will return that service
 272   discovery's playlist. If it is any other string, it won't return anything.
 273   Else it will return the full playlist.
 274   The second argument, "tree", is optional. If set to true or unset, the
 275   playlist will be returned in a tree layout. If set to false, the playlist
 276   will be returned using the flat layout.
 277   Each playlist item returned will have the following members:
 278       .item: The input item.
 279       .id: The item's id.
 280       .flags: a table with the following members if the corresponding flag is
 281               set:
 282           .save
 283           .skip
 284           .disabled
 285           .ro
 286           .remove
 287           .expanded
 288       .name:
 289       .path:
 290       .duration: (-1 if unknown)
 291       .nb_played:
 292       .children: A table of children playlist items.
 293 playlist.search( name ): filter the playlist items with the given string
 294 playlist.current(): return the current input item id
 295 playlist.sort( key ): sort the playlist according to the key.
 296   Key must be one of the followings values: 'id', 'title', 'title nodes first',
 297                                             'artist', 'genre', 'random', 'duration',
 298                                             'title numeric' or 'album'.
 299 playlist.status(): return the playlist status: 'stopped', 'playing', 'paused' or 'unknown'.
 300 playlist.delete( id ): check if item of id is in playlist and delete it. returns -1 when invalid id.
 301 playlist.move( id_item, id_where ): take id_item and if id_where has children, it put it as first children,
 302    if id_where don't have children, id_item is put after id_where in same playlist. returns -1 when invalid ids.
 303
 304 FIXME: add methods to get an item's meta, options, es ...
 305
 306 SD
 307 --
 308 sd.get_services_names(): Get a table of all available service discovery
 309   modules. The module name is used as key, the long name is used as value.
 310 sd.add( name ): Add service discovery.
 311 sd.remove( name ): Remove service discovery.
 312 sd.is_loaded( name ): Check if service discovery is loaded.
 313 sd.add_node( ... ): Add a node to the service discovery.
 314   The node object has the following members:
 315       .title: the node's name
 316       .arturl: the node's ArtURL (OPTIONAL)
 317       .category: the node's category (OPTIONAL)
 318 sd.add_item( ... ): Add an item to the service discovery.
 319   The item object has the same members as the one in playlist.add() along with:
 320       .category: the item's category (OPTIONAL)
 321   Returns the input item.
 322 sd.remove_item( item ): remove the item.
 323
 324 n = vlc.sd.add_node( {title="Node"} )
 325 n:add_subitem( ... ): Same as sd.add_item(), but as a subitem of n.
 326 n:add_subnode( ... ): Same as sd.add_node(), but as a subnode of n.
 327
 328 d = vlc.sd.add_item( ... ) Get an item object to perform following set operations on it:
 329 d:set_name(): the item's name in playlist
 330 d:set_title(): the item's Title (OPTIONAL, meta data)
 331 d:set_artist(): the item's Artist (OPTIONAL, meta data)
 332 d:set_genre(): the item's Genre (OPTIONAL, meta data)
 333 d:set_copyright(): the item's Copyright (OPTIONAL, meta data)
 334 d:set_album(): the item's Album (OPTIONAL, meta data)
 335 d:set_tracknum(): the item's Tracknum (OPTIONAL, meta data)
 336 d:set_description(): the item's Description (OPTIONAL, meta data)
 337 d:set_rating(): the item's Rating (OPTIONAL, meta data)
 338 d:set_date(): the item's Date (OPTIONAL, meta data)
 339 d:set_setting(): the item's Setting (OPTIONAL, meta data)
 340 d:set_url(): the item's URL (OPTIONAL, meta data)
 341 d:set_language(): the item's Language (OPTIONAL, meta data)
 342 d:set_nowplaying(): the item's NowPlaying (OPTIONAL, meta data)
 343 d:set_publisher(): the item's Publisher (OPTIONAL, meta data)
 344 d:set_encodedby(): the item's EncodedBy (OPTIONAL, meta data)
 345 d:set_arturl(): the item's ArtURL (OPTIONAL, meta data)
 346 d:set_trackid(): the item's TrackID (OPTIONAL, meta data)
 347
 348 Stream
 349 ------
 350 stream( url ): Instantiate a stream object for specific url.
 351 memory_stream( string ): Instantiate a stream object containing a specific string.
 352   Those two functions return the stream object upon success and nil if an
 353   error occurred, in that case, the second return value will be an error message.
 354
 355 s = vlc.stream( "http://www.videolan.org/" )
 356 s:read( 128 ) -- read up to 128 characters. Return 0 if no more data is available (FIXME?).
 357 s:readline() -- read a line. Return nil if EOF was reached.
 358 s:addfilter() -- add a stream filter. If no argument was specified, try to add all automatic stream filters.
 359
 360 Strings
 361 -------
 362 strings.decode_uri( [uri1, [uri2, [...]]] ): Decode a list of URIs. This
 363   function returns as many variables as it had arguments.
 364 strings.encode_uri_component( [uri1, [uri2, [...]]] ): Encode a list of URI
 365   components. This function returns as many variables as it had arguments.
 366 strings.make_uri( path, [scheme] ): Convert a file path to a URI.
 367 strings.resolve_xml_special_chars( [str1, [str2, [...]]] ): Resolve XML
 368   special characters in a list of strings. This function returns as many
 369   variables as it had arguments.
 370 strings.convert_xml_special_chars( [str1, [str2, [...]]] ): Do the inverse
 371   operation.
 372 strings.from_charset( charset, str ): convert a string from a specified
 373   character encoding into UTF-8.
 374
 375 Variables
 376 ---------
 377 var.inherit( object, name ): Find the variable "name"'s value inherited by
 378   the object. If object is unset, the current module's object will be used.
 379 var.get( object, name ): Get the object's variable "name"'s value.
 380 var.get_list( object, name ): Get the object's variable "name"'s value list.
 381   1st return value is the value list, 2nd return value is the text list.
 382 var.set( object, name, value ): Set the object's variable "name" to "value".
 383 var.create( object, name, value ): Create and set the object's variable "name"
 384   to "value". Created vars can be of type float, string, bool or void.
 385   For a void variable the value has to be 'nil'.
 386
 387 var.trigger_callback( object, name ): Trigger the callbacks associated with the
 388   object's "name" variable.
 389
 390 var.libvlc_command( name, argument ): Issue libvlc's "name" command with
 391   argument "argument".
 392
 393 var.inc_integer( name ): Increment the given integer.
 394 var.dec_integer( name ): Decrement the given integer.
 395 var.count_choices( name ): Return the number of choices.
 396 var.toggle_bool( name ): Toggle the given boolean.
 397
 398 Video
 399 -----
 400 video.fullscreen( [status] ):
 401  * toggle fullscreen if no arguments are given
 402  * switch to fullscreen 1st argument is true
 403  * disable fullscreen if 1st argument is false
 404
 405 VLM
 406 ---
 407 vlm(): Instanciate a VLM object.
 408
 409 v = vlc.vlm()
 410 v:execute_command( "new test broadcast" ) -- execute given VLM command
 411
 412 Note: if the VLM object is deleted and you were the last person to hold
 413 a reference to it, all VLM items will be deleted.
 414
 415 Volume
 416 ------
 417 volume.get(): Get volume.
 418 volume.set( level ): Set volume to an absolute level between 0 and 1024.
 419   256 is 100%.
 420 volume.up( [n] ): Increment volume by n steps of 32. n defaults to 1.
 421 volume.down( [n] ): Decrement volume by n steps of 32. n defaults to 1.
 422
 423 Win
 424 ---
 425 This module is only available on Windows builds
 426 win.console_init(): Initialize the windows console.
 427 win.console_wait([timeout]): Wait for input on the console for timeout ms.
 428                              Returns true if console input is available.
 429 win.console_read(): Read input from the windows console. Note that polling and
 430                     reading from stdin does not work under windows.
 431
 432 XML
 433 ---
 434 xml = vlc.xml(): Create an xml object.
 435 reader = xml:create_reader( stream ): create an xml reader that use the given stream.
 436 reader:read(): read some data, return -1 on error, 0 on EOF, 1 on start of XML
 437   element, 2 on end of XML element, 3 on text
 438 reader:name(): name of the element
 439 reader:value(): value of the element
 440 reader:next_attr(): next attribute of the element
 441
 442 The simplexml module can also be used to parse XML documents easily.