Up  

Module Cry


module Cry: sig .. end
Native implementation of the shout source protocols for icecast and shoutcast.

Description

Cry implements the protocols used to connect and send source data to icecast2 and shoutcast servers.

It is a low-level implementation, so it only does the minimal source connection. In particular, it does not handle synchronisation. Hence, the task of sending audio data to the streaming server at real time rate is up to the programmer, contrary to the main implementation, libshout.

Types and errors



type error =
| Create
| Connect
| Close
| Write
| Read
| Busy
| Not_connected
| Invalid_usage
| Bad_answer of string option
| Http_answer of int * string * string
Possible errors.
exception Error of error
val string_of_error : error -> string
Get a string explaining an error.

type protocol =
| Icy
| Http
Possible protocols. Icy is the (undocumented) shoutcast source protocol. Http is the icecast2 source protocol.

Ogg streaming is only possible with Http. Any headerless format, (e.g. mpeg containers), should work with both protocols, provided you set the correct content-type (mime) for the source.

type content_type
Special type for content-type (mime) data.
val ogg_application : content_type
General mime type for ogg data.
val ogg_audio : content_type
Mime type for audio data encapsulated using ogg.
val ogg_video : content_type
Mime type for video data encapsulated using ogg.
val mpeg : content_type
Mime type for mpeg audio data (mp3).
val content_type_of_string : string -> content_type
Create a mime type from a string (e.g. "audio/aacp")
val string_of_content_type : content_type -> string
Get the string representation of a mime type.

type connection = {
   mount : string;
   user : string;
   password : string;
   host : string;
   port : int;
   content_type : content_type;
   protocol : protocol;
   headers : (string, string) Hashtbl.t;
}
Type for a source connection.

headers is a hash table containing the headers. See connection function for more details.

type audio_info = (string, string) Hashtbl.t
Type for audio informations. Used for connection headers. See audio_info function for more details.
type metadata = (string, string) Hashtbl.t
Type for metadata values.

type status =
| Connected of connection
| Disconnected
Type for the status of a handler.
type t
Type for the main handler.

API


val create : ?ipv6:bool -> ?timeout:float -> ?bind:string -> unit -> t
Create a new handler.

ipv6 is false by default. timeout is 30. (seconds) by default. bind is "0.0.0.0" by default.

val get_status : t -> status
Get a handler's status
val get_icy_cap : t -> bool
Get a handler's ICY capabilities. For the Http protocol, this is always true. For the Icy protocol, this is detected upon connecting.
val get_socket : t -> Unix.file_descr
Get a handler's socket. Use it only if you know what you are doing.

Raises: Error Not_connected if not connected.

val audio_info : ?samplerate:int ->
       ?channels:int -> ?quality:float -> ?bitrate:int -> unit -> audio_info
Create a new audio_info value, filed with given values.
val connection : ?user_agent:string ->
       ?name:string ->
       ?genre:string ->
       ?url:string ->
       ?public:bool ->
       ?audio_info:audio_info ->
       ?description:string ->
       ?host:string ->
       ?port:int ->
       ?password:string ->
       ?protocol:protocol ->
       ?user:string ->
       mount:string -> content_type:content_type -> unit -> connection
Create a new connection value with default values.

host is "localhost" by default. password is "hackme" by default. user is "source" by default. Change user only if you know what your are doing. protocol is Http by default. port is 8000 by default.

The list of preset headers for Http connections is: "User-Agent", "ice-name", "ice-genre", "ice-url", "ice-public", "ice-audio-info", "ice-description".

The list of preset headers for Icy connections is: "User-Agent", "icy-name", "icy-url", "icy-pub", "icy-genre", "icy-br".

Additionally, you can also add: "icy-irc", "icy-icq" and "icy-aim" but these are not added by this function.

val connect : t -> connection -> unit
Connect a handler.
val update_metadata : t -> metadata -> unit
Update metadata on a handler. Useful only for non-ogg data format, and if icy_cap is true for Icy connections.

For Icy protocol, the relevant metadata are only "song" and "url".

Raises: Error Not_connected if not connected.

val manual_update_metadata : host:string ->
       port:int ->
       protocol:protocol ->
       user:string ->
       password:string ->
       mount:string ->
       ?headers:(string, string) Hashtbl.t ->
       ?ipv6:bool -> ?bind:string -> metadata -> unit
Manually update metadata on any source with being connected or streaming.

Use it only if you know what you are doing !

val send : t -> string -> unit
Send data to a source connection.

Raises: Error Not_connected if not connected.

val close : t -> unit
Close a source connection.

Raises: Error Not_connected if not connected.