The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
StreamFinder-2.23
River stage one • 1 direct dependent • 2 total dependents
6 ++
/ StreamFinder::Apple

NAME

StreamFinder::Apple - Fetch actual raw streamable URLs from Apple podcasts on podcasts.apple.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::Apple;

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

        my $podcast = new StreamFinder::Apple($ARGV[0]);

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

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

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

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

        print "Stream URL=$url\n";

        my $podcastTitle = $podcast->getTitle();
        
        print "Title=$podcastTitle\n";
        
        my $podcastDescription = $podcast->getTitle('desc');
        
        print "Description=$podcastDescription\n";
        
        my $podcastID = $podcast->getID();

        print "PODCAST ID=$podcastID\n";
        
        my $artist = $podcast->{'artist'};

        print "Artist=$artist\n"  if ($artist);
        
        my $genre = $podcast->{'genre'};

        print "Genre=$genre\n"  if ($genre);
        
        my $icon_url = $podcast->getIconURL();

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

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

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

                        binmode IMGOUT;

                        print IMGOUT $icon_image;

                        close IMGOUT;

                }

        }

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

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

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

        foreach my $s (@streams) {

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

        }

DESCRIPTION

StreamFinder::Apple accepts a valid podcast or episode URL on podcasts.apple.com, and returns the actual stream URL(s), title, and cover art icon for that podcast. 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" incorporates this module to decode and play podcasts.apple.com streams.

NOTE: The URL must be either a podcast site, format: https://podcasts.apple.com/country/podcast/idpodcast# (returns stream(s) for all "episodes" for that site, OR a specific podcast / "episode" page site, format: https://podcasts.apple.com/country/podcast/idpodcast#?i=episode# (returns a single stream for that specific podcast).

SUBROUTINES/METHODS

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

Accepts a podcasts.apple.com ID or URL and creates and returns a new podcast object, or undef if the URL is not a valid podcast, album, etc. or no streams are found. The URL can be the full URL, ie. https://podcasts.apple.com/podcast/idpodcast-id, https://podcasts.apple.com/podcast/idpodcast-id?i=episode-id, or just podcast-id, or podcast-id/episode-id.

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:

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

$podcast->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). NOTE: If an author / channel page url is given, rather than an individual podcast episode's url, get() returns the first (latest?) podcast episode found, and get("playlist") returns an extended m3u playlist containing the urls, titles, etc. for all the podcast episodes found on that page url.

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

$podcast->count(['playlist'])

Returns the number of streams found for the podcast. If "playlist" is specified, the number of episodes returned in the playlist is returned (the playlist can have more than one item if a podcast page URL is specified).

$podcast->getID()

Returns the station's Apple ID (numeric). For podcasts and albums, this is a single numeric value. For episodes and songs, it's two numbers separated by a slash ("/").

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

Returns the podcast's, album's, episode's or song clip's title, or (long description).

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

Returns the url for the podcast's / album's "cover art" icon image, if any. If 'artist' is specified, the channel artist's icon url is returned, if any. Note: This requires StreamFinder::Apple to also fetch the channel artist's (AlbumArtist) url as this icon is currently not included on the podcast's page.

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

$podcast->getImageURL()

Returns the url for the podcast's / album's "cover art" banner image, which for Apple is always the icon image, as Apple does not support a separate banner image at this time.

$podcast->getImageData()

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

$podcast->getType()

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

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/Apple/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. Blank lines and lines starting with a "#" sign are ignored.

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

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

apple podcasts

DEPENDENCIES

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

RECCOMENDS

wget

BUGS

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

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.