lib/POE/Component/Client/MPD/Commands.pm

   1 #
   2 # This program is free software; you can redistribute it and/or modify
   3 # it under the terms of the GNU General Public License as published by
   4 # the Free Software Foundation; either version 2 of the License, or
   5 # (at your option) any later version.
   6 #
   7 # This program is distributed in the hope that it will be useful,
   8 # but WITHOUT ANY WARRANTY; without even the implied warranty of
   9 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  10 # GNU General Public License for more details.
  11 #
  12 # You should have received a copy of the GNU General Public License
  13 # along with this program; if not, write to the Free Software
  14 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  15 #
  16 #
  17
  18 package POE::Component::Client::MPD::Commands;
  19
  20 use strict;
  21 use warnings;
  22
  23 use POE;
  24 use POE::Component::Client::MPD::Message;
  25 use POE::Component::Client::MPD::Stats;
  26 use POE::Component::Client::MPD::Status;
  27 use base qw[ Class::Accessor::Fast ];
  28
  29 # -- MPD interaction: general commands
  30
  31 #
  32 # event: updatedb( [$path] )
  33 #
  34 # Force mpd to rescan its collection. If $path (relative to MPD's music
  35 # directory) is supplied, MPD will only scan it - otherwise, MPD will rescan
  36 # its whole collection.
  37 #
  38 sub _onpub_updatedb {
  39     my $path = defined $_[ARG0] ? $_[ARG0] : '';
  40     my $msg = POE::Component::Client::MPD::Message->new( {
  41         _from     => $_[SENDER]->ID,
  42         _request  => $_[STATE],
  43         _answer   => $DISCARD,
  44         _commands => [ "update $path" ],
  45         _cooking  => $RAW,
  46     } );
  47     $_[KERNEL]->yield( '_send', $msg );
  48 }
  49
  50
  51 # -- MPD interaction: handling volume & output
  52
  53 #
  54 # event: volume( $volume )
  55 #
  56 # Sets the audio output volume percentage to absolute $volume.
  57 # If $volume is prefixed by '+' or '-' then the volume is changed relatively
  58 # by that value.
  59 #
  60 sub _onpub_volume {
  61     my $volume = $_[ARG0]; # FIXME: +/- prefix
  62     my $msg = POE::Component::Client::MPD::Message->new( {
  63         _from     => $_[SENDER]->ID,
  64         _request  => $_[STATE],
  65         _answer   => $DISCARD,
  66         _commands => [ "setvol $volume" ],
  67         _cooking  => $RAW,
  68     } );
  69     $_[KERNEL]->yield( '_send', $msg );
  70 }
  71
  72
  73 #
  74 # event: output_enable( $output )
  75 #
  76 # Enable the specified audio output. $output is the ID of the audio output.
  77 #
  78 sub _onpub_output_enable {
  79     my $output = $_[ARG0];
  80     my $msg = POE::Component::Client::MPD::Message->new( {
  81         _from     => $_[SENDER]->ID,
  82         _request  => $_[STATE],
  83         _answer   => $DISCARD,
  84         _commands => [ "enableoutput $output" ],
  85         _cooking  => $RAW,
  86     } );
  87     $_[KERNEL]->yield( '_send', $msg );
  88 }
  89
  90
  91 #
  92 # event: output_disable( $output )
  93 #
  94 # Disable the specified audio output. $output is the ID of the audio output.
  95 #
  96 sub _onpub_output_disable {
  97     my $output = $_[ARG0];
  98     my $msg = POE::Component::Client::MPD::Message->new( {
  99         _from     => $_[SENDER]->ID,
 100         _request  => $_[STATE],
 101         _answer   => $DISCARD,
 102         _commands => [ "disableoutput $output" ],
 103         _cooking  => $RAW,
 104     } );
 105     $_[KERNEL]->yield( '_send', $msg );
 106 }
 107
 108
 109 # -- MPD interaction: retrieving info from current state
 110
 111 #
 112 # event: stats()
 113 #
 114 # Return a hash with the current statistics of MPD.
 115 #
 116 sub _onpub_stats {
 117     my $msg = POE::Component::Client::MPD::Message->new( {
 118         _from     => $_[SENDER]->ID,
 119         _request  => $_[STATE],
 120         _answer   => $SEND,
 121         _commands => [ 'stats' ],
 122         _cooking  => $AS_KV,
 123         _post     => '_stats_postback',
 124     } );
 125     $_[KERNEL]->yield( '_send', $msg );
 126 }
 127
 128
 129 #
 130 # event: _stats_postback( $msg )
 131 #
 132 # Transform $msg->data from hash to a POCOCM::Stats object with the current
 133 # statistics of MPD.
 134 #
 135 sub _onpriv_stats_postback {
 136     my $msg   = $_[ARG0];
 137     my %stats = @{ $msg->data };
 138     my $stats = POE::Component::Client::MPD::Stats->new( \%stats );
 139     $msg->data($stats);
 140     $_[KERNEL]->yield( '_mpd_data', $msg );
 141 }
 142
 143
 144 #
 145 # event: status()
 146 #
 147 # Return a hash with the current status of MPD.
 148 #
 149 sub _onpub_status {
 150     my $msg = POE::Component::Client::MPD::Message->new( {
 151         _from     => $_[SENDER]->ID,
 152         _request  => $_[STATE],
 153         _answer   => $SEND,
 154         _commands => [ 'status' ],
 155         _cooking  => $AS_KV,
 156         _post     => '_status_postback',
 157     } );
 158     $_[KERNEL]->yield( '_send', $msg );
 159 }
 160
 161
 162 #
 163 # event: _status_postback( $msg )
 164 #
 165 # Transform $msg->data from hash to a POCOCM::Status object with the current
 166 # status of MPD.
 167 #
 168 sub _onpriv_status_postback {
 169     my $msg   = $_[ARG0];
 170     my %stats = @{ $msg->data };
 171     my $stats = POE::Component::Client::MPD::Status->new( \%stats );
 172     $msg->data($stats);
 173     $_[KERNEL]->yield( '_mpd_data', $msg );
 174 }
 175
 176
 177 #
 178 # event: current()
 179 #
 180 # Return a POCOCM::Item::Song representing the song currently playing.
 181 #
 182 sub _onpub_current {
 183     my $msg = POE::Component::Client::MPD::Message->new( {
 184         _from     => $_[SENDER]->ID,
 185         _request  => $_[STATE],
 186         _answer   => $SEND,
 187         _commands => [ 'currentsong' ],
 188         _cooking  => $AS_ITEMS,
 189         _post     => '_post_array2scalar',
 190     } );
 191     $_[KERNEL]->yield( '_send', $msg );
 192 }
 193
 194
 195 # -- MPD interaction: altering settings
 196 # -- MPD interaction: controlling playback
 197
 198 #
 199 # event: play( [$song] )
 200 #
 201 # Begin playing playlist at song number $song. If no argument supplied,
 202 # resume playing.
 203 #
 204 sub _onpub_play {
 205     my $number = defined $_[ARG0] ? $_[ARG0] : '';
 206     my $msg = POE::Component::Client::MPD::Message->new( {
 207         _from     => $_[SENDER]->ID,
 208         _request  => $_[STATE],
 209         _answer   => $DISCARD,
 210         _commands => [ "play $number" ],
 211         _cooking  => $RAW,
 212     } );
 213     $_[KERNEL]->yield( '_send', $msg );
 214 }
 215
 216
 217 #
 218 # event: playid( [$song] )
 219 #
 220 # Begin playing playlist at song ID $song. If no argument supplied,
 221 # resume playing.
 222 #
 223 sub _onpub_playid {
 224     my $number = defined $_[ARG0] ? $_[ARG0] : '';
 225     my $msg = POE::Component::Client::MPD::Message->new( {
 226         _from     => $_[SENDER]->ID,
 227         _request  => $_[STATE],
 228         _answer   => $DISCARD,
 229         _commands => [ "playid $number" ],
 230         _cooking  => $RAW,
 231     } );
 232     $_[KERNEL]->yield( '_send', $msg );
 233 }
 234
 235
 236 #
 237 # event: pause( [$sate] )
 238 #
 239 # Pause playback. If $state is 0 then the current track is unpaused, if
 240 # $state is 1 then the current track is paused.
 241 #
 242 # Note that if $state is not given, pause state will be toggled.
 243 #
 244 sub _onpub_pause {
 245     my $state = defined $_[ARG0] ? $_[ARG0] : '';
 246     my $msg = POE::Component::Client::MPD::Message->new( {
 247         _from     => $_[SENDER]->ID,
 248         _request  => $_[STATE],
 249         _answer   => $DISCARD,
 250         _commands => [ "pause $state" ],
 251         _cooking  => $RAW,
 252     } );
 253     $_[KERNEL]->yield( '_send', $msg );
 254 }
 255
 256
 257 #
 258 # event: stop()
 259 #
 260 # Stop playback
 261 #
 262 sub _onpub_stop {
 263     my $msg = POE::Component::Client::MPD::Message->new( {
 264         _from     => $_[SENDER]->ID,
 265         _request  => $_[STATE],
 266         _answer   => $DISCARD,
 267         _commands => [ 'stop' ],
 268         _cooking  => $RAW,
 269     } );
 270     $_[KERNEL]->yield( '_send', $msg );
 271 }
 272
 273
 274 #
 275 # event: next()
 276 #
 277 # Play next song in playlist.
 278 #
 279 sub _onpub_next {
 280     my $msg = POE::Component::Client::MPD::Message->new( {
 281         _from     => $_[SENDER]->ID,
 282         _request  => $_[STATE],
 283         _answer   => $DISCARD,
 284         _commands => [ 'next' ],
 285         _cooking  => $RAW,
 286     } );
 287     $_[KERNEL]->yield( '_send', $msg );
 288 }
 289
 290
 291 #
 292 # event: prev()
 293 #
 294 # Play previous song in playlist.
 295 #
 296 sub _onpub_prev {
 297     my $msg = POE::Component::Client::MPD::Message->new( {
 298         _from     => $_[SENDER]->ID,
 299         _request  => $_[STATE],
 300         _answer   => $DISCARD,
 301         _commands => [ 'previous' ],
 302         _cooking  => $RAW,
 303     } );
 304     $_[KERNEL]->yield( '_send', $msg );
 305 }
 306
 307
 308 #
 309 # event: seek( $time, [$song] )
 310 #
 311 # Seek to $time seconds in song number $song. If $song number is not specified
 312 # then the perl module will try and seek to $time in the current song.
 313 #
 314 sub _onpub_seek {
 315     my ($time, $song) = @_[ARG0, ARG1];
 316     $time ||= 0; $time = int $time;
 317     my $msg = POE::Component::Client::MPD::Message->new( {
 318         _from     => $_[SENDER]->ID,
 319         _request  => $_[STATE],
 320         _answer   => $DISCARD,
 321         _cooking  => $RAW,
 322     } );
 323
 324     if ( defined $song ) {
 325         $msg->_commands( [ "seek $song $time" ] );
 326     } else {
 327         $msg->_pre_from( '_seek_need_current' );
 328         $msg->_pre_event( 'status' );
 329         $msg->_pre_data( $time );
 330     }
 331     $_[KERNEL]->yield( '_send', $msg );
 332 }
 333
 334
 335 #
 336 # event: _seek_need_current( $msg, $current )
 337 #
 338 # Use $current to get current song, before sending real seek $msg.
 339 #
 340 sub _onpriv_seek_need_current {
 341     my ($msg, $current) = @_[ARG0, ARG1];
 342     my $song = $current->data->song;
 343     my $time = $msg->_pre_data;
 344     $msg->_commands( [ "seek $song $time" ] );
 345     $_[KERNEL]->yield( '_send', $msg );
 346 }
 347
 348
 349 #
 350 # event: seekid( $time, [$songid] )
 351 #
 352 # Seek to $time seconds in song ID $songid. If $songid number is not specified
 353 # then the perl module will try and seek to $time in the current song.
 354 #
 355 sub _onpub_seekid {
 356     my ($time, $song) = @_[ARG0, ARG1];
 357     $time ||= 0; $time = int $time;
 358     my $msg = POE::Component::Client::MPD::Message->new( {
 359         _from     => $_[SENDER]->ID,
 360         _request  => $_[STATE],
 361         _answer   => $DISCARD,
 362         _cooking  => $RAW,
 363     } );
 364
 365     if ( defined $song ) {
 366         $msg->_commands( [ "seekid $song $time" ] );
 367     } else {
 368         $msg->_pre_from( '_seekid_need_current' );
 369         $msg->_pre_event( 'status' );
 370         $msg->_pre_data( $time );
 371     }
 372     $_[KERNEL]->yield( '_send', $msg );
 373 }
 374
 375
 376 #
 377 # event: _seekid_need_current( $msg, $current )
 378 #
 379 # Use $current to get current song, before sending real seekid $msg.
 380 #
 381 sub _onpriv_seekid_need_current {
 382     my ($msg, $current) = @_[ARG0, ARG1];
 383     my $song = $current->data->song;
 384     my $time = $msg->_pre_data;
 385     $msg->_commands( [ "seekid $song $time" ] );
 386     $_[KERNEL]->yield( '_send', $msg );
 387 }
 388
 389
 390 1;
 391
 392 __END__
 393
 394 =head1 NAME
 395
 396 POE::Component::Client::MPD::Commands - module handling basic commands
 397
 398
 399 =head1 DESCRIPTION
 400
 401 C<POCOCM::Commands> is responsible for handling general purpose commands.
 402 To achieve those commands, send the corresponding event to the POCOCM
 403 session you created: it will be responsible for dispatching the event
 404 where it is needed.
 405
 406
 407 =head1 PUBLIC EVENTS
 408
 409 The following is a list of general purpose events accepted by POCOCM.
 410
 411
 412 =head2 General commands
 413
 414 =head2 Handling volume & output
 415
 416 =head2 Retrieving info from current state
 417
 418 =head2 Altering settings
 419
 420 =head2 Controlling playback
 421
 422
 423 =head1 SEE ALSO
 424
 425 For all related information (bug reporting, mailing-list, pointers to
 426 MPD and POE, etc.), refer to C<POE::Component::Client::MPD>'s pod,
 427 section C<SEE ALSO>
 428
 429
 430 =head1 AUTHOR
 431
 432 Jerome Quelin, C<< <jquelin at cpan.org> >>
 433
 434
 435 =head1 COPYRIGHT & LICENSE
 436
 437 Copyright 2007 Jerome Quelin, all rights reserved.
 438
 439 This program is free software; you can redistribute it and/or modify
 440 it under the terms of the GNU General Public License as published by
 441 the Free Software Foundation; either version 2 of the License, or
 442 (at your option) any later version.
 443
 444 This program is distributed in the hope that it will be useful,
 445 but WITHOUT ANY WARRANTY; without even the implied warranty of
 446 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 447 GNU General Public License for more details.
 448
 449 You should have received a copy of the GNU General Public License
 450 along with this program; if not, write to the Free Software
 451 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 452
 453 =cut