Add support for Lyrics

configure.ac

@@ -251,6 +251,8 @@ OWNTONE_MODULES_CHECK([OWNTONE], [LIBAV],
 		[libavutil/avutil.h])
 	 OWNTONE_CHECK_DECLS([avformat_network_init],
 		[libavformat/avformat.h])
+	 OWNTONE_CHECK_DECLS([av_dict_iterate],
+		[libavutil/dict.h])
 	])
 
 AC_CHECK_SIZEOF([void *])

docs/json-api.md

@@ -1544,7 +1544,8 @@ curl -X GET "http://localhost:3689/api/library/tracks/1"
   "data_kind": "file",
   "path": "/music/srv/Incubus/Make Yourself/12 Pardon Me.mp3",
   "uri": "library:track:1",
-  "artwork_url": "/artwork/item/1"
+  "artwork_url": "/artwork/item/1",
+  "lyrics": "[00:00:10] Let's start the music [...]"
 }
 ```
 
@@ -2622,6 +2623,7 @@ curl --include \
 | uri                | string   | Resource identifier                       |
 | artwork_url        | string   | *(optional)* [Artwork url](#artwork-urls) |
 | usermark           | integer  | User review marking of track (ranges from 0) |
+| lyrics             | string   | The lyrics if found either as LRC or plain text |
 
 
 ### `paging` object

src/db.c

@@ -230,6 +230,7 @@ static const struct col_type_map mfi_cols_map[] =
     { "channels",           mfi_offsetof(channels),           DB_TYPE_INT },
     { "usermark",           mfi_offsetof(usermark),           DB_TYPE_INT },
     { "scan_kind",          mfi_offsetof(scan_kind),          DB_TYPE_INT },
+    { "lyrics",             mfi_offsetof(lyrics),             DB_TYPE_STRING },
   };
 
 /* This list must be kept in sync with
@@ -371,6 +372,7 @@ static const ssize_t dbmfi_cols_map[] =
     dbmfi_offsetof(channels),
     dbmfi_offsetof(usermark),
     dbmfi_offsetof(scan_kind),
+    dbmfi_offsetof(lyrics),
   };
 
 /* This list must be kept in sync with
@@ -777,6 +779,7 @@ free_mfi(struct media_file_info *mfi, int content_only)
   free(mfi->composer_sort);
   free(mfi->album_artist_sort);
   free(mfi->virtual_path);
+  free(mfi->lyrics);
 
   if (!content_only)
     free(mfi);

src/db.h

@@ -248,6 +248,7 @@ struct media_file_info {
   char *composer_sort;
 
   uint32_t scan_kind; /* Identifies the library_source that created/updates this item */
+  char *lyrics;
 };
 
 #define mfi_offsetof(field) offsetof(struct media_file_info, field)
@@ -422,6 +423,7 @@ struct db_media_file_info {
   char *channels;
   char *usermark;
   char *scan_kind;
+  char *lyrics;
 };
 
 #define dbmfi_offsetof(field) offsetof(struct db_media_file_info, field)

src/db_init.c

@@ -98,7 +98,8 @@
   "   composer_sort      VARCHAR(1024) DEFAULT NULL COLLATE DAAP,"	\
   "   channels           INTEGER DEFAULT 0,"		\
   "   usermark           INTEGER DEFAULT 0,"		\
-  "   scan_kind          INTEGER DEFAULT 0"		\
+  "   scan_kind          INTEGER DEFAULT 0,"		\
+  "   lyrics             TEXT DEFAULT NULL COLLATE DAAP"		\
   ");"
 
 #define T_PL					\

src/db_init.h

@@ -26,7 +26,7 @@
  * is a major upgrade. In other words minor version upgrades permit downgrading
  * the server after the database was upgraded. */
 #define SCHEMA_VERSION_MAJOR 22
-#define SCHEMA_VERSION_MINOR 0
+#define SCHEMA_VERSION_MINOR 1
 
 int
 db_init_indices(sqlite3 *hdl);

src/db_upgrade.c

@@ -1227,6 +1227,26 @@ static const struct db_upgrade_query db_upgrade_v2200_queries[] =
     { U_v2200_SCVER_MINOR,    "set schema_version_minor to 00" },
   };
 
+/* ---------------------------- 22.00 -> 22.01 ------------------------------ */
+
+#define U_v2201_ALTER_FILES_ADD_LYRICS \
+  "ALTER TABLE files ADD COLUMN lyrics TEXT DEFAULT NULL COLLATE DAAP;"
+
+#define U_v2201_SCVER_MAJOR                    \
+  "UPDATE admin SET value = '22' WHERE key = 'schema_version_major';"
+#define U_v2201_SCVER_MINOR                    \
+  "UPDATE admin SET value = '01' WHERE key = 'schema_version_minor';"
+
+static const struct db_upgrade_query db_upgrade_v2201_queries[] =
+  {
+    { U_v2201_ALTER_FILES_ADD_LYRICS, "alter table files add column lyrics" },
+
+    { U_v2201_SCVER_MAJOR,    "set schema_version_major to 22" },
+    { U_v2201_SCVER_MINOR,    "set schema_version_minor to 01" },
+  };
+
+
+
 /* -------------------------- Main upgrade handler -------------------------- */
 
 int
@@ -1437,6 +1457,12 @@ db_upgrade(sqlite3 *hdl, int db_ver)
       if (ret < 0)
 	return -1;
 
+      /* FALLTHROUGH */
+
+    case 2200:
+      ret = db_generic_upgrade(hdl, db_upgrade_v2201_queries, ARRAY_SIZE(db_upgrade_v2201_queries));
+      if (ret < 0)
+	return -1;
 
       /* Last case statement is the only one that ends with a break statement! */
       break;

src/httpd_jsonapi.c

@@ -322,14 +322,15 @@ track_to_json(struct db_media_file_info *dbmfi)
 
   safe_json_add_string(item, "path", dbmfi->path);
 
-  ret = snprintf(uri, sizeof(uri), "%s:%s:%s", "library", "track", dbmfi->id);
+  ret = snprintf(uri, sizeof(uri), "library:track:%s", dbmfi->id);
   if (ret < sizeof(uri))
     json_object_object_add(item, "uri", json_object_new_string(uri));
 
   ret = snprintf(artwork_url, sizeof(artwork_url), "/artwork/item/%s", dbmfi->id);
   if (ret < sizeof(artwork_url))
     json_object_object_add(item, "artwork_url", json_object_new_string(artwork_url));
 
+  safe_json_add_string(item, "lyrics", dbmfi->lyrics);
   return item;
 }
 
@@ -3851,7 +3852,7 @@ jsonapi_reply_queue_save(struct httpd_request *hreq)
   if (!allow_modifying_stored_playlists)
     {
       DPRINTF(E_LOG, L_WEB, "Modifying stored playlists is not enabled in the config file\n");
-      return 403; 
+      return 403;
     }
 
   if (access(default_playlist_directory, W_OK) < 0)
@@ -4762,7 +4763,7 @@ jsonapi_init(void)
   default_playlist_directory = NULL;
   allow_modifying_stored_playlists = cfg_getbool(cfg_getsec(cfg, "library"), "allow_modifying_stored_playlists");
   if (allow_modifying_stored_playlists)
-    { 
+    {
       temp_path = cfg_getstr(cfg_getsec(cfg, "library"), "default_playlist_directory");
       if (temp_path)
 	{