Major audio format handler cleanups.
[paraslash.git] / aft.c
diff --git a/aft.c b/aft.c
index 3283dda..23b36a8 100644 (file)
--- a/aft.c
+++ b/aft.c
@@ -7,6 +7,7 @@
 /** \file aft.c Audio file table functions. */
 
 #include <dirent.h> /* readdir() */
+#include <osl.h>
 #include "para.h"
 #include "error.h"
 #include "string.h"
@@ -218,12 +219,27 @@ enum audio_file_table_columns {
        NUM_AFT_COLUMNS
 };
 
+/**
+ * Compare two osl objects pointing to hash values.
+ *
+ * \param obj1 Pointer to the first hash object.
+ * \param obj2 Pointer to the second hash object.
+ *
+ * \return The values required for an osl compare function.
+ *
+ * \sa osl_compare_func, uint32_compare().
+ */
+int aft_hash_compare(const struct osl_object *obj1, const struct osl_object *obj2)
+{
+       return hash_compare((HASH_TYPE *)obj1->data, (HASH_TYPE *)obj2->data);
+}
+
 static struct osl_column_description aft_cols[] = {
        [AFTCOL_HASH] = {
                .storage_type = OSL_MAPPED_STORAGE,
                .storage_flags = OSL_RBTREE | OSL_FIXED_SIZE | OSL_UNIQUE,
                .name = "hash",
-               .compare_function = osl_hash_compare,
+               .compare_function = aft_hash_compare,
                .data_size = HASH_SIZE
        },
        [AFTCOL_PATH] = {
@@ -336,23 +352,29 @@ enum afhi_offsets {
        CHUNK_TV_TV_USEC_OFFSET = 36,
        /** Number of channels is stored here. (1 byte) */
        AFHI_CHANNELS_OFFSET = 40,
-       /** EOF timeout in ms. (2 byte) */
-       AFHI_EOF_OFFSET = 41,
        /** The tag info position. */
-       AFHI_INFO_STRING_OFFSET = 43,
+       AFHI_INFO_STRING_OFFSET = 41,
        /** Minimal on-disk size of a valid afhi struct. */
-       MIN_AFHI_SIZE = 44
+       MIN_AFHI_SIZE = 47, /* at least 6 null bytes for techinfo/tags */
 };
 
 static unsigned sizeof_afhi_buf(const struct afh_info *afhi)
 {
        if (!afhi)
                return 0;
-       return strlen(afhi->info_string) + MIN_AFHI_SIZE;
+       return MIN_AFHI_SIZE
+               + strlen(afhi->techinfo)
+               + strlen(afhi->tags.artist)
+               + strlen(afhi->tags.title)
+               + strlen(afhi->tags.year)
+               + strlen(afhi->tags.album)
+               + strlen(afhi->tags.comment);
 }
 
 static void save_afhi(struct afh_info *afhi, char *buf)
 {
+       char *p;
+
        if (!afhi)
                return;
        write_u32(buf + AFHI_SECONDS_TOTAL_OFFSET, afhi->seconds_total);
@@ -366,8 +388,14 @@ static void save_afhi(struct afh_info *afhi, char *buf)
        write_u32(buf + HEADER_OFFSET_OFFSET, afhi->header_offset);
        write_u32(buf + CHUNK_TV_TV_SEC_OFFSET, afhi->chunk_tv.tv_sec);
        write_u32(buf + CHUNK_TV_TV_USEC_OFFSET, afhi->chunk_tv.tv_usec);
-       write_u16(buf + AFHI_EOF_OFFSET, tv2ms(&afhi->eof_tv));
-       strcpy(buf + AFHI_INFO_STRING_OFFSET, afhi->info_string); /* OK */
+       p = buf + AFHI_INFO_STRING_OFFSET;
+       /* The sprintf's below are OK as our caller made sure that buf is large enough */
+       p += sprintf(p, "%s", afhi->techinfo) + 1;
+       p += sprintf(p, "%s", afhi->tags.artist) + 1;
+       p += sprintf(p, "%s", afhi->tags.title) + 1;
+       p += sprintf(p, "%s", afhi->tags.year) + 1;
+       p += sprintf(p, "%s", afhi->tags.album) + 1;
+       sprintf(p, "%s", afhi->tags.comment);
 }
 
 static void load_afhi(const char *buf, struct afh_info *afhi)
@@ -383,8 +411,12 @@ static void load_afhi(const char *buf, struct afh_info *afhi)
        afhi->header_offset = read_u32(buf + HEADER_OFFSET_OFFSET);
        afhi->chunk_tv.tv_sec = read_u32(buf + CHUNK_TV_TV_SEC_OFFSET);
        afhi->chunk_tv.tv_usec = read_u32(buf + CHUNK_TV_TV_USEC_OFFSET);
-       ms2tv(read_u16(buf + AFHI_EOF_OFFSET), &afhi->eof_tv);
-       afhi->info_string = para_strdup(buf + AFHI_INFO_STRING_OFFSET);
+       afhi->techinfo = buf + AFHI_INFO_STRING_OFFSET;
+       afhi->tags.artist = afhi->techinfo + strlen(afhi->techinfo) + 1;
+       afhi->tags.title = afhi->tags.artist + strlen(afhi->tags.artist) + 1;
+       afhi->tags.year = afhi->tags.title + strlen(afhi->tags.title) + 1;
+       afhi->tags.album = afhi->tags.year + strlen(afhi->tags.year) + 1;
+       afhi->tags.comment = afhi->tags.album + strlen(afhi->tags.album) + 1;
 }
 
 static unsigned sizeof_chunk_table(struct afh_info *afhi)
@@ -417,27 +449,27 @@ static void load_chunk_table(struct afh_info *afhi, char *buf)
  * \param path The full path of the audio file.
  * \param row Result pointer.
  *
- * \return The return value of the underlying call to osl_get_row().
+ * \return Standard.
  */
 int aft_get_row_of_path(const char *path, struct osl_row **row)
 {
        struct osl_object obj = {.data = (char *)path, .size = strlen(path) + 1};
 
-       return osl_get_row(audio_file_table, AFTCOL_PATH, &obj, row);
+       return osl(osl_get_row(audio_file_table, AFTCOL_PATH, &obj, row));
 }
 
 /**
  * Get the row of the audio file table corresponding to the given hash value.
  *
  * \param hash The hash value of the desired audio file.
- * \param row resul pointer.
+ * \param row Result pointer.
  *
- * \return The return value of the underlying call to osl_get_row().
+ * \return Standard.
  */
 int aft_get_row_of_hash(HASH_TYPE *hash, struct osl_row **row)
 {
        const struct osl_object obj = {.data = hash, .size = HASH_SIZE};
-       return osl_get_row(audio_file_table, AFTCOL_HASH, &obj, row);
+       return osl(osl_get_row(audio_file_table, AFTCOL_HASH, &obj, row));
 }
 
 /**
@@ -446,11 +478,11 @@ int aft_get_row_of_hash(HASH_TYPE *hash, struct osl_row **row)
  * \param row Pointer to a row in the audio file table.
  * \param obj Result pointer.
  *
- * \return The return value of the underlying call to osl_get_object().
+ * \return Standard.
  */
 int get_afsi_object_of_row(const struct osl_row *row, struct osl_object *obj)
 {
-       return osl_get_object(audio_file_table, row, AFTCOL_AFSI, obj);
+       return osl(osl_get_object(audio_file_table, row, AFTCOL_AFSI, obj));
 }
 
 /**
@@ -519,8 +551,8 @@ int get_afsi_of_path(const char *path, struct afs_info *afsi)
 int get_audio_file_path_of_row(const struct osl_row *row, char **path)
 {
        struct osl_object path_obj;
-       int ret = osl_get_object(audio_file_table, row, AFTCOL_PATH,
-               &path_obj);
+       int ret = osl(osl_get_object(audio_file_table, row, AFTCOL_PATH,
+               &path_obj));
        if (ret < 0)
                return ret;
        *path = path_obj.data;
@@ -537,9 +569,10 @@ int get_audio_file_path_of_row(const struct osl_row *row, char **path)
  *
  * \sa get_hash_of_row().
  */
-static int get_hash_object_of_aft_row(const struct osl_row *row, struct osl_object *obj)
+static int get_hash_object_of_aft_row(const struct osl_row *row,
+               struct osl_object *obj)
 {
-       return osl_get_object(audio_file_table, row, AFTCOL_HASH, obj);
+       return osl(osl_get_object(audio_file_table, row, AFTCOL_HASH, obj));
 }
 
 /**
@@ -577,8 +610,8 @@ static int get_hash_of_row(const struct osl_row *row, HASH_TYPE **hash)
 int get_afhi_of_row(const struct osl_row *row, struct afh_info *afhi)
 {
        struct osl_object obj;
-       int ret = osl_get_object(audio_file_table, row, AFTCOL_AFHI,
-               &obj);
+       int ret = osl(osl_get_object(audio_file_table, row, AFTCOL_AFHI,
+               &obj));
        if (ret < 0)
                return ret;
        load_afhi(obj.data, afhi);
@@ -874,10 +907,15 @@ static int print_list_item(struct ls_data *d, struct ls_options *opts,
                "%s: %lu\n" /* seconds total */
                "%s: %s\n" /* last played time */
                "%s: %d\n" /* num_played */
-               "%s: %u\n" /* ampplification */
-               "%s" /* tag info */
+               "%s: %u\n" /* amplification */
                "%s: %lu\n" /* chunk time */
-               "%s: %lu\n", /* num chunks */
+               "%s: %lu\n" /* num chunks */
+               "%s: %s\n" /* techinfo */
+               "%s: %s\n" /* artist */
+               "%s: %s\n" /* title */
+               "%s: %s\n" /* year */
+               "%s: %s\n" /* album */
+               "%s: %s\n", /* comment */
                filename_lines,
                have_score? status_item_list[SI_SCORE] : "",
                        have_score? ": " : "",
@@ -896,9 +934,14 @@ static int print_list_item(struct ls_data *d, struct ls_options *opts,
                status_item_list[SI_LAST_PLAYED], last_played_time,
                status_item_list[SI_NUM_PLAYED], afsi->num_played,
                status_item_list[SI_AMPLIFICATION], afsi->amp,
-               afhi->info_string,
                status_item_list[SI_CHUNK_TIME], tv2ms(&afhi->chunk_tv),
-               status_item_list[SI_NUM_CHUNKS], afhi->chunks_total
+               status_item_list[SI_NUM_CHUNKS], afhi->chunks_total,
+               status_item_list[SI_TECHINFO], afhi->techinfo,
+               status_item_list[SI_ARTIST], afhi->tags.artist,
+               status_item_list[SI_TITLE], afhi->tags.title,
+               status_item_list[SI_YEAR], afhi->tags.year,
+               status_item_list[SI_ALBUM], afhi->tags.album,
+               status_item_list[SI_COMMENT], afhi->tags.comment
        );
        if (ret < 0)
                goto out;
@@ -916,7 +959,6 @@ static int print_list_item(struct ls_data *d, struct ls_options *opts,
        free(image_lines);
        free(filename_lines);
 out:
-       free(afhi->info_string);
        return ret;
 }
 
@@ -949,9 +991,12 @@ void make_empty_status_items(char *buf)
                "%s: \n" /* seconds total */
                "%s: \n" /* num played */
                "%s: \n" /* last played */
-               "%s: \n" /* audio file info */
-               "%s: \n" /* taginfo1 */
-               "%s: \n" /* taginfo2 */
+               "%s: \n" /* techinfo */
+               "%s: \n" /* artist */
+               "%s: \n" /* title */
+               "%s: \n" /* year */
+               "%s: \n" /* album */
+               "%s: \n" /* comment */
                "%s: \n" /* amplification */
                ,
                status_item_list[SI_PATH],
@@ -973,9 +1018,12 @@ void make_empty_status_items(char *buf)
                status_item_list[SI_SECONDS_TOTAL],
                status_item_list[SI_NUM_PLAYED],
                status_item_list[SI_LAST_PLAYED],
-               status_item_list[SI_AUDIO_FILE_INFO],
-               status_item_list[SI_TAGINFO1],
-               status_item_list[SI_TAGINFO2],
+               status_item_list[SI_TECHINFO],
+               status_item_list[SI_ARTIST],
+               status_item_list[SI_TITLE],
+               status_item_list[SI_YEAR],
+               status_item_list[SI_ALBUM],
+               status_item_list[SI_COMMENT],
                status_item_list[SI_AMPLIFICATION]
        );
 }
