/ 
StreamFinder-2.03
River stage one • 1 direct dependent • 2 total dependents
/ StreamFinder::Vimeo

NAME

StreamFinder::Vimeo - Fetch actual raw streamable URLs from Vimeo.com.

AUTHOR

This module is Copyright (C) 2017-2021 by

Jim Turner, <turnerjw784 at yahoo.com>

Email: turnerjw784@yahoo.com

All rights reserved.

You may distribute this module under the terms of either the GNU General Public License or the Artistic License, as specified in the Perl README file.

SYNOPSIS

#!/usr/bin/perl

use strict;

use StreamFinder::Vimeo;

die "..usage:  $0 ID|URL\n"  unless ($ARGV[0]);

my $video = new StreamFinder::Vimeo($ARGV[0]);

die "Invalid URL or no streams found!\n"  unless ($video);

my $firstStream = $video->get();

print "First Stream URL=$firstStream\n";

my $url = $video->getURL();

print "Stream URL=$url\n";

my $videoTitle = $video->getTitle();

print "Title=$videoTitle\n";

my $videoDescription = $video->getTitle('desc');

print "Description=$videoDescription\n";

my $videoID = $video->getID();

print "Video ID=$videoID\n";

my $artist = $video->{'artist'};

print "Artist=$artist\n"  if ($artist);

my $albumartist = $video->{'albumartist'};

print "Album Artist=$albumartist\n"  if ($albumartist);

my $icon_url = $video->getIconURL();

if ($icon_url) {   #SAVE THE ICON TO A TEMP. FILE:

	my ($image_ext, $icon_image) = $video->getIconData();

	if ($icon_image && open IMGOUT, ">/tmp/${videoID}.$image_ext") {

		binmode IMGOUT;

		print IMGOUT $icon_image;

		close IMGOUT;

	}

}

my $stream_count = $video->count();

print "--Stream count=$stream_count=\n";

my @streams = $video->get();

foreach my $s (@streams) {

	print "------ stream URL=$s=\n";

}

DESCRIPTION

StreamFinder::Vimeo accepts a valid full Vimeo video ID or URL on vimeo.com and returns the actual stream URL, title, and cover art icon for that video. The purpose is that one needs this URL in order to have he option to stream the video in one's own choice of media player software rather than using their web browser and accepting any / all flash, ads, javascript, cookies, trackers, web-bugs, and other crapware that can come with that method of play. The author uses his own custom all-purpose media player called "fauxdacious" (his custom hacked version of the open-source "audacious" audio player). "fauxdacious" incorporates this module to decode and play vimeo.com videos. This is a submodule of the general StreamFinder module.

Depends:

URI::Escape, HTML::Entities, LWP::UserAgent

SUBROUTINES/METHODS

new(ID|url [, -debug [ => 0|1|2 ]] [, "-quality" => quality] [, -secure [ => 0|1 ]])

Accepts a vimeo.com ID or URL and creates and returns a new video object, or undef if the URL is not a valid Vimeo video or no streams are found. The URL can be the full URL, ie. https://player.vimeo.com/video/video-id, or just video-id.

The optional -quality argument, which can be set to a "p number" optionally preceeded by a relational operator ("<", ">", "=") - default: "<". This limits the video quality.. For example: "720" would mean select a stream "<= 720p", ">720" would mean ">= 720p", and "=1080" would mean "only "1080p". See also the "vimeo_quality" config. file option that does the same thing. Default is just use the best quality found.

The optional -secure argument can be either 0 or 1 (false or true). If 1 then only secure ("https://") streams will be returned.

DEFAULT -secure is 0 (false) - return all streams (http and https).

Additional options:

