rewrite?

[odnar-dev]

Branch: rewrite?

# RELEASING
- comment the code
- typos 🗡️ 
- how to make you own plugins
- included plugins :
			- `players`		: default
			- `menus`		: 
							 ✅	- cli		-	multi-select , download, paging, highlight selected
								- fzf		-	multi-select , download
								- dmenu		-	
								- rofi		- 	multi-select , download
			- `platforms` 	: 
								- youtube	-	search , trends , channels, playlist
							 ✅	- piped     -   same as youtube but with some limitation
							 ✅	- peertube	-	search , trends , channels, user
								- odysee	-	search , trends , 
								- tedtalk?	-	there is no official api, https://ted2srt.org has alot of limitation,
												don't support pagination¹

[1] :

bitchute may not be included in the next release:
	- cause it suck!! 
	- don't have lives
	- a lot of uploaders moved to odysee
	- no progress
	- dead..

# Sat Sep  4 04:03:22 AM +01 2021
The script end up pretty long; almost 100 line for every menu plugin, and more for platforms
after some quick math, look like this script well have more than 1000 line

After publishing the first draft, I need to focus on trying to make it smaller,
and optimize some functions and remove duplicated codes

# README.md

- Create your own plugin
- Contributing
- Related projects
- License

[odnar-dev]

branding

video search > vid search > vids

	     🔍        🔘        ⏯️       🔁
vids : search -> select -> play -> repeat

[odnar-dev]

TODO:

# OPTIONS
-h  : print help                
-v  : print version            ✅
-u  : update to latest version
-p  : select platform          ✅
-t  : trending                 ✅
-s  : search
-m  : select menu
-P  : select player            ✅
-Pa : select player args       ✅
-D  : select downloader        ✅
-Da : select downloader args   ✅
--update : 🚫 for security i wont add an internal update mechanism
			  updates should be provided by your package manager
			  also don't install scripts whitout opening them that just wrong
--loop   : 
--audio-only : 
--verbose : 
--select : 
--auto-select : 
# Aliases

--print link, 
--select all, random, auto

# ENVIRONMENT VARIABLES
VIDS_DEFAULT_PLATFORM       : default platform             ✅
VIDS_DEFAULT_MENU           : default menu                 ✅
VIDS_DEFAULT_PLAYER         : default player               ✅
VIDS_DEFAULT_PLAYER_ARGS    : default player args          ✅
VIDS_DOWNLOADER             : default downloader         
VIDS_DOWNLOADER_ARGS        : default downloader args    
VIDS_YOUTUBE_PIPED          : use piped instead of youtube
VIDS_PIPEDAPI_URL           : piped api url                ✅
VIDS_PEERTUBE_URL           : peertube instance            ✅

# KEY BINDINGS for rofi & fzf
ctrl-c    : copy link of selected videos
alt-d     : download selected videos
alt-entre : runs the player in a new session

f1: youtube
f2: odysee
f3: peertube
f4: bitchute

# functions 
## platform
vids_search 		✅
vids_trends			✅
vids_urlhandler		✅
vids_nextpage		✅
vids_getdlink		✅
## menu
vids_choose			✅
vids_input 		    ✅
## player
vids_play			✅

# json data structure
- author			✅
- authorUrl			✅
- title				✅
- duration			✅
- views				✅
- publishedAt		✅
- videoUrl			✅
- thumbUrl			✅
- description		

[odnar-dev]

PLUGINS

Plugins are loaded from $HOME/.config/vids/plugins/$type/ ${XDG_DATA_HOME:-$HOME/.local/share}/vids/plugins/$type/

Currently platforms, menus, players plugins are supported.

TODO

- Support for `platforms` plugins.  ✅
- Prioritize external plugins.  	✅
- Support for `menus` plugins.      ✅
- Support for `players` plugins.    ✅

[odnar-dev]

PAGES

- switch to `bash` 😥 ; any other ideas?
	- may move back to sh in future
		- save everything in json
		  page, data, nextpagequery, islastpage

Wed Aug 25 09:35:16 AM +01 2021
first test working;
need to rewrite all the menus to add support

Wed Aug 25 02:10:21 PM +01 2021
fuck!