@@ -985,7 +1033,7 @@ static int make_status_items(struct audio_file_data *afd,
                HASH_TYPE *hash)
 {
        struct ls_data d = {
-               .afhi = afd->afhi, /* struct copy */
+               .afhi = afd->afhi,
                .afsi = *afsi,
                .path = path,
                .score = score,
@@ -1000,8 +1048,7 @@ static int make_status_items(struct audio_file_data *afd,
        int ret;
 
        time(&current_time);
-       ret = print_list_item(&d, &opts, &pb, current_time); /* frees info string */
-       afd->afhi.info_string = NULL;
+       ret = print_list_item(&d, &opts, &pb, current_time);
        if (ret < 0)
                goto out;
        strncpy(afd->verbose_ls_output, pb.buf, VERBOSE_LS_OUTPUT_SIZE);
@@ -1080,7 +1127,6 @@ int open_and_update_audio_file(struct osl_row *aft_row, long score,
        ret = save_afd(afd);
 err:
        free(afd->afhi.chunk_table);
-       free(afd->afhi.info_string);
        osl_close_disk_object(&chunk_table_obj);
        return ret;
 }
@@ -1283,7 +1329,6 @@ static int prepare_ls_row(struct osl_row *row, void *ls_opts)
        }
        return 1;
 err:
-       free(d->afhi.info_string);
        return ret;
 }
 
@@ -1308,8 +1353,8 @@ static void com_ls_callback(int fd, const struct osl_object *query)
        if (opts->flags & LS_FLAG_ADMISSIBLE_ONLY)
                ret = admissible_file_loop(opts, prepare_ls_row);
        else
-               ret = osl_rbtree_loop(audio_file_table, AFTCOL_PATH, opts,
-                       prepare_ls_row);
+               ret = osl(osl_rbtree_loop(audio_file_table, AFTCOL_PATH, opts,
+                       prepare_ls_row));
        if (ret < 0)
                goto out;
        if (!opts->num_matching_paths)
@@ -1457,12 +1502,12 @@ int com_ls(int fd, int argc, char * const * const argv)
  * \param private_data An arbitrary data pointer, passed to \a func.
  * \param func The custom function to be called.
  *
- * \return The return value of the underlying call to osl_rbtree_loop().
+ * \return Standard.
  */
 int audio_file_loop(void *private_data, osl_rbtree_loop_func *func)
 {
-       return osl_rbtree_loop(audio_file_table, AFTCOL_HASH, private_data,
-               func);
+       return osl(osl_rbtree_loop(audio_file_table, AFTCOL_HASH, private_data,
+               func));
 }
 
 static struct osl_row *find_hash_sister(HASH_TYPE *hash)
@@ -1622,7 +1667,7 @@ static void com_add_callback(int fd, const struct osl_object *query)
        PARA_INFO_LOG("request to add %s\n", path);
        hs = find_hash_sister(hash);
        ret = aft_get_row_of_path(path, &pb);
-       if (ret < 0 && ret != -E_RB_KEY_NOT_FOUND)
+       if (ret < 0 && ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
                goto out;
        if (hs && pb && hs == pb && !(flags & ADD_FLAG_FORCE)) {
                if (flags & ADD_FLAG_VERBOSE)
@@ -1639,23 +1684,23 @@ static void com_add_callback(int fd, const struct osl_object *query)
                                if (ret < 0)
                                        goto out;
                        }
-                       ret = osl_del_row(audio_file_table, pb);
+                       ret = osl(osl_del_row(audio_file_table, pb));
                        if (ret < 0)
                                goto out;
                        pb = NULL;
                }
                /* file rename, update hs' path */
                if (flags & ADD_FLAG_VERBOSE) {
-                       ret = osl_get_object(audio_file_table, hs,
-                               AFTCOL_PATH, &obj);
+                       ret = osl(osl_get_object(audio_file_table, hs,
+                               AFTCOL_PATH, &obj));
                        if (ret < 0)
                                goto out;
                        ret = para_printf(&msg, "renamed from %s\n", (char *)obj.data);
                        if (ret < 0)
                                goto out;
                }
-               ret = osl_update_object(audio_file_table, hs, AFTCOL_PATH,
-                       &objs[AFTCOL_PATH]);
+               ret = osl(osl_update_object(audio_file_table, hs, AFTCOL_PATH,
+                       &objs[AFTCOL_PATH]));
                if (ret < 0)
                        goto out;
                afs_event(AUDIO_FILE_RENAME, &msg, hs);
@@ -1699,12 +1744,12 @@ static void com_add_callback(int fd, const struct osl_object *query)
                        if (ret < 0)
                                goto out;
                }
