netease-cloudmusic-detector 1.0.0__tar.gz

netease_cloudmusic_detector-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 ButterCookies
+Copyright (c) 2026 YouRan
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

netease_cloudmusic_detector-1.0.0/PKG-INFO

@@ -0,0 +1,75 @@
+Metadata-Version: 2.4
+Name: netease-cloudmusic-detector
+Version: 1.0.0
+Summary: 使用 Python 监听网易云音乐客户端正在播放中的音乐，支持获取 SongId、暂停状态、歌曲进度
+Project-URL: Homepage, https://github.com/YouRanCoder/netease-cloudmusic-detector
+Project-URL: Repository, https://github.com/YouRanCoder/netease-cloudmusic-detector.git
+Author-email: YouRan <205545151@qq.com>
+License: MIT
+License-File: LICENSE
+Keywords: cloudmusic,detector,music,netease
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# netease-cloudmusic-detector (Python 版)
+
+*本项目基于[Coooookies/netease-cloudmusic-detector](https://github.com/Coooookies/netease-cloudmusic-detector)这一开源项目，使用GLM5.0 Turbo进行重写为Python版本，并保留了原作者的LICENSE。在此感谢原作者的开源*
+
+**以下为AIGC内容**
+
+使用 Python 监听网易云音乐客户端正在播放中的音乐。
+
+支持获取 SongId、暂停状态、歌曲进度，歌曲进度跟随进度条拖拽同步。仅支持 3.0 以上客户端。
+
+## 环境要求
+
+- Python >= 3.10
+- Windows 系统已安装网易云音乐客户端 3.0+
+- 客户端至少运行过一次（以生成 elog 文件）
+
+## 安装
+
+```bash
+# 使用 uv
+uv sync
+
+# 或使用 pip
+pip install -e .
+```
+
+## 使用
+
+```bash
+uv run python main.py
+```
+
+## 依赖
+
+无第三方依赖，仅使用 Python 标准库。
+
+## 文件结构
+
+```
+cloudmusic_detector/
+├── __init__.py        # 包入口
+├── elog_analysis.py   # 二进制解码 + 日志头解析
+├── elog_listener.py   # 文件轮询监听
+├── constant.py        # 路径常量 + 事件匹配规则
+├── webdb.py           # SQLite 只读查询
+└── detector.py        # 核心调度器
+main.py               # 示例入口
+test_decode.py         # 测试脚本
+```
+
+## 事件
+
+
+| 事件名     | 触发时机      | 参数              |
+| ---------- | ------------- | ----------------- |
+| `play`     | 切歌时        | `song_id: int`    |
+| `status`   | 播放/暂停切换 | `playing: bool`   |
+| `position` | 进度拖拽      | `position: float` |

netease_cloudmusic_detector-1.0.0/README.md

@@ -0,0 +1,58 @@
+# netease-cloudmusic-detector (Python 版)
+
+*本项目基于[Coooookies/netease-cloudmusic-detector](https://github.com/Coooookies/netease-cloudmusic-detector)这一开源项目，使用GLM5.0 Turbo进行重写为Python版本，并保留了原作者的LICENSE。在此感谢原作者的开源*
+
+**以下为AIGC内容**
+
+使用 Python 监听网易云音乐客户端正在播放中的音乐。
+
+支持获取 SongId、暂停状态、歌曲进度，歌曲进度跟随进度条拖拽同步。仅支持 3.0 以上客户端。
+
+## 环境要求
+
+- Python >= 3.10
+- Windows 系统已安装网易云音乐客户端 3.0+
+- 客户端至少运行过一次（以生成 elog 文件）
+
+## 安装
+
+```bash
+# 使用 uv
+uv sync
+
+# 或使用 pip
+pip install -e .
+```
+
+## 使用
+
+```bash
+uv run python main.py
+```
+
+## 依赖
+
+无第三方依赖，仅使用 Python 标准库。
+
+## 文件结构
+
+```
+cloudmusic_detector/
+├── __init__.py        # 包入口
+├── elog_analysis.py   # 二进制解码 + 日志头解析
+├── elog_listener.py   # 文件轮询监听
+├── constant.py        # 路径常量 + 事件匹配规则
+├── webdb.py           # SQLite 只读查询
+└── detector.py        # 核心调度器
+main.py               # 示例入口
+test_decode.py         # 测试脚本
+```
+
+## 事件
+
+
+| 事件名     | 触发时机      | 参数              |
+| ---------- | ------------- | ----------------- |
+| `play`     | 切歌时        | `song_id: int`    |
+| `status`   | 播放/暂停切换 | `playing: bool`   |
+| `position` | 进度拖拽      | `position: float` |

netease_cloudmusic_detector-1.0.0/cloudmusic_detector/__init__.py

@@ -0,0 +1,49 @@
+"""
+cloudmusic_detector — 网易云音乐播放状态监听库
+
+面向桌面歌词软件的封装接口。
+
+快速上手::
+
+    from cloudmusic_detector import CloudMusic, Track, PlayingState, PlayState
+
+    cm = CloudMusic()
+    cm.on_track_change(lambda track: print(track.name))
+    cm.start()
+
+    state = cm.state  # PlayingState 快照
+    cm.stop()
+
+API 一览::
+
+    cm.state           # PlayingState — 状态+进度+歌曲  (每次调用都是最新快照)
+    cm.track           # Track — 当前歌曲信息
+    cm.is_playing      # bool  — 是否播放中
+    cm.position        # float — 当前进度(秒)
+
+    cm.on_track_change(cb)   # 切歌回调  cb(track: Track)
+    cm.on_state_change(cb)   # 暂停/播放回调  cb(state: PlayingState)
+    cm.on_seek(cb)           # 进度拖拽回调  cb(position: float)
+
+    cm.start()  /  cm.stop()
+
+Asyncio 版本::
+
+    from cloudmusic_detector import AsyncCloudMusic
+    cm = AsyncCloudMusic()
+    await cm.start()
+    state = cm.state
+    await cm.stop()
+"""
+
+from .types import Track, PlayingState, PlayState
+from .api import CloudMusic, AsyncCloudMusic
+
+__all__ = [
+    "CloudMusic",
+    "AsyncCloudMusic",
+    "Track",
+    "PlayingState",
+    "PlayState",
+]
+__version__ = "2.0.0"

netease_cloudmusic_detector-1.0.0/cloudmusic_detector/_constant.py

@@ -0,0 +1,79 @@
+"""内部模块：路径常量与事件匹配规则。"""
+
+import os
+import re
+import json
+from typing import Any, Optional
+
+
+def _get_local_app_data() -> str:
+    if os.name != "nt":
+        return os.environ.get(
+            "CLOUDMUSIC_DIR",
+            os.path.expanduser("~/.local/share/netease-cloudmusic"),
+        )
+    return os.environ.get(
+        "LOCALAPPDATA",
+        os.path.join(os.path.expanduser("~"), "AppData", "Local"),
+    )
+
+
+CLOUDMUSIC_DIR = os.path.join(_get_local_app_data(), "NetEase", "CloudMusic")
+CLOUDMUSIC_ELOG_PATH = os.path.join(CLOUDMUSIC_DIR, "cloudmusic.elog")
+CLOUDMUSIC_WEBDB_PATH = os.path.join(CLOUDMUSIC_DIR, "Library", "webdb.dat")
+
+
+_JSON_RE = re.compile(r"\{.*\}")
+
+
+def _extract_json(row: str) -> Optional[dict]:
+    m = _JSON_RE.search(row)
+    return json.loads(m.group()) if m else None
+
+
+def _extract_group(row: str, pattern: str) -> Optional[str]:
+    m = re.search(pattern, row)
+    return m.group(1) if m else None
+
+
+# 正则预编译
+_RE_POSITION = re.compile(r"【playing】,\"setPlayingPosition\",(\d+(?:\.\d+)?)")
+_RE_STATUS = re.compile(r"【playing】,\"native播放state\",(\d+),")
+
+
+ELOG_RULES = {
+    # 客户端退出
+    "EXIT": {
+        "rule": lambda r: "【app】,{\"actionId\":\"exitApp\"}" in r,
+        "args": lambda r: True,
+    },
+    # checkPlayPrivilege 切歌
+    "SET_PLAYING": {
+        "rule": lambda r: "【playing】,\"checkPlayPrivilege\"," in r,
+        "args": lambda r: _extract_json(r),
+    },
+    # 播放列表切歌
+    "PLAY_ONE_TRACKIN_PLAYING_LIST": {
+        "rule": lambda r: "【playing】,\"playOneTrackInPlayingList\"" in r,
+        "args": lambda r: _extract_json(r),
+    },
+    # 原生播放资源加载完成
+    "NATIVE_SONG_LOAD": {
+        "rule": lambda r: "【playing】,\"native播放资源load完成，开始播放\"" in r,
+        "args": lambda r: _extract_json(r),
+    },
+    # 进度拖拽
+    "SET_PLAYING_POSITION": {
+        "rule": lambda r: "【playing】,\"setPlayingPosition\"" in r,
+        "args": lambda r: _extract_group(r, _RE_POSITION.pattern),
+    },
+    # 播放/暂停状态切换  1=播放  2=暂停
+    "SET_PLAYING_STATUS": {
+        "rule": lambda r: "【playing】,\"native播放state\"" in r,
+        "args": lambda r: _extract_group(r, _RE_STATUS.pattern),
+    },
+}
+
+
+def parse_args(event_type: str, row: str) -> Any:
+    return ELOG_RULES[event_type]["args"](row)

netease_cloudmusic_detector-1.0.0/cloudmusic_detector/_elog_analysis.py

@@ -0,0 +1,83 @@
+"""内部模块：elog 日志解码与解析。"""
+
+import os
+import re
+import time
+from dataclasses import dataclass
+from typing import Optional
+
+
+@dataclass
+class _ElogHeader:
+    pid: str
+    tid: str
+    timestamp: int
+    log_type: str
+    src: str
+    lr: str
+    datetime: str
+
+
+def decode_elog(data: bytes) -> str:
+    """解码 cloudmusic.elog 的自定义二进制编码。"""
+    decoded_bytes = []
+    for byte in data:
+        high = byte >> 4
+        low = byte & 0x0F
+        hex_digit = (high ^ ((low + 8) % 16)) % 16
+        restored = hex_digit * 16 + (byte >> 6) * 4 + (~high & 3)
+        decoded_bytes.append(restored & 0xFF)
+
+    buf = bytes(decoded_bytes)
+    while len(buf) > 0:
+        try:
+            return buf.decode("utf-8")
+        except (UnicodeDecodeError, ValueError):
+            buf = buf[1:]
+    return ""
+
+
+_HEADER_RE = re.compile(
+    r"^\[(\d+):(\d+):(\d{4}/\d{6}:\d+):([A-Z]+):([a-zA-Z0-9._-]+)\((\d+)\)\]\s+"
+    r"\[(\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2})\]"
+)
+
+
+def _get_system_uptime_ms() -> int:
+    if os.name == "nt":
+        import ctypes
+        kernel32 = ctypes.windll.kernel32
+        try:
+            fn = kernel32.GetTickCount64
+            fn.restype = ctypes.c_uint64
+            return int(fn())
+        except AttributeError:
+            return int(kernel32.GetTickCount())
+    else:
+        try:
+            with open("/proc/uptime") as f:
+                return int(float(f.read().split()[0]) * 1000)
+        except (OSError, IOError):
+            return 0
+
+
+def parse_header(row: str) -> Optional[_ElogHeader]:
+    m = _HEADER_RE.match(row)
+    if not m:
+        return None
+    pid, tid, ts_str, log_type, src, lr, dt = m.groups()
+    startup_time = int(ts_str.split(":")[-1])
+    uptime_ms = _get_system_uptime_ms()
+    now_ms = int(time.time() * 1000)
+    return _ElogHeader(
+        pid=pid, tid=tid,
+        timestamp=startup_time + (now_ms - uptime_ms),
+        log_type=log_type, src=src, lr=lr, datetime=dt,
+    )
+
+
+def get_event_type(row: str, rules: dict) -> Optional[str]:
+    for name, cfg in rules.items():
+        if cfg["rule"](row):
+            return name
+    return None

netease_cloudmusic_detector-1.0.0/cloudmusic_detector/_elog_listener.py

@@ -0,0 +1,72 @@
+"""内部模块：elog 文件轮询监听。"""
+
+import os
+import time
+import threading
+from typing import Callable, Optional
+
+from ._elog_analysis import decode_elog
+
+
+class _ElogListener:
+    def __init__(self, file_path: str, poll_interval: float = 0.3):
+        self.file_path = file_path
+        self.poll_interval = poll_interval
+        self._file_size: int = 0
+        self._running: bool = False
+        self._thread: Optional[threading.Thread] = None
+        self._callbacks: list[Callable[[str], None]] = []
+
+    def on_line(self, callback: Callable[[str], None]) -> None:
+        self._callbacks.append(callback)
+
+    def _emit(self, line: str) -> None:
+        line = line.strip()
+        if line:
+            for cb in self._callbacks:
+                cb(line)
+
+    def start(self) -> list[str]:
+        if not os.path.exists(self.file_path):
+            raise FileNotFoundError(
+                f"elog 文件不存在: {self.file_path}\n"
+                f"请确认网易云音乐客户端 (3.0+) 已安装并至少运行过一次。"
+            )
+        with open(self.file_path, "rb") as f:
+            buffer = f.read()
+        lines = decode_elog(buffer).split("\n")
+        self._file_size = len(buffer)
+        self._running = True
+        self._thread = threading.Thread(target=self._poll_loop, daemon=True)
+        self._thread.start()
+        return lines
+
+    def stop(self) -> None:
+        self._running = False
+        if self._thread and self._thread.is_alive():
+            self._thread.join(timeout=2 * self.poll_interval)
+
+    def _poll_loop(self) -> None:
+        while self._running:
+            try:
+                size = os.path.getsize(self.file_path)
+            except OSError:
+                time.sleep(self.poll_interval)
+                continue
+            if size < self._file_size:
+                self._file_size = 0
+                time.sleep(self.poll_interval)
+                continue
+            if size > self._file_size:
+                try:
+                    with open(self.file_path, "rb") as f:
+                        f.seek(self._file_size)
+                        chunk = f.read()
+                except (OSError, IOError):
+                    time.sleep(self.poll_interval)
+                    continue
+                if chunk:
+                    for line in decode_elog(chunk).split("\n"):
+                        self._emit(line)
+                    self._file_size = size
+            time.sleep(self.poll_interval)

netease_cloudmusic_detector-1.0.0/cloudmusic_detector/_webdb.py

@@ -0,0 +1,57 @@
+"""内部模块：webdb.dat SQLite 只读查询。"""
+
+import json
+import sqlite3
+import os
+from typing import Optional
+
+from ._constant import CLOUDMUSIC_WEBDB_PATH
+
+
+class _Webdb:
+    def __init__(self, db_path: Optional[str] = None):
+        self.db_path = db_path or CLOUDMUSIC_WEBDB_PATH
+        self._conn: Optional[sqlite3.Connection] = None
+
+    def _get_conn(self) -> sqlite3.Connection:
+        if self._conn is None:
+            if not os.path.exists(self.db_path):
+                raise FileNotFoundError(f"webdb.dat 不存在: {self.db_path}")
+            self._conn = sqlite3.connect(self.db_path)
+            self._conn.row_factory = sqlite3.Row
+            self._conn.execute("PRAGMA journal_mode = WAL")
+        return self._conn
+
+    def get_song_detail(self, song_id: int) -> Optional[dict]:
+        try:
+            row = self._get_conn().execute(
+                "SELECT playtime, jsonStr FROM historyTracks ORDER BY playtime DESC LIMIT 1"
+            ).fetchone()
+        except (sqlite3.Error, FileNotFoundError):
+            return None
+        if not row:
+            return None
+        try:
+            detail = json.loads(row["jsonStr"])
+        except (json.JSONDecodeError, TypeError):
+            return None
+        return detail if int(detail.get("id", -1)) == song_id else None
+
+    def wait_for_song_detail(self, song_id: int, timeout: float = 2.0) -> Optional[dict]:
+        import time
+        elapsed = 0.0
+        while elapsed < timeout:
+            detail = self.get_song_detail(song_id)
+            if detail:
+                return detail
+            time.sleep(0.1)
+            elapsed += 0.1
+        return None
+
+    def close(self):
+        if self._conn:
+            self._conn.close()
+            self._conn = None
+
+    def __del__(self):
+        self.close()