TonieToolbox 0.1.0__py3-none-any.whl

TonieToolbox/__init__.py

@@ -0,0 +1,5 @@
+"""
+TonieToolbox - Convert audio files to Tonie box compatible format
+"""
+
+__version__ = '0.1.0'

TonieToolbox/__main__.py

@@ -0,0 +1,145 @@
+#!/usr/bin/python3
+"""
+Main entry point for the TonieToolbox package.
+"""
+
+import argparse
+import os
+import sys
+import logging
+
+from . import __version__
+from .audio_conversion import get_input_files, append_to_filename
+from .tonie_file import create_tonie_file
+from .tonie_analysis import check_tonie_file, split_to_opus_files
+from .dependency_manager import get_ffmpeg_binary, get_opus_binary
+from .logger import setup_logging, get_logger
+from .filename_generator import guess_output_filename
+
+def main():
+    """Entry point for the TonieToolbox application."""
+    parser = argparse.ArgumentParser(description='Create Tonie compatible file from Ogg opus file(s).')
+    parser.add_argument('--version', action='version', version=f'TonieToolbox {__version__}',
+                        help='show program version and exit')
+    parser.add_argument('input_filename', metavar='SOURCE', type=str, 
+                        help='input file or directory or a file list (.lst)')
+    parser.add_argument('output_filename', metavar='TARGET', nargs='?', type=str,
+                        help='the output file name (default: ---ID---)')
+    parser.add_argument('--ts', dest='user_timestamp', metavar='TIMESTAMP', action='store',
+                        help='set custom timestamp / bitstream serial')
+
+    parser.add_argument('--ffmpeg', help='specify location of ffmpeg', default=None)
+    parser.add_argument('--opusenc', help='specify location of opusenc', default=None)
+    parser.add_argument('--bitrate', type=int, help='set encoding bitrate in kbps (default: 96)', default=96)
+    parser.add_argument('--cbr', action='store_true', help='encode in cbr mode')
+    parser.add_argument('--append-tonie-tag', metavar='TAG', action='store',
+                        help='append [TAG] to filename (must be an 8-character hex value)')
+    parser.add_argument('--no-tonie-header', action='store_true', help='do not write Tonie header')
+    parser.add_argument('--info', action='store_true', help='Check and display info about Tonie file')
+    parser.add_argument('--split', action='store_true', help='Split Tonie file into opus tracks')
+    parser.add_argument('--auto-download', action='store_true', help='Automatically download FFmpeg and opusenc if needed')
+    parser.add_argument('--keep-temp', action='store_true', 
+                       help='Keep temporary opus files in a temp folder for testing')
+    parser.add_argument('--compare', action='store', metavar='FILE2', 
+                       help='Compare input file with another .taf file for debugging')
+    parser.add_argument('--detailed-compare', action='store_true',
+                       help='Show detailed OGG page differences when comparing files')
+    
+    log_group = parser.add_argument_group('Logging Options')
+    log_level_group = log_group.add_mutually_exclusive_group()
+    log_level_group.add_argument('--debug', action='store_true', help='Enable debug logging')
+    log_level_group.add_argument('--trace', action='store_true', help='Enable trace logging (very verbose)')
+    log_level_group.add_argument('--quiet', action='store_true', help='Show only warnings and errors')
+    log_level_group.add_argument('--silent', action='store_true', help='Show only errors')
+
+    args = parser.parse_args()
+    if args.trace:
+        from .logger import TRACE
+        log_level = TRACE
+    elif args.debug:
+        log_level = logging.DEBUG
+    elif args.quiet:
+        log_level = logging.WARNING
+    elif args.silent:
+        log_level = logging.ERROR
+    else:
+        log_level = logging.INFO
+
+    setup_logging(log_level)
+    logger = get_logger('main')
+    logger.debug("Starting TonieToolbox with log level: %s", logging.getLevelName(log_level))
+
+    ffmpeg_binary = args.ffmpeg
+    if ffmpeg_binary is None:
+        ffmpeg_binary = get_ffmpeg_binary()
+        if ffmpeg_binary is None:
+            logger.error("Could not find FFmpeg. Please install FFmpeg or specify its location using --ffmpeg")
+            sys.exit(1)
+        logger.debug("Using FFmpeg binary: %s", ffmpeg_binary)
+
+    opus_binary = args.opusenc
+    if opus_binary is None:
+        opus_binary = get_opus_binary() 
+        if opus_binary is None:
+            logger.error("Could not find opusenc. Please install opus-tools or specify its location using --opusenc")
+            sys.exit(1)
+        logger.debug("Using opusenc binary: %s", opus_binary)
+
+    if os.path.isdir(args.input_filename):
+        logger.debug("Input is a directory: %s", args.input_filename)
+        args.input_filename += "/*"
+    else:
+        logger.debug("Input is a file: %s", args.input_filename)
+        if args.info:
+            logger.info("Checking Tonie file: %s", args.input_filename)
+            ok = check_tonie_file(args.input_filename)
+            sys.exit(0 if ok else 1)
+        elif args.split:
+            logger.info("Splitting Tonie file: %s", args.input_filename)
+            split_to_opus_files(args.input_filename, args.output_filename)
+            sys.exit(0)
+        elif args.compare:
+            from .tonie_analysis import compare_taf_files
+            logger.info("Comparing Tonie files: %s and %s", args.input_filename, args.compare)
+            result = compare_taf_files(args.input_filename, args.compare, args.detailed_compare)
+            sys.exit(0 if result else 1)
+
+    files = get_input_files(args.input_filename)
+    logger.debug("Found %d files to process", len(files))
+
+    if len(files) == 0:
+        logger.error("No files found for pattern %s", args.input_filename)
+        sys.exit(1)
+
+    if args.output_filename:
+        out_filename = args.output_filename
+    else:
+        guessed_name = guess_output_filename(args.input_filename, files)    
+        output_dir = './output'
+        if not os.path.exists(output_dir):
+            logger.debug("Creating default output directory: %s", output_dir)
+            os.makedirs(output_dir, exist_ok=True)
+        out_filename = os.path.join(output_dir, guessed_name)
+        logger.debug("Using default output location: %s", out_filename)
+
+    if args.append_tonie_tag:
+        # Validate that the value is an 8-character hex value
+        hex_tag = args.append_tonie_tag
+        logger.debug("Validating tag: %s", hex_tag)
+        if not all(c in '0123456789abcdefABCDEF' for c in hex_tag) or len(hex_tag) != 8:
+            logger.error("TAG must be an 8-character hexadecimal value")
+            sys.exit(1)
+        logger.debug("Appending [%s] to output filename", hex_tag)
+        out_filename = append_to_filename(out_filename, hex_tag)
+    
+    if not out_filename.lower().endswith('.taf'):
+        out_filename += '.taf'
+
+    logger.info("Creating Tonie file: %s with %d input file(s)", out_filename, len(files))
+    create_tonie_file(out_filename, files, args.no_tonie_header, args.user_timestamp,
+                     args.bitrate, not args.cbr, ffmpeg_binary, opus_binary, args.keep_temp)
+    logger.info("Successfully created Tonie file: %s", out_filename)
+
+
+if __name__ == "__main__":
+    main()

