/
youtube-viewer
executable file
·3044 lines (2602 loc) · 103 KB
/
youtube-viewer
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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/perl
#
# Copyright (C) 2010-2013 Trizen <echo dHJpemVueEBnbWFpbC5jb20K | base64 -d>.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
#-------------------------------------------------------
# Appname: youtube-viewer
# Created on: 02 June 2010
# Latest edit on: 11 November 2013
# Websites: http://trizen.googlecode.com
# https://github.com/trizen/youtube-viewer
#-------------------------------------------------------
#
# youtube-viewer is a command line utility for viewing youtube-videos in MPlayer.
#
# [CHANGELOG]
# - Added support for YouTube EDU categories (-edu) // Options: :dv, :lec, :courses, :course - NEW (v3.0.4)
# - Some minor bug-fixes // New options has been added: --pp, :pp, :anp, :kregex - NEW (v3.0.3)
# - Added support for more resolutions, UTF-8 support, --convert-to=FMT and many bug-fixes - NEW (v3.0.1)
# - Youtube Viewer 3.0 has been released! New options, better functionality and new bugs :) - NEW (v3.0.0)
# - Added support for detailed results (usage: -D or --details) // Support for comments - NEW (v2.5.8)
# - Switched to Term::ReadLine for a better STDIN support // Better colors // Info support - NEW (v2.5.7)
# - Added support for: -duration, -caption=s, -safe-search=s, -hd // Improved code quality - NEW (v2.5.6)
# - Added support for configuration file, improved stability, improved debug mode - NEW (v2.5.5)
# - Switched to XML::Fast for parsing gdata XML, in consequence, youtube-viewer is faster! - NEW (v2.5.5)
# - Switched to Getopt::Long, added SIGINT handler and a better way to execute mplayer - NEW (v2.5.5)
# - Added support to list playlists created by a specific user (usage: -up <USERNAME>) - NEW (v2.5.4)
# - Improved parsing support for arguments, including arguments specified via STDIN. - NEW (v2.5.4)
# - Added support to search for videos uploaded by a particular YouTube user (-author=USER) - NEW (v2.5.4)
# - Added support to get video results starting with a predefined page (e.g.: -page=4) - NEW (v2.5.4)
# - Added support for previous page and support to list youtube usernames from a file - (v2.5.2)
# - Added few options to control cache of MPlayer and lower cache for lower video resolutions - (v2.5.1)
# - Added colors for text (--use_colors), 360p support (-3), playlist support - (v2.5.0)
# - Added support for today and all time Youtube tops (usage: -t, --tops, -a, --all-time) - (v2.4.*)
# - Re-added the support for the next page / Added support for download (-d, --download) - (v2.4.*)
# - Added support for Youtube CCaptions. (Depends on: 'gcap' - http://gcap.googlecode.com) - (v2.4.*)
# - First version with Windows support. Require SMPlayer to play videos. See MPlayer Line - (v2.4.*)
# - Code has been changed in a proportion of ~60% and optimized for speed // --480 became -4 - (v2.4.*)
# - Added mega-powers of omnibox to the STDIN :) - (v2.3.*)
# - Re-added the option to list and play youtube videos from a user profile. Usage: -u [user] - (v2.3.*)
# - Added a new option to play only the audio track of a videoclip. Usage: [words] -n - (v2.3.*)
# - Added option for fullscreen (-f, --fullscreen). Usage: youtube-viewer [words] -f - (v2.3.*)
# - Added one new option '-c'. It shows available categories and will let you to choose one. - (v2.3.*)
# - Added one new option '-m'. It shows 3 pages of youtube video results. Usage: [words] -m - (v2.3.*)
# - For "-A" option has been added 3 pages of youtube video results (50 clips) - (v2.3.*)
# - Added "-prefer-ipv4" to the mplayer line (videoclips starts in no time now). - (v2.3.*)
# - Search and play videos at 480p, 720p. Ex: [words] --480, [words] -A --480 - (v2.3.*)
# - Added support to play a video at 480p even if it's resolution is higher. Ex: [url] --480 - (v2.2.*)
# - Added a nice feature which prints some informations about the current playing video - (v2.2.*)
# - Added support to play videos by your order. Example: after search results, insert: 3 5 2 1 - (v2.1.*)
# - Added support for next pages of video results (press <ENTER> after search results) - (v2.1.*)
# - Added support to continue playing searched videos, usage: "youtube-viewer [words] -A" - (v2.1.*)
# - Added support to print counted videos and support to insert a number instead of video code - (v2.1.*)
# - Added support to search YouTube Videos in script (e.g.: youtube-viewer avatar trailer) - (v2.0.*)
# - Added support for script to choose automat quality if it is lower than 1080p - (v2.0.*)
# - Added support to choose the quality only between 720p and 1080p (if it is available) - (v2.0.*)
# - Added support for YouTube video codes (e.g.: youtube-viewer WVTWCPoUt8w) - (v1.0.*)
# - Added support for 720p and 1080p YouTube Videos... - (v1.0.*)
# Special thanks to:
# - Army (for the bug reports and for his great ideas: https://aur.archlinux.org/packages.php?ID=37779&comments=all)
# - dhn (for adding youtube-viewer in freshports.org: http://www.freshports.org/multimedia/youtube-viewer)
# - stressat (for the great review of youtube-viewer: http://stressat.blogspot.com/2012/01/youtube-viewer.html)
# - symbianflo (for packaging youtube-viewer for Mandriva: https://abf.rosalinux.ru/symbianflo/youtube-viewer)
# - gotbletu (for the great video review of youtube-viewer: http://www.youtube.com/watch?v=FnJ67oAxVQ4)
# - Julian Ospald (for adding youtube-viewer in the gentoo portage tree: http://packages.gentoo.org/package/net-misc/youtube-viewer)
# - 666philb (for packaging gtk-youtube-viewer for Puppy Linux: http://www.murga-linux.com/puppy/viewtopic.php?t=76835)
# - Kevin Lemonnier (for adding support for proxy - https://github.com/Ulrar)
=head1 NAME
youtube-viewer - YouTube from command line.
See: youtube-viewer --help
youtube-viewer --tricks
youtube-viewer --examples
youtube-viewer --stdin-help
=head1 LICENSE AND COPYRIGHT
Copyright 2010-2013 Trizen.
This program is free software; you can redistribute it and/or modify it
under the terms of either: the GNU General Public License as published
by the Free Software Foundation; or the Artistic License.
See http://dev.perl.org/licenses/ for more information.
=cut
use 5.016;
#use lib qw(../lib); # devel only
#use warnings; # debug only
use File::Spec::Functions qw(catdir catfile curdir path rel2abs tmpdir);
no if $] >= 5.018, warnings => 'experimental::smartmatch';
no if $] >= 5.018, warnings => 'deprecated';
my $appname = 'Youtube Viewer';
my $version = '3.0.9';
my $execname = 'youtube-viewer';
# A better <STDIN> support:
require Term::UI;
my $term = Term::ReadLine->new("$appname $version");
# Developer key
my $key = 'eTj9NtCyOsGMliTTwz-T85muGT-ARAwVREslfB_giHP3X339Jkpn5Xf71pQXY96xWtFY1oFHt530ct5uZZJk5YTghbNm2IrwZ4';
# Options (key=>value) goes here
my %opt = ();
my $term_width = 80;
# Unchangeable data goes here
my %constant = (win32 => ($^O =~ /^mswin\d/i || 0));
my $xdg_config_home = $ENV{XDG_CONFIG_HOME}
|| catdir(
(
$ENV{HOME}
|| $ENV{LOGDIR}
|| ($constant{win32} ? '\Local Settings\Application Data' : ((getpwuid($<))[7] || `echo -n ~`))
),
'.config'
);
# Configuration dir/file
my $config_dir = catdir($xdg_config_home, $execname);
my $config_file = catfile($config_dir, "$execname.conf");
my $authentication_file = catfile($config_dir, 'reg.dat');
if (not -d $config_dir) {
require File::Path;
File::Path::make_path($config_dir)
or warn "[!] Can't create dir '$config_dir': $!";
}
sub which_command {
my ($cmd) = @_;
foreach my $path (path()) {
if (-e (my $cmd_path = catfile($path, $cmd))) {
return $cmd_path;
}
}
return;
}
# Regular expressions
use WWW::YoutubeViewer::RegularExpressions;
# Main configuration
my %CONFIG = (
# MPlayer options
cache => 30000,
cache_min => 5,
lower_cache => 2000,
lower_cache_min => 3,
mplayer => get_mplayer(),
mplayer_srt_args => '-sub %s',
mplayer_arguments => '-prefer-ipv4 -really-quiet -cache %d -cache-min %d',
# Youtube options
prefer_https => 0,
results => 20,
resolution => 'original',
hd => undef,
safe_search => undef,
caption => undef,
duration => undef,
time => undef,
orderby => undef,
categories_language => 'en-US',
# URI options
youtube_video_url => 'http://www.youtube.com/watch?v=%s',
# Subtitle options
srt_languages => ['en', 'jp'],
captions_dir => tmpdir(),
get_captions => 1,
gcap => undef,
# Others
http_proxy => undef,
debug => 0,
colors => $constant{win32} ^ 1,
clobber => 0,
skip_if_exists => 0,
lwp_downloading => $constant{win32},
fullscreen => 0,
use_lower_cache => 0,
results_with_details => 0,
results_with_colors => 0,
results_fixed_width => 0,
interactive => 1,
get_term_width => $constant{win32} ^ 1,
download_with_wget => $constant{win32} ^ 1,
thousand_separator => q{,},
downloads_folder => curdir(),
keep_original_video => 0,
download_and_play => 0,
remove_played_file => 0,
ffmpeg_command => 'ffmpeg -i %s %s',
convert_to => undef,
);
local $SIG{__WARN__} = sub { warn @_; ++$opt{_error} };
my %MPLAYER;
# MPlayer variable arguments
sub set_mplayer_arguments {
my ($cache, $cache_min) = @_;
$MPLAYER{mplayer_arguments} = sprintf $opt{mplayer_arguments}, $cache, $cache_min;
$MPLAYER{fullscreen} = $opt{fullscreen} ? q{-fs} : q{};
$MPLAYER{novideo} = $opt{novideo} ? q{-novideo} : q{};
return 1;
}
my $base_options = <<'BASE';
# Base
[keywords] : search for YouTube videos
[youtube-url] : play a video by YouTube URL
:v(ideoid)=ID : play videos by YouTube video IDs
[playlist-url] : list videos from a playlistURL
:playlist=ID : list videos from a playlistID
:lectures=ID : list lectures from a categoryID
:course=ID : list lectures from a courseID
:courses=ID : list courses of lectures from a categoryID
BASE
my $action_options = <<'ACTIONS';
# Actions
:login : will prompt you for login
:logout : will delete the authentication key
ACTIONS
my $control_help = <<'CONTROL';
# Control
:n(ext) : get the next page of results
:b(ack) : get the previous page of results
CONTROL
my $other_options = <<'OTHER';
# Others
:r(eturn) : return to the previous section
:reset, :reload : restart the application
:dv=i : print the key=>value informations
-argv -argv2=v : some arguments (e.g.: -u=google)
:q, :quit, :exit : close the application
OTHER
my $notes_options = <<'NOTES';
NOTES:
1. You can specify more options in a row, separated by spaces.
2. A stdin option is valid only if it begins with '=', ';' or ':'.
3. Quoting a group of space separated keywords, or option values,
the group will be considered just like a single value/keyword.
NOTES
my $general_help = <<"HELP";
$action_options
$other_options
$notes_options
Examples:
4 : select the 4th result
-V funny cats : search for videos
-p classical music : search for playlists of videos
HELP
my $complete_help = <<"STDIN_HELP";
$base_options
$control_help
$action_options
# YouTube
:i(nfo)=i,i : show video informations
:d(ownload)=i,i : download the selected videos
:c(omments)=i : show video comments
:r(elated)=i : show related videos
:a(uthor)=i : show a video author's latest uploads
:p(laylists)=i : show author's latest playlists
:subscribe=i : subscribe to an author's channel
:(dis)like=i : like or dislike a video
:fav(orite)=i : favorite a video
# Playing
<number> : play the corresponding video
3-8, 3..8 : same as 3 4 5 6 7 8
8-3, 8..3 : same as 8 7 6 5 4 3
8 2 12 4 6 5 1 : play the videos in your order
:q(ueue)=i,i,... : enqueue videos to play them later
:pq, :play-queue : play the enqueued videos (if any)
:anp :nnp : auto-next-page, no-next-page
:regex=my?[regex] : play videos matched by a regex (/i)
:kregex=KEY,RE : play videos if the value of KEY matches the RE
$other_options
$notes_options
** Examples:
:regex="\\w \\d" -> play videos matched by a regular expression.
:info=1,4 -> show informations for the first and 4th video.
:d18-20,1,2 -> download the videos: 18, 19, 20, 1 and 2.
-u=google -D -> list videos from google with extra details.
3 4 :next 9 -> play the 3rd and 4th videos from the current
page, go to the next page and play the 9th video.
STDIN_HELP
{
my $config_documentation = <<"EOD";
#!/usr/bin/perl
# $appname $version - configuration file
EOD
sub dump_configuration {
require Data::Dump;
open my $config_fh, '>', $config_file
or do { warn "[!] Can't open '${config_file}' for write: $!"; return };
my $dumped_config = q{our $CONFIG = } . Data::Dump::pp(\%CONFIG) . "\n";
print $config_fh $config_documentation, $dumped_config;
close $config_fh;
}
}
if (not -e $config_file or -z _ or $opt{reconfigure}) {
dump_configuration();
}
our $CONFIG;
require $config_file; # Load the configuration file
if (ref $CONFIG ne 'HASH') {
die "ERROR: Invalid configuration file!\n\t\$CONFIG is not an HASH ref!";
}
my @valid_keys = grep { exists $CONFIG{$_} } keys %{$CONFIG};
@CONFIG{@valid_keys} = @{$CONFIG}{@valid_keys};
if (not \%CONFIG ~~ $CONFIG) {
dump_configuration();
}
# Locating gcap
if (not defined $CONFIG{gcap}) {
if (defined(my $gcap = which_command('gcap'))) {
$CONFIG{gcap} = $gcap;
dump_configuration();
}
}
@opt{keys %CONFIG} = values(%CONFIG);
{
my $i = length $key;
$key =~ s/(.{$i})(.)/$2$1/g while $i--;
}
require WWW::YoutubeViewer;
my $yv_obj = WWW::YoutubeViewer->new(
key => $key,
app_name => $appname,
app_version => $version,
config_dir => $config_dir,
escape_utf8 => 1,
authentication_file => $authentication_file,
);
{
my $client_id = '991455593101.apps.googleusercontent.com';
my $client_secret = 'YcxxWCCbBwIr-IhUDCanrp41';
my $redirect_uri = 'urn:ietf:wg:oauth:2.0:oob';
$yv_obj->set_client_id($client_id);
$yv_obj->set_client_secret($client_secret);
$yv_obj->set_redirect_uri($redirect_uri);
}
require WWW::YoutubeViewer::Utils;
my $yv_utils = WWW::YoutubeViewer::Utils->new(thousand_separator => $opt{thousand_separator},);
{
no strict 'refs';
foreach my $name (qw(description title)) {
*{__PACKAGE__ . '::get_and_print_video_' . $name} = sub {
foreach my $id (@_) {
my $videoID = get_valid_video_id($id) // next;
my $info = $yv_obj->get_video_info($videoID);
if (@{$info->{results}}) {
say $info->{results}[0]{$name};
}
else {
warn_cant_get($name, $videoID);
}
}
};
}
}
# Apply the configuration file
unless (qr/^--?(?>N|noconfig)\z/ ~~ \@ARGV) {
my (%temp_hash) = %CONFIG;
apply_configuration(\%temp_hash);
}
#---------------------- YOUTUBE-VIEWER USAGE ----------------------#
sub help {
my $eqs = q{=} x 30;
print <<"HELP";
\n $eqs \U$appname\E $eqs
\t\t\t\t\t\t by Trizen (trizenx\@gmail.com)
usage: $execname [options] ([url] || [keywords])
Base Options:
<url> : play an YouTube video by URL
<keywords> : search and list YouTube videos
<playlist_url> : list a playlist of YouTube videos
YouTube options:
-t --tops : show today YouTube video tops
--tops=all : show all time YouTube video tops
-r --region=ID : list top videos for a specific region
-M --movies : show YouTube category of movies
-c --categories : show available YouTube categories
--edu-categories : show the YouTube EDU categories
--course-id=ID : list the video lectures from courseID
-hl --catlang=s : language for categories (default: en-US)
-p --playlists : search for playlists of videos
--playlist=ID : list a playlist of videos by playlistID
--pp=ID,ID : play the videos from the given playlist IDs
-u --user=s : list videos uploaded by a specific user
-up --user-pl=s : list playlists created by a specific user
-uf --user-fav=s : list the videos favorited by a specific user
-V --videos=K-WORDS : search for YouTube videos (default mode)
-id --videoids=ID,ID : play the YouTube videos by video IDs
-rv --related=URL/ID : show related videos for a video ID/URL
--channels : search for Youtube channels
--disco : YouTube discovery - search and list the playlist
--author=s : search in videos uploaded by a specific user
--duration=s : filter search results based on video length
valid values are: short, medium, long
--caption=s : only videos with/without closed captions
valid values are: true, false
--category=s : search only for videos in a specific category
this option can also be used with the --tops argument
--safe-search=s : YouTube will skip restricted videos for your location
valid values are: none, moderate, strict
--orderby=s : order entries by: published, viewCount or rating
--time=s : show only videos uploaded within the specified time
valid values are: today, this_week and this_month
--hd : search only for videos available in at least 720p
--page=i : get results starting with a specific page
--results=[1-50] : how many results to display per page
-2 -3 -4 -7 -1 : resolutions: 240p, 360p, 480p, 720p and 1080p
--resolution=RES : available resolutions: original, 1080p, 720p,
480p, 360p, 240p, 144p, audio
-F --favorites:s : show the latest favorited videos *
-R --recommended : show the recommended videos for you *
-S --subscriptions:s : show the new subscription videos *
-W --watched : show the latest watched videos on YouTube *
--channel-sugg : show the suggested YouTube channels for you *
--subscribe=USER : subscribe to a user's channel *
--favorite=ID/URL : favorite a YouTube video by URL or ID *
--like=ID/URL : send a 'like' rating to one or more videos *
--dislike=ID/URL : send a 'dislike' rating to one or more videos *
MPlayer options:
-f --fullscreen! : set the fullscreen mode for mplayer (-fs)
-n --novideo! : play the music only without a video in the foreground
-l --use-lc : use a lower cache for MPlayer (for slow connections)
--nocache : use no cache while streaming videos (for fast connections)
--cache=i : set the cache for MPlayer (set: $opt{cache})
--cache-min=i : set the cache-min for MPlayer (set: $opt{cache_min})
--lcache=i : set the lower-cache for MPlayer (set: $opt{lower_cache})
--lcache-min=i : set the lower-cache-min for MPlayer (set: $opt{lower_cache_min})
--mplayer=s : set a media player (set: $opt{mplayer})
--mplayer-args=s : replace the arguments for the media player
--mplayer-srt-args=s : replace the subtitle arguments for the media player
--append-mplayer=s : add some arguments for the media player
Other options:
-d --download! : download the video(s)
-i --info=ID/URL : show video informations for a videoID or URL
-A --all! : play all the video results in order
-s --shuffle! : shuffle the playlist before playing (with -A)
-C --colorful! : use colors to delimit the video results
-D --details! : a new look for the results, with more details
-W --fixed-width! : adjust the results to fit inside the term width
-L --lwp-download! : download the videos with LWP (default: wget)
-U --update-config : update the configuration file before exit
-N --noconfig : start the $appname with the default config
-I --interactive! : prompt for the first user input
-q --quiet : do not display any warning
-dp --downl-play : play the video after download (with -d)
-rp --rem-played : delete a local video after played (with -dp)
--really-quiet : do not display any warning or output
--use-colors! : use ANSI colors for text
--convert-to=FORMAT : convert video to a specific format (with -d)
--ffmpeg-command=s : ffmpeg command for converting videos after download
--keep-original! : keep the original video after converting
--comments=ID/URL : show comments for a YouTube video
--get-title=ID/URL : get and print the title for a video
--get-desc=ID/URL : get and print the description for a video
--gcap=s : set the full path to the gcap script
--get-captions! : download the closed captions (with gcap)
--captions-dir=s : the directory where to download the .srt files
--gdata-url=s : print video results from a valid GData URL
--get-term-width! : adjust the text for your terminal width
--login : will prompt you for login
--logout : will delete the authentication key
--http_proxy=s : HTTP proxy to use, format 'http://domain.tld:port/'.
If authentication required,
use 'http://user:pass\@domain.tld:port/'
--clobber : overwrite an existent video (with -d)
--skip-if-exists! : don't download videos which already exists (with -d)
--prefer-https! : use the HTTPS protocol instead of the HTTP protocol
--downloads-dir=s : downloads directory (set: '$opt{downloads_folder}')
Help options:
-T --tricks : show more 'hidden' features of $appname
-E --examples : show some useful usage examples for $appname
-H --stdin-help : show the valid stdin options for $appname
-v --version : print version and exit
-h --help : print help and exit
--debug:1,2 : see behind the scenes
NOTE:
* -> requires authentication
! -> the argument can be negated with '--no'
=s -> requires an argument
:s -> can take an optional argument
HELP
main_quit(0);
}
sub wrap_text {
my (%args) = @_;
require Text::Wrap;
${Text::Wrap::columns} = $args{columns} || $term_width;
my $text = "@{$args{text}}";
$text =~ tr{\r}{}d;
return eval { Text::Wrap::wrap($args{i_tab}, $args{s_tab}, $text) } // $text;
}
sub tricks {
my $tab = "\t\t";
my $cat_ids = wrap_text(
i_tab => $tab,
s_tab => $tab,
text => [@{WWW::YoutubeViewer::categories_IDs}]
);
my $region_ids = wrap_text(
i_tab => $tab,
s_tab => $tab,
text => [@{WWW::YoutubeViewer::region_IDs}]
);
my $valid_keys = wrap_text(
i_tab => q{},
s_tab => q{ } x 3,
text => [
sort qw(
favorited videoID
name duration author
description dislikes
rating published views
category title likes
)
]
);
print <<"TRICKS";
** Valid categories:
$cat_ids
** Valid region IDs:
$region_ids
NOTE: Categories and region IDs are case sensitive!
[orderby, time, duration]'s values are also case sensitive!
** Playing videos
1. To stream the videos in other players, you need to change the
configuration file. You can execute '$execname -mplayer=vlc' for
example, but the mplayer arguments doesn't work for vlc.
The full command should be: $execname -mplayer=vlc -mplayer-arg=-q
2. lower_cache and lower_cache_min values are used when -l (--use-lower-cache)
is specified as argument, or if the resolution of a video is lower than 720p.
** Arguments
1. Almost all boolean arguments can be negated with a '--no-' prefix.
2. Arguments that require an ID/URL, you can specify more than one,
separated by whitespace (quoted), or separated by commas.
** More STDIN help:
1. ':r', ':return' will return to the previous section.
For example, if you search for playlists, then list a playlist
of videos, inserting ':r' will return back to the playlist results.
Also, for the previous page, you can insert ':b', but ':r' is faster!
2. "6" (quoted) or -V=6 will search for videos with the keyword '6'.
3. If a stdin option is followed by one or more digits, the equal sign,
which separates the option from value, can be omited.
For example:
:i2,4 is equivalent with :i=2,4
:d1-5 is equivalent with :d=1,2,3,4,5
:c10 is equivalent with :c=10
4. When more videos are selected to play, you can stop them by
pressing CTRL+C. $appname will return to the previous section.
5. For the option ':kregex', the valid keys are:
$valid_keys
6. Space inside the values of the STDIN options, can be either escaped
or backslashed.
For example:
:re=video\\ title == :re="video title"
7. ':anp' stands for the "Auto Next Page". How do we use it?
Well, let's search for some videos. Now, if we'd want to play
only the videos matched by a regex, we'd say :re="REGEX".
But, what if we'd want to play the videos from the next pages too?
In this case, ':anp' is your friend. Use it wisely!
** Closed-Captions
To get the closed-captions (subtitles) for videos, you need to install
the 'gcap' program. See: http://gcap.googlecode.com
After it is installed, put it into the configuration file as:
gcap => '/path/to/gcap'
** Configuration file: $config_file
** Donations gladly accepted:
https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=75FUVBE6Q73T8
TRICKS
main_quit(0);
}
sub examples {
print <<"EXAMPLES";
==== COMMAND LINE EXAMPLES ====
Command: $execname -A -n -4 russian music -category=Music
Results: play all the video results (-A)
only audio, no video (-n)
quality 480p (-4)
search for "russian music"
in the "Music" category.
-A will include the videos from the next pages as well.
Command: $execname -comments=http://www.youtube.com/watch?v=U6_8oIPFREY
Results: show video comments for a specific video URL or videoID
Command: $execname -results=5 -up=khanacademy -D
Results: set 5 results,
get playlists created by a specific user
and print them with details (-D)
Command: $execname -author=UCBerkeley atom
Results: search only in videos uploaded by a specific author
Command: $execname -S=vsauce
Results: get the video subscriptions for a username
Command: $execname --page=2 -u=Google
Results: show latest videos uploaded by Google,
starting with the page number 2.
Command: $execname --category=Music --tops
Results: show today tops for Music category.
Command: $execname --tops=all --region=JP
Results: show all time tops for the Japan country.
Command: $execname --tops --region=RU --category=Music
Results: show today tops of RUssian Music
Command: $execname cats -order-by=viewCount -duration=short
Results: search for 'cats' videos, ordered by ViewCount and short length.
Command: $execname --channels russian music
Results: search for channels.
Command: $execname --uf=Google
Results: show latest videos favorited by a user.
==== USER INPUT EXAMPLES ====
A STDIN option can begin with ':', ';' or '='.
Command: <ENTER>, :n, :next, CTRL+D
Results: get the next page of results.
Command: :b, :back (:r, :return)
Results: get the previous page of results.
Command: :i4..6, :i7-9, :i20-4, :i2, :i=4, :info=4
Results: show video informations for the selected videos.
Command: :d5,2, :d=3, :download=8
Results: download the selected videos.
Command: :c2, :comments=4
Results: show comments for a selected video.
Command: :r4, :related=6
Results: show related videos for a selected video.
Command: :a14, :author=12
Results: show videos uploaded by the author who uploaded the selected video.
Command: :p9, :playlists=14
Results: show playlists created by the author who uploaded the selected video.
Command: :subscribe=7
Results: subscribe to the author's channel who uploaded the selected video.
Command: :like=2, :dislike=4,5
Results: like or dislike the selected videos.
Command: :course=EC7AEDF86AABA1AA9A
Results: list videos lectures from course ID.
Command: :courses=285
Results: list courses of lectures from EDU category ID.
Command: :lectures=361
Results: list video lectures from EDU category ID.
Command: :fav=4, :favorite=3..5
Results: favorite the selected videos.
Command: 3, 5..7, 12-1, 9..4, 2 3 9
Results: play the selected videos.
Command: :q3,5, :q=4, :queue=3-9
Results: enqueue the selected videos to play them later.
Command: :pq, :play-queue
Results: play the videos enqueued by the :queue option.
Command: :re="^Google Tricks"
Results: play videos matched by a regex.
Example: valid title: "Google Tricks & Easter eggs"
Command: :regex="Google.*part \\d+/\\d+"
Example: valid title: "The GOOGLE company (part 1/4)"
Command: :kregex=author,^google\$
Results: play only the videos uploaded by google.
Command: :kre=category,"^(?:People & Blogs|Entertainment)\$"
Results: play only the videos from the specified categories.
Command: :kre=views,"^(\\d+)\\z(?(?{ \$1 > 1000 })(?=)|(?!))"
Results: play only the videos which have more than 1000 of views.
Command: :anp 1 2 3
Results: play the first three videos from every page.
Command: :r, :return
Results: return to the previous section.
EXAMPLES
main_quit(0);
}
sub stdin_help {
print $complete_help;
main_quit(0);
}
# Print version
sub version {
print "YouTube Viewer $version\n";
main_quit(0);
}
sub apply_configuration {
my ($opt, $keywords) = @_;
if ($yv_obj->get_debug == 2
or (defined($opt->{debug}) && $opt->{debug} == 2)) {
require Data::Dump;
say "=>> Options with keywords: <@{$keywords}>";
Data::Dump::pp($opt);
}
# ... BASIC OPTIONS ... #
if (delete $opt->{quiet}) {
close STDERR;
}
if (delete $opt->{really_quiet}) {
close STDERR;
close STDOUT;
}
# ... YOUTUBE OPTIONS ... #
foreach my $option_name (
qw(
caption results duration
author orderby region category
categories_language safe_search
page debug time prefer_https http_proxy
)
) {
if (defined $opt->{$option_name}) {
my $code = \&{"WWW::YoutubeViewer::set_$option_name"};
my $value = delete $opt->{$option_name};
my $set_value = $yv_obj->$code($value);
if (not defined($set_value) or $set_value ne $value) {
warn "\n[!] Invalid value <$value> for option <$option_name>.\n";
}
}
}
if (defined $opt->{hd}) {
$yv_obj->set_hd(delete($opt->{hd}) ? 'true' : undef);
}
if (defined $opt->{more_results}) {
$yv_obj->set_results(delete($opt->{more_results}) ? 50 : $CONFIG{results});
}
if (delete $opt->{authenticate}) {
authenticate();
}
if (delete $opt->{logout}) {
logout();
}
# ... OTHER OPTIONS ... #
if (defined $opt->{shuffle_playlist}) {
require List::Util;
$opt{shuffle} = delete $opt->{shuffle_playlist};
}
if (defined $opt->{colors}) {
$opt{_colors} = $opt->{colors};
if (delete $opt->{colors}) {
require Term::ANSIColor;
*colored = \&Term::ANSIColor::colored;
}
else {
*colored = sub {
return $_[0];
};
}
}
# ... SUBROUTINE CALLS ... #
if (defined $opt->{subscribe_channel}) {
subscribe_to_channels(split(/[,\s]+/, delete $opt->{subscribe_channel}));
}
if (defined $opt->{favorite_video}) {
favorite_videos(split(/[,\s]+/, delete $opt->{favorite_video}));
}
if (defined $opt->{get_title}) {
get_and_print_video_title(split(/[,\s]+/, delete $opt->{get_title}));
}
if (defined $opt->{get_description}) {
get_and_print_video_description(split(/[,\s]+/, delete $opt->{get_description}));
}
if (defined $opt->{like_video}) {
rating_videos('like', split(/[,\s]+/, delete $opt->{like_video}));
}
if (defined $opt->{dislike_video}) {
rating_videos('dislike', split(/[,\s]+/, delete $opt->{like_video}));
}
if (defined $opt->{play_video_ids}) {
get_and_play_video_ids(split(/[,\s]+/, delete $opt->{play_video_ids}));
}
if (defined $opt->{play_playlists}) {
get_and_play_playlists(split(/[,\s]+/, delete $opt->{play_playlists}));
}
if (delete $opt->{disco}) {
if (defined(my $videos = $yv_obj->get_disco_videos($keywords))) {
print_videos($videos);
}
else {
warn_no_results("disco video");
}
}
if (defined $opt->{search_playlists}) {
my $value = delete($opt->{search_playlists});
if ($value =~ /$valid_playlist_id_re/ and not @{$keywords}) {
get_and_print_videos_from_playlist($value);
}
else {
print_playlists($yv_obj->search_for_playlists($value, @{$keywords}));
}
}
if (defined $opt->{course_id}) {
get_and_print_videos_from_course(delete $opt->{course_id});
}
if (defined $opt->{search_videos}) {
my $value = delete $opt->{search_videos};
print_videos($yv_obj->search($value, @{$keywords}));
}
if (defined $opt->{search_channels}) {
my $value = delete $opt->{search_channels};
print_channels($yv_obj->search_channels($value, @{$keywords}));
}
if (delete $opt->{channel_suggestions}) {
my $results = $yv_obj->get_channel_suggestions();
if (defined $results) {
print_channels($results, 'channel_suggestions');
}
}
if (delete $opt->{show_categories}) {
print_categories(categories => $yv_obj->get_categories());
}
if (delete $opt->{show_educategories}) {
print_categories(categories => $yv_obj->get_educategories(), edu => 1);
}
if (defined $opt->{user_videos}) {
if ($opt->{user_videos} =~ /$valid_username_re/) {
print_videos($yv_obj->get_videos_from_username(delete $opt->{user_videos}));
}
else {
warn_invalid("username", $opt->{user_videos});
}
}
if (defined $opt->{related_videos}) {
get_and_print_related_videos(split(/[,\s]+/, delete($opt->{related_videos})));
}
if (defined $opt->{user_playlists}) {
print_playlists($yv_obj->get_playlists_from_username(delete $opt->{user_playlists}));
}
if (defined $opt->{user_favorited_videos}) {
my $username = delete $opt->{user_favorited_videos};
if ($username =~ /$valid_username_re/) {
print_videos($yv_obj->get_favorited_videos_from_username($username));
}
else {
warn_invalid("username", $username);
print STDERR "\n";
}
}
if (defined $opt->{show_tops}) {
print_video_tops(time_id => (delete($opt->{show_tops}) =~ /^all/i ? 'all_time' : 'today'));
}
if (delete $opt->{show_movies}) {
print_movies();
}
foreach my $feed_name (@{WWW::YoutubeViewer::feed_methods}) {
if (defined $opt->{$feed_name}) {