Shift from youtube-dl to yt-dlp

[nimcoon.git] / src / lib.nim

import
  os,
  osproc,
  re,
  sequtils,
  std/[terminal],
  strformat,
  strutils,
  tables

import
  config,
  peertube,
  types,
  youtube


let
  processOptions = {poStdErrToStdOut, poUsePath} # Add poEchoCmd to debug
  PEERTUBE_REGEX = re"videos\/watch\/[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}"


proc isInstalled(program: string): bool =
  execProcess("which " & program).len != 0


proc selectMediaPlayer*(): string =
  let availablePlayers = supportedPlayers.filter(isInstalled)
  if len(availablePlayers) == 0:
    stderr.writeLine &"Please install one of the supported media players: {supportedPlayers}"
    raise newException(OSError, "No supported media player found")
  else:
    return availablePlayers[0]


proc printTitle(action: string, title: string) =
    styledEcho "\n", fgGreen, &"{action} ", styleBright, fgMagenta, title


###############
# URL CLEANUP #
###############

func rewriteInvidiousToYouTube*(url: string): string =
  {.noSideEffect.}:
    if rewriteInvidiousURLs and url.replace(".", "").contains("invidious"):
       &"https://www.youtube.com/watch?v={url.split(\"=\")[1]}"
    else: url


func urlLongen(url: string): string =
  url.replace("youtu.be/", "www.youtube.com/watch?v=")


func stripZshEscaping(url: string): string = url.replace("\\", "")


func sanitizeURL*(url: string): string =
  rewriteInvidiousToYouTube(urlLongen(stripZshEscaping(url)))


########
# PLAY #
########

func buildPlayerArgs(url: string, options: Table[string, bool], player: string): seq[string] =
  let musicOnly = if options["musicOnly"]: "--no-video" else: ""
  let fullScreen = if options["fullScreen"]: "--fullscreen" else: ""
  filterIt([url, musicOnly, fullScreen], it != "")


proc play*(player: string, options: Table[string, bool], url: string, title: string = "") =
  let args = buildPlayerArgs(url, options, player)
  if title != "":
    printTitle("Playing", title)
  if "--no-video" in args:
    discard execShellCmd(&"{player} {args.join(\" \")}")
  else:
    discard execProcess(player, args=args, options=processOptions)


proc directPlay*(url: string, player: string, options: Table[string, bool]) =
  let url =
    if find(url, PEERTUBE_REGEX) != -1 and "webtorrent".isInstalled:
      getPeerTubeMagnetLink(url)
    else: url
  if url.startswith("magnet:") or url.endswith(".torrent"):
    if options["musicOnly"]:
      # TODO Replace with WebTorrent once it supports media player options
      discard execShellCmd(&"peerflix '{url}' -a --{player} -- --no-video")
    else:
      # WebTorrent is so much faster!
      discard execProcess("webtorrent", args=[url, &"--{player}"], options=processOptions)
  else:
    play(player, options, url)


############
# DOWNLOAD #
############

func buildMusicDownloadArgs(url: string): seq[string] =
  {.noSideEffect.}:
    let downloadLocation = &"'{expandTilde(musicDownloadDirectory)}/%(title)s.%(ext)s'"
    @["--ignore-errors", "-f", "bestaudio", "--extract-audio", "--audio-format", "mp3",
      "--audio-quality", "0", "-o", downloadLocation, url]


func buildVideoDownloadArgs(url: string): seq[string] =
  {.noSideEffect.}:
    let downloadLocation = &"'{expandTilde(videoDownloadDirectory)}/%(title)s.%(ext)s'"
    @["-f", "best", "-o", downloadLocation, url]


func buildDownloadArgs(url: string, options: Options): seq[string] =
  if options["musicOnly"]: buildMusicDownloadArgs(url)
  else: buildVideoDownloadArgs(url)


proc download*(args: openArray[string], title: string) =
  printTitle("Downloading", title)
  discard execShellCmd(&"yt-dlp {args.join(\" \")}")


proc directDownload*(url: string, options: Options) =
  let args = buildDownloadArgs(url, options)
  if "aria2c".isInstalled:
    discard execShellCmd(&"yt-dlp {args.join(\" \")} --external-downloader aria2c --external-downloader-args '-x 16 -s 16 -k 2M'")
  else:
    discard execShellCmd(&"yt-dlp {args.join(\" \")}")

