Split from git://repo.or.cz/quvi.git
[libquvi-scripts.git] / share / lua / website / youtube.lua
blob38f56efde98eb30ad7508f59f975d85066e953ca
2 -- libquvi-scripts
3 -- Copyright (C) 2010-2011 Toni Gundogdu <legatvs@gmail.com>
4 --
5 -- This file is part of libquvi-scripts <http://quvi.sourceforge.net/>.
6 --
7 -- This library is free software; you can redistribute it and/or
8 -- modify it under the terms of the GNU Lesser General Public
9 -- License as published by the Free Software Foundation; either
10 -- version 2.1 of the License, or (at your option) any later version.
12 -- This library is distributed in the hope that it will be useful,
13 -- but WITHOUT ANY WARRANTY; without even the implied warranty of
14 -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 -- Lesser General Public License for more details.
17 -- You should have received a copy of the GNU Lesser General Public
18 -- License along with this library; if not, write to the Free Software
19 -- Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
20 -- 02110-1301 USA
23 local YouTube = {} -- Utility functions unique to this script
25 -- <http://en.wikipedia.org/wiki/YouTube#Quality_and_codecs>
27 -- Identify the script.
28 function ident(self)
29 package.path = self.script_dir .. '/?.lua'
30 local C = require 'quvi/const'
31 local r = {}
32 r.domain = "youtube%.com"
33 r.formats = "default|best"
34 r.categories = C.proto_http
35 self.page_url = YouTube.normalize(self.page_url)
36 local U = require 'quvi/util'
37 r.handles = U.handles(self.page_url,
38 {r.domain}, {"/watch"}, {"v=[%w-_]+"})
39 return r
40 end
42 -- Query available formats.
43 function query_formats(self)
44 local config,U = YouTube.get_config(self)
45 local formats = YouTube.iter_formats(config, U)
47 local t = {}
48 for _,v in pairs(formats) do
49 table.insert(t, YouTube.to_s(v))
50 end
52 table.sort(t)
53 self.formats = table.concat(t, "|")
55 return self
56 end
58 -- Parse URL.
59 function parse(self)
60 self.host_id = "youtube"
61 local page_url = YouTube.normalize(self.page_url)
63 local _,_,s = page_url:find('#a?t=(.+)')
64 self.start_time = s or ''
66 return YouTube.get_video_info(self)
67 end
70 -- Utility functions
73 function YouTube.normalize(s)
74 if not s then return s end
75 -- domain names
76 s = s:gsub('youtu%.be', 'youtube.com')
77 s = s:gsub('%-nocookie', '')
78 -- paths
79 local w = '/watch?v='
80 for _,v in pairs({'/embed/', '/%w/'}) do
81 s = s:gsub(v,w)
82 end
83 return s
84 end
86 function YouTube.get_config(self)
87 local _,_,s = self.page_url:find('^(%w+)://')
88 local scheme = s or error("no match: scheme")
90 local page_url = YouTube.normalize(self.page_url)
92 local _,_,s = page_url:find("v=([%w-_]+)")
93 self.id = s or error("no match: media id")
95 local s_fmt = "%s://www.youtube.com/get_video_info?&video_id=%s"
96 .. "&el=detailpage&ps=default&eurl=&gl=US&hl=en"
98 local config_url = string.format(s_fmt, scheme, self.id)
100 local U = require 'quvi/util'
101 local config = U.decode(quvi.fetch(config_url, {fetch_type='config'}))
103 if config['reason'] then
104 local reason = U.unescape(config['reason'])
105 local code = config['errorcode']
106 error(string.format("%s (code=%s)", reason, code))
109 return config,U
112 function YouTube.iter_formats(config, U)
113 local fmt_stream_map = config['url_encoded_fmt_stream_map']
114 or error("no match: url_encoded_fmt_stream_map")
116 fmt_stream_map = U.unescape(fmt_stream_map) .. ","
118 local urls = {}
119 for f in fmt_stream_map:gfind('([^,]*),') do
120 local d = U.decode(f)
121 if d['itag'] and d['url'] then
122 urls[U.unescape(d['itag'])] = U.unescape(d['url'])
126 local fmt_map = config['fmt_list'] or error("no match: fmt_list")
127 fmt_map = U.unescape(fmt_map)
129 local r = {}
130 for f,w,h in fmt_map:gfind('(%d+)/(%d+)x(%d+)') do
131 -- print(f,w,h)
132 table.insert(r, {fmt_id=tonumber(f), url=urls[f],
133 width=tonumber(w), height=tonumber(h)})
136 return r
139 function YouTube.get_video_info(self)
140 local config,U = YouTube.get_config(self)
142 self.title = config['title'] or error('no match: media title')
143 self.title = U.unescape(self.title)
145 self.thumbnail_url = config['thumbnail_url'] or ''
146 if #self.thumbnail_url > 0 then
147 self.thumbnail_url = U.unescape(self.thumbnail_url)
150 self.duration = (config['length_seconds'] or 0)*1000 -- to msec
152 self.requested_format =
153 YouTube.convert_deprecated_id(self.requested_format)
155 local formats = YouTube.iter_formats(config, U)
156 local url = U.choose_format(self, formats,
157 YouTube.choose_best,
158 YouTube.choose_default,
159 YouTube.to_s).url
160 or error("no match: media url")
162 if url and #self.start_time > 0 then
163 local min, sec = self.start_time:match("^(%d+)m(%d+)s$")
164 min = tonumber(min) or 0
165 sec = tonumber(sec) or 0
166 local msec = (min * 60000) + (sec * 1000)
167 if msec > 0 then
168 url = url .. "&begin=" .. msec
172 self.url = {url}
174 return self
177 function YouTube.choose_best(formats) -- Highest quality available
178 local r = {width=0, height=0, url=nil}
179 local U = require 'quvi/util'
180 for _,v in pairs(formats) do
181 if U.is_higher_quality(v,r) then
182 r = v
185 -- for k,v in pairs(r) do print(k,v) end
186 return r
189 function YouTube.choose_default(formats) -- Lowest quality available
190 local r = {width=0xffff, height=0xffff, url=nil}
191 local U = require 'quvi/util'
192 for _,v in pairs(formats) do
193 if U.is_lower_quality(v,r) then
194 r = v
197 -- for k,v in pairs(r) do print(k,v) end
198 return r
201 YouTube.conv_table = { -- Deprecated.
202 -- flv
203 flv_240p = '5',
204 flv_360p = '34',
205 flv_480p = '35',
206 -- mp4
207 mp4_360p = '18',
208 mp4_720p = '22',
209 mp4_1080p = '37',
210 mp4_3072p = '38'
213 function YouTube.convert_deprecated_id(r_fmt)
214 if YouTube.conv_table[r_fmt] then
215 local s = string.format("fmt%02d_", YouTube.conv_table[r_fmt])
216 r_fmt = r_fmt:gsub("^(%w+)_", s)
218 return r_fmt
221 function YouTube.to_s(t)
222 return string.format("fmt%02d_%sp", t.fmt_id, t.height)
225 -- vim: set ts=4 sw=4 tw=72 expandtab: