TonieToolbox 0.5.0a1__py3-none-any.whl → 0.6.0__py3-none-any.whl

TonieToolbox/tonie_analysis.py

@@ -1,3 +1,4 @@
+#!/usr/bin/python3
 """
 Functions for analyzing Tonie files
 """
@@ -10,13 +11,14 @@ from  . import tonie_header_pb2
 from .ogg_page import OggPage
 from .logger import get_logger
 
-logger = get_logger('tonie_analysis')
-def format_time(ts):
+logger = get_logger(__name__)
+
+def format_time(ts: float) -> str:
     """
     Format a timestamp as a human-readable date and time string.
     
     Args:
-        ts: Timestamp to format
+        ts (float): Timestamp to format
         
     Returns:
         str: Formatted date and time string
@@ -24,12 +26,12 @@ def format_time(ts):
     return datetime.datetime.fromtimestamp(ts, datetime.timezone.utc).strftime('%Y-%m-%d %H:%M:%S')
 
 
-def format_hex(data):
+def format_hex(data: bytes) -> str:
     """
     Format binary data as a hex string.
     
     Args:
-        data: Binary data to format
+        data (bytes): Binary data to format
         
     Returns:
         str: Formatted hex string
@@ -37,13 +39,13 @@ def format_hex(data):
     return "".join(format(x, "02X") for x in data)
 
 
-def granule_to_time_string(granule, sample_rate=1):
+def granule_to_time_string(granule: int, sample_rate: int = 1) -> str:
     """
     Convert a granule position to a time string.
     
     Args:
-        granule: Granule position
-        sample_rate: Sample rate in Hz
+        granule (int): Granule position
+        sample_rate (int): Sample rate in Hz
         
     Returns:
         str: Formatted time string (HH:MM:SS.FF)
@@ -56,7 +58,7 @@ def granule_to_time_string(granule, sample_rate=1):
     return "{:02d}:{:02d}:{:02d}.{:02d}".format(hours, minutes, seconds, fraction)
 
 
-def get_header_info(in_file):
+def get_header_info(in_file) -> tuple:
     """
     Get header information from a Tonie file.
     
@@ -164,15 +166,15 @@ def get_header_info(in_file):
     )
 
 
-def get_audio_info(in_file, sample_rate, tonie_header, header_size):
+def get_audio_info(in_file, sample_rate: int, tonie_header, header_size: int) -> tuple:
     """
     Get audio information from a Tonie file.
     
     Args:
         in_file: Input file handle
-        sample_rate: Sample rate in Hz
+        sample_rate (int): Sample rate in Hz
         tonie_header: Tonie header object
-        header_size: Header size in bytes
+        header_size (int): Header size in bytes
         
     Returns:
         tuple: Page count, alignment OK flag, page size OK flag, total time, chapter times
@@ -228,12 +230,12 @@ def get_audio_info(in_file, sample_rate, tonie_header, header_size):
     return page_count, alignment_okay, page_size_okay, total_time, chapter_times
 
 
-def check_tonie_file(filename):
+def check_tonie_file(filename: str) -> bool:
     """
     Check if a file is a valid Tonie file and display information about it.
     
     Args:
-        filename: Path to the file to check
+        filename (str): Path to the file to check
         
     Returns:
         bool: True if the file is valid, False otherwise
@@ -315,13 +317,13 @@ def check_tonie_file(filename):
     return all_ok
 
 
-def split_to_opus_files(filename, output=None):
+def split_to_opus_files(filename: str, output: str = None) -> None:
     """
     Split a Tonie file into individual Opus files.
     
     Args:
-        filename: Path to the Tonie file
-        output: Output directory path (optional)
+        filename (str): Path to the Tonie file
+        output (str | None): Output directory path (optional)
     """
     logger.info("Splitting Tonie file into individual Opus tracks: %s", filename)
     
@@ -412,14 +414,14 @@ def split_to_opus_files(filename, output=None):
         logger.info("Successfully split Tonie file into %d individual tracks", len(tonie_header.chapterPages))
 
 
-def compare_taf_files(file1, file2, detailed=False):
+def compare_taf_files(file1: str, file2: str, detailed: bool = False) -> bool:
     """
     Compare two .taf files for debugging purposes.
     
     Args:
-        file1: Path to the first .taf file
-        file2: Path to the second .taf file
-        detailed: Whether to show detailed comparison results
+        file1 (str): Path to the first .taf file
+        file2 (str): Path to the second .taf file
+        detailed (bool): Whether to show detailed comparison results
         
     Returns:
         bool: True if files are equivalent, False otherwise
@@ -572,7 +574,7 @@ def compare_taf_files(file1, file2, detailed=False):
         logger.info("Files comparison result: Equivalent")
         return True
 
-def get_header_info_cli(in_file):
+def get_header_info_cli(in_file) -> tuple:
     """
     Get header information from a Tonie file.
     
@@ -687,12 +689,12 @@ def get_header_info_cli(in_file):
         return (0, tonie_header_pb2.TonieHeader(), 0, 0, None, False, 0, 0, 0, 0, {}, False)
 
 
-def check_tonie_file_cli(filename):
+def check_tonie_file_cli(filename: str) -> bool:
     """
     Check if a file is a valid Tonie file
     
     Args:
-        filename: Path to the file to check
+        filename (str): Path to the file to check
         
     Returns:
         bool: True if the file is valid, False otherwise

TonieToolbox/tonie_file.py

@@ -1,3 +1,4 @@
+#!/usr/bin/python3
 """
 Tonie file operations module
 """
@@ -15,18 +16,17 @@ from .ogg_page import OggPage
 from .constants import OPUS_TAGS, SAMPLE_RATE_KHZ, TIMESTAMP_DEDUCT
 from .logger import get_logger
 
-# Setup logging
-logger = get_logger('tonie_file')
+logger = get_logger(__name__)
 
 
-def toniefile_comment_add(buffer, length, comment_str):
+def toniefile_comment_add(buffer: bytearray, length: int, comment_str: str) -> int:
     """
     Add a comment string to an Opus comment packet buffer.
     
     Args:
-        buffer: Bytearray buffer to add comment to
-        length: Current position in the buffer
-        comment_str: Comment string to add
+        buffer (bytearray): Bytearray buffer to add comment to
+        length (int): Current position in the buffer
+        comment_str (str): Comment string to add
         
     Returns:
         int: New position in the buffer after adding comment
@@ -38,7 +38,6 @@ def toniefile_comment_add(buffer, length, comment_str):
     buffer[length:length+4] = struct.pack("<I", str_length)
     length += 4
     
-    # Add the actual string
     buffer[length:length+str_length] = comment_str.encode('utf-8')
     length += str_length
     
@@ -46,7 +45,7 @@ def toniefile_comment_add(buffer, length, comment_str):
     return length
 
 
-def check_identification_header(page):
+def check_identification_header(page) -> None:
     """
     Check if a page contains a valid Opus identification header.
     
@@ -79,16 +78,16 @@ def check_identification_header(page):
     logger.debug("Opus identification header is valid")
 
 
-def prepare_opus_tags(page, custom_tags=False, bitrate=64, vbr=True, opus_binary=None):
+def prepare_opus_tags(page, custom_tags: bool = False, bitrate: int = 64, vbr: bool = True, opus_binary: str = None) -> OggPage:
     """
     Prepare standard Opus tags for a Tonie file.
     
     Args:
         page: OggPage to modify
-        custom_tags: Whether to use custom TonieToolbox tags instead of default ones
-        bitrate: Actual bitrate used for encoding
-        vbr: Whether variable bitrate was used
-        opus_binary: Path to opusenc binary for version detection
+        custom_tags (bool): Whether to use custom TonieToolbox tags instead of default ones
+        bitrate (int): Actual bitrate used for encoding
+        vbr (bool): Whether variable bitrate was used
+        opus_binary (str | None): Path to opusenc binary for version detection
         
     Returns:
         OggPage: Modified page with Tonie-compatible Opus tags
