Internet radio browser GUI for music/video streams from various directory services.

⌈⌋ ⎇ branch:  streamtuner2


Diff

Differences From Artifact [b136303bf1]:

To Artifact [693e44deeb]:

  • File action.py — part of check-in [ea628d6426] at 2015-04-08 17:59:53 on branch trunk — Remove extraneous class wrapper action.action. Start to regroup listformat mapping (pls-url → m3u-fn rewrites). Will need some heuristics, as depending just on the channel.listformat assumption won't work in practice (some .pls servers actually host direct server links, or occasionally .m3u references even). Currently does nothing, just returns the pls/etc URL. (user: mario, size: 8949) [annotate] [blame] [check-ins using]

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


109
110
111
112
113
114

115
116


117
118
119










120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301






302
303
304

305
306

307
#
# Each channel plugin has a .listtype which describes the linked
# audio playlist format. It's audio/x-scpls mostly, seldomly m3u,
# but sometimes url/direct if the entry[url] directly leads to the
# streaming server.
#
# As fallback there is a regex which just looks for URLs in the
# given resource (works for m3u/pls/xspf/asx/...). There is no
# actual url "filename" extension guessing.


import re
import os
import ahttp as http
from config import conf, __print__, dbg
import platform


# coupling to main window

main = None


#-- media actions
#
# implements "play" and "record" methods,
# but also "browser" for web URLs
#        
class action:

    # streamlink map
    lt = dict(
       asx = "video/x-ms-asf",
       pls = "audio/x-scpls",
       m3u = "audio/x-mpegurl",

       xspf = "application/xspf+xml",
       href = "url/http",
       src = "url/direct",
       ram = "audio/x-pn-realaudio",
       smil = "application/smil",





















    )
    # media map
    mf = dict(
       mp3 = "audio/mpeg",

       ogg = "audio/ogg",
       aac = "audio/aac",


    )
    

    
    # web
    @staticmethod
    def browser(url):
        bin = conf.play.get("url/http", "sensible-browser")
        __print__( dbg.CONF, bin )
        action.run(bin + " " + action.quote(url))



        
    # os shell cmd escaping

    @staticmethod
    def quote(s):



        if conf.windows:


            return str(s)   # should actually be "\\\"%s\\\"" % s
        else:






            return "%r" % str(s)




    # calls player for stream url and format
    @staticmethod
    def play(url, audioformat="audio/mpeg", listformat="text/x-href"):



        if (url):
            url = action.url(url, listformat)
        if audioformat == "audio/mp3":
            audioformat = "audio/mpeg"

        cmd = action.mime_match(audioformat, conf.play)
        try:


            __print__( dbg.PROC, "play", url, cmd )

            action.run( action.interpol(cmd, url) )

        except:
            pass





    

    # exec wrapper
    @staticmethod
    def run(cmd):
        if conf.windows:
            os.system("start \"%s\"")
        else:

            os.system(cmd + " &")












    # streamripper
    @staticmethod
    def record(url, audioformat="audio/mpeg", listformat="text/x-href", append="", row={}):
        __print__( dbg.PROC, "record", url )
        cmd = action.mime_match(audioformat, conf.record)
        try: action.run( action.interpol(cmd, url, row) + append )
        except: pass




    # Convert MIME type into list of ["audio/xyz", "audio/*", "*/*"] for comparison against record/play association
    @staticmethod
    def mime_match(fmt, cmd_list):
        for match in [ fmt, fmt[:fmt.find("/")] + "/*", "*/*" ]:
            if cmd_list.get(match, None):

                return cmd_list[match]




    # save as .m3u
    @staticmethod










    def save(row, fn, listformat="audio/x-scpls"):

        # output format
        format = re.findall("\.(m3u|pls|xspf|jspf|json|asx|smil)", fn)

        # modify stream url
        row["url"] = action.url(row["url"], listformat)
        stream_urls = action.extract_urls(row["url"], listformat)

        # M3U
        if "m3u" in format:
            txt = "#M3U\n"
            for url in stream_urls:
                txt += http.fix_url(url) + "\n"

        # PLS
        elif "pls" in format:
            txt = "[playlist]\n" + "numberofentries=1\n"
            for i,u in enumerate(stream_urls):
                i = str(i + 1)
                txt += "File"+i + "=" + u + "\n"
                txt += "Title"+i + "=" + row["title"] + "\n"
                txt += "Length"+i + "=-1\n"
            txt += "Version=2\n"

        # XSPF
        elif "xspf" in format:
            txt = '<?xml version="1.0" encoding="UTF-8"?>' + "\n"
            txt += '<?http header="Content-Type: application/xspf+xml" ?>' + "\n"
            txt += '<playlist version="1" xmlns="http://xspf.org/ns/0/">' + "\n"
            for attr,tag in [("title","title"), ("homepage","info"), ("playing","annotation"), ("description","annotation")]:
                if row.get(attr):
                    txt += "  <"+tag+">" + xmlentities(row[attr]) + "</"+tag+">\n"
            txt += "  <trackList>\n"
            for u in stream_urls:
                txt += '	<track><location>' + xmlentities(u) + '</location></track>' + "\n"
            txt += "  </trackList>\n</playlist>\n"

        # JSPF
        elif "jspf" in format:
            pass

        # JSON
        elif "json" in format:
            row["stream_urls"] = stream_urls
            txt = str(row)   # pseudo-json (python format)
        
        # ASX
        elif "asx" in format:
            txt = "<ASX version=\"3.0\">\n"			\
                + " <Title>" + xmlentities(row["title"]) + "</Title>\n"	\
                + " <Entry>\n"				\
                + "  <Title>" + xmlentities(row["title"]) + "</Title>\n"	\
                + "  <MoreInfo href=\"" + row["homepage"] + "\"/>\n"	\
                + "  <Ref href=\"" + stream_urls[0] + "\"/>\n"		\
                + " </Entry>\n</ASX>\n"

        # SMIL
        elif "smil" in format:
                txt = "<smil>\n<head>\n  <meta name=\"title\" content=\"" + xmlentities(row["title"]) + "\"/>\n</head>\n"	\
                    + "<body>\n  <seq>\n    <audio src=\"" + stream_urls[0] + "\"/>\n  </seq>\n</body>\n</smil>\n"

        # unknown
        else:
            return

        # write
        if txt:
            f = open(fn, "wb")
            f.write(txt)
            f.close()
        pass


    # replaces instances of %u, %l, %pls with urls / %g, %f, %s, %m, %m3u or local filenames
    @staticmethod
    def interpol(cmd, url, row={}):
        # inject other meta fields
        if row:
            for field in row:
                cmd = cmd.replace("%"+field, "%r" % row.get(field))
        # add default if cmd has no %url placeholder
        if cmd.find("%") < 0:
            cmd = cmd + " %m3u"
        # standard placeholders
        if (re.search("%(url|pls|[ulr])", cmd)):
            cmd = re.sub("%(url|pls|[ulr])", action.quote(url), cmd)
        if (re.search("%(m3u|[fgm])", cmd)):
            cmd = re.sub("%(m3u|[fgm])", action.quote(action.m3u(url)), cmd)
        if (re.search("%(srv|[ds])", cmd)):
            cmd = re.sub("%(srv|[ds])", action.quote(action.srv(url)), cmd)
        return cmd


    # eventually transforms internal URN/IRI to URL
    @staticmethod
    def url(url, listformat):
        if (listformat == "audio/x-scpls"):
            url = url
        elif (listformat == "text/x-urn-streamtuner2-script"):
            url = main.special.stream_url(url)
        else:
            url = url
        return url

        
    # download a .pls resource and extract urls
    @staticmethod
    def pls(url):
        text = http.get(url)
        __print__( dbg.DATA, "pls_text=", text )
        return re.findall("\s*File\d*\s*=\s*(\w+://[^\s]+)", text, re.I)
        # currently misses out on the titles            
        
    # get a single direct ICY stream url (extract either from PLS or M3U)
    @staticmethod
    def srv(url):
        return action.extract_urls(url)[0]


    # retrieve real stream urls from .pls or .m3u links
    @staticmethod
    def extract_urls(pls, listformat="__not_used_yet__"):
        # extract stream address from .pls URL
        if (re.search("\.pls", pls)):       #audio/x-scpls
            return action.pls(pls)
        elif (re.search("\.asx", pls)):	#video/x-ms-asf
            return re.findall("<Ref\s+href=\"(http://.+?)\"", http.get(pls))
        elif (re.search("\.m3u|\.ram|\.smil", pls)):	#audio/x-mpegurl
            return re.findall("(http://[^\s]+)", http.get(pls), re.I)
        else:  # just assume it was a direct mpeg/ogg streamserver link
            return [ (pls if pls.startswith("/") else http.fix_url(pls)) ]
        pass


    # generate filename for temporary .m3u, if possible with unique id
    @staticmethod
    def tmp_fn(pls):
        # use shoutcast unique stream id if available
        stream_id = re.search("http://.+?/.*?(\d+)", pls, re.M)
        stream_id = stream_id and stream_id.group(1) or "XXXXXX"
        try:
            channelname = main.current_channel
        except:
            channelname = "unknown"
        return (str(conf.tmp) + os.sep + "streamtuner2."+channelname+"."+stream_id+".m3u", len(stream_id) > 3 and stream_id != "XXXXXX")
    
    # check if there are any urls in a given file
    @staticmethod
    def has_urls(tmp_fn):
        if os.path.exists(tmp_fn):
            return open(tmp_fn, "r").read().find("http://") > 0
        
    
    # create a local .m3u file from it
    @staticmethod
    def m3u(pls):
    
        # temp filename
        (tmp_fn, unique) = action.tmp_fn(pls)
        # does it already exist?
        if tmp_fn and unique and conf.reuse_m3u and action.has_urls(tmp_fn):
            return tmp_fn

        # download PLS
        __print__( dbg.DATA, "pls=",pls )
        url_list = action.extract_urls(pls)
        __print__( dbg.DATA, "urls=", url_list )

        # output URL list to temporary .m3u file
        if (len(url_list)):
            #tmp_fn = 
            f = open(tmp_fn, "w")
            f.write("#M3U\n")
            f.write("\n".join(url_list) + "\n")
            f.close()
            # return path/name of temporary file
            return tmp_fn
        else:
            __print__( dbg.ERR, "error, there were no URLs in ", pls )
            raise "Empty PLS"








    # open help browser                
    @staticmethod

    def help(*args):
        action.run("yelp /usr/share/doc/streamtuner2/help/")