# Navigation between pages 🧑‍🏭 
## Conditions : 
- check if platform support getnextpage()				 							 ✅
- Check if page is the first one : (current page number <= 0)  						 ✅
- Check if page is the last one : (if lastpage bool is true)						 ✅
- check if page is already cached : (check if current page holder is not empty) 	 ✅
- run getnextpage()																	 ✅
- check if nextpage response is empty 												 ✅
- 

# Wed Aug 25 04:10:00 PM +01 2021
i finished a working prototype menu that support navigation between pages (tested with 1 platform)
- need to apply the same logic to other menus
- try it with other platforms
- improve logic & fix errors

i hope i can finish it before the end of the week

[odnar-dev]

Platforms investigation

PIPED 👍🏻

# Trending ✅
	api : https://pipedapi.kavin.rocks/trending?region={query}
	- support select region: use region as query					✅
	- region parameter is necessary, use US if empty				✅
	- region parameter need to be a valide ISO 3166-1 codes, 		✅
	- not all ISO 3166-1 codes are supported,fallback to US			✅
	- don't support pagination , mark first page as the last page	✅
# Search ✅
	api : https://pipedapi.kavin.rocks/search?q={query}&filter=videos
	- support pagination, use nextpagequery							✅
	- last page indicator is "nextpage=null"						✅
	- nexpage search api is different from search api				✅
	- need to encode {nextpage}										✅
	nextpagequery = "search/?nextpage={nextpage}&q={query}&filter=videos"
# URL Handler
## */channel/*, */c/*, */user/*  ✅
	api : https://pipedapi.kavin.rocks/{type}/{channelid}
	- don't support search query						 ✅
	- support pagination, use nextpagequery				 ✅
	- last page indicator is "nextpage=null"			 ✅
	- nexpage channel api is different from search api	 ✅
	- need to extract channelid from api for /c/, /user/ ✅
	- channelid only available in first page			 ✅
	nextpagequery = "channel/{channelid}/?nextpage={nextpage}"
## *"/playlist?list="*  		   ✅
	api : https://pipedapi.kavin.rocks/playlists/{playlistid}
	- don't support search query						 ✅
	- support pagination, use nextpagequery				 ✅
	- last page indicator is "nextpage=null"			 ✅
	- nexpage playlist api is different from search api  ✅
	nextpagequery = "playlists/{playlistid}/?nextpage={nextpage}"
# Next Page ✅
	api : https://pipedapi.kavin.rocks/nextpage/{nextpagequery}

# Limitation
	- don't support search in channels, playlist
	- youtube-dl don't support https://piped.kavin.rocks/watch?v=*
		- yt-dlp extract stream from youtube.com
		- newpipe extract stream from youtube.com
	- for now use youtube.com, as the only thing that leaked to google is your ip, urls of videos 
	  you are watching and which time you are watching those videos
		- this can be fixed by making an internal extractor to get stream from piped
		  but if user select multiple videos, it well take a long time, cause it need to extract streams
		  from all selected video, and even than some streams may fail
		- share my own setup which is :
			- streamlink plugin + mpv plugin which use streamlink backend on selected urls simply by typing
			  mpv "https://piped.kavin.rocks/watch?v=*"
			  i use this for twitch, but i can make it work with piped
		- people who use piped probably are privacy minded people who don't like to leak their IP to google
		  so maybe :
			- use 'Watch on LBRY service' which check if video available on LBRY
			- if not check if user has the same setup as me
			- if not use direct youtube urls
			- or just don't watch youtube 🎉 
			 

[odnar-dev]

YOUTUBE

look like youtube has a new api called innertube, i moved this to be last one cause it looked more complicated...

# Trending	✅
	api:  "https://www.youtube.com/youtubei/v1/browse?key=AIzaSyAO_FJ2SlqU8Q4STEHLGCilw_Y9_11qcW8"
	- support select region: use region as query "gl":"US"			✅
	- don't support pagination , mark first page as the last page	✅
	- support tabs music, gaming, films								✅

# Search	✅
	api: "https://www.youtube.com/youtubei/v1/search?key=AIzaSyAO_FJ2SlqU8Q4STEHLGCilw_Y9_11qcW8"
	  - pagination, use nextpagequery			✅
	  - last page indicator is nextpagequery=""	✅