Certain youtube-dl (StreamFinder::Youtube) configuration options, namely format, formatonly, youtube-dl-args, and youtube-dl-add-args can be overridden here by specifying youtube-format, youtube-formatonly, youtube-dl-args, and youtube-dl-add-args arguments respectively. It is however, recommended to specify these in the Vimeo-specific configuration file (see CONFIGURATION FILES below. NOTE: These are only applicable when no streams are found the normal way and the user has youtube-dl or a compatable program, such as yt-dlp installed.

-log => "logfile"

Specify path to a log file. If a valid and writable file is specified, A line will be appended to this file every time one or more streams is successfully fetched for a url.

DEFAULT -none- (no logging).

-logfmt specifies a format string for lines written to the log file.

DEFAULT "[time] [url] - [site]: [title] ([total])".

The valid field [variables] are: [stream]: The url of the first/best stream found. [site]: The site name (Vimeo). [url]: The url searched for streams. [time]: Perl timestamp when the line was logged. [title], [artist], [album], [description], [year], [genre], [total], [albumartist]: The corresponding field data returned (or "-na-", if no value).

$video->get()

Returns an array of strings representing all stream URLs found.

$video->getURL([options])

Similar to get() except it only returns a single stream representing the first valid stream found.

Current options are: "random", "nopls", and "noplaylists". By default, the first ("best"?) stream is returned. If "random" is specified, then a random one is selected from the list of streams found. If "nopls" is specified, and the stream to be returned is a ".pls" playlist, it is first fetched and the first entry (or a random entry if "random" is specified) is returned. This is needed by Fauxdacious Mediaplayer. If "noplaylists" is specified, and the stream to be returned is a "playlist" (either .pls or .m3u? extension), it is first fetched and the first entry (or a random entry if "random" is specified) in the playlist is returned.

$video->count()

Returns the number of streams found for the video.

$video->getID()

Returns the video's Vimeo ID (numeric).

$video->getTitle(['desc'])

Returns the video's title, or (long description).

$video->getIconURL(['artist'])

Returns the URL for the video's "cover art" icon image, if any. If 'artist' is specified, the channel artist's icon url is returned, if any.

$video->getIconData(['artist'])

Returns a two-element array consisting of the extension (ie. "png", "gif", "jpeg", etc.) and the actual icon image (binary data), if any. If 'artist' is specified, the channel artist's icon data is returned, if any.

$video->getImageURL()

Returns the URL for the video's "cover art" (usually larger) banner image.

$video->getImageData()

Returns a two-element array consisting of the extension (ie. "png", "gif", "jpeg", etc.) and the actual video's banner image (binary data).

$video->getType()

Returns the video's type ("Vimeo").

CONFIGURATION FILES

The default root location directory for StreamFinder configuration files is "~/.config/StreamFinder". To use an alternate location directory, specify it in the "STREAMFINDER" environment variable, ie.: $ENV{STREAMFINDER} = "/etc/StreamFinder".

~/.config/StreamFinder/Vimeo/config

Optional text file for specifying various configuration options for a specific site (submodule). Each option is specified on a separate line in the format below: NOTE: Do not follow the lines with a semicolon, comma, or any other separator. Non-numeric values should be surrounded with quotes, either single or double. Blank lines and lines beginning with a "#" sign as their first non-blank character are ignored as comments.

'option' => 'value' [,]

and the options are loaded into a hash used only by the specific (submodule) specified. Valid options include -debug => [0|1|2] and most of the LWP::UserAgent options.

Options specified here override any specified in ~/.config/StreamFinder/config.

Among options valid for Vimeo videos are the -vimeo_quality option, which can be set to a "p" number optionally preceeded by a relational operator ("<", ">", "=") - default: "<". This limits the video quality.. For example: "720" would mean select a stream "<= 720p", ">720" would mean ">= 720p", and "=1080" would mean "only "1080p". This can be overridden with the -quality argument to the new() function. Also, various youtube-dl (StreamFinder::Youtube) configuration options, namely format, formatonly, youtube-dl-args, and youtube-dl-add-args can be overridden here by specifying youtube-format, youtube-formatonly, youtube-dl-args, and youtube-dl-add-args arguments respectively. NOTE: These are only applicable when no streams are found the normal way and the user has youtube-dl or a compatable program, such as yt-dlp installed.

~/.config/StreamFinder/config

Optional text file for specifying various configuration options. Each option is specified on a separate line in the format below:

'option' => 'value' [,]

and the options are loaded into a hash used by all sites (submodules) that support them. Valid options include -debug => [0|1|2] and most of the LWP::UserAgent options.

NOTE: Options specified in the options parameter list of the new() function will override those corresponding options specified in these files.

KEYWORDS

vimeo

DEPENDENCIES

URI::Escape, HTML::Entities, LWP::UserAgent

RECCOMENDS

youtube-dl (or yt-dlp, or other compatable program)

wget

BUGS

Please report any bugs or feature requests to bug-streamFinder-vimeo at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=StreamFinder-Vimeo. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc StreamFinder::Vimeo

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright 2017-2021 Jim Turner.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.