xref: /dports/audio/easytag/easytag-2.4.3/src/file_tag.c

/* EasyTAG - tag editor for audio files
 * Copyright (C) 2014,2015  David King <amigadave@amigadave.com>
 *
 * 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 of the License, 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, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

#include "file_tag.h"

#include "misc.h"

/*
 * Create a new File_Tag structure.
 */
File_Tag *
et_file_tag_new (void)
{
    File_Tag *file_tag;

    file_tag = g_slice_new0 (File_Tag);
    file_tag->key = et_undo_key_new ();

    return file_tag;
}

/*
 * Frees the list of 'other' field in a File_Tag item (contains attached gchar data).
 */
static void
et_file_tag_free_other_field (File_Tag *file_tag)
{
    g_list_free_full (file_tag->other, g_free);
    file_tag->other = NULL;
}


/*
 * Frees a File_Tag item.
 */
void
et_file_tag_free (File_Tag *FileTag)
{
    g_return_if_fail (FileTag != NULL);

    g_free(FileTag->title);
    g_free(FileTag->artist);
    g_free(FileTag->album_artist);
    g_free(FileTag->album);
    g_free(FileTag->disc_number);
    g_free (FileTag->disc_total);
    g_free(FileTag->year);
    g_free(FileTag->track);
    g_free(FileTag->track_total);
    g_free(FileTag->genre);
    g_free(FileTag->comment);
    g_free(FileTag->composer);
    g_free(FileTag->orig_artist);
    g_free(FileTag->copyright);
    g_free(FileTag->url);
    g_free(FileTag->encoded_by);
    et_file_tag_set_picture (FileTag, NULL);
    et_file_tag_free_other_field (FileTag);

    g_slice_free (File_Tag, FileTag);
}

/*
 * Duplicate the 'other' list, preserving the list already in @destination.
 */
void
et_file_tag_copy_other_into (File_Tag *destination,
                             const File_Tag *source)
{
    GList *l;
    GList *new_other = NULL;

    for (l = source->other; l != NULL; l = g_list_next (l))
    {
        new_other = g_list_prepend (new_other, g_strdup ((gchar *)l->data));
    }

    new_other = g_list_reverse (new_other);
    destination->other = g_list_concat (destination->other, new_other);
}


/*
 * Copy data of the File_Tag structure (of ETFile) to the FileTag item.
 * Reallocate data if not null.
 */
void
et_file_tag_copy_into (File_Tag *destination,
                       const File_Tag *source)
{
    g_return_if_fail (source != NULL);
    g_return_if_fail (destination != NULL);

    /* Key for the item, may be overwritten. */
    destination->key = et_undo_key_new ();

    et_file_tag_set_title (destination, source->title);
    et_file_tag_set_artist (destination, source->artist);
    et_file_tag_set_album_artist (destination, source->album_artist);
    et_file_tag_set_album (destination, source->album);
    et_file_tag_set_disc_number (destination, source->disc_number);
    et_file_tag_set_disc_total (destination, source->disc_total);
    et_file_tag_set_year (destination, source->year);
    et_file_tag_set_track_number (destination, source->track);
    et_file_tag_set_track_total (destination, source->track_total);
    et_file_tag_set_genre (destination, source->genre);
    et_file_tag_set_comment (destination, source->comment);
    et_file_tag_set_composer (destination, source->composer);
    et_file_tag_set_orig_artist (destination, source->orig_artist);
    et_file_tag_set_copyright (destination, source->copyright);
    et_file_tag_set_url (destination, source->url);
    et_file_tag_set_encoded_by (destination, source->encoded_by);
    et_file_tag_set_picture (destination, source->picture);

    if (source->other)
    {
        et_file_tag_copy_other_into (destination, source);
    }
    else
    {
        et_file_tag_free_other_field (destination);
    }
}

/*
 * Set the value of a field of a FileTag item (for ex, value of FileTag->title)
 * Must be used only for the 'gchar *' components
 */
