/
hsys-youtube.el
250 lines (222 loc) · 10.4 KB
/
hsys-youtube.el
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
;;; hsys-youtube.el --- Action buttons to play timestamped segments of Youtube videos -*- lexical-binding: t; -*-
;;
;; Author: Bob Weiner
;;
;; Orig-Date: 10-Jul-22 at 18:10:56
;; Last-Mod: 19-Jan-24 at 12:11:07 by Mats Lidell
;;
;; SPDX-License-Identifier: GPL-3.0-or-later
;;
;; Copyright (C) 2022 Free Software Foundation, Inc.
;; See the "HY-COPY" file for license information.
;;
;; This file is part of GNU Hyperbole.
;;; Commentary:
;;
;; Load this library and then you can embed Action Buttons like
;; these to play segments of Youtube videos from any of your
;; buffers, activating these buttons with the Action Key.
;;
;; All of these do the exact same thing:
;; <yt-play "WKwZHSbHmPg" "2:44">
;; <yt-play "WKwZHSbHmPg" "2m44s">
;; <yt-play "WKwZHSbHmPg" "164">
;; <yt-play "www.youtube.com/watch?v=WKwZHSbHmPg" "2m:44">
;; <yt-play "www.youtube.com/watch?v=WKwZHSbHmPg&start=30&end=40">
;; <yt-play "youtu.be/WKwZHSbHmPg&t=2m44s">
;; <yt-play "https://www.youtube.com/watch?v=WKwZHSbHmPg" "0h:2m:44s">
;;
;; Add a third parameter to give the end/stop time:
;; <yt-play "WKwZHSbHmPg" "2m44s" "2m50s">
;; <yt-url "WKwZHSbHmPg" "2m44s" "2m50s">
;; Additional Action Button types include search:
;; <yt-search "hypertext hyperbole">
;;
;; and summarizing all of the metadata info associated with a video:
;; <yt-info "WKwZHSbHmPg">
;;; Code:
;;; ************************************************************************
;;; Requirements
;;; ************************************************************************
;;;###autoload
(require 'hact) ;; For htype:symbol
(require 'hsys-www)
;;; ************************************************************************
;;; Public variables
;;; ************************************************************************
(defvar hsys-youtube-start-format "https://www.youtube.com/watch?v=%s&t=%s"
"Format string used to play a Youtube video from a certain point in time.
The first %s is where the video id string is inserted and the second %s is
where the time string is inserted. The time string must be a
colon-separated hours:minutes:seconds string, e.g. 1:2:44 (1 hour, two
minutes, 45 seconds), where the hours and minutes are optional.")
(defvar hsys-youtube-end-format "https://www.youtube.com/embed/%s?autoplay=1&start=%s&end=%s"
"Format string used to play a section of a Youtube video.
This requires use of the `embed' api.
The first %s is where the video id string is inserted; the second %s is
where the start time string in seconds is inserted; the third %s is
where the end time string in seconds is inserted. The time strings
must be in colon-separated hours:minutes:seconds format, e.g. 1:2:44
\(1 hour, two minutes, 45 seconds), where the hours and minutes are
optional.")
;;; ************************************************************************
;;; Public functions
;;; ************************************************************************
;;;###autoload
(defact yt-info (video-id)
"Display a web page with the metadata information about VIDEO-ID."
(hact #'actypes::www-url (format "https://mattw.io/youtube-metadata/?url=https://youtu.be/%s&submit=true"
video-id)))
;;;###autoload
(defact yt-play (video-id &optional start-time-string end-time-string)
"Play a VIDEO-ID from the point specified by optional START-TIME-STRING.
If not given, START-TIME-STRING is set to \"0s\" representing the beginning
of the video. START-TIME-STRING is a colon-separated hours:minutes:seconds
string, e.g. 1:2:44 (1 hour, two minutes, 45 seconds), where the hours
and minutes are optional."
(hact #'actypes::www-url (hsys-youtube-get-url video-id start-time-string end-time-string)))
;;;###autoload
(defact yt-search (search-term)
"Search Youtube for SEARCH-TERM."
(interactive "sSearch Youtube for: ")
(hyperbole-web-search "Youtube" search-term))
;;;###autoload
(defact yt-url (video-id &optional start-time-string end-time-string)
"Return url to play VIDEO-ID from point specified by optional START-TIME-STRING.
Return nil if START-TIME-STRING is given but is invalid. If not given,
START-TIME-STRING is set to \"0s\" representing the beginning of the video.
START-TIME-STRING is a colon-separated hours:minutes:seconds string,
e.g. 1:2:44 (1 hour, two minutes, 45 seconds), where the hours and
minutes are optional."
(if end-time-string
(progn (setq start-time-string (hsys-youtube-time-in-seconds start-time-string)
end-time-string (hsys-youtube-time-in-seconds end-time-string))
(hsys-youtube-end-url video-id start-time-string end-time-string))
(setq start-time-string (hsys-youtube-time-in-hms start-time-string)
end-time-string (hsys-youtube-time-in-hms end-time-string))
(hsys-youtube-start-url video-id start-time-string)))
;;;###autoload
(defun hsys-youtube-play:help (hbut)
"Show in the minibuffer the url for an `hsys-youtube-play' action button, HBUT.
Called when the Assist Key is pressed on such a button."
(message (apply #'hsys-youtube-get-url (hattr:get hbut 'args))))
;; Create easy to type Action Button aliases.
;;;###autoload
(defalias 'hsys-youtube-info (htype:symbol 'yt-info 'actypes))
;;;###autoload
(defalias 'hsys-youtube-play (htype:symbol 'yt-play 'actypes))
;;;###autoload
(defalias 'hsys-youtube-search (htype:symbol 'yt-search 'actypes))
;;;###autoload
(defun hsys-youtube-search:help (search-term)
"Display in the minibuffer the Youtube url to search for SEARCH-TERM."
(interactive "sShow Youtube search url for: ")
(hyperbole-web-search "Youtube" search-term t))
;;;###autoload
(defalias 'hsys-youtube-get-url (htype:symbol 'yt-url 'actypes))
;;;###autoload
(defun hsys-youtube-get-url:help (hbut)
"Show in minibuffer the url from an `hsys-youtube-get-url' action button, HBUT.
Called when the Assist Key is pressed on such a button."
(message (apply #'hsys-youtube-get-url (hattr:get hbut 'args))))
;;; ************************************************************************
;;; Private variables
;;; ************************************************************************
(defconst hsys-youtube-url-prefix-regexp "\\`\\(https://\\|www\\.\\|youtube\\.\\|youtu\\.be/\\)"
"Regexp matching the start of a Youtube url.")
;;; ************************************************************************
;;; Private functions
;;; ************************************************************************
;;;###autoload
(defun hsys-youtube-end-url (video-id &optional start-time-string end-time-string)
"Return url to play VIDEO-ID from optional START-TIME-STRING to END-TIME-STRING.
VIDEO-ID must be a string and can be a video identifier,
e.g. WkwZHSbHmPg, or a full url to the video."
(if (or (null video-id)
(not (stringp video-id))
(string-empty-p video-id))
(error "(hsys-youtube-end-url): Invalid 'video-id': '%s'" video-id)
(setq start-time-string (if (stringp start-time-string)
(hsys-youtube-time-in-seconds start-time-string)
"0")
end-time-string (if (stringp end-time-string)
(hsys-youtube-time-in-seconds end-time-string)
"-1"))
(format "%s&rand=%d"
(if (string-match-p hsys-youtube-url-prefix-regexp video-id)
(if (string-match-p "[?&]\\(start\\|end\\)=" video-id)
video-id
(format (concat video-id "?autoplay=1&start=%s&end=%s")
start-time-string end-time-string))
(format hsys-youtube-end-format video-id start-time-string end-time-string))
;; Need to change the URL each time is called to force
;; replay, so add unused random parameter.
(random 10000000))))
;;;###autoload
(defun hsys-youtube-start-url (video-id &optional start-time-string)
"Return url to play VIDEO-ID starting at beginning or optional START-TIME-STRING.
VIDEO-ID must be a string and can be a video identifier,
e.g. WkwZHSbHmPg, or a full url to the video."
(if (or (null video-id)
(not (stringp video-id))
(string-empty-p video-id))
(error "(hsys-youtube-start-url): Invalid 'video-id': '%s'" video-id)
(setq start-time-string (if (stringp start-time-string)
(hsys-youtube-time-in-hms start-time-string)
"0s"))
(if (string-match-p hsys-youtube-url-prefix-regexp video-id)
(if (string-match-p "[?&]t=" video-id)
video-id
(format (concat video-id "&t=%s") start-time-string))
(format hsys-youtube-start-format video-id start-time-string))))
;;;###autoload
(defun hsys-youtube-time-in-hms (start-time-string)
"Return the start time for a Youtube url from START-TIME-STRING.
Start time is returned as hours, minutes and seconds.
Hours and minutes are optional within the START-TIME-STRING, e.g. 1:2:44 (1
hour, two minutes, 45 seconds into a video). If the START-TIME-STRING
format is invalid, return it unchanged."
(if (and (stringp start-time-string)
(string-match-p ":" start-time-string))
(let* ((time-parts (split-string start-time-string "[:hmsHMS]" t))
(num-of-parts (length time-parts))
(part1 (nth 0 time-parts))
(part2 (nth 1 time-parts))
(part3 (nth 2 time-parts)))
(cond ((zerop num-of-parts)
"0s")
((= num-of-parts 1)
(concat part1 "s"))
((= num-of-parts 2)
(concat part1 "m" part2 "s"))
((= num-of-parts 3)
(concat part1 "h" part2 "m" part3 "s"))))
start-time-string))
;;;###autoload
(defun hsys-youtube-time-in-seconds (start-time-string)
"Return the number of seconds time for a Youtube url given a START-TIME-STRING.
Hours and minutes are optional within the START-TIME-STRING,
e.g. 1:2:44 (1 hour, two minutes, 45 seconds into a video). The
formats 1h2m44s or 1h:2m:44s may also be used. If the
START-TIME-STRING format is invalid, return it unchanged."
(if (and (stringp start-time-string)
(string-match-p "[:hmsHMS]" start-time-string))
(let* ((time-parts (split-string start-time-string "[:hmsHMS]" t))
(num-of-parts (length time-parts))
(part1 (nth 0 time-parts))
(part2 (nth 1 time-parts))
(part3 (nth 2 time-parts)))
(cond ((zerop num-of-parts)
"0")
((= num-of-parts 1)
part1)
((= num-of-parts 2)
(int-to-string (+ (* (string-to-number part1) 60)
(string-to-number part2))))
((= num-of-parts 3)
(int-to-string (+ (* (string-to-number part1) 3600)
(* (string-to-number part2) 60)
(string-to-number part3))))))
start-time-string))
(provide 'hsys-youtube)
;;; hsys-youtube.el ends here