1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
|
/*
* GStreamer
* Copyright 2007 Ole André Vadla Ravnås <ole.andre.ravnas@tandberg.com>
* Copyright 2007 Ali Sabil <ali.sabil@tandberg.com>
* Copyright 2008 Barracuda Networks <justin@affinix.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
/**
* SECTION:element-osxvideosrc
*
* <refsect2>
* osxvideosrc can be used to capture video from capture devices on OS X.
* <title>Example launch line</title>
* <para>
* <programlisting>
* gst-launch osxvideosrc ! osxvideosink
* </programlisting>
* This pipeline shows the video captured from the default capture device.
* </para>
* </refsect2>
*/
#ifdef HAVE_CONFIG_H
# include <config.h>
#endif
#include <string.h>
// for usleep
#include <unistd.h>
#include <gst/interfaces/propertyprobe.h>
#include "osxvideosrc.h"
/* for now, framerate is hard-coded */
#define FRAMERATE 30
// TODO: for completeness, write an _unlock function
/*
QuickTime notes:
EnterMovies
initialize QT subsystem
there is no deinit
OpenDefaultComponent of type SeqGrabComponentType
this gets a handle to a sequence grabber
CloseComponent
release the sequence grabber
SGInitialize
initialize the SG
there is no deinit, simply close the component
SGSetDataRef of seqGrabDontMakeMovie
this is to disable file creation. we only want frames
SGNewChannel of VideoMediaType
make a video capture channel
QTNewGWorld
specify format (e.g. k32ARGBPixelFormat)
specify size
LockPixels
this makes it so the base address of the image doesn't "move".
you can UnlockPixels also, if you care to.
CocoaSequenceGrabber locks (GetPortPixMap(gWorld)) for the entire session.
it also locks/unlocks the pixmaphandle
[ PixMapHandle pixMapHandle = GetGWorldPixMap(gworld); ]
during the moment where it extracts the frame from the gworld
SGSetGWorld
assign the gworld to the component
pass GetMainDevice() as the last arg, which is just a formality?
SGSetChannelBounds
use this to set our desired capture size. the camera might not actually
capture at this size, but it will pick something close.
SGSetChannelUsage of seqGrabRecord
enable recording
SGSetDataProc
set callback handler
SGPrepare
prepares for recording. this initializes the camera (the light should
come on) so that when you call SGStartRecord you hit the ground running.
maybe we should call SGPrepare when READY->PAUSED happens?
SGRelease
unprepare the recording
SGStartRecord
kick off the recording
SGStop
stop recording
SGGetChannelSampleDescription
obtain the size the camera is actually capturing at
DecompressSequenceBegin
i'm pretty sure you have to use this to receive the raw frames.
you can also use it to scale the image. to scale, create a matrix
from the source and desired sizes and pass the matrix to this function.
*** deprecated: use DecompressSequenceBeginS instead
CDSequenceEnd
stop a decompress sequence
DecompressSequenceFrameS
use this to obtain a raw frame. the result ends up in the gworld
*** deprecated: use DecompressSequenceFrameWhen instead
SGGetChannelDeviceList of sgDeviceListIncludeInputs
obtain the list of devices for the video channel
SGSetChannelDevice
set the master device (DV, USB, etc) on the channel, by string name
SGSetChannelDeviceInput
set the sub device on the channel (iSight), by integer id
device ids should be a concatenation of the above two values.
*/
GST_DEBUG_CATEGORY (gst_debug_osx_video_src);
#define GST_CAT_DEFAULT gst_debug_osx_video_src
/* Filter signals and args */
enum
{
/* FILL ME */
LAST_SIGNAL
};
enum
{
ARG_0,
ARG_DEVICE,
ARG_DEVICE_NAME
};
static GstStaticPadTemplate src_template = GST_STATIC_PAD_TEMPLATE ("src",
GST_PAD_SRC,
GST_PAD_ALWAYS,
GST_STATIC_CAPS ("video/x-raw-yuv, "
"format = (fourcc) UYVY, "
"width = (int) [ 1, MAX ], " "height = (int) [ 1, MAX ], "
//"framerate = (fraction) 0/1")
"framerate = (fraction) 30/1")
);
static void
gst_osx_video_src_init_interfaces (GType type);
static void
gst_osx_video_src_type_add_device_property_probe_interface (GType type);
GST_BOILERPLATE_FULL (GstOSXVideoSrc, gst_osx_video_src, GstPushSrc,
GST_TYPE_PUSH_SRC, gst_osx_video_src_init_interfaces);
static void gst_osx_video_src_dispose (GObject * object);
static void gst_osx_video_src_finalize (GstOSXVideoSrc * osx_video_src);
static void gst_osx_video_src_set_property (GObject * object,
guint prop_id, const GValue * value, GParamSpec * pspec);
static void gst_osx_video_src_get_property (GObject * object,
guint prop_id, GValue * value, GParamSpec * pspec);
static GstStateChangeReturn gst_osx_video_src_change_state (GstElement *
element, GstStateChange transition);
static GstCaps *gst_osx_video_src_get_caps (GstBaseSrc * src);
static gboolean gst_osx_video_src_set_caps (GstBaseSrc * src,
GstCaps * caps);
static gboolean gst_osx_video_src_start (GstBaseSrc * src);
static gboolean gst_osx_video_src_stop (GstBaseSrc * src);
static gboolean gst_osx_video_src_query (GstBaseSrc * bsrc,
GstQuery * query);
static GstFlowReturn gst_osx_video_src_create (GstPushSrc * src,
GstBuffer ** buf);
static void gst_osx_video_src_fixate (GstBaseSrc * bsrc, GstCaps * caps);
static gboolean prepare_capture (GstOSXVideoSrc * self);
/* \ = \\, : = \c */
static GString *escape_string (const GString * in)
{
GString *out;
int n;
out = g_string_sized_new (64);
for (n = 0; n < (int) in->len; ++n) {
if (in->str[n] == '\\')
g_string_append (out, "\\\\");
else if (in->str[n] == ':')
g_string_append (out, "\\:");
else
g_string_append_c (out, in->str[n]);
}
return out;
}
/* \\ = \, \c = : */
static GString *
unescape_string (const GString * in)
{
GString *out;
int n;
out = g_string_sized_new (64);
for (n = 0; n < (int) in->len; ++n) {
if (in->str[n] == '\\') {
if (n + 1 < (int) in->len) {
++n;
if (in->str[n] == '\\')
g_string_append_c (out, '\\');
else if (in->str[n] == 'c')
g_string_append_c (out, ':');
else {
/* unknown code, we will eat the escape sequence */
}
} else {
/* string ends with backslash, we will eat it */
}
} else
g_string_append_c (out, in->str[n]);
}
return out;
}
static gchar *
create_device_id (const gchar * sgname, int inputIndex)
{
GString *out;
GString *name;
GString *nameenc;
gchar *ret;
name = g_string_new (sgname);
nameenc = escape_string (name);
g_string_free (name, TRUE);
if (inputIndex >= 0) {
out = g_string_new ("");
g_string_printf (out, "%s:%d", nameenc->str, inputIndex);
} else {
/* unspecified index */
out = g_string_new (nameenc->str);
}
g_string_free (nameenc, TRUE);
ret = g_string_free (out, FALSE);
return ret;
}
static gboolean
parse_device_id (const gchar * id, gchar ** sgname, int *inputIndex)
{
gchar **parts;
int numparts;
GString *p1;
GString *out1;
int out2 = 0;
parts = g_strsplit (id, ":", -1);
numparts = 0;
while (parts[numparts])
++numparts;
/* must be exactly 1 or 2 parts */
if (numparts < 1 || numparts > 2) {
g_strfreev (parts);
return FALSE;
}
p1 = g_string_new (parts[0]);
out1 = unescape_string (p1);
g_string_free (p1, TRUE);
if (numparts >= 2) {
errno = 0;
out2 = strtol (parts[1], NULL, 10);
if (out2 == 0 && (errno == ERANGE || errno == EINVAL)) {
g_string_free (out1, TRUE);
g_strfreev (parts);
return FALSE;
}
}
g_strfreev (parts);
*sgname = g_string_free (out1, FALSE);
*inputIndex = out2;
return TRUE;
}
typedef struct
{
gchar *id;
gchar *name;
} video_device;
static video_device *
video_device_alloc (void)
{
video_device *dev;
dev = g_malloc (sizeof (video_device));
dev->id = NULL;
dev->name = NULL;
return dev;
}
static void
video_device_free (video_device * dev)
{
if (!dev)
return;
if (dev->id)
g_free (dev->id);
if (dev->name)
g_free (dev->name);
g_free (dev);
}
static void
video_device_free_func (gpointer data, gpointer user_data)
{
video_device_free ((video_device *) data);
}
/* return a list of available devices. the default device (if any) will be
* the first in the list.
*/
static GList *
device_list (GstOSXVideoSrc * src)
{
SeqGrabComponent component = NULL;
SGChannel channel;
SGDeviceList deviceList;
SGDeviceName *deviceEntry;
SGDeviceInputList inputList;
SGDeviceInputName *inputEntry;
ComponentResult err;
int n, i;
GList *list;
video_device *dev, *default_dev;
gchar sgname[256];
gchar friendly_name[256];
list = NULL;
default_dev = NULL;
if (src->video_chan) {
/* if we already have a video channel allocated, use that */
GST_DEBUG_OBJECT (src, "reusing existing channel for device_list");
channel = src->video_chan;
} else {
/* otherwise, allocate a temporary one */
component = OpenDefaultComponent (SeqGrabComponentType, 0);
if (!component) {
err = paramErr;
GST_ERROR_OBJECT (src, "OpenDefaultComponent failed. paramErr=%d",
(int) err);
goto end;
}
err = SGInitialize (component);
if (err != noErr) {
GST_ERROR_OBJECT (src, "SGInitialize returned %d", (int) err);
goto end;
}
err = SGSetDataRef (component, 0, 0, seqGrabDontMakeMovie);
if (err != noErr) {
GST_ERROR_OBJECT (src, "SGSetDataRef returned %d", (int) err);
goto end;
}
err = SGNewChannel (component, VideoMediaType, &channel);
if (err != noErr) {
GST_ERROR_OBJECT (src, "SGNewChannel returned %d", (int) err);
goto end;
}
}
err =
SGGetChannelDeviceList (channel, sgDeviceListIncludeInputs, &deviceList);
if (err != noErr) {
GST_ERROR_OBJECT (src, "SGGetChannelDeviceList returned %d", (int) err);
goto end;
}
for (n = 0; n < (*deviceList)->count; ++n) {
deviceEntry = &(*deviceList)->entry[n];
if (deviceEntry->flags & sgDeviceNameFlagDeviceUnavailable)
continue;
p2cstrcpy (sgname, deviceEntry->name);
inputList = deviceEntry->inputs;
if (inputList && (*inputList)->count >= 1) {
for (i = 0; i < (*inputList)->count; ++i) {
inputEntry = &(*inputList)->entry[i];
p2cstrcpy (friendly_name, inputEntry->name);
dev = video_device_alloc ();
dev->id = create_device_id (sgname, i);
if (!dev->id) {
video_device_free (dev);
i = -1;
break;
}
dev->name = g_strdup (friendly_name);
list = g_list_append (list, dev);
/* if this is the default device, note it */
if (n == (*deviceList)->selectedIndex
&& i == (*inputList)->selectedIndex) {
default_dev = dev;
}
}
/* error */
if (i == -1)
break;
} else {
/* ### can a device have no defined inputs? */
dev = video_device_alloc ();
dev->id = create_device_id (sgname, -1);
if (!dev->id) {
video_device_free (dev);
break;
}
dev->name = g_strdup (sgname);
list = g_list_append (list, dev);
/* if this is the default device, note it */
if (n == (*deviceList)->selectedIndex) {
default_dev = dev;
}
}
}
/* move default device to the front */
if (default_dev) {
list = g_list_remove (list, default_dev);
list = g_list_prepend (list, default_dev);
}
end:
if (!src->video_chan && component) {
err = CloseComponent (component);
if (err != noErr)
GST_WARNING_OBJECT (src, "CloseComponent returned %d", (int) err);
}
return list;
}
static gboolean
device_set_default (GstOSXVideoSrc * src)
{
GList *list;
video_device *dev;
gboolean ret;
/* obtain the device list */
list = device_list (src);
if (!list)
return FALSE;
ret = FALSE;
/* the first item is the default */
if (g_list_length (list) >= 1) {
dev = (video_device *) list->data;
/* take the strings, no need to copy */
src->device_id = dev->id;
src->device_name = dev->name;
dev->id = NULL;
dev->name = NULL;
/* null out the item */
video_device_free (dev);
list->data = NULL;
ret = TRUE;
}
/* clean up */
g_list_foreach (list, video_device_free_func, NULL);
g_list_free (list);
return ret;
}
static gboolean
device_get_name (GstOSXVideoSrc * src)
{
GList *l, *list;
video_device *dev;
gboolean ret;
/* if there is no device set, then attempt to set up with the default,
* which will also grab the name in the process.
*/
if (!src->device_id)
return device_set_default (src);
/* if we already have a name, free it */
if (src->device_name) {
g_free (src->device_name);
src->device_name = NULL;
}
/* obtain the device list */
list = device_list (src);
if (!list)
return FALSE;
ret = FALSE;
/* look up the id */
for (l = list; l != NULL; l = l->next) {
dev = (video_device *) l->data;
if (g_str_equal (dev->id, src->device_id)) {
/* take the string, no need to copy */
src->device_name = dev->name;
dev->name = NULL;
ret = TRUE;
break;
}
}
g_list_foreach (list, video_device_free_func, NULL);
g_list_free (list);
return ret;
}
static gboolean
device_select (GstOSXVideoSrc * src)
{
Str63 pstr;
ComponentResult err;
gchar *sgname;
int inputIndex;
/* if there's no device id set, attempt to select default device */
if (!src->device_id && !device_set_default (src))
return FALSE;
if (!parse_device_id (src->device_id, &sgname, &inputIndex)) {
GST_ERROR_OBJECT (src, "unable to parse device id: [%s]", src->device_id);
return FALSE;
}
c2pstrcpy (pstr, sgname);
g_free (sgname);
err = SGSetChannelDevice (src->video_chan, (StringPtr) & pstr);
if (err != noErr) {
GST_ERROR_OBJECT (src, "SGSetChannelDevice returned %d", (int) err);
return FALSE;
}
err = SGSetChannelDeviceInput (src->video_chan, inputIndex);
if (err != noErr) {
GST_ERROR_OBJECT (src, "SGSetChannelDeviceInput returned %d", (int) err);
return FALSE;
}
return TRUE;
}
static gboolean
gst_osx_video_src_iface_supported (GstImplementsInterface * iface,
GType iface_type)
{
return FALSE;
}
static void
gst_osx_video_src_interface_init (GstImplementsInterfaceClass * klass)
{
/* default virtual functions */
klass->supported = gst_osx_video_src_iface_supported;
}
static void
gst_osx_video_src_init_interfaces (GType type)
{
static const GInterfaceInfo implements_iface_info = {
(GInterfaceInitFunc) gst_osx_video_src_interface_init,
NULL,
NULL,
};
g_type_add_interface_static (type, GST_TYPE_IMPLEMENTS_INTERFACE,
&implements_iface_info);
gst_osx_video_src_type_add_device_property_probe_interface (type);
}
static void
gst_osx_video_src_base_init (gpointer gclass)
{
GstElementClass *element_class = GST_ELEMENT_CLASS (gclass);
GST_DEBUG ("%s", G_STRFUNC);
gst_element_class_add_pad_template (element_class,
gst_static_pad_template_get (&src_template));
gst_element_class_set_metadata (element_class, "Video Source (OSX)",
"Source/Video",
"Reads raw frames from a capture device on OS X",
"Ole Andre Vadla Ravnaas <ole.andre.ravnas@tandberg.com>, "
"Ali Sabil <ali.sabil@tandberg.com>");
}
static void
gst_osx_video_src_class_init (GstOSXVideoSrcClass * klass)
{
GObjectClass *gobject_class;
GstElementClass *element_class;
GstBaseSrcClass *basesrc_class;
GstPushSrcClass *pushsrc_class;
OSErr err;
GST_DEBUG ("%s", G_STRFUNC);
gobject_class = G_OBJECT_CLASS (klass);
element_class = GST_ELEMENT_CLASS (klass);
basesrc_class = GST_BASE_SRC_CLASS (klass);
pushsrc_class = GST_PUSH_SRC_CLASS (klass);
gobject_class->dispose = gst_osx_video_src_dispose;
gobject_class->finalize = (GObjectFinalizeFunc) gst_osx_video_src_finalize;
gobject_class->set_property =
GST_DEBUG_FUNCPTR (gst_osx_video_src_set_property);
gobject_class->get_property =
GST_DEBUG_FUNCPTR (gst_osx_video_src_get_property);
element_class->change_state = gst_osx_video_src_change_state;
basesrc_class->get_caps = gst_osx_video_src_get_caps;
basesrc_class->set_caps = gst_osx_video_src_set_caps;
basesrc_class->start = gst_osx_video_src_start;
basesrc_class->stop = gst_osx_video_src_stop;
basesrc_class->query = gst_osx_video_src_query;
basesrc_class->fixate = gst_osx_video_src_fixate;
pushsrc_class->create = gst_osx_video_src_create;
g_object_class_install_property (gobject_class, ARG_DEVICE,
g_param_spec_string ("device", "Device",
"Sequence Grabber input device in format 'sgname:input#'",
NULL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
g_object_class_install_property (gobject_class, ARG_DEVICE_NAME,
g_param_spec_string ("device-name", "Device name",
"Human-readable name of the video device",
NULL, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
err = EnterMovies ();
if (err == noErr) {
klass->movies_enabled = TRUE;
} else {
klass->movies_enabled = FALSE;
GST_ERROR ("EnterMovies returned %d", err);
}
}
static void
gst_osx_video_src_init (GstOSXVideoSrc * self, GstOSXVideoSrcClass * klass)
{
GST_DEBUG_OBJECT (self, "%s", G_STRFUNC);
gst_base_src_set_format (GST_BASE_SRC (self), GST_FORMAT_TIME);
gst_base_src_set_live (GST_BASE_SRC (self), TRUE);
}
static void
gst_osx_video_src_dispose (GObject * object)
{
GstOSXVideoSrc *self = GST_OSX_VIDEO_SRC (object);
GST_DEBUG_OBJECT (object, "%s", G_STRFUNC);
if (self->device_id) {
g_free (self->device_id);
self->device_id = NULL;
}
if (self->device_name) {
g_free (self->device_name);
self->device_name = NULL;
}
if (self->buffer != NULL) {
gst_buffer_unref (self->buffer);
self->buffer = NULL;
}
G_OBJECT_CLASS (parent_class)->dispose (object);
}
static void
gst_osx_video_src_finalize (GstOSXVideoSrc * self)
{
GST_DEBUG_OBJECT (self, "%s", G_STRFUNC);
G_OBJECT_CLASS (parent_class)->finalize (G_OBJECT (self));
}
static void
gst_osx_video_src_set_property (GObject * object, guint prop_id,
const GValue * value, GParamSpec * pspec)
{
GstOSXVideoSrc *src = GST_OSX_VIDEO_SRC (object);
switch (prop_id) {
case ARG_DEVICE:
if (src->device_id) {
g_free (src->device_id);
src->device_id = NULL;
}
if (src->device_name) {
g_free (src->device_name);
src->device_name = NULL;
}
src->device_id = g_strdup (g_value_get_string (value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
gst_osx_video_src_get_property (GObject * object, guint prop_id,
GValue * value, GParamSpec * pspec)
{
GstOSXVideoSrc *src = GST_OSX_VIDEO_SRC (object);
switch (prop_id) {
case ARG_DEVICE:
if (!src->device_id)
device_set_default (src);
g_value_set_string (value, src->device_id);
break;
case ARG_DEVICE_NAME:
if (!src->device_name)
device_get_name (src);
g_value_set_string (value, src->device_name);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static GstCaps *
gst_osx_video_src_get_caps (GstBaseSrc * src)
{
GstElementClass *gstelement_class;
GstOSXVideoSrc *self;
GstPadTemplate *pad_template;
GstCaps *caps;
GstStructure *structure;
gint width, height;
gstelement_class = GST_ELEMENT_GET_CLASS (src);
self = GST_OSX_VIDEO_SRC (src);
/* if we don't have the resolution set up, return template caps */
if (!self->world)
return NULL;
pad_template = gst_element_class_get_pad_template (gstelement_class, "src");
/* i don't think this can actually fail... */
if (!pad_template)
return NULL;
width = self->rect.right;
height = self->rect.bottom;
caps = gst_caps_copy (gst_pad_template_get_caps (pad_template));
structure = gst_caps_get_structure (caps, 0);
gst_structure_set (structure, "width", G_TYPE_INT, width, NULL);
gst_structure_set (structure, "height", G_TYPE_INT, height, NULL);
return caps;
}
static gboolean
gst_osx_video_src_set_caps (GstBaseSrc * src, GstCaps * caps)
{
GstOSXVideoSrc *self = GST_OSX_VIDEO_SRC (src);
GstStructure *structure = gst_caps_get_structure (caps, 0);
gint width, height, framerate_num, framerate_denom;
float fps;
ComponentResult err;
GST_DEBUG_OBJECT (src, "%s", G_STRFUNC);
if (!self->seq_grab)
return FALSE;
gst_structure_get_int (structure, "width", &width);
gst_structure_get_int (structure, "height", &height);
gst_structure_get_fraction (structure, "framerate", &framerate_num,
&framerate_denom);
fps = (float) framerate_num / framerate_denom;
GST_DEBUG_OBJECT (src, "changing caps to %dx%d@%f", width, height, fps);
SetRect (&self->rect, 0, 0, width, height);
err = QTNewGWorld (&self->world, k422YpCbCr8PixelFormat, &self->rect, 0,
NULL, 0);
if (err != noErr) {
GST_ERROR_OBJECT (self, "QTNewGWorld returned %d", (int) err);
goto fail;
}
if (!LockPixels (GetPortPixMap (self->world))) {
GST_ERROR_OBJECT (self, "LockPixels failed");
goto fail;
}
err = SGSetGWorld (self->seq_grab, self->world, NULL);
if (err != noErr) {
GST_ERROR_OBJECT (self, "SGSetGWorld returned %d", (int) err);
goto fail;
}
err = SGSetChannelBounds (self->video_chan, &self->rect);
if (err != noErr) {
GST_ERROR_OBJECT (self, "SGSetChannelBounds returned %d", (int) err);
goto fail;
}
// ###: if we ever support choosing framerates, do something with this
/*err = SGSetFrameRate (self->video_chan, FloatToFixed(fps));
if (err != noErr) {
GST_ERROR_OBJECT (self, "SGSetFrameRate returned %d", (int) err);
goto fail;
} */
return TRUE;
fail:
if (self->world) {
SGSetGWorld (self->seq_grab, NULL, NULL);
DisposeGWorld (self->world);
self->world = NULL;
}
return FALSE;
}
static void
gst_osx_video_src_fixate (GstBaseSrc * bsrc, GstCaps * caps)
{
GstStructure *structure;
int i;
/* this function is for choosing defaults as a last resort */
for (i = 0; i < (int) gst_caps_get_size (caps); ++i) {
structure = gst_caps_get_structure (caps, i);
gst_structure_fixate_field_nearest_int (structure, "width", 640);
gst_structure_fixate_field_nearest_int (structure, "height", 480);
// ###: if we ever support choosing framerates, do something with this
//gst_structure_fixate_field_nearest_fraction (structure, "framerate", 15, 2);
}
}
static gboolean
gst_osx_video_src_start (GstBaseSrc * src)
{
GstOSXVideoSrc *self;
GObjectClass *gobject_class;
GstOSXVideoSrcClass *klass;
ComponentResult err;
self = GST_OSX_VIDEO_SRC (src);
gobject_class = G_OBJECT_GET_CLASS (src);
klass = GST_OSX_VIDEO_SRC_CLASS (gobject_class);
GST_DEBUG_OBJECT (src, "entering");
if (!klass->movies_enabled)
return FALSE;
self->seq_num = 0;
self->seq_grab = OpenDefaultComponent (SeqGrabComponentType, 0);
if (self->seq_grab == NULL) {
err = paramErr;
GST_ERROR_OBJECT (self, "OpenDefaultComponent failed. paramErr=%d",
(int) err);
goto fail;
}
err = SGInitialize (self->seq_grab);
if (err != noErr) {
GST_ERROR_OBJECT (self, "SGInitialize returned %d", (int) err);
goto fail;
}
err = SGSetDataRef (self->seq_grab, 0, 0, seqGrabDontMakeMovie);
if (err != noErr) {
GST_ERROR_OBJECT (self, "SGSetDataRef returned %d", (int) err);
goto fail;
}
err = SGNewChannel (self->seq_grab, VideoMediaType, &self->video_chan);
if (err != noErr) {
GST_ERROR_OBJECT (self, "SGNewChannel returned %d", (int) err);
goto fail;
}
if (!device_select (self))
goto fail;
GST_DEBUG_OBJECT (self, "started");
return TRUE;
fail:
self->video_chan = NULL;
if (self->seq_grab) {
err = CloseComponent (self->seq_grab);
if (err != noErr)
GST_WARNING_OBJECT (self, "CloseComponent returned %d", (int) err);
self->seq_grab = NULL;
}
return FALSE;
}
static gboolean
gst_osx_video_src_stop (GstBaseSrc * src)
{
GstOSXVideoSrc *self;
ComponentResult err;
self = GST_OSX_VIDEO_SRC (src);
GST_DEBUG_OBJECT (src, "stopping");
self->video_chan = NULL;
err = CloseComponent (self->seq_grab);
if (err != noErr)
GST_WARNING_OBJECT (self, "CloseComponent returned %d", (int) err);
self->seq_grab = NULL;
DisposeGWorld (self->world);
self->world = NULL;
if (self->buffer != NULL) {
gst_buffer_unref (self->buffer);
self->buffer = NULL;
}
return TRUE;
}
static gboolean
gst_osx_video_src_query (GstBaseSrc * bsrc, GstQuery * query)
{
GstOSXVideoSrc *self;
gboolean res = FALSE;
self = GST_OSX_VIDEO_SRC (bsrc);
switch (GST_QUERY_TYPE (query)) {
case GST_QUERY_LATENCY:
{
GstClockTime min_latency, max_latency;
gint fps_n, fps_d;
fps_n = FRAMERATE;
fps_d = 1;
/* min latency is the time to capture one frame */
min_latency = gst_util_uint64_scale_int (GST_SECOND, fps_d, fps_n);
/* max latency is total duration of the frame buffer */
// FIXME: we don't know what this is, so we'll just say 2 frames
max_latency = 2 * min_latency;
GST_DEBUG_OBJECT (bsrc,
"report latency min %" GST_TIME_FORMAT " max %" GST_TIME_FORMAT,
GST_TIME_ARGS (min_latency), GST_TIME_ARGS (max_latency));
/* we are always live, the min latency is 1 frame and the max latency is
* the complete buffer of frames. */
gst_query_set_latency (query, TRUE, min_latency, max_latency);
res = TRUE;
break;
}
default:
res = GST_BASE_SRC_CLASS (parent_class)->query (bsrc, query);
break;
}
return res;
}
static GstStateChangeReturn
gst_osx_video_src_change_state (GstElement * element, GstStateChange transition)
{
GstStateChangeReturn result;
GstOSXVideoSrc *self;
ComponentResult err;
result = GST_STATE_CHANGE_SUCCESS;
self = GST_OSX_VIDEO_SRC (element);
// ###: prepare_capture in READY->PAUSED?
switch (transition) {
case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
{
ImageDescriptionHandle imageDesc;
Rect sourceRect;
MatrixRecord scaleMatrix;
if (!prepare_capture (self))
return GST_STATE_CHANGE_FAILURE;
// ###: should we start recording /after/ making the decompressionsequence?
// CocoaSequenceGrabber does it beforehand, so we do too, but it feels
// wrong.
err = SGStartRecord (self->seq_grab);
if (err != noErr) {
/* since we prepare here, we should also unprepare */
SGRelease (self->seq_grab);
GST_ERROR_OBJECT (self, "SGStartRecord returned %d", (int) err);
return GST_STATE_CHANGE_FAILURE;
}
imageDesc = (ImageDescriptionHandle) NewHandle (0);
err = SGGetChannelSampleDescription (self->video_chan,
(Handle) imageDesc);
if (err != noErr) {
SGStop (self->seq_grab);
SGRelease (self->seq_grab);
DisposeHandle ((Handle) imageDesc);
GST_ERROR_OBJECT (self, "SGGetChannelSampleDescription returned %d",
(int) err);
return GST_STATE_CHANGE_FAILURE;
}
GST_DEBUG_OBJECT (self, "actual capture resolution is %dx%d",
(int) (**imageDesc).width, (int) (**imageDesc).height);
SetRect (&sourceRect, 0, 0, (**imageDesc).width, (**imageDesc).height);
RectMatrix (&scaleMatrix, &sourceRect, &self->rect);
err = DecompressSequenceBegin (&self->dec_seq, imageDesc, self->world,
NULL, NULL, &scaleMatrix, srcCopy, NULL, 0, codecNormalQuality,
bestSpeedCodec);
if (err != noErr) {
SGStop (self->seq_grab);
SGRelease (self->seq_grab);
DisposeHandle ((Handle) imageDesc);
GST_ERROR_OBJECT (self, "DecompressSequenceBegin returned %d",
(int) err);
return GST_STATE_CHANGE_FAILURE;
}
DisposeHandle ((Handle) imageDesc);
break;
}
default:
break;
}
result = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
if (result == GST_STATE_CHANGE_FAILURE)
return result;
switch (transition) {
case GST_STATE_CHANGE_PAUSED_TO_READY:
SGStop (self->seq_grab);
err = CDSequenceEnd (self->dec_seq);
if (err != noErr)
GST_WARNING_OBJECT (self, "CDSequenceEnd returned %d", (int) err);
self->dec_seq = 0;
SGRelease (self->seq_grab);
break;
default:
break;
}
return result;
}
static GstFlowReturn
gst_osx_video_src_create (GstPushSrc * src, GstBuffer ** buf)
{
GstOSXVideoSrc *self = GST_OSX_VIDEO_SRC (src);
ComponentResult err;
GstCaps *caps;
//GstClock * clock;
// ###: we need to sleep between calls to SGIdle. originally, the sleeping
// was done using gst_clock_id_wait(), but it turns out that approach
// doesn't work well. it has two issues:
// 1) every so often, gst_clock_id_wait() will block for a much longer
// period of time than requested (upwards of a minute) causing video
// to freeze until it finally returns. this seems to happen once
// every few minutes, which probably means something like 1 in every
// several hundred calls gst_clock_id_wait() does the wrong thing.
// 2) even when the gst_clock approach is working properly, it uses
// quite a bit of cpu in comparison to a simple usleep(). on one
// test machine, using gst_clock_id_wait() caused osxvideosrc to use
// nearly 100% cpu, while using usleep() brough the usage to less
// than 10%.
//
// so, for now, we comment out the gst_clock stuff and use usleep.
//clock = gst_system_clock_obtain ();
do {
err = SGIdle (self->seq_grab);
if (err != noErr) {
GST_ERROR_OBJECT (self, "SGIdle returned %d", (int) err);
gst_object_unref (clock);
return GST_FLOW_UNEXPECTED;
}
if (self->buffer == NULL) {
/*GstClockID clock_id;
clock_id = gst_clock_new_single_shot_id (clock,
(GstClockTime) (gst_clock_get_time(clock) +
(GST_SECOND / ((float)FRAMERATE * 2))));
gst_clock_id_wait (clock_id, NULL);
gst_clock_id_unref (clock_id); */
usleep (1000000 / (FRAMERATE * 2));
}
} while (self->buffer == NULL);
//gst_object_unref (clock);
*buf = self->buffer;
self->buffer = NULL;
caps = gst_pad_get_caps (GST_BASE_SRC_PAD (src));
gst_buffer_set_caps (*buf, caps);
gst_caps_unref (caps);
return GST_FLOW_OK;
}
static OSErr
data_proc (SGChannel c, Ptr p, long len, long *offset, long chRefCon,
TimeValue time, short writeType, long refCon)
{
GstOSXVideoSrc *self;
gint fps_n, fps_d;
GstClockTime duration, timestamp, latency;
CodecFlags flags;
ComponentResult err;
PixMapHandle hPixMap;
Rect portRect;
int pix_rowBytes;
void *pix_ptr;
int pix_height;
int pix_size;
self = GST_OSX_VIDEO_SRC (refCon);
if (self->buffer != NULL) {
gst_buffer_unref (self->buffer);
self->buffer = NULL;
}
err = DecompressSequenceFrameS (self->dec_seq, p, len, 0, &flags, NULL);
if (err != noErr) {
GST_ERROR_OBJECT (self, "DecompressSequenceFrameS returned %d", (int) err);
return err;
}
hPixMap = GetGWorldPixMap (self->world);
LockPixels (hPixMap);
GetPortBounds (self->world, &portRect);
pix_rowBytes = (int) GetPixRowBytes (hPixMap);
pix_ptr = GetPixBaseAddr (hPixMap);
pix_height = (portRect.bottom - portRect.top);
pix_size = pix_rowBytes * pix_height;
GST_DEBUG_OBJECT (self, "num=%5d, height=%d, rowBytes=%d, size=%d",
self->seq_num, pix_height, pix_rowBytes, pix_size);
fps_n = FRAMERATE;
fps_d = 1;
duration = gst_util_uint64_scale_int (GST_SECOND, fps_d, fps_n);
latency = duration;
timestamp = gst_clock_get_time (GST_ELEMENT_CAST (self)->clock);
timestamp -= gst_element_get_base_time (GST_ELEMENT_CAST (self));
if (timestamp > latency)
timestamp -= latency;
else
timestamp = 0;
self->buffer = gst_buffer_new_and_alloc (pix_size);
GST_BUFFER_OFFSET (self->buffer) = self->seq_num;
GST_BUFFER_TIMESTAMP (self->buffer) = timestamp;
memcpy (GST_BUFFER_DATA (self->buffer), pix_ptr, pix_size);
self->seq_num++;
UnlockPixels (hPixMap);
return noErr;
}
static gboolean
prepare_capture (GstOSXVideoSrc * self)
{
ComponentResult err;
err = SGSetChannelUsage (self->video_chan, seqGrabRecord);
if (err != noErr) {
GST_ERROR_OBJECT (self, "SGSetChannelUsage returned %d", (int) err);
return FALSE;
}
err = SGSetDataProc (self->seq_grab, NewSGDataUPP (data_proc), (long) self);
if (err != noErr) {
GST_ERROR_OBJECT (self, "SGSetDataProc returned %d", (int) err);
return FALSE;
}
err = SGPrepare (self->seq_grab, false, true);
if (err != noErr) {
GST_ERROR_OBJECT (self, "SGPrepare returnd %d", (int) err);
return FALSE;
}
return TRUE;
}
static const GList *
probe_get_properties (GstPropertyProbe * probe)
{
GObjectClass *klass = G_OBJECT_GET_CLASS (probe);
static GList *list = NULL;
// ###: from gstalsadeviceprobe.c
/* well, not perfect, but better than no locking at all.
* In the worst case we leak a list node, so who cares? */
GST_CLASS_LOCK (GST_OBJECT_CLASS (klass));
if (!list) {
GParamSpec *pspec;
pspec = g_object_class_find_property (klass, "device");
list = g_list_append (NULL, pspec);
}
GST_CLASS_UNLOCK (GST_OBJECT_CLASS (klass));
return list;
}
static void
probe_probe_property (GstPropertyProbe * probe, guint prop_id,
const GParamSpec * pspec)
{
/* we do nothing in here. the actual "probe" occurs in get_values(),
* which is a common practice when not caching responses.
*/
if (!g_str_equal (pspec->name, "device")) {
G_OBJECT_WARN_INVALID_PROPERTY_ID (probe, prop_id, pspec);
}
}
static gboolean
probe_needs_probe (GstPropertyProbe * probe, guint prop_id,
const GParamSpec * pspec)
{
/* don't cache probed data */
return TRUE;
}
static GValueArray *
probe_get_values (GstPropertyProbe * probe, guint prop_id,
const GParamSpec * pspec)
{
GstOSXVideoSrc *src;
GValueArray *array;
GValue value = { 0, };
GList *l, *list;
video_device *dev;
if (!g_str_equal (pspec->name, "device")) {
G_OBJECT_WARN_INVALID_PROPERTY_ID (probe, prop_id, pspec);
return NULL;
}
src = GST_OSX_VIDEO_SRC (probe);
list = device_list (src);
if (list == NULL) {
GST_LOG_OBJECT (probe, "No devices found");
return NULL;
}
array = g_value_array_new (g_list_length (list));
g_value_init (&value, G_TYPE_STRING);
for (l = list; l != NULL; l = l->next) {
dev = (video_device *) l->data;
GST_LOG_OBJECT (probe, "Found device: %s", dev->id);
g_value_take_string (&value, dev->id);
dev->id = NULL;
video_device_free (dev);
l->data = NULL;
g_value_array_append (array, &value);
}
g_value_unset (&value);
g_list_free (list);
return array;
}
static void
gst_osx_video_src_property_probe_interface_init (GstPropertyProbeInterface *
iface)
{
iface->get_properties = probe_get_properties;
iface->probe_property = probe_probe_property;
iface->needs_probe = probe_needs_probe;
iface->get_values = probe_get_values;
}
void
gst_osx_video_src_type_add_device_property_probe_interface (GType type)
{
static const GInterfaceInfo probe_iface_info = {
(GInterfaceInitFunc) gst_osx_video_src_property_probe_interface_init,
NULL,
NULL,
};
g_type_add_interface_static (type, GST_TYPE_PROPERTY_PROBE,
&probe_iface_info);
}
|