Class: XmpToolkitRuby::XmpWrapper

Inherits:
Object
  • Object
show all
Defined in:
ext/xmp_toolkit_ruby/xmp_toolkit_ruby.cpp

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.register_namespace(rb_namespaceURI, rb_suggestedPrefix) ⇒ Object 



523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
 
# File 'ext/xmp_toolkit_ruby/xmp_wrapper.cpp', line 523

VALUE
register_namespace(VALUE self, VALUE rb_namespaceURI, VALUE rb_suggestedPrefix) {
  const char *namespaceURI = StringValueCStr(rb_namespaceURI);
  const char *suggestedPrefix = StringValueCStr(rb_suggestedPrefix);
  std::string registeredPrefix;

  ensure_sdk_initialized();

  bool isRegistered = SXMPMeta::GetNamespacePrefix(namespaceURI, &registeredPrefix);

  if (isRegistered) {
    fprintf(stderr, "Namespace '%s' is already registered with prefix '%s'\n", namespaceURI, registeredPrefix.c_str());
    return rb_str_new_cstr(registeredPrefix.c_str());
  }

  bool isSuggestedPrefix = SXMPMeta::RegisterNamespace(namespaceURI, suggestedPrefix, &registeredPrefix);

  if (isSuggestedPrefix) {
    return rb_suggestedPrefix;
  }

  return rb_str_new_cstr(registeredPrefix.c_str());
}

Instance Method Details

#close ⇒ Object

close flushes the file until then the data is not guaranteed to be written



572
573
574
575
576
577
578
579
580
581
582
 
# File 'ext/xmp_toolkit_ruby/xmp_wrapper.cpp', line 572

VALUE
xmpwrapper_close_file(VALUE self) {
  XMPWrapper *wrapper;
  TypedData_Get_Struct(self, XMPWrapper, &xmpwrapper_data_type, wrapper);

  if (wrapper->xmpFile) {
    clean_wrapper(wrapper);
  }

  return Qtrue;
}

#file_info ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'ext/xmp_toolkit_ruby/xmp_wrapper.cpp', line 119

VALUE
xmp_file_info(VALUE self) {
  XMPWrapper *wrapper;
  TypedData_Get_Struct(self, XMPWrapper, &xmpwrapper_data_type, wrapper);
  check_wrapper_initialized(wrapper);

  XMP_FileFormat format;
  XMP_OptionBits openFlags, handlerFlags;
  bool ok = wrapper->xmpFile->GetFileInfo(0, &openFlags, &format, &handlerFlags);
  if (!ok) {
    clean_wrapper(wrapper);
    rb_raise(rb_eRuntimeError, "Failed to get file info");
    return Qnil;
  }

  VALUE result = rb_hash_new();

  rb_hash_aset(result, rb_str_new_cstr("format"), UINT2NUM(format));
  rb_hash_aset(result, rb_str_new_cstr("handler_flags"), UINT2NUM(handlerFlags));
  rb_hash_aset(result, rb_str_new_cstr("open_flags"), UINT2NUM(openFlags));

  return result;
}

#localized_property(*args) ⇒ Object 



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
 
# File 'ext/xmp_toolkit_ruby/xmp_wrapper.cpp', line 218