static void
et_file_tag_set_field (gchar **FileTagField,
                       const gchar *value)
{
    g_return_if_fail (FileTagField != NULL);

    if (*FileTagField != NULL)
    {
        g_free (*FileTagField);
        *FileTagField = NULL;
    }

    if (value != NULL)
    {
        if (*value != '\0')
        {
            *FileTagField = g_strdup (value);
        }
    }
}

void
et_file_tag_set_title (File_Tag *file_tag,
                       const gchar *title)
{
    g_return_if_fail (file_tag != NULL);

    et_file_tag_set_field (&file_tag->title, title);
}

void
et_file_tag_set_artist (File_Tag *file_tag,
                        const gchar *artist)
{
    g_return_if_fail (file_tag != NULL);

    et_file_tag_set_field (&file_tag->artist, artist);
}

void
et_file_tag_set_album_artist (File_Tag *file_tag,
                              const gchar *album_artist)
{
    g_return_if_fail (file_tag != NULL);

    et_file_tag_set_field (&file_tag->album_artist, album_artist);
}

void
et_file_tag_set_album (File_Tag *file_tag,
                       const gchar *album)
{
    g_return_if_fail (file_tag != NULL);

    et_file_tag_set_field (&file_tag->album, album);
}

void
et_file_tag_set_disc_number (File_Tag *file_tag,
                             const gchar *disc_number)
{
    g_return_if_fail (file_tag != NULL);

    et_file_tag_set_field (&file_tag->disc_number, disc_number);
}

void
et_file_tag_set_disc_total (File_Tag *file_tag,
                            const gchar *disc_total)
{
    g_return_if_fail (file_tag != NULL);

    et_file_tag_set_field (&file_tag->disc_total, disc_total);
}

void
et_file_tag_set_year (File_Tag *file_tag,
                      const gchar *year)
{
    g_return_if_fail (file_tag != NULL);

    et_file_tag_set_field (&file_tag->year, year);
}

void
et_file_tag_set_track_number (File_Tag *file_tag,
                              const gchar *track_number)
{
    g_return_if_fail (file_tag != NULL);

    et_file_tag_set_field (&file_tag->track, track_number);
}

void
et_file_tag_set_track_total (File_Tag *file_tag,
                             const gchar *track_total)
{
    g_return_if_fail (file_tag != NULL);

    et_file_tag_set_field (&file_tag->track_total, track_total);
}

void
et_file_tag_set_genre (File_Tag *file_tag,
                       const gchar *genre)
{
    g_return_if_fail (file_tag != NULL);

    et_file_tag_set_field (&file_tag->genre, genre);
}

void
et_file_tag_set_comment (File_Tag *file_tag,
                         const gchar *comment)
{
    g_return_if_fail (file_tag != NULL);

    et_file_tag_set_field (&file_tag->comment, comment);
}

void
et_file_tag_set_composer (File_Tag *file_tag,
                          const gchar *composer)
{
    g_return_if_fail (file_tag != NULL);

    et_file_tag_set_field (&file_tag->composer, composer);
}

void
et_file_tag_set_orig_artist (File_Tag *file_tag,
                             const gchar *orig_artist)
{
    g_return_if_fail (file_tag != NULL);

    et_file_tag_set_field (&file_tag->orig_artist, orig_artist);
}

void
et_file_tag_set_copyright (File_Tag *file_tag,
                           const gchar *copyright)
{
    g_return_if_fail (file_tag != NULL);

    et_file_tag_set_field (&file_tag->copyright, copyright);
}

void
et_file_tag_set_url (File_Tag *file_tag,
                     const gchar *url)
{
    g_return_if_fail (file_tag != NULL);

    et_file_tag_set_field (&file_tag->url, url);
}

void
et_file_tag_set_encoded_by (File_Tag *file_tag,
                            const gchar *encoded_by)
{
    g_return_if_fail (file_tag != NULL);

    et_file_tag_set_field (&file_tag->encoded_by, encoded_by);
}