|
<




|
|



|
>



<
|
|
<
|
<
<
<
|
<
|
|
>
|
|
|
|
|
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
|
|
<
|
>
|
|
>
>
|
|
>
|
<
<
|
|
<
|


>
|
|
>
|
|
>
>
>
|
>
>
|
|
>
>
>
>
>
>
|

>
|
>
|
|
|
>
>
>
|
|
|
|
>
|
|
>
>
|
>
|
>
|
|

>
>
>
>
|
>
|
|
|
<
<
|
>
|
>
>
>

>
>
>
>
>
>
>

<
|
|
<
<
<
<

>
>
|
<
<
|
|
|
>
|

>
>

|
|
>
>
>
>
>
>
>
>
>
>
|

|
|

|
<
|

|
|
|
|
|

|
|
|
|
|
|
|
|
|

|
|
|
|
|
|
|
|
|
|
|
|

|
|
|

|
|
|
|
|
|
|
|
|
|
|
|
|
|

|
|
|
|

|
|
|

|
|
|
|
|
|


<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<


<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
|
<
|
|
|
|
|
|
|
|
|
|
|


|
<
|
|
|
|
|
|
|
|
|
|
|
<
|
|
|
|
|
|
<
|
|
|
|
|
|
|

|
|
|
|

|
|
|
|
|
|
|
|
|
|
|
|

