1 /* GSequencer - Advanced GTK Sequencer
2  * Copyright (C) 2005-2020 Joël Krähemann
3  *
4  * This file is part of GSequencer.
5  *
6  * GSequencer is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * GSequencer is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with GSequencer.  If not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 #ifndef __AGS_OSC_RESPONSE_H__
21 #define __AGS_OSC_RESPONSE_H__
22 
23 #include <glib.h>
24 #include <glib-object.h>
25 
26 #include <ags/libags.h>
27 
28 #include <time.h>
29 
30 G_BEGIN_DECLS
31 
32 #define AGS_TYPE_OSC_RESPONSE                (ags_osc_response_get_type ())
33 #define AGS_OSC_RESPONSE(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_OSC_RESPONSE, AgsOscResponse))
34 #define AGS_OSC_RESPONSE_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_OSC_RESPONSE, AgsOscResponseClass))
35 #define AGS_IS_OSC_RESPONSE(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_OSC_RESPONSE))
36 #define AGS_IS_OSC_RESPONSE_CLASS(class)     (G_TYPE_CHECK_CLASS_TYPE ((class), AGS_TYPE_OSC_RESPONSE))
37 #define AGS_OSC_RESPONSE_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS ((obj), AGS_TYPE_OSC_RESPONSE, AgsOscResponseClass))
38 
39 #define AGS_OSC_RESPONSE_GET_OBJ_MUTEX(obj) (&(((AgsOscResponse *) obj)->obj_mutex))
40 
41 #define AGS_OSC_RESPONSE_ERROR_MESSAGE_SERVER_FAILURE "server failure"
42 #define AGS_OSC_RESPONSE_ERROR_MESSAGE_MALFORMED_REQUEST "malformed request"
43 #define AGS_OSC_RESPONSE_ERROR_MESSAGE_UNKNOWN_PATH "unknown path"
44 #define AGS_OSC_RESPONSE_ERROR_MESSAGE_UNKNOWN_ARGUMENT "unknown argument"
45 #define AGS_OSC_RESPONSE_ERROR_MESSAGE_MISSING_INDEX "missing index"
46 #define AGS_OSC_RESPONSE_ERROR_MESSAGE_CHUNK_SIZE_EXCEEDED "chunk size exceeded"
47 
48 #define AGS_OSC_RESPONSE_DEFAULT_CHUNK_SIZE (131072)
49 
50 typedef struct _AgsOscResponse AgsOscResponse;
51 typedef struct _AgsOscResponseClass AgsOscResponseClass;
52 
53 /**
54  * AgsOscResponseFlags:
55  * @AGS_OSC_RESPONSE_EMPTY: is empty
56  * @AGS_OSC_RESPONSE_OK: is OK
57  * @AGS_OSC_RESPONSE_ERROR: has error
58  *
59  * Enum values to configure OSC response.
60  */
61 typedef enum{
62   AGS_OSC_RESPONSE_EMPTY     = 1,
63   AGS_OSC_RESPONSE_OK        = 1 <<  1,
64   AGS_OSC_RESPONSE_ERROR     = 1 <<  2,
65 }AgsOscResponseFlags;
66 
67 struct _AgsOscResponse
68 {
69   GObject gobject;
70 
71   guint flags;
72 
73   GRecMutex obj_mutex;
74 
75   guchar *packet;
76   guint packet_size;
77 
78   gchar *error_message;
79 
80   GObject *osc_message;
81 
82   struct timespec *creation_time;
83 };
84 
85 struct _AgsOscResponseClass
86 {
87   GObjectClass gobject;
88 };
89 
90 GType ags_osc_response_get_type(void);
91 
92 gboolean ags_osc_response_test_flags(AgsOscResponse *osc_response, guint flags);
93 void ags_osc_response_set_flags(AgsOscResponse *osc_response, guint flags);
94 void ags_osc_response_unset_flags(AgsOscResponse *osc_response, guint flags);
95 
96 AgsOscResponse* ags_osc_response_new();
97 
98 G_END_DECLS
99 
100 #endif /*__AGS_OSC_RESPONSE_H__*/
101