/*
 * et_file_tag_set_picture:
 * @file_tag: the #File_Tag on which to set the image
 * @pic: the image to set
 *
 * Set the images inside @file_tag to be @pic, freeing existing images as
 * necessary. Copies @pic with et_picture_copy_all().
 */
void
et_file_tag_set_picture (File_Tag *file_tag,
                         const EtPicture *pic)
{
    g_return_if_fail (file_tag != NULL);

    if (file_tag->picture != NULL)
    {
        et_picture_free (file_tag->picture);
        file_tag->picture = NULL;
    }

    if (pic)
    {
        file_tag->picture = et_picture_copy_all (pic);
    }
}

/*
 * Compares two File_Tag items and returns TRUE if there aren't the same.
 * Notes:
 *  - if field is '' or NULL => will be removed
 */
gboolean
et_file_tag_detect_difference (const File_Tag *FileTag1,
                               const File_Tag *FileTag2)
{
    const EtPicture *pic1;
    const EtPicture *pic2;

    g_return_val_if_fail (FileTag1 != NULL && FileTag2 != NULL, FALSE);

    if ( ( FileTag1 && !FileTag2)
      || (!FileTag1 &&  FileTag2) )
        return TRUE;

    /* Title */
    if (et_normalized_strcmp0 (FileTag1->title, FileTag2->title) != 0)
    {
        return TRUE;
    }

    /* Artist */
    if (et_normalized_strcmp0 (FileTag1->artist, FileTag2->artist) != 0)
    {
        return TRUE;
    }

	/* Album Artist */
    if (et_normalized_strcmp0 (FileTag1->album_artist,
                               FileTag2->album_artist) != 0)
    {
        return TRUE;
    }

    /* Album */
    if (et_normalized_strcmp0 (FileTag1->album, FileTag2->album) != 0)
    {
        return TRUE;
    }

    /* Disc Number */
    if (et_normalized_strcmp0 (FileTag1->disc_number,
                               FileTag2->disc_number) != 0)
    {
        return TRUE;
    }

    /* Discs Total */
    if (et_normalized_strcmp0 (FileTag1->disc_total,
                               FileTag2->disc_total) != 0)
    {
        return TRUE;
    }

    /* Year */
    if (et_normalized_strcmp0 (FileTag1->year, FileTag2->year) != 0)
    {
        return TRUE;
    }

    /* Track */
    if (et_normalized_strcmp0 (FileTag1->track, FileTag2->track) != 0)
    {
        return TRUE;
    }

    /* Track Total */
    if (et_normalized_strcmp0 (FileTag1->track_total,
                               FileTag2->track_total) != 0)
    {
        return TRUE;
    }

    /* Genre */
    if (et_normalized_strcmp0 (FileTag1->genre, FileTag2->genre) != 0)
    {
        return TRUE;
    }

    /* Comment */
    if (et_normalized_strcmp0 (FileTag1->comment, FileTag2->comment) != 0)
    {
        return TRUE;
    }

    /* Composer */
    if (et_normalized_strcmp0 (FileTag1->composer, FileTag2->composer) != 0)
    {
        return TRUE;
    }

    /* Original artist */
    if (et_normalized_strcmp0 (FileTag1->orig_artist,
                               FileTag2->orig_artist) != 0)
    {
        return TRUE;
    }

    /* Copyright */
    if (et_normalized_strcmp0 (FileTag1->copyright, FileTag2->copyright) != 0)
    {
        return TRUE;
    }

    /* URL */
    if (et_normalized_strcmp0 (FileTag1->url, FileTag2->url) != 0)
    {
        return TRUE;
    }

    /* Encoded by */
    if (et_normalized_strcmp0 (FileTag1->encoded_by,
                               FileTag2->encoded_by) != 0)
    {
        return TRUE;
    }

    /* Picture */
    for (pic1 = FileTag1->picture, pic2 = FileTag2->picture;
         pic1 || pic2;
         pic1 = pic1->next, pic2 = pic2->next)
    {
        if (et_picture_detect_difference (pic1, pic2))
        {
            return TRUE;
        }
    }

    return FALSE; /* No changes */
}