>
>
>
>
>
>

|
<
>
|
<
>

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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138


139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

154
155




156
157
158
159


160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186

187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253


















254
255


























256

257
258
259
260
261
262
263
264
265
266
267
268
269
270

271
272
273
274
275
276
277
278
279
280
281

282
283
284
285
286
287

288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321

322
323

324
325
#
# Each channel plugin has a .listtype which describes the linked
# audio playlist format. It's audio/x-scpls mostly, seldomly m3u,
# but sometimes url/direct if the entry[url] directly leads to the
# streaming server.
#
# As fallback there is a regex which just looks for URLs in the
# given resource (works for m3u/pls/xspf/asx/...).



import re
import os
from ahttp import fix_url as http_fix_url, get as http_get
from config import conf, __print__ as debug, dbg
import platform


# Coupling to main window
#
main = None




# Streamlink/listformat mapping

#



lt = dict(

    pls = "audio/x-scpls",
    m3u = "audio/x-mpegurl",
    asx = "video/x-ms-asf",
    xspf = "application/xspf+xml",
    href = "url/http",
    srv = "url/direct",
    ram = "audio/x-pn-realaudio",
    smil = "application/smil",
    script = "text/x-urn-streamtuner2-script", # unused
)


# Audio type MIME map
#
mf = dict(
    mp3 = "audio/mpeg",
    ogg = "audio/ogg",
    aac = "audio/aac",
    midi = "audio/midi",
    mod = "audio/mod",
)

