Documentation:Building Lua Playlist Scripts - Revision history

Nhumfrey: Deleted lua scripts that don't exist anymore and added hyperlinks to source code

2023-06-06T10:36:01Z

Deleted lua scripts that don't exist anymore and added hyperlinks to source code

← Older revision		Revision as of 10:36, 6 June 2023
Line 181:		Line 181:

	Scripts for popular playlist formats and video websites are available in the default VLC installer:		Scripts for popular playlist formats and video websites are available in the default VLC installer:
	* dailymotion.lua: URL translation for Daily Motion video pages;		* [https://code.videolan.org/videolan/vlc/-/blob/master/share/lua/playlist/dailymotion.lua dailymotion.lua]: URL translation for Daily Motion video pages;
	* ~~googlevideo~~.lua: URL translation for ~~Google Video~~ video pages;		* [https://code.videolan.org/videolan/vlc/-/blob/master/share/lua/playlist/metacafe.lua metacafe.lua]: URL translation for metacafe video pages and flash player;
	* ~~metacafe~~.lua: URL translation for ~~metacafe~~ video pages ~~and flash player~~;		* [https://code.videolan.org/videolan/vlc/-/blob/master/share/lua/playlist/vimeo.lua vimeo.lua]: URL translation for Vimeo video pages;
	* youtube.lua: URL translation for YouTube video pages and flash player (including fullscreen video URLs);		* [https://code.videolan.org/videolan/vlc/-/blob/master/share/lua/playlist/youtube.lua youtube.lua]: URL translation for YouTube video pages and flash player (including fullscreen video URLs);
	* youtube_hompage.lua: Parse YouTube homepage and browse page.


	== Useful links ==		== Useful links ==

Nhumfrey: Fixed links to README.txt files

2023-06-06T10:32:42Z

Fixed links to README.txt files

← Older revision		Revision as of 10:32, 6 June 2023
Line 175:		Line 175:
	Information about the VLC Lua scripts is available in your VLC installation in the lua subdirectory.		Information about the VLC Lua scripts is available in your VLC installation in the lua subdirectory.

	* [~~http~~://~~www~~.videolan.org/~~developers~~/vlc/share/lua/README.txt Global VLC Lua README]		* [https://code.videolan.org/videolan/vlc/-/blob/master/share/lua/README.txt Global VLC Lua README]
	* [~~http~~://~~www~~.videolan.org/~~developers~~/vlc/share/lua/playlist/README.txt Playlist script specific README]		* [https://code.videolan.org/videolan/vlc/-/blob/master/share/lua/playlist/README.txt Playlist script specific README]

	== Scripts shipped with VLC ==		== Scripts shipped with VLC ==

DoesItReallyMatter: +:Category:Playlist, +{{Example code}}, syntaxhighlight

2019-02-11T08:27:33Z

+Category:Playlist, +{{Example code}}, syntaxhighlight

← Older revision		Revision as of 08:27, 11 February 2019
Line 1:		Line 1:
			{{Example code}}
	{{RightMenu\|Documentation TOC}}		{{RightMenu\|Documentation TOC}}

Line 26:		Line 27:
	==== Probe ====		==== Probe ====
	The Lua script is going to be made of 2 functions. The first one is the '''probe()''' function. This function tells VLC if the Lua script should be used (function returns true) or not (function returns false). Here it would look like:		The Lua script is going to be made of 2 functions. The first one is the '''probe()''' function. This function tells VLC if the Lua script should be used (function returns true) or not (function returns false). Here it would look like:
			<syntaxhighlight lang="lua">
	function probe()		function probe()
	if vlc.access ~= "http"		if vlc.access ~= "http"
Line 38:		Line 40:
	end		end
	end		end
			</syntaxhighlight>

	Lets analyse that function step by step. First we check that VLC is using HTTP. If it isn't (for example it's reading a file off your hard drive or a DVD), we don't want to trigger the Google Video URL translation. The '''vlc''' Lua object provides '''vlc.access''' which should be equal to string '''"http"'''. Then we check that the URL is a Google Video page. This is easily done by trying to find the '''"video.google.com/videoplay"''' string in '''vlc.path'''.		Lets analyse that function step by step. First we check that VLC is using HTTP. If it isn't (for example it's reading a file off your hard drive or a DVD), we don't want to trigger the Google Video URL translation. The '''vlc''' Lua object provides '''vlc.access''' which should be equal to string '''"http"'''. Then we check that the URL is a Google Video page. This is easily done by trying to find the '''"video.google.com/videoplay"''' string in '''vlc.path'''.

	Note that the same function can be written as		Note that the same function can be written as
			<syntaxhighlight lang="lua">
	function probe()		function probe()
	return vlc.access == "http" and string.match( vlc.path, "video.google.com/videoplay" )		return vlc.access == "http" and string.match( vlc.path, "video.google.com/videoplay" )
	end		end
			</syntaxhighlight>

	==== Parse ====		==== Parse ====
	If the '''probe()''' function returns true, VLC will use the '''parse()''' to ask for the new playlist item(s) which need to be added.		If the '''probe()''' function returns true, VLC will use the '''parse()''' to ask for the new playlist item(s) which need to be added.
			<syntaxhighlight lang="lua">
	function parse()		function parse()
	item = {}		item = {}
Line 54:		Line 60:
	return { item }		return { item }
	end		end
			</syntaxhighlight>

	We create a new playlist item (a Lua table). We set the item's path to the appropriate string: 1/ we prepend "http://" since the '''vlc.path''' string doesn't include that part of the original URL and 2/ we replace "videoplay" by "videogvp".		We create a new playlist item (a Lua table). We set the item's path to the appropriate string: 1/ we prepend "http://" since the '''vlc.path''' string doesn't include that part of the original URL and 2/ we replace "videoplay" by "videogvp".
Line 62:		Line 69:

	A shorter version would be:		A shorter version would be:
			<syntaxhighlight lang="lua">
	function parse()		function parse()
	return { { path = "http://" .. string.gsub( vlc.path, "videoplay", "videogvp" ); name = "Some Google video playlist" } }		return { { path = "http://" .. string.gsub( vlc.path, "videoplay", "videogvp" ); name = "Some Google video playlist" } }
	end		end
			</syntaxhighlight>

	==== Saving that to a file ====		==== Saving that to a file ====
Line 91:		Line 100:
	==== Probe ====		==== Probe ====
	The first thing we need to worry about is making sure that the file we're playing is a Google Video Playlist (GVP) file. We could rely on the URL, but that would prevent playing GVP files from our hard drive. Fortunately, the file's contents, especially the "gvp_version:" string seem specific to GVP files. We'll thus try reading a bunch of characters from the beginning of the file and look for the "gvp_version:" string.		The first thing we need to worry about is making sure that the file we're playing is a Google Video Playlist (GVP) file. We could rely on the URL, but that would prevent playing GVP files from our hard drive. Fortunately, the file's contents, especially the "gvp_version:" string seem specific to GVP files. We'll thus try reading a bunch of characters from the beginning of the file and look for the "gvp_version:" string.
			<syntaxhighlight lang="lua">
	function probe()		function probe()
	return string.match( vlc.peek( 512 ), "gvp_version:" )		return string.match( vlc.peek( 512 ), "gvp_version:" )
	end		end
			</syntaxhighlight>

	The '''vlc.peek(''' ''<number of chars>'' ''')''' function asks VLC to return the first <number of chars> characters. If the string "gvp_version:" isn't found in a file's first 512 characters, we're almost 100% sure that it's not a valid GVP file.		The '''vlc.peek(''' ''<number of chars>'' ''')''' function asks VLC to return the first <number of chars> characters. If the string "gvp_version:" isn't found in a file's first 512 characters, we're almost 100% sure that it's not a valid GVP file.
Line 99:		Line 110:
	==== Parse ====		==== Parse ====
	We now need to read information from the file to create our new playlist item. A simple version would only fetch the URL:		We now need to read information from the file to create our new playlist item. A simple version would only fetch the URL:
			<syntaxhighlight lang="lua">
	function parse()		function parse()
	item = {}		item = {}
Line 115:		Line 127:
	return { item }		return { item }
	end		end
			</syntaxhighlight>

	We read all the file's lines using the '''vlc.readline()''' function. If we encounter the line starting with '''"url:"''' (''string.match( line, "url:" )'' would match lines containing "url:", while ''string.match( line, "^url:" )'' only matches those starting with "url:"), we use that as our new item's path.		We read all the file's lines using the '''vlc.readline()''' function. If we encounter the line starting with '''"url:"''' (''string.match( line, "url:" )'' would match lines containing "url:", while ''string.match( line, "^url:" )'' only matches those starting with "url:"), we use that as our new item's path.
Line 121:		Line 134:

	This simple '''parse()''' function unfortunately discards all the other useful meta information available in the GVP file. Lets try to use it:		This simple '''parse()''' function unfortunately discards all the other useful meta information available in the GVP file. Lets try to use it:
			<syntaxhighlight lang="lua">
	function parse()		function parse()
	item = {}		item = {}
Line 151:		Line 165:
	return { item }		return { item }
	end		end
			</syntaxhighlight>

	Getting the video's title works like the URL parameter.		Getting the video's title works like the URL parameter.
Line 178:		Line 193:

	{{Documentation}}		{{Documentation}}

			[[Category:Playlist]]

DoesItReallyMatter: /* What we want to do */ c/e

2014-12-09T04:25:40Z

What we want to do: c/e

← Older revision		Revision as of 04:25, 9 December 2014
Line 19:		Line 19:

	==== What we want to do ====		==== What we want to do ====
	~~Lets~~ say that we want VLC to open Google Video links automatically. Google Video pages have URLs like		Let's say that we want VLC to open Google Video links automatically. Google Video pages have URLs like
	<nowiki>http://video.google.com/videoplay?docid=-5784010886294950089</nowiki>		<nowiki>http://video.google.com/videoplay?docid=-5784010886294950089</nowiki>
	to the URL of the corresponding Google Video Playlist file which is		to the URL of the corresponding Google Video Playlist file which is

DoesItReallyMatter: spelling

2014-11-10T06:10:33Z

spelling

← Older revision		Revision as of 06:10, 10 November 2014
Line 90:		Line 90:

	==== Probe ====		==== Probe ====
	The first thing we need to worry about is making sure that the file we're playing is a Google Video Playlist (GVP) file. We could rely on the URL, but that would prevent playing GVP files from our hard drive. Fortunately, the file's contents, especially the "gvp_version:" string seem specific to GVP files. We'll thus try reading a bunch of characters from the ~~begining~~ of the file and look for the "gvp_version:" string.		The first thing we need to worry about is making sure that the file we're playing is a Google Video Playlist (GVP) file. We could rely on the URL, but that would prevent playing GVP files from our hard drive. Fortunately, the file's contents, especially the "gvp_version:" string seem specific to GVP files. We'll thus try reading a bunch of characters from the beginning of the file and look for the "gvp_version:" string.
	function probe()		function probe()
	return string.match( vlc.peek( 512 ), "gvp_version:" )		return string.match( vlc.peek( 512 ), "gvp_version:" )
Line 120:		Line 120:
	If vlc.readline() returns nil, this means that we've finished reading the file so we break out of the while loop and return our new playlist.		If vlc.readline() returns nil, this means that we've finished reading the file so we break out of the while loop and return our new playlist.

	This simple '''parse()''' function unfortunately discards all the other ~~usefull~~ meta information available in the GVP file. Lets try to use it:		This simple '''parse()''' function unfortunately discards all the other useful meta information available in the GVP file. Lets try to use it:
	function parse()		function parse()
	item = {}		item = {}
Line 153:		Line 153:

	Getting the video's title works like the URL parameter.		Getting the video's title works like the URL parameter.
	The duration is a bit more tricky. GVP uses times in ~~miliseconds~~ while VLC wants a time in seconds. We thus have to divide it by 1000.		The duration is a bit more tricky. GVP uses times in milliseconds while VLC wants a time in seconds. We thus have to divide it by 1000.
	For the description, it works like the URL and title parameters except that a GVP file can have more than one description parameter. If we read more than one parameter we thus concatenate the different description lines.		For the description, it works like the URL and title parameters except that a GVP file can have more than one description parameter. If we read more than one parameter we thus concatenate the different description lines.

Corbax at 15:53, 25 September 2013

2013-09-25T15:53:46Z

← Older revision		Revision as of 15:53, 25 September 2013
Line 1:		Line 1:
	{{RightMenu\|~~documentation play howto toc~~}}		{{RightMenu\|Documentation TOC}}

	== Introduction ==		== Introduction ==

Corbax: Corbax moved page Documentation:Play HowTo/Building Lua Playlist Scripts to Documentation:Building Lua Playlist Scripts

2013-09-25T15:18:16Z

Corbax moved page Documentation:Play HowTo/Building Lua Playlist Scripts to Documentation:Building Lua Playlist Scripts

← Older revision	Revision as of 15:18, 25 September 2013
(No difference)

Corbax: /* Useful links */

2013-09-25T15:17:59Z

Useful links

← Older revision		Revision as of 15:17, 25 September 2013
Line 176:		Line 176:
	* [http://www.lua.org/manual/5.1/ Lua 5.1 reference manual]		* [http://www.lua.org/manual/5.1/ Lua 5.1 reference manual]
	* [http://lua-users.org/wiki/TutorialDirectory Lua tutorials]		* [http://lua-users.org/wiki/TutorialDirectory Lua tutorials]

			{{Documentation}}

Grahack: Fixed typo: usefull -> useful

2010-08-19T14:26:34Z

Fixed typo: usefull -> useful

← Older revision		Revision as of 14:26, 19 August 2010
Line 173:		Line 173:


	== ~~Usefull~~ links ==		== Useful links ==
	* [http://www.lua.org/manual/5.1/ Lua 5.1 reference manual]		* [http://www.lua.org/manual/5.1/ Lua 5.1 reference manual]
	* [http://lua-users.org/wiki/TutorialDirectory Lua tutorials]		* [http://lua-users.org/wiki/TutorialDirectory Lua tutorials]

Dionoea: /* Reference */

2008-09-04T22:50:57Z

Reference

← Older revision		Revision as of 22:50, 4 September 2008
Line 160:		Line 160:
	Information about the VLC Lua scripts is available in your VLC installation in the lua subdirectory.		Information about the VLC Lua scripts is available in your VLC installation in the lua subdirectory.

	* [http://~~git~~.videolan.org/~~gitweb.cgi?p=~~vlc~~.git;a=blob_plain;f=~~share/lua/README.txt~~;hb=HEAD~~ Global VLC Lua README]		* [http://www.videolan.org/developers/vlc/share/lua/README.txt Global VLC Lua README]
	* [http://~~git~~.videolan.org/~~gitweb.cgi?p=~~vlc~~.git;a=blob_plain;f=~~share/lua/playlist/README.txt~~;hb=HEAD~~ Playlist script specific README]		* [http://www.videolan.org/developers/vlc/share/lua/playlist/README.txt Playlist script specific README]

	== Scripts shipped with VLC ==		== Scripts shipped with VLC ==