session_info.py

# session_info.py
#
# This example demonstrates various getter methods of the `ptsl.Engine
# class.
#
# ```sh
# $ python3 examples/session_info.py
# PTSL Version: 4
# Session Name: Test PTSL 3
# Session Path: /Volumes/Projects/Tests/Test PTSL 3/Test PTSL 3.ptx
# Session Sample Rate: 48000
# Session Audio Format: SAF_WAVE
# Session Bit Depth: Bit24
# Session Audio Interlaved: TRUE
# Session Timecode Rate: STCR_Fps23976
# Current System Delay (fs): 0
# Session Start Time: 00:59:57:00.00
# Session Length: 24:00:00:00
# Session feet+frames rate: SFFR_Fps24
# Session Audio Rate Pull: SRP_None
# Session Video Rate Pull: SRP_None
# -------------------------------
# Transport State: TS_TransportStopped
# Transport Arm: SAFE
# Playback Modes: Normal
# Record Mode: 0
# ```


import sys

from ptsl import open_engine, CommandError
from ptsl.PTSL_pb2 import PT_NoOpenedSession
import ptsl.PTSL_pb2 as pt


with open_engine(company_name="py-ptsl",
                 application_name=sys.argv[0]) as engine:

    try:
        print("PTSL Version: %i" % engine.ptsl_version())
        print("Session Name: %s" % engine.session_name())
        print("Session Path: %s" % engine.session_path())
        print("Session Sample Rate: %i" % engine.session_sample_rate())
        print("Session Audio Format: %s" %
              pt.SessionAudioFormat.Name(engine.session_audio_format()))

        print("Session Bit Depth: %s" %
              pt.BitDepth.Name(engine.session_bit_depth()))

        print("Session Audio Interlaved: %s" %
              ("TRUE" if engine.session_interleaved_state() else "FALSE"))

        tc = engine.session_timecode_rate()
        print("Session Timecode Rate: %s" %
              pt.SessionTimeCodeRate.Name(engine.session_timecode_rate()))

        print("Current System Delay (fs): %i" % engine.get_system_delay())

        print("Session Start Time: %s" % engine.session_start_time())
        print("Session Length: %s" % engine.session_length())

        ff = engine.session_feet_frames_rate()
        print("Session feet+frames rate: %s" %
              pt.SessionFeetFramesRate.Name(engine.session_feet_frames_rate()))

        print("Session Audio Rate Pull: %s" %
              pt.SessionRatePull.Name(engine.session_audio_rate_pull()))

        print("Session Video Rate Pull: %s" %
              pt.SessionRatePull.Name(engine.session_video_rate_pull()))

        print("-------------------------------")
        print("Transport State: %s " % engine.transport_state())
        print("Transport Arm: %s" %
              ("ARMED" if engine.transport_armed() else "SAFE"))

        pbm = engine.playback_modes()
        pbms = []
        if pbm[0]:
            pbms.append("Normal")
        if pbm[1]:
            pbms.append("Loop")
        if pbm[2]:
            pbms.append("Dynamic Transport")

        print("Playback Modes: %s" % ", ".join(pbms))

        print("Record Mode: %s" % engine.record_mode())

    except CommandError as e:
        if e.error_response.command_error_type == PT_NoOpenedSession:
            print("No Opened Session, exiting!")
        else:
            print("Command Error, exiting")