# Player command placeholders for playlist formats
placeholder_map = dict(
    pls = "%url | %pls | %u | %l | %r",
    m3u = "%m3u | %f | %g | %m",
    pls = "%srv | %d | %s",
)




# Exec wrapper
#
def run(cmd):
    if cmd: debug(dbg.PROC, "Exec:", cmd)
    try:    os.system("start \"%s\"" % cmd if conf.windows else cmd + " &")
    except: debug(dbg.ERR, "Command not found:", cmd)


# Start web browser
#


def browser(url):
    bin = conf.play.get("url/http", "sensible-browser")

    run(bin + " " + quote(url))


# Open help browser, streamtuner2 pages
#
def help(*args):
    run("yelp /usr/share/doc/streamtuner2/help/")


# Calls player for stream url and format
#
def play(url, audioformat="audio/mpeg", listformat="href"):
    cmd = mime_app(audioformat, conf.play)
    cmd = interpol(cmd, url, listformat)
    run(cmd)


# Call streamripper
#
def record(url, audioformat="audio/mpeg", listformat="href", append="", row={}):
    cmd = mime_app(audioformat, conf.record)
    cmd = interpol(cmd, url, listformat, row)
    run(cmd)


# OS shell command escaping
#
def quote(s):
    return "%r" % str(s)


# Convert e.g. "text/x-scpls" MIME types to just "pls" monikers
#
def listfmt(t = "pls"):
    if t in lf.values():
       for short,mime in lf.items():
           if mime == t:
               return short
    return t # "pls"


# Convert MIME type into list of ["audio/xyz", "audio/*", "*/*"]
# for comparison against configured record/play association.
def mime_app(fmt, cmd_list):
    for match in [ fmt, fmt[:fmt.find("/")] + "/*", "*/*" ]:
        if cmd_list.get(match):
            return cmd_list[match]



# Replaces instances of %m3u, %pls, %srv in a command string.
#  · Also understands short aliases %l, %f, %d.
#  · And can embed %title or %genre placeholders.
#  · Replace .pls URL with local .m3u file depending on map.
#
def interpol(cmd, url, source="pls", row={}):

    # inject other meta fields
    if row:


        for field in row:
            cmd = cmd.replace("%"+field, "%r" % row.get(field))

    # add default if cmd has no %url placeholder
    if cmd.find("%") < 0:
        cmd = cmd + " %m3u"

    # standard placeholders
    for dest, rx in placeholder_map.items():
        if re.search(rx, cmd, re.X):
            # from .pls to .m3u
            url = convert_playlist(url, listfmt(source), listfmt(dest))
            # insert quoted URL/filepath
            return re.sub(rx, cmd, quote(url), 2, re.X)


    return "false"






# Substitute .pls URL with local .m3u,
# or direct srv address, or leave as-is.
#


def convert_playlist(url, source, dest):

    # Leave alone
    if source == dest or source in ("srv", "href"):
        return url

    # Else
    return url



