playlist.c

/*
 * Gjay - Gtk+ DJ music playlist creator
 * Copyright (C) 2002 Chuck Groom
 * Copyright (C) 2010-2015 Craig Small
 *
 * This program 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 2, or (at
 * your option) any later version.
 *
 * This program 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 this program; if not, see <http://www.gnu.org/licenses/>.
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include <stdlib.h>
#include <math.h>
#include <unistd.h>
#include <string.h>
#include <time.h>
#include "gjay.h"
#include "analysis.h"
#include "playlist.h"
#include "i18n.h"
#ifdef WITH_GUI
#include "ui.h"
#endif /* WITH_GUI */

static GjaySong * current;
static GjaySong * first;
static void remove_repeats   ( GjaySong * s, GList * list);

/* How much does brightness factor into matching two songs? */
#define BRIGHTNESS_FACTOR .8

#define PATH_DIST_FACTOR 0.5

/**
 * Generate a playlist (list of song *) no longer than the specified
 * time, in minutes
 */
GList * generate_playlist (GjayApp *gjay, const guint minutes ) {
    GList * working, * final, * rand_list, * list;
    gint i, list_time, l, r, max_force_index, len;
    gdouble max_force, s_force;
    GjaySong * s;
    time_t t=0;

    list_time = 0;

    if (gjay->verbosity)
        t = time(NULL);

    if (!g_list_length(gjay->songs->songs))
        return NULL;

    /* Create a working set, a copy of the songs list */
    if (gjay->prefs->use_selected_songs)
        working = g_list_copy(gjay->selected_songs);
    else
        working = g_list_copy(gjay->songs->songs);

    final = NULL;
    for (list = g_list_first(working); list; ) {
        current = SONG(list);
        /* OK, hold your breath. We exclude songs which:
         * 1. Are not in the current file tree
         * 2. Are no longer present
         * 3. Are below the rating cutoff, if applied by the user
         * 4. Are not in the currently selected directory, if the user
         *    specified that s/he wanted to limit the playlist to the
         *    current dir. */
        if ((!current->in_tree) ||
            (!current->access_ok) ||
            (gjay->prefs->use_ratings && gjay->prefs->rating_cutoff &&
             (current->rating < gjay->prefs->rating)) ||
            (gjay->prefs->use_selected_dir &&
             gjay->selected_files &&
             (strncmp((char *) gjay->selected_files->data, current->path,
                      strlen((char *) gjay->selected_files->data)) != 0))) {
            if (g_list_next(list))
                list = g_list_next(list);
            else
                list = g_list_previous(list);
            working = g_list_remove(working, current);
        } else {
            list = g_list_next(list);
        }
    }

    if (!working) {
        g_warning(_("No songs to create playlist from"));
        return NULL;
    }
    if (gjay->verbosity > 2)
	  printf(_("Working set is %d songs long.\n"), g_list_length(working));

    /* Pick the first song */
    first = NULL;
    if (gjay->prefs->start_selected) {
        for (list = g_list_first(working); list && !first;
             list = g_list_next(list)) {
            if (strncmp((char *) gjay->selected_files->data, SONG(list)->path,
                        strlen((char *) gjay->selected_files->data)) == 0)
                first = SONG(list);
        }
        if (!first) {
            gchar * latin1;
            latin1 = strdup_to_latin1((char *) gjay->selected_files->data);
            fprintf(stderr, _(
                  "File '%s' not found in data file;\n"
                  "perhaps it has not been analyzed. Using random starting song.\n"),
                    latin1);
            g_free(latin1);
        }
    }
    if (gjay->prefs->use_color) {
        GjaySong temp_song;
        bzero(&temp_song, sizeof(GjaySong));
        temp_song.no_data = TRUE;
        temp_song.no_rating = TRUE;
        temp_song.color = gjay->prefs->start_color;
        for (max_force = -1000, list = g_list_first(working);
             list;
             list = g_list_next(list)) {
            s = SONG(list);
            s_force = song_force(gjay, &temp_song, s, gjay->tree_depth);
            if (s_force > max_force) {
                max_force = s_force;
                first = s;
            }
        }
    }
    if (!first) {
        /* Pick random starting song */
        i = rand() % g_list_length(working);
        first = SONG(g_list_nth(working, i));
    }

    final = g_list_append(final, first);
    working = g_list_remove (working, first);
    current = first;

    /* If the song had any duplicates (symlinks) in the working
     * list, remove them from the working list, too */
    remove_repeats(current, working);

    /* Regretably, we must winnow the working set to something reasonable.
       If there were 10,000 songs, this would take ~20 seconds on a fast
       machine. */
    for (len = g_list_length(working); len > gjay->prefs->max_working_set; len--) {
        s = SONG(g_list_nth(working, rand() % len));
        working = g_list_remove(working, s);
    }


    /* Pick the rest of the songs */
    while (working && (list_time < minutes * 60)) {
        /* Divide working list into { random set, leftover }. Then
         * pick the best song in random set. */
        rand_list = NULL;
        max_force = -10000;
        max_force_index = -1;
        l = g_list_length(working);
        r = MAX(1, (l * gjay->prefs->variance) / MAX_CRITERIA );
        /* Reduce copy of working to size of random list */
        len = g_list_length(working);
        while(r--) {
            s = SONG(g_list_nth(working, rand() % len));
            working = g_list_remove(working, s);
            rand_list = g_list_append(rand_list, s);
            len--;
            /* Find the closest song */
            if (gjay->prefs->wander)
                s_force = song_force(gjay, s, current, gjay->tree_depth);
            else
                s_force = song_force(gjay, s, first, gjay->tree_depth);

            if (s_force > max_force) {
                max_force = s_force;
                max_force_index = g_list_length(rand_list) - 1;
            }
        }
        current = SONG(g_list_nth(rand_list, max_force_index));
        list_time += current->length;
        final = g_list_append(final, current);
        rand_list = g_list_remove(rand_list, current);
        working = g_list_concat(working, rand_list);

       /* If the song had any duplicates (symlinks) in the working
        * list, remove them from the working list, too */
        remove_repeats(current, working);
    }
    if (final && (list_time > minutes * 60)) {
        list_time -= SONG(g_list_last(final))->length;
        final = g_list_remove(final, SONG(g_list_last(final)));
    }

    g_list_free(working);

    if (gjay->verbosity)
        printf(_("It took %d seconds to generate playlist\n"),
               (int) (time(NULL) - t));

    return final;
}


