NAME
    StreamFinder - Fetch actual raw streamable URLs from various
    radio-station websites.

INSTALLATION
            To install this module, run the following commands:

            perl Makefile.PL

            make

            make test

            make install

AUTHOR
    This module is Copyright (C) 2017-2019 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
            use strict;

            use StreamFinder;

            my $station = new StreamFinder(<url>);

            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 $stationTitle = $station->getTitle();
        
            print "Title=$stationTitle\n";
        
            my $stationID = $station->getID();

            print "Station ID=$stationID\n";
        
            my $icon_url = $station->getIconURL();

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

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

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

                            binmode IMGOUT;

                            print IMGOUT $icon_image;

                            close IMGOUT;

                    }

            }

            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 accepts a valid radio station URL on supported websites and
    returns the actual streamurl, title, and cover art icon for that
    station. 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 audio
    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 playing. The author uses his
    own custom all-purpose audio player called "fauxdacious" (his custom
    hacked version of the open-source "audacious" media player).
    "fauxdacious" incorporates this module to decode and play streams. The
    currently-supported websites are: radionomy.com, iheartradio.com,
    reciva.com, facebook, and youtube / vimeo / brighteon, et. al. We used
    to support tunein.com, but they have since apparently wasted a ton of
    money on web-developers and script kiddies to so fsck up their stations'
    pages to make it impossible to obtain their hidden streams
    programatically.

    It amazes me the effort to which marketing-run operations will go to and
    web-development money they'll spend to prevent people from accessing
    their radio streams in alternate ways, even though the content is
    already paid for by the advertisements already played in the streams.
    Guess they are that desparate to track your web-activity, store crap in
    cookies on your browser, and pummel you to death with evem more useless
    add garbage. Our mission is to restore your freedom to access commercial
    and other streaming radio stations that already paid for and freely
    available over the air in the ways most convenient to YOU, the listener!
    We are NOT in the business to provide a means of circumventing copyright
    laws, however!

    Each site is supported by a separate subpackage
    (StreamFinder::*Package*), which is determined and selected based on the
    url when the StreamFinder object is created. The methods are overloaded
    by the selected subpackage's methods.

    One or more playable streams can be returned for each station.

SUBROUTINES/METHODS
    new(*url*)
        Accepts a URL and creates and returns a new station object, or
        *undef* if the URL is not a valid station or no streams are found.

    $station->get()
        Returns an array of strings representing all stream urls found.

    $station->getURL()
        Similar to get() except it only returns a single stream representing
        the first valid stream found.

    $station->count()
        Returns the number of streams found for the station.

    $station->getStationID()
        Returns the station's ID.

    $station->getTitle()
        Returns the station's title (description).

    $station->getIconURL()
        Returns the url for the station's "cover art" icon image, if any.

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

    $station->getImageURL()
        Returns the url for the station's "cover art" banner image, if any.

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

DEPENDENCIES
    LWP::Simple

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

    You can also look for information at:

    *   RT: CPAN's request tracker (report bugs here)

        <http://rt.cpan.org/NoAuth/Bugs.html?Dist=StreamFinder>

    *   AnnoCPAN: Annotated CPAN documentation

        <http://annocpan.org/dist/StreamFinder>

    *   CPAN Ratings

        <http://cpanratings.perl.org/d/StreamFinder>

    *   Search CPAN

        <http://search.cpan.org/dist/StreamFinder/>

LICENSE AND COPYRIGHT
    Copyright 2017-2019 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.


