path: root/emms-player-vlc.el

;;; emms-player-vlc.el --- vlc support for EMMS  -*- lexical-binding: t; -*-

;; Copyright (C) 2008-2021  Free Software Foundation, Inc.

;; Authors: Yoni Rabkin <yrk@gnu.org>

;; This file is part of EMMS.

;; EMMS is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public License
;; as published by the Free Software Foundation; either version 3
;; of the License, or (at your option) any later version.

;; EMMS is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with EMMS; if not, write to the Free Software Foundation,
;; Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.

;;; Commentary:

;;; Code:

(require 'emms-compat)
(require 'emms-player-simple)

;; I use this macro, and later override some of the stuff it defines
;; in order to accomodate VLC's particular idioms.
(define-emms-simple-player vlc '(file url)
  (concat "\\`\\(http[s]?\\|mms\\)://\\|"
	  (apply #'emms-player-simple-regexp
		 emms-player-base-format-list))
  "vlc" "--intf=rc")

(define-emms-simple-player vlc-playlist '(streamlist)
  "\\`http[s]?://"
  "vlc" "--intf=rc")

;; (kludge) By default, VLC does not quit after finishing to play a
;; track, so the player sentinel has no way of telling that the next
;; track should be played. Therefore I redefine this low-level
;; function and add a "quit" track which is invisible to Emms.
(advice-add 'emms-player-vlc-start :override #'emms--vlc-quit-after-finish)
(defun emms--vlc-quit-after-finish (track &rest _)
  (let ((process (apply #'start-process
                        emms-player-simple-process-name
                        nil
                        emms-player-vlc-command-name
                        ;; splice in params here
                        (append emms-player-vlc-parameters
                                (list (emms-track-name track))
                                '("vlc://quit")))))
    ;; Add a sentinel for signaling termination.
    (set-process-sentinel process #'emms-player-simple-sentinel))
  (emms-player-started emms-player-vlc))

(defun emms-player-vlc-pause ()
  "Depends on vlc's rc mode."
  (process-send-string
   emms-player-simple-process-name "pause\n"))

(defun emms-player-vlc-seek (sec)
  "Seek relative within a stream."
  (when (not (= 0 sec))
    (process-send-string
     emms-player-simple-process-name
     (if (< 0 sec) "fastforward\n" "rewind\n"))))

(defun emms-player-vlc-seek-to (sec)
  "Seek to time SEC within the stream."
  (process-send-string
   emms-player-simple-process-name
   (format "seek %d\n" sec)))

(emms-player-set emms-player-vlc 'pause 'emms-player-vlc-pause)
(emms-player-set emms-player-vlc 'resume nil) ; pause is also resume
(emms-player-set emms-player-vlc 'start 'emms-player-vlc-start)
(emms-player-set emms-player-vlc 'seek 'emms-player-vlc-seek)
(emms-player-set emms-player-vlc 'seek-to 'emms-player-vlc-seek-to)

(provide 'emms-player-vlc)

;;; emms-player-vlc.el ends here