Switch branches/tags
Nothing to show
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
..
Failed to load latest commit information.
packages
PirateBoxRadio.zip
README.md
dependencies
icecast.xml
ices.xml
setup.sh

README.md

---BEGIN IMPORTANT---

This repo contains everything needed to get ices and icecast working on your TP-Link MR3020 or WR703N PirateBox, turning it into a PirateBoxRadio. You should consider this to be a pre-alpha, since I've just followed some tutorials for getting ices and icecast to work together and have basically no idea what they actually do. I haven't done any testing over prolonged time periods to see if it's stable enough to keep on running for hours on end. I have only tested with two connected clients so I don't know how many clients can connect and listen at the same time. As of now, only .ogg files is playable... that means NO MP3s!!! I might try and get MP3 working, but I have no plans for it at the moment. I support open formats and standards, so I want my PirateBox to stream music that is free in every way.

For those of you who don't feel all that comfortable on the command line or when manually editing configuration files, or you don't want to spend the time setting it all up manually, there's a simple script that will set it all up for you. Just download the archive (PirateBoxRadio.zip), extract it and place it on the USB-stick you use with your PirateBox. The archive file contains all the needed packages, a setup script, a folder for storing logs and configuration files for ices and icecast.

This tutorial is partly based on this wonderful Icecast tutorial: http://karellen.blogspot.no/2011/12/streaming-audio-server-with-icecast.html You'll find lots more details there if you want to figure out how to configure Icecast and ices yourself

---END IMPORTANT---

Using the setup script

Log in to your PirateBox and navigate to the PirateBoxRadio-folder. If you placed it directly on the USB-stick the following command should do the trick: cd /mnt/usb/PirateBoxRadio. Once there, execute the script with ./setup.sh wait for it to finish and then move on to "Add some tunes" near the bottom of this tutorial.

Getting started

First you need to install some packages. You can download them from this repo or directly from OpenWrt at http://downloads.openwrt.org/attitude_adjustment/12.09/ar71xx/generic/packages/ You'll need the following packages (not listing complete names, only what's needed to locate them with CTRL+F):

  • libshout
  • ices
  • libtheora
  • libspeex
  • alsa-lib
  • kmod-sound-core
  • kmod-input-core
  • icecast
  • libxslt
  • libcurl
  • libpolarssl
  • libvorbisidec
  • librt

The dependencies between the different packages are shown below

icecast
 |
  ----- libcurl
  ----- libxslt

ices
 |
  ----- libshout
 |       |
 |        ----- libspeex
 |        ----- libtheora
 |        ----- libvorbisidec
 |
  ----- alsa-lib
         |
          ----- kmod-sound-core
         |       |
         |        ----- kmod-input-core
         |
          ----- librt

Installing necessary packages

There's no way all this is going to fit on rootfs, but luckily we have access to external storage on the USB-drive. Assuming you've placed the packages in a folder "packages" Let's install them with opkg install -d ext packages/*

You'll probably get the following error messages at the end of the opkg-output, but just ignore it:

sed: 19-input-core: No such file or directory
sed: 30-sound-core: No such file or directory

Configuring icecast and ices

Now that we've got everything installed, we can start configuring it. But first, let's add a user and group for the icecast server since it refuses to run as root Execute the following two commands to add a user and group "icecast"

echo "icecast:x:200:" >> /etc/group
echo "icecast:*:200:200:icecast:/mnt/usb:/bin/ash" >> /etc/passwd

At this point you should take a look at the supplied ices.xml and icecast.xml config files. If you want to keep the default settings you don't need to do anything, but if you don't want to store the logs in /mnt/usb/PirateBoxRadio/log you need to change the log path in both files. Also, you might want to change the password for the icecast server, but that's up to you. The zip-file already contains a folder for the logs, but if you're not using the folder structure I've set up, or decide to store the logs somewhere else, remember to create the required folders with this command mkdir -p log/icecast. Otherwise, both icecast and ices will complain about missing folders.

In ices.xml, look for the following section:

    <input>
      <param name="type">basic</param>
      <param name="file">/mnt/usb/PirateBoxRadio/playlist1.txt</param>
      <param name="random">1</param>
      <param name="once">0</param>
      <param name="restart-after-reread">1</param>
    </input>

See where it says playlist? Guess what that line does. Correct! It tells ices where to find the playlist you want it to stream. You can place the playlist anywhere you want, it's just a textfile with a list of full paths to the music you want to stream. If you don't have a specific place you want it, just keep the default setting.

The rest of the file is basically just giving your pirate radio channel a name, description, genre etc. Nothing you need to change unless you absolutely want to.

Add some tunes

Now we're almost done! But we need to add some music! If you don't have any .ogg files at hand, you can download an awesome CC-licensed song which I've converted to .ogg here https://mega.co.nz/#!8skFTBRB!1ZB7himQzPXxnHs5MXtzVg4_UPir4COQXDQNhCCohUI Original can be found here http://www.jamendo.com/en/artist/352184/conway-hambone and license here https://creativecommons.org/licenses/by-sa/3./0

You can either choose to upload music to your PB via the network (that's what it's designed for y'know), or if you want to fill it with lots of music quickly, connect the USB-stick to your computer and place the files in /mnt/usb/PirateBox/Shared since you want to share it with the world. Now run the following command which will find all .ogg files and list their locations in playlist1.txt:

find /mnt/usb -name "*.ogg" > /mnt/usb/playlist1.txt

If you've decided to place your placelist somewhere else, or named it differently, adjust accordingly (the ices.xml file... remember?) Please note that if you only have one track in your playlist, ices will exit after finishing it with the default configuration. That's because it is configured to shuffle the playlist, and refuses to play the same track twice in a row. If you have two or more tracks, it will keep on playing them until you shut it down.

Let's stream some music!

Now you've got about 10 seconds left of work to do before you can listen to some sweet, sweet locally streamed music. Assuming you're in the folder where the configuration files are located we can now start icecast and ices with the following commands:

icecast -b -c icecast.xml
ices ices.xml

That's it! Now you can use e.g. VLC to open the network stream http://pirateboxip:8000/one.ogg (Please note that pirateboxip is, surprisingly enough, the IP-address of your PirateBox. Mine is 192.168.1.1, but yours might be different. one.ogg is the name of the radio station, you can change this in ices.xml)

Relax, lean back, and enjoy the melodies.

If more music is added to the Shared-folder, or wherever you choose to place the files, just run the find-command, mentioned in the previous section, again and your playlist will be updated with the new files.

Any problems, questions, complaints, interesting new profanities or anything else, drop me a PM on the forum.