[#102] Allow file caching policies

Author: jesperpedersen

doc/CONFIGURATION.md

@@ -22,7 +22,8 @@ The `Bool` data type supports the following values: `on`, `1`, `true`, `off`, `0
 | device   | | String | No | The default device name |
 | output | `[%n/%N] %d: %f [%i] (%t/%T) (%p)`| String | No | Defines the console output. Valid expansions are: `%n` (current track number), `%N` (total number of tracks), `%d` (device name), `%f` (file name), `%F` (full path of file), `%i` (file information), `%t` (current time), `%T` (total time), `%p` (percentage), `%b` (ringbuffer current size in Mb), `%B` (ringbuffer maximum size in Mb)|
 | volume   | -1 | Int | No | The volume in percent. -1 means use current volume |
-| cache   | 256Mb | Int | No | The cache size |
+| cache   | 256Mb | Int | No | The cache size. `0` means no caching |
+| cache_files | `off` | String | No | File caching policy: `off` only caches the current file, `minimal` caches the previous and next files as well, and `all` caches all files in the playlist |
 | log_type | console | String | No | The logging type (console, file, syslog) |
 | log_level | info | String | No | The logging level, any of the (case insensitive) strings `FATAL`, `ERROR`, `WARN`, `INFO` and `DEBUG` (that can be more specific as `DEBUG1` thru `DEBUG5`). Debug level greater than 5 will be set to `DEBUG5`. Not recognized values will make the log_level be `INFO` |
 | log_path | hrmp.log | String | No | The log file location. Can be a strftime(3) compatible string. |

doc/man/hrmp.conf.5.rst

@@ -35,7 +35,11 @@ volume
   The volume in percent. -1 means use current volume
 
 cache
-  The cache size. Default is 256Mb
+  The cache size. 0 means no caching. Default is 256Mb
+
+cache_files
+  File caching policy: off only caches the current file, minimal caches the previous and next files as well, and all caches all files
+  in the playlist
 
 log_type
   The logging type (console, file, syslog). Default is console

doc/manual/03-configuration.md

@@ -26,7 +26,8 @@ The `Bool` data type supports the following values: `on`, `yes`, `1`, `true`, `o
 | device   | | String | No | The default device name |
 | output | `[%n/%N] %d: %f [%i] (%t/%T) (%p)`| String | No | Defines the console output. Valid expansions are: `%n` (current track number), `%N` (total number of tracks), `%d` (device name), `%f` (file name), `%F` (full path of file), `%i` (file information), `%t` (current time), `%T` (total time), `%p` (percentage), `%b` (ringbuffer current size in Mb), `%B` (ringbuffer maximum size in Mb)|
 | volume   | -1 | Int | No | The volume in percent. -1 means use current volume |
-| cache   | 256Mb | Int | No | The cache size |
+| cache   | 256Mb | Int | No | The cache size. `0` means no caching |
+| cache_files | `off` | String | No | File caching policy: `off` only caches the current file, `minimal` caches the previous and next files as well, and `all` caches all files in the playlist |
 | log_type | console | String | No | The logging type (console, file, syslog) |
 | log_level | info | String | No | The logging level, any of the (case insensitive) strings `FATAL`, `ERROR`, `WARN`, `INFO` and `DEBUG` (that can be more specific as `DEBUG1` thru `DEBUG5`). Debug level greater than 5 will be set to `DEBUG5`. Not recognized values will make the log_level be `INFO` |
 | log_path | hrmp.log | String | No | The log file location. Can be a strftime(3) compatible string. |

src/include/hrmp.h

@@ -43,6 +43,10 @@ extern "C" {
 #define UPDATE_PROCESS_TITLE_MINIMAL 2
 #define UPDATE_PROCESS_TITLE_VERBOSE 3
 
+#define HRMP_CACHE_FILES_OFF     0
+#define HRMP_CACHE_FILES_MINIMAL 1
+#define HRMP_CACHE_FILES_ALL     2
+
 #define DEFAULT_BUFFER_SIZE          131072
 #define ALIGNMENT_SIZE               512
 
@@ -193,6 +197,7 @@ struct configuration
    bool is_muted;   /**< Is muted */
 
    size_t cache_size; /**< The cache size */
+   int cache_files;   /**< The cache files policy */
 
    bool metadata; /**< Display metadata about files */
 

src/include/list.h

@@ -28,19 +28,19 @@ extern "C" {
 #include <stddef.h>
 
 /** @struct list_entry
- * Node of a singly linked list of strings
+ * Node of a singly linked list
  */
 struct list;
 
 struct list_entry
 {
-   char value[MAX_PATH];    /**< Stored string value (NUL-terminated) */
+   void* value;             /**< Stored value (owned by the list) */
    struct list_entry* next; /**< Pointer to the next entry */
    struct list* list;       /**< Owning list */
 };
 
 /** @struct list
- * Singly linked list of strings
+ * Singly linked list
  */
 struct list
 {
@@ -64,6 +64,14 @@ hrmp_list_create(struct list** list);
 void
 hrmp_list_destroy(struct list* list);
 
+/**
+ * Destroy a list and free all its entries using a custom free function
+ * @param list The list
+ * @param free_value Function to free each value (can be NULL)
+ */
+void
+hrmp_list_destroy_with(struct list* list, void (*free_value)(void*));
+
 /**
  * Is the list empty
  * @param list The list
@@ -89,6 +97,15 @@ hrmp_list_size(const struct list* list);
 int
 hrmp_list_append(struct list* list, const char* value);
 
+/**
+ * Append a value to the end of the list (takes ownership)
+ * @param list The list
+ * @param value The value to append (owned by list)
+ * @return 0 if success, otherwise 1
+ */
+int
+hrmp_list_append_owned(struct list* list, void* value);
+
 /**
  * Prepend a value to the beginning of the list
  * @param list The list

src/include/playback.h

@@ -48,15 +48,32 @@ struct playback
 };
 
 /**
- * Play back a file
+ * Initialize a playback
  * @param number The file number
  * @param total The total number of files
  * @param fm The file metadata
+ * @param pb The playback
+ * @return 0 upon success, otherwise 1
+ */
+int
+hrmp_playback_init(int number, int total, struct file_metadata* fm, struct playback** pb);
+
+/**
+ * Prepare a playback ringbuffer according to cache settings
+ * @param pb The playback
+ * @return 0 upon success, otherwise 1
+ */
+int
+hrmp_playback_prepare_ringbuffer(struct playback* pb);
+
+/**
+ * Play back a file
+ * @param pb The playback
  * @param next Are going forward or backward
  * @return 0 upon success, otherwise 1
  */
 int
-hrmp_playback(int number, int total, struct file_metadata* fm, bool* next);
+hrmp_playback(struct playback* pb, bool* next);
 
 #ifdef __cplusplus
 }

src/libhrmp/alsa.c

@@ -26,9 +26,12 @@
 #include <stdio.h>
 #include <alsa/pcm.h>
 
+static int
+find_best_format(struct file_metadata* fm, snd_pcm_format_t* format);
+
+
 #define MAX_BUFFER_SIZE 131072
 
-static int find_best_format(struct file_metadata* fm, snd_pcm_format_t* format);
 
 int
 hrmp_alsa_init_handle(struct file_metadata* fm, snd_pcm_t** handle)
@@ -511,6 +514,7 @@ hrmp_alsa_set_volume(int volume)
    return 1;
 }
 
+
 static int
 find_best_format(struct file_metadata* fm, snd_pcm_format_t* format)
 {
@@ -600,3 +604,4 @@ find_best_format(struct file_metadata* fm, snd_pcm_format_t* format)
 
    return 1;
 }
+

src/libhrmp/cmd.c

@@ -21,30 +21,7 @@
 #include <stdlib.h>
 #include <string.h>
 
-static bool
-option_requires_arg(char* option_name, cli_option* options, int num_options, bool is_long_option)
-{
-   for (int j = 0; j < num_options; j++)
-   {
-      cli_option* option = &options[j];
-      bool matches = false;
-
-      if (is_long_option)
-      {
-         matches = (strcmp(option_name, option->long_name) == 0);
-      }
-      else
-      {
-         matches = (strcmp(option_name, option->short_name) == 0);
-      }
-
-      if (matches)
-      {
-         return option->requires_arg;
-      }
-   }
-   return false;
-}
+static bool option_requires_arg(char* option_name, cli_option* options, int num_options, bool is_long_option);
 
 int
 cmd_parse(
@@ -260,3 +237,30 @@ cmd_parse(
 
    return result_count;
 }
+
+
+static bool
+option_requires_arg(char* option_name, cli_option* options, int num_options, bool is_long_option)
+{
+   for (int j = 0; j < num_options; j++)
+   {
+      cli_option* option = &options[j];
+      bool matches = false;
+
+      if (is_long_option)
+      {
+         matches = (strcmp(option_name, option->long_name) == 0);
+      }
+      else
+      {
+         matches = (strcmp(option_name, option->short_name) == 0);
+      }
+
+      if (matches)
+      {
+         return option->requires_arg;
+      }
+   }
+   return false;
+}
+