1 /*****************************************************************************
2 * growl.m : growl notification plugin
3 *****************************************************************************
6 * Copyright © 2008,2011,2012 the VideoLAN team
9 * Authors: Rafaël Carré <funman@videolanorg>
10 * Felix Paul Kühne <fkuehne@videolan.org
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
26 * Growl specific code, ripped from growlnotify:
28 * Copyright (c) The Growl Project, 2004-2005
29 * All rights reserved.
31 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
33 * 1. Redistributions of source code must retain the above copyright
34 notice, this list of conditions and the following disclaimer.
35 * 2. Redistributions in binary form must reproduce the above copyright
36 notice, this list of conditions and the following disclaimer in the
37 documentation and/or other materials provided with the distribution.
38 * 3. Neither the name of Growl nor the names of its contributors
39 may be used to endorse or promote products derived from this software
40 without specific prior written permission.
42 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44 *****************************************************************************/
46 /*****************************************************************************
48 *****************************************************************************/
54 #import <Foundation/Foundation.h>
55 #import <Growl/Growl.h>
57 #include <vlc_common.h>
58 #include <vlc_plugin.h>
59 #include <vlc_playlist.h>
60 #include <vlc_input.h>
62 #include <vlc_interface.h>
66 /*****************************************************************************
67 * intf_sys_t, VLCGrowlDelegate
68 *****************************************************************************/
69 @interface VLCGrowlDelegate : NSObject <GrowlApplicationBridgeDelegate>
71 NSString *o_applicationName;
72 NSString *o_notificationType;
73 NSMutableDictionary *o_registrationDictionary;
76 - (void)registerToGrowl;
77 - (void)notifyWithDescription: (const char *)psz_desc
78 artUrl: (const char *)psz_arturl;
83 VLCGrowlDelegate *o_growl_delegate;
88 /*****************************************************************************
90 *****************************************************************************/
91 static int Open ( vlc_object_t * );
92 static void Close ( vlc_object_t * );
94 static int ItemChange( vlc_object_t *, const char *,
95 vlc_value_t, vlc_value_t, void * );
97 /*****************************************************************************
99 ****************************************************************************/
102 set_category( CAT_INTERFACE )
103 set_subcategory( SUBCAT_INTERFACE_CONTROL )
104 set_shortname( "Growl" )
105 set_description( N_("Growl Notification Plugin") )
106 set_capability( "interface", 0 )
107 set_callbacks( Open, Close )
110 /*****************************************************************************
111 * Open: initialize and create stuff
112 *****************************************************************************/
113 static int Open( vlc_object_t *p_this )
115 intf_thread_t *p_intf = (intf_thread_t *)p_this;
116 playlist_t *p_playlist;
119 p_sys = p_intf->p_sys = calloc( 1, sizeof(intf_sys_t) );
123 p_sys->o_growl_delegate = [[VLCGrowlDelegate alloc] init];
124 if( !p_sys->o_growl_delegate )
127 p_playlist = pl_Get( p_intf );
128 var_AddCallback( p_playlist, "item-change", ItemChange, p_intf );
129 var_AddCallback( p_playlist, "input-current", ItemChange, p_intf );
131 [p_sys->o_growl_delegate registerToGrowl];
135 /*****************************************************************************
136 * Close: destroy interface stuff
137 *****************************************************************************/
138 static void Close( vlc_object_t *p_this )
140 intf_thread_t *p_intf = (intf_thread_t *)p_this;
141 playlist_t *p_playlist = pl_Get( p_intf );
142 intf_sys_t *p_sys = p_intf->p_sys;
144 var_DelCallback( p_playlist, "item-change", ItemChange, p_intf );
145 var_DelCallback( p_playlist, "input-current", ItemChange, p_intf );
147 [p_sys->o_growl_delegate release];
151 /*****************************************************************************
152 * ItemChange: Playlist item change callback
153 *****************************************************************************/
154 static int ItemChange( vlc_object_t *p_this, const char *psz_var,
155 vlc_value_t oldval, vlc_value_t newval, void *param )
159 intf_thread_t *p_intf = (intf_thread_t *)param;
160 char *psz_tmp = NULL;
161 char *psz_title = NULL;
162 char *psz_artist = NULL;
163 char *psz_album = NULL;
164 input_item_t *p_item = newval.p_address;
166 bool b_is_item_current = !strcmp( "input-current", psz_var );
168 /* Don't update each time an item has been preparsed */
169 if( b_is_item_current )
170 { /* stores the current input item id */
171 input_thread_t *p_input = newval.p_address;
175 p_item = input_GetItem( p_input );
176 if( p_intf->p_sys->i_id != p_item->i_id )
178 p_intf->p_sys->i_id = p_item->i_id;
179 p_intf->p_sys->i_item_changes = 0;
184 /* ignore items which weren't pre-parsed yet */
185 else if( !input_item_IsPreparsed(p_item) )
188 { /* "item-change" */
190 if( p_item->i_id != p_intf->p_sys->i_id )
193 /* Some variable bitrate inputs call "item-change" callbacks each time
194 * their length is updated, that is several times per second.
195 * We'll limit the number of changes to 1 per input. */
196 if( p_intf->p_sys->i_item_changes > 0 )
199 p_intf->p_sys->i_item_changes++;
202 /* Playing something ... */
203 if( input_item_GetNowPlayingFb( p_item ) )
204 psz_title = input_item_GetNowPlayingFb( p_item );
206 psz_title = input_item_GetTitleFbName( p_item );
207 if( EMPTY_STR( psz_title ) )
213 psz_artist = input_item_GetArtist( p_item );
214 if( EMPTY_STR( psz_artist ) ) FREENULL( psz_artist );
215 psz_album = input_item_GetAlbum( p_item ) ;
216 if( EMPTY_STR( psz_album ) ) FREENULL( psz_album );
219 if( psz_artist && psz_album )
220 i_ret = asprintf( &psz_tmp, "%s\n%s [%s]",
221 psz_title, psz_artist, psz_album );
222 else if( psz_artist )
223 i_ret = asprintf( &psz_tmp, "%s\n%s", psz_title, psz_artist );
225 i_ret = asprintf(&psz_tmp, "%s", psz_title );
235 char *psz_arturl = input_item_GetArtURL( p_item );
238 char *psz = make_path( psz_arturl );
243 [p_intf->p_sys->o_growl_delegate notifyWithDescription: psz_tmp artUrl: psz_arturl];
254 /*****************************************************************************
256 *****************************************************************************/
257 @implementation VLCGrowlDelegate
261 if( !( self = [super init] ) )
264 o_applicationName = nil;
265 o_notificationType = nil;
266 o_registrationDictionary = nil;
273 [o_applicationName release];
274 [o_notificationType release];
275 [o_registrationDictionary release];
279 - (void)registerToGrowl
281 o_applicationName = [[NSString alloc] initWithUTF8String: _( "VLC media player" )];
282 o_notificationType = [[NSString alloc] initWithUTF8String: _( "New input playing" )];
284 NSAutoreleasePool *o_pool = [[NSAutoreleasePool alloc] init];
285 NSArray *o_defaultAndAllNotifications = [NSArray arrayWithObject: o_notificationType];
287 o_registrationDictionary = [[NSMutableDictionary alloc] init];
288 [o_registrationDictionary setObject: o_defaultAndAllNotifications
289 forKey: GROWL_NOTIFICATIONS_ALL];
290 [o_registrationDictionary setObject: o_defaultAndAllNotifications
291 forKey: GROWL_NOTIFICATIONS_DEFAULT];
293 [GrowlApplicationBridge setGrowlDelegate: self];
297 - (void)notifyWithDescription: (const char *)psz_desc artUrl: (const char *)psz_arturl
299 NSAutoreleasePool *o_pool = [[NSAutoreleasePool alloc] init];
303 o_art = [NSData dataWithContentsOfFile: [NSString stringWithUTF8String: psz_arturl]];
305 [GrowlApplicationBridge notifyWithTitle: [NSString stringWithUTF8String: _( "Now playing" )]
306 description: [NSString stringWithUTF8String: psz_desc]
307 notificationName: o_notificationType
315 /*****************************************************************************
317 *****************************************************************************/
318 - (NSDictionary *)registrationDictionaryForGrowl
320 return o_registrationDictionary;
323 - (NSString *)applicationNameForGrowl
325 return o_applicationName;