media/: Use socket.url

[libquvi-scripts.git] / share / media / youtube.lua

-- libquvi-scripts
-- Copyright (C) 2010-2012  Toni Gundogdu <legatvs@gmail.com>
--
-- This file is part of libquvi-scripts <http://quvi.sourceforge.net/>.
--
-- This library is free software; you can redistribute it and/or
-- modify it under the terms of the GNU Lesser General Public
-- License as published by the Free Software Foundation; either
-- version 2.1 of the License, or (at your option) any later version.
--
-- This library is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-- Lesser General Public License for more details.
--
-- You should have received a copy of the GNU Lesser General Public
-- License along with this library; if not, write to the Free Software
-- Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
-- 02110-1301  USA
--

local YouTube = {} -- Utility functions unique to this script

-- <http://en.wikipedia.org/wiki/YouTube#Quality_and_codecs>

-- Identify the script.
function ident(qargs)
  local Y = require 'quvi/youtube'
  local u = Y.normalize(qargs.input_url)
  return {
    domains = table.concat({'youtube.com'}, ','),
    can_parse_url = YouTube.can_parse_url(u)
  }
end

-- Parse media properties.
function parse(qargs)
  local Y = require 'quvi/youtube'
  return YouTube.parse_properties(qargs, Y)
end

--
-- Utility functions
--

function YouTube.can_parse_url(url)
  local U = require 'socket.url'
  local t = U.parse(url)
  if t and t.scheme and t.scheme:lower():match('^https?$')
       and t.host   and t.host:lower():match('youtube%.com$')
       and t.query  and t.query:lower():match('^v=[%w-_]+')
       and t.path   and t.path:lower():match('^/watch')
  then
    return true
  else
    return false
  end
end

-- Parses the video info from the server.
function YouTube.parse_properties(qargs, Y)
  local c, U = YouTube.get_data(qargs, Y)

  qargs.duration_ms = (c['length_seconds'] or 0)*1000 -- to ms
  qargs.thumb_url = U.unescape(c['thumbnail_url'] or '')
  qargs.title = U.unescape(c['title'] or '')
  qargs.streams = YouTube.iter_streams(c, U)
  YouTube.append_begin_param(qargs)

  return qargs
end

-- Queries the video data from the server.
function YouTube.get_data(qargs, Y)
  local u = Y.normalize(qargs.input_url)

  qargs.id = u:match('v=([%w-_]+)')
              or error('no match: media ID')

  local U = require 'socket.url'
  local u = U.parse(u)
  local s = u.scheme or error('no match: scheme')

  local s_fmt = '%s://www.youtube.com/get_video_info?&video_id=%s'
                  .. '&el=detailpage&ps=default&eurl=&gl=US&hl=en'
  local u = string.format(s_fmt, s, qargs.id)

  local C = require 'quvi/const'
  local U = require 'quvi/util'

  local o = { [C.qfo_type] = C.qft_config }
  local c = U.decode(quvi.fetch(u, o))

  if c['reason'] then
    local reason = U.unescape(c['reason'])
    local code = c['errorcode']
    error(string.format("%s (code=%s)", reason, code))
  end

  return c, U
end

-- Appends the &begin parameter to the media stream URL.
function YouTube.append_begin_param(qargs)
  local m,s = qargs.input_url:match('t=(%d?%d?m?)(%d%d)s')
  m = tonumber(((m or ''):gsub('%a',''))) or 0
  s = tonumber(((s or ''):gsub('%a',''))) or 0
  local ms = (m*60000) + (s*1000)
  if ms >0 then
    for i,v in ipairs(qargs.streams) do
      local url = qargs.streams[i].url
      qargs.streams[i].url = url .."&begin=".. ms
    end
    qargs.start_time_ms = ms
  end
end

-- Iterates the available streams.
function YouTube.iter_streams(config, U)

  -- Stream map. Holds many of the essential properties,
  -- e.g. the media stream URL.

  local stream_map = U.unescape(config['url_encoded_fmt_stream_map']
                      or error('no match: url_encoded_fmt_stream_map'))
                        .. ','

  local smr = {}
  for d in stream_map:gmatch('([^,]*),') do
    local d = U.decode(d)
    if d['url'] then
      local ct = U.unescape(d['type'])
      local v_enc,a_enc = ct:match('codecs="([%w.]+),%s+([%w.]+)"')
      local itag = d['itag']
      local cnt = (ct:match('/([%w-]+)')):gsub('x%-', '')
      local t = {
        url = U.unescape(d['url']) -- d['sig'] ? "&signature=val" : ""
              .. (d['sig'] and ('&signature='..d['sig']) or ''),
        quality = d['quality'],
        container = cnt,
        v_enc = v_enc,
        a_enc = a_enc
      }
      smr[itag] = t
    end
  end

  -- Format list. Combined with the above properties. This list is used
  -- for collecting the video resolution.

  local fmtl = U.unescape(config['fmt_list'] or error('no match: fmt_list'))
  local S = require 'quvi/stream'
  local r = {}

  for itag,w,h in fmtl:gmatch('(%d+)/(%d+)x(%d+)') do
    local smri = smr[itag]
    local t = S.stream_new(smri.url)

    t.video.encoding = smri.v_enc or ''
    t.audio.encoding = smri.a_enc or ''
    t.container = smri.container or ''
    t.video.height = tonumber(h)
    t.video.width = tonumber(w)

    -- Do this after we have the video resolution, as the to_id
    -- function uses the height property.
    t.id = YouTube.to_id(t, itag, smri)

    table.insert(r, t)
  end

  if #r >1 then
    YouTube.ch_best(S, r) -- Pick one stream as the 'best' quality.
  end

  return r
end

-- Picks the stream with the highest video height property
-- as the best in quality.
function YouTube.ch_best(S, t)
  local r = t[1] -- Make the first one the 'best' by default.
  r.flags.best = true
  for _,v in pairs(t) do
    if v.video.height > r.video.height then
      r = S.swap_best(r, v)
    end
  end
end

-- Return an ID for a stream.
function YouTube.to_id(t, itag, smri)
  return string.format("%s_%s_i%02d_%sp",
          smri.quality, t.container, itag, t.video.height)
end

-- vim: set ts=2 sw=2 tw=72 expandtab: