/ 
StreamFinder-2.41
River stage one • 1 direct dependent • 2 total dependents
/ StreamFinder::Anystream

NAME

StreamFinder::Anystream - Fetch any raw streamable URLs from an HTML page.

AUTHOR

This module is Copyright (C) 2017-2023 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::Anystream;

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

my $station = new StreamFinder::Anystream($ARGV[0]);

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

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

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

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

print "Stream URL=$url\n";

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

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

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

foreach my $s (@streams) {

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

}

DESCRIPTION

StreamFinder::Anystream accepts any valid html URL and returns any actual stream URL(s) found. StreamFinder::Anystream is intended mainly as a "last resort" search of webpages that do not match any of the supported websites handled (better) by the other site-specific StreamFinder modules. The purpose is that one needs one of these URLs in order to have the option to stream the station 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" can incorporate this module to decode and play streams. NOTE: It is recommended to use the main StreamFinder module or one of the other StreamFinder submodules for searching supported sites, as this module does not return "station" (website)-specific or stream-specific metadata as those modules can and do for their supported sites! The main StreamFinder module will first try to use the proper matching submodule supporting the website (if one exists) before trying this one last.

One or more streams can be returned.

SUBROUTINES/METHODS

new(ID|url [, -keep => "type1,type2?..." | [type1,type2?...] ] [, -maxstreams [ => # ]] [, -secure [ => 0|1 ]] [, -debug [ => 0|1|2 ]])

Accepts an HTML URL (webpage) and creates and returns a new station object, or undef if the URL contains any valid stream URLs (matching the list of default extensions). The URL must be the full URL.

The optional -keep argument can be either a comma-separated string or an array reference ([...]) of stream types (extensions) to keep (include) and returned in order specified (type1, type2...). Each "type" (extension) can be one of: "mp3", "m4a", "mp4", "pls" (playlist), etc. NOTE: Since these are actual extensions used to identify streams, there is NO "any/all/stream/playlist" catch-all options as used by some of the other (more specific) StreamFinder-supported sites! Streams will be returned sorted by extension in the order specified in this list.

DEFAULT -keep list is: "mp3,ogg,flac,mp4,m4a,mpd,aac,m3u8,m3u,pls", meaning that all mp3 streams found (if any), followed by all "ogg" streams, etc.

The optional -maxstreams argument specifies the maximum number of streams to consider (some sites have tons of them).

DEFAULT -secure is 20 - return up to the first 20 streams found. The optional -secure argument can be either 0 or 1 (false or true). If 1 then only secure ("https://") streams will be returned. NOTE: If -secure is specified, the number returned could be less as both secure and unsecure streams are counted against the total as they are found.

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

Additional options:

-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 (Anystream). [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).

$station->get(['playlist'])

Returns an array of strings representing all stream URLs found. If "playlist" is specified, then an extended m3u playlist is returned instead of stream url(s).

$station->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.

$station->count()

Returns the number of streams found for the station.

$station->getID()

Returns the station's ID (alphanumeric). NOTE: Since this module only looks for any streams found on any specifed website, this function always returns the base name of the website being searched, plus the first word (subdirectory name) following it (if any).

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

Returns the station's title, or (long description). NOTE: Since this module only looks for any streams found on any specifed website, this function usually returns the base name of the website being searched, or the full URL passed in, unless an html <TITLE> tag is found, in which case that will be returned. If 'desc' is specified, then it will usually be full URL of the website being searched, unless a standard "description" HTML metatag is found, in which case that will be returned.

$station->getIconURL()

Returns the URL for the station's "cover art" icon image, if any. NOTE: For most websites, this will return an empty string, however, a few have an image link contained in a standard HTML meta-tag which, if found, will be returned.

$station->getIconData()

Returns a two-element array consisting of the extension (ie. "png", "gif", "jpeg", etc.) and the actual icon image (binary data), if any. NOTE: For most websites, this will return an empty string, however, a few have an image link contained in a standard HTML meta-tag which, if found, will be fetched and returned as image data.

$station->getImageURL()

Returns the URL for the station's "cover art" (usually larger) banner image. NOTE: Since this module only looks for any streams found on any specifed website, this function always returns an empty string!

$station->getImageData()

Returns a two-element array consisting of the extension (ie. "png", "gif", "jpeg", etc.) and the actual station's banner image (binary data). NOTE: Since this module only looks for any streams found on any specifed website, this function always returns an empty array!

$station->getType()

Returns the station's type ("Anystream").

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/Anystream/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 Anystream streams is the -keep option previously described in the new() function.

~/.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

Anystream

DEPENDENCIES

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

RECCOMENDS

wget

BUGS

Please report any bugs or feature requests to bug-streamFinder-Anystream at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=StreamFinder-Anystream. 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::Anystream

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright 2017-2023 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.