| … | |
… | |
| 147 | my $quit = AE::cv; |
147 | my $quit = AE::cv; |
| 148 | |
148 | |
| 149 | my $mpv = AnyEvent::MPV->new ( |
149 | my $mpv = AnyEvent::MPV->new ( |
| 150 | trace => 1, |
150 | trace => 1, |
| 151 | args => ["--pause", "--idle=yes"], |
151 | args => ["--pause", "--idle=yes"], |
| 152 | on_event => sub { |
|
|
| 153 | my ($mpv, $event, $data) = @_; |
|
|
| 154 | |
|
|
| 155 | if ($event eq "start-file") { |
|
|
| 156 | $mpv->cmd ("set", "pause", "no"); |
|
|
| 157 | } elsif ($event eq "end-file") { |
|
|
| 158 | print "end-file<$data->{reason}>\n"; |
|
|
| 159 | $quit->send; |
|
|
| 160 | } |
|
|
| 161 | }, |
|
|
| 162 | ); |
152 | ); |
| 163 | |
153 | |
| 164 | $mpv->start; |
154 | $mpv->start; |
|
|
155 | |
|
|
156 | $mpv->register_event (start_file => sub { |
|
|
157 | $mpv->cmd ("set", "pause", "no"); |
|
|
158 | }); |
|
|
159 | |
|
|
160 | $mpv->register_event (end_file => sub { |
|
|
161 | my ($mpv, $event, $data) = @_; |
|
|
162 | |
|
|
163 | print "end-file<$data->{reason}>\n"; |
|
|
164 | $quit->send; |
|
|
165 | }); |
|
|
166 | |
| 165 | $mpv->cmd (loadfile => $mpv->escape_binary ($videofile)); |
167 | $mpv->cmd (loadfile => $mpv->escape_binary ($videofile)); |
| 166 | |
168 | |
| 167 | $quit->recv; |
169 | $quit->recv; |
| 168 | |
170 | |
| 169 | This example uses a global condvar C<$quit> to wait for the file to finish |
171 | This example uses a global condvar C<$quit> to wait for the file to finish |
| 170 | playing. Also, most of the logic is now in an C<on_event> callback, which |
172 | playing. Also, most of the logic is now implement in event handlers. |
| 171 | receives an event name and the actual event object. |
|
|
| 172 | |
173 | |
| 173 | The two events we handle are C<start-file>, which is emitted by F<mpv> |
174 | The two events handlers we register are C<start-file>, which is emitted by |
| 174 | once it has loaded a new file, and C<end-file>, which signals the end |
175 | F<mpv> once it has loaded a new file, and C<end-file>, which signals the |
| 175 | of a file. |
176 | end of a file (underscores are internally replaced by minus signs, so you |
|
|
177 | cna speicfy event names with either). |
| 176 | |
178 | |
| 177 | In the former event, we again set the C<pause> property to C<no> so the |
179 | In the C<start-file> event, we again set the C<pause> property to C<no> |
| 178 | movie starts playing. For the latter event, we tell the main program to |
180 | so the movie starts playing. For the C<end-file> event, we tell the main |
| 179 | quit by invoking C<$quit>. |
181 | program to quit by invoking C<$quit>. |
| 180 | |
182 | |
| 181 | This should conclude the basics of operation. There are a few more |
183 | This should conclude the basics of operation. There are a few more |
| 182 | examples later in the documentation. |
184 | examples later in the documentation. |
| 183 | |
185 | |
| 184 | =head2 ENCODING CONVENTIONS |
186 | =head2 ENCODING CONVENTIONS |
| … | |
… | |
| 209 | use Scalar::Util (); |
211 | use Scalar::Util (); |
| 210 | |
212 | |
| 211 | use AnyEvent (); |
213 | use AnyEvent (); |
| 212 | use AnyEvent::Util (); |
214 | use AnyEvent::Util (); |
| 213 | |
215 | |
|
|
216 | our $VERSION = '0.2'; |
|
|
217 | |
|
|
218 | sub OBSID() { 0x10000000000000 } # 2**52 |
|
|
219 | |
| 214 | our $JSON = eval { require JSON::XS; JSON::XS:: } |
220 | our $JSON = eval { require JSON::XS; JSON::XS:: } |
| 215 | || do { require JSON::PP; JSON::PP:: }; |
221 | || do { require JSON::PP; JSON::PP:: }; |
| 216 | |
222 | |
| 217 | our $JSON_CODER = |
223 | our $JSON_ENCODER = $JSON->new->utf8; |
| 218 | |
224 | our $JSON_DECODER = $JSON->new->latin1; |
| 219 | our $VERSION = '0.1'; |
|
|
| 220 | |
225 | |
| 221 | our $mpv_path; # last mpv path used |
226 | our $mpv_path; # last mpv path used |
| 222 | our $mpv_optionlist; # output of mpv --list-options |
227 | our $mpv_optionlist; # output of mpv --list-options |
| 223 | |
228 | |
| 224 | =item $mpv = AnyEvent::MPV->new (key => value...) |
229 | =item $mpv = AnyEvent::MPV->new (key => value...) |
| … | |
… | |
| 396 | while ($buf =~ s/^([^\n]+)\n//) { |
401 | while ($buf =~ s/^([^\n]+)\n//) { |
| 397 | $trace->("mpv>" => "$1"); |
402 | $trace->("mpv>" => "$1"); |
| 398 | |
403 | |
| 399 | if ("{" eq substr $1, 0, 1) { |
404 | if ("{" eq substr $1, 0, 1) { |
| 400 | eval { |
405 | eval { |
| 401 | my $reply = $JSON->new->latin1->decode ($1); |
406 | my $reply = $JSON_DECODER->decode ($1); |
| 402 | |
407 | |
| 403 | if (exists $reply->{event}) { |
408 | if (defined (my $event = delete $reply->{event})) { |
| 404 | if ( |
409 | if ( |
| 405 | $reply->{event} eq "client-message" |
410 | $event eq "client-message" |
| 406 | and $reply->{args}[0] eq "AnyEvent::MPV" |
411 | and $reply->{args}[0] eq "AnyEvent::MPV" |
| 407 | ) { |
412 | ) { |
| 408 | if ($reply->{args}[1] eq "key") { |
413 | if ($reply->{args}[1] eq "key") { |
| 409 | (my $key = $reply->{args}[2]) =~ s/\\x(..)/chr hex $1/ge; |
414 | (my $key = $reply->{args}[2]) =~ s/\\x(..)/chr hex $1/ge; |
| 410 | $self->on_key ($key); |
415 | $self->on_key ($key); |
| 411 | } |
416 | } |
|
|
417 | } elsif ( |
|
|
418 | $event eq "property-change" |
|
|
419 | and OBSID <= $reply->{id} |
|
|
420 | ) { |
|
|
421 | if (my $cb = $self->{obscb}{$reply->{id}}) { |
|
|
422 | $cb->($self, $event, $reply->{data}); |
|
|
423 | } |
| 412 | } else { |
424 | } else { |
|
|
425 | if (my $cbs = $self->{evtcb}{$event}) { |
|
|
426 | for my $evtid (keys %$cbs) { |
|
|
427 | my $cb = $cbs->{$evtid} |
|
|
428 | or next; |
|
|
429 | $cb->($self, $event, $reply); |
|
|
430 | } |
|
|
431 | } |
|
|
432 | |
| 413 | $self->on_event (delete $reply->{event}, $reply); |
433 | $self->on_event ($event, $reply); |
| 414 | } |
434 | } |
| 415 | } elsif (exists $reply->{request_id}) { |
435 | } elsif (exists $reply->{request_id}) { |
| 416 | my $cv = delete $self->{cmd_cv}{$reply->{request_id}}; |
436 | my $cv = delete $self->{cmdcv}{$reply->{request_id}}; |
| 417 | |
437 | |
| 418 | unless ($cv) { |
438 | unless ($cv) { |
| 419 | warn "no cv found for request id <$reply->{request_id}>\n"; |
439 | warn "no cv found for request id <$reply->{request_id}>\n"; |
| 420 | next; |
440 | next; |
| 421 | } |
441 | } |
| … | |
… | |
| 447 | my $reqid; |
467 | my $reqid; |
| 448 | |
468 | |
| 449 | $self->{_cmd} = sub { |
469 | $self->{_cmd} = sub { |
| 450 | my $cv = AE::cv; |
470 | my $cv = AE::cv; |
| 451 | |
471 | |
| 452 | $self->{cmd_cv}{++$reqid} = $cv; |
472 | $self->{cmdcv}{++$reqid} = $cv; |
| 453 | |
473 | |
| 454 | my $cmd = $JSON->new->utf8->encode ({ command => ref $_[0] ? $_[0] : \@_, request_id => $reqid*1 }); |
474 | my $cmd = $JSON_ENCODER->encode ({ command => ref $_[0] ? $_[0] : \@_, request_id => $reqid*1 }); |
| 455 | |
475 | |
| 456 | # (un-)apply escape_binary hack |
476 | # (un-)apply escape_binary hack |
| 457 | $cmd =~ s/\xf4\x8e\x97\x9f(..)/sprintf sprintf "\\x%02x", hex $1/ges; # f48e979f == 10e5df in utf-8 |
477 | $cmd =~ s/\xf4\x8e\x97\x9f(..)/sprintf sprintf "\\x%02x", hex $1/ges; # f48e979f == 10e5df in utf-8 |
| 458 | |
478 | |
|
|
479 | $trace->(">mpv" => $cmd); |
|
|
480 | |
| 459 | $wbuf .= "$cmd\n"; |
481 | $wbuf .= "$cmd\n"; |
| 460 | |
|
|
| 461 | $trace->(">mpv" => "$_[0]"); |
|
|
| 462 | |
482 | |
| 463 | $self->{ww} ||= AE::io $fh, 1, sub { |
483 | $self->{ww} ||= AE::io $fh, 1, sub { |
| 464 | my $len = syswrite $fh, $wbuf; |
484 | my $len = syswrite $fh, $wbuf; |
| 465 | substr $wbuf, 0, $len, ""; |
485 | substr $wbuf, 0, $len, ""; |
| 466 | undef $self->{ww} unless length $wbuf; |
486 | undef $self->{ww} unless length $wbuf; |
| … | |
… | |
| 496 | kill TERM => $self->{pid}; |
516 | kill TERM => $self->{pid}; |
| 497 | |
517 | |
| 498 | } |
518 | } |
| 499 | |
519 | |
| 500 | delete $self->{pid}; |
520 | delete $self->{pid}; |
| 501 | delete $self->{cmd_cv}; |
521 | delete $self->{cmdcv}; |
|
|
522 | delete $self->{evtid}; |
|
|
523 | delete $self->{evtcb}; |
| 502 | delete $self->{obsid}; |
524 | delete $self->{obsid}; |
|
|
525 | delete $self->{obscb}; |
| 503 | delete $self->{wbuf}; |
526 | delete $self->{wbuf}; |
| 504 | } |
527 | } |
| 505 | |
528 | |
| 506 | =item $mpv->on_eof |
529 | =item $mpv->on_eof |
| 507 | |
530 | |
| … | |
… | |
| 618 | &cmd->recv |
641 | &cmd->recv |
| 619 | } |
642 | } |
| 620 | |
643 | |
| 621 | =item $mpv->bind_key ($INPUT => $string) |
644 | =item $mpv->bind_key ($INPUT => $string) |
| 622 | |
645 | |
| 623 | This is an extension implement by this module to make it easy to get key events. The way this is implemented |
646 | This is an extension implement by this module to make it easy to get key |
| 624 | is to bind a C<client-message> witha first argument of C<AnyEvent::MPV> and the C<$string> you passed. This C<$string> is then |
647 | events. The way this is implemented is to bind a C<client-message> witha |
| 625 | passed ot the C<on_key> handle when the key is proessed, e.g.: |
648 | first argument of C<AnyEvent::MPV> and the C<$string> you passed. This |
|
|
649 | C<$string> is then passed to the C<on_key> handle when the key is |
|
|
650 | proessed, e.g.: |
| 626 | |
651 | |
| 627 | my $mpv = AnyEvent::MPV->new ( |
652 | my $mpv = AnyEvent::MPV->new ( |
| 628 | on_key => sub { |
653 | on_key => sub { |
| 629 | my ($mpv, $key) = @_; |
654 | my ($mpv, $key) = @_; |
| 630 | |
655 | |
| … | |
… | |
| 634 | }, |
659 | }, |
| 635 | ); |
660 | ); |
| 636 | |
661 | |
| 637 | $mpv_>bind_key (ESC => "letmeout"); |
662 | $mpv_>bind_key (ESC => "letmeout"); |
| 638 | |
663 | |
|
|
664 | You cna find a list of key names L<in the mpv |
|
|
665 | documentation|https://mpv.io/manual/stable/#key-names>. |
|
|
666 | |
| 639 | The key configuration is lost when F<mpv> is stopped and must be (re-)done |
667 | The key configuration is lost when F<mpv> is stopped and must be (re-)done |
| 640 | after every C<start>. |
668 | after every C<start>. |
| 641 | |
669 | |
| 642 | =cut |
670 | =cut |
| 643 | |
671 | |
| 644 | sub bind_key { |
672 | sub bind_key { |
| 645 | my ($self, $key, $event) = @_; |
673 | my ($self, $key, $event) = @_; |
| 646 | |
674 | |
| 647 | $event =~ s/([^A-Za-z0-9\-_])/sprintf "\\x%02x", ord $1/ge; |
675 | $event =~ s/([^A-Za-z0-9\-_])/sprintf "\\x%02x", ord $1/ge; |
| 648 | $self->cmd (keybind => $key => "no-osd script-message AnyEvent::MPV key $event"); |
676 | $self->cmd (keybind => $key => "no-osd script-message AnyEvent::MPV key $event"); |
|
|
677 | } |
|
|
678 | |
|
|
679 | =item [$guard] = $mpv->register_event ($event => $coderef->($mpv, $event, $data)) |
|
|
680 | |
|
|
681 | This method registers a callback to be invoked for a specific |
|
|
682 | event. Whenever the event occurs, it calls the coderef with the C<$mpv> |
|
|
683 | object, the C<$event> name and the event object, just like the C<on_event> |
|
|
684 | method. |
|
|
685 | |
|
|
686 | For a lst of events, see L<the mpv |
|
|
687 | documentation|https://mpv.io/manual/stable/#list-of-events>. Any |
|
|
688 | underscore in the event name is replaced by a minus sign, so you can |
|
|
689 | specify event names using underscores for easier quoting in Perl. |
|
|
690 | |
|
|
691 | In void context, the handler stays registered until C<stop> is called. In |
|
|
692 | any other context, it returns a guard object that, when destroyed, will |
|
|
693 | unregister the handler. |
|
|
694 | |
|
|
695 | You can register multiple handlers for the same event, and this method |
|
|
696 | does not interfere with the C<on_event> mechanism. That is, you can |
|
|
697 | completely ignore this method and handle events in a C<on_event> handler, |
|
|
698 | or mix both approaches as you see fit. |
|
|
699 | |
|
|
700 | Note that unlike commands, event handlers are registered immediately, that |
|
|
701 | is, you can issue a command, then register an event handler and then get |
|
|
702 | an event for this handler I<before> the command is even sent to F<mpv>. If |
|
|
703 | this kind of race is an issue, you can issue a dummy command such as |
|
|
704 | C<get_version> and register the handler when the reply is received. |
|
|
705 | |
|
|
706 | =cut |
|
|
707 | |
|
|
708 | sub AnyEvent::MPV::Unevent::DESTROY { |
|
|
709 | my ($evtcb, $event, $evtid) = @{$_[0]}; |
|
|
710 | delete $evtcb->{$event}{$evtid}; |
|
|
711 | } |
|
|
712 | |
|
|
713 | sub register_event { |
|
|
714 | my ($self, $event, $cb) = @_; |
|
|
715 | |
|
|
716 | $event =~ y/_/-/; |
|
|
717 | |
|
|
718 | my $evtid = ++$self->{evtid}; |
|
|
719 | $self->{evtcb}{$event}{$evtid} = $cb; |
|
|
720 | |
|
|
721 | defined wantarray |
|
|
722 | and bless [$self->{evtcb}, $event, $evtid], AnyEvent::MPV::Unevent:: |
|
|
723 | } |
|
|
724 | |
|
|
725 | =item [$guard] = $mpv->observe_property ($name => $coderef->($mpv, $name, $value)) |
|
|
726 | |
|
|
727 | =item [$guard] = $mpv->observe_property_string ($name => $coderef->($mpv, $name, $value)) |
|
|
728 | |
|
|
729 | These methods wrap a registry system around F<mpv>'s C<observe_property> |
|
|
730 | and C<observe_property_string> commands - every time the named property |
|
|
731 | changes, the coderef is invoked with the C<$mpv> object, the name of the |
|
|
732 | property and the new value. |
|
|
733 | |
|
|
734 | For a list of properties that you can observe, see L<the mpv |
|
|
735 | documentation|https://mpv.io/manual/stable/#property-list>. |
|
|
736 | |
|
|
737 | Due to the (sane :) way F<mpv> handles these requests, you will always |
|
|
738 | get a property cxhange event right after registering an observer (meaning |
|
|
739 | you don't have to query the current value), and it is also possible to |
|
|
740 | register multiple observers for the same property - they will all be |
|
|
741 | handled properly. |
|
|
742 | |
|
|
743 | When called in void context, the observer stays in place until F<mpv> |
|
|
744 | is stopped. In any otrher context, these methods return a guard |
|
|
745 | object that, when it goes out of scope, unregisters the observe using |
|
|
746 | C<unobserve_property>. |
|
|
747 | |
|
|
748 | Internally, this method uses observer ids of 2**52 (0x10000000000000) or |
|
|
749 | higher - it will not interfere with lower ovserver ids, so it is possible |
|
|
750 | to completely ignore this system and execute C<observe_property> commands |
|
|
751 | yourself, whilst listening to C<property-change> events - as long as your |
|
|
752 | ids stay below 2**52. |
|
|
753 | |
|
|
754 | Example: register observers for changtes in C<aid> and C<sid>. Note that |
|
|
755 | a dummy statement is added to make sure the method is called in void |
|
|
756 | context. |
|
|
757 | |
|
|
758 | sub register_observers { |
|
|
759 | my ($mpv) = @_; |
|
|
760 | |
|
|
761 | $mpv->observe_property (aid => sub { |
|
|
762 | my ($mpv, $name, $value) = @_; |
|
|
763 | print "property aid (=$name) has changed to $value\n"; |
|
|
764 | }); |
|
|
765 | |
|
|
766 | $mpv->observe_property (sid => sub { |
|
|
767 | my ($mpv, $name, $value) = @_; |
|
|
768 | print "property sid (=$name) has changed to $value\n"; |
|
|
769 | }); |
|
|
770 | |
|
|
771 | () # ensure the above method is called in void context |
|
|
772 | } |
|
|
773 | |
|
|
774 | =cut |
|
|
775 | |
|
|
776 | sub AnyEvent::MPV::Unobserve::DESTROY { |
|
|
777 | my ($mpv, $obscb, $obsid) = @{$_[0]}; |
|
|
778 | |
|
|
779 | delete $obscb->{$obsid}; |
|
|
780 | |
|
|
781 | if ($obscb == $mpv->{obscb}) { |
|
|
782 | $mpv->cmd (unobserve_property => $obsid+0); |
|
|
783 | } |
|
|
784 | } |
|
|
785 | |
|
|
786 | sub _observe_property { |
|
|
787 | my ($self, $type, $property, $cb) = @_; |
|
|
788 | |
|
|
789 | my $obsid = OBSID + ++$self->{obsid}; |
|
|
790 | $self->cmd ($type => $obsid+0, $property); |
|
|
791 | $self->{obscb}{$obsid} = $cb; |
|
|
792 | |
|
|
793 | defined wantarray and do { |
|
|
794 | my $unobserve = bless [$self, $self->{obscb}, $obsid], AnyEvent::MPV::Unobserve::; |
|
|
795 | Scalar::Util::weaken $unobserve->[0]; |
|
|
796 | $unobserve |
|
|
797 | } |
|
|
798 | } |
|
|
799 | |
|
|
800 | sub observe_property { |
|
|
801 | my ($self, $property, $cb) = @_; |
|
|
802 | |
|
|
803 | $self->_observe_property (observe_property => $property, $cb) |
|
|
804 | } |
|
|
805 | |
|
|
806 | sub observe_property_string { |
|
|
807 | my ($self, $property, $cb) = @_; |
|
|
808 | |
|
|
809 | $self->_observe_property (observe_property_string => $property, $cb) |
| 649 | } |
810 | } |
| 650 | |
811 | |
| 651 | =back |
812 | =back |
| 652 | |
813 | |
| 653 | =head2 SUBCLASSING |
814 | =head2 SUBCLASSING |