# Save row(s) in one of the export formats,
# depending on file extension:
#
#  · m3u
#  · pls
#  · xspf
#  · asx
#  · json
#  · smil
#
def save(row, fn, listformat="audio/x-scpls"):

    # output format
    format = re.findall("\.(m3u|pls|xspf|jspf|json|asx|smil)", fn)

    # modify stream url

    stream_urls = extract_urls(row["url"], listformat)

    # M3U
    if "m3u" in format:
        txt = "#M3U\n"
        for url in stream_urls:
            txt += http_fix_url(url) + "\n"

    # PLS
    elif "pls" in format:
        txt = "[playlist]\n" + "numberofentries=1\n"
        for i,u in enumerate(stream_urls):
            i = str(i + 1)
            txt += "File"+i + "=" + u + "\n"
            txt += "Title"+i + "=" + row["title"] + "\n"
            txt += "Length"+i + "=-1\n"
        txt += "Version=2\n"

    # XSPF
    elif "xspf" in format:
        txt = '<?xml version="1.0" encoding="UTF-8"?>' + "\n"
        txt += '<?http header="Content-Type: application/xspf+xml" ?>' + "\n"
        txt += '<playlist version="1" xmlns="http://xspf.org/ns/0/">' + "\n"
        for attr,tag in [("title","title"), ("homepage","info"), ("playing","annotation"), ("description","annotation")]:
            if row.get(attr):
                txt += "  <"+tag+">" + xmlentities(row[attr]) + "</"+tag+">\n"
        txt += "  <trackList>\n"
        for u in stream_urls:
            txt += '	<track><location>' + xmlentities(u) + '</location></track>' + "\n"
        txt += "  </trackList>\n</playlist>\n"

    # JSPF
    elif "jspf" in format:
        pass

    # JSON
    elif "json" in format:
        row["stream_urls"] = stream_urls
        txt = str(row)   # pseudo-json (python format)
    
    # ASX
    elif "asx" in format:
        txt = "<ASX version=\"3.0\">\n"			\
            + " <Title>" + xmlentities(row["title"]) + "</Title>\n"	\
            + " <Entry>\n"				\
            + "  <Title>" + xmlentities(row["title"]) + "</Title>\n"	\
            + "  <MoreInfo href=\"" + row["homepage"] + "\"/>\n"	\
            + "  <Ref href=\"" + stream_urls[0] + "\"/>\n"		\
            + " </Entry>\n</ASX>\n"

    # SMIL
    elif "smil" in format:
            txt = "<smil>\n<head>\n  <meta name=\"title\" content=\"" + xmlentities(row["title"]) + "\"/>\n</head>\n"	\
                + "<body>\n  <seq>\n    <audio src=\"" + stream_urls[0] + "\"/>\n  </seq>\n</body>\n</smil>\n"

    # unknown
    else:
        return

    # write
    if txt:
        f = open(fn, "wb")
        f.write(txt)
        f.close()
    pass
















































# retrieve real stream urls from .pls or .m3u links

def extract_urls(pls, listformat="__not_used_yet__"):
    # extract stream address from .pls URL
    if (re.search("\.pls", pls)):       #audio/x-scpls
        return pls(pls)
    elif (re.search("\.asx", pls)):	#video/x-ms-asf
        return re.findall("<Ref\s+href=\"(http://.+?)\"", http_get(pls))
    elif (re.search("\.m3u|\.ram|\.smil", pls)):	#audio/x-mpegurl
        return re.findall("(http://[^\s]+)", http_get(pls), re.I)
    else:  # just assume it was a direct mpeg/ogg streamserver link
        return [ (pls if pls.startswith("/") else http_fix_url(pls)) ]
    pass


# generate filename for temporary .m3u, if possible with unique id

def tmp_fn(pls):
    # use shoutcast unique stream id if available
    stream_id = re.search("http://.+?/.*?(\d+)", pls, re.M)
    stream_id = stream_id and stream_id.group(1) or "XXXXXX"
    try:
        channelname = main.current_channel
    except:
        channelname = "unknown"
    return (str(conf.tmp) + os.sep + "streamtuner2."+channelname+"."+stream_id+".m3u", len(stream_id) > 3 and stream_id != "XXXXXX")

# check if there are any urls in a given file

def has_urls(tmp_fn):
    if os.path.exists(tmp_fn):
        return open(tmp_fn, "r").read().find("http://") > 0
    

# create a local .m3u file from it

def m3u(pls):

    # temp filename
    (tmp_fn, unique) = tmp_fn(pls)
    # does it already exist?
    if tmp_fn and unique and conf.reuse_m3u and has_urls(tmp_fn):
        return tmp_fn

    # download PLS
    debug( dbg.DATA, "pls=",pls )
    url_list = extract_urls(pls)
    debug( dbg.DATA, "urls=", url_list )

    # output URL list to temporary .m3u file
    if (len(url_list)):
        #tmp_fn = 
        f = open(tmp_fn, "w")
        f.write("#M3U\n")
        f.write("\n".join(url_list) + "\n")
        f.close()
        # return path/name of temporary file
        return tmp_fn
    else:
        debug( dbg.ERR, "error, there were no URLs in ", pls )
        raise "Empty PLS"

# Download a .pls resource and extract urls
def extract_from_pls(url):
    text = http_get(url)
    debug(dbg.DATA, "pls_text=", text)
    return re.findall("\s*File\d*\s*=\s*(\w+://[^\s]+)", text, re.I)
    # currently misses out on the titles            



# get a single direct ICY stream url (extract either from PLS or M3U)
def srv(url):

    return extract_urls(url)[0]