aboutsummaryrefslogtreecommitdiff
path: root/mp3cast~/README
blob: 7247f818cf24ac758d0594710579e7a4595f3a08 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
Version 0.01 
copyright (c) 2001 by Olaf Matthes
ported to Linux by Yves Degoyon

mp3cast~.dll is a MPEG I Layer III (mp3) streaming external for pd (by Miller 
Puckette) that connects to a SHOUTcast or IceCast server.

To install mp3cast~, follow the steps from INSTALL

This software is published under GPL terms.

This is software with ABSOLUTELY NO WARRANTY.
Use it at your OWN RISK. It's possible to damage e.g. hardware or your hearing
due to a bug or for other reasons. 
We do not warrant that the program is free of infringement of any third-party
patents.

*****************************************************************************

mp3cast~ has been compiled for Linux using LAME 3.92.
The newest version of LAME can be found at sourceforge.net

COPYING: you may use this source under GPL terms!

PLEASE NOTE: This software may contain patented alogrithm (at least
  patented in some countries). It may be not allowed to sell/use products
  based on this source code in these countries. Check this out first!

COPYRIGHT of MP3 music:
  Please note, that the duplicating of copyrighted music without explicit
  permission violates the rights of the owner.

*****************************************************************************

	using mp3cast~ external for Pure Data

Open the help-mp3cast~.pd to understand how it works.
In this patch, you must send the messages to mp3cast~ 
in the following order :

1/ password ***** 
2/ icecast | mp3cast
3/ connect host port
4/ pd dsp 1

Parameters sent to mp3cast~ object :

  Sampling Rate (Hz): 
Possible values are 48000, 44100 and 32000. If Pd runs at a different sampling 
rate, LAME will resample the signal. Default value for mp3 sampling rate is Pd's 
sampling rate.

  Bitrate (kbit/s): 
Possible values are 32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256 
and 320. Default is 224.

  Mode: 
Possible values are 0 (stereo), 1 (joint stereo, the default), 2 (dual channel) 
and 3 (mono).

  Password:
The default is 'pd', can be changed with a message "passwd yourpassword".

  Server:
Use message "connect name_of_your_server.com port" to connect (same as with 
Pd's netsend). 'port' is the number specified in the server's config file. 
Attention (for SHOUTcast users): The actual port number used is one higher! 
Standard would be 8000 resulting in a socket at port 8001!!! Bare this in mind 
when configuring proxys or using mp3cast~ in connection with netsend / 
netreceive. For IceCast, the port number used is the same as specified.

  Outlet:
The outlet outputs an int, 1 if connected to SHOUTcast server, 0 if not. This could 
be used to build an automatic reconnect mechanism.

  Other things:
mp3cast~ prints the current status (connection, login, LAME status) to the pd 
window. To see the current settings, send it a message "print" and mp3 settings 
will be displayed.
Note that changing any mp3 settings will require to disconnect and reconnect again!
This has to be done manually. 

  Known problems:
If you turn off audio processing when you are connected with the server, no data will 
be sent to it. This will make the server disconnect after a certain time ('no data' 
error in server log). mp3cast~ does not recongnise this and attempts to keep on
streaming. To avoid this set 'AutoDumpSourceTime' in the servers config file to a 
fairly high value preventing the server from closing the socket to fast.

ALLOWED QUALITY FACTOR :

    -q <arg>        <arg> = 0...9.  Default  -q 5 
                    -q 0:  Highest quality, very slow 
                    -q 9:  Poor quality, but fast 
    -h              Same as -q 2.   Recommended.
    -f              Same as -q 7.   Fast, ok quality

ALLOWED SAMPLERATE/BITRATES

MPEG-1   layer III sample frequencies (kHz):  32  48  44.1
bitrates (kbps): 32 40 48 56 64 80 96 112 128 160 192 224 256 320

MPEG-2   layer III sample frequencies (kHz):  16  24  22.05
bitrates (kbps):  8 16 24 32 40 48 56 64 80 96 112 128 144 160

MPEG-2.5 layer III sample frequencies (kHz):   8  12  11.025
bitrates (kbps):  8 16 24 32 40 48 56 64 80 96 112 128 144 160