VALUE
xmpwrapper_get_localized_text(int argc, VALUE *argv, VALUE self) {
  XMPWrapper *wrapper;
  TypedData_Get_Struct(self, XMPWrapper, &xmpwrapper_data_type, wrapper);
  check_wrapper_initialized(wrapper);

  get_xmp(wrapper);

  if (!wrapper->xmpMetaDataLoaded) {
    rb_raise(rb_eRuntimeError, "No XMP metadata loaded");
  }

  VALUE kwargs;
  rb_scan_args(argc, argv, ":", &kwargs);

  // Define allowed keywords
  ID kw_table[4];

  kw_table[0] = rb_intern("schema_ns");
  kw_table[1] = rb_intern("alt_text_name");
  kw_table[2] = rb_intern("generic_lang");
  kw_table[3] = rb_intern("specific_lang");

  VALUE kw_values[4];
  kw_values[2] = rb_str_new_cstr("");  // Default for generic_lang

  rb_get_kwargs(kwargs, kw_table, 3, 1, kw_values);

  VALUE schema_ns = kw_values[0];
  VALUE alt_text_name = kw_values[1];
  VALUE generic_lang = kw_values[2];  // Will be default if not provided
  VALUE specific_lang = kw_values[3];

  if (NIL_P(generic_lang)) generic_lang = rb_str_new_cstr("");

  const char *c_schema_ns = StringValueCStr(schema_ns);
  const char *c_alt_text_name = StringValueCStr(alt_text_name);
  const char *c_generic_lang = StringValueCStr(generic_lang);
  const char *c_specific_lang = StringValueCStr(specific_lang);

  std::string actual_lang;
  std::string item_value;
  XMP_OptionBits options;

  bool array_items_exists = wrapper->xmpMeta->GetLocalizedText(c_schema_ns, c_alt_text_name, c_generic_lang,
                                                               c_specific_lang, &actual_lang, &item_value, &options);

  VALUE result = rb_hash_new();
  rb_hash_aset(result, rb_str_new_cstr("options"), UINT2NUM(options));
  rb_hash_aset(result, rb_str_new_cstr("exists"), array_items_exists ? Qtrue : Qfalse);
  rb_hash_aset(result, rb_str_new_cstr("value"), rb_str_new_cstr(item_value.c_str()));
  rb_hash_aset(result, rb_str_new_cstr("actual_lang"), rb_str_new_cstr(actual_lang.c_str()));

  return result;
}

#meta ⇒ Object 



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'ext/xmp_toolkit_ruby/xmp_wrapper.cpp', line 168

VALUE
xmp_meta(VALUE self) {
  XMPWrapper *wrapper;
  TypedData_Get_Struct(self, XMPWrapper, &xmpwrapper_data_type, wrapper);
  check_wrapper_initialized(wrapper);

  get_xmp(wrapper);

  if (!wrapper->xmpMetaDataLoaded) {
    rb_raise(rb_eRuntimeError, "No XMP metadata loaded");
  }

  std::string xmpString;
  wrapper->xmpMeta->SerializeToBuffer(&xmpString);

  VALUE rb_xmp_data = rb_str_new_cstr(xmpString.c_str());

  return rb_xmp_data;
}

#open(*args) ⇒ Object 



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
 
# File 'ext/xmp_toolkit_ruby/xmp_wrapper.cpp', line 78

VALUE
xmpwrapper_open_file(int argc, VALUE *argv, VALUE self) {
  ensure_sdk_initialized();

  XMPWrapper *wrapper;
  TypedData_Get_Struct(self, XMPWrapper, &xmpwrapper_data_type, wrapper);

  if (wrapper->xmpFile != nullptr) {
    rb_raise(rb_eRuntimeError, "File already opened");
  }

  VALUE rb_filename = Qnil;
  VALUE rb_opts_mask = Qnil;
  rb_scan_args(argc, argv, "11", &rb_filename, &rb_opts_mask);

  const char *filename = StringValueCStr(rb_filename);

  // Allocate native objects
  wrapper->xmpMeta = new SXMPMeta();
  wrapper->xmpFile = new SXMPFiles();
  wrapper->xmpPacket = new XMP_PacketInfo();

  XMP_OptionBits opts;

  if (!NIL_P(rb_opts_mask)) {
    Check_Type(rb_opts_mask, T_FIXNUM);
    opts = NUM2UINT(rb_opts_mask);
  } else {
    opts = kXMPFiles_OpenForRead | kXMPFiles_OpenUseSmartHandler;
  }

  bool ok = wrapper->xmpFile->OpenFile(filename, kXMP_UnknownFile, opts);
  if (!ok) {
    clean_wrapper(wrapper);
    rb_raise(rb_eIOError, "Failed to open file %s, try open_use_packet_scanning instead of open_use_smart_handler",
             filename);
  }

  return Qtrue;
}

#packet_info ⇒ Object 



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'ext/xmp_toolkit_ruby/xmp_wrapper.cpp', line 143