TonieToolbox/audio_conversion.py

@@ -0,0 +1,194 @@
+"""
+Audio conversion functionality for the TonieToolbox package
+"""
+
+import os
+import glob
+import subprocess
+import tempfile
+from .dependency_manager import get_ffmpeg_binary, get_opus_binary
+from .logger import get_logger
+
+logger = get_logger('audio_conversion')
+
+
+def get_opus_tempfile(ffmpeg_binary=None, opus_binary=None, filename=None, bitrate=48, vbr=True, keep_temp=False):
+    """
+    Convert an audio file to Opus format and return a temporary file handle.
+    
+    Args:
+        ffmpeg_binary: Path to the ffmpeg binary. If None, will be auto-detected or downloaded.
+        opus_binary: Path to the opusenc binary. If None, will be auto-detected or downloaded.
+        filename: Path to the input audio file
+        bitrate: Bitrate for the Opus encoding in kbps
+        vbr: Whether to use variable bitrate encoding
+        keep_temp: Whether to keep the temporary files for testing
+        
+    Returns:
+        tuple: (file handle, temp_file_path) or (file handle, None) if keep_temp is False
+    """
+    logger.debug("Converting %s to Opus format (bitrate: %d kbps, vbr: %s)", filename, bitrate, vbr)
+    
+    if ffmpeg_binary is None:
+        logger.debug("FFmpeg not specified, attempting to auto-detect")
+        ffmpeg_binary = get_ffmpeg_binary()
+        if ffmpeg_binary is None:
+            logger.error("Could not find or download FFmpeg binary")
+            raise RuntimeError("Could not find or download FFmpeg binary")
+        logger.debug("Found FFmpeg at: %s", ffmpeg_binary)
+    
+    if opus_binary is None:
+        logger.debug("Opusenc not specified, attempting to auto-detect")
+        opus_binary = get_opus_binary()
+        if opus_binary is None:
+            logger.error("Could not find or download Opus binary")
+            raise RuntimeError("Could not find or download Opus binary")
+        logger.debug("Found opusenc at: %s", opus_binary)
+    
+    vbr_parameter = "--vbr" if vbr else "--hard-cbr"
+    logger.debug("Using encoding parameter: %s", vbr_parameter)
+
+    temp_path = None
+    if keep_temp:
+        temp_dir = os.path.join(tempfile.gettempdir(), "tonie_toolbox_temp")
+        os.makedirs(temp_dir, exist_ok=True)
+        base_filename = os.path.basename(filename)
+        temp_path = os.path.join(temp_dir, f"{os.path.splitext(base_filename)[0]}_{bitrate}kbps.opus")
+        logger.info("Creating persistent temporary file: %s", temp_path)
+        
+        logger.debug("Starting FFmpeg process")
+        ffmpeg_process = subprocess.Popen(
+            [ffmpeg_binary, "-hide_banner", "-loglevel", "warning", "-i", filename, "-f", "wav",
+             "-ar", "48000", "-"], stdout=subprocess.PIPE)
+             
+        logger.debug("Starting opusenc process")
+        opusenc_process = subprocess.Popen(
+            [opus_binary, "--quiet", vbr_parameter, "--bitrate", f"{bitrate:d}", "-", temp_path],
+            stdin=ffmpeg_process.stdout, stderr=subprocess.DEVNULL)
+        
+        opusenc_process.communicate()
+        
+        if opusenc_process.returncode != 0:
+            logger.error("Opus encoding failed with return code %d", opusenc_process.returncode)
+            raise RuntimeError(f"Opus encoding failed with return code {opusenc_process.returncode}")
+        
+        logger.debug("Opening temporary file for reading")
+        tmp_file = open(temp_path, "rb")
+        return tmp_file, temp_path
+    else:        
+        logger.debug("Using in-memory temporary file")
+        
+        logger.debug("Starting FFmpeg process")
+        ffmpeg_process = subprocess.Popen(
+            [ffmpeg_binary, "-hide_banner", "-loglevel", "warning", "-i", filename, "-f", "wav",
+             "-ar", "48000", "-"], stdout=subprocess.PIPE)
+             
+        logger.debug("Starting opusenc process")
+        opusenc_process = subprocess.Popen(
+            [opus_binary, "--quiet", vbr_parameter, "--bitrate", f"{bitrate:d}", "-", "-"],
+            stdin=ffmpeg_process.stdout, stdout=subprocess.PIPE, stderr=subprocess.DEVNULL)
+
+        tmp_file = tempfile.SpooledTemporaryFile()
+        bytes_written = 0
+        
+        logger.debug("Reading opusenc output")
+        for chunk in iter(lambda: opusenc_process.stdout.read(4096), b""):
+            tmp_file.write(chunk)
+            bytes_written += len(chunk)
+        
+        if opusenc_process.wait() != 0:
+            logger.error("Opus encoding failed with return code %d", opusenc_process.returncode)
+            raise RuntimeError(f"Opus encoding failed with return code {opusenc_process.returncode}")
+        
+        logger.debug("Wrote %d bytes to temporary file", bytes_written)
+        tmp_file.seek(0)
+        
+        return tmp_file, None
+
+
+def filter_directories(glob_list):
+    """
+    Filter a list of glob results to include only audio files that can be handled by ffmpeg.
+    
+    Args:
+        glob_list: List of path names from glob.glob()
+        
+    Returns:
+        list: Filtered list containing only supported audio files
+    """
+    logger.debug("Filtering %d glob results for supported audio files", len(glob_list))
+    
+    # Common audio file extensions supported by ffmpeg
+    supported_extensions = [
+        '.wav', '.mp3', '.aac', '.m4a', '.flac', '.ogg', '.opus',
+        '.ape', '.wma', '.aiff', '.mp2', '.mp4', '.webm', '.mka'
+    ]
+    
+    filtered = []
+    for name in glob_list:
+        if os.path.isfile(name):
+            ext = os.path.splitext(name)[1].lower()
+            if ext in supported_extensions:
+                filtered.append(name)
+                logger.trace("Added supported audio file: %s", name)
+            else:
+                logger.trace("Skipping unsupported file: %s", name)
+    
+    logger.debug("Found %d supported audio files after filtering", len(filtered))
+    return filtered
+
+
+def get_input_files(input_filename):
+    """
+    Get a list of input files to process.
+    
+    Supports direct file paths, directory paths, glob patterns, and .lst files.
+    
+    Args:
+        input_filename: Input file pattern or list file path
+        
+    Returns:
+        list: List of input file paths
+    """
+    logger.debug("Getting input files for pattern: %s", input_filename)
+    
+    if input_filename.endswith(".lst"):
+        logger.debug("Processing list file: %s", input_filename)
+        list_dir = os.path.dirname(os.path.abspath(input_filename))
+        input_files = []
+        with open(input_filename) as file_list:
+            for line in file_list:
+                fname = line.rstrip()
+                full_path = os.path.join(list_dir, fname)
+                input_files.append(full_path)
+                logger.trace("Added file from list: %s", full_path)
+        logger.debug("Found %d files in list file", len(input_files))
+    else:
+        logger.debug("Processing glob pattern: %s", input_filename)
+        input_files = sorted(filter_directories(glob.glob(input_filename)))
+        logger.debug("Found %d files matching pattern", len(input_files))
+    
+    return input_files
+
+
+def append_to_filename(output_filename, tag):
+    """
+    Append a tag to a filename, preserving the extension.
+    
+    Args:
+        output_filename: Original filename
+        tag: Tag to append (typically an 8-character hex value)
+        
+    Returns:
+        str: Modified filename with tag
+    """
+    logger.debug("Appending tag '%s' to filename: %s", tag, output_filename)
+    pos = output_filename.rfind('.')
+    if pos == -1:
+        result = f"{output_filename}_{tag}"
+        logger.debug("No extension found, result: %s", result)
+        return result
+    else:
+        result = f"{output_filename[:pos]}_{tag}{output_filename[pos:]}"
+        logger.debug("Extension found, result: %s", result)
+        return result

TonieToolbox/constants.py

@@ -0,0 +1,14 @@
+"""
+Constants used throughout the TonieToolbox package
+"""
+SAMPLE_RATE_KHZ = 48
+ONLY_CONVERT_FRAMEPACKING = -1
+OTHER_PACKET_NEEDED = -2
+DO_NOTHING = -3
+TOO_MANY_SEGMENTS = -4
+OPUS_TAGS = [
+    bytearray(
+        b"\x4F\x70\x75\x73\x54\x61\x67\x73\x0D\x00\x00\x00\x4C\x61\x76\x66\x35\x38\x2E\x32\x30\x2E\x31\x30\x30\x03\x00\x00\x00\x26\x00\x00\x00\x65\x6E\x63\x6F\x64\x65\x72\x3D\x6F\x70\x75\x73\x65\x6E\x63\x20\x66\x72\x6F\x6D\x20\x6F\x70\x75\x73\x2D\x74\x6F\x6F\x6C\x73\x20\x30\x2E\x31\x2E\x31\x30\x2A\x00\x00\x00\x65\x6E\x63\x6F\x64\x65\x72\x5F\x6F\x70\x74\x69\x6F\x6E\x73\x3D\x2D\x2D\x71\x75\x69\x65\x74\x20\x2D\x2D\x62\x69\x74\x72\x61\x74\x65\x20\x39\x36\x20\x2D\x2D\x76\x62\x72\x3B\x01\x00\x00\x70\x61\x64\x3D\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30"),
+    bytearray(
+        b"\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30\x30")
+]