# Url
## */playlist?list=*	✅
	api: "https://www.youtube.com/youtubei/v1/browse?key=AIzaSyAO_FJ2SlqU8Q4STEHLGCilw_Y9_11qcW8"
	  - pagination, use nextpagequery			✅
	  - last page indicator is nextpagequery=""	✅
## */channel/*
- support search in channel
	- 

## */c/*|*/user/*
- need to extract channelid

# Next Page
- last page indicator is "nextpagequery empty"
- 

[odnar-dev]

PeerTube ✅

# Trending ✅
	api: https://framatube.org/api/v1/videos/?start=0&count=40&sort=-trending
	- support pagination ✅
		- page 1 : start=0&count=40
		- page 2 : start=40&count=40
		- start = (count*(page-1))
		- last page indicator is (count*(page)) > total
	- support filter by categories, languages, licence, include nsfw (nsfw=both)
# Search ✅
	api: https://framatube.org/api/v1/search/videos?start=0&count=40&search={query}&sort=-match&searchTarget=local
	- support pagination (same as trending) ✅
	- support filter by categories, languages, licence, include nsfw (nsfw=both)
	- support sort by name "name" "-duration" "-createdAt" "-publishedAt" "-views" "-likes" "-match"
# urlhandler ✅
## *"/c/"*|*"/video-channels/"*	 ✅
	api: https://videos.lukesmith.xyz/api/v1/video-channels/{channelHandle}/videos?start=0&count=2540sort=-publishedAt

## *"/a/"*|*"/accounts/"*		 ✅
	api:https://videos.lukesmith.xyz/api/v1/accounts/{channelHandle}/videos?start=0&count=25&sort=-publishedAt

# Limitation
	- youtube-dl don't support short video link like https://framatube.org/w/* yet
	- different instances has different version

[odnar-dev]

LBRY

# trends
	curl -X POST -H "content-type:application/json; charset=utf-8" -H "user-agent:okhttp/4.4.1" -d '{"jsonrpc":"2.0","method":"claim_search","params":{"no_totals":false,"stream_types":["video"],"order_by":["trending_group","trending_mixed"],"page":1,"has_source":true,"page_size":40}}' "https://api.lbry.tv/api/v1/proxy"

# search
	api :	
			https://lighthouse.odysee.com/search?s={query}&size=40&from=0&claimType=file&mediaType=video&nsfw=false&free_only=true
			https://lighthouse.lbry.com/search?s={query}&size=40&from=0&claimType=file&mediaType=video&include=view_cnt
	- support pagination
		- page 1 : from=0&size=40
		- page 2 : from=40&size=40
		- from = (size*(page-1))
	- support filter by nsfw
	- support sort by 

# urlhandler
## channel
	https://odysee.com/@Luke:7
	curl -X POST -H "content-type:application/json; charset=utf-8" -H "user-agent:okhttp/4.4.1" -d '{"jsonrpc":"2.0","method":"claim_search","params":{"channel":"@Luke:7","order_by":["release_time"],"page":1,"has_source":true,"page_size":40},"no_totals": false}' "https://api.lbry.tv/api/v1/proxy"
	- support pagination "page":{page}
	- last page indicator is "total_pages"
## channel search
https://lighthouse.odysee.com/search?s={query}&channel=luke&nsfw=false&size=50&from=0
https://lighthouse.odysee.com/search?s={query}&channel=@luke&nsfw=false&size=50&from=0

[odnar-dev]

Menu investigation

support navigation between pages
support multi-select
highlight selected items when navigating between pages
highlight watched videos in the season when navigating between pages
indicate when selector is not empty 
actions : play, download, exit, toggle, copy

different menus has different features

- fzf	:
- rofi	:
- dmenu	:
- cli	:
- sxiv	:
- rofi with thumbs (!learn rofi theme)
- sxim : Simple X Image Menu (fork of sxiv) (!learn C)

[odnar-dev]

fzf

