Organizing import, refresh the license (zapata deleted cos.jar)
[mir.git] / source / mircoders / media / MediaHandlerMp3.java
1 /*
2  * Copyright (C) 2001, 2002 The Mir-coders group
3  *
4  * This file is part of Mir.
5  *
6  * Mir is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * Mir is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with Mir; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  *
20  * In addition, as a special exception, The Mir-coders gives permission to link
21  * the code of this program with  any library licensed under the Apache Software License, 
22  * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library 
23  * (or with modified versions of the above that use the same license as the above), 
24  * and distribute linked combinations including the two.  You must obey the 
25  * GNU General Public License in all respects for all of the code used other than 
26  * the above mentioned libraries.  If you modify this file, you may extend this 
27  * exception to your version of the file, but you are not obligated to do so.  
28  * If you do not wish to do so, delete this exception statement from your version.
29  */
30 package  mircoders.media;
31
32 import java.io.StringReader;
33
34 import mir.entity.Entity;
35 import mir.log.LoggerWrapper;
36 import mir.media.MediaExc;
37 import mir.media.MediaFailure;
38 import mir.media.MirMedia;
39 import mir.misc.FileUtil;
40 import mir.misc.StringUtil;
41 import freemarker.template.SimpleHash;
42 import freemarker.template.SimpleList;
43
44 /**
45  * Please note: this media handler produces
46  * 3 media files, the raw .mp3, a .m3u which is
47  * contains the URL for the mp3 and a .pls which
48  * contains the URL to the mp3 in shoutcast playlist
49  * format. What's important is that the web server (of
50  * the media host) must recognize the .m3u and .pls file
51  * extensions and send the proper "audio/x-mpegurl"
52  * and "audio/x-scpls" mime-types respectively.
53  * If the web server is apache, it's easy, just
54  * add:
55  *
56  * audio/x-mpegurl                 m3u
57  * audio/x-scpl                    pls
58  *
59  * to the file pointed to by the "TypesConfig"
60  * command in your apache config file. Or add
61  * and equivalent AddType command to your httpd.conf.
62  * Of course this assumes that the mod_mime is loaded.
63  *
64  * If the web server is not apache, then your on your own.
65  *
66  * @see mir.media.MirMedia
67  * @author mh <mh@nadir.org>
68  * @version $Id: MediaHandlerMp3.java,v 1.15 2003/04/21 12:42:48 idfx Exp $
69  */
70
71 public class MediaHandlerMp3 extends MediaHandlerAudio implements MirMedia
72 {
73   protected LoggerWrapper logger;
74
75   public MediaHandlerMp3() {
76     logger = new LoggerWrapper("Media.Audio.Mp3");
77   }
78
79   public void produce(Entity ent, Entity mediaTypeEnt) throws MediaExc, MediaFailure {
80
81     // first check if the file exists
82     super.produce(ent, mediaTypeEnt);
83
84     String baseName = ent.getId();
85     String date = ent.getValue("date");
86     String datePath = StringUtil.webdbDate2path(date);
87     String mp3Pointer = getPublishHost() + ent.getValue("publish_path");
88     String mpegURLFile = baseName + ".m3u";
89     String playlistFile = baseName + ".pls";
90
91     try {
92       //write the "meta" files
93       //first the .m3u since it only contains one line
94       FileUtil.write(getStoragePath() + "/" + datePath + "/" + mpegURLFile,
95                      new StringReader(mp3Pointer), "US-ASCII");
96       //now the .pls file
97       FileUtil.write(getStoragePath() + "/" + datePath + "/" + playlistFile,
98                      new StringReader(mp3Pointer), "US-ASCII");
99     }
100     catch (Throwable e) {
101       logger.error("MediaHandlerMp3.produce: " + e.toString());
102
103       throw new MediaFailure(e);
104     }
105   }
106
107   public SimpleList getURL(Entity ent, Entity mediaTypeEnt) {
108     SimpleList theList = new SimpleList();
109
110     //String stringSize = ent.getValue("size");
111     //int size = Integer.parseInt(stringSize, 10)/1024;
112     theList.add(ent);
113
114     String basePath = StringUtil.regexpReplace(ent.getValue("publish_path"),
115                                                ".mp3$", "");
116
117     // @todo the texts ("title") below urgently need to be sanely localizaeble
118     // somehow
119     SimpleHash m3uHash = new SimpleHash();
120     m3uHash.put("publish_path", basePath + ".m3u");
121     m3uHash.put("publish_server", ent.getValue("publish_server"));
122     m3uHash.put("title", "stream URL");
123     theList.add(m3uHash);
124
125     SimpleHash plsHash = new SimpleHash();
126     plsHash.put("publish_path", basePath + ".pls");
127     plsHash.put("publish_server", ent.getValue("publish_server"));
128     plsHash.put("title", "playlist URL");
129     theList.add(plsHash);
130
131     return theList;
132
133   }
134
135   public String getDescr(Entity mediaType) {
136     return "mp3";
137   }
138 }
139
140
141