2 * Advanced Message Queuing Protocol (AMQP) 0-9-1
3 * Copyright (c) 2020 Andriy Gelman
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 #include <amqp_tcp_socket.h>
26 #include "libavutil/avstring.h"
27 #include "libavutil/opt.h"
28 #include "libavutil/time.h"
31 #include "urldecode.h"
33 typedef struct AMQPContext {
35 amqp_connection_state_t conn;
36 amqp_socket_t *socket;
38 const char *routing_key;
40 int64_t connection_timeout;
41 int pkt_size_overflow;
46 #define DEFAULT_CHANNEL 1
48 #define OFFSET(x) offsetof(AMQPContext, x)
49 #define D AV_OPT_FLAG_DECODING_PARAM
50 #define E AV_OPT_FLAG_ENCODING_PARAM
51 static const AVOption options[] = {
52 { "pkt_size", "Maximum send/read packet size", OFFSET(pkt_size), AV_OPT_TYPE_INT, { .i64 = 131072 }, 4096, INT_MAX, .flags = D | E },
53 { "exchange", "Exchange to send/read packets", OFFSET(exchange), AV_OPT_TYPE_STRING, { .str = "amq.direct" }, 0, 0, .flags = D | E },
54 { "routing_key", "Key to filter streams", OFFSET(routing_key), AV_OPT_TYPE_STRING, { .str = "amqp" }, 0, 0, .flags = D | E },
55 { "connection_timeout", "Initial connection timeout", OFFSET(connection_timeout), AV_OPT_TYPE_DURATION, { .i64 = -1 }, -1, INT64_MAX, .flags = D | E},
56 { "delivery_mode", "Delivery mode", OFFSET(delivery_mode), AV_OPT_TYPE_INT, { .i64 = AMQP_DELIVERY_PERSISTENT }, 1, 2, .flags = E, "delivery_mode"},
57 { "persistent", "Persistent delivery mode", 0, AV_OPT_TYPE_CONST, { .i64 = AMQP_DELIVERY_PERSISTENT }, 0, 0, E, "delivery_mode" },
58 { "non-persistent", "Non-persistent delivery mode", 0, AV_OPT_TYPE_CONST, { .i64 = AMQP_DELIVERY_NONPERSISTENT }, 0, 0, E, "delivery_mode" },
62 static int amqp_proto_open(URLContext *h, const char *uri, int flags)
65 char hostname[STR_LEN], credentials[STR_LEN];
67 const char *user, *password = NULL;
68 const char *user_decoded, *password_decoded;
70 amqp_rpc_reply_t broker_reply;
71 struct timeval tval = { 0 };
73 AMQPContext *s = h->priv_data;
76 h->max_packet_size = s->pkt_size;
78 av_url_split(NULL, 0, credentials, sizeof(credentials),
79 hostname, sizeof(hostname), &port, NULL, 0, uri);
84 if (hostname[0] == '\0' || port <= 0 || port > 65535 ) {
85 av_log(h, AV_LOG_ERROR, "Invalid hostname/port\n");
86 return AVERROR(EINVAL);
89 p = strchr(credentials, ':');
95 if (!password || *password == '\0')
98 password_decoded = ff_urldecode(password, 0);
99 if (!password_decoded)
100 return AVERROR(ENOMEM);
106 user_decoded = ff_urldecode(user, 0);
108 av_freep(&password_decoded);
109 return AVERROR(ENOMEM);
112 s->conn = amqp_new_connection();
114 av_freep(&user_decoded);
115 av_freep(&password_decoded);
116 av_log(h, AV_LOG_ERROR, "Error creating connection\n");
117 return AVERROR_EXTERNAL;
120 s->socket = amqp_tcp_socket_new(s->conn);
122 av_log(h, AV_LOG_ERROR, "Error creating socket\n");
123 goto destroy_connection;
126 if (s->connection_timeout < 0)
127 s->connection_timeout = (h->rw_timeout > 0 ? h->rw_timeout : 5000000);
129 tval.tv_sec = s->connection_timeout / 1000000;
130 tval.tv_usec = s->connection_timeout % 1000000;
131 ret = amqp_socket_open_noblock(s->socket, hostname, port, &tval);
134 av_log(h, AV_LOG_ERROR, "Error connecting to server: %s\n",
135 amqp_error_string2(ret));
136 goto destroy_connection;
139 broker_reply = amqp_login(s->conn, "/", 0, s->pkt_size, 0,
140 AMQP_SASL_METHOD_PLAIN, user_decoded, password_decoded);
142 if (broker_reply.reply_type != AMQP_RESPONSE_NORMAL) {
143 av_log(h, AV_LOG_ERROR, "Error login\n");
144 server_msg = AMQP_ACCESS_REFUSED;
145 goto close_connection;
148 amqp_channel_open(s->conn, DEFAULT_CHANNEL);
149 broker_reply = amqp_get_rpc_reply(s->conn);
151 if (broker_reply.reply_type != AMQP_RESPONSE_NORMAL) {
152 av_log(h, AV_LOG_ERROR, "Error set channel\n");
153 server_msg = AMQP_CHANNEL_ERROR;
154 goto close_connection;
157 if (h->flags & AVIO_FLAG_READ) {
158 amqp_bytes_t queuename;
159 char queuename_buff[STR_LEN];
160 amqp_queue_declare_ok_t *r;
162 r = amqp_queue_declare(s->conn, DEFAULT_CHANNEL, amqp_empty_bytes,
163 0, 0, 0, 1, amqp_empty_table);
164 broker_reply = amqp_get_rpc_reply(s->conn);
165 if (!r || broker_reply.reply_type != AMQP_RESPONSE_NORMAL) {
166 av_log(h, AV_LOG_ERROR, "Error declare queue\n");
167 server_msg = AMQP_RESOURCE_ERROR;
171 /* store queuename */
172 queuename.bytes = queuename_buff;
173 queuename.len = FFMIN(r->queue.len, STR_LEN);
174 memcpy(queuename.bytes, r->queue.bytes, queuename.len);
176 amqp_queue_bind(s->conn, DEFAULT_CHANNEL, queuename,
177 amqp_cstring_bytes(s->exchange),
178 amqp_cstring_bytes(s->routing_key), amqp_empty_table);
180 broker_reply = amqp_get_rpc_reply(s->conn);
181 if (broker_reply.reply_type != AMQP_RESPONSE_NORMAL) {
182 av_log(h, AV_LOG_ERROR, "Queue bind error\n");
183 server_msg = AMQP_INTERNAL_ERROR;
187 amqp_basic_consume(s->conn, DEFAULT_CHANNEL, queuename, amqp_empty_bytes,
188 0, 1, 0, amqp_empty_table);
190 broker_reply = amqp_get_rpc_reply(s->conn);
191 if (broker_reply.reply_type != AMQP_RESPONSE_NORMAL) {
192 av_log(h, AV_LOG_ERROR, "Set consume error\n");
193 server_msg = AMQP_INTERNAL_ERROR;
198 av_freep(&user_decoded);
199 av_freep(&password_decoded);
203 amqp_channel_close(s->conn, DEFAULT_CHANNEL, server_msg);
205 amqp_connection_close(s->conn, server_msg);
207 amqp_destroy_connection(s->conn);
209 av_freep(&user_decoded);
210 av_freep(&password_decoded);
211 return AVERROR_EXTERNAL;
214 static int amqp_proto_write(URLContext *h, const unsigned char *buf, int size)
217 AMQPContext *s = h->priv_data;
218 int fd = amqp_socket_get_sockfd(s->socket);
220 amqp_bytes_t message = { size, (void *)buf };
221 amqp_basic_properties_t props;
223 ret = ff_network_wait_fd_timeout(fd, 1, h->rw_timeout, &h->interrupt_callback);
227 props._flags = AMQP_BASIC_CONTENT_TYPE_FLAG | AMQP_BASIC_DELIVERY_MODE_FLAG;
228 props.content_type = amqp_cstring_bytes("octet/stream");
229 props.delivery_mode = s->delivery_mode;
231 ret = amqp_basic_publish(s->conn, DEFAULT_CHANNEL, amqp_cstring_bytes(s->exchange),
232 amqp_cstring_bytes(s->routing_key), 0, 0,
236 av_log(h, AV_LOG_ERROR, "Error publish: %s\n", amqp_error_string2(ret));
237 return AVERROR_EXTERNAL;
243 static int amqp_proto_read(URLContext *h, unsigned char *buf, int size)
245 AMQPContext *s = h->priv_data;
246 int fd = amqp_socket_get_sockfd(s->socket);
249 amqp_rpc_reply_t broker_reply;
250 amqp_envelope_t envelope;
252 ret = ff_network_wait_fd_timeout(fd, 0, h->rw_timeout, &h->interrupt_callback);
256 amqp_maybe_release_buffers(s->conn);
257 broker_reply = amqp_consume_message(s->conn, &envelope, NULL, 0);
259 if (broker_reply.reply_type != AMQP_RESPONSE_NORMAL)
260 return AVERROR_EXTERNAL;
262 if (envelope.message.body.len > size) {
263 s->pkt_size_overflow = FFMAX(s->pkt_size_overflow, envelope.message.body.len);
264 av_log(h, AV_LOG_WARNING, "Message exceeds space in the buffer. "
265 "Message will be truncated. Setting -pkt_size %d "
266 "may resolve this issue.\n", s->pkt_size_overflow);
268 size = FFMIN(size, envelope.message.body.len);
270 memcpy(buf, envelope.message.body.bytes, size);
271 amqp_destroy_envelope(&envelope);
276 static int amqp_proto_close(URLContext *h)
278 AMQPContext *s = h->priv_data;
279 amqp_channel_close(s->conn, DEFAULT_CHANNEL, AMQP_REPLY_SUCCESS);
280 amqp_connection_close(s->conn, AMQP_REPLY_SUCCESS);
281 amqp_destroy_connection(s->conn);
286 static const AVClass amqp_context_class = {
287 .class_name = "amqp",
288 .item_name = av_default_item_name,
290 .version = LIBAVUTIL_VERSION_INT,
293 const URLProtocol ff_libamqp_protocol = {
295 .url_close = amqp_proto_close,
296 .url_open = amqp_proto_open,
297 .url_read = amqp_proto_read,
298 .url_write = amqp_proto_write,
299 .priv_data_size = sizeof(AMQPContext),
300 .priv_data_class = &amqp_context_class,
301 .flags = URL_PROTOCOL_FLAG_NETWORK,