fzf -e -i --multi --cycle --reverse --tiebreak=index \
	--prompt="Select Videos: " --header="${FZF_MESG}"  \
	--color="bg+:${VCOLOR},gutter:-1,marker:${VCOLOR}" \
	--with-nth='1..-3' \
	--color="bg+:${VCOLOR},marker:white" \
	--expect=ctrl-n,ctrl-p,ctrl-q,ctrl-t,alt-d,alt-p,alt-enter \
	-bind "ctrl-c:execute-silent()" \
	-bind "alt-c:execute-silent()" \

# key bind
## builtin: (can be run without the switching)
		✅ ctrl-c : copy selected items urls		
		✅ alt-c  : copy selected channels urls
## external:
		✅ ctrl-n : next page
		✅ ctrl-p : previous page
		✅ ctrl-q : exit
		✅ ctrl-t : toggle-all
		✅ alt-d  : download
		✅ alt-p  : play
		✅ alt-enter : play in background

actions : 
	✅ - play									
	✅ - Download : download all selected items
	✅ - Copy links : copy all selected items
	✅ - Exit
	   - Empty Selector : 
	

# Pros
- multi-select with tab/shift-tab
- KEY/EVENT BINDINGS
-  --expect=KEY
# Limitation
- i wanted to use reload(*) to dynamically navigate between pages without restarting fzf.
  but look like fzf don't remember selected items

[odnar-dev]

dmenu 👍🏻

- support navigation between pages									✅
- support multi-select												✅
- mark selected items when navigating between pages					✅
- mark watched videos in the season when navigating between pages	✅
- indicate when selector is not empty 								✅
- actions : 
	play		 ✅
	download	 ✅
	exit		 ✅
	toggle		 ⌛
	copy		 ⌛

VCOLOR : Platform Color

dmenuheader="[✔] Page 1" || dmenuheader="Page 1"

dmenu -i -l 30 -p "${dmenuheader}" -sb "${VCOLOR}"

# Limitation
- don't support key-binding
	- page navigation need to be done externally
- don't support multi-select
	- check out the Ctrl-Return key which prints the selected item to stdout and continues.
		- print duplicate lines

[odnar-dev]

cli

# Pros
- multi-select, download, paging, highlight selected  ✅
# Limitation
- UI
- no fuzzy finder

preview

typos 💤 

[odnar-dev]

rofi 👍🏻

- support navigation between pages									 	✅
- support multi-select												 	✅
- highlight selected items when navigating between pages				✅
- highlight watched videos in the season when navigating between pages	✅
- indicate when selector is not empty 								 	✅
- actions : 
	play		 ✅
	download	 ✅
	exit		 ✅
	toggle		 ✅
	copy		 ⌛ 

rofi -dmenu -i -p 'Select Videos' -markup-rows -multi-select -no-click-to-exit \
	 -mesg "${ROFI_MESG}" -l 23  -scroll-method 1 -theme-str 'window {width: 95%;}' \
	 -format p -selected-row "$((${selected_item:-0}+2))" -kb-row-down "Down" -kb-row-up "Up" \
	 -kb-custom-1 "ctrl-n" -kb-custom-2 "ctrl-p" -kb-custom-3 "ctrl-q" -kb-custom-4 "ctrl-t" \
	 -kb-custom-5 "alt-d" -kb-custom-6 "alt-p"

ctrl+n : next page
ctrl+p : previous page
ctrl+q : exit
ctrl+t : toggle-all
alt+d  : download
alt+p  : play

just some ideas : 
-filter $query		: remember search query
-theme-str '#window { fullscreen: true; }' : 
-show-icons			: can be used to show videos thumbnails
-u "0,2"			: can be used to mark watched videos?
-a "0,1,3"			: can be used to mark selected lines?

[odnar-dev]

Player investigation

## related options
-P | --player
-Pa| --player-args

-d | --download
-D | --downloader
-Da| --downloader-args

--only-audio | --no-video

## related variables
VPLAYER="${VIDS_DEFAULT_PLAYER:-mpv}"
VPLAYER_ARGS="${VIDS_DEFAULT_PLAYER_ARGS:-}"
VDOWNLOADER="${VIDS_DEFAULT_DOWNLOADER:-youtube-dl}"
VDOWNLOADER_ARGS="${VIDS_DEFAULT_DOWNLOADER_ARGS:-}"

play()
player()
downloader()

[odnar-dev]

fuck life commitment 👍