path: root/emms-info.el

;;; emms-info.el --- Retrieving track information  -*- lexical-binding: t; -*-

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

;; Author: Jorgen Schaefer <forcer@forcix.cx>

;; 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:

;; This EMMS module provides a way to add information for a track.
;; This can use an ID3 or OGG comment like syntax.

;; The code will add info symbols to the track. The following symbols
;; are defined:

;; info-artist - string naming the artist
;; info-composer - string naming the composer
;; info-performer - string naming the performer
;; info-title - string naming the title of the song
;; info-album - string naming the album
;; info-tracknumber - string(?) naming the track number
;; info-discnumber - string naming the disc number
;; info-year - string naming the year
;; info-note - string of free-form entry
;; info-genre - string naming the genre
;; info-playing-time - number giving the seconds of playtime

;;; Code:

(require 'emms)
(require 'emms-later-do)

(defgroup emms-info nil
  "*Track information. ID3, OGG, etc."
  :group 'emms)

(defcustom emms-info-auto-update t
  "Non-nil when EMMS should update track information if the file changes.
This will cause hard drive activity on track loading. If this is
too annoying for you, set this variable to nil."
  :type 'boolean)

(defcustom emms-info-asynchronously t
  "Non-nil when track information should be loaded asynchronously."
  :type 'boolean)

(defcustom emms-info-report-each-num-tracks 200
  "Non-zero will report progress information every number of tracks.
The default is to display a message every 200 tracks.
This variable is only used when adding tracks asynchronously."
  :type 'integer)

(defcustom emms-info-functions nil
  "Functions which add information to tracks.
Each is called with a track as argument."
  :type 'hook)

(defvar emms-info-asynchronous-tracks 0
  "Number of tracks we're waiting for to be done.")

(defun emms-info-initialize-track (track &optional force)
  "Initialize TRACK with emms-info information.
Update TRACK information if it is new or has been modified since
last update, or if FORCE is non-nil.

This is a suitable value for `emms-track-initialize-functions'."
  (if (not emms-info-asynchronously)
      (emms-info-really-initialize-track track force)
    (setq emms-info-asynchronous-tracks (1+ emms-info-asynchronous-tracks))
    (emms-later-do 'emms-info-really-initialize-track track force)))

(defun emms-info-really-initialize-track (track &optional force)
  "Really initialize TRACK.
Return t when the track got changed."
  (let ((file-mtime (when emms-info-auto-update
                      (emms-info-track-file-mtime track)))
        (info-mtime (emms-track-get track 'info-mtime)))

    ;; if the file's been modified or is new
    (when (or (not file-mtime)
              (not info-mtime)
              (emms-time-less-p info-mtime file-mtime)
              force)
      (run-hook-with-args 'emms-info-functions track)
      ;; not set by info functions
      (when file-mtime
        (emms-track-set track 'info-mtime file-mtime))
      (emms-track-updated track))

    (when emms-info-asynchronously
      (setq emms-info-asynchronous-tracks (1- emms-info-asynchronous-tracks))
      (if (zerop emms-info-asynchronous-tracks)
          (message "EMMS: All track information loaded.")
        (unless (zerop emms-info-report-each-num-tracks)
          (if (zerop
               (mod emms-info-asynchronous-tracks
                    emms-info-report-each-num-tracks))
              (message "EMMS: %d tracks to go.."
                       emms-info-asynchronous-tracks)))))))

(defun emms-info-track-file-mtime (track)
  "Return the mtime of the file of TRACK, if any.
Return nil otherwise."
  (if (eq (emms-track-type track)
          'file)
      (nth 5 (file-attributes (emms-track-name track)))
    nil))

(defun emms-info-track-description (track)
  "Return a description of TRACK."
  (let ((artist (emms-track-get track 'info-artist))
        (title  (emms-track-get track 'info-title)))
    (cond
     ((and artist title)
      (concat artist " - " title))
     (title
      title)
     (t
      (emms-track-simple-description track)))))

(provide 'emms-info)
;;; emms-info.el ends here