void save_playlist ( GList * list, gchar * fname ) {
    FILE * f;
    f = fopen(fname, "w");
    if (!f) {
        g_warning(_("Sorry, cannot write playlist to '%s'."), fname);
        return;
    }
    write_playlist(list, f, TRUE);
    fclose(f);
}


void write_playlist ( GList * list, FILE * f, gboolean m3u_format) {
    GjaySong * s;
    gchar * l1_artist, * l1_title, * l1_path, * l1_fname;

    if (m3u_format)
        fprintf(f, "#EXTM3U\n");
    for (; list; list = g_list_next(list)) {
        s = SONG(list);
        if (m3u_format) {
            if (s->title) {
                l1_artist = strdup_to_latin1(s->artist);
                l1_title = strdup_to_latin1(s->title);

                fprintf(f, "#EXTINF:%d,%s - %s\n",
                        s->length,
                        l1_artist,
                        l1_title);
                g_free(l1_artist);
                g_free(l1_title);
            } else {
                l1_fname = strdup_to_latin1(s->fname);
                fprintf(f, "#EXTINF:%d,%s\n",
                        s->length,
                        l1_fname);
                g_free(l1_fname);
            }
        }
        l1_path = strdup_to_latin1(s->path);
        fprintf(f, "%s\n", l1_path);
        g_free(l1_path);
    }
}


static void remove_repeats ( GjaySong * s, GList * list) {
    GjaySong * repeat;
    for (repeat = s->repeat_prev; repeat;
         repeat = repeat->repeat_prev) {
        list = g_list_remove(list, repeat);
    }
    for (repeat = s->repeat_next; repeat;
         repeat = repeat->repeat_next) {
        list = g_list_remove(list, repeat);
    }
}