VALUE xmp_packet_info(VALUE self) {
  XMPWrapper *wrapper;
  TypedData_Get_Struct(self, XMPWrapper, &xmpwrapper_data_type, wrapper);
  check_wrapper_initialized(wrapper);

  get_xmp(wrapper);

  if (!wrapper->xmpMetaDataLoaded) {
    rb_raise(rb_eRuntimeError, "No XMP metadata loaded");
  }

  VALUE result = rb_hash_new();

  rb_hash_aset(result, rb_str_new_cstr("offset"), LONG2NUM(wrapper->xmpPacket->offset));
  rb_hash_aset(result, rb_str_new_cstr("length"), LONG2NUM(wrapper->xmpPacket->length));
  rb_hash_aset(result, rb_str_new_cstr("pad_size"), LONG2NUM(wrapper->xmpPacket->padSize));

  rb_hash_aset(result, rb_str_new_cstr("char_form"), UINT2NUM(wrapper->xmpPacket->charForm));
  rb_hash_aset(result, rb_str_new_cstr("writeable"), wrapper->xmpPacket->writeable ? Qtrue : Qfalse);
  rb_hash_aset(result, rb_str_new_cstr("has_wrapper"), wrapper->xmpPacket->hasWrapper ? Qtrue : Qfalse);
  rb_hash_aset(result, rb_str_new_cstr("pad"), UINT2NUM(wrapper->xmpPacket->pad));

  return result;
}

#property(rb_ns, rb_prop) ⇒ Object 



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
 
# File 'ext/xmp_toolkit_ruby/xmp_wrapper.cpp', line 188

VALUE
xmpwrapper_get_property(VALUE self, VALUE rb_ns, VALUE rb_prop) {
  XMPWrapper *wrapper;
  TypedData_Get_Struct(self, XMPWrapper, &xmpwrapper_data_type, wrapper);
  check_wrapper_initialized(wrapper);

  Check_Type(rb_ns, T_STRING);
  Check_Type(rb_prop, T_STRING);

  get_xmp(wrapper);

  if (!wrapper->xmpMetaDataLoaded) {
    rb_raise(rb_eRuntimeError, "No XMP metadata loaded");
  }

  const char *ns = StringValueCStr(rb_ns);
  const char *prop = StringValueCStr(rb_prop);

  std::string property_value;
  XMP_OptionBits options;
  bool property_exists = wrapper->xmpMeta->GetProperty(ns, prop, &property_value, &options);

  VALUE result = rb_hash_new();
  rb_hash_aset(result, rb_str_new_cstr("options"), UINT2NUM(options));
  rb_hash_aset(result, rb_str_new_cstr("exists"), property_exists ? Qtrue : Qfalse);
  rb_hash_aset(result, rb_str_new_cstr("value"), rb_str_new_cstr(property_value.c_str()));

  return result;
}

#update_localized_property(*args) ⇒ Object

GetFileInfo() retrieves basic information about an opened file. to be defined



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
 
# File 'ext/xmp_toolkit_ruby/xmp_wrapper.cpp', line 461

VALUE
xmpwrapper_update_localized_text(int argc, VALUE *argv, VALUE self) {
  XMPWrapper *wrapper;
  TypedData_Get_Struct(self, XMPWrapper, &xmpwrapper_data_type, wrapper);
  check_wrapper_initialized(wrapper);

  get_xmp(wrapper);

  if (!wrapper->xmpMetaDataLoaded) {
    rb_raise(rb_eRuntimeError, "No XMP metadata loaded");
  }

  VALUE kwargs;
  rb_scan_args(argc, argv, ":", &kwargs);

  // Define allowed keywords
  ID kw_table[6];

  kw_table[0] = rb_intern("schema_ns");
  kw_table[1] = rb_intern("alt_text_name");
  kw_table[2] = rb_intern("generic_lang");
  kw_table[3] = rb_intern("specific_lang");
  kw_table[4] = rb_intern("item_value");
  kw_table[5] = rb_intern("options");

  VALUE kw_values[6];
  kw_values[2] = rb_str_new_cstr("");  // Default for generic_lang
  kw_values[5] = INT2NUM(0);           // Default for options

  // Extract keywords from kwargs hash
  rb_get_kwargs(kwargs, kw_table, 4, 2, kw_values);

  VALUE schema_ns = kw_values[0];
  VALUE alt_text_name = kw_values[1];
  VALUE generic_lang = kw_values[2];  // Will be default if not provided
  VALUE specific_lang = kw_values[3];
  VALUE item_value = kw_values[4];
  VALUE options = kw_values[5];  // Will be default if not provided

  // Provide defaults if needed
  if (NIL_P(generic_lang)) generic_lang = rb_str_new_cstr("");
  if (NIL_P(options)) options = INT2NUM(0);

  // Convert Ruby values to C strings / types
  const char *c_schema_ns = StringValueCStr(schema_ns);
  const char *c_alt_text_name = StringValueCStr(alt_text_name);
  const char *c_generic_lang = StringValueCStr(generic_lang);
  const char *c_specific_lang = StringValueCStr(specific_lang);
  const char *c_item_value = StringValueCStr(item_value);
  XMP_OptionBits c_options = NUM2UINT(options);

  fprintf(stderr,
          "Updating localized text with schema_ns='%s', alt_text_name='%s', generic_lang='%s', specific_lang='%s', "
          "item_value='%s', options=%u\n",
          c_schema_ns, c_alt_text_name, c_generic_lang, c_specific_lang, c_item_value, c_options);

  wrapper->xmpMeta->SetLocalizedText(c_schema_ns, c_alt_text_name, c_generic_lang, c_specific_lang,
                                     std::string(c_item_value), c_options);

  return Qtrue;
}

