feat: Initial support for TTS functionality

locales/index.d.ts

@@ -730,6 +730,14 @@ export interface Locale extends ILocale {
      * にゃにゃにゃ？？
      */
     "flagAsCatDescription": string;
+    /**
+     * 自動TTS機能が欲しい。
+     */
+    "flagAsVI": string;
+    /**
+     * 自動TTS機能が必要な場合は有効にしてください。 権限のあるユーザーグループに所属している場合、特定の範囲で自動TTS機能を有効にします。
+     */
+    "flagAsVIDescription": string;
     /**
      * タイムラインにノートへの返信を表示する
      */
@@ -6891,6 +6899,10 @@ export interface Locale extends ILocale {
              * 翻訳機能の利用
              */
             "canUseTranslator": string;
+            /**
+             * TTS機能の利用
+             */
+            "canUseTTS": string;
             /**
              * アイコンデコレーションの最大取付個数
              */
@@ -6937,6 +6949,10 @@ export interface Locale extends ILocale {
              * botユーザー
              */
             "isBot": string;
+            /**
+             * TTSユーザー
+             */
+            "isVI": string;
             /**
              * サスペンド済みユーザー
              */
@@ -7328,6 +7344,10 @@ export interface Locale extends ILocale {
          * Misskeyを翻訳
          */
         "translation": string;
+        /**
+         * Misskeyを変換
+         */
+        "convert": string;
         /**
          * Misskeyに寄付
          */

locales/ja-JP.yml

@@ -178,6 +178,8 @@ flagAsBot: "Botとして設定"
 flagAsBotDescription: "このアカウントがプログラムによって運用される場合は、このフラグをオンにします。オンにすると、反応の連鎖を防ぐためのフラグとして他の開発者に役立ったり、Misskeyのシステム上での扱いがBotに合ったものになります。"
 flagAsCat: "にゃああああああああああああああ！！！！！！！！！！！！"
 flagAsCatDescription: "にゃにゃにゃ？？"
+flagAsVI: "自動TTS機能が欲しい。"
+flagAsVIDescription: "自動TTS機能が必要な場合は有効にしてください。 権限のあるユーザーグループに所属している場合、特定の範囲で自動TTS機能を有効にします。"
 flagShowTimelineReplies: "タイムラインにノートへの返信を表示する"
 flagShowTimelineRepliesDescription: "オンにすると、タイムラインにユーザーのノート以外にもそのユーザーの他のノートへの返信を表示します。"
 autoAcceptFollowed: "フォロー中ユーザーからのフォロリクを自動承認"
@@ -1780,6 +1782,7 @@ _role:
     canHideAds: "広告の非表示"
     canSearchNotes: "ノート検索の利用"
     canUseTranslator: "翻訳機能の利用"
+    canUseTTS: "TTS機能の利用"
     avatarDecorationLimit: "アイコンデコレーションの最大取付個数"
     canImportAntennas: "アンテナのインポートを許可"
     canImportBlocking: "ブロックのインポートを許可"
@@ -1792,6 +1795,7 @@ _role:
     isRemote: "リモートユーザー"
     isCat: "猫ユーザー"
     isBot: "botユーザー"
+    isVI: "TTSユーザー"
     isSuspended: "サスペンド済みユーザー"
     isLocked: "鍵アカウントユーザー"
     isExplorable: "「アカウントを見つけやすくする」が有効なユーザー"
@@ -1910,6 +1914,7 @@ _aboutMisskey:
   original: "オリジナル"
   thisIsModifiedVersion: "{name}はオリジナルのMisskeyを改変したバージョンを使用しています。"
   translation: "Misskeyを翻訳"
+  convert: "Misskeyを変換"
   donate: "Misskeyに寄付"
   morePatrons: "他にも多くの方が支援してくれています。ありがとうございます🥰"
   patrons: "支援者"

packages/backend/migration/1724683952000-tts.js

@@ -0,0 +1,19 @@
+/*
+ * SPDX-FileCopyrightText: syuilo and misskey-project
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+export class TTSIntegration1724683952000 {
+    constructor() {
+        this.name = 'TTSIntegration1724683952000';
+    }
+
+    async up(queryRunner) {
+        await queryRunner.query(`ALTER TABLE "meta" ADD "hfAuthKey" character varying(128)`);
+    }
+
+    async down(queryRunner) {
+        await queryRunner.query(`ALTER TABLE "meta" DROP COLUMN "hfAuthKey"`);
+    }
+}
+

packages/backend/migration/1724683962000-tts.js

@@ -0,0 +1,45 @@
+/*
+ * SPDX-FileCopyrightText: syuilo and misskey-project
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+export class TTSIntegration1724683962000 {
+    constructor() {
+        this.name = 'TTSIntegration1724683962000';
+    }
+
+    async up(queryRunner) {
+    	await queryRunner.query(`ALTER TABLE "user" ADD "isVI" boolean NOT NULL DEFAULT false`);
+    	await queryRunner.query(`COMMENT ON COLUMN "user"."isVI" IS 'Whether the User needs auto TTS.'`);
+        await queryRunner.query(`ALTER TABLE "meta" ADD "hfSpace" boolean NOT NULL DEFAULT false`);
+        await queryRunner.query(`ALTER TABLE "meta" ADD "hfSpaceName" character varying(128)`);
+        await queryRunner.query(`ALTER TABLE "meta" ADD "hfexampleAudioURL" character varying(128)`);
+        await queryRunner.query(`ALTER TABLE "meta" ADD "hfexampleText" character varying(128)`);
+        await queryRunner.query(`ALTER TABLE "meta" ADD "hfexampleLang" character varying(128)`);
+        await queryRunner.query(`ALTER TABLE "meta" ADD "hfslice" character varying(128) DEFAULT 'Slice once every 4 sentences'`);
+        await queryRunner.query(`ALTER TABLE "meta" ADD "hftopK" INTEGER DEFAULT 15`);
+        await queryRunner.query(`ALTER TABLE "meta" ADD "hftopP" INTEGER DEFAULT 100`);
+        await queryRunner.query(`ALTER TABLE "meta" ADD "hfTemperature" INTEGER DEFAULT 100`);
+        await queryRunner.query(`ALTER TABLE "meta" ADD "hfnrm" boolean NOT NULL DEFAULT false`);
+        await queryRunner.query(`ALTER TABLE "meta" ADD "hfSpeedRate" INTEGER DEFAULT 125`);
+        await queryRunner.query(`ALTER TABLE "meta" ADD "hfdas" boolean NOT NULL DEFAULT false`);
+    }
+
+    async down(queryRunner) {
+        await queryRunner.query(`COMMENT ON COLUMN "user"."isVI" IS NULL`);
+    	await queryRunner.query(`ALTER TABLE "user" DROP COLUMN "isVI"`);
+        await queryRunner.query(`ALTER TABLE "meta" DROP COLUMN "hfSpace"`);
+        await queryRunner.query(`ALTER TABLE "meta" DROP COLUMN "hfSpaceName"`);
+        await queryRunner.query(`ALTER TABLE "meta" DROP COLUMN "hfexampleAudioURL"`);
+        await queryRunner.query(`ALTER TABLE "meta" DROP COLUMN "hfexampleText"`);
+        await queryRunner.query(`ALTER TABLE "meta" DROP COLUMN "hfexampleLang"`);
+        await queryRunner.query(`ALTER TABLE "meta" DROP COLUMN "hfslice"`);
+        await queryRunner.query(`ALTER TABLE "meta" DROP COLUMN "hftopK"`);
+        await queryRunner.query(`ALTER TABLE "meta" DROP COLUMN "hftopP"`);
+        await queryRunner.query(`ALTER TABLE "meta" DROP COLUMN "hfTemperature"`);
+        await queryRunner.query(`ALTER TABLE "meta" DROP COLUMN "hfnrm"`);
+        await queryRunner.query(`ALTER TABLE "meta" DROP COLUMN "hfSpeedRate"`);
+        await queryRunner.query(`ALTER TABLE "meta" DROP COLUMN "hfdas"`);
+    }
+}
+

packages/backend/package.json

@@ -81,6 +81,7 @@
 		"@fastify/multipart": "9.0.1",
 		"@fastify/static": "8.0.1",
 		"@fastify/view": "10.0.1",
+		"@gradio/client": "1.6.0-beta.3",
 		"@misskey-dev/sharp-read-bmp": "1.2.0",
 		"@misskey-dev/summaly": "5.1.0",
 		"@napi-rs/canvas": "0.1.56",
@@ -134,8 +135,8 @@
 		"json5": "2.2.3",
 		"jsonld": "8.3.2",
 		"jsrsasign": "11.1.0",
-		"meilisearch": "0.42.0",
 		"juice": "11.0.0",
+		"meilisearch": "0.42.0",
 		"mfm-js": "0.24.0",
 		"microformats-parser": "2.0.2",
 		"mime-types": "2.1.35",

packages/backend/src/core/RoleService.ts

@@ -44,6 +44,7 @@ export type RolePolicies = {
 	canManageAvatarDecorations: boolean;
 	canSearchNotes: boolean;
 	canUseTranslator: boolean;
+	canUseTTS: boolean;
 	canHideAds: boolean;
 	driveCapacityMb: number;
 	alwaysMarkNsfw: boolean;
@@ -78,6 +79,7 @@ export const DEFAULT_POLICIES: RolePolicies = {
 	canManageAvatarDecorations: false,
 	canSearchNotes: false,
 	canUseTranslator: true,
+	canUseTTS: true,
 	canHideAds: false,
 	driveCapacityMb: 100,
 	alwaysMarkNsfw: false,
@@ -256,6 +258,10 @@ export class RoleService implements OnApplicationShutdown, OnModuleInit {
 				case 'isCat': {
 					return user.isCat;
 				}
+				// Auto TTS
+				case 'isVI': {
+					return user.isVI;
+				}
 				// 「ユーザを見つけやすくする」が有効なアカウント
 				case 'isExplorable': {
 					return user.isExplorable;
@@ -383,6 +389,7 @@ export class RoleService implements OnApplicationShutdown, OnModuleInit {
 			canManageAvatarDecorations: calc('canManageAvatarDecorations', vs => vs.some(v => v === true)),
 			canSearchNotes: calc('canSearchNotes', vs => vs.some(v => v === true)),
 			canUseTranslator: calc('canUseTranslator', vs => vs.some(v => v === true)),
+			canUseTTS: calc('canUseTTS', vs => vs.some(v => v === true)),
 			canHideAds: calc('canHideAds', vs => vs.some(v => v === true)),
 			driveCapacityMb: calc('driveCapacityMb', vs => Math.max(...vs)),
 			alwaysMarkNsfw: calc('alwaysMarkNsfw', vs => vs.some(v => v === true)),

packages/backend/src/core/WebhookTestService.ts

@@ -79,6 +79,7 @@ function generateDummyUser(override?: Partial<MiUser>): MiUser {
 		isLocked: false,
 		isBot: false,
 		isCat: true,
+		isVI: false,
 		isRoot: false,
 		isExplorable: true,
 		isHibernated: false,
@@ -198,6 +199,7 @@ function toPackedUserLite(user: MiUser, override?: Packed<'UserLite'>): Packed<'
 		})),
 		isBot: user.isBot,
 		isCat: user.isCat,
+		isVI: user.isVI,
 		emojis: user.emojis,
 		onlineStatus: 'active',
 		badgeRoles: [],

packages/backend/src/core/entities/MetaEntityService.ts

@@ -123,6 +123,7 @@ export class MetaEntityService {
 			enableServiceWorker: instance.enableServiceWorker,
 
 			translatorAvailable: instance.deeplAuthKey != null,
+			ttsAvailable: instance.hfAuthKey != null,
 
 			serverRules: instance.serverRules,
 

packages/backend/src/core/entities/UserEntityService.ts

@@ -490,6 +490,7 @@ export class UserEntityService implements OnModuleInit {
 			}))) : [],
 			isBot: user.isBot,
 			isCat: user.isCat,
+			isVI: user.isVI,
 			instance: user.host ? this.federatedInstanceService.federatedInstanceCache.fetch(user.host).then(instance => instance ? {
 				name: instance.name,
 				softwareName: instance.softwareName,

packages/backend/src/models/Meta.ts

@@ -359,6 +359,78 @@ export class MiMeta {
 	})
 	public deeplIsPro: boolean;
 
+	@Column('varchar', {
+		length: 1024,
+		nullable: true,
+	})
+	public hfAuthKey: string | null;
+
+	@Column('boolean', {
+		default: false,
+	})
+	public hfSpace: boolean;
+
+	@Column('varchar', {
+		length: 1024,
+		nullable: true,
+	})
+	public hfSpaceName: string | null;
+
+	@Column('varchar', {
+		length: 1024,
+		nullable: true,
+	})
+	public hfexampleAudioURL: string | null;
+
+	@Column('varchar', {
+		length: 1024,
+		nullable: true,
+	})
+	public hfexampleText: string | null;
+
+	@Column('varchar', {
+		length: 1024,
+		nullable: true,
+	})
+	public hfexampleLang: string | null;
+
+	@Column('varchar', {
+		length: 1024,
+		default: 'Slice once every 4 sentences',
+		nullable: true,
+	})
+	public hfslice: string | null;
+
+	@Column('integer', {
+		default: 15,
+	})
+	public hftopK: number;
+
+	@Column('integer', {
+		default: 100,
+	})
+	public hftopP: number;
+
+	@Column('integer', {
+		default: 100,
+	})
+	public hfTemperature: number;
+
+	@Column('boolean', {
+		default: false,
+	})
+	public hfnrm: boolean;
+
+	@Column('integer', {
+		default: 125,
+	})
+	public hfSpeedRate: number;
+
+	@Column('boolean', {
+		default: false,
+	})
+	public hfdas: boolean;
+
 	@Column('varchar', {
 		length: 1024,
 		nullable: true,

packages/backend/src/models/Role.ts

@@ -83,6 +83,13 @@ type CondFormulaValueIsCat = {
 	type: 'isCat';
 };
 
+/**
+ * Auto TTS
+ */
+type CondFormulaValueIsVI = {
+	type: 'isVI';
+};
+
 /**
  * 「ユーザを見つけやすくする」が有効なアカウントの場合のみ成立とする
  */
@@ -164,6 +171,7 @@ export type RoleCondFormulaValue = { id: string } & (
 	CondFormulaValueIsLocked |
 	CondFormulaValueIsBot |
 	CondFormulaValueIsCat |
+	CondFormulaValueIsVI |
 	CondFormulaValueIsExplorable |
 	CondFormulaValueRoleAssignedTo |
 	CondFormulaValueCreatedLessThan |

packages/backend/src/models/User.ts

@@ -184,6 +184,12 @@ export class MiUser {
 	})
 	public isCat: boolean;
 
+	@Column('boolean', {
+		default: false,
+		comment: 'Whether the User needs auto TTS.',
+	})
+	public isVI: boolean;
+
 	@Column('boolean', {
 		default: false,
 		comment: 'Whether the User is the root.',

packages/backend/src/models/json-schema/meta.ts

@@ -207,6 +207,10 @@ export const packedMetaLiteSchema = {
 			type: 'boolean',
 			optional: false, nullable: false,
 		},
+		ttsAvailable: {
+			type: 'boolean',
+			optional: false, nullable: false,
+		},
 		mediaProxy: {
 			type: 'string',
 			optional: false, nullable: false,

packages/backend/src/models/json-schema/role.ts

@@ -66,7 +66,7 @@ export const packedRoleCondFormulaValueUserSettingBooleanSchema = {
 		type: {
 			type: 'string',
 			nullable: false, optional: false,
-			enum: ['isSuspended', 'isLocked', 'isBot', 'isCat', 'isExplorable'],
+			enum: ['isSuspended', 'isLocked', 'isBot', 'isCat', 'isVI', 'isExplorable'],
 		},
 	},
 } as const;
@@ -216,6 +216,10 @@ export const packedRolePoliciesSchema = {
 			type: 'boolean',
 			optional: false, nullable: false,
 		},
+		canUseTTS: {
+			type: 'boolean',
+			optional: false, nullable: false,
+		},
 		canHideAds: {
 			type: 'boolean',
 			optional: false, nullable: false,

packages/backend/src/models/json-schema/user.ts

@@ -115,6 +115,10 @@ export const packedUserLiteSchema = {
 			type: 'boolean',
 			nullable: false, optional: true,
 		},
+		isVI: {
+			type: 'boolean',
+			nullable: false, optional: true,
+		},
 		instance: {
 			type: 'object',
 			nullable: false, optional: true,