Osc4py3 documentation

• Module documentation (on Read The Docs)
• Subversion repository & bug tracking (on french academic SourceSup site).
• Developer page

Osc4py3 is an implementation of Open Sound Control (OSC) message transport protocol within a Python3 package.

It manages different sides of OSC in possibly different contexts:

• encoding/decoding of OSC message packets (including bundles)
• routing of incoming messages based on selector regexps or globbing
• timed messages with possible delay period
• named client/server for sending/subscribing (light coupling)
• different scheduling models (single process, totally multithread, only multithread for communications)
• extra processing of packets (hack points to encrypt/decrypt, sign/verify…)

Note: routing, timed messages, named client/server, scheduling models make a complex system (see the “big picture” in doc). The oscbuildparse module of osc4py3 package can be used as is and provides nice OSC packets encoding/decoding functions usable in your own message transmission scheme.

The documentation is splitted in two main parts, a user guide for simple package use, and a developer guide explaining how things are organized and work together.

Contents

• 1. Usage
  • 1.1. Introduction
    • 1.1.1. What is osc4py3?
    • 1.1.2. What Python?
    • 1.1.3. Why?
    • 1.1.4. What’s new?
    • 1.1.5. Complicated to use?
  • 1.2. Quick OSC
    • 1.2.1. Messages
  • 1.3. Simple use
    • 1.3.1. Examples
    • 1.3.2. Sending messages
    • 1.3.3. Message handlers
    • 1.3.4. Threading model
    • 1.3.5. Servers channels
    • 1.3.6. Client channels
    • 1.3.7. Light coupling
    • 1.3.8. Logging OSC operations
    • 1.3.9. Advanced pattern/handler
  • 1.4. User main functions
• 2. Messages and Bundles
  • 2.1. Programming interface
    • 2.1.1. OSC Messages
    • 2.1.2. OSC Bundles
    • 2.1.3. Supported atomic data types
    • 2.1.4. Automatic type tagging
  • 2.2. Errors
    • 2.2.1. OSCError
    • 2.2.2. OSCInvalidDataError
    • 2.2.3. OSCInvalidRawError
    • 2.2.4. OSCInternalBugError
    • 2.2.5. OSCUnknownTypetagError
    • 2.2.6. OSCInvalidSignatureError
    • 2.2.7. OSCCorruptedRawError
  • 2.3. Out of band options
    • 2.3.1. Supported data types
    • 2.3.2. Strings encoding
    • 2.3.3. Compression of addresses
    • 2.3.4. Basic messages controls
    • 2.3.5. Dump of packets
    • 2.3.6. Advanced control
  • 2.4. Code documentation
• 3. Development
  • 3.1. Implementation Modules
    • 3.1.1. oscbuildparse
    • 3.1.2. oscmethod
  • 3.2. Core Modules
    • 3.2.1. oscchannel
    • 3.2.2. oscscheduling
    • 3.2.3. oscdistributing
    • 3.2.4. oscdispatching
  • 3.3. Specialized Tools
    • 3.3.1. oscpacketoptions
    • 3.3.2. osctoolspools
    • 3.3.3. oscnettools
  • 3.4. Transport Protocol
    • 3.4.1. Base transport class
    • 3.4.2. Datagram transport class
    • 3.4.3. Stream transport class
  • 3.5. User Helpers
    • 3.5.1. as_eventloop
    • 3.5.2. as_allthreads
    • 3.5.3. as_comthreads
  • 3.6. Action Handlers
    • 3.6.1. Generic
    • 3.6.2. UDP
    • 3.6.3. TCP