#update_meta(*args) ⇒ Object 



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
 
# File 'ext/xmp_toolkit_ruby/xmp_wrapper.cpp', line 313

VALUE
xmpwrapper_set_meta(int argc, VALUE *argv, VALUE self) {
  XMPWrapper *wrapper;
  TypedData_Get_Struct(self, XMPWrapper, &xmpwrapper_data_type, wrapper);
  check_wrapper_initialized(wrapper);

  VALUE rb_xmp_data, kwargs;
  XMP_OptionBits templateFlags =
      kXMPTemplate_AddNewProperties | kXMPTemplate_ReplaceExistingProperties | kXMPTemplate_IncludeInternalProperties;

  rb_scan_args(argc, argv, "1:", &rb_xmp_data, &kwargs);

  const char *xmpString = NULL;
  if (!NIL_P(rb_xmp_data)) {
    Check_Type(rb_xmp_data, T_STRING);
    xmpString = StringValueCStr(rb_xmp_data);
  }

  ID kw_table[1];
  kw_table[0] = rb_intern("mode");

  VALUE kw_values[1];
  kw_values[0] = rb_str_new_cstr("upsert");

  rb_get_kwargs(kwargs, kw_table, 0, 1, kw_values);

  VALUE rb_mode_sym = kw_values[0];

  const char *mode_cstr;
  if (RB_TYPE_P(rb_mode_sym, T_SYMBOL)) {
    // Convert symbol to string first
    VALUE mode_str = rb_sym_to_s(rb_mode_sym);
    mode_cstr = StringValueCStr(mode_str);
  } else {
    // Already a string
    mode_cstr = StringValueCStr(rb_mode_sym);
  }

  bool override;
  if (strcmp(mode_cstr, "upsert") == 0) {
    override = false;
  } else if (strcmp(mode_cstr, "override") == 0) {
    override = true;
  } else {
    rb_raise(rb_eArgError, "mode must be :upsert or :override (String or Symbol). Got '%s'", mode_cstr);
    return Qnil;  // unreachable, but for clarity
  }

  get_xmp(wrapper);

  SXMPMeta newMeta;

  if (xmpString != NULL) {
    int i;
    for (i = 0; i < (long)strlen(xmpString) - 10; i += 10) {
      newMeta.ParseFromBuffer(&xmpString[i], 10, kXMP_ParseMoreBuffers);
    }

    newMeta.ParseFromBuffer(&xmpString[i], (XMP_StringLen)strlen(xmpString) - i);
  }

  XMP_DateTime dt;
  SXMPUtils::CurrentDateTime(&dt);

  if (xmpString != NULL) {
    newMeta.SetProperty_Date(kXMP_NS_XMP, "MetadataDate", dt, 0);
  }

  if (override) {
    wrapper->xmpMeta->Erase();
  }

  SXMPUtils::ApplyTemplate(wrapper->xmpMeta, newMeta, templateFlags);

  return Qnil;
}

#update_property(rb_ns, rb_prop, rb_value) ⇒ Object 



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
 
# File 'ext/xmp_toolkit_ruby/xmp_wrapper.cpp', line 390