@@ -115,49 +114,38 @@ def prepare_opus_tags(page, custom_tags=False, bitrate=64, vbr=True, opus_binary
         # Use custom tags for TonieToolbox
         # Create buffer for opus tags (similar to teddyCloud implementation)
         logger.debug("Creating custom Opus tags")
-        comment_data = bytearray(0x1B4)  # Same size as in teddyCloud
-        
-        # OpusTags signature
+        comment_data = bytearray(0x1B4)
         comment_data_pos = 0
         comment_data[comment_data_pos:comment_data_pos+8] = b"OpusTags"
-        comment_data_pos += 8
-        
+        comment_data_pos += 8        
         # Vendor string
-        comment_data_pos = toniefile_comment_add(comment_data, comment_data_pos, "TonieToolbox")
-        
+        comment_data_pos = toniefile_comment_add(comment_data, comment_data_pos, "TonieToolbox")        
         # Number of comments (3 comments: version, encoder info, and encoder options)
         comments_count = 3
         comment_data[comment_data_pos:comment_data_pos+4] = struct.pack("<I", comments_count)
-        comment_data_pos += 4
-        
+        comment_data_pos += 4        
         # Add version information
         from . import __version__
         version_str = f"version={__version__}"
-        comment_data_pos = toniefile_comment_add(comment_data, comment_data_pos, version_str)
-        
+        comment_data_pos = toniefile_comment_add(comment_data, comment_data_pos, version_str)        
         # Get actual opusenc version
         from .dependency_manager import get_opus_version
         encoder_info = get_opus_version(opus_binary)
-        comment_data_pos = toniefile_comment_add(comment_data, comment_data_pos, f"encoder={encoder_info}")
-        
+        comment_data_pos = toniefile_comment_add(comment_data, comment_data_pos, f"encoder={encoder_info}")        
         # Create encoder options string with actual settings
         vbr_opt = "--vbr" if vbr else "--cbr"
         encoder_options = f"encoder_options=--bitrate {bitrate} {vbr_opt}"
-        comment_data_pos = toniefile_comment_add(comment_data, comment_data_pos, encoder_options)
-        
+        comment_data_pos = toniefile_comment_add(comment_data, comment_data_pos, encoder_options)        
         # Add padding
         remain = len(comment_data) - comment_data_pos - 4
         comment_data[comment_data_pos:comment_data_pos+4] = struct.pack("<I", remain)
         comment_data_pos += 4
-        comment_data[comment_data_pos:comment_data_pos+4] = b"pad="
-        
+        comment_data[comment_data_pos:comment_data_pos+4] = b"pad="        
         # Create segments - handle data in chunks of 255 bytes maximum
-        comment_data = comment_data[:comment_data_pos + remain]  # Trim to actual used size
-        
+        comment_data = comment_data[:comment_data_pos + remain]  # Trim to actual used size        
         # Split large data into smaller segments (each <= 255 bytes)
         remaining_data = comment_data
-        first_segment = True
-        
+        first_segment = True        
         while remaining_data:
             chunk_size = min(255, len(remaining_data))
             segment = OpusPacket(None)
@@ -175,19 +163,28 @@ def prepare_opus_tags(page, custom_tags=False, bitrate=64, vbr=True, opus_binary
     return page
 
 
-def copy_first_and_second_page(in_file, out_file, timestamp, sha, use_custom_tags=True, bitrate=64, vbr=True, opus_binary=None):
+def copy_first_and_second_page(
+    in_file,
+    out_file,
+    timestamp: int,
+    sha,
+    use_custom_tags: bool = True,
+    bitrate: int = 64,
+    vbr: bool = True,
+    opus_binary: str = None
+) -> None:
     """
     Copy and modify the first two pages of an Opus file for a Tonie file.
     
     Args:
         in_file: Input file handle
         out_file: Output file handle
-        timestamp: Timestamp to use for the Tonie file
+        timestamp (int): Timestamp to use for the Tonie file
         sha: SHA1 hash object to update with written data
-        use_custom_tags: Whether to use custom TonieToolbox tags
-        bitrate: Actual bitrate used for encoding
-        vbr: Whether VBR was used
-        opus_binary: Path to opusenc binary
+        use_custom_tags (bool): Whether to use custom TonieToolbox tags
+        bitrate (int): Actual bitrate used for encoding
+        vbr (bool): Whether VBR was used
+        opus_binary (str | None): Path to opusenc binary
     """
     logger.debug("Copying first and second pages with timestamp %d", timestamp)
     found = OggPage.seek_to_page_header(in_file)
@@ -215,7 +212,7 @@ def copy_first_and_second_page(in_file, out_file, timestamp, sha, use_custom_tag
     logger.debug("Second page written successfully")
 
 
-def skip_first_two_pages(in_file):
+def skip_first_two_pages(in_file) -> None:
     """
     Skip the first two pages of an Opus file.
     
@@ -248,7 +245,7 @@ def skip_first_two_pages(in_file):
     logger.debug("First two pages skipped successfully")
 
 
-def read_all_remaining_pages(in_file):
+def read_all_remaining_pages(in_file) -> list:
     """
     Read all remaining OGG pages from an input file.
     
@@ -273,19 +270,26 @@ def read_all_remaining_pages(in_file):
     return remaining_pages
 
 
-def resize_pages(old_pages, max_page_size, first_page_size, template_page, last_granule=0, start_no=2,
-                set_last_page_flag=False):
+def resize_pages(
+    old_pages: list,
+    max_page_size: int,
+    first_page_size: int,
+    template_page,
+    last_granule: int = 0,
+    start_no: int = 2,
+    set_last_page_flag: bool = False
+) -> list:
     """
     Resize OGG pages to fit Tonie requirements.
     
     Args:
-        old_pages: List of original OggPage objects
-        max_page_size: Maximum size for pages
-        first_page_size: Size for the first page
+        old_pages (list): List of original OggPage objects
+        max_page_size (int): Maximum size for pages
+        first_page_size (int): Size for the first page
         template_page: Template OggPage to use for creating new pages
-        last_granule: Last granule position
-        start_no: Starting page number
-        set_last_page_flag: Whether to set the last page flag
+        last_granule (int): Last granule position
+        start_no (int): Starting page number
+        set_last_page_flag (bool): Whether to set the last page flag
         
     Returns:
         list: List of resized OggPage objects
@@ -339,14 +343,14 @@ def resize_pages(old_pages, max_page_size, first_page_size, template_page, last_
     return new_pages
 
 
-def fix_tonie_header(out_file, chapters, timestamp, sha):
+def fix_tonie_header(out_file, chapters: list, timestamp: int, sha) -> None:
     """
     Fix the Tonie header in a file.
     
     Args:
         out_file: Output file handle
-        chapters: List of chapter page numbers
-        timestamp: Timestamp for the Tonie file
+        chapters (list): List of chapter page numbers
+        timestamp (int): Timestamp for the Tonie file
         sha: SHA1 hash object with file content
     """
     logger.info("Writing Tonie header with %d chapters and timestamp %d", len(chapters), timestamp)
@@ -375,31 +379,43 @@ def fix_tonie_header(out_file, chapters, timestamp, sha):
     logger.debug("Tonie header written successfully (size: %d bytes)", len(header))
 
 
-def create_tonie_file(output_file, input_files, no_tonie_header=False, user_timestamp=None,
-                     bitrate=96, vbr=True, ffmpeg_binary=None, opus_binary=None, keep_temp=False, auto_download=False, 
-                     use_custom_tags=True):
+def create_tonie_file(
+    output_file: str,
+    input_files: list[str],
+    no_tonie_header: bool = False,
+    user_timestamp: str = None,
+    bitrate: int = 96,
+    vbr: bool = True,
+    ffmpeg_binary: str = None,
+    opus_binary: str = None,
+    keep_temp: bool = False,
+    auto_download: bool = False,
+    use_custom_tags: bool = True,
+    no_mono_conversion: bool = False
+) -> None:
     """
     Create a Tonie file from input files.
     
     Args:
-        output_file: Output file path
-        input_files: List of input file paths
-        no_tonie_header: Whether to omit the Tonie header
-        user_timestamp: Custom timestamp to use
-        bitrate: Bitrate for encoding in kbps
-        vbr: Whether to use variable bitrate encoding (True) or constant (False)
-        ffmpeg_binary: Path to ffmpeg binary
-        opus_binary: Path to opusenc binary
-        keep_temp: Whether to keep temporary opus files for testing
-        auto_download: Whether to automatically download dependencies if not found
-        use_custom_tags: Whether to use dynamic comment tags generated with toniefile_comment_add
+        output_file (str): Output file path
+        input_files (list[str]): List of input file paths
+        no_tonie_header (bool): Whether to omit the Tonie header
+        user_timestamp (str | None): Custom timestamp to use
+        bitrate (int): Bitrate for encoding in kbps
+        vbr (bool): Whether to use variable bitrate encoding (True) or constant (False)
+        ffmpeg_binary (str | None): Path to ffmpeg binary
+        opus_binary (str | None): Path to opusenc binary
+        keep_temp (bool): Whether to keep temporary opus files for testing
+        auto_download (bool): Whether to automatically download dependencies if not found
+        use_custom_tags (bool): Whether to use dynamic comment tags generated with toniefile_comment_add
+        no_mono_conversion (bool): Whether to skip mono conversion during audio processing
     """
     from .audio_conversion import get_opus_tempfile
     
     logger.trace("Entering create_tonie_file(output_file=%s, input_files=%s, no_tonie_header=%s, user_timestamp=%s, "
-                "bitrate=%d, vbr=%s, ffmpeg_binary=%s, opus_binary=%s, keep_temp=%s, auto_download=%s, use_custom_tags=%s)",
+                "bitrate=%d, vbr=%s, ffmpeg_binary=%s, opus_binary=%s, keep_temp=%s, auto_download=%s, use_custom_tags=%s, no_mono_conversion=%s)",
                 output_file, input_files, no_tonie_header, user_timestamp, bitrate, vbr, ffmpeg_binary, 
-                opus_binary, keep_temp, auto_download, use_custom_tags)
+                opus_binary, keep_temp, auto_download, use_custom_tags, no_mono_conversion)
     
     logger.info("Creating Tonie file from %d input files", len(input_files))
     logger.debug("Output file: %s, Bitrate: %d kbps, VBR: %s, No header: %s", 
@@ -465,9 +481,9 @@ def create_tonie_file(output_file, input_files, no_tonie_header=False, user_time
                 handle = open(fname, "rb")
                 temp_file_path = None
             else:
-                logger.debug("Converting %s to Opus format (bitrate: %d kbps, VBR: %s)", 
-                            fname, bitrate, vbr)
-                handle, temp_file_path = get_opus_tempfile(ffmpeg_binary, opus_binary, fname, bitrate, vbr, keep_temp, auto_download)
+                logger.debug("Converting %s to Opus format (bitrate: %d kbps, VBR: %s, no_mono_conversion: %s)", 
+                            fname, bitrate, vbr, no_mono_conversion)
+                handle, temp_file_path = get_opus_tempfile(ffmpeg_binary, opus_binary, fname, bitrate, vbr, keep_temp, auto_download, no_mono_conversion=no_mono_conversion)
                 if temp_file_path:
                     temp_files.append(temp_file_path)
                     logger.debug("Temporary opus file saved to: %s", temp_file_path)