"%s: \n" /* dirname */
"%s: \n" /* basename */
"%s: \n" /* score */
- "%s: \n" /* attributes bitnmap */
+ "%s: \n" /* attributes bitmap */
"%s: \n" /* attributes txt */
"%s: \n" /* hash */
"%s: \n" /* image id */
return row;
}
-enum aft_row_offsets {
- AFTROW_AFHI_OFFSET_POS = 0,
- AFTROW_CHUNKS_OFFSET_POS = 2,
- AFTROW_AUDIO_FORMAT_OFFSET = 4,
- AFTROW_FLAGS_OFFSET = 5,
- AFTROW_HASH_OFFSET = 9,
- AFTROW_PATH_OFFSET = (AFTROW_HASH_OFFSET + HASH_SIZE),
+/** The format of the data stored by save_audio_file_data(). */
+enum com_add_buffer_offsets {
+ /** afhi (if present) starts here. */
+ CAB_AFHI_OFFSET_POS = 0,
+ /** Start of the chunk table (if present). */
+ CAB_CHUNKS_OFFSET_POS = 2,
+ /** Audio format id. */
+ CAB_AUDIO_FORMAT_OFFSET = 4,
+ /** Flags given to the add command. */
+ CAB_FLAGS_OFFSET = 5,
+ /** The hash of the audio file being added. */
+ CAB_HASH_OFFSET = 9,
+ /** Start of the path of the audio file. */
+ CAB_PATH_OFFSET = (CAB_HASH_OFFSET + HASH_SIZE),
};
-/* never save the afsi, as the server knows it too. Note that afhi might be NULL.
- * In this case, afhi won't be stored in the buffer */
-static void save_audio_file_info(HASH_TYPE *hash, const char *path,
+/*
+ * Store the given data to a single buffer. Doesn't need the audio file selector
+ * info struct as the server knows it as well.
+ *
+ * It's OK to call this with afhi == NULL. In this case, the audio format
+ * handler info won't be stored in the buffer.
+ */
+static void save_add_callback_buffer(HASH_TYPE *hash, const char *path,
struct afh_info *afhi, uint32_t flags,
uint8_t audio_format_num, struct osl_object *obj)
{
size_t path_len = strlen(path) + 1;
size_t afhi_size = sizeof_afhi_buf(afhi);
- size_t size = AFTROW_PATH_OFFSET + path_len + afhi_size
+ size_t size = CAB_PATH_OFFSET + path_len + afhi_size
+ sizeof_chunk_table(afhi);
char *buf = para_malloc(size);
uint16_t pos;
- write_u8(buf + AFTROW_AUDIO_FORMAT_OFFSET, audio_format_num);
- write_u32(buf + AFTROW_FLAGS_OFFSET, flags);
+ write_u8(buf + CAB_AUDIO_FORMAT_OFFSET, audio_format_num);
+ write_u32(buf + CAB_FLAGS_OFFSET, flags);
- memcpy(buf + AFTROW_HASH_OFFSET, hash, HASH_SIZE);
- strcpy(buf + AFTROW_PATH_OFFSET, path);
+ memcpy(buf + CAB_HASH_OFFSET, hash, HASH_SIZE);
+ strcpy(buf + CAB_PATH_OFFSET, path);
- pos = AFTROW_PATH_OFFSET + path_len;
+ pos = CAB_PATH_OFFSET + path_len;
PARA_DEBUG_LOG("size: %zu, afhi starts at %d\n", size, pos);
PARA_DEBUG_LOG("last afhi byte: %p, pos %zu\n", buf + pos + afhi_size - 1,
pos + afhi_size - 1);
- write_u16(buf + AFTROW_AFHI_OFFSET_POS, pos);
+ write_u16(buf + CAB_AFHI_OFFSET_POS, pos);
save_afhi(afhi, buf + pos);
pos += afhi_size;
PARA_DEBUG_LOG("size: %zu, chunks start at %d\n", size, pos);
- write_u16(buf + AFTROW_CHUNKS_OFFSET_POS, pos);
+ write_u16(buf + CAB_CHUNKS_OFFSET_POS, pos);
if (afhi)
save_chunk_table(afhi, buf + pos);
PARA_DEBUG_LOG("last byte in buf: %p\n", buf + size - 1);
}
/*
-input:
+
+Overview of the add command.
+
+Input: What was passed to the callback by the command handler.
~~~~~~
-HS: hash sister
-PB: path brother
-F: force flag given
+HS: Hash sister. Whether an audio file with identical hash
+ already exists in the osl database.
+
+PB: Path brother. Whether a file with the given path exists
+ in the table.
+
+F: Force flag given. Whether add was called with -f.
-output:
+output: Action performed by the callback.
~~~~~~~
-AFHI: whether afhi and chunk table are computed and sent
-ACTION: table modifications to be performed
-
-+---+----+-----+------+---------------------------------------------------+
-| HS | PB | F | AFHI | ACTION
-+---+----+-----+------+---------------------------------------------------+
-| Y | Y | Y | Y | if HS != PB: remove PB. HS: force afhi update,
-| | update path, keep afsi
-+---+----+-----+------+---------------------------------------------------+
-| Y | Y | N | N | if HS == PB: do not send callback request at all.
-| | otherwise: remove PB, HS: update path, keep afhi,
-| | afsi.
-+---+----+-----+------+---------------------------------------------------+
-| Y | N | Y | Y | (rename) force afhi update of HS, update path of
-| | HS, keep afsi
-+---+----+-----+------+---------------------------------------------------+
-| Y | N | N | N | (file rename) update path of HS, keep afsi, afhi
-+---+----+-----+------+---------------------------------------------------+
-| N | Y | Y | Y | (file change) update afhi, hash, of PB, keep afsi
-| | (force has no effect)
-+---+----+-----+------+---------------------------------------------------+
-| N | Y | N | Y | (file change) update afhi, hash of PB, keep afsi
-+---+----+-----+------+---------------------------------------------------+
-| N | N | Y | Y | (new file) create new entry (force has no effect)
-+---+----+-----+------+---------------------------------------------------+
-| N | N | N | Y | (new file) create new entry
-+---+----+-----+------+---------------------------------------------------+
-
-afhi <=> force or no HS
+AFHI: Whether afhi and chunk table are computed and sent.
+ACTION: Table modifications to be done by the callback.
+
++----+----+---+------+---------------------------------------------------+
+| HS | PB | F | AFHI | ACTION
++----+----+---+------+---------------------------------------------------+
+| Y | Y | Y | Y | if HS != PB: remove PB. HS: force afhi update,
+| | update path, keep afsi
++----+----+---+------+---------------------------------------------------+
+| Y | Y | N | N | if HS == PB: do not send callback request at all.
+| | otherwise: remove PB, HS: update path, keep afhi,
+| | afsi.
++----+----+---+------+---------------------------------------------------+
+| Y | N | Y | Y | (rename) force afhi update of HS, update path of
+| | HS, keep afsi
++----+----+---+------+---------------------------------------------------+
+| Y | N | N | N | (file rename) update path of HS, keep afsi, afhi
++----+----+---+------+---------------------------------------------------+
+| N | Y | Y | Y | (file change) update afhi, hash, of PB, keep afsi
+| | (force has no effect)
++----+----+---+------+---------------------------------------------------+
+| N | Y | N | Y | (file change) update afhi, hash of PB, keep afsi
++----+----+---+------+---------------------------------------------------+
+| N | N | Y | Y | (new file) create new entry (force has no effect)
++----+----+---+------+---------------------------------------------------+
+| N | N | N | Y | (new file) create new entry
++----+----+---+------+---------------------------------------------------+
+
+Notes:
+
+ afhi <=> force or no HS
+ F => AFHI
*/
char asc[2 * HASH_SIZE + 1];
int ret;
char afsi_buf[AFSI_SIZE];
- uint32_t flags = read_u32(buf + AFTROW_FLAGS_OFFSET);
+ uint32_t flags = read_u32(buf + CAB_FLAGS_OFFSET);
struct afs_info default_afsi = {.last_played = 0};
struct para_buffer msg = {.buf = NULL};
- hash = (HASH_TYPE *)buf + AFTROW_HASH_OFFSET;
+ hash = (HASH_TYPE *)buf + CAB_HASH_OFFSET;
hash_to_asc(hash, asc);;
- objs[AFTCOL_HASH].data = buf + AFTROW_HASH_OFFSET;
+ objs[AFTCOL_HASH].data = buf + CAB_HASH_OFFSET;
objs[AFTCOL_HASH].size = HASH_SIZE;
- path = buf + AFTROW_PATH_OFFSET;
+ path = buf + CAB_PATH_OFFSET;
objs[AFTCOL_PATH].data = path;
objs[AFTCOL_PATH].size = strlen(path) + 1;
goto out;
}
/* no hs or force mode, child must have sent afhi */
- uint16_t afhi_offset = read_u16(buf + AFTROW_AFHI_OFFSET_POS);
- uint16_t chunks_offset = read_u16(buf + AFTROW_CHUNKS_OFFSET_POS);
+ uint16_t afhi_offset = read_u16(buf + CAB_AFHI_OFFSET_POS);
+ uint16_t chunks_offset = read_u16(buf + CAB_CHUNKS_OFFSET_POS);
objs[AFTCOL_AFHI].data = buf + afhi_offset;
objs[AFTCOL_AFHI].size = chunks_offset - afhi_offset;
if (flags & ADD_FLAG_VERBOSE)
para_printf(&msg, "new file\n");
default_afsi.last_played = time(NULL) - 365 * 24 * 60 * 60;
- default_afsi.audio_format_id = read_u8(buf + AFTROW_AUDIO_FORMAT_OFFSET);
+ default_afsi.audio_format_id = read_u8(buf + CAB_AUDIO_FORMAT_OFFSET);
objs[AFTCOL_AFSI].data = &afsi_buf;
objs[AFTCOL_AFSI].size = AFSI_SIZE;
if (send_ret < 0)
goto out_free;
}
- save_audio_file_info(hash, path, afhi_ptr, pad->flags, format_num, &obj);
+ save_add_callback_buffer(hash, path, afhi_ptr, pad->flags, format_num, &obj);
/* Ask afs to consider this entry for adding. */
ret = send_callback_request(com_add_callback, &obj, &result);
if (ret > 0) {