proc luckyDownload*(searchQuery: string, options: Options) =
  let args = @[&"ytsearch1:\"{searchQuery}\""] & buildDownloadArgs("", options)
  let title = execProcess(&"yt-dlp --get-title {args.join(\" \")}").split("\n")[0]
  download(args, title)

proc luckyPlay*(searchQuery: string, player: string, options: Options) =
  let args = @[&"ytsearch:\"{searchQuery}\""] & buildDownloadArgs("", options)
  let output = execProcess(&"yt-dlp --get-url --get-title {args.join(\" \")}").split("\n")
  let
    title = output[0]
    url = &"\"{output[1]}\""
  play(player, options, url, title)

###########
# OPTIONS #
###########

proc isValidOptions*(options: Options): bool =
  # Check for invalid combinations of options
  var invalidCombinations = [("musicOnly", "fullScreen"), ("download", "fullScreen"), ("download", "autoPlay")]
  result = true
  for combination in invalidCombinations:
    if options[combination[0]] and options[combination[1]]:
     stderr.writeLine fmt"Incompatible options provided: {combination[0]} and {combination[1]}"
     result = false
  # TODO Make this overridable in configuration
  if options["autoPlay"] and not options["musicOnly"]:
    stderr.writeLine "--music-only must be provided with --auto-play. This is to prevent binge-watching."
    result = false


proc updateOptions(options: Options, newOptions: string): Options =
  result = options

  # Interactive options
  for option in newOptions:
    case option
    of 'm': result["musicOnly"] = true
    of 'f': result["fullScreen"] = true
    of 'd': result["download"] = true
    of 'a': result["autoPlay"] = true
    else:
      stderr.writeLine "Invalid option provided!"
      quit(2)

  if(not isValidOptions(result)):
    quit(2)


################
# PRESENTATION #
################

proc handleUserInput(searchResult: SearchResult, options: Table[string, bool], player: string) =
  if options["autoPlay"]:
    play(player, options, searchResult.url, searchResult.title)
    handleUserInput(getAutoPlayVideo(searchResult), options, player) # inifinite playlist till user quits
  elif options["download"]:
    download(buildDownloadArgs(searchResult.url, options), searchResult.title)
  else:
    play(player, options, searchResult.url, searchResult.title)


proc presentVideoOptions(searchResults: SearchResults) =
  eraseScreen()
  for index, (title, url) in searchResults:
    styledEcho $index, ". ", styleBright, fgMagenta, title, "\n", resetStyle, fgCyan, "   ", url, "\n"


proc offerSelection(searchResults: SearchResults, options: Table[string, bool], selectionRange: SelectionRange): string =
  if options["feelingLucky"]: "0"
  else:
    presentVideoOptions(searchResults[selectionRange.begin .. selectionRange.until])
    stdout.styledWrite(fgYellow, "Choose video number: ")
    readLine(stdin)


proc present*(searchResults: SearchResults, options: Table[string, bool], selectionRange: SelectionRange, player: string) =
  ##[ Continuously present options till the user quits the application

        selectionRange: Currently available range to choose from depending on pagination
  ]##

  let userInput = offerSelection(searchResults, options, selectionRange)

  case userInput
  of "all":
    for selection in selectionRange.begin .. selectionRange.until:
      handleUserInput(searchResults[selection], options, player)
    quit(0)
  of "n":
    if selectionRange.until + 1 < len(searchResults):
      let newSelectionRange = (selectionRange.until + 1, min(len(searchResults) - 1, selectionRange.until + limit))
      present(searchResults, options, newSelectionRange, player)
    else:
      present(searchResults, options, selectionRange, player)
  of "p":
    if selectionRange.begin > 0:
      let newSelectionRange = (selectionRange.begin - limit, selectionRange.until - limit)
      present(searchResults, options, newSelectionRange, player)
    else:
      present(searchResults, options, selectionRange, player)
  of "q":
    quit(0)
  else:
    if " " in userInput:
      let selection = parseInt(userInput.split(" ")[0])
      let updatedOptions = updateOptions(options, userInput.split(" ")[1])
      let searchResult = searchResults[selectionRange.begin .. selectionRange.until][selection]
      handleUserInput(searchResult, updatedOptions, player)
    else:
      let searchResult = searchResults[selectionRange.begin .. selectionRange.until][parseInt(userInput)]
      handleUserInput(searchResult, options, player)
    if options["feelingLucky"]:
      quit(0)
    else:
      present(searchResults, options, selectionRange, player)