VALUE
xmpwrapper_set_property(VALUE self, VALUE rb_ns, VALUE rb_prop, VALUE rb_value) {
  XMPWrapper *wrapper;
  TypedData_Get_Struct(self, XMPWrapper, &xmpwrapper_data_type, wrapper);
  check_wrapper_initialized(wrapper);

  Check_Type(rb_ns, T_STRING);
  Check_Type(rb_prop, T_STRING);

  get_xmp(wrapper);

  if (!wrapper->xmpMetaDataLoaded) {
    rb_raise(rb_eRuntimeError, "No XMP metadata loaded");
  }

  VALUE mXmpToolkitRuby = rb_const_get(rb_cObject, rb_intern("XmpToolkitRuby"));
  VALUE cXmpValue = rb_const_get(mXmpToolkitRuby, rb_intern("XmpValue"));

  const char *ns = StringValueCStr(rb_ns);
  const char *prop = StringValueCStr(rb_prop);

  if (rb_obj_is_kind_of(rb_value, cXmpValue)) {
    VALUE rb_inner_val = rb_funcall(rb_value, rb_intern("value"), 0);
    VALUE rb_type_val = rb_funcall(rb_value, rb_intern("type"), 0);

    const char *type_str;
    if (RB_TYPE_P(rb_type_val, T_SYMBOL)) {
      VALUE mode_str = rb_sym_to_s(rb_type_val);
      type_str = StringValueCStr(mode_str);
    } else {
      type_str = StringValueCStr(rb_type_val);
    }

    if (strcmp(type_str, "string") == 0) {
      Check_Type(rb_inner_val, T_STRING);
      wrapper->xmpMeta->SetProperty(ns, prop, StringValueCStr(rb_inner_val), 0);
      return Qtrue;
    } else if (strcmp(type_str, "int") == 0) {
      Check_Type(rb_inner_val, T_FIXNUM);
      wrapper->xmpMeta->SetProperty_Int(ns, prop, NUM2INT(rb_inner_val), 0);
      return Qtrue;
    } else if (strcmp(type_str, "int64") == 0) {
      Check_Type(rb_inner_val, T_FIXNUM);
      wrapper->xmpMeta->SetProperty_Int64(ns, prop, NUM2LL(rb_inner_val), 0);
      return Qtrue;
    } else if (strcmp(type_str, "float") == 0) {
      Check_Type(rb_inner_val, T_FLOAT);
      wrapper->xmpMeta->SetProperty_Float(ns, prop, NUM2DBL(rb_inner_val), 0);
      return Qtrue;
    } else if (strcmp(type_str, "bool") == 0) {
      wrapper->xmpMeta->SetProperty_Bool(ns, prop, RTEST(rb_inner_val), 0);
      return Qtrue;
    } else if (strcmp(type_str, "date") == 0) {
      wrapper->xmpMeta->SetProperty_Date(ns, prop, datetime_to_xmp(rb_inner_val), 0);
      return Qtrue;
    }
  }

  const char *val = StringValueCStr(rb_value);

  try {
    wrapper->xmpMeta->SetProperty(ns, prop, val, 0);
  } catch (...) {
    rb_raise(rb_eRuntimeError, "Failed to set XMP property");
  }

  return Qtrue;
}

#write ⇒ Object 



547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
 
# File 'ext/xmp_toolkit_ruby/xmp_wrapper.cpp', line 547

VALUE
write_xmp(VALUE self) {
  XMPWrapper *wrapper;
  TypedData_Get_Struct(self, XMPWrapper, &xmpwrapper_data_type, wrapper);
  check_wrapper_initialized(wrapper);

  if (wrapper->xmpFile && wrapper->xmpMeta) {
    try {
      if (wrapper->xmpFile->CanPutXMP(*(wrapper->xmpMeta))) {
        wrapper->xmpFile->PutXMP(*(wrapper->xmpMeta));
        std::string newBuffer;
        wrapper->xmpMeta->SerializeToBuffer(&newBuffer);
      } else {
        std::string newBuffer;
        wrapper->xmpMeta->SerializeToBuffer(&newBuffer);
        rb_raise(rb_eArgError, "Can't update XMP new Data: '%s'", newBuffer.c_str());
      }
    } catch (const XMP_Error &e) {
      rb_raise(rb_eRuntimeError, "XMP SDK error: %s", e.GetErrMsg());
    }
  }

  return Qtrue;
}