Mir goes GPL
[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
36 import freemarker.template.SimpleList;
37 import freemarker.template.SimpleHash;
38
39 import mir.media.*;
40 import mir.entity.*;
41 import mir.misc.*;
42 import mir.storage.*;
43
44
45 /**
46  * Please note: this media handler produces 
47  * 3 media files, the raw .mp3, a .m3u which is 
48  * contains the URL for the mp3 and a .pls which
49  * contains the URL to the mp3 in shoutcast playlist
50  * format. What's important is that the web server (of 
51  * the media host) must recognize the .m3u and .pls file 
52  * extensions and send the proper "audio/x-mpegurl"
53  * and "audio/x-scpls" mime-types respectively.
54  * If the web server is apache, it's easy, just 
55  * add:
56  *
57  * audio/x-mpegurl                 m3u
58  * audio/x-scpl                    pls
59  *
60  * to the file pointed to by the "TypesConfig" 
61  * command in your apache config file. Or add 
62  * and equivalent AddType command to your httpd.conf.
63  * Of course this assumes that the mod_mime is loaded.
64  *
65  * If the web server is not apache, then your on your own.
66  * 
67  * @see mir.media.MirMedia
68  * @author mh <heckmann@hbe.ca>
69  * @version 01.12.2001
70  */
71
72 public class MediaHandlerMp3 extends MediaHandlerAudio implements MirMedia
73 {
74
75     public void produce (Entity ent, Entity mediaTypeEnt )
76       throws MirMediaException {
77       
78       // first check if the file exists
79       super.produce(ent, mediaTypeEnt);
80
81       String baseName = ent.getId();
82       String date = ent.getValue("date");
83       String datePath = StringUtil.webdbDate2path(date);
84       String mp3Pointer = getPublishHost()+ent.getValue("publish_path");
85       String mpegURLFile = baseName+".m3u"; 
86       String playlistFile = baseName+".pls"; 
87
88       try {
89         //write the "meta" files
90         //first the .m3u since it only contains one line
91         FileUtil.write(getStoragePath()+"/"+datePath+"/"+mpegURLFile,
92                       mp3Pointer.getBytes());
93         //now the .pls file
94         FileUtil.write(getStoragePath()+"/"+datePath+"/"+playlistFile,
95                       mp3Pointer.getBytes());
96       } catch (Exception e) {
97           theLog.printError(e.toString()); 
98           throw new MirMediaException(e.toString());
99       }
100     }
101
102   public SimpleList getURL(Entity ent, Entity mediaTypeEnt)
103   {
104     SimpleList theList = new SimpleList();
105
106     //String stringSize = ent.getValue("size");
107     //int size = Integer.parseInt(stringSize, 10)/1024;
108     theList.add(ent);
109    
110     String basePath=StringUtil.regexpReplace(ent.getValue("publish_path"),
111                                             ".mp3$","");
112
113     // @todo the texts ("title") below urgently need to be sanely localizaeble
114     // somehow
115     SimpleHash m3uHash = new SimpleHash();
116     m3uHash.put("publish_path", basePath+".m3u");
117     m3uHash.put("publish_server", ent.getValue("publish_server"));
118     m3uHash.put("title", "stream URL");
119     theList.add(m3uHash);
120
121     SimpleHash plsHash = new SimpleHash();
122     plsHash.put("publish_path", basePath+".pls");
123     plsHash.put("publish_server", ent.getValue("publish_server"));
124     plsHash.put("title", "playlist URL");
125     theList.add(plsHash);
126
127     return theList;
128
129   }
130
131   public String getDescr(Entity mediaType)
132   {
133     return "Mp3 audio";
134   }
135
136 }
137         
138         
139