489f6bcb6ec39de2929f3286cc6a797873e75164
[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 the com.oreilly.servlet library, any library
22  * licensed under the Apache Software License, The Sun (tm) Java Advanced
23  * Imaging library (JAI), The Sun JIMI library (or with modified versions of
24  * the above that use the same license as the above), and distribute linked
25  * combinations including the two.  You must obey the GNU General Public
26  * License in all respects for all of the code used other than the above
27  * mentioned libraries.  If you modify this file, you may extend this exception
28  * to your version of the file, but you are not obligated to do so.  If you do
29  * not wish to do so, delete this exception statement from your version.
30  */
31
32 package  mircoders.media;
33
34 import java.util.*;
35 import java.io.StringReader;
36
37 import freemarker.template.SimpleList;
38 import freemarker.template.SimpleHash;
39
40 import mir.media.*;
41 import mir.entity.*;
42 import mir.misc.*;
43 import mir.storage.*;
44
45
46 /**
47  * Please note: this media handler produces 
48  * 3 media files, the raw .mp3, a .m3u which is 
49  * contains the URL for the mp3 and a .pls which
50  * contains the URL to the mp3 in shoutcast playlist
51  * format. What's important is that the web server (of 
52  * the media host) must recognize the .m3u and .pls file 
53  * extensions and send the proper "audio/x-mpegurl"
54  * and "audio/x-scpls" mime-types respectively.
55  * If the web server is apache, it's easy, just 
56  * add:
57  *
58  * audio/x-mpegurl                 m3u
59  * audio/x-scpl                    pls
60  *
61  * to the file pointed to by the "TypesConfig" 
62  * command in your apache config file. Or add 
63  * and equivalent AddType command to your httpd.conf.
64  * Of course this assumes that the mod_mime is loaded.
65  *
66  * If the web server is not apache, then your on your own.
67  * 
68  * @see mir.media.MirMedia
69  * @author mh <heckmann@hbe.ca>
70  * @version 01.12.2001
71  */
72
73 public class MediaHandlerMp3 extends MediaHandlerAudio implements MirMedia
74 {
75
76     public void produce (Entity ent, Entity mediaTypeEnt )
77       throws MirMediaException {
78       
79       // first check if the file exists
80       super.produce(ent, mediaTypeEnt);
81
82       String baseName = ent.getId();
83       String date = ent.getValue("date");
84       String datePath = StringUtil.webdbDate2path(date);
85       String mp3Pointer = getPublishHost()+ent.getValue("publish_path");
86       String mpegURLFile = baseName+".m3u"; 
87       String playlistFile = baseName+".pls"; 
88
89       try {
90         //write the "meta" files
91         //first the .m3u since it only contains one line
92         FileUtil.write(getStoragePath()+"/"+datePath+"/"+mpegURLFile,
93                       new StringReader(mp3Pointer), "US-ASCII");
94         //now the .pls file
95         FileUtil.write(getStoragePath()+"/"+datePath+"/"+playlistFile,
96                       new StringReader(mp3Pointer), "US-ASCII");
97       } catch (Exception e) {
98           theLog.printError(e.toString()); 
99           throw new MirMediaException(e.toString());
100       }
101     }
102
103   public SimpleList getURL(Entity ent, Entity mediaTypeEnt)
104   {
105     SimpleList theList = new SimpleList();
106
107     //String stringSize = ent.getValue("size");
108     //int size = Integer.parseInt(stringSize, 10)/1024;
109     theList.add(ent);
110    
111     String basePath=StringUtil.regexpReplace(ent.getValue("publish_path"),
112                                             ".mp3$","");
113
114     // @todo the texts ("title") below urgently need to be sanely localizaeble
115     // somehow
116     SimpleHash m3uHash = new SimpleHash();
117     m3uHash.put("publish_path", basePath+".m3u");
118     m3uHash.put("publish_server", ent.getValue("publish_server"));
119     m3uHash.put("title", "stream URL");
120     theList.add(m3uHash);
121
122     SimpleHash plsHash = new SimpleHash();
123     plsHash.put("publish_path", basePath+".pls");
124     plsHash.put("publish_server", ent.getValue("publish_server"));
125     plsHash.put("title", "playlist URL");
126     theList.add(plsHash);
127
128     return theList;
129
130   }
131
132   public String getDescr(Entity mediaType)
133   {
134     return "Mp3 audio";
135   }
136
137 }
138         
139         
140