-               ret = osl_update_object(audio_file_table, row, AFTCOL_AFHI,
-                       &objs[AFTCOL_AFHI]);
+               ret = osl(osl_update_object(audio_file_table, row, AFTCOL_AFHI,
+                       &objs[AFTCOL_AFHI]));
                if (ret < 0)
                        goto out;
-               ret = osl_update_object(audio_file_table, row, AFTCOL_CHUNKS,
-                       &objs[AFTCOL_CHUNKS]);
+               ret = osl(osl_update_object(audio_file_table, row, AFTCOL_CHUNKS,
+                       &objs[AFTCOL_CHUNKS]));
                if (ret < 0)
                        goto out;
                afs_event(AFHI_CHANGE, &msg, row);
@@ -1722,7 +1767,7 @@ static void com_add_callback(int fd, const struct osl_object *query)
        objs[AFTCOL_AFSI].data = &afsi_buf;
        objs[AFTCOL_AFSI].size = AFSI_SIZE;
        save_afsi(&default_afsi, &objs[AFTCOL_AFSI]);
-       ret = osl_add_and_get_row(audio_file_table, objs, &aft_row);
+       ret = osl(osl_add_and_get_row(audio_file_table, objs, &aft_row));
        afs_event(AUDIO_FILE_ADD, &msg, aft_row);
 out:
        if (ret < 0)
