mirakurun 4.0.0-beta.0 → 4.0.0-beta.10

package/CHANGELOG.md

@@ -2,7 +2,146 @@
 
 see [Commit Logs](https://github.com/Chinachu/Mirakurun/commits/master) to check all.
 
-## 3.9.0 (2023-xx-xx)
+## 4.0.0-beta.10 (2025-03-17)
+
+**Important Notice**: Mirakurun 4.0.0 includes significant performance improvements, enhanced EPG processing, asynchronous file I/O operations, and new features. As announced in 3.9.0, the experimental Win32 support has been completely removed.
+
+### Server Changes
+
+- **Server**:
+  - Added test mode support for unit/integration testing
+  - Added deinit method (not used yet)
+  - Improved server init with proper async handling
+- **API**:
+  - **getTuner**: Fixed 500 error on not found (*bug*)
+
+### Client Changes
+
+- **getDocs**: Added to get API spec docs
+
+## 4.0.0-beta.9 (2025-03-16)
+
+### Server Changes
+
+- **UI**:
+  - **ChannelsConfigurator**: Fixed layout issue on initial view (*bug*)
+  - **TunersManager**: Added dropped packet counter
+
+## 4.0.0-beta.8 (2025-03-16)
+
+### Server Changes
+
+- **API**:
+  - **getTuner**: Fixed broken response (*bug*)
+  - **killTunerProcess**: The normal status code was changed to `204`. Response is now empty. (*breaking change*)
+  - **getChannelStream**,<br>
+    **getServiceStreamByChannel**,<br>
+    **getProgramStream**,<br>
+    **getServiceStream**:
+    - Fixed processing of HEAD requests; removed operationId because duplicated. (*bug*)
+
+### Client Changes
+
+- channelScan: (Note) Response spec may change. asynchronous support is under consideration.
+- **getChannelScanStatus**: Added
+- **stopChannelScan**: Added
+
+## 4.0.0-beta.7 (2025-03-14)
+
+**Important Notice**: Mirakurun 4.0.0 includes significant performance improvements, enhanced EPG processing, asynchronous file I/O operations, and new features. As announced in 3.9.0, the experimental Win32 support has been completely removed.
+
+### Key Changes
+
+- **Node.js**: Updated supported versions: `^18 || ^20 || ^22` (dropped support for Node.js 14 and 16)
+- **Win32**: Completely removed support
+- **UI**: Added UI for channel scanning
+- **Performance**: Eliminated blocking file I/O operations to improve real-time processing
+- **Configuration**: Reduced storage write frequency to minimize interruptions to real-time processing
+- **Docker**: Updated configuration files, improved commands, and added Node.js 22 support
+
+### Breaking Changes
+
+- **Win32**: Completely removed support
+- **Project Structure**: Changed global installation to be discouraged and removed PM2 support
+
+### Server Changes
+
+- **config/server**: Added new configuration options:
+  - `allowOrigins`: Specify CORS origins
+  - `allowPNA`: Allow Private Network Access (default: `true`)
+  - `tsplayEndpoint`: Endpoint for TSPlay feature
+- **CORS**: Support for multiple origins, Cross-Origin Resource Policy set to "cross-origin"
+- **Private Network Access**: Added PNA/LNA support, enabling secure access within private networks
+- **Memory Usage**: Increased Node.js `max-semi-space-size` to 64MB to improve memory performance (this may slight increase memory usage)
+- **config/channels/scan**: Added service type support, improved scanning capabilities
+  - Added `skipCh` parameter to skip specific channels
+  - Added asynchronous channel scanning with progress tracking
+  - Added DELETE endpoint for canceling scans
+- **UI**:
+  - Changed API documentation from Swagger UI to ReDoc
+  - Added new UI components and service type filtering options
+  - Added channel, service ID, and User-Agent columns to tuner manager
+  - Added UI for channel scanning with visual progress tracking
+- **TSPlay**: Added experimental TSPlay feature
+
+### Docker Changes
+
+- **Base Image**: Updated from `node:18.15.0-buster-slim` to `node:22.14.0-bookworm-slim`
+- **Build Process**: Changed from `npm install` to `npm ci` for more reliable builds
+- **Configuration**:
+  - Made Dockerfile and image tag configurable via environment variables (`DOCKERFILE`, `MIRAKURUN_IMAGE_TAG`)
+  - Added `tmpfs` mount for `/tmp` to improve I/O performance
+- **docker-compose.yml**:
+  - Simplified volume binding syntax
+  - Added configuration guidance for users not using card readers or DVB devices
+  - Added detailed comments for hostname settings
+- **Commands**: Added new npm scripts for developers:
+  - `docker:run-setup`: Run container in setup mode
+  - `docker:down`: Stop and remove container
+  - `docker:logs`: Display container logs
+  - `docker:bash`: Run Bash shell in container
+
+### Other Changes
+
+- **File I/O Processing**:
+  - Replaced synchronous file I/O operations with asynchronous ones to improve real-time processing performance
+  - Replaced synchronous methods from the `fs` module with asynchronous methods from `fs/promises`
+  - Introduced queues for config file I/O operations to prevent concurrent access issues
+  - Reduced storage write frequency (extended program info save interval from 10 seconds to 30 seconds)
+
+- **Performance Optimization**:
+  - Implemented asynchronous JSON processing to prevent interruptions to real-time stream processing
+  - Introduced `yieldable-json` package for asynchronous JSON parsing
+  - Increased Node.js `max-semi-space-size` to 64MB to improve garbage collection efficiency
+
+- **Packages and Frameworks**:
+  - Updated major dependencies:
+    - express: `4.17.3` → `4.21.2`
+    - glob: `7.2.3` → `11.0.1`
+    - semver: `7.3.5` → `7.7.1`
+    - rfdc: `1.3.0` → `1.4.1`
+    - React: `17.0.2` → `^18.3.1`
+    - React DOM: `17.0.2` → `^18.3.1`
+    - TypeScript: `4.7` → `5.7`
+  - Added new dependencies:
+    - redoc: `2.4.0` (as an alternative to Swagger UI)
+    - redoc-try: `1.4.10`
+    - yieldable-json: `^2.1.0`
+  - Removed dependencies:
+    - swagger-ui-dist (due to change in API documentation tool to ReDoc)
+
+- **Project Structure**:
+  - Removed global installation (`preferGlobal`) flag
+  - Removed PM2 support, added dummy CLI script for migration guidance
+  - Completely removed Win32-specific scripts and support
+  - Improved TypeScript configuration and consistency
+  - Updated Azure Pipelines configuration (updated to Ubuntu 22.04 base)
+
+- **Channels**:
+  - Updated default sample channel configuration
+  - Significantly improved and extended channel scanning functionality
+
+## 3.9.0-rc.4 (2023-04-09)
 
 Performance improvements, fixes for memory leaks and bugs related to EPG processing, etc.
 

package/README.md

@@ -22,7 +22,7 @@ see: available [Tags](https://hub.docker.com/r/chinachu/mirakurun/tags) (Docker
 ```sh
 mkdir ~/mirakurun/
 cd ~/mirakurun/
-wget https://raw.githubusercontent.com/Chinachu/Mirakurun/master/docker/docker-compose.yml
+wget https://raw.githubusercontent.com/Chinachu/Mirakurun/refs/heads/release/4.0.0/docker/docker-compose.yml
 docker compose pull
 docker compose run --rm -e SETUP=true mirakurun
 docker compose up -d

package/api.d.ts

@@ -51,8 +51,6 @@ export interface Channel {
 
 export type ChannelType = "GR" | "BS" | "CS" | "SKY";
 
-export type ChannelScanMode = "Channel" | "Service";
-
 export interface Service {
     id: ServiceItemId;
     serviceId: ServiceId;
@@ -85,24 +83,7 @@ export interface Program {
         streamContent: number;
         componentType: number;
     }
-    audios?: {
-        /** component_type
-         * - 0x01 - 1/0 mode (single-mono)
-         * - 0x02 - 1/0 + 1/0 mode (dual-mono)
-         * - 0x03 - 2/0 mode (stereo)
-         * - 0x07 - 3/1 mode
-         * - 0x08 - 3/2 mode
-         * - 0x09 - 3/2 + LFE mode
-         */
-        componentType: number;
-        componentTag: number;
-        isMain: boolean;
-        samplingRate: ProgramAudioSamplingRate;
-        /** ISO_639_language_code, ISO_639_language_code_2
-         * - this `#length` will `2` if dual-mono multi-lingual.
-         */
-        langs: ProgramAudioLanguageCode[];
-    }[]
+    audios?: ProgramAudio[];
 
     series?: ProgramSeries;
 
@@ -122,17 +103,45 @@ export interface ProgramGenre {
 
 export type ProgramVideoType = "mpeg2" | "h.264" | "h.265";
 
-export type ProgramVideoResolution = "240p" | "480i" | "480p" | "720p" | "1080i" | "2160p" | "4320p";
+export type ProgramVideoResolution = (
+    "240p" |
+    "480i" |
+    "480p" |
+    "720p" |
+    "1080i" |
+    "1080p" |
+    "2160p" |
+    "4320p"
+);
 
-export enum ProgramAudioSamplingRate {
-    "16kHz" = 16000,
-    "22.05kHz" = 22050,
-    "24kHz" = 24000,
-    "32kHz" = 32000,
-    "44.1kHz" = 44100,
-    "48kHz" = 48000
+export interface ProgramAudio {
+    /** component_type
+     * - 0x01 - 1/0 mode (single-mono)
+     * - 0x02 - 1/0 + 1/0 mode (dual-mono)
+     * - 0x03 - 2/0 mode (stereo)
+     * - 0x07 - 3/1 mode
+     * - 0x08 - 3/2 mode
+     * - 0x09 - 3/2 + LFE mode
+     */
+    componentType: number;
+    componentTag: number;
+    isMain: boolean;
+    samplingRate: ProgramAudioSamplingRate;
+    /** ISO_639_language_code, ISO_639_language_code_2
+     * - this `#length` will `2` if dual-mono multi-lingual.
+     */
+    langs: ProgramAudioLanguageCode[];
 }
 
+export type ProgramAudioSamplingRate = (
+    16000 |
+    22050 |
+    24000 |
+    32000 |
+    44100 |
+    48000
+);
+
 export type ProgramAudioLanguageCode = (
     "jpn" |
     "eng" |
@@ -211,10 +220,10 @@ export interface TunerProcess {
     pid: number;
 }
 
-export interface Event {
+export interface Event<T = any> {
     resource: EventResource;
     type: EventType;
-    data: any;
+    data: T;
     time: UnixtimeMS;
 }
 
@@ -239,15 +248,19 @@ export interface ConfigServer {
     disableWebUI?: boolean;
     allowIPv4CidrRanges?: string[];
     allowIPv6CidrRanges?: string[];
+    allowOrigins: string[];
+    allowPNA: boolean;
+    tsplayEndpoint: string;
 }
 
-export enum LogLevel {
-    "FATAL" = -1,
-    "ERROR" = 0,
-    "WARN" = 1,
-    "INFO" = 2,
-    "DEBUG" = 3
-}
+/**
+ * FATAL: -1
+ * ERROR: 0
+ * WARN: 1
+ * INFO: 2
+ * DEBUG: 3
+ */
+export type LogLevel = -1 | 0 | 1 | 2 | 3;
 
 export type ConfigTuners = ConfigTunersItem[];
 
@@ -286,8 +299,53 @@ export interface ConfigChannelsItem {
     polarity?: "H" | "V";
     tsmfRelTs?: number;
     isDisabled?: boolean;
+    /** @deprecated */
+    readonly satelite?: string;
+}
+
+export interface ChannelScanStatus {
+    isScanning: boolean;
+    status: ChannelScanPhase;
+    type?: ChannelType;
+    dryRun?: boolean;
+    progress?: number;
+    currentChannel?: string;
+    scanLog?: string[];
+    newCount?: number;
+    takeoverCount?: number;
+    result?: ConfigChannelsItem[];
+    startTime?: number;
+    updateTime?: number;
 }
 
+export type ChannelScanMode = "Channel" | "Service";
+
+export type ChannelScanPhase = (
+    "not_started" |
+    "scanning" |
+    "completed" |
+    "cancelled" |
+    "error"
+);
+
+export type ChannelScanStep = (
+    "started" |
+    "scanning_channel" |
+    "takeover" |
+    "skipped" |
+    "services_found" |
+    "channels_found" |
+    "error"
+);
+
+export type ChannelScanResultType = (
+    "summary" |
+    "summary_new" |
+    "summary_takeover" |
+    "restart_required" |
+    "final_result"
+);
+
 export interface Version {
     current: string;
     latest: string;

package/api.yml

@@ -1,7 +1,7 @@
 swagger: '2.0'
 info:
   title: Mirakurun
-  version: ~
+  version: '0.0.0'
   description: DVR Tuner Server for Japanese TV.
   contact:
     name: Chinachu Project
@@ -572,6 +572,55 @@ definitions:
       latest:
         type: string
 
+  ChannelScanStatus:
+    type: object
+    description: "Current status of a channel scan operation"
+    properties:
+      status:
+        type: string
+        description: "Current scan status"
+        enum:
+          - not_started
+          - scanning
+          - completed
+          - cancelled
+          - error
+      isScanning:
+        type: boolean
+        description: "Whether a scan is currently in progress"
+      type:
+        $ref: '#/definitions/ChannelType'
+        description: "Channel type being scanned"
+      dryRun:
+        type: boolean
+        description: "Whether this is a dry run (no changes will be saved)"
+      progress:
+        type: integer
+        description: "Scan progress percentage (0-100)"
+      currentChannel:
+        type: string
+        description: "Channel currently being scanned"
+      scanLog:
+        type: array
+        description: "Log of scan events"
+        items:
+          type: string
+      newCount:
+        type: integer
+        description: "Number of new channels found"
+      takeoverCount:
+        type: integer
+        description: "Number of existing channels merged"
+      result:
+        type: array
+        description: "Complete channel configuration"
+        items:
+          $ref: "#/definitions/ConfigChannelsItem"
+      startTime:
+        $ref: '#/definitions/UnixtimeMS'
+      updateTime:
+        $ref: '#/definitions/UnixtimeMS'
+
   Status:
     type: object
     properties:

package/bin/cli.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+cat <<EOF
+
+CLI / PM2 support has been removed on @4.0.0.
+
+Solutions:
+- use Docker (recommended)
+  - https://github.com/Chinachu/Mirakurun/blob/release/4.0.0/doc/Platforms.md#docker-on-linux
+- use PM2 manually (legacy)
+  - https://github.com/Chinachu/Mirakurun/blob/release/4.0.0/doc/Platforms.md#linux-w-pm2-legacy
+- downgrade to @3.9.0-rc.4
+  - sudo npm install mirakurun@3.9.0-rc.4 -g --unsafe-perm --foreground-scripts --production
+
+EOF

package/config/channels.yml

@@ -1,140 +1,197 @@
 - name: ＴＯＫＹＯ　ＭＸ
   type: GR
   channel: '16'
+  isDisabled: true
 
 - name: フジテレビ
   type: GR
   channel: '21'
+  isDisabled: true
 
 - name: ＴＢＳ
   type: GR
   channel: '22'
+  isDisabled: true
 
-- name: テレビ東京
+- name: テレ東
   type: GR
   channel: '23'
+  isDisabled: true
 
 - name: テレビ朝日
   type: GR
   channel: '24'
+  isDisabled: true
 
 - name: 日テレ
   type: GR
   channel: '25'
+  isDisabled: true
 
-- name: ＮＨＫＥテレ・東京
+- name: ＮＨＫＥテレ
   type: GR
   channel: '26'
+  isDisabled: true
 
-- name: ＮＨＫ総合・東京
+- name: ＮＨＫ総合
   type: GR
   channel: '27'
+  isDisabled: true
 
-- name: NHK BS1
+- name: ＢＳ朝日１
   type: BS
-  channel: BS15_0
-  serviceId: 101
+  channel: BS01_0
+  serviceId: 151
+  isDisabled: true
 
-- name: NHK BS1 (Sub)
+- name: ＢＳ朝日２
   type: BS
-  channel: BS15_0
-  serviceId: 102
+  channel: BS01_0
+  serviceId: 152
+  isDisabled: true
+
+- name: ＢＳ朝日３
+  type: BS
+  channel: BS01_0
+  serviceId: 153
+  isDisabled: true
+
+- name: ＢＳ－ＴＢＳ
+  type: BS
+  channel: BS01_1
+  serviceId: 161
+  isDisabled: true
+
+- name: ＢＳ－ＴＢＳ
+  type: BS
+  channel: BS01_1
+  serviceId: 162
+  isDisabled: true
+
+- name: ＢＳ－ＴＢＳ
+  type: BS
+  channel: BS01_1
+  serviceId: 163
+  isDisabled: true
+
+- name: ＢＳテレ東
+  type: BS
+  channel: BS01_2
+  serviceId: 171
+  isDisabled: true
+
+- name: ＢＳテレ東２
+  type: BS
+  channel: BS01_2
+  serviceId: 172
+  isDisabled: true
+
+- name: ＢＳテレ東３
+  type: BS
+  channel: BS01_2
+  serviceId: 173
+  isDisabled: true
 
-- name: ＮＨＫＢＳプレミアム
+- name: ＢＳ１１イレブン
   type: BS
-  channel: BS03_1
-  serviceId: 103
+  channel: BS09_0
+  serviceId: 211
+  isDisabled: true
 
-- name: ＮＨＫＢＳプレミアム
+- name: ＢＳ１２トゥエルビ
   type: BS
-  channel: BS03_1
-  serviceId: 104
+  channel: BS09_2
+  serviceId: 222
+  isDisabled: true
 
 - name: ＢＳ日テレ
   type: BS
   channel: BS13_0
   serviceId: 141
+  isDisabled: true
 
 - name: ＢＳ日テレ
   type: BS
   channel: BS13_0
   serviceId: 142
+  isDisabled: true
 
-- name: ＢＳ朝日１
-  type: BS
-  channel: BS01_0
-  serviceId: 151
-
-- name: ＢＳ朝日２
+- name: ＢＳ日テレ
   type: BS
-  channel: BS01_0
-  serviceId: 152
+  channel: BS13_0
+  serviceId: 143
+  isDisabled: true
 
-- name: ＢＳ－ＴＢＳ
+- name: ＢＳフジ・１８１
   type: BS
-  channel: BS01_1
-  serviceId: 161
+  channel: BS13_1
+  serviceId: 181
+  isDisabled: true
 
-- name: ＢＳテレ東
+- name: ＢＳフジ・１８２
   type: BS
-  channel: BS01_2
-  serviceId: 171
+  channel: BS13_1
+  serviceId: 182
+  isDisabled: true
 
-- name: ＢＳフジ・１８１
+- name: ＢＳフジ・１８３
   type: BS
   channel: BS13_1
-  serviceId: 181
+  serviceId: 183
+  isDisabled: true
 
-- name: ＷＯＷＯＷプライム
+- name: 放送大学テレビ
   type: BS
-  channel: BS03_0
-  serviceId: 191
+  channel: BS13_2
+  serviceId: 231
   isDisabled: true
 
-- name: ＷＯＷＯＷライブ
+- name: 放送大学テレビ
   type: BS
-  channel: BS05_0
-  serviceId: 192
+  channel: BS13_2
+  serviceId: 232
   isDisabled: true
 
-- name: ＷＯＷＯＷシネマ
+- name: ＮＨＫ　ＢＳ
   type: BS
-  channel: BS05_1
-  serviceId: 193
+  channel: BS15_0
+  serviceId: 101
   isDisabled: true
 
-- name: ＢＳ１１イレブン
+- name: ＮＨＫ　ＢＳ
   type: BS
-  channel: BS09_0
-  serviceId: 211
+  channel: BS15_0
+  serviceId: 102
+  isDisabled: true
 
-- name: ＢＳスカパー！
+- name: ＢＳ１０
   type: BS
-  channel: BS11_1
-  serviceId: 241
+  channel: BS15_2
+  serviceId: 200
+  isDisabled: true
 
-- name: テレ朝チャンネル1
-  type: CS
-  channel: CS2
-  serviceId: 298
+- name: ＢＳよしもと
+  type: BS
+  channel: BS23_1
+  serviceId: 265
   isDisabled: true
 
-- name: テレ朝チャンネル2
-  type: CS
-  channel: CS2
-  serviceId: 299
+- name: ＢＳ松竹東急
+  type: BS
+  channel: BS23_3
+  serviceId: 260
   isDisabled: true
 
-- name: 日テレプラス
+- name: ショップチャンネル
   type: CS
-  channel: CS24
-  serviceId: 300
+  channel: CS8
+  serviceId: 55
   isDisabled: true
 
-- name: AT-X
+- name: ＱＶＣ
   type: CS
-  channel: CS16
-  serviceId: 333
+  channel: CS22
+  serviceId: 161
   isDisabled: true
 
 - name: BS SPTV
@@ -143,17 +200,3 @@
   serviceId: 33353
   satellite: JCSAT3A
   isDisabled: true
-
-- name: AT-X HD
-  type: SKY
-  channel: ATXHD
-  serviceId: 33435
-  satellite: JCSAT3A
-  isDisabled: true
-
-- name: AXN HD
-  type: SKY
-  channel: AXNHD
-  serviceId: 33418
-  satellite: JCSAT4A
-  isDisabled: true