@@ -1785,7 +1830,7 @@ static int add_one_audio_file(const char *path, void *private_data)
        query.size = strlen(path) + 1;
        ret = send_callback_request(path_brother_callback, &query,
                get_row_pointer_from_result, &pb);
-       if (ret < 0 && ret != -E_RB_KEY_NOT_FOUND)
+       if (ret < 0 && ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
                goto out_free;
        ret = 1;
        if (pb && (pad->flags & ADD_FLAG_LAZY)) { /* lazy is really cheap */
@@ -1847,7 +1892,12 @@ out_free:
        free(obj.data);
        if (afhi_ptr) {
                free(afhi_ptr->chunk_table);
-               free(afhi_ptr->info_string);
+               free(afhi_ptr->techinfo);
+               free(afhi_ptr->tags.artist);
+               free(afhi_ptr->tags.title);
+               free(afhi_ptr->tags.year);
+               free(afhi_ptr->tags.album);
+               free(afhi_ptr->tags.comment);
        }
        /* Stop adding files only on send errors. */
        return send_ret;
@@ -2149,7 +2199,7 @@ static int remove_audio_file(__a_unused struct osl_table *table,
                        return ret;
        }
        afs_event(AUDIO_FILE_REMOVE, &crd->pb, row);
-       ret = osl_del_row(audio_file_table, row);
+       ret = osl(osl_del_row(audio_file_table, row));
        if (ret < 0)
                para_printf(&crd->pb, "%s: %s\n", name, para_strerror(-ret));
        else
@@ -2488,7 +2538,7 @@ static int aft_open(const char *dir)
        int ret;
 
        audio_file_table_desc.dir = dir;
-       ret = osl_open_table(&audio_file_table_desc, &audio_file_table);
+       ret = osl(osl_open_table(&audio_file_table_desc, &audio_file_table));
        if (ret >= 0) {
                unsigned num;
                osl_get_num_rows(audio_file_table, &num);
@@ -2497,7 +2547,7 @@ static int aft_open(const char *dir)
        }
        PARA_INFO_LOG("failed to open audio file table\n");
        audio_file_table = NULL;
-       if (ret >= 0 || is_errno(-ret, ENOENT))
+       if (ret >= 0 || ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_NOENT))
                return 1;
        return ret;
 }
@@ -2505,7 +2555,7 @@ static int aft_open(const char *dir)
 static int aft_create(const char *dir)
 {
        audio_file_table_desc.dir = dir;
-       return osl_create_table(&audio_file_table_desc);
+       return osl(osl_create_table(&audio_file_table_desc));
 }
 
 static int clear_attribute(